Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add support for non-standard DASH label attribute #811

Merged
merged 5 commits into from
May 25, 2017
Merged

Add support for non-standard DASH label attribute #811

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
34607c9
add support to label attribute for audio and text
May 17, 2017
272334e
fix code review, add label to
May 22, 2017
474add7
more fixes
May 23, 2017
71e2ade
fix unit test + add HLS NAME attribute as label
May 24, 2017
2a1d135
update from master and fix test
May 25, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions demo/info_section.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 :
Expand Down Expand Up @@ -196,11 +195,11 @@ shakaDemo.updateLanguageOptions_ =
var selectedTrack = activeTracks[0];

// Populate list with new options.
languages.forEach(function(lang) {
tracks.forEach(function(track) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updateLanguageOptions_ updates the list of languages in the demo. You should not be changing this method.

Instead, you should be changing the formatting in the list of tracks.

Everything else looks good, so I'm going to go ahead and run tests on the build bot. If all tests pass, I will fix the demo UI myself when I merge.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tests are failing, so I will leave it to you to make updates.

For the demo app, please revert changes in this file and look at the formatters map in updateTrackOptions_. That is where you should add labels to the track list. Here's a suggestion:

shakaDemo.updateTrackOptions_ = function(list, tracks, language) {
  var formatters = {
    variant: function(track) {
      var trackInfo = '';
      if (track.language) trackInfo += 'language: ' + track.language + ', ';
      if (track.label) trackInfo += 'label: ' + track.label + ', ';
      if (track.width && track.height)
        trackInfo += track.width + 'x' + track.height + ', ';
      trackInfo += track.bandwidth + ' bits/s';
      return trackInfo;
    },
    text: function(track) {
      var trackInfo = 'language: ' + track.language + ', ';
      if (track.label) trackInfo += 'label: ' + track.label + ', ';
      trackInfo += 'kind: ' + track.kind;
      return trackInfo;
    }
  };

var option = document.createElement('option');
option.textContent = lang;
option.value = lang;
option.selected = lang == selectedTrack.language;
option.textContent = track.label ? track.label : track.language;
option.value = track.language;
option.selected = track.language == selectedTrack.language;
list.appendChild(option);
});
};
Expand Down
3 changes: 3 additions & 0 deletions externs/shaka/manifest.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -297,6 +297,7 @@ shakaExtern.GetSegmentReferenceFunction;
* encrypted: boolean,
* keyId: ?string,
* language: string,
* label: ?string,
* type: string,
* primary: boolean,
* trickModeVideo: ?shakaExtern.Stream,
Expand Down Expand Up @@ -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')
Expand Down
3 changes: 3 additions & 0 deletions externs/shaka/offline.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,7 @@ shakaExtern.PeriodDB;
* frameRate: (number|undefined),
* kind: (string|undefined),
* language: string,
* label: ?string,
* width: ?number,
* height: ?number,
* initSegmentUri: ?string,
Expand Down Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions externs/shaka/player.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,7 @@ shakaExtern.Stats;
* bandwidth: number,
*
* language: string,
* label: ?string,
* kind: ?string,
* width: ?number,
* height: ?number,
Expand Down Expand Up @@ -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'.
Expand Down
8 changes: 6 additions & 2 deletions lib/dash/dash_parser.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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');
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was unable to find any mention of this attribute in the DASH spec (2014) or the latest DASH-IF-IOP (v4.0). I don't object to you adding it, though.

Please add a comment that this is a non-standard attribute supported by Kaltura.


// 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) {
Expand Down Expand Up @@ -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
Expand All @@ -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;

Expand Down Expand Up @@ -1105,6 +1108,7 @@ shaka.dash.DashParser.prototype.parseRepresentation_ = function(
encrypted: contentProtection.drmInfos.length > 0,
keyId: keyId,
language: language,
label: label,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add this new field to the definition of the shakaExtern.Stream structure in externs/shaka/manifest.js.

type: context.adaptationSet.contentType,
primary: isPrimary,
trickModeVideo: null,
Expand Down
1 change: 1 addition & 0 deletions lib/offline/offline_utils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
1 change: 1 addition & 0 deletions lib/offline/storage.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
5 changes: 4 additions & 1 deletion lib/player.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1411,11 +1411,12 @@ shaka.Player.prototype.getStats = function() {
* @param {string} kind
* @param {string} mime
* @param {string=} opt_codec
* @param {string=} opt_label
* @return {!Promise.<shakaExtern.Track>}
* @export
*/
shaka.Player.prototype.addTextTrack = function(
uri, language, kind, mime, opt_codec) {
uri, language, kind, mime, opt_codec, opt_label) {
if (!this.streamingEngine_) {
shaka.log.error(
'Must call load() and wait for it to resolve before adding text ' +
Expand Down Expand Up @@ -1466,6 +1467,7 @@ shaka.Player.prototype.addTextTrack = function(
encrypted: false,
keyId: null,
language: language,
label: opt_label || null,
type: ContentType.TEXT,
primary: false,
trickModeVideo: null,
Expand Down Expand Up @@ -1494,6 +1496,7 @@ shaka.Player.prototype.addTextTrack = function(
type: ContentType.TEXT,
bandwidth: 0,
language: language,
label: opt_label || null,
kind: kind,
width: null,
height: null
Expand Down
3 changes: 3 additions & 0 deletions lib/util/stream_utils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 = null;
var tracks = variants.map(function(variant) {
var isActive;
if (variant.video && variant.audio) {
Expand All @@ -233,6 +234,7 @@ shaka.util.StreamUtils.getVariantTracks =
if (variant.audio) {
if (codecs != '') codecs += ', ';
codecs += variant.audio.codecs;
label = variant.audio.label;
}

var audioCodec = variant.audio ? variant.audio.codecs : null;
Expand All @@ -251,6 +253,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,
Expand Down
3 changes: 2 additions & 1 deletion test/dash/dash_parser_manifest_unit.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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">',
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for updating the tests!

' <Role value="caption" />',
' <Role value="main" />',
' <Representation bandwidth="100" />',
Expand Down Expand Up @@ -176,6 +176,7 @@ describe('DashParser Manifest', function() {
.primary()
.addTextStream(jasmine.any(Number))
.language('es')
.label('spanish')
.primary()
.anySegmentFunctions()
.anyInitSegment()
Expand Down
3 changes: 3 additions & 0 deletions test/offline/offline_utils_unit.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,7 @@ describe('OfflineUtils', function() {
frameRate: 22,
kind: undefined,
language: '',
label: '',
width: 250,
height: 100,
initSegmentUri: null,
Expand Down Expand Up @@ -183,6 +184,7 @@ describe('OfflineUtils', function() {
frameRate: undefined,
kind: undefined,
language: 'en',
label: 'English',
width: null,
height: null,
initSegmentUri: 'offline:1/' + id + '/0',
Expand Down Expand Up @@ -213,6 +215,7 @@ describe('OfflineUtils', function() {
frameRate: undefined,
kind: undefined,
language: 'en',
label: 'English',
width: null,
height: null,
initSegmentUri: 'offline:1/' + id + '/0',
Expand Down
13 changes: 13 additions & 0 deletions test/test/util/manifest_generator.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*
Expand Down Expand Up @@ -456,6 +468,7 @@ shaka.test.ManifestGenerator.prototype.createStream_ =
encrypted: false,
keyId: null,
language: language,
label: null,
type: type,
primary: false,
trickModeVideo: null,
Expand Down