viaprog/shaka-player
1
0
Fork 0
mirror of https://github.com/shaka-project/shaka-player.git synced 2026-06-26 17:46:26 +03:00
Code Issues Packages Projects Releases Wiki Activity

feat: Add preferredAudioLabel to PlayerConfiguration (#4763)

Browse Source 
Closes
[#4762](https://github.com/shaka-project/shaka-player/issues/4762).

The change is to add PreferredAudioLabel to player configuration so that
host apps can decide the default variant label to choose at very
beginning.
This commit is contained in:
Tian Shao
2022-11-29 01:30:40 -08:00
committed by GitHub
parent c5a86a8298
commit aadecd6401
13 changed files with 39 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
AUTHORS
+1
View File
@@ -78,6 +78,7 @@ Seongryun Jo <ocipap0531@gmail.com>
Swank Motion Pictures Inc. <*@swankmp.com>
TalkTalk Plc <*@talktalkplc.com>
Tatsiana Gelahova <tatsiana.gelahova@gmail.com>
Tian Shao <tyrelltle@gmail.com>
Tomas Tichy <mr.tichyt@gmail.com>
Tomohiro Matsuzawa <thmatuza75@hotmail.com>
Toshihiro Suzuki <t.suzuki326@gmail.com>
CONTRIBUTORS
+1
View File
@@ -114,6 +114,7 @@ Seth Madison <seth@philo.com>
Tatsiana Gelahova <tatsiana.gelahova@gmail.com>
Theodore Abshire <theodab@google.com>
Thomas Stephens <thomas@ustudio.com>
Tian Shao <tyrelltle@gmail.com>
Tim Plummer <objelisks@google.com>
Timothy Drews <tdrews@google.com>
Tomas Bucher <collapsingtesseract@gmail.com>
demo/common/message_ids.js
+1
View File
@@ -153,6 +153,7 @@ shakaDemo.MessageIds = {
ALWAYS_STREAM_TEXT_WARNING: 'DEMO_ALWAYS_STREAM_TEXT_WARNING',
AUDIO_CHANNEL_COUNT: 'DEMO_AUDIO_CHANNEL_COUNT',
AUDIO_LANGUAGE: 'DEMO_AUDIO_LANGUAGE',
AUDIO_LABEL: 'DEMO_AUDIO_LABEL',
AUDIO_ROBUSTNESS: 'DEMO_AUDIO_ROBUSTNESS',
AUTO_CORRECT_DASH_DRIFT: 'DEMO_AUTO_CORRECT_DASH_DRIFT',
AUTO_LOW_LATENCY: 'DEMO_AUTO_LOW_LATENCY',
demo/config.js
+1
View File
@@ -477,6 +477,7 @@ shakaDemo.Config = class {
this.addSection_(MessageIds.LANGUAGE_SECTION_HEADER, docLink)
.addTextInput_(MessageIds.AUDIO_LANGUAGE, 'preferredAudioLanguage')
.addTextInput_(MessageIds.AUDIO_LABEL, 'preferredAudioLabel')
.addTextInput_(MessageIds.TEXT_LANGUAGE, 'preferredTextLanguage')
.addTextInput_(MessageIds.TEXT_ROLE, 'preferredTextRole')
.addSelectInput_(
demo/locales/en.json
+1
View File
@@ -11,6 +11,7 @@
"DEMO_APPLE": "Apple",
"DEMO_AUDIO_CHANNEL_COUNT": "Preferred Audio Channel Count",
"DEMO_AUDIO_LANGUAGE": "Preferred Audio Language",
"DEMO_AUDIO_LABEL": "Preferred Audio Label",
"DEMO_AUDIO_ONLY": "Audio only",
"DEMO_AUDIO_ONLY_SEARCH": "Filters for assets that do not have video streams.",
"DEMO_AUDIO_ROBUSTNESS": "Audio Robustness",
demo/locales/source.json
+4
View File
@@ -47,6 +47,10 @@
"description": "The name of a configuration value.",
"message": "Preferred Audio Language"
},
"DEMO_AUDIO_LABEL": {
"description": "The name of a configuration value.",
"message": "Preferred Audio Label"
},
"DEMO_AUDIO_ONLY": {
"description": "A tag that marks an asset as having multiple languages.",
"message": "Audio only"
docs/tutorials/config.md
+1
View File
@@ -64,6 +64,7 @@ player.getConfiguration();
playRangeEnd: Infinity
playRangeStart: 0
preferredAudioLanguage: ""
preferredAudioLabel: ""
preferredTextLanguage: ""
restrictions: Object
streaming: Object
externs/shaka/player.js
+3
View File
@@ -1317,6 +1317,7 @@ shaka.extern.OfflineConfiguration;
* lcevc: shaka.extern.LcevcConfiguration,
* offline: shaka.extern.OfflineConfiguration,
* preferredAudioLanguage: string,
* preferredAudioLabel: string,
* preferredTextLanguage: string,
* preferredVariantRole: string,
* preferredTextRole: string,
@@ -1356,6 +1357,8 @@ shaka.extern.OfflineConfiguration;
* The preferred language to use for audio tracks. If not given it will use
* the <code>'main'</code> track.
* Changing this during playback will not affect the current playback.
* @property {string} preferredAudioLabel
* The preferred label to use for audio tracks
* @property {string} preferredTextLanguage
* The preferred language to use for text tracks. If a matching text track
* is found, and the selected audio and text tracks have different languages,
lib/media/adaptation_set_criteria.js
+1 -1
View File
@@ -218,7 +218,7 @@ shaka.media.PreferenceBasedCriteria = class {
*/
static filterVariantsByLabel_(variants, preferredLabel) {
return variants.filter((variant) => {
if (!variant.audio) {
if (!variant.audio || !variant.audio.label) {
return false;
}
lib/player.js
+2 -1
View File
@@ -2099,7 +2099,8 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
new shaka.media.PreferenceBasedCriteria(
this.config_.preferredAudioLanguage,
this.config_.preferredVariantRole,
this.config_.preferredAudioChannelCount);
this.config_.preferredAudioChannelCount,
this.config_.preferredAudioLabel);
this.currentTextLanguage_ = this.config_.preferredTextLanguage;
this.currentTextRole_ = this.config_.preferredTextRole;
lib/util/player_configuration.js
+1
View File
@@ -289,6 +289,7 @@ shaka.util.PlayerConfiguration = class {
abr: abr,
autoShowText: AutoShowText.IF_SUBTITLES_MAY_BE_NEEDED,
preferredAudioLanguage: '',
preferredAudioLabel: '',
preferredTextLanguage: '',
preferredVariantRole: '',
preferredTextRole: '',
test/player_unit.js
+16 -2
View File
@@ -1252,6 +1252,7 @@ describe('Player', () => {
manifest.addVariant(106, (variant) => { // spanish stereo, low res
variant.language = 'es';
variant.bandwidth = 1100;
variant.label = 'es-label';
variant.addExistingStream(1); // video
variant.addAudio(6, (stream) => {
stream.originalId = 'audio-es';
@@ -1263,6 +1264,7 @@ describe('Player', () => {
manifest.addVariant(107, (variant) => { // spanish stereo, high res
variant.language = 'es';
variant.bandwidth = 2100;
variant.label = 'es-label';
variant.addExistingStream(2); // video
variant.addExistingStream(6); // audio
});
@@ -1529,7 +1531,7 @@ describe('Player', () => {
type: 'variant',
bandwidth: 1100,
language: 'es',
label: null,
label: 'es-label',
kind: null,
width: 100,
height: 200,
@@ -1565,7 +1567,7 @@ describe('Player', () => {
type: 'variant',
bandwidth: 2100,
language: 'es',
label: null,
label: 'es-label',
kind: null,
width: 200,
height: 400,
@@ -2236,6 +2238,18 @@ describe('Player', () => {
roles: ['commentary'],
}));
});
it('chooses a variant with preferred audio label', async () => {
expect(getActiveVariantTrack().label).toBe(null);
player.configure({
preferredAudioLanguage: '',
preferredAudioLabel: 'es-label',
});
await player.load(fakeManifestUri, 0, fakeMimeType);
expect(getActiveVariantTrack().label).toBe('es-label');
});
}); // describe('tracks')
describe('languages', () => {
test/test/util/manifest_generator.js
+6 -3
View File
@@ -263,6 +263,8 @@ shaka.test.ManifestGenerator.Variant = class {
if (!isPartial) {
/** @type {string} */
this.language = 'und';
/** @type {string} */
this.label = '';
/** @type {number} */
this.bandwidth = 0;
/** @type {number} */
@@ -316,7 +318,7 @@ shaka.test.ManifestGenerator.Variant = class {
const ContentType = shaka.util.ManifestParserUtils.ContentType;
const stream = new shaka.test.ManifestGenerator.Stream(
this.manifest_, /* isPartial= */ false, id, ContentType.AUDIO,
this.language);
this.language, this.label);
if (func) {
func(stream);
}
@@ -447,8 +449,9 @@ shaka.test.ManifestGenerator.Stream = class {
* @param {?number} id
* @param {shaka.util.ManifestParserUtils.ContentType} type
* @param {string=} lang
* @param {string=} label
*/
constructor(manifest, isPartial, id, type, lang) {
constructor(manifest, isPartial, id, type, lang, label) {
goog.asserts.assert(
!manifest || !manifest.isIdUsed_(id),
'Streams should have unique ids!');
@@ -518,7 +521,7 @@ shaka.test.ManifestGenerator.Stream = class {
/** @type {string} */
this.language = lang || 'und';
/** @type {?string} */
this.label = null;
this.label = label || null;
/** @type {boolean} */
this.primary = false;
/** @type {?shaka.extern.Stream} */