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

Fix subtitle track selection when reusing media element with mismatched TextTracks #5880

Merged
merged 3 commits into from
Oct 10, 2023
Merged

Fix subtitle track selection when reusing media element with mismatched TextTracks #5880

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4a0b616
Use subtitle track name and language to find and match subtitle/capti…
robwalch Oct 5, 2023
6562c19
Fix regression in dev where AUDIO_TRACKS_UPDATED is re-dispatched wit…
robwalch Oct 6, 2023
230a7d8
Fix TextTrack use with ASSOC-LANGUAGE
robwalch Oct 6, 2023
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
132 changes: 67 additions & 65 deletions src/controller/audio-track-controller.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,10 +58,10 @@ class AudioTrackController extends BasePlaylistController {

protected onManifestLoading(): void {
this.tracks = [];
this.groupIds = null;
this.tracksInGroup = [];
this.trackId = -1;
this.groupIds = null;
this.currentTrack = null;
this.trackId = -1;
this.selectDefaultTrack = true;
}

Expand Down Expand Up @@ -113,40 +113,48 @@ class AudioTrackController extends BasePlaylistController {

private switchLevel(levelIndex: number) {
const levelInfo = this.hls.levels[levelIndex];

if (!levelInfo) {
return;
}

const audioGroups = levelInfo.audioGroups || null;
const currentGroups = this.groupIds;
const currentTrack = this.currentTrack;
if (
!audioGroups ||
currentGroups?.length !== audioGroups?.length ||
audioGroups?.some((groupId) => currentGroups?.indexOf(groupId) === -1)
) {
this.groupIds = audioGroups;
this.trackId = -1;
this.currentTrack = null;

const audioTracks = this.tracks.filter(
(track): boolean =>
!audioGroups || audioGroups.indexOf(track.groupId) !== -1,
);

// Disable selectDefaultTrack if there are no default tracks
if (
this.selectDefaultTrack &&
!audioTracks.some((track) => track.default)
) {
this.selectDefaultTrack = false;
}
if (!audioTracks.length) {
this.trackId = -1;
this.currentTrack = null;
if (audioTracks.length) {
// Disable selectDefaultTrack if there are no default tracks
if (
this.selectDefaultTrack &&
!audioTracks.some((track) => track.default)
) {
this.selectDefaultTrack = false;
}
// track.id should match hls.audioTracks index
audioTracks.forEach((track, i) => {
track.id = i;
});
} else if (!currentTrack && !this.tracksInGroup.length) {
// Do not dispatch AUDIO_TRACKS_UPDATED when there were and are no tracks
return;
}
audioTracks.forEach((track, i) => {
track.id = i;
});

this.tracksInGroup = audioTracks;
let trackId = this.findTrackId(currentTrack);
if (trackId === -1 && currentTrack) {
trackId = this.findTrackId(null);
}

const audioTracksUpdated: AudioTracksUpdatedData = { audioTracks };
this.log(
`Updating audio tracks, ${
Expand All @@ -155,8 +163,25 @@ class AudioTrackController extends BasePlaylistController {
);
this.hls.trigger(Events.AUDIO_TRACKS_UPDATED, audioTracksUpdated);

this.selectInitialTrack();
} else if (this.shouldReloadPlaylist(this.currentTrack)) {
const selectedTrackId = this.trackId;
if (trackId !== -1 && selectedTrackId === -1) {
this.setAudioTrack(trackId);
} else if (audioTracks.length && selectedTrackId === -1) {
const error = new Error(
`No audio track selected for current audio group-ID(s): ${this.groupIds?.join(
',',
)} track count: ${audioTracks.length}`,
);
this.warn(error.message);

this.hls.trigger(Events.ERROR, {
type: ErrorTypes.MEDIA_ERROR,
details: ErrorDetails.AUDIO_TRACK_LOAD_ERROR,
fatal: true,
error,
});
}
} else if (this.shouldReloadPlaylist(currentTrack)) {
// Retry playlist loading if no playlist is or has been loaded yet
this.setAudioTrack(this.trackId);
}
Expand Down Expand Up @@ -228,55 +253,32 @@ class AudioTrackController extends BasePlaylistController {
this.loadPlaylist(hlsUrlParameters);
}

private selectInitialTrack(): void {
const audioTracks = this.tracksInGroup;
if (!audioTracks.length) {
return;
}
let trackId = this.findTrackId(this.currentTrack);
if (trackId === -1) {
trackId = this.findTrackId(null);
}

if (trackId !== -1) {
this.setAudioTrack(trackId);
} else {
const error = new Error(
`No track found for running audio group-ID(s): ${this.groupIds?.join(
',',
)} track count: ${audioTracks.length}`,
);
this.warn(error.message);

this.hls.trigger(Events.ERROR, {
type: ErrorTypes.MEDIA_ERROR,
details: ErrorDetails.AUDIO_TRACK_LOAD_ERROR,
fatal: true,
error,
});
}
}

private findTrackId(currentTrack: MediaPlaylist | null): number {
const audioTracks = this.tracksInGroup;
for (let i = 0; i < audioTracks.length; i++) {
const track = audioTracks[i];
if (!this.selectDefaultTrack || track.default) {
if (
!currentTrack ||
mediaAttributesIdentical(currentTrack.attrs, track.attrs)
) {
return track.id;
}
if (
mediaAttributesIdentical(currentTrack.attrs, track.attrs, [
'LANGUAGE',
'ASSOC-LANGUAGE',
'CHARACTERISTICS',
])
) {
return track.id;
}
if (this.selectDefaultTrack && !track.default) {
continue;
}
if (
!currentTrack ||
mediaAttributesIdentical(currentTrack.attrs, track.attrs)
) {
return track.id;
}
if (
mediaAttributesIdentical(currentTrack.attrs, track.attrs, [
'LANGUAGE',
'ASSOC-LANGUAGE',
'CHARACTERISTICS',
])
) {
return track.id;
}
if (
mediaAttributesIdentical(currentTrack.attrs, track.attrs, ['LANGUAGE'])
) {
return track.id;
}
}
return -1;
Expand Down
Loading