Improve track selection logic (#1654)
## Description Updates the logic for selecting tracks which should fix several edge cases The new logic groups track types together and then applying the user's selection to the actual tracks in the file. For example, if the user choosing the audio track which the server reports as absolute `index=2` (eg the _third_ track of any type in the file) and audio `index=1` (eg the _second audio_ track in the file), then the track selection logic will use the _second audio_ track in the direct played file (after accounting for id sorting). Some other changes: - If direct playing and an unsupported track is selected, the app will now fall back to transcoding - If the correct audio/subtitle tracks are not found, the app will now fall back to transcoding instead of blocking any track change attempts ### TODO Not necessarily in this PR, but some things need further investigation: - Handling external audio tracks - Why does ExoPlayer order the tracks differently sometimes, see [example here](https://github.com/damontecres/Wholphin/issues/791#issuecomment-4836470813) where `0:3` is _after_ `0:4`, but the `MediaSourceInfo` lists them `0:3` then `0:4` ### Related issues Maybe fixes #791 Should fix https://github.com/damontecres/Wholphin/issues/1005#issuecomment-4085440175 Related to the parent issue, #1475 Replaces #845 ### Testing Unit tests mostly, some basic tests on emulator Needs more "real world" testing #### Try it out? You can try out this build by following the [instructions here](https://github.com/damontecres/Wholphin/releases/tag/develop-track-selection). If you do, please report your results in this PR! ## Screenshots N/A ## AI or LLM usage None
This commit is contained in:
Damontecres
GitHub
parent
d481aea85a
commit
26124a5348
10 changed files with 1014 additions and 498 deletions
|
|
@ -41,6 +41,7 @@ import com.github.damontecres.wholphin.preferences.PlayerBackend
|
|||
import com.github.damontecres.wholphin.preferences.ShowNextUpWhen
|
||||
import com.github.damontecres.wholphin.preferences.SkipSegmentBehavior
|
||||
import com.github.damontecres.wholphin.preferences.UserPreferences
|
||||
import com.github.damontecres.wholphin.preferences.enabled
|
||||
import com.github.damontecres.wholphin.services.DatePlayedService
|
||||
import com.github.damontecres.wholphin.services.DeviceProfileService
|
||||
import com.github.damontecres.wholphin.services.ImageUrlService
|
||||
|
|
@ -614,231 +615,257 @@ class PlaybackViewModel
|
|||
userInitiated: Boolean,
|
||||
enableDirectPlay: Boolean = !this.forceTranscoding,
|
||||
enableDirectStream: Boolean = !this.forceTranscoding,
|
||||
) = withContext(WholphinDispatchers.IO) {
|
||||
val itemId = item.id
|
||||
): Unit =
|
||||
withContext(WholphinDispatchers.IO) {
|
||||
val itemId = item.id
|
||||
|
||||
val currentPlayback = state.value.currentPlayback
|
||||
if (currentPlayback != null && currentPlayback.item.id == item.id && currentPlayback.playMethod == PlayMethod.DIRECT_PLAY) {
|
||||
val wasSuccessful =
|
||||
changeStreamsDirectPlay(
|
||||
currentPlayback = currentPlayback,
|
||||
currentItemPlayback = currentItemPlayback,
|
||||
audioIndex = audioIndex,
|
||||
subtitleIndex = subtitleIndex,
|
||||
userInitiated = userInitiated,
|
||||
)
|
||||
if (wasSuccessful) return@withContext
|
||||
}
|
||||
|
||||
Timber.d(
|
||||
"changeStreams: userInitiated=$userInitiated, audioIndex=$audioIndex, subtitleIndex=$subtitleIndex, " +
|
||||
"enableDirectPlay=$enableDirectPlay, enableDirectStream=$enableDirectStream, positionMs=$positionMs",
|
||||
)
|
||||
|
||||
val maxBitrate =
|
||||
preferences.appPreferences.playbackPreferences.maxBitrate
|
||||
.takeIf { it > 0 } ?: AppPreference.DEFAULT_BITRATE
|
||||
val response by
|
||||
api.mediaInfoApi
|
||||
.getPostedPlaybackInfo(
|
||||
itemId,
|
||||
PlaybackInfoDto(
|
||||
startTimeTicks = null,
|
||||
deviceProfile =
|
||||
if (currentPlayer.value!!.backend == PlayerBackend.EXO_PLAYER) {
|
||||
deviceProfileService.getOrCreateDeviceProfile(
|
||||
preferences.appPreferences,
|
||||
serverRepository.currentServer?.serverVersion,
|
||||
)
|
||||
} else {
|
||||
mpvDeviceProfile
|
||||
},
|
||||
maxAudioChannels = null,
|
||||
audioStreamIndex = audioIndex,
|
||||
subtitleStreamIndex = subtitleIndex,
|
||||
mediaSourceId = currentItemPlayback.sourceId?.toServerString(),
|
||||
alwaysBurnInSubtitleWhenTranscoding = false,
|
||||
maxStreamingBitrate = maxBitrate.toInt(),
|
||||
enableDirectPlay = enableDirectPlay,
|
||||
enableDirectStream = enableDirectStream,
|
||||
allowVideoStreamCopy = enableDirectStream,
|
||||
allowAudioStreamCopy = enableDirectStream,
|
||||
enableTranscoding = true,
|
||||
autoOpenLiveStream = true,
|
||||
),
|
||||
)
|
||||
if (response.errorCode != null) {
|
||||
_state.update { it.copy(loading = LoadingState.Error(response.errorCode?.serialName)) }
|
||||
return@withContext
|
||||
}
|
||||
val source = response.mediaSources.firstOrNull()
|
||||
source?.let { source ->
|
||||
val mediaUrl =
|
||||
if (source.supportsDirectPlay) {
|
||||
if (source.isRemote && source.path.isNotNullOrBlank()) {
|
||||
Timber.i("Playback is remote for source: %s", source.id)
|
||||
source.path
|
||||
} else {
|
||||
api.videosApi.getVideoStreamUrl(
|
||||
itemId = itemId,
|
||||
mediaSourceId = source.id,
|
||||
static = true,
|
||||
tag = source.eTag,
|
||||
playSessionId = response.playSessionId,
|
||||
)
|
||||
}
|
||||
} else if (source.supportsDirectStream) {
|
||||
source.transcodingUrl?.let(api::createUrl)
|
||||
} else {
|
||||
source.transcodingUrl?.let(api::createUrl)
|
||||
}
|
||||
if (mediaUrl.isNullOrBlank()) {
|
||||
_state.update {
|
||||
it.copy(
|
||||
loading =
|
||||
LoadingState.Error(
|
||||
"Unable to get media URL from the server. Do you have permission to view and/or transcode?",
|
||||
),
|
||||
val currentPlayback = state.value.currentPlayback
|
||||
if (currentPlayback != null &&
|
||||
currentPlayback.item.id == item.id &&
|
||||
currentPlayback.playMethod == PlayMethod.DIRECT_PLAY &&
|
||||
enableDirectPlay
|
||||
) {
|
||||
val wasSuccessful =
|
||||
changeStreamsDirectPlay(
|
||||
currentPlayback = currentPlayback,
|
||||
currentItemPlayback = currentItemPlayback,
|
||||
audioIndex = audioIndex,
|
||||
subtitleIndex = subtitleIndex,
|
||||
userInitiated = userInitiated,
|
||||
)
|
||||
}
|
||||
if (wasSuccessful) return@withContext
|
||||
}
|
||||
|
||||
Timber.i(
|
||||
"changeStreams (%s): userInitiated=%s, audioIndex=%s, subtitleIndex=%s, enableDirectPlay=%s, enableDirectStream=%s, positionMs=%s",
|
||||
itemId,
|
||||
userInitiated,
|
||||
audioIndex,
|
||||
subtitleIndex,
|
||||
enableDirectPlay,
|
||||
enableDirectStream,
|
||||
positionMs,
|
||||
)
|
||||
|
||||
val maxBitrate =
|
||||
preferences.appPreferences.playbackPreferences.maxBitrate
|
||||
.takeIf { it > 0 } ?: AppPreference.DEFAULT_BITRATE
|
||||
val response by
|
||||
api.mediaInfoApi
|
||||
.getPostedPlaybackInfo(
|
||||
itemId,
|
||||
PlaybackInfoDto(
|
||||
startTimeTicks = null,
|
||||
deviceProfile =
|
||||
if (currentPlayer.value!!.backend == PlayerBackend.EXO_PLAYER) {
|
||||
deviceProfileService.getOrCreateDeviceProfile(
|
||||
preferences.appPreferences,
|
||||
serverRepository.currentServer?.serverVersion,
|
||||
)
|
||||
} else {
|
||||
mpvDeviceProfile
|
||||
},
|
||||
maxAudioChannels = null,
|
||||
audioStreamIndex = audioIndex,
|
||||
subtitleStreamIndex = subtitleIndex,
|
||||
mediaSourceId = currentItemPlayback.sourceId?.toServerString(),
|
||||
alwaysBurnInSubtitleWhenTranscoding = false,
|
||||
maxStreamingBitrate = maxBitrate.toInt(),
|
||||
enableDirectPlay = enableDirectPlay,
|
||||
enableDirectStream = enableDirectStream,
|
||||
allowVideoStreamCopy = enableDirectStream,
|
||||
allowAudioStreamCopy = enableDirectStream,
|
||||
enableTranscoding = true,
|
||||
autoOpenLiveStream = true,
|
||||
),
|
||||
)
|
||||
if (response.errorCode != null) {
|
||||
_state.update { it.copy(loading = LoadingState.Error(response.errorCode?.serialName)) }
|
||||
return@withContext
|
||||
}
|
||||
val transcodeType =
|
||||
when {
|
||||
// playerBackend == PlayerBackend.MPV -> PlayMethod.DIRECT_PLAY
|
||||
source.supportsDirectPlay -> PlayMethod.DIRECT_PLAY
|
||||
|
||||
source.supportsDirectStream -> PlayMethod.DIRECT_STREAM
|
||||
|
||||
source.supportsTranscoding -> PlayMethod.TRANSCODE
|
||||
|
||||
else -> throw Exception("No supported playback method")
|
||||
}
|
||||
Timber.i("Playback decision for $itemId: $transcodeType")
|
||||
|
||||
val externalSubtitleCount = source.externalSubtitlesCount
|
||||
|
||||
val externalSubtitle =
|
||||
source.findExternalSubtitle(subtitleIndex)?.let {
|
||||
it.deliveryUrl?.let { deliveryUrl ->
|
||||
var flags = 0
|
||||
if (it.isForced) flags = flags.or(C.SELECTION_FLAG_FORCED)
|
||||
if (it.isDefault) flags = flags.or(C.SELECTION_FLAG_DEFAULT)
|
||||
MediaItem.SubtitleConfiguration
|
||||
.Builder(
|
||||
api.createUrl(deliveryUrl).toUri(),
|
||||
).setId("e:${it.index}")
|
||||
.setMimeType(subtitleMimeTypes[it.codec])
|
||||
.setLanguage(it.language)
|
||||
.setLabel(it.title)
|
||||
.setSelectionFlags(flags)
|
||||
.build()
|
||||
}
|
||||
}
|
||||
|
||||
Timber.v("subtitleIndex=$subtitleIndex, externalSubtitleCount=$externalSubtitleCount, externalSubtitle=$externalSubtitle")
|
||||
|
||||
val mediaItem =
|
||||
MediaItem
|
||||
.Builder()
|
||||
.setMediaId(itemId.toString())
|
||||
.setMediaMetadata(
|
||||
item.toMediaMetadata(
|
||||
imageUrlService.getItemImageUrl(
|
||||
item,
|
||||
ImageType.PRIMARY,
|
||||
useSeriesForPrimary = true,
|
||||
),
|
||||
),
|
||||
).setUri(mediaUrl.toUri())
|
||||
.setSubtitleConfigurations(listOfNotNull(externalSubtitle))
|
||||
.apply {
|
||||
when (source.container) {
|
||||
Codec.Container.HLS -> setMimeType(MimeTypes.APPLICATION_M3U8)
|
||||
Codec.Container.DASH -> setMimeType(MimeTypes.APPLICATION_MPD)
|
||||
val source = response.mediaSources.firstOrNull()
|
||||
source?.let { source ->
|
||||
val mediaUrl =
|
||||
if (source.supportsDirectPlay) {
|
||||
if (source.isRemote && source.path.isNotNullOrBlank()) {
|
||||
Timber.i("Playback is remote for source: %s", source.id)
|
||||
source.path
|
||||
} else {
|
||||
api.videosApi.getVideoStreamUrl(
|
||||
itemId = itemId,
|
||||
mediaSourceId = source.id,
|
||||
static = true,
|
||||
tag = source.eTag,
|
||||
playSessionId = response.playSessionId,
|
||||
)
|
||||
}
|
||||
}.build()
|
||||
|
||||
val playback =
|
||||
CurrentPlayback(
|
||||
item = item,
|
||||
tracks = listOf(),
|
||||
backend = currentPlayer.value!!.backend,
|
||||
playMethod = transcodeType,
|
||||
playSessionId = response.playSessionId,
|
||||
liveStreamId = source.liveStreamId,
|
||||
mediaSourceInfo = source,
|
||||
)
|
||||
|
||||
preferences.appPreferences.playbackPreferences.let { prefs ->
|
||||
source.mediaStreams
|
||||
?.firstOrNull { it.type == MediaStreamType.VIDEO }
|
||||
?.let { stream ->
|
||||
refreshRateService.changeRefreshRate(
|
||||
stream = stream,
|
||||
switchRefreshRate = prefs.refreshRateSwitching,
|
||||
switchResolution = prefs.resolutionSwitching,
|
||||
} else if (source.supportsDirectStream) {
|
||||
source.transcodingUrl?.let(api::createUrl)
|
||||
} else {
|
||||
source.transcodingUrl?.let(api::createUrl)
|
||||
}
|
||||
if (mediaUrl.isNullOrBlank()) {
|
||||
_state.update {
|
||||
it.copy(
|
||||
loading =
|
||||
LoadingState.Error(
|
||||
"Unable to get media URL from the server. Do you have permission to view and/or transcode?",
|
||||
),
|
||||
)
|
||||
}
|
||||
}
|
||||
withContext(WholphinDispatchers.Main) {
|
||||
// TODO, don't need to release & recreate when switching streams
|
||||
this@PlaybackViewModel.activityListener?.let {
|
||||
it.release()
|
||||
player.removeListener(it)
|
||||
return@withContext
|
||||
}
|
||||
val transcodeType =
|
||||
when {
|
||||
// playerBackend == PlayerBackend.MPV -> PlayMethod.DIRECT_PLAY
|
||||
source.supportsDirectPlay -> PlayMethod.DIRECT_PLAY
|
||||
|
||||
val playbackItemState = PlaybackItemState(playback, currentItemPlayback)
|
||||
val activityListener =
|
||||
TrackActivityPlaybackListener(
|
||||
api = api,
|
||||
player = player,
|
||||
getState = { playbackItemState },
|
||||
)
|
||||
player.addListener(activityListener)
|
||||
this@PlaybackViewModel.activityListener = activityListener
|
||||
source.supportsDirectStream -> PlayMethod.DIRECT_STREAM
|
||||
|
||||
_state.update {
|
||||
it.copy(
|
||||
loading = LoadingState.Success,
|
||||
currentPlayback = playback,
|
||||
)
|
||||
}
|
||||
player.setMediaItem(
|
||||
mediaItem,
|
||||
positionMs,
|
||||
source.supportsTranscoding -> PlayMethod.TRANSCODE
|
||||
|
||||
else -> throw Exception("No supported playback method")
|
||||
}
|
||||
Timber.i("Playback decision for $itemId: $transcodeType")
|
||||
|
||||
val externalSubtitleCount = source.externalSubtitlesCount
|
||||
|
||||
val externalSubtitle =
|
||||
source.findExternalSubtitle(subtitleIndex)?.let {
|
||||
it.deliveryUrl?.let { deliveryUrl ->
|
||||
var flags = 0
|
||||
if (it.isForced) flags = flags.or(C.SELECTION_FLAG_FORCED)
|
||||
if (it.isDefault) flags = flags.or(C.SELECTION_FLAG_DEFAULT)
|
||||
MediaItem.SubtitleConfiguration
|
||||
.Builder(
|
||||
api.createUrl(deliveryUrl).toUri(),
|
||||
).setId("e:${it.index}")
|
||||
.setMimeType(subtitleMimeTypes[it.codec])
|
||||
.setLanguage(it.language)
|
||||
.setLabel(it.title)
|
||||
.setSelectionFlags(flags)
|
||||
.build()
|
||||
}
|
||||
}
|
||||
|
||||
Timber.v(
|
||||
"subtitleIndex=$subtitleIndex, externalSubtitleCount=$externalSubtitleCount, externalSubtitle=$externalSubtitle",
|
||||
)
|
||||
if (audioIndex != null || subtitleIndex != null) {
|
||||
val onTracksChangedListener =
|
||||
object : Player.Listener {
|
||||
override fun onTracksChanged(tracks: Tracks) {
|
||||
Timber.v("onTracksChanged: $tracks")
|
||||
if (tracks.groups.isNotEmpty()) {
|
||||
val result =
|
||||
TrackSelectionUtils.createTrackSelections(
|
||||
player.trackSelectionParameters,
|
||||
player.currentTracks,
|
||||
currentPlayer.value!!.backend,
|
||||
source.supportsDirectPlay,
|
||||
audioIndex.takeIf { transcodeType == PlayMethod.DIRECT_PLAY },
|
||||
subtitleIndex,
|
||||
source,
|
||||
)
|
||||
Timber.v("onTracksChanged: %s", result)
|
||||
if (result.bothSelected) {
|
||||
player.trackSelectionParameters =
|
||||
result.trackSelectionParameters
|
||||
|
||||
val mediaItem =
|
||||
MediaItem
|
||||
.Builder()
|
||||
.setMediaId(itemId.toString())
|
||||
.setMediaMetadata(
|
||||
item.toMediaMetadata(
|
||||
imageUrlService.getItemImageUrl(
|
||||
item,
|
||||
ImageType.PRIMARY,
|
||||
useSeriesForPrimary = true,
|
||||
),
|
||||
),
|
||||
).setUri(mediaUrl.toUri())
|
||||
.setSubtitleConfigurations(listOfNotNull(externalSubtitle))
|
||||
.apply {
|
||||
when (source.container) {
|
||||
Codec.Container.HLS -> setMimeType(MimeTypes.APPLICATION_M3U8)
|
||||
Codec.Container.DASH -> setMimeType(MimeTypes.APPLICATION_MPD)
|
||||
}
|
||||
}.build()
|
||||
|
||||
val playback =
|
||||
CurrentPlayback(
|
||||
item = item,
|
||||
tracks = listOf(),
|
||||
backend = currentPlayer.value!!.backend,
|
||||
playMethod = transcodeType,
|
||||
playSessionId = response.playSessionId,
|
||||
liveStreamId = source.liveStreamId,
|
||||
mediaSourceInfo = source,
|
||||
)
|
||||
|
||||
preferences.appPreferences.playbackPreferences.let { prefs ->
|
||||
source.mediaStreams
|
||||
?.firstOrNull { it.type == MediaStreamType.VIDEO }
|
||||
?.let { stream ->
|
||||
refreshRateService.changeRefreshRate(
|
||||
stream = stream,
|
||||
switchRefreshRate = prefs.refreshRateSwitching,
|
||||
switchResolution = prefs.resolutionSwitching,
|
||||
)
|
||||
}
|
||||
}
|
||||
withContext(WholphinDispatchers.Main) {
|
||||
// TODO, don't need to release & recreate when switching streams
|
||||
this@PlaybackViewModel.activityListener?.let {
|
||||
it.release()
|
||||
player.removeListener(it)
|
||||
}
|
||||
|
||||
val playbackItemState = PlaybackItemState(playback, currentItemPlayback)
|
||||
val activityListener =
|
||||
TrackActivityPlaybackListener(
|
||||
api = api,
|
||||
player = player,
|
||||
getState = { playbackItemState },
|
||||
)
|
||||
player.addListener(activityListener)
|
||||
this@PlaybackViewModel.activityListener = activityListener
|
||||
|
||||
_state.update {
|
||||
it.copy(
|
||||
loading = LoadingState.Success,
|
||||
currentPlayback = playback,
|
||||
)
|
||||
}
|
||||
player.setMediaItem(
|
||||
mediaItem,
|
||||
positionMs,
|
||||
)
|
||||
if (transcodeType == PlayMethod.DIRECT_PLAY && (audioIndex != null || subtitleIndex != null)) {
|
||||
val onTracksChangedListener =
|
||||
object : Player.Listener {
|
||||
override fun onTracksChanged(tracks: Tracks) {
|
||||
Timber.v("onTracksChanged: $tracks")
|
||||
if (tracks.groups.isNotEmpty()) {
|
||||
val result =
|
||||
TrackSelectionUtils.createTrackSelections(
|
||||
player.trackSelectionParameters,
|
||||
player.currentTracks,
|
||||
audioIndex,
|
||||
subtitleIndex,
|
||||
source,
|
||||
)
|
||||
Timber.v("onTracksChanged: %s", result)
|
||||
player.removeListener(this)
|
||||
if (result.bothSelected) {
|
||||
player.trackSelectionParameters =
|
||||
result.trackSelectionParameters
|
||||
} else {
|
||||
// Fall back to transcoding
|
||||
Timber.w("Failed to select tracks, falling back to transcoding")
|
||||
viewModelScope.launchIO {
|
||||
changeStreams(
|
||||
item = item,
|
||||
currentItemPlayback = currentItemPlayback,
|
||||
audioIndex = audioIndex,
|
||||
subtitleIndex = subtitleIndex,
|
||||
positionMs = positionMs,
|
||||
userInitiated = userInitiated,
|
||||
enableDirectPlay = false,
|
||||
enableDirectStream = true,
|
||||
)
|
||||
}
|
||||
}
|
||||
viewModelScope.launchIO { loadSubtitleDelay() }
|
||||
}
|
||||
viewModelScope.launchIO { loadSubtitleDelay() }
|
||||
}
|
||||
}
|
||||
}
|
||||
player.addListener(onTracksChangedListener)
|
||||
player.addListener(onTracksChangedListener)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* If direct playing, can try to switch tracks without playback restarting
|
||||
|
|
@ -853,12 +880,11 @@ class PlaybackViewModel
|
|||
userInitiated: Boolean,
|
||||
): Boolean =
|
||||
withContext(WholphinDispatchers.IO) {
|
||||
// TODO there's probably no reason why we can't add external subtitles?
|
||||
Timber.v("changeStreams direct play")
|
||||
|
||||
// TODO Better way to handle unsupported types in general is needed
|
||||
// This is a workaround for switching to a non AC3 track when the user wants audio transcoded to AC3
|
||||
if (preferences.appPreferences.experimentalPreferences.preferAc3Surround && audioIndex != null) {
|
||||
if (preferences.appPreferences.experimentalPreferences.enabled { preferAc3Surround } && audioIndex != null) {
|
||||
currentPlayback.mediaSourceInfo.mediaStreams
|
||||
.orEmpty()
|
||||
.firstOrNull { it.index == audioIndex }
|
||||
|
|
@ -873,15 +899,12 @@ class PlaybackViewModel
|
|||
val source = currentPlayback.mediaSourceInfo
|
||||
val externalSubtitle = source.findExternalSubtitle(subtitleIndex)
|
||||
|
||||
// TODO there's probably no reason why we can't add external subtitles?
|
||||
if (externalSubtitle == null) {
|
||||
val result =
|
||||
withContext(WholphinDispatchers.Main) {
|
||||
TrackSelectionUtils.createTrackSelections(
|
||||
onMain { player.trackSelectionParameters },
|
||||
onMain { player.currentTracks },
|
||||
currentPlayer.value!!.backend,
|
||||
true,
|
||||
audioIndex,
|
||||
subtitleIndex,
|
||||
source,
|
||||
|
|
@ -916,7 +939,7 @@ class PlaybackViewModel
|
|||
it.copy(
|
||||
currentPlayback =
|
||||
(it.currentPlayback ?: currentPlayback).copy(
|
||||
tracks = checkForSupport(player.currentTracks),
|
||||
tracks = checkForSupport(onMain { player.currentTracks }),
|
||||
),
|
||||
)
|
||||
}
|
||||
|
|
|
|||
|
|
@ -7,13 +7,11 @@ import androidx.media3.common.TrackSelectionOverride
|
|||
import androidx.media3.common.TrackSelectionParameters
|
||||
import androidx.media3.common.Tracks
|
||||
import androidx.media3.common.util.UnstableApi
|
||||
import com.github.damontecres.wholphin.preferences.PlayerBackend
|
||||
import com.github.damontecres.wholphin.ui.indexOfFirstOrNull
|
||||
import org.jellyfin.sdk.model.api.MediaSourceInfo
|
||||
import org.jellyfin.sdk.model.api.MediaStream
|
||||
import org.jellyfin.sdk.model.api.MediaStreamType
|
||||
import org.jellyfin.sdk.model.api.SubtitleDeliveryMethod
|
||||
import timber.log.Timber
|
||||
import kotlin.math.max
|
||||
|
||||
/**
|
||||
* Functions for selecting which audio & subtitle tracks to activate in the [androidx.media3.common.Player]
|
||||
|
|
@ -23,201 +21,152 @@ object TrackSelectionUtils {
|
|||
fun createTrackSelections(
|
||||
trackSelectionParams: TrackSelectionParameters,
|
||||
tracks: Tracks,
|
||||
playerBackend: PlayerBackend,
|
||||
supportsDirectPlay: Boolean,
|
||||
audioIndex: Int?,
|
||||
subtitleIndex: Int?,
|
||||
source: MediaSourceInfo,
|
||||
): TrackSelectionResult {
|
||||
val embeddedSubtitleCount = source.embeddedSubtitleCount
|
||||
val externalSubtitleCount = source.externalSubtitlesCount
|
||||
|
||||
val paramsBuilder = trackSelectionParams.buildUpon()
|
||||
val groups = tracks.groups
|
||||
|
||||
val subtitleSelected =
|
||||
if (subtitleIndex != null && subtitleIndex >= 0) {
|
||||
val subtitleIsExternal = source.findExternalSubtitle(subtitleIndex) != null
|
||||
if (subtitleIsExternal || supportsDirectPlay) {
|
||||
val chosenTrack =
|
||||
if (subtitleIsExternal && playerBackend == PlayerBackend.EXO_PLAYER) {
|
||||
groups.firstOrNull { group ->
|
||||
group.type == C.TRACK_TYPE_TEXT && group.isSupported &&
|
||||
(0..<group.mediaTrackGroup.length)
|
||||
.mapNotNull {
|
||||
group.getTrackFormat(it).id
|
||||
}.any { it.endsWith("e:$subtitleIndex") }
|
||||
}
|
||||
} else {
|
||||
val actualEmbeddedCount =
|
||||
groups
|
||||
.filter { group ->
|
||||
group.type == C.TRACK_TYPE_TEXT &&
|
||||
(0..<group.mediaTrackGroup.length)
|
||||
.mapNotNull {
|
||||
group.getTrackFormat(it).id
|
||||
}.none { it.contains("e:") }
|
||||
}.size
|
||||
val indexToFind =
|
||||
calculateIndexToFind(
|
||||
subtitleIndex,
|
||||
MediaStreamType.SUBTITLE,
|
||||
playerBackend,
|
||||
embeddedSubtitleCount,
|
||||
externalSubtitleCount,
|
||||
subtitleIsExternal,
|
||||
actualEmbeddedCount,
|
||||
source,
|
||||
)
|
||||
Timber.v("Chosen subtitle ($subtitleIndex/$indexToFind) track")
|
||||
// subtitleIndex - externalSubtitleCount + 1
|
||||
groups.firstOrNull { group ->
|
||||
group.type == C.TRACK_TYPE_TEXT && group.isSupported &&
|
||||
(0..<group.mediaTrackGroup.length)
|
||||
.filter {
|
||||
if (subtitleIsExternal) {
|
||||
group.getTrackFormat(0).id?.contains("e:") == true
|
||||
} else {
|
||||
group.getTrackFormat(0).id?.contains("e:") == false
|
||||
}
|
||||
}.map {
|
||||
group.getTrackFormat(it).idAsInt
|
||||
}.contains(indexToFind)
|
||||
}
|
||||
val chosenTrack =
|
||||
if (subtitleIsExternal) {
|
||||
tracks.groups.firstOrNull { group ->
|
||||
group.type == C.TRACK_TYPE_TEXT && group.isExternal
|
||||
}
|
||||
|
||||
Timber.v("Chosen subtitle ($subtitleIndex) track: $chosenTrack")
|
||||
chosenTrack?.let {
|
||||
} else {
|
||||
val playerIndex =
|
||||
getPlayerIndex(subtitleIndex, source, MediaStreamType.SUBTITLE)
|
||||
if (playerIndex != null) {
|
||||
tracks.groups
|
||||
.filter { group ->
|
||||
group.type == C.TRACK_TYPE_TEXT &&
|
||||
group.length >= 1 &&
|
||||
!group.isExternal
|
||||
}
|
||||
// TODO why are exoplayer tracks out of order sometimes?
|
||||
.sortedById()
|
||||
.getOrNull(playerIndex)
|
||||
} else {
|
||||
null
|
||||
}
|
||||
}
|
||||
when {
|
||||
chosenTrack != null && chosenTrack.isSupported -> {
|
||||
paramsBuilder
|
||||
.clearOverridesOfType(C.TRACK_TYPE_TEXT)
|
||||
.setTrackTypeDisabled(C.TRACK_TYPE_TEXT, false)
|
||||
.setOverrideForType(
|
||||
TrackSelectionOverride(
|
||||
chosenTrack.mediaTrackGroup,
|
||||
0,
|
||||
),
|
||||
TrackSelectionOverride(chosenTrack.mediaTrackGroup, 0),
|
||||
)
|
||||
TrackSelected.SELECTED
|
||||
}
|
||||
|
||||
chosenTrack != null && !chosenTrack.isSupported -> {
|
||||
TrackSelected.UNSUPPORTED
|
||||
}
|
||||
|
||||
else -> {
|
||||
TrackSelected.NOT_FOUND
|
||||
}
|
||||
chosenTrack != null
|
||||
} else {
|
||||
false
|
||||
}
|
||||
} else {
|
||||
paramsBuilder
|
||||
.clearOverridesOfType(C.TRACK_TYPE_TEXT)
|
||||
.setTrackTypeDisabled(C.TRACK_TYPE_TEXT, true)
|
||||
|
||||
true
|
||||
TrackSelected.SELECTED
|
||||
}
|
||||
|
||||
val audioSelected =
|
||||
if (audioIndex != null && audioIndex >= 0 && supportsDirectPlay) {
|
||||
val indexToFind =
|
||||
calculateIndexToFind(
|
||||
audioIndex,
|
||||
MediaStreamType.AUDIO,
|
||||
playerBackend,
|
||||
embeddedSubtitleCount,
|
||||
externalSubtitleCount,
|
||||
false,
|
||||
null,
|
||||
source,
|
||||
)
|
||||
if (audioIndex != null && audioIndex >= 0) {
|
||||
val playerIndex = getPlayerIndex(audioIndex, source, MediaStreamType.AUDIO)
|
||||
val chosenTrack =
|
||||
groups.firstOrNull { group ->
|
||||
group.type == C.TRACK_TYPE_AUDIO && group.isSupported &&
|
||||
(0..<group.mediaTrackGroup.length)
|
||||
.map {
|
||||
group.getTrackFormat(it).idAsInt
|
||||
}.contains(indexToFind)
|
||||
if (playerIndex != null) {
|
||||
tracks.groups
|
||||
.filter { group ->
|
||||
group.type == C.TRACK_TYPE_AUDIO && group.length >= 1
|
||||
}
|
||||
// TODO why are exoplayer tracks out of order sometimes?
|
||||
.sortedById()
|
||||
.getOrNull(playerIndex)
|
||||
} else {
|
||||
null
|
||||
}
|
||||
when {
|
||||
chosenTrack != null && chosenTrack.isSupported -> {
|
||||
paramsBuilder
|
||||
.clearOverridesOfType(C.TRACK_TYPE_AUDIO)
|
||||
.setTrackTypeDisabled(C.TRACK_TYPE_AUDIO, false)
|
||||
.setOverrideForType(
|
||||
TrackSelectionOverride(chosenTrack.mediaTrackGroup, 0),
|
||||
)
|
||||
TrackSelected.SELECTED
|
||||
}
|
||||
|
||||
chosenTrack != null && !chosenTrack.isSupported -> {
|
||||
TrackSelected.UNSUPPORTED
|
||||
}
|
||||
|
||||
else -> {
|
||||
TrackSelected.NOT_FOUND
|
||||
}
|
||||
Timber.v("Chosen audio ($audioIndex/$indexToFind) track: $chosenTrack")
|
||||
chosenTrack?.let {
|
||||
paramsBuilder
|
||||
.setTrackTypeDisabled(C.TRACK_TYPE_AUDIO, false)
|
||||
.setOverrideForType(
|
||||
TrackSelectionOverride(
|
||||
chosenTrack.mediaTrackGroup,
|
||||
0,
|
||||
),
|
||||
)
|
||||
}
|
||||
chosenTrack != null
|
||||
} else {
|
||||
true
|
||||
TrackSelected.SELECTED
|
||||
}
|
||||
return TrackSelectionResult(paramsBuilder.build(), audioSelected, subtitleSelected)
|
||||
}
|
||||
|
||||
/**
|
||||
* Maps the server provided index to the track index based on the [PlayerBackend] and other stream information
|
||||
*/
|
||||
private fun calculateIndexToFind(
|
||||
private fun getPlayerIndex(
|
||||
serverIndex: Int,
|
||||
type: MediaStreamType,
|
||||
playerBackend: PlayerBackend,
|
||||
embeddedSubtitleCount: Int,
|
||||
externalSubtitleCount: Int,
|
||||
subtitleIsExternal: Boolean,
|
||||
actualEmbeddedCount: Int?,
|
||||
source: MediaSourceInfo,
|
||||
): Int =
|
||||
when (playerBackend) {
|
||||
PlayerBackend.EXO_PLAYER,
|
||||
PlayerBackend.UNRECOGNIZED,
|
||||
-> {
|
||||
serverIndex - externalSubtitleCount + 1
|
||||
}
|
||||
|
||||
// TODO MPV could use literal indexes because they are stored in the track format ID
|
||||
PlayerBackend.PREFER_MPV,
|
||||
PlayerBackend.MPV,
|
||||
-> {
|
||||
when (type) {
|
||||
MediaStreamType.VIDEO -> {
|
||||
serverIndex - externalSubtitleCount + 1
|
||||
type: MediaStreamType,
|
||||
): Int? {
|
||||
val playerIndex =
|
||||
source.mediaStreams
|
||||
.orEmpty()
|
||||
.filter { it.type == type }
|
||||
.let {
|
||||
if (type == MediaStreamType.SUBTITLE) {
|
||||
it.filter { it.deliveryMethod == SubtitleDeliveryMethod.EMBED || it.deliveryMethod == SubtitleDeliveryMethod.HLS }
|
||||
} else {
|
||||
it
|
||||
}
|
||||
}.indexOfFirstOrNull { it.index == serverIndex }
|
||||
return playerIndex
|
||||
}
|
||||
|
||||
MediaStreamType.AUDIO -> {
|
||||
val videoStreamsBeforeAudioCount =
|
||||
source.mediaStreams
|
||||
.orEmpty()
|
||||
.indexOfFirst { it.type == MediaStreamType.AUDIO } - externalSubtitleCount
|
||||
serverIndex - externalSubtitleCount - videoStreamsBeforeAudioCount + 1
|
||||
}
|
||||
|
||||
MediaStreamType.SUBTITLE -> {
|
||||
if (subtitleIsExternal) {
|
||||
// Need to account for the actual embedded count because if the library
|
||||
// disables embedded subtitles, they still exist in the direct played file,
|
||||
// but not included in the MediaStreams list
|
||||
serverIndex + max(actualEmbeddedCount ?: 0, embeddedSubtitleCount) + 1
|
||||
} else {
|
||||
val videoStreamCount = source.videoStreamCount
|
||||
val audioStreamCount = source.audioStreamCount
|
||||
serverIndex - externalSubtitleCount - videoStreamCount - audioStreamCount + 1
|
||||
}
|
||||
}
|
||||
|
||||
else -> {
|
||||
throw UnsupportedOperationException("Cannot calculate index for $type")
|
||||
}
|
||||
val Tracks.Group.trackFormats: List<Format>
|
||||
@OptIn(UnstableApi::class)
|
||||
get() =
|
||||
(0..<mediaTrackGroup.length)
|
||||
.mapNotNull {
|
||||
getTrackFormat(it)
|
||||
}
|
||||
|
||||
private val Tracks.Group.isExternal: Boolean
|
||||
get() =
|
||||
trackFormats.any {
|
||||
it.id?.contains(":e:") == true
|
||||
}
|
||||
|
||||
PlayerBackend.EXTERNAL_PLAYER -> {
|
||||
throw IllegalStateException("Cannot calculate tracks external playback")
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
val Format.idAsInt: Int?
|
||||
@OptIn(UnstableApi::class)
|
||||
get() =
|
||||
id?.let {
|
||||
if (it.contains(":")) {
|
||||
it.split(":").last().toIntOrNull()
|
||||
private fun Iterable<Tracks.Group>.sortedById(): List<Tracks.Group> =
|
||||
mapNotNull { track ->
|
||||
if (track.isExternal) {
|
||||
// Should be filtered out before calling this though
|
||||
track to listOf(Int.MAX_VALUE, Int.MAX_VALUE)
|
||||
} else {
|
||||
it.toIntOrNull()
|
||||
track.trackFormats[0]
|
||||
.id
|
||||
?.split(":")
|
||||
?.map { it.toInt() }
|
||||
?.let {
|
||||
track to it
|
||||
}
|
||||
}
|
||||
}
|
||||
}.sortedWith(compareBy<Pair<Tracks.Group, List<Int>>> { it.second[0] }.thenBy { it.second[1] })
|
||||
.map { it.first }
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the number of external subtitle streams there are
|
||||
|
|
@ -270,8 +219,18 @@ fun List<MediaStream>.findExternalSubtitle(subtitleIndex: Int?): MediaStream? =
|
|||
*/
|
||||
data class TrackSelectionResult(
|
||||
val trackSelectionParameters: TrackSelectionParameters,
|
||||
val audioSelected: Boolean,
|
||||
val subtitleSelected: Boolean,
|
||||
val audio: TrackSelected,
|
||||
val subtitle: TrackSelected,
|
||||
) {
|
||||
val bothSelected: Boolean = audioSelected && subtitleSelected
|
||||
val audioSelected: Boolean get() = audio == TrackSelected.SELECTED
|
||||
|
||||
val subtitleSelected: Boolean get() = subtitle == TrackSelected.SELECTED
|
||||
|
||||
val bothSelected: Boolean get() = audioSelected && subtitleSelected
|
||||
}
|
||||
|
||||
enum class TrackSelected {
|
||||
SELECTED,
|
||||
NOT_FOUND,
|
||||
UNSUPPORTED,
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue