Add support for non-standard DASH label attribute

demo/info_section.js

@@ -84,7 +84,6 @@ shakaDemo.updateVariantTracks_ = function() {
  */
 shakaDemo.updateTextTracks_ = function() {
   var trackList = document.getElementById('textTracks');
-
   var langList = document.getElementById('textLanguages');
   var language = langList.selectedIndex >= 0 ?
       langList.options[langList.selectedIndex].value :
@@ -154,8 +153,10 @@ shakaDemo.updateLanguages_ = function() {
 shakaDemo.updateTextLanguages_ = function() {
   var player = shakaDemo.player_;
   var list = document.getElementById('textLanguages');
-  var languages = player.getTextLanguages();
   var tracks = player.getTextTracks();
+  var languages = tracks.map(function(track) {
+    return { id: track.id, lang: track.language, label: track.label};
+  });
 
   shakaDemo.updateLanguageOptions_(list, languages, tracks);
 };
@@ -168,8 +169,10 @@ shakaDemo.updateTextLanguages_ = function() {
 shakaDemo.updateAudioLanguages_ = function() {
   var player = shakaDemo.player_;
   var list = document.getElementById('audioLanguages');
-  var languages = player.getAudioLanguages();
   var tracks = player.getVariantTracks();
+  var languages = tracks.map(function(track) {
+    return { id: track.id, lang: track.language, label: track.label};
+  });
 
   shakaDemo.updateLanguageOptions_(list, languages, tracks);
 };
@@ -198,9 +201,9 @@ shakaDemo.updateLanguageOptions_ =
   // Populate list with new options.
   languages.forEach(function(lang) {
     var option = document.createElement('option');
-    option.textContent = lang;
-    option.value = lang;
-    option.selected = lang == selectedTrack.language;
+    option.textContent = lang.label ? lang.label : lang.lang;
+    option.value = lang.lang;
+    option.selected = lang.lang == selectedTrack.language;
     list.appendChild(option);
   });
 };

externs/shaka/manifest.js

@@ -297,6 +297,7 @@ shakaExtern.GetSegmentReferenceFunction;
  *   encrypted: boolean,
  *   keyId: ?string,
  *   language: string,
+ *   label: ?string,
  *   type: string,
  *   primary: boolean,
  *   trickModeVideo: ?shakaExtern.Stream,
@@ -371,6 +372,8 @@ shakaExtern.GetSegmentReferenceFunction;
  *   The Stream's language, specified as a language code. <br>
  *   Audio stream's language must be identical to the language of the containing
  *   Variant.
+ * @property {?string} label
+ *   The Stream's label, unique text that should describe the audio/text track.
  * @property {string} type
  *   <i>Required.</i> <br>
  *   Content type (e.g. 'video', 'audio' or 'text')

externs/shaka/offline.js

@@ -148,6 +148,7 @@ shakaExtern.PeriodDB;
  *   frameRate: (number|undefined),
  *   kind: (string|undefined),
  *   language: string,
+ *   label: ?string,
  *   width: ?number,
  *   height: ?number,
  *   initSegmentUri: ?string,
@@ -175,6 +176,8 @@ shakaExtern.PeriodDB;
  *   The kind of text stream; undefined for audio/video.
  * @property {string} language
  *   The language of the stream; '' for video.
+ * @property {?string} label
+ *   The label of the stream; '' for video.
  * @property {?number} width
  *   The width of the stream; null for audio/text.
  * @property {?number} height

externs/shaka/player.js

@@ -130,6 +130,7 @@ shakaExtern.Stats;
  *   bandwidth: number,
  *
  *   language: string,
+ *   label: ?string,
  *   kind: ?string,
  *   width: ?number,
  *   height: ?number,
@@ -161,6 +162,8 @@ shakaExtern.Stats;
  * @property {string} language
  *   The language of the track, or 'und' if not given.  This is the exact
  *   value provided in the manifest; it may need to be normalized.
+ * @property {?string} label
+ *   The track label, unique text that should describe the track.
  * @property {?string} kind
  *   (only for text tracks) The kind of text track, either 'caption' or
  *   'subtitle'.

lib/dash/dash_parser.js

@@ -957,11 +957,13 @@ shaka.dash.DashParser.prototype.parseAdaptationSet_ = function(context, elem) {
   var language =
       shaka.util.LanguageUtils.normalize(elem.getAttribute('lang') || 'und');
 
+  var label = elem.getAttribute('label');
+
   // Parse Representations into Streams.
   var representations = XmlUtils.findChildren(elem, 'Representation');
   var streams = representations
       .map(this.parseRepresentation_.bind(
-          this, context, contentProtection, kind, language, main))
+          this, context, contentProtection, kind, language, label, main))
       .filter(function(s) { return !!s; });
 
   if (streams.length == 0) {
@@ -1018,6 +1020,7 @@ shaka.dash.DashParser.prototype.parseAdaptationSet_ = function(context, elem) {
  * @param {shaka.dash.ContentProtection.Context} contentProtection
  * @param {(string|undefined)} kind
  * @param {string} language
+ * @param {string} label
  * @param {boolean} isPrimary
  * @param {!Element} node
  * @return {?shakaExtern.Stream} The Stream, or null when there is a
@@ -1026,7 +1029,7 @@ shaka.dash.DashParser.prototype.parseAdaptationSet_ = function(context, elem) {
  * @private
  */
 shaka.dash.DashParser.prototype.parseRepresentation_ = function(
-    context, contentProtection, kind, language, isPrimary, node) {
+    context, contentProtection, kind, language, label, isPrimary, node) {
   var XmlUtils = shaka.util.XmlUtils;
   var ContentType = shaka.util.ManifestParserUtils.ContentType;
 
@@ -1105,6 +1108,7 @@ shaka.dash.DashParser.prototype.parseRepresentation_ = function(
     encrypted: contentProtection.drmInfos.length > 0,
     keyId: keyId,
     language: language,
+    label: label,
     type: context.adaptationSet.contentType,
     primary: isPrimary,
     trickModeVideo: null,

lib/offline/offline_utils.js

@@ -251,6 +251,7 @@ shaka.offline.OfflineUtils.createStream_ = function(streamDb) {
     encrypted: streamDb.encrypted,
     keyId: streamDb.keyId,
     language: streamDb.language,
+    label: streamDb.label,
     type: streamDb.contentType,
     primary: streamDb.primary,
     trickModeVideo: null,

lib/offline/storage.js

@@ -883,6 +883,7 @@ shaka.offline.Storage.prototype.createStream_ = function(
     frameRate: stream.frameRate,
     kind: stream.kind,
     language: stream.language,
+    label: stream.label,
     width: stream.width || null,
     height: stream.height || null,
     initSegmentUri: initUri,

lib/player.js

@@ -1408,14 +1408,15 @@ shaka.Player.prototype.getStats = function() {
  *
  * @param {string} uri
  * @param {string} language
+ * @param {?string} label
  * @param {string} kind
  * @param {string} mime
  * @param {string=} opt_codec
  * @return {!Promise.<shakaExtern.Track>}
  * @export
  */
 shaka.Player.prototype.addTextTrack = function(
-    uri, language, kind, mime, opt_codec) {
+    uri, language, label, kind, mime, opt_codec) {
   if (!this.streamingEngine_) {
     shaka.log.error(
         'Must call load() and wait for it to resolve before adding text ' +
@@ -1466,6 +1467,7 @@ shaka.Player.prototype.addTextTrack = function(
     encrypted: false,
     keyId: null,
     language: language,
+    label: label,
     type: ContentType.TEXT,
     primary: false,
     trickModeVideo: null,
@@ -1494,6 +1496,7 @@ shaka.Player.prototype.addTextTrack = function(
       type: ContentType.TEXT,
       bandwidth: 0,
       language: language,
+      label: label,
       kind: kind,
       width: null,
       height: null

lib/util/stream_utils.js

@@ -219,6 +219,7 @@ shaka.util.StreamUtils.getVariantTracks =
     function(period, activeAudioId, activeVideoId) {
   var StreamUtils = shaka.util.StreamUtils;
   var variants = StreamUtils.getPlayableVariants(period.variants);
+  var label;
   var tracks = variants.map(function(variant) {
     var isActive;
     if (variant.video && variant.audio) {
@@ -233,6 +234,9 @@ shaka.util.StreamUtils.getVariantTracks =
     if (variant.audio) {
       if (codecs != '') codecs += ', ';
       codecs += variant.audio.codecs;
+      if (variant.audio.label) {
+        label = variant.audio.label;
+      }
     }
 
     var audioCodec = variant.audio ? variant.audio.codecs : null;
@@ -251,6 +255,7 @@ shaka.util.StreamUtils.getVariantTracks =
       type: 'variant',
       bandwidth: variant.bandwidth,
       language: variant.language,
+      label: label,
       kind: kind || null,
       width: variant.video ? variant.video.width : null,
       height: variant.video ? variant.video.height : null,

test/dash/dash_parser_manifest_unit.js

@@ -119,7 +119,7 @@ describe('DashParser Manifest', function() {
           '      <Representation bandwidth="50" width="576" height="432" />',
           '    </AdaptationSet>',
           '    <AdaptationSet mimeType="text/vtt"',
-          '        lang="es">',
+          '        lang="es" label="spanish">',
           '      <Role value="caption" />',
           '      <Role value="main" />',
           '      <Representation bandwidth="100" />',
@@ -176,6 +176,7 @@ describe('DashParser Manifest', function() {
                 .primary()
             .addTextStream(jasmine.any(Number))
               .language('es')
+              .label('spanish')
               .primary()
               .anySegmentFunctions()
               .anyInitSegment()

test/offline/offline_utils_unit.js

@@ -152,6 +152,7 @@ describe('OfflineUtils', function() {
         frameRate: 22,
         kind: undefined,
         language: '',
+        label: '',
         width: 250,
         height: 100,
         initSegmentUri: null,
@@ -183,6 +184,7 @@ describe('OfflineUtils', function() {
         frameRate: undefined,
         kind: undefined,
         language: 'en',
+        label: 'English',
         width: null,
         height: null,
         initSegmentUri: 'offline:1/' + id + '/0',
@@ -213,6 +215,7 @@ describe('OfflineUtils', function() {
         frameRate: undefined,
         kind: undefined,
         language: 'en',
+        label: 'English',
         width: null,
         height: null,
         initSegmentUri: 'offline:1/' + id + '/0',

test/test/util/manifest_generator.js

@@ -162,6 +162,18 @@ shaka.test.ManifestGenerator.prototype.language = function(language) {
 };
 
 
+/**
+ * Sets the label of the language of the most recent variant or text stream.
+ *
+ * @param {string} label
+ * @return {!shaka.test.ManifestGenerator}
+ */
+shaka.test.ManifestGenerator.prototype.label = function(label) {
+  this.currentStream_().label = label;
+  return this;
+};
+
+
 /**
  * Sets that the most recent variant or text stream is primary.
  *
@@ -320,7 +332,7 @@ shaka.test.ManifestGenerator.prototype.addVideo = function(id) {
   }
 
   if (!stream)
-    stream = this.createStream_(id, ContentType.VIDEO, 'und');
+    stream = this.createStream_(id, ContentType.VIDEO, 'und', null);
 
   variant.video = stream;
   this.lastStreamAdded_ = stream;
@@ -353,7 +365,8 @@ shaka.test.ManifestGenerator.prototype.addAudio = function(id) {
   }
 
   if (!stream)
-    stream = this.createStream_(id, ContentType.AUDIO, variant.language);
+    stream = this.createStream_(id, ContentType.AUDIO, variant.language,
+        variant.audio.label);
 
   variant.audio = stream;
   this.lastStreamAdded_ = stream;
@@ -372,7 +385,7 @@ shaka.test.ManifestGenerator.prototype.addAudio = function(id) {
 shaka.test.ManifestGenerator.prototype.addTextStream = function(id) {
   var ContentType = shaka.util.ManifestParserUtils.ContentType;
   var period = this.currentPeriod_();
-  var stream = this.createStream_(id, ContentType.TEXT, 'und');
+  var stream = this.createStream_(id, ContentType.TEXT, 'und', '');
   period.textStreams.push(stream);
   this.lastObjectAdded_ = stream;
   this.lastStreamAdded_ = stream;
@@ -416,11 +429,12 @@ shaka.test.ManifestGenerator.prototype.isIdUsed_ = function(id) {
  * @param {number} id
  * @param {string} type
  * @param {string} language
+ * @param {?string} label
  * @return {!shakaExtern.Stream}
  * @private
  */
 shaka.test.ManifestGenerator.prototype.createStream_ =
-    function(id, type, language) {
+    function(id, type, language, label) {
   goog.asserts.assert(!this.isIdUsed_(id),
                       'Streams should have unique ids!');
 
@@ -456,6 +470,7 @@ shaka.test.ManifestGenerator.prototype.createStream_ =
     encrypted: false,
     keyId: null,
     language: language,
+    label: label,
     type: type,
     primary: false,
     trickModeVideo: null,