fix: resolve subtitle visibility leakage, UI track sync, and play queue missing episodes

mattsigal · mattsigal · commit 1a05cb313c6a · 2026-06-11T15:57:58.000-07:00
- Prevent subtitle visibility state leaking between tracks on MediaKit backend.
- Filter out missing/virtual episodes and specials from play queues.
- Asynchronously query native subtitle track to synchronize the UI subtitle track selector when auto-selected.
- Fix broken unit tests from audio pref migrations.
diff --git a/lib/di/modules/playback_module.dart b/lib/di/modules/playback_module.dart
@@ -23,6 +23,7 @@ import '../../preference/preference_constants.dart';
 import '../../preference/user_preferences.dart';
 import '../../syncplay/syncplay_manager.dart';
 import '../../util/platform_detection.dart';
+import '../../util/episode_playability.dart';
 
 final _getIt = GetIt.instance;
 
@@ -316,11 +317,14 @@ Future<List<dynamic>> _nextSeasonItemsProvider(
       seriesId: seriesId,
       seasonId: nextSeasonId,
     );
-    if (nextSeasonEpisodes.isEmpty ||
-        nextSeasonEpisodes.first.mediaSources.isEmpty) {
+    final playableEpisodes = nextSeasonEpisodes
+        .where(isEligibleNextEpisodeCandidate)
+        .toList();
+    if (playableEpisodes.isEmpty ||
+        playableEpisodes.first.mediaSources.isEmpty) {
       return const <dynamic>[];
     }
-    return nextSeasonEpisodes;
+    return playableEpisodes;
   } catch (_) {
     return const <dynamic>[];
   }
diff --git a/lib/playback/html_video_backend_stub.dart b/lib/playback/html_video_backend_stub.dart
@@ -85,6 +85,12 @@ class HtmlVideoBackend implements PlayerBackend {
   @override
   Future<void> setAudioTrack(int index) async {}
 
+  @override
+  int? get activeSubtitleTrackIndex => null;
+
+  @override
+  Future<int?> getActiveSubtitleTrackIndexAsync() async => null;
+
   @override
   Future<void> setSubtitleTrack(
     int index, {
diff --git a/lib/playback/html_video_backend_web.dart b/lib/playback/html_video_backend_web.dart
@@ -440,6 +440,12 @@ class HtmlVideoBackend implements PlayerBackend {
   Future<void> setAudioTrack(int index) async {
   }
 
+  @override
+  int? get activeSubtitleTrackIndex => null;
+
+  @override
+  Future<int?> getActiveSubtitleTrackIndexAsync() async => null;
+
   @override
   Future<void> setSubtitleTrack(
     int index, {
diff --git a/lib/playback/media3_player_backend.dart b/lib/playback/media3_player_backend.dart
@@ -543,6 +543,12 @@ class Media3PlayerBackend implements PlayerBackend {
     await _invoke<void>('setAudioTrack', {'index': index});
   }
 
+  @override
+  int? get activeSubtitleTrackIndex => null;
+
+  @override
+  Future<int?> getActiveSubtitleTrackIndexAsync() async => null;
+
   @override
   Future<void> setSubtitleTrack(
     int index, {
diff --git a/lib/playback/media_kit_player_backend.dart b/lib/playback/media_kit_player_backend.dart
@@ -543,6 +543,17 @@ class MediaKitPlayerBackend implements PlayerBackend {
     await _applyAudioPassthroughOptions();
     await _applyCustomMpvConfIfEnabled();
     await _applyAssOverrideMode();
+
+    if (_player.platform is NativePlayer) {
+      final native = _player.platform as NativePlayer;
+      await _nativeSetProperty(native, 'sid', 'auto');
+      await _nativeSetProperty(native, 'secondary-sid', 'no');
+      await _nativeSetProperty(native, 'sub-visibility', 'yes');
+      if (_useLibass) {
+        await _nativeSetProperty(native, 'sub-ass', 'yes');
+      }
+    }
+
     final media = Media(url);
     final openPaused = startPosition > Duration.zero;
     await _player.open(media, play: !openPaused);
@@ -1226,6 +1237,56 @@ class MediaKitPlayerBackend implements PlayerBackend {
     }
   }
 
+  @override
+  int? get activeSubtitleTrackIndex {
+    if (_player.platform is! NativePlayer) {
+      return null;
+    }
+    try {
+      final active = _player.state.track.subtitle;
+      if (active.id == 'no') {
+        return -1;
+      }
+      if (active.id == 'auto') {
+        return null;
+      }
+      final subtitleTracks = _player.state.tracks.subtitle;
+      final playableSubtitleTracks = subtitleTracks
+          .where((t) => t.id != 'auto' && t.id != 'no')
+          .toList();
+      final idx = playableSubtitleTracks.indexWhere((t) => t.id == active.id);
+      if (idx >= 0) {
+        return idx + 1;
+      }
+    } catch (_) {}
+    return null;
+  }
+
+  @override
+  Future<int?> getActiveSubtitleTrackIndexAsync() async {
+    if (_player.platform is! NativePlayer) {
+      return null;
+    }
+    try {
+      final native = _player.platform as NativePlayer;
+      final sid = await _tryNativeGetProperty(native, 'sid');
+      if (sid == 'no' || sid == null) {
+        return -1;
+      }
+      final trackList = await _tryNativeGetProperty(native, 'track-list');
+      final subtitleIds = _extractSubtitleTrackIds(trackList);
+      final sidInt = int.tryParse(sid);
+      if (sidInt != null) {
+        final idx = subtitleIds.indexOf(sidInt);
+        if (idx >= 0) {
+          return idx + 1;
+        }
+        return sidInt;
+      }
+    } catch (_) {}
+    return null;
+  }
+
   @override
   Future<void> setSubtitleTrack(
     int mpvTrackId, {
diff --git a/lib/playback/tizen_player_backend.dart b/lib/playback/tizen_player_backend.dart
@@ -279,6 +279,12 @@ class TizenPlayerBackend implements PlayerBackend {
     await _controller?.setPlaybackSpeed(speed);
   }
 
+  @override
+  int? get activeSubtitleTrackIndex => null;
+
+  @override
+  Future<int?> getActiveSubtitleTrackIndexAsync() async => null;
+
   // The standard video_player API exposes no runtime track selection; tracks are
   // selected server-side via the device profile / transcoding instead.
   @override
diff --git a/lib/ui/screens/detail/item_detail_screen.dart b/lib/ui/screens/detail/item_detail_screen.dart
@@ -5883,7 +5883,7 @@ class _ActionButtonsState extends State<_ActionButtons> {
             );
 
           case 'Season':
-            final episodes = viewModel.episodes;
+            final episodes = viewModel.episodes.where(isEligibleNextEpisodeCandidate).toList();
             if (episodes.isEmpty) return;
             final startIndex = resume
                 ? episodes.indexWhere(
@@ -5939,11 +5939,12 @@ class _ActionButtonsState extends State<_ActionButtons> {
             if (!context.mounted) return;
 
             if (episodes.length > 1) {
-              final startIndex = episodes.indexWhere((e) => e.id == item.id);
+              final playableEpisodes = episodes.where((e) => e.id == item.id || isEligibleNextEpisodeCandidate(e)).toList();
+              final startIndex = playableEpisodes.indexWhere((e) => e.id == item.id);
               final idx = startIndex >= 0 ? startIndex : 0;
-              final selectedEpisode = episodes[idx];
+              final selectedEpisode = playableEpisodes[idx];
               final episodeQueue = _truncateQueueIfImmediateNextUnplayable(
-                episodes,
+                playableEpisodes,
                 startIndex: idx,
               );
               
@@ -6102,10 +6103,11 @@ class _ActionButtonsState extends State<_ActionButtons> {
   ) async {
     final manager = GetIt.instance<PlaybackManager>();
     final queue = await _shuffleQueueForItem(item);
-    if (queue.length < 2) return;
+    final playableQueue = queue.where((e) => isEligibleNextEpisodeCandidate(e) || e.id == item.id).toList();
+    if (playableQueue.length < 2) return;
     if (!context.mounted) return;
 
-    final shuffled = List<AggregatedItem>.from(queue)..shuffle();
+    final shuffled = List<AggregatedItem>.from(playableQueue)..shuffle();
     final isAudio = shuffled.every((queuedItem) {
       final mediaType = queuedItem.rawData['MediaType'] as String?;
       return queuedItem.type == 'Audio' || mediaType == 'Audio';
diff --git a/lib/ui/screens/playback/video_player_screen.dart b/lib/ui/screens/playback/video_player_screen.dart
@@ -5837,88 +5837,90 @@ class _VideoPlayerScreenState extends State<VideoPlayerScreen>
     final canDownloadRemote =
         !audio && item is AggregatedItem && _canDownloadRemoteSubtitles(item);
 
-    final int? currentStreamIndex;
-    if (audio) {
-      currentStreamIndex =
-          _manager.audioStreamIndex ??
-          streams.where((s) => s['IsDefault'] == true).firstOrNull?['Index']
-              as int?;
-    } else {
-      final subIdx = _manager.subtitleStreamIndex;
-      currentStreamIndex =
-          subIdx ??
-          streams.where((s) => s['IsDefault'] == true).firstOrNull?['Index']
-              as int?;
-    }
-    final isSubsOff = !audio && _manager.subtitleStreamIndex == -1;
-
-    final options = <TrackOption>[
-      if (!audio) TrackOption(label: l10n.off),
-      ...optionStreams.asMap().entries.map((entry) {
-        final index = entry.key;
-        final trackNumber = index + 1;
-        final s = entry.value;
-        final displayTitle = s['DisplayTitle'] as String?;
-        final title = s['Title'] as String?;
-        final language = s['Language'] as String?;
-        final codec = s['Codec'] as String?;
-        final label =
-            displayTitle ??
-            title ??
-            language ??
-            l10n.streamTypeFallback(streamType, index + 1);
-        final subtitle = audio
-            ? [
-                if (language != null && displayTitle != null) language,
-                if (codec != null) codec.toUpperCase(),
-                if (s['Channels'] != null) '${s['Channels']}ch',
-              ].join(' · ')
-            : (() {
-                final subtitleType =
-                    ((codec == null || codec.isEmpty) ? 'Unknown' : codec)
-                        .toUpperCase();
-                final deliveryMethod = (s['DeliveryMethod'] as String?)
-                    ?.trim()
-                    .toLowerCase();
-                final location = s['IsExternal'] == true
-                    ? 'External'
-                    : (deliveryMethod == 'embed' ? 'Embedded' : 'Internal');
-                return '$subtitleType · $location';
-              })();
-        return TrackOption(
-          label: '$trackNumber - $label',
-          subtitle: subtitle.isNotEmpty ? subtitle : null,
-          scrollLabel: true,
-          scrollSubtitle: true,
-        );
-      }),
-      if (canDownloadRemote)
-        TrackOption(
-          label: l10n.downloadSubtitlesLabel,
-          subtitle: l10n.searchOpenSubtitlesPlugin,
-        ),
-    ];
+    unawaited(() async {
+      final int? currentStreamIndex;
+      if (audio) {
+        currentStreamIndex =
+            _manager.audioStreamIndex ??
+            streams.where((s) => s['IsDefault'] == true).firstOrNull?['Index']
+                as int?;
+      } else {
+        final subIdx = await _manager.getSubtitleStreamIndexAsync();
+        currentStreamIndex =
+            subIdx ??
+            streams.where((s) => s['IsDefault'] == true).firstOrNull?['Index']
+                as int?;
+      }
+      final isSubsOff = !audio && currentStreamIndex == -1;
+
+      final options = <TrackOption>[
+        if (!audio) TrackOption(label: l10n.off),
+        ...optionStreams.asMap().entries.map((entry) {
+          final index = entry.key;
+          final trackNumber = index + 1;
+          final s = entry.value;
+          final displayTitle = s['DisplayTitle'] as String?;
+          final title = s['Title'] as String?;
+          final language = s['Language'] as String?;
+          final codec = s['Codec'] as String?;
+          final label =
+              displayTitle ??
+              title ??
+              language ??
+              l10n.streamTypeFallback(streamType, index + 1);
+          final subtitle = audio
+              ? [
+                  if (language != null && displayTitle != null) language,
+                  if (codec != null) codec.toUpperCase(),
+                  if (s['Channels'] != null) '${s['Channels']}ch',
+                ].join(' · ')
+              : (() {
+                  final subtitleType =
+                      ((codec == null || codec.isEmpty) ? 'Unknown' : codec)
+                          .toUpperCase();
+                  final deliveryMethod = (s['DeliveryMethod'] as String?)
+                      ?.trim()
+                      .toLowerCase();
+                  final location = s['IsExternal'] == true
+                      ? 'External'
+                      : (deliveryMethod == 'embed' ? 'Embedded' : 'Internal');
+                  return '$subtitleType · $location';
+                })();
+          return TrackOption(
+            label: '$trackNumber - $label',
+            subtitle: subtitle.isNotEmpty ? subtitle : null,
+            scrollLabel: true,
+            scrollSubtitle: true,
+          );
+        }),
+        if (canDownloadRemote)
+          TrackOption(
+            label: l10n.downloadSubtitlesLabel,
+            subtitle: l10n.searchOpenSubtitlesPlugin,
+          ),
+      ];
 
-    final int? selectedIndex;
-    if (audio) {
-      final idx = currentStreamIndex != null
-          ? streams.indexWhere((s) => s['Index'] == currentStreamIndex)
-          : -1;
-      selectedIndex = idx >= 0 ? idx : null;
-    } else {
-      if (isSubsOff || (currentStreamIndex == null && streams.isNotEmpty)) {
-        selectedIndex = 0;
-      } else if (currentStreamIndex != null) {
-        final idx = optionStreams.indexWhere(
-          (s) => s['Index'] == currentStreamIndex,
-        );
-        selectedIndex = idx >= 0 ? idx + 1 : null;
+      final int? selectedIndex;
+      if (audio) {
+        final idx = currentStreamIndex != null
+            ? streams.indexWhere((s) => s['Index'] == currentStreamIndex)
+            : -1;
+        selectedIndex = idx >= 0 ? idx : null;
       } else {
-        selectedIndex = null;
+        if (isSubsOff || (currentStreamIndex == null && streams.isNotEmpty)) {
+          selectedIndex = 0;
+        } else if (currentStreamIndex != null) {
+          final idx = optionStreams.indexWhere(
+            (s) => s['Index'] == currentStreamIndex,
+          );
+          selectedIndex = idx >= 0 ? idx + 1 : null;
+        } else {
+          selectedIndex = null;
+        }
       }
-    }
 
-    unawaited(() async {
+      if (!mounted) return;
+
       final result = await TrackSelectorDialog.show(
         context,
         title: audio ? l10n.audioTrack : l10n.subtitleTrack,
diff --git a/packages/playback_core/lib/src/playback_manager.dart b/packages/playback_core/lib/src/playback_manager.dart
diff --git a/packages/playback_core/lib/src/player_backend.dart b/packages/playback_core/lib/src/player_backend.dart
