Merge pull request #441 from rdkcentral/feature/rdkemw-6446

RDKEMW-6742: Add CC HAL support to ITextTrack

Author: torben-thellefsen-sky

apis/TextTrack/ITextTrack.h

@@ -21,7 +21,7 @@
 
 #include "Module.h"
 
-#define ITEXTTRACK_VERSION 2
+#define ITEXTTRACK_VERSION 3
 
 namespace WPEFramework {
 namespace Exchange {
@@ -308,6 +308,7 @@ struct EXTERNAL ITextTrackClosedCaptionsStyle : virtual public Core::IUnknown {
 
 /*
  * This is the COM-RPC interface for global TTML style overrides.
+ * Added in version 2
  */
 /* @json 1.0.0 @text:keep */
 struct EXTERNAL ITextTrackTtmlStyle : virtual public Core::IUnknown {
@@ -358,7 +359,7 @@ struct EXTERNAL ITextTrackTtmlStyle : virtual public Core::IUnknown {
 /*
     This is the COM-RPC interface for handling TextTrack sessions.
 */
-/* @json 1.1.0 @text:keep */
+/* @json 1.3.0 @text:keep */
 struct EXTERNAL ITextTrack : virtual public Core::IUnknown {
     enum {
         ID = ID_TEXT_TRACK
@@ -374,9 +375,10 @@ struct EXTERNAL ITextTrack : virtual public Core::IUnknown {
     // Sessions
     /**
      * @brief Opens a new renderSession.
-     * @details If a session is already running on the supplied the supplied displayHandle already has a running session, the sessionId for this session is
-     * returned
-     * @param displayHandle The displayHandle is an encoding of the wayland display name  optionally including the and window ID
+     * @details If a session is already running on the supplied displayHandle, the sessionId for this session is
+     * returned. If the session is instead newly opened, the session type is not set and display is muted. Use one
+     * of the "selection" functions to select a session type, and UnMuteSession() to get subtitles displayed.
+     * @param displayHandle is an encoding of the wayland display name
      * @param sessionId On success the returned session id
      * @text openSession
      */
@@ -390,7 +392,7 @@ struct EXTERNAL ITextTrack : virtual public Core::IUnknown {
     virtual Core::hresult CloseSession(const uint32_t sessionId) = 0;
     /**
      * @brief Resets a previously opened render session back to its opened state.
-     * @details The text render display is cleared by the render session.
+     * @details The state will be like after calling OpenSession()
      * @param sessionId Is the session to reset
      * @text resetSession
      */
@@ -517,12 +519,30 @@ struct EXTERNAL ITextTrack : virtual public Core::IUnknown {
      * overridden. For styling options, see https://www.w3.org/TR/2018/REC-ttml1-20181108/#styling-vocabulary-style
      * The format of the styling string is "attr:value;attr:value;attr:value" (see vocabulary; NB: not all styling is supported)
      * Styles not mentioned in the list will not be affected.
+     * Added in version 2
      * @param sessionId Is the session as returned in the ITextTrack interface.
      * @param style Contains the list of styles to be overridden
      * @text applyCustomTtmlStyleOverridesToSession
      */
     virtual Core::hresult ApplyCustomTtmlStyleOverridesToSession(const uint32_t sessionId, const string &style) { return Core::ERROR_NOT_SUPPORTED; }
 
+    /**
+     * @brief Associate a video decoder with the given session
+     * @details This will ask TextTrack to subscribe to Closed Captions data from the decoder and display
+     * these in the given session. Depending on the support on the platform, this may not be possible to do.
+     * The assocation is active until CloseSession() or ResetSession() is called, and can also be
+     * cancelled by calling AssociateVideoDecoder() with an empty string for handle.
+     * After associating the video decoder, further calls to SendSessionData will be ignored.
+     * Added in version 3
+     * @param sessionId is the session
+     * @param handle is a textual representation of the video decoder handle
+     * @text associateVideoDecoder
+     * @returns ERROR_NOT_SUPPORTED if the function is not implemented
+     * @returns ERROR_GENERAL if the association failed (whether bad handle is used or lack of support on the platform).
+     * @returns ERROR_OK on success
+     */
+    virtual Core::hresult AssociateVideoDecoder(const uint32_t sessionId, const string &handle) { return Core::ERROR_NOT_SUPPORTED; }
+
 };
 } // namespace Exchange
 } // namespace WPEFramework