Skip to content

add support for Preselection element #4790

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

Merged
merged 14 commits into from
Sep 13, 2025
Merged

add support for Preselection element #4790

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
6e930c3
add support for Preselection element parsing and codecs string replac…
stschr Jun 10, 2025
e2a1e38
address review comments
stschr Jun 23, 2025
fb7e4c2
one more fix from review
stschr Jun 24, 2025
40e8c4b
unify getProperty functions
stschr Jul 4, 2025
50e44d7
adding id
stschr Jul 9, 2025
e2f4b46
more updates to index.d.ts
stschr Jul 18, 2025
e2075ea
improve preselections capability check with MediaCapabilitiesAPI
stschr Jul 29, 2025
8e9a43d
missing fix from last commit
stschr Jul 29, 2025
2bb921a
improve robustness
stschr Jul 30, 2025
332c4e4
rename settings element for preselection to MediaInfo mapping
stschr Sep 12, 2025
83897ae
setting Preselection@id to the default value per spec
stschr Sep 12, 2025
cf716d4
move code to helper function
stschr Sep 12, 2025
9bcb4f3
remove currently unsed code
stschr Sep 12, 2025
d4d11e8
remove declarations from index.d.ts, where respective items were remo…
stschr Sep 12, 2025
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: 8 additions & 1 deletion contrib/akamai/controlbar/ControlBar.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -577,7 +577,7 @@ var ControlBar = function (dashjsMediaPlayer, displayUTCTimeCodes) {
var info = '';

if (element.lang) {
info += 'Language - ' + element.lang + ' ';
info += 'Language: ' + element.lang + ' ';
}

if (element.roles && element.roles.length > 0) {
Expand All @@ -596,6 +596,10 @@ var ControlBar = function (dashjsMediaPlayer, displayUTCTimeCodes) {
info += '- Id: ' + element.id + ' ';
}

if (element.isPreselection) {
info += '- Preselection';
}

return label || info
};
trackSwitchMenu = createMenu(availableTracks, contentFunc);
Expand Down Expand Up @@ -785,6 +789,9 @@ var ControlBar = function (dashjsMediaPlayer, displayUTCTimeCodes) {
};

var isTracksEqual = function (t1, t2) {
if (!t1 && !t2) return true;
if (!t1 || !t2) return false;
if (t1.isPreselection !== t2.isPreselection) return false;
var sameId = t1.id === t2.id;
var sameViewpoint = t1.viewpoint === t2.viewpoint;
var sameLang = t1.lang === t2.lang;
Expand Down
48 changes: 40 additions & 8 deletions index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -415,6 +415,8 @@ declare namespace dashjs {

getCodec(adaptation: object, representationIndex: number, addResolutionInfo: boolean): string;

getCodecForPreselection(preselection: Preselection, adaptations: AdaptationSet[], addResolutionInfo: boolean): string;

getContentProtectionByAdaptation(adaptation: object): any;

getContentProtectionByManifest(manifest: object): any[];
Expand All @@ -427,7 +429,7 @@ declare namespace dashjs {

getEndTimeForLastPeriod(voPeriod: Period): number;

getEssentialPropertiesForRepresentation(realRepresentation: object): { schemeIdUri: string, value: string }
getEssentialProperties(element: object): DescriptorType | [];

getEventStreamForAdaptationSet(manifest: object, adaptation: object): EventStream[];

Expand Down Expand Up @@ -467,12 +469,22 @@ declare namespace dashjs {

getLoction(manifest: object): MpdLocation | [];

getMainAdaptationSetForPreselection(preselection: Preselection, adaptations: AdaptationSet[]): AdaptationSet | undefined;

getCommonRepresentationForPreselection(preselection: Preselection, adaptations: AdaptationSet[]): Representation | undefined;

getManifestUpdatePeriod(manifest: object, latencyOfLastUpdate?: number): number;

getMimeType(adaptation: object): object;

getMpd(manifest: object): Mpd;

getPatchLocation(manifest: object): PatchLocation[];

getPreselectionIsTypeOf(preselection: Preselection, adaptations: AdaptationSet[], type: MediaType): boolean;

getPreselectionsForPeriod(voPeriod: object): Preselection[];

getPeriodId(realPeriod: Period, i: number): string;

getProducerReferenceTimesForAdaptation(adaptation: object): any[];
Expand Down Expand Up @@ -509,9 +521,7 @@ declare namespace dashjs {

getSuggestedPresentationDelay(mpd: Mpd): any;

getSupplementalPropertiesForAdaptation(adaptation: object): DescriptorType | [];

getSupplementalPropertiesForRepresentation(representation: Representation): DescriptorType | [];
getSupplementalProperties(element: object): DescriptorType | [];

getUTCTimingSources(manifest: object): any[];

Expand Down Expand Up @@ -672,6 +682,7 @@ declare namespace dashjs {

export class AdaptationSet {
period: Period | null;
id: string | null;
index: number;
type: string | null;
}
Expand Down Expand Up @@ -879,6 +890,7 @@ declare namespace dashjs {
index: number | null;
isEmbedded: any | null;
isFragmented: any | null;
isPreselection: boolean;
isText: boolean;
labels: { text: string, lang?: string }[];
lang: string | null;
Expand Down Expand Up @@ -944,6 +956,16 @@ declare namespace dashjs {
start: number;
}

export interface Preselection {
period: Period | null;
index: number;
id: string | null;
order: string | null;
preselectionComponents: any[];
tag: string | null;
type: string | null;
}

export interface ProducerReferenceTime {
UTCTiming: any;
applicationSchme: any;
Expand Down Expand Up @@ -1056,13 +1078,15 @@ declare namespace dashjs {

getCodec(adaptation: object, representationIndex: number, addResolutionInfo: boolean): string;

getCodecForPreselection(preselection: Preselection, adaptations: AdaptationSet[]): string;

getCommonRepresentationForPreselection(preselection: Preselection, adaptations: AdaptationSet[]): Representation | null;

getContentSteering(manifest: object): object;

getDuration(externalManifest?: object): number;

getEssentialPropertiesAdaptationSet(adaptationSet: AdaptationSet): object | [];

getEssentialPropertiesForRepresentation(representation: Representation): any[];
getEssentialProperties(element: AdaptationSet | Representation | Preselection): DescriptorType | [];

getEvent(eventBox: object, eventStreams: object, mediaStartTime: number, voRepresentation: object): null | Event;

Expand All @@ -1086,6 +1110,10 @@ declare namespace dashjs {

getLocation(manifest: object): MpdLocation[];

getMainAdaptationForType(type: string, streamInfo: object): object;

getMainAdaptationSetForPreselection(preselection: Preselection, adaptations: AdaptationSet[]): AdaptationSet | undefined;

getManifestUpdatePeriod(manifest: object, latencyOfLastUpdate?: number): number;

getMediaInfoForType(streamInfo: object, type: MediaType): MediaInfo | null;
Expand All @@ -1096,6 +1124,8 @@ declare namespace dashjs {

getPeriodById(id: string): Period | null;

getPreselectionIsTypeOf(preselection: Preselection, adaptations: AdaptationSet[], type: MediaType): boolean;

getProducerReferenceTime(streamInfo: StreamInfo, mediaInfo: MediaInfo): object | [];

getPublishTime(manifest: object): number | null;
Expand All @@ -1112,7 +1142,7 @@ declare namespace dashjs {

getSuggestedPresentationDelay(): string;

getSupplementalCodex(representation: Representation): Array<any>;
getSupplementalCodecs(representation: Representation): Array<any>;

getUTCTimingSources(): any[];

Expand Down Expand Up @@ -1771,6 +1801,8 @@ declare namespace dashjs {
video?: TrackSwitchMode;
audio?: TrackSwitchMode;
};
includePreselectionsInMediainfo?: boolean;
includePreselectionsForInitialTrackSelection?: boolean;
ignoreSelectionPriority?: boolean;
prioritizeRoleMain?: boolean;
assumeDefaultRoleAsMain?: boolean;
Expand Down
10 changes: 10 additions & 0 deletions src/core/Settings.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,8 @@ import Events from './events/Events.js';
* audio: Constants.TRACK_SWITCH_MODE_ALWAYS_REPLACE,
* video: Constants.TRACK_SWITCH_MODE_NEVER_REPLACE
* },
* includePreselectionsInMediainfoArray: true,
* includePreselectionsForInitialTrackSelection: false,
* ignoreSelectionPriority: false,
* prioritizeRoleMain: true,
* assumeDefaultRoleAsMain: true,
Expand Down Expand Up @@ -1007,6 +1009,12 @@ import Events from './events/Events.js';
* - Constants.TRACK_SWITCH_MODE_NEVER_REPLACE
* Do not replace existing segments in the buffer
*
* @property {} [includePreselectionsInMediainfoArray: true]
* provides the option to include Preselections in the MediaInfo object
*
* @property {} [includePreselectionsForInitialTrackSelection: false]
* provides the option to include Preselections for initial track selection
*
* @property {} [ignoreSelectionPriority: false]
* provides the option to disregard any signalled selectionPriority attribute. If disabled and if no initial media settings are set, track selection is accomplished as defined by selectionModeForInitialTrack.
*
Expand Down Expand Up @@ -1246,6 +1254,8 @@ function Settings() {
audio: Constants.TRACK_SWITCH_MODE_ALWAYS_REPLACE,
video: Constants.TRACK_SWITCH_MODE_NEVER_REPLACE
},
includePreselectionsInMediainfoArray: true,
includePreselectionsForInitialTrackSelection: false,
ignoreSelectionPriority: false,
prioritizeRoleMain: true,
assumeDefaultRoleAsMain: true,
Expand Down
Loading