Files
plezy/lib/services/track_selection_service.dart
T
edde746 f4ce60611b fix(subtitles): let the server deliver subtitles on a transcode
Two regressions since 2.9.1 broke subtitles on transcoded playback. Since
a1b6a8971 sidecars load with the media behind a 10s open guard, so a
subtitle URL the server is slow to serve — Jellyfin extracting an
embedded stream while its transcoder spins up — tripped the guard: stop,
reopen without subtitles, "Selected subtitles could not be loaded"
snackbar, and an emptied subtitle menu. Since 2b3853a88 every embedded
Plex subtitle was handed to the player as a sidecar whose URL is the
original container, so a transcode also range-read and demuxed the
source over HTTP — for a 40 GB remux, purely to find a subtitle track —
which is also why PGS never appeared: the client was handed a container
to demux rather than a rendition to play.

Delivery is the server's job again, backported from the AVPlayer branch
(42ba01440, the subtitle subset of 6852ac274, and a3da81e83) and adapted
to main's mpv backend:

Plex burns every embedded track (subtitles=burn); only a real external
file with a /library/streams key stays a client-fetched sidecar. A burn
is a re-encode, so directPlay is withdrawn — a real PMS answers HTTP 400
to directPlay=1 with burn — and the burn is aimed by selecting the
stream on the part first via the selectStreams PUT, because the decision
endpoint ignores subtitleStreamID alongside subtitles=burn. An
unaimable or undeliverable burn (dvb_teletext) refuses the transcode and
falls back to warned direct play rather than welding the wrong language
in or silently dropping the caption. Main's per-preset
directPlay/directStream pinning is kept; verified against a live PMS
that burn works under directStream=0.

Jellyfin never offers image formats as External, so bitmaps fall through
to Encode and are burned; text External is withheld per request when the
effective selection — including the server's DefaultSubtitleStreamIndex —
is embedded, and offered when it is a real file, so a file is delivered
as a file and never fetched twice. The burned row is excluded from the
sidecars; remaining text rows stay extractable, which is how a secondary
track still renders over a transcode. Sidecar URLs now use the format
extension the endpoint expects instead of the reported codec name.

The controls and selection layers learn what burning means: burn
eligibility is the codec's property, so burned rows stay selectable in
the menu; any change away from a burned selection renegotiates with the
server instead of pretending a local switch worked; the visibility
shortcut explains itself instead of doing nothing; and the track manager
is told when the primary is server-rendered so it stops waiting out a
thirty-second deadline for a native track that is already pixels.

Verified: analyzer parity, clean_translations --check --strict, full
flutter test (5749), and decision-level runs against live Plex and
Jellyfin servers — text and PGS burn decisions, the directPlay=1+burn
400, External file delivery, an unchanged no-burn baseline, and a real
burn session serving its playlist. The pre-commit aggregate was bypassed
for pre-existing main-state findings outside this diff: 21 format-drifted
files and three unused test seams in lib/main.dart.

close #1738

Refs #1815, #1622.
2026-08-09 07:30:47 +02:00

1376 lines
54 KiB
Dart

import 'dart:async';
import '../mpv/mpv.dart';
import '../media/media_backend.dart';
import '../media/media_item.dart';
import '../media/media_server_user_profile.dart';
import '../media/media_source_info.dart';
import '../utils/future_extensions.dart';
import '../utils/app_logger.dart';
import '../utils/language_codes.dart';
import '../utils/subtitle_forced_semantics.dart';
import 'subtitle_preference.dart';
// These functions match MPV tracks to Plex tracks by properties (language,
// codec, title, etc.) instead of list index, since the two may be ordered
// differently.
/// Score how well an MPV subtitle track matches a Plex subtitle track.
/// Language (+10 / +1 exact) and codec (+5) carry the most weight; title,
/// forced flag, and identical ordinal position (only when [ordinalMatches]
/// is true) add smaller nudges.
int _scoreSubtitleMatch(SubtitleTrack mpvTrack, MediaSubtitleTrack plexTrack, {required bool ordinalMatches}) {
int score = 0;
if (_languagesMatch(mpvTrack.language, plexTrack.languageCode)) {
score += 10;
if (_languageCodesExactMatch(mpvTrack.language, plexTrack.languageCode)) {
score += 1;
}
}
if (_subtitleCodecsMatch(mpvTrack.codec, plexTrack.codec)) {
score += 5;
}
score += _titleScore(mpvTrack.title, plexTrack.title, plexTrack.displayTitle);
if (mpvTrack.effectiveForced == plexTrack.effectiveForced) {
score += 2;
}
if (ordinalMatches) {
score += 1;
}
return score;
}
/// Score how well an MPV audio track matches a Plex audio track.
/// Language (+10 / +1 exact) and codec (+5) dominate; channel count (+3),
/// title match (+2), and identical ordinal position ([ordinalMatches], +1)
/// act as tiebreakers.
int _scoreAudioMatch(AudioTrack mpvTrack, MediaAudioTrack plexTrack, {required bool ordinalMatches}) {
int score = 0;
if (_languagesMatch(mpvTrack.language, plexTrack.languageCode)) {
score += 10;
if (_languageCodesExactMatch(mpvTrack.language, plexTrack.languageCode)) {
score += 1;
}
}
if (_audioCodecsMatch(mpvTrack.codec, plexTrack.codec)) {
score += 5;
}
if (mpvTrack.channels != null && plexTrack.channels != null && mpvTrack.channels == plexTrack.channels) {
score += 3;
}
if (_titlesMatch(mpvTrack.title, plexTrack.title, plexTrack.displayTitle)) {
score += 2;
}
if (ordinalMatches) {
score += 1;
}
return score;
}
enum _DirectEmbeddedSubtitleCatalog { incomplete, complete }
bool _isDirectEmbeddedPlexSubtitle(MediaSubtitleTrack track) => !track.isExternal;
bool _isDirectEmbeddedMpvSubtitle(SubtitleTrack track) =>
track.id != SubtitleTrack.auto.id && track.id != SubtitleTrack.off.id && !track.isExternal && !track.isContainer;
/// Classifies only ordinary direct-embedded rows. External/keyed source
/// subtitles and native container tracks have independent arrival semantics
/// and cannot prove that this catalog is complete.
_DirectEmbeddedSubtitleCatalog _classifyDirectEmbeddedSubtitleCatalog(
List<MediaSubtitleTrack> plexTracks,
List<SubtitleTrack> mpvTracks,
) {
var plexTrackCount = 0;
for (final track in plexTracks) {
if (_isDirectEmbeddedPlexSubtitle(track)) plexTrackCount++;
}
var mpvTrackCount = 0;
for (final track in mpvTracks) {
if (_isDirectEmbeddedMpvSubtitle(track)) mpvTrackCount++;
}
return plexTrackCount > 0 && plexTrackCount == mpvTrackCount
? _DirectEmbeddedSubtitleCatalog.complete
: _DirectEmbeddedSubtitleCatalog.incomplete;
}
bool _hasSubtitleFact(String? value) => value != null && value.trim().isNotEmpty;
bool _lowMetadataSubtitleFactsAreCompatible(SubtitleTrack mpvTrack, MediaSubtitleTrack plexTrack) {
final plexLanguage = plexTrack.languageCode;
if (_hasSubtitleFact(mpvTrack.language) &&
_hasSubtitleFact(plexLanguage) &&
!_languagesMatch(mpvTrack.language, plexLanguage)) {
return false;
}
if (_hasSubtitleFact(mpvTrack.codec) &&
_hasSubtitleFact(plexTrack.codec) &&
!_subtitleCodecsMatch(mpvTrack.codec, plexTrack.codec)) {
return false;
}
final plexHasTitle = _hasSubtitleFact(plexTrack.title) || _hasSubtitleFact(plexTrack.displayTitle);
if (_hasSubtitleFact(mpvTrack.title) &&
plexHasTitle &&
_titleScore(mpvTrack.title, plexTrack.title, plexTrack.displayTitle) == 0) {
return false;
}
return mpvTrack.effectiveForced == plexTrack.effectiveForced;
}
int _scoreLowMetadataSubtitleFacts(SubtitleTrack mpvTrack, MediaSubtitleTrack plexTrack) {
var score = 0;
final plexLanguage = plexTrack.languageCode;
if (_hasSubtitleFact(mpvTrack.language) &&
_hasSubtitleFact(plexLanguage) &&
_languagesMatch(mpvTrack.language, plexLanguage)) {
score += 10;
if (_languageCodesExactMatch(mpvTrack.language, plexLanguage)) score++;
}
if (_hasSubtitleFact(mpvTrack.codec) &&
_hasSubtitleFact(plexTrack.codec) &&
_subtitleCodecsMatch(mpvTrack.codec, plexTrack.codec)) {
score += 5;
}
if (_hasSubtitleFact(mpvTrack.title) &&
(_hasSubtitleFact(plexTrack.title) || _hasSubtitleFact(plexTrack.displayTitle)) &&
_titleScore(mpvTrack.title, plexTrack.title, plexTrack.displayTitle) > 0) {
score += 3;
}
if (mpvTrack.effectiveForced == plexTrack.effectiveForced) score += 2;
return score;
}
T? _findUniqueBestLowMetadataMatch<T extends Object>(
Iterable<T> candidates, {
required bool Function(T candidate) isCompatible,
required int Function(T candidate) score,
}) {
T? bestMatch;
var bestScore = -1;
var bestIsUnique = false;
for (final candidate in candidates) {
if (!isCompatible(candidate)) continue;
final candidateScore = score(candidate);
if (candidateScore > bestScore) {
bestMatch = candidate;
bestScore = candidateScore;
bestIsUnique = true;
} else if (candidateScore == bestScore) {
bestIsUnique = false;
}
}
return bestIsUnique ? bestMatch : null;
}
/// Find the MPV subtitle track that matches a Plex subtitle track
SubtitleTrack? findMpvTrackForPlexSubtitle(
MediaSubtitleTrack plexTrack,
List<SubtitleTrack> mpvTracks, {
List<MediaSubtitleTrack>? allPlexTracks,
}) {
if (mpvTracks.isEmpty) return null;
final sourceId = int.tryParse(plexTrack.id.toString());
if (sourceId != null) {
final exactSourceTrack = mpvTracks.where((track) => track.id == 'source:$sourceId').firstOrNull;
if (exactSourceTrack != null) return exactSourceTrack;
}
// Keyed subtitles have a stable identity. Do not let a sidecar that has not
// arrived yet fall through to fuzzy language/title scoring.
final plexKey = plexTrack.key;
if (plexKey != null && plexKey.isNotEmpty) {
for (final mpvTrack in mpvTracks) {
if (mpvTrack.isExternal && mpvTrack.uri?.contains(plexKey) == true) {
return mpvTrack;
}
}
return null;
}
// For internal subtitles, use scoring based on properties
SubtitleTrack? bestMatch;
int bestScore = 0;
bool bestMatchUsesContainerOrdinal = false;
// Ordinal identity: container sidecars expose embedded subtitle tracks as
// external media, but retain the source container's subtitle ordering.
final containerPlexTracks = allPlexTracks
?.where((track) => track.key == null || track.key!.isEmpty)
.toList(growable: false);
final internalMpvTracks = allPlexTracks == null
? null
: mpvTracks.where((track) => !track.isExternal || track.isContainer).toList(growable: false);
final plexOrdinal = containerPlexTracks?.indexOf(plexTrack) ?? -1;
for (final mpvTrack in mpvTracks) {
// A container sidecar's subtitle tracks map to internal Plex streams.
if (!plexTrack.isExternal && mpvTrack.isExternal && !mpvTrack.isContainer) continue;
final ordinalMatches =
internalMpvTracks != null && plexOrdinal >= 0 && internalMpvTracks.indexOf(mpvTrack) == plexOrdinal;
// A container track has no stable native ID. Its source-container ordinal
// is authoritative; a metadata-identical earlier track is not a match.
// Narrower than the guard in [findPlexTrackForMpvSubtitle]: a Plex stream
// carrying no container ordinal still falls back to metadata scoring.
if (mpvTrack.isContainer && plexOrdinal >= 0 && !ordinalMatches) continue;
final score = _scoreSubtitleMatch(mpvTrack, plexTrack, ordinalMatches: ordinalMatches);
if (score > bestScore) {
bestScore = score;
bestMatch = mpvTrack;
bestMatchUsesContainerOrdinal = mpvTrack.isContainer && ordinalMatches;
}
}
// Prefer metadata matches. Container sidecars may expose no language/title/
// codec at all, so their stable subtitle order is the last-resort identity.
if (bestScore >= 10 || bestMatchUsesContainerOrdinal) return bestMatch;
final plexTracks = allPlexTracks;
if (plexTracks == null ||
!_isDirectEmbeddedPlexSubtitle(plexTrack) ||
_classifyDirectEmbeddedSubtitleCatalog(plexTracks, mpvTracks) != _DirectEmbeddedSubtitleCatalog.complete) {
return null;
}
// A complete ordinary direct catalog may safely resolve low-metadata rows
// only from their facts. Native order is deliberately not an identity.
return _findUniqueBestLowMetadataMatch(
mpvTracks.where(_isDirectEmbeddedMpvSubtitle),
isCompatible: (candidate) => _lowMetadataSubtitleFactsAreCompatible(candidate, plexTrack),
score: (candidate) => _scoreLowMetadataSubtitleFacts(candidate, plexTrack),
);
}
/// Find the Plex subtitle track that matches an MPV subtitle track
MediaSubtitleTrack? findPlexTrackForMpvSubtitle(
SubtitleTrack mpvTrack,
List<MediaSubtitleTrack> plexTracks, {
List<SubtitleTrack>? allMpvTracks,
}) {
if (plexTracks.isEmpty) return null;
if (mpvTrack.id.startsWith('source:')) {
final sourceId = int.tryParse(mpvTrack.id.substring('source:'.length));
if (sourceId != null) {
final exactSourceTrack = plexTracks.where((track) => track.id == sourceId).firstOrNull;
if (exactSourceTrack != null) return exactSourceTrack;
}
}
// A standalone keyed subtitle maps back only by its stable Plex key.
// Container sidecars may continue to the source-container matcher below.
if (mpvTrack.isExternal && mpvTrack.uri != null) {
for (final plexTrack in plexTracks) {
final plexKey = plexTrack.key;
if (plexKey != null && plexKey.isNotEmpty && mpvTrack.uri!.contains(plexKey)) {
return plexTrack;
}
}
if (!mpvTrack.isContainer) return null;
}
// For internal subtitles, use scoring based on properties
MediaSubtitleTrack? bestMatch;
int bestScore = 0;
bool bestMatchUsesContainerOrdinal = false;
// Ordinal identity: container-sidecar tracks map back to source-container
// streams even though the native player marks their source as external.
final mpvIsInternal = !mpvTrack.isExternal || mpvTrack.isContainer;
final containerPlexTracks = allMpvTracks == null
? null
: plexTracks.where((track) => track.key == null || track.key!.isEmpty).toList(growable: false);
final mpvOrdinal = allMpvTracks == null
? -1
: allMpvTracks.where((track) => !track.isExternal || track.isContainer).toList().indexOf(mpvTrack);
for (final plexTrack in plexTracks) {
if (mpvIsInternal && plexTrack.isExternal) continue;
final ordinalMatches =
containerPlexTracks != null && mpvOrdinal >= 0 && containerPlexTracks.indexOf(plexTrack) == mpvOrdinal;
// The probe fixes isContainer here, so once a container ordinal list exists
// a container track matches at its own ordinal or not at all.
if (mpvTrack.isContainer && containerPlexTracks != null && !ordinalMatches) continue;
final score = _scoreSubtitleMatch(mpvTrack, plexTrack, ordinalMatches: ordinalMatches);
if (score > bestScore) {
bestScore = score;
bestMatch = plexTrack;
bestMatchUsesContainerOrdinal = mpvTrack.isContainer && ordinalMatches;
}
}
// Prefer metadata matches, with container order as the symmetric fallback
// needed to persist a metadata-free native track back to its Plex stream.
if (bestScore >= 10 || bestMatchUsesContainerOrdinal) return bestMatch;
final mpvTracks = allMpvTracks;
if (mpvTracks == null ||
!_isDirectEmbeddedMpvSubtitle(mpvTrack) ||
_classifyDirectEmbeddedSubtitleCatalog(plexTracks, mpvTracks) != _DirectEmbeddedSubtitleCatalog.complete) {
return null;
}
return _findUniqueBestLowMetadataMatch(
plexTracks.where(_isDirectEmbeddedPlexSubtitle),
isCompatible: (candidate) => _lowMetadataSubtitleFactsAreCompatible(mpvTrack, candidate),
score: (candidate) => _scoreLowMetadataSubtitleFacts(mpvTrack, candidate),
);
}
/// Find the source-catalog row that serves a cross-item subtitle intent.
///
/// Identity matching ([findPlexTrackForMpvSubtitle]) answers "which row IS
/// this track"; this answers "which row of a DIFFERENT item serves the same
/// intent". Effective forced-ness is a hard requirement, and so is language
/// when both sides declare one: the intent's class is preserved or the match
/// declines, so the selection ladder can fall back to the server's own
/// per-item choice (#1716/#1717).
///
/// When language metadata is missing on either side, a unique real title
/// match may vouch for the row instead (#1785) — untagged tracks whose only
/// signal is a title like "Swedish" are common, and declining them turned the
/// viewer's subtitles off on every episode advance. Codec/external parity is
/// never sufficient evidence on its own (an arbitrary untagged row would
/// reintroduce the #1716 wrong-track class); technical parity only breaks
/// ties the stronger tiers left, and any tie still standing at the top
/// declines rather than guesses — in every band, so two indistinguishable
/// same-language rows never latch by catalog order.
MediaSubtitleTrack? findSourceTrackForIntent(SubtitleIntent intent, List<MediaSubtitleTrack> sourceTracks) {
return _findTrackByEvidenceBands(
sourceTracks,
intentLanguage: intent.language,
isSelectable: (_) => true,
classMatches: (row) => row.effectiveForced == intent.forced,
language: (row) => row.languageCode ?? row.language,
titleScore: (row) => _titleScore(intent.title, row.title, row.displayTitle),
codecMatches: (row) => _subtitleCodecsMatch(intent.codec, row.codec),
extraScore: (row) => intent.isExternal == row.isExternal ? 1 : 0,
);
}
/// Native-track twin of [findSourceTrackForIntent], for catalogs the source
/// side cannot describe (legacy offline sidecars) and late-arriving tracks.
SubtitleTrack? findNativeTrackForIntent(SubtitleIntent intent, List<SubtitleTrack> tracks) {
return _findTrackByEvidenceBands(
tracks,
intentLanguage: intent.language,
isSelectable: (track) => track.id != SubtitleTrack.auto.id && track.id != SubtitleTrack.off.id,
classMatches: (track) => track.effectiveForced == intent.forced,
language: (track) => track.language,
titleScore: (track) => _titleScore(intent.title, track.title, null),
codecMatches: (track) => _subtitleCodecsMatch(intent.codec, track.codec),
extraScore: (track) => intent.isExternal == track.isExternal ? 1 : 0,
);
}
/// Audio twin of [findSourceTrackForIntent]: the source-catalog row that
/// serves a cross-item audio carry. [carried] is a semantic vehicle — its id
/// belongs to another item; language, title, codec, and channels are the
/// signal. Audio has no forced-class gate; channel-count parity replaces the
/// external-parity tiebreaker.
MediaAudioTrack? findSourceAudioTrackForIntent(AudioTrack carried, List<MediaAudioTrack> rows) {
return _findTrackByEvidenceBands(
rows,
intentLanguage: carried.language,
isSelectable: (_) => true,
classMatches: (_) => true,
language: (row) => row.languageCode ?? row.language,
titleScore: (row) => _titleScore(carried.title, row.title, row.displayTitle),
codecMatches: (row) => _audioCodecsMatch(carried.codec, row.codec),
extraScore: (row) => carried.channels != null && carried.channels == row.channels ? 1 : 0,
);
}
/// Native twin of [findSourceAudioTrackForIntent].
AudioTrack? findNativeAudioTrackForIntent(AudioTrack carried, List<AudioTrack> tracks) {
return _findTrackByEvidenceBands(
tracks,
intentLanguage: carried.language,
isSelectable: (track) => track.id != AudioTrack.auto.id && track.id != AudioTrack.off.id,
classMatches: (_) => true,
language: (track) => track.language,
titleScore: (track) => _titleScore(carried.title, track.title, null),
codecMatches: (track) => _audioCodecsMatch(carried.codec, track.codec),
extraScore: (track) => carried.channels != null && carried.channels == track.channels ? 1 : 0,
);
}
/// Sentinel id for a cross-item audio carry. Native player ids ('1', '2', …)
/// and Jellyfin `source:<Index>` ids are reused per item, so a carried track
/// with its original id can identity-match a DIFFERENT track that happens to
/// sit at the same position on the next episode — bypassing the evidence
/// bands and their ambiguity decline.
const String carriedAudioTrackId = 'carried';
/// Strips item-bound identity from an audio carry so only its semantics may
/// speak — the audio twin of [SubtitlePreference.demoteToIntent]. Same-item
/// reloads keep the original track and its identity fast path.
AudioTrack itemAgnosticAudioCarry(AudioTrack track) => track.copyWith(id: carriedAudioTrackId);
/// Shared evidence matcher behind the cross-item intent matchers.
///
/// Candidates are compared lexicographically, strongest evidence first:
/// declared-language parity, then the semantic title/role match, then
/// technical parity (codec, then channels/external). Each tier only breaks
/// ties left by the tiers above it — a codec that changed between episodes
/// can never outvote the title that names the viewer's track, and language
/// parity always outranks a title coincidence. A tie left standing at the
/// top means the catalog cannot say which row the viewer meant: the match
/// declines and the ladder falls to the server's own per-item choice.
T? _findTrackByEvidenceBands<T extends Object>(
List<T> candidates, {
required String? intentLanguage,
required bool Function(T) isSelectable,
required bool Function(T) classMatches,
required String? Function(T) language,
required int Function(T) titleScore,
required bool Function(T) codecMatches,
required int Function(T) extraScore,
}) {
T? bestMatch;
List<int>? bestKey;
var bestIsAmbiguous = false;
for (final candidate in candidates) {
if (!isSelectable(candidate)) continue;
if (!classMatches(candidate)) continue;
final candidateLanguage = language(candidate);
final candidateTitleScore = titleScore(candidate);
final hasLanguageParity = intentLanguage != null && candidateLanguage != null;
if (hasLanguageParity) {
// A declared language on both sides stays authoritative: a
// contradiction declines no matter what the title says.
if (!_languagesMatch(intentLanguage, candidateLanguage)) continue;
} else if (candidateTitleScore < 3) {
// Language evidence is missing on at least one side; only a real
// title match may serve the intent then.
continue;
}
final key = [
hasLanguageParity ? 1 : 0,
candidateTitleScore,
codecMatches(candidate) ? 1 : 0,
extraScore(candidate),
];
final comparison = bestKey == null ? 1 : _compareEvidenceKeys(key, bestKey);
if (comparison > 0) {
bestKey = key;
bestMatch = candidate;
bestIsAmbiguous = false;
} else if (comparison == 0) {
bestIsAmbiguous = true;
}
}
if (bestIsAmbiguous) return null;
return bestMatch;
}
int _compareEvidenceKeys(List<int> a, List<int> b) {
for (var i = 0; i < a.length; i++) {
if (a[i] != b[i]) return a[i].compareTo(b[i]);
}
return 0;
}
/// Find the MPV audio track that matches a Plex audio track
AudioTrack? findMpvTrackForPlexAudio(
MediaAudioTrack plexTrack,
List<AudioTrack> mpvTracks, {
List<MediaAudioTrack>? allPlexTracks,
}) {
if (mpvTracks.isEmpty) return null;
AudioTrack? bestMatch;
int bestScore = 0;
// Ordinal identity is cross-side: the probe's index in the Plex list against
// the candidate's index in the MPV list.
final plexOrdinal = allPlexTracks?.indexOf(plexTrack) ?? -1;
for (final mpvTrack in mpvTracks) {
final ordinalMatches = plexOrdinal >= 0 && mpvTracks.indexOf(mpvTrack) == plexOrdinal;
final score = _scoreAudioMatch(mpvTrack, plexTrack, ordinalMatches: ordinalMatches);
if (score > bestScore) {
bestScore = score;
bestMatch = mpvTrack;
}
}
// Require at least language match for a valid match
return bestScore >= 10 ? bestMatch : null;
}
/// Find the Plex audio track that matches an MPV audio track
MediaAudioTrack? findPlexTrackForMpvAudio(
AudioTrack mpvTrack,
List<MediaAudioTrack> plexTracks, {
List<AudioTrack>? allMpvTracks,
}) {
if (plexTracks.isEmpty) return null;
MediaAudioTrack? bestMatch;
int bestScore = 0;
// Same cross-side ordinal rule as [findMpvTrackForPlexAudio] with the two
// lists swapped; the score arguments stay MPV-first either way.
final mpvOrdinal = allMpvTracks?.indexOf(mpvTrack) ?? -1;
for (final plexTrack in plexTracks) {
final ordinalMatches = mpvOrdinal >= 0 && plexTracks.indexOf(plexTrack) == mpvOrdinal;
final score = _scoreAudioMatch(mpvTrack, plexTrack, ordinalMatches: ordinalMatches);
if (score > bestScore) {
bestScore = score;
bestMatch = plexTrack;
}
}
// Require at least language match for a valid match
return bestScore >= 10 ? bestMatch : null;
}
/// Check if two language codes match exactly (after normalizing case and stripping region suffixes)
bool _languageCodesExactMatch(String? a, String? b) {
if (a == null || b == null) return false;
return a.toLowerCase().split('-').first == b.toLowerCase().split('-').first;
}
/// Check if two language codes refer to the same language
/// Handles both ISO 639-1 (2-letter) and ISO 639-2 (3-letter) codes
bool _languagesMatch(String? mpvLang, String? plexLang) {
if (mpvLang == null || plexLang == null) return false;
final mpvNormalized = mpvLang.toLowerCase().split('-').first;
final plexNormalized = plexLang.toLowerCase().split('-').first;
// Direct match
if (mpvNormalized == plexNormalized) return true;
final mpvVariations = LanguageCodes.getVariations(mpvNormalized);
return mpvVariations.contains(plexNormalized);
}
/// Check if two subtitle codec strings match
/// Handles common aliases (e.g., subrip/srt, ass/ssa)
bool _subtitleCodecsMatch(String? mpvCodec, String? plexCodec) {
if (mpvCodec == null || plexCodec == null) return false;
final mpvNorm = mpvCodec.toLowerCase();
final plexNorm = plexCodec.toLowerCase();
if (mpvNorm == plexNorm) return true;
// Common subtitle codec aliases
const aliases = {
'subrip': ['srt', 'subrip'],
'srt': ['srt', 'subrip'],
'ass': ['ass', 'ssa'],
'ssa': ['ass', 'ssa'],
'pgs': ['pgs', 'hdmv_pgs_subtitle'],
'hdmv_pgs_subtitle': ['pgs', 'hdmv_pgs_subtitle'],
'vobsub': ['vobsub', 'dvd_subtitle'],
'dvd_subtitle': ['vobsub', 'dvd_subtitle'],
'webvtt': ['webvtt', 'vtt'],
'vtt': ['webvtt', 'vtt'],
};
final mpvAliases = aliases[mpvNorm] ?? [mpvNorm];
return mpvAliases.contains(plexNorm);
}
/// Check if two audio codec strings match
/// Handles common aliases (e.g., ac3/a52, dts variants)
bool _audioCodecsMatch(String? mpvCodec, String? plexCodec) {
if (mpvCodec == null || plexCodec == null) return false;
final mpvNorm = mpvCodec.toLowerCase();
final plexNorm = plexCodec.toLowerCase();
if (mpvNorm == plexNorm) return true;
// Common audio codec aliases
const aliases = {
'ac3': ['ac3', 'a52', 'eac3', 'dolby digital'],
'a52': ['ac3', 'a52'],
'eac3': ['eac3', 'e-ac-3', 'dolby digital plus', 'ac3'],
'dts': ['dts', 'dca'],
'dca': ['dts', 'dca'],
'aac': ['aac', 'mp4a'],
'mp4a': ['aac', 'mp4a'],
'truehd': ['truehd', 'mlp'],
'mlp': ['truehd', 'mlp'],
'flac': ['flac'],
'opus': ['opus'],
'vorbis': ['vorbis', 'ogg'],
'mp3': ['mp3', 'mp3float'],
};
final mpvAliases = aliases[mpvNorm] ?? [mpvNorm];
return mpvAliases.contains(plexNorm);
}
/// Score how well titles match.
/// Returns 3 for a real text match, 1 for null/empty (non-contradicting), 0 for mismatch.
int _titleScore(String? mpvTitle, String? plexTitle, String? plexDisplayTitle) {
if (mpvTitle == null || mpvTitle.isEmpty) return 1; // No title to contradict — mild bonus
final mpvNorm = mpvTitle.toLowerCase().trim();
// Check exact match with either Plex title
if (plexTitle != null && plexTitle.toLowerCase().trim() == mpvNorm) return 3;
if (plexDisplayTitle != null && plexDisplayTitle.toLowerCase().trim() == mpvNorm) return 3;
// Check if one contains the other (partial match)
if (plexTitle != null && plexTitle.toLowerCase().contains(mpvNorm)) return 3;
if (plexDisplayTitle != null && plexDisplayTitle.toLowerCase().contains(mpvNorm)) return 3;
return 0;
}
/// Check if titles match (fuzzy comparison) — used by audio matching
bool _titlesMatch(String? mpvTitle, String? plexTitle, String? plexDisplayTitle) {
return _titleScore(mpvTitle, plexTitle, plexDisplayTitle) > 0;
}
int _mediaTrackStreamIndex(int id, int? index) => index ?? id;
/// Priority levels for track selection
enum TrackSelectionPriority {
navigation, // Priority 1: User's manual selection from previous episode
serverSelected, // Priority 2: server's pre-selected track
perMedia, // Priority 3: Per-media language preference
profile, // Priority 4: User profile preferences
defaultTrack, // Priority 5: Default or first track
off, // Priority 6: Subtitles off (subtitle only)
}
/// Result of track selection including the selected track and which priority was used
class TrackSelectionResult<T> {
final T track;
final TrackSelectionPriority priority;
const TrackSelectionResult(this.track, this.priority);
}
/// Service for selecting and applying audio and subtitle tracks based on
/// preferences, user profiles, and per-media settings.
class TrackSelectionService {
final Player? player;
final MediaServerUserProfile? profileSettings;
final MediaItem metadata;
final MediaSourceInfo? plexMediaInfo;
TrackSelectionService({this.player, this.profileSettings, required this.metadata, this.plexMediaInfo});
/// Build list of preferred languages from a user profile
List<String> _buildPreferredLanguages(MediaServerUserProfile profile, {required bool isAudio}) {
final primary = isAudio ? profile.defaultAudioLanguage : profile.defaultSubtitleLanguage;
final list = isAudio ? profile.defaultAudioLanguages : profile.defaultSubtitleLanguages;
final result = <String>[];
if (primary != null && primary.isNotEmpty) {
result.add(primary);
}
if (list != null) {
result.addAll(list);
}
return result;
}
/// Find a track by preferred language with variation lookup and logging
T? _findTrackByPreferredLanguage<T>(
List<T> tracks,
String preferredLanguage,
String? Function(T) getLanguage,
String Function(T) getDescription,
String trackType,
) {
final languageVariations = LanguageCodes.getVariations(preferredLanguage);
return _findTrackByLanguageVariations<T>(
tracks,
preferredLanguage,
languageVariations,
getLanguage,
getDescription,
trackType,
);
}
/// Apply a filter to tracks, falling back to original if filter produces empty result
/// Generic track matching for audio and subtitle tracks
/// Returns the best matching track based on hierarchical criteria:
/// 1. Exact match (id + title + language)
/// 2. Partial match (title + language)
/// 3. Language-only match
T? findBestTrackMatch<T>(
List<T> availableTracks,
T preferred,
String Function(T) getId,
String? Function(T) getTitle,
String? Function(T) getLanguage,
) {
if (availableTracks.isEmpty) return null;
// Filter out auto and no tracks
final validTracks = availableTracks.where((t) => getId(t) != 'auto' && getId(t) != 'no').toList();
if (validTracks.isEmpty) return null;
final preferredId = getId(preferred);
final preferredTitle = getTitle(preferred);
final preferredLanguage = getLanguage(preferred);
// Try to match: id, title, and language
for (final track in validTracks) {
if (getId(track) == preferredId && getTitle(track) == preferredTitle && getLanguage(track) == preferredLanguage) {
return track;
}
}
// Try to match: title and language
for (final track in validTracks) {
if (getTitle(track) == preferredTitle && getLanguage(track) == preferredLanguage) {
return track;
}
}
// Try to match: language only
for (final track in validTracks) {
if (getLanguage(track) == preferredLanguage) {
return track;
}
}
return null;
}
AudioTrack? findAudioTrackByProfile(List<AudioTrack> availableTracks, MediaServerUserProfile profile) {
if (availableTracks.isEmpty || !profile.autoSelectAudio) return null;
final preferredLanguages = _buildPreferredLanguages(profile, isAudio: true);
if (preferredLanguages.isEmpty) return null;
for (final preferredLanguage in preferredLanguages) {
final match = _findTrackByPreferredLanguage<AudioTrack>(
availableTracks,
preferredLanguage,
(t) => t.language,
(t) => t.title ?? 'Track ${t.id}',
'audio track',
);
if (match != null) return match;
}
return null;
}
SubtitleTrack? _findSubtitleTrackByProfile(
List<SubtitleTrack> availableTracks,
MediaServerUserProfile profile, {
bool forcedOnly = false,
}) {
final candidates = forcedOnly ? availableTracks.where((track) => track.effectiveForced).toList() : availableTracks;
if (candidates.isEmpty) return null;
final preferredLanguages = _buildPreferredLanguages(profile, isAudio: false);
if (preferredLanguages.isEmpty) return null;
for (final preferredLanguage in preferredLanguages) {
final match = _findTrackByPreferredLanguage<SubtitleTrack>(
candidates,
preferredLanguage,
(track) => track.language,
(track) => track.title ?? 'Track ${track.id}',
'subtitle track',
);
if (match != null) return match;
}
return null;
}
SubtitleTrack? _findDefaultSubtitleTrack(List<SubtitleTrack> availableTracks) {
for (final track in availableTracks) {
if (track.isDefault) return track;
}
return null;
}
SubtitleTrack? _findFirstSubtitleTrack(List<SubtitleTrack> availableTracks) {
return availableTracks.isEmpty ? null : availableTracks.first;
}
SubtitleTrack? _findForcedSubtitleTrack(List<SubtitleTrack> availableTracks) {
for (final track in availableTracks) {
if (track.effectiveForced) return track;
}
return null;
}
bool _audioMatchesProfile(AudioTrack? selectedAudioTrack, MediaServerUserProfile profile) {
if (selectedAudioTrack == null) return false;
final preferredLanguages = _buildPreferredLanguages(profile, isAudio: true);
if (preferredLanguages.isEmpty) return false;
return preferredLanguages.any((language) => languageMatches(selectedAudioTrack.language, language));
}
TrackSelectionResult<SubtitleTrack>? _selectSubtitleTrackByProfile(
List<SubtitleTrack> availableTracks,
AudioTrack? selectedAudioTrack,
) {
final profile = profileSettings;
final mode = profile?.subtitleMode;
if (profile == null || mode == null || mode == SubtitlePlaybackMode.defaultMode) return null;
SubtitleTrack? selected;
switch (mode) {
case SubtitlePlaybackMode.none:
selected = SubtitleTrack.off;
break;
case SubtitlePlaybackMode.onlyForced:
selected =
_findSubtitleTrackByProfile(availableTracks, profile, forcedOnly: true) ??
_findForcedSubtitleTrack(availableTracks) ??
SubtitleTrack.off;
break;
case SubtitlePlaybackMode.always:
selected =
_findSubtitleTrackByProfile(availableTracks, profile) ??
_findDefaultSubtitleTrack(availableTracks) ??
_findFirstSubtitleTrack(availableTracks) ??
SubtitleTrack.off;
break;
case SubtitlePlaybackMode.smart:
if (_audioMatchesProfile(selectedAudioTrack, profile)) {
selected =
_findSubtitleTrackByProfile(availableTracks, profile, forcedOnly: true) ??
_findForcedSubtitleTrack(availableTracks) ??
SubtitleTrack.off;
} else {
selected =
_findSubtitleTrackByProfile(availableTracks, profile) ??
_findDefaultSubtitleTrack(availableTracks) ??
_findFirstSubtitleTrack(availableTracks) ??
SubtitleTrack.off;
}
break;
case SubtitlePlaybackMode.defaultMode:
return null;
}
return TrackSelectionResult(selected, TrackSelectionPriority.profile);
}
MediaSubtitleTrack? _sourceSubtitleTrack(String nativeId) {
if (!nativeId.startsWith('source:')) return null;
final sourceId = int.tryParse(nativeId.substring('source:'.length));
return sourceId == null ? null : plexMediaInfo?.subtitleTracks.where((track) => track.id == sourceId).firstOrNull;
}
/// Whether the source catalog can prove it has already delivered every
/// ordinary direct-embedded row, so a still-unmatched [sourceTrack] is a
/// real mismatch rather than a native track that has not arrived yet.
///
/// Backend-neutral: any backend whose source rows describe streams inside
/// the container can reach completeness. Rows delivered as sidecars never
/// can, because they arrive on their own schedule.
bool _hasCompleteDirectSourceCatalogFor(MediaSubtitleTrack? sourceTrack, List<SubtitleTrack> availableTracks) {
final info = plexMediaInfo;
return info != null &&
sourceTrack != null &&
_isDirectEmbeddedPlexSubtitle(sourceTrack) &&
_classifyDirectEmbeddedSubtitleCatalog(info.subtitleTracks, availableTracks) ==
_DirectEmbeddedSubtitleCatalog.complete;
}
SubtitleTrack? findBestSubtitleMatch(List<SubtitleTrack> availableTracks, SubtitleTrack preferred) {
// Handle special "no subtitles" case
if (preferred.id == 'no') {
return SubtitleTrack.off;
}
if (preferred.id.startsWith('source:')) {
// A source row delivered as its own *file* carries that file's URL on the preference, and the
// loaded track is external. `findMpvTrackForPlexSubtitle` pairs a source row with the
// container's own tracks by metadata, so it cannot see that external track at all - which
// left an extracted secondary waiting out the deadline and never appearing. The URL is both
// stronger and unambiguous, so it is tried first; a unique hit is the same file by
// definition, whatever id either side chose for it.
//
// Container tracks are excluded on purpose: several source rows share one container URL, so a
// URL hit there says nothing about *which* row it is, and the metadata matcher below is what
// waits for the intended one to be discovered.
final sidecarUri = preferred.uri;
if (sidecarUri != null && sidecarUri.isNotEmpty) {
final uriMatches = availableTracks
.where((track) => track.uri == sidecarUri && !track.isContainer)
.toList(growable: false);
if (uriMatches.length == 1) return uriMatches.single;
}
final sourceTrack = _sourceSubtitleTrack(preferred.id);
if (sourceTrack == null) return null;
return findMpvTrackForPlexSubtitle(sourceTrack, availableTracks, allPlexTracks: plexMediaInfo?.subtitleTracks);
}
final preferredUri = preferred.uri;
if (preferredUri != null) {
final uriMatches = availableTracks.where((track) => track.uri == preferredUri).toList(growable: false);
if (uriMatches.length == 1) return uriMatches.single;
}
return findBestTrackMatch<SubtitleTrack>(
availableTracks,
preferred,
(t) => t.id,
(t) => t.title,
(t) => t.language,
);
}
/// Find a track matching a preferred language from a list of tracks
/// Returns the first track whose language matches any variation of the preferred language
T? _findTrackByLanguageVariations<T>(
List<T> tracks,
String _,
List<String> languageVariations,
String? Function(T) getLanguage,
String Function(T) _,
String _,
) {
for (final track in tracks) {
final trackLang = getLanguage(track)?.toLowerCase();
if (trackLang != null && languageVariations.any((lang) => trackLang.startsWith(lang))) {
return track;
}
}
return null;
}
/// Checks if a track language matches a preferred language
///
/// Handles both 2-letter (ISO 639-1) and 3-letter (ISO 639-2) codes
/// Also handles bibliographic variants and region codes (e.g., "en-US")
bool languageMatches(String? trackLanguage, String? preferredLanguage) {
if (trackLanguage == null || preferredLanguage == null) {
return false;
}
final track = trackLanguage.toLowerCase();
final preferred = preferredLanguage.toLowerCase();
// Direct match
if (track == preferred) return true;
// Extract base language codes (handle region codes like "en-US")
final trackBase = track.split('-').first;
final preferredBase = preferred.split('-').first;
if (trackBase == preferredBase) return true;
// Get all variations of the preferred language (e.g., "en" → ["en", "eng"])
final variations = LanguageCodes.getVariations(preferredBase);
// Check if track's base code matches any variation
return variations.contains(trackBase);
}
/// Select the best audio track based on priority:
/// Priority 1: Preferred track from navigation
/// Priority 2: Server-selected track from media info
/// Priority 3: Per-media language preference
/// Priority 4: User profile preferences
/// Priority 5: Default or first track
TrackSelectionResult<AudioTrack>? selectAudioTrack(
List<AudioTrack> availableTracks,
AudioTrack? preferredAudioTrack,
) {
if (availableTracks.isEmpty) return null;
AudioTrack? trackToSelect;
// Priority 1: the carried preference. Full identity first (a same-item
// reload passing back the identical track), then the cross-item evidence
// bands — bridged language parity or a unique title match with
// codec/channel tiebreaks. This replaces the old first-match language
// tier, which latched onto an arbitrary same-language (or same-untagged)
// row and lost the viewer's commentary/dub distinction across episodes.
if (preferredAudioTrack != null) {
trackToSelect =
availableTracks
.where(
(track) =>
track.id != AudioTrack.auto.id &&
track.id != AudioTrack.off.id &&
track.id == preferredAudioTrack.id &&
track.title == preferredAudioTrack.title &&
track.language == preferredAudioTrack.language,
)
.firstOrNull ??
findNativeAudioTrackForIntent(preferredAudioTrack, availableTracks);
if (trackToSelect != null) {
return TrackSelectionResult(trackToSelect, TrackSelectionPriority.navigation);
}
appLogger.d('Audio carry declined: ${preferredAudioTrack.language}/${preferredAudioTrack.title}');
}
// Priority 2: Check server-selected track from media info
final info = plexMediaInfo;
if (info != null && availableTracks.isNotEmpty) {
final serverSelectedTrack = info.audioTracks.where((t) => t.selected).firstOrNull;
if (serverSelectedTrack != null) {
final matchedMpvTrack = findMpvTrackForPlexAudio(
serverSelectedTrack,
availableTracks,
allPlexTracks: info.audioTracks,
);
if (matchedMpvTrack != null) {
return TrackSelectionResult(matchedMpvTrack, TrackSelectionPriority.serverSelected);
}
} else if (metadata.backend.usesMediaBrowserApi) {
final defaultStreamIndex = info.defaultAudioStreamIndex;
final defaultTrack = defaultStreamIndex != null
? info.audioTracks
.where((track) => _mediaTrackStreamIndex(track.id, track.index) == defaultStreamIndex)
.firstOrNull
: null;
if (defaultTrack != null) {
final matchedMpvTrack = findMpvTrackForPlexAudio(
defaultTrack,
availableTracks,
allPlexTracks: info.audioTracks,
);
if (matchedMpvTrack != null) {
return TrackSelectionResult(matchedMpvTrack, TrackSelectionPriority.serverSelected);
}
}
}
}
// Priority 3: Try per-media language preference
if (metadata.audioLanguage != null) {
final matchedTrack = availableTracks.firstWhere(
(track) => languageMatches(track.language, metadata.audioLanguage),
orElse: () => availableTracks.first,
);
if (languageMatches(matchedTrack.language, metadata.audioLanguage)) {
return TrackSelectionResult(matchedTrack, TrackSelectionPriority.perMedia);
}
}
// Priority 4: Try user profile preferences
if (profileSettings != null) {
trackToSelect = findAudioTrackByProfile(availableTracks, profileSettings!);
if (trackToSelect != null) {
return TrackSelectionResult(trackToSelect, TrackSelectionPriority.profile);
}
}
// Priority 5: Use default or first track
trackToSelect = availableTracks.firstWhere((t) => t.isDefault, orElse: () => availableTracks.first);
return TrackSelectionResult(trackToSelect, TrackSelectionPriority.defaultTrack);
}
/// Select the best subtitle track based on priority:
/// Priority 1: Preferred track from navigation
/// Priority 2: Server-selected track or explicit server off decision
/// Priority 3: User profile subtitle mode
/// Priority 4: Default track
/// Priority 5: Off
///
/// Returns null only while the source catalog can still deliver the requested
/// subtitle. A complete catalog with no unambiguous match proceeds through
/// the safe default/off priorities instead of waiting indefinitely.
///
/// [waitForPendingSource] disables that wait when the caller has run out of
/// patience: every pending branch falls through to the priorities below, so
/// the result is a real decision rather than "ask again later". A deadline
/// pass must use it, otherwise it re-derives the same null and applies
/// nothing at all.
TrackSelectionResult<SubtitleTrack>? selectSubtitleTrack(
List<SubtitleTrack> availableTracks,
SubtitlePreference? preference,
AudioTrack? selectedAudioTrack, {
bool waitForPendingSource = true,
}) {
// Priority 1: the caller's preference — an identity reference into this
// item, or a semantic intent carried across an item boundary.
switch (preference) {
case null:
break;
case SubtitleOffPreference():
return TrackSelectionResult(SubtitleTrack.off, TrackSelectionPriority.navigation);
case SubtitleTrackPreference(:final track):
if (track.id == 'no') {
return TrackSelectionResult(SubtitleTrack.off, TrackSelectionPriority.navigation);
}
if (availableTracks.isNotEmpty) {
final subtitleToSelect = findBestSubtitleMatch(availableTracks, track);
if (subtitleToSelect != null) {
return TrackSelectionResult(subtitleToSelect, TrackSelectionPriority.navigation);
}
}
if (waitForPendingSource && track.id.startsWith('source:')) {
// Only a row this catalog actually advertises can still show up
// natively. An id the catalog does not carry — a stale preference
// from another media source — resolves the same way on every retry,
// so waiting for it would defer selection forever.
final sourceTrack = _sourceSubtitleTrack(track.id);
if (sourceTrack != null && !_hasCompleteDirectSourceCatalogFor(sourceTrack, availableTracks)) {
return null;
}
}
case SubtitleIntentPreference(:final intent):
if (availableTracks.isNotEmpty) {
final match = findNativeTrackForIntent(intent, availableTracks);
if (match != null) {
return TrackSelectionResult(match, TrackSelectionPriority.navigation);
}
}
if (waitForPendingSource) {
// Mirror of the source-id rule above: only an intent this catalog
// can actually serve may still show up natively. A class-preserving
// row proves the catalog can serve it; an incomplete direct catalog
// means its native track may not have arrived yet. An unservable
// intent resolves the same way on every retry — decline immediately
// and let the ladder decide.
final servableRow = findSourceTrackForIntent(intent, plexMediaInfo?.subtitleTracks ?? const []);
if (servableRow != null && !_hasCompleteDirectSourceCatalogFor(servableRow, availableTracks)) {
return null;
}
}
appLogger.d('Subtitle intent declined: $intent');
}
// Priority 2: Trust the server's selected track. Plex computes this from
// account/show/per-item prefs; MediaBrowser exposes DefaultSubtitleStreamIndex.
final info = plexMediaInfo;
if (info != null) {
final serverSelectedTrack = info.subtitleTracks.where((track) => track.selected).firstOrNull;
if (serverSelectedTrack != null) {
final matchedMpvTrack = findMpvTrackForPlexSubtitle(
serverSelectedTrack,
availableTracks,
allPlexTracks: info.subtitleTracks,
);
if (matchedMpvTrack != null) {
return TrackSelectionResult(matchedMpvTrack, TrackSelectionPriority.serverSelected);
}
// A server-selected row the native player has not produced yet must
// keep the pass pending on every backend. Falling through here would
// commit an unrelated native default and, because readiness is this
// same decision, retire the listener before the real track lands.
if (waitForPendingSource && !_hasCompleteDirectSourceCatalogFor(serverSelectedTrack, availableTracks)) {
return null;
}
} else if (metadata.backend.usesMediaBrowserApi) {
final defaultStreamIndex = info.defaultSubtitleStreamIndex;
if (defaultStreamIndex == -1) {
return TrackSelectionResult(SubtitleTrack.off, TrackSelectionPriority.serverSelected);
}
final defaultTrack = defaultStreamIndex != null && availableTracks.isNotEmpty
? info.subtitleTracks
.where((track) => _mediaTrackStreamIndex(track.id, track.index) == defaultStreamIndex)
.firstOrNull
: null;
if (defaultTrack != null) {
final matchedMpvTrack = findMpvTrackForPlexSubtitle(
defaultTrack,
availableTracks,
allPlexTracks: info.subtitleTracks,
);
if (matchedMpvTrack != null) {
return TrackSelectionResult(matchedMpvTrack, TrackSelectionPriority.serverSelected);
}
}
} else if (metadata.backend == MediaBackend.plex && info.subtitleTracks.isNotEmpty) {
if (availableTracks.isEmpty && waitForPendingSource) return null;
// Native tracks exist and none maps to a server-selected stream.
return TrackSelectionResult(SubtitleTrack.off, TrackSelectionPriority.serverSelected);
}
if (waitForPendingSource && availableTracks.isEmpty && info.subtitleTracks.isNotEmpty) return null;
}
// Priority 3: Apply server profile subtitle mode when the backend exposes
// one (MediaBrowser). Plex keeps using the selected-stream path above.
final profileSelectedTrack = _selectSubtitleTrackByProfile(availableTracks, selectedAudioTrack);
if (profileSelectedTrack != null) return profileSelectedTrack;
// Priority 4: Check for default subtitle
final defaultTrack = _findDefaultSubtitleTrack(availableTracks);
if (defaultTrack != null) {
return TrackSelectionResult(defaultTrack, TrackSelectionPriority.defaultTrack);
}
// Priority 5: Turn off subtitles
return TrackSelectionResult(SubtitleTrack.off, TrackSelectionPriority.off);
}
/// Select and apply audio and subtitle tracks based on preferences
Future<bool> selectAndApplyTracks({
AudioTrack? preferredAudioTrack,
SubtitlePreference? preferredSubtitleTrack,
SubtitlePreference? preferredSecondarySubtitleTrack,
double? defaultPlaybackSpeed,
Function(AudioTrack)? onAudioTrackChanged,
Function(SubtitleTrack)? onSubtitleTrackChanged,
bool Function()? isActive,
void Function(Future<void> mutation)? onPlayerMutationDispatched,
bool waitForPendingSource = true,
/// The primary is painted into the picture, so no native subtitle track is
/// coming for it. With no secondary wanted either, a silent video legitimately
/// exposes no tracks at all and the wait below can only time out.
bool primarySubtitleIsServerRendered = false,
}) async {
final player = this.player;
if (player == null) {
throw StateError('A player is required to apply track selections');
}
bool canMutatePlayer() => !player.disposed && (isActive == null || isActive());
if (!canMutatePlayer()) return false;
// Wait for tracks to be loaded, unless nothing can arrive: a burned-in primary with no
// secondary wanted has a complete catalog at zero tracks, and waiting ten seconds for one
// held the saved playback rate back with it. An explicit off is as settled as an absent
// preference, which is how `TrackManager._secondaryPreferenceResolves` reads it too.
final nothingToWaitFor =
primarySubtitleIsServerRendered &&
(preferredSecondarySubtitleTrack == null || preferredSecondarySubtitleTrack is SubtitleOffPreference);
if (!nothingToWaitFor && player.state.tracks.audio.isEmpty && player.state.tracks.subtitle.isEmpty) {
try {
await player.streams.tracks
.where((t) => t.audio.isNotEmpty || t.subtitle.isNotEmpty)
.first
.namedTimeout(const Duration(seconds: 10), operation: 'track loading');
} catch (_) {
// Timeout or stream closed — proceed with whatever state we have
}
}
if (!canMutatePlayer()) return false;
// Get real tracks (excluding auto and no)
final realAudioTracks = player.state.tracks.audio.where((t) => t.id != 'auto' && t.id != 'no').toList();
final realSubtitleTracks = player.state.tracks.subtitle.where((t) => t.id != 'auto' && t.id != 'no').toList();
// Select and apply audio track
final audioResult = selectAudioTrack(realAudioTracks, preferredAudioTrack);
AudioTrack? selectedAudioTrack;
if (audioResult != null) {
selectedAudioTrack = audioResult.track;
appLogger.d(
'Audio: ${selectedAudioTrack.title ?? selectedAudioTrack.language ?? "Track ${selectedAudioTrack.id}"} [${audioResult.priority.name}]',
);
if (!canMutatePlayer()) return false;
final audioMutation = player.selectAudioTrack(selectedAudioTrack);
onPlayerMutationDispatched?.call(audioMutation);
await audioMutation;
if (!canMutatePlayer()) return false;
// Save to Plex if this was user's navigation preference (Priority 1)
if (audioResult.priority == TrackSelectionPriority.navigation && onAudioTrackChanged != null) {
onAudioTrackChanged(selectedAudioTrack);
}
}
// Select and apply subtitle track. A null result means source metadata
// advertises subtitles that the native player has not exposed yet.
final subtitleResult = selectSubtitleTrack(
realSubtitleTracks,
preferredSubtitleTrack,
selectedAudioTrack,
waitForPendingSource: waitForPendingSource,
);
if (subtitleResult != null) {
final selectedSubtitleTrack = subtitleResult.track;
final subtitleName = selectedSubtitleTrack.id == 'no'
? 'OFF'
: (selectedSubtitleTrack.title ?? selectedSubtitleTrack.language ?? 'Track ${selectedSubtitleTrack.id}');
appLogger.d('Subtitle: $subtitleName [${subtitleResult.priority.name}]');
if (!canMutatePlayer()) return false;
final subtitleMutation = player.selectSubtitleTrack(selectedSubtitleTrack);
onPlayerMutationDispatched?.call(subtitleMutation);
await subtitleMutation;
if (!canMutatePlayer()) return false;
// Save to Plex if this was user's navigation preference (Priority 1)
if (subtitleResult.priority == TrackSelectionPriority.navigation && onSubtitleTrackChanged != null) {
onSubtitleTrackChanged(selectedSubtitleTrack);
}
} else {
appLogger.d('Subtitle selection pending: native tracks have not arrived');
}
// Apply preferred secondary subtitle track if provided (mpv-only)
final secondaryPreference = preferredSecondarySubtitleTrack;
if (secondaryPreference != null &&
secondaryPreference is! SubtitleOffPreference &&
player.supportsSecondarySubtitles &&
realSubtitleTracks.isNotEmpty) {
final secondaryMatch = switch (secondaryPreference) {
SubtitleOffPreference() => null,
SubtitleTrackPreference(:final track) =>
track.id == 'no' ? null : findBestSubtitleMatch(realSubtitleTracks, track),
SubtitleIntentPreference(:final intent) => findNativeTrackForIntent(intent, realSubtitleTracks),
};
if (secondaryMatch != null && secondaryMatch.id != 'no') {
appLogger.d(
'Secondary subtitle: ${secondaryMatch.title ?? secondaryMatch.language ?? "Track ${secondaryMatch.id}"}',
);
if (!canMutatePlayer()) return false;
final secondarySubtitleMutation = player.selectSecondarySubtitleTrack(secondaryMatch);
onPlayerMutationDispatched?.call(secondarySubtitleMutation);
await secondarySubtitleMutation;
if (!canMutatePlayer()) return false;
}
}
// Apply default playback speed from settings
if (defaultPlaybackSpeed != null && defaultPlaybackSpeed != 1.0) {
if (!canMutatePlayer()) return false;
final rateMutation = player.setRate(defaultPlaybackSpeed);
onPlayerMutationDispatched?.call(rateMutation);
await rateMutation;
if (!canMutatePlayer()) return false;
}
return true;
}
}