Feature / Parse labels for adaptation sets (#1105)

* mob sessioe

* Mob session

* Some cleanups

* Return labels for available videotracks and available text tracks

* Return labels for chosen tracks

* Correct types

* Review fixes: Simplified label parsing

* Reverted changes in dist/rx-player.js

* Revert changes in dist/rx-player.js

Co-authored-by: stephanterning <[email protected]>

.gitignore

@@ -35,3 +35,5 @@
 /tools
 
 /src/parsers/manifest/dash/wasm-parser/target
+
+/.idea

src/core/api/track_choice_manager.ts

@@ -71,13 +71,15 @@ export interface ITMAudioTrack { language : string;
                                  audioDescription : boolean;
                                  dub? : boolean;
                                  id : number|string;
+                                 label?: string|undefined;
                                  representations: ITMAudioRepresentation[]; }
 
 /** Text track returned by the TrackChoiceManager. */
 export interface ITMTextTrack { language : string;
                                 normalized : string;
                                 closedCaption : boolean;
-                                id : number|string; }
+                                id : number|string;
+                                label?: string|undefined; }
 
 /**
  * Definition of a single video Representation as represented by the
@@ -96,7 +98,8 @@ export interface ITMVideoTrack { id : number|string;
                                  signInterpreted?: boolean;
                                  isTrickModeTrack?: boolean;
                                  trickModeTracks?: ITMVideoTrack[];
-                                 representations: ITMVideoRepresentation[]; }
+                                 representations: ITMVideoRepresentation[];
+                                 label?: string|undefined; }
 
 /** Audio track from a list of audio tracks returned by the TrackChoiceManager. */
 export interface ITMAudioTrackListItem
@@ -684,6 +687,7 @@ export default class TrackChoiceManager {
       audioDescription: chosenTrack.isAudioDescription === true,
       id: chosenTrack.id,
       representations: chosenTrack.representations.map(parseAudioRepresentation),
+      label: chosenTrack.label,
     };
     if (chosenTrack.isDub === true) {
       audioTrack.dub = true;
@@ -719,6 +723,7 @@ export default class TrackChoiceManager {
       normalized: takeFirstSet<string>(chosenTextAdaptation.normalizedLanguage, ""),
       closedCaption: chosenTextAdaptation.isClosedCaption === true,
       id: chosenTextAdaptation.id,
+      label: chosenTextAdaptation.label,
     };
   }
 
@@ -763,6 +768,7 @@ export default class TrackChoiceManager {
     const videoTrack: ITMVideoTrack = {
       id: currAdaptation.id,
       representations: currAdaptation.representations.map(parseVideoRepresentation),
+      label: currAdaptation.label,
     };
     if (currAdaptation.isSignInterpreted === true) {
       videoTrack.signInterpreted = true;
@@ -805,6 +811,7 @@ export default class TrackChoiceManager {
           active: currentId === null ? false :
                                        currentId === adaptation.id,
           representations: adaptation.representations.map(parseAudioRepresentation),
+          label: adaptation.label,
         };
         if (adaptation.isDub === true) {
           formatted.dub = true;
@@ -841,6 +848,7 @@ export default class TrackChoiceManager {
         id: adaptation.id,
         active: currentId === null ? false :
                                      currentId === adaptation.id,
+        label: adaptation.label,
       }));
   }
 
@@ -887,6 +895,7 @@ export default class TrackChoiceManager {
           active: currentId === null ? false :
                                        currentId === adaptation.id,
           representations: adaptation.representations.map(parseVideoRepresentation),
+          label: adaptation.label,
         };
         if (adaptation.isSignInterpreted === true) {
           formatted.signInterpreted = true;

src/manifest/adaptation.ts

@@ -101,6 +101,9 @@ export default class Adaptation {
   /** Tells if the track is a trick mode track. */
   public isTrickModeTrack? : boolean;
 
+  /** Label of the adaptionSet */
+  public label?: string;
+
   public readonly trickModeTracks? : Adaptation[];
 
   /**
@@ -138,6 +141,9 @@ export default class Adaptation {
     if (parsedAdaptation.isSignInterpreted !== undefined) {
       this.isSignInterpreted = parsedAdaptation.isSignInterpreted;
     }
+    if (parsedAdaptation.label !== undefined) {
+      this.label = parsedAdaptation.label;
+    }
 
     if (trickModeTracks !== undefined &&
         trickModeTracks.length > 0) {

src/parsers/manifest/dash/common/parse_adaptation_sets.ts

@@ -27,7 +27,7 @@ import isNonEmptyString from "../../../../utils/is_non_empty_string";
 import {
   IParsedAdaptation,
   IParsedAdaptations,
-} from "../../types";
+} from "../../types";
 import {
   IAdaptationSetIntermediateRepresentation,
   ISegmentTemplateIntermediateRepresentation,
@@ -266,7 +266,7 @@ export default function parseAdaptationSets(
     const adaptation = adaptationsIR[adaptationIdx];
     const adaptationChildren = adaptation.children;
     const { essentialProperties,
-            roles } = adaptationChildren;
+            roles, label } = adaptationChildren;
 
     const isMainAdaptation = Array.isArray(roles) &&
       roles.some((role) => role.value === "main") &&
@@ -425,6 +425,10 @@ export default function parseAdaptationSets(
         parsedAdaptationSet.isSignInterpreted = true;
       }
 
+      if (label !== undefined) {
+        parsedAdaptationSet.label = label;
+      }
+
       if (trickModeAttachedAdaptationIds !== undefined) {
         trickModeAdaptations.push({ adaptation: parsedAdaptationSet,
                                     trickModeAttachedAdaptationIds });

src/parsers/manifest/dash/js-parser/node_parsers/AdaptationSet.ts

@@ -94,6 +94,14 @@ function parseAdaptationSetChildren(
           children.inbandEventStreams.push(parseScheme(currentElement));
           break;
 
+        case "Label":
+          const label = currentElement.textContent;
+
+          if (label !== null && label !== undefined) {
+            children.label = label;
+          }
+          break;
+
         case "Representation":
           const [representation, representationWarnings] =
             createRepresentationIntermediateRepresentation(currentElement);

src/parsers/manifest/dash/node_parser_types.ts

@@ -200,6 +200,7 @@ export interface IAdaptationSetChildren {
   segmentBase? : ISegmentBaseIntermediateRepresentation | undefined;
   segmentList? : ISegmentListIntermediateRepresentation | undefined;
   segmentTemplate? : ISegmentTemplateIntermediateRepresentation | undefined;
+  label? : string | undefined;
 }
 
 /* Intermediate representation for An AdaptationSet node's attributes. */

src/parsers/manifest/types.ts

@@ -184,6 +184,10 @@ export interface IParsedAdaptation {
    * Not set if unknown or if it makes no sense for the current track.
    */
   language?: string | undefined;
+  /**
+   * Label of the `Adaptation` if it exists.
+   */
+  label?: string;
   /**
    * TrickMode tracks attached to the adaptation.
    */