Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Mitigate missing aspect ratio issue #507

Merged
merged 1 commit into from
Apr 25, 2024
Merged

Mitigate missing aspect ratio issue #507

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 14 additions & 7 deletions pillarbox-player/src/main/java/ch/srgssr/pillarbox/player/PlayerCallbackFlow.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
package ch.srgssr.pillarbox.player

import androidx.media3.common.C
import androidx.media3.common.Format
import androidx.media3.common.MediaItem
import androidx.media3.common.MediaMetadata
import androidx.media3.common.PlaybackException
Expand All @@ -17,6 +16,7 @@ import androidx.media3.common.TrackSelectionParameters
import androidx.media3.common.Tracks
import androidx.media3.common.VideoSize
import ch.srgssr.pillarbox.player.asset.Chapter
import ch.srgssr.pillarbox.player.extension.computeAspectRatioOrNull
import ch.srgssr.pillarbox.player.extension.getChapterAtPosition
import ch.srgssr.pillarbox.player.extension.getCurrentMediaItems
import ch.srgssr.pillarbox.player.extension.getPlaybackSpeed
Expand All @@ -28,6 +28,7 @@ import kotlinx.coroutines.currentCoroutineContext
import kotlinx.coroutines.delay
import kotlinx.coroutines.flow.Flow
import kotlinx.coroutines.flow.callbackFlow
import kotlinx.coroutines.flow.combine
import kotlinx.coroutines.flow.distinctUntilChanged
import kotlinx.coroutines.flow.flow
import kotlinx.coroutines.flow.map
Expand Down Expand Up @@ -295,10 +296,16 @@ fun Player.videoSizeAsFlow(): Flow<VideoSize> = callbackFlow {
*
* @param defaultAspectRatio The aspect ratio when the video size is unknown, or for audio content.
*/
@OptIn(ExperimentalCoroutinesApi::class)
fun Player.getAspectRatioAsFlow(defaultAspectRatio: Float): Flow<Float> {
return getCurrentTracksAsFlow()
.map { it.getVideoAspectRatioOrElse(defaultAspectRatio) }
.distinctUntilChanged()
return combine(
getCurrentTracksAsFlow(),
videoSizeAsFlow(),
) { currentTracks, videoSize ->
currentTracks.getVideoAspectRatioOrNull()
?: videoSize.computeAspectRatioOrNull()
?: defaultAspectRatio
}.distinctUntilChanged()
}

/**
Expand Down Expand Up @@ -403,11 +410,11 @@ private suspend fun <T> ProducerScope<T>.addPlayerListener(player: Player, liste
}
}

private fun Tracks.getVideoAspectRatioOrElse(defaultAspectRatio: Float): Float {
private fun Tracks.getVideoAspectRatioOrNull(): Float? {
val format = videoTracks.find { it.isSelected }?.format

return if (format == null || format.height <= 0 || format.width == Format.NO_VALUE) {
defaultAspectRatio
return if (format == null || format.height <= 0 || format.width <= 0) {
null
} else {
format.width * format.pixelWidthHeightRatio / format.height.toFloat()
}
Expand Down
8 changes: 3 additions & 5 deletions pillarbox-player/src/main/java/ch/srgssr/pillarbox/player/extension/VideoSize.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,10 @@ import android.util.Rational
import androidx.media3.common.VideoSize

/**
* Compute aspect ratio, return [unknownAspectRatioValue] if aspect ratio can't be computed.
*
* @param unknownAspectRatioValue
* Compute the aspect ratio, return `null` if the aspect ratio can't be computed.
*/
fun VideoSize.computeAspectRatio(unknownAspectRatioValue: Float): Float {
return if (height == 0 || width == 0) unknownAspectRatioValue else width * this.pixelWidthHeightRatio / height
fun VideoSize.computeAspectRatioOrNull(): Float? {
return if (height == 0 || width == 0) null else width * this.pixelWidthHeightRatio / height
}

/**
Expand Down
48 changes: 48 additions & 0 deletions pillarbox-player/src/test/java/ch/srgssr/pillarbox/player/TestPlayerCallbackFlow.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -432,6 +432,54 @@ class TestPlayerCallbackFlow {
}
}

@Test
fun `get aspect ratio as flow, video tracks no video size, has video size`() = runTest {
val videoTracks = Tracks(
listOf(
createTrackGroup(
selectedIndex = 1,
createVideoFormat("v1", width = Format.NO_VALUE, height = Format.NO_VALUE),
createVideoFormat("v2", width = Format.NO_VALUE, height = Format.NO_VALUE),
createVideoFormat("v3", width = Format.NO_VALUE, height = Format.NO_VALUE),
)
)
)

val fakePlayer = PlayerListenerCommander(player)

fakePlayer.getAspectRatioAsFlow(0f).test {
fakePlayer.onVideoSizeChanged(VideoSize(1920, 1080))
fakePlayer.onTracksChanged(videoTracks)

assertEquals(0f, awaitItem())
assertEquals(16 / 9f, awaitItem())
ensureAllEventsConsumed()
}
}

@Test
fun `get aspect ratio as flow, video tracks no video size, no video size`() = runTest {
val videoTracks = Tracks(
listOf(
createTrackGroup(
selectedIndex = 1,
createVideoFormat("v1", width = Format.NO_VALUE, height = Format.NO_VALUE),
createVideoFormat("v2", width = Format.NO_VALUE, height = Format.NO_VALUE),
createVideoFormat("v3", width = Format.NO_VALUE, height = Format.NO_VALUE),
)
)
)

val fakePlayer = PlayerListenerCommander(player)

fakePlayer.getAspectRatioAsFlow(0f).test {
fakePlayer.onTracksChanged(videoTracks)

assertEquals(0f, awaitItem())
ensureAllEventsConsumed()
}
}

@Test
fun `get aspect ratio as flow, video tracks without selection`() = runTest {
val videoTracksWithoutSelection = Tracks(
Expand Down
29 changes: 9 additions & 20 deletions pillarbox-player/src/test/java/ch/srgssr/pillarbox/player/extension/VideoSizeTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,71 +10,60 @@ import androidx.test.ext.junit.runners.AndroidJUnit4
import org.junit.runner.RunWith
import kotlin.test.Test
import kotlin.test.assertEquals
import kotlin.test.assertNull

@RunWith(AndroidJUnit4::class)
class VideoSizeTest {
@Test
fun `computeAspectRatio unknown video size`() {
val input = VideoSize.UNKNOWN
val expectedAspectRatio = 16f / 9
val unknownAspectRatio = 16f / 9
assertEquals(expectedAspectRatio, input.computeAspectRatio(unknownAspectRatio))
assertNull(input.computeAspectRatioOrNull())
}

@Test
fun `computeAspectRatio with height set to 0`() {
val input = VideoSize(0, 100)
val expectedAspectRatio = 16f / 9
val unknownAspectRatio = 16f / 9
assertEquals(expectedAspectRatio, input.computeAspectRatio(unknownAspectRatio))
assertNull(input.computeAspectRatioOrNull())
}

@Test
fun `computeAspectRatio with width set to 0`() {
val input = VideoSize(240, 0)
val expectedAspectRatio = 16f / 9
val unknownAspectRatio = 16f / 9
assertEquals(expectedAspectRatio, input.computeAspectRatio(unknownAspectRatio))
assertNull(input.computeAspectRatioOrNull())
}

@Test
fun `computeAspectRatio with width and height set to 0`() {
val input = VideoSize(0, 0)
val expectedAspectRatio = 16f / 9
val unknownAspectRatio = 16f / 9
assertEquals(expectedAspectRatio, input.computeAspectRatio(unknownAspectRatio))
assertNull(input.computeAspectRatioOrNull())
}

@Test
fun `computeAspectRatio with a 16-9 aspect ratio`() {
val input = VideoSize(1920, 1080)
val expectedAspectRatio = 16f / 9
val unknownAspectRatio = 1f
assertEquals(expectedAspectRatio, input.computeAspectRatio(unknownAspectRatio))
assertEquals(expectedAspectRatio, input.computeAspectRatioOrNull())
}

@Test
fun `computeAspectRatio with a 9-16 aspect ratio`() {
val input = VideoSize(1080, 1920)
val expectedAspectRatio = 9f / 16
val unknownAspectRatio = 1f
assertEquals(expectedAspectRatio, input.computeAspectRatio(unknownAspectRatio))
assertEquals(expectedAspectRatio, input.computeAspectRatioOrNull())
}

@Test
fun `computeAspectRatio with a 4-3 aspect ratio`() {
val input = VideoSize(800, 600)
val expectedAspectRatio = 4f / 3
val unknownAspectRatio = 1f
assertEquals(expectedAspectRatio, input.computeAspectRatio(unknownAspectRatio))
assertEquals(expectedAspectRatio, input.computeAspectRatioOrNull())
}

@Test
fun `computeAspectRatio with a square aspect ratio`() {
val input = VideoSize(500, 500)
val expectedAspectRatio = 1f
val unknownAspectRatio = 0f
assertEquals(expectedAspectRatio, input.computeAspectRatio(unknownAspectRatio))
assertEquals(expectedAspectRatio, input.computeAspectRatioOrNull())
}

@Test
Expand Down
2 changes: 1 addition & 1 deletion pillarbox-ui/src/main/java/ch/srgssr/pillarbox/ui/widget/player/PlayerSurface.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ fun PlayerSurface(
displayDebugView: Boolean = false,
surfaceContent: @Composable (BoxScope.() -> Unit)? = { ExoPlayerSubtitleView(player = player) },
) {
var lastKnownVideoAspectRatio by remember { mutableFloatStateOf(defaultAspectRatio ?: 0f) }
var lastKnownVideoAspectRatio by remember { mutableFloatStateOf(defaultAspectRatio ?: 1f) }
val videoAspectRatio by player.getAspectRatioAsState(defaultAspectRatio = lastKnownVideoAspectRatio)

// If the media has tracks, but no video tracks, we reset the aspect ratio to 0
Expand Down
Loading