Skip to content

Commit

Permalink
Added condition to RtspMediaPeriod.isLoading to check RtspState
Browse files Browse the repository at this point in the history 
If a RtspMediaSource is used within a combining source like MergingMediaSource, then it could become stuck in a loop of calling continueLoading when the source has not actually started loading yet.

Issue: #577
PiperOrigin-RevId: 561322900
  • Loading branch information
@microkatz
microkatz authored and Copybara-Service committed Aug 30, 2023
1 parent b4ee896 commit cf3fd1f
Show file tree
Hide file tree
Showing 3 changed files with 213 additions and 109 deletions.
3 changes: 3 additions & 0 deletions RELEASENOTES.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,9 @@
* RTSP Extension:
* Fix a race condition that could lead to `IndexOutOfBoundsException` when
falling back to TCP, or playback hanging in some situations.
* Check state in RTSP setup when returning loading state of
`RtspMediaPeriod`
([#577](https://github.com/androidx/media/issues/577)).
* Decoder Extensions (FFmpeg, VP9, AV1, etc.):
* MIDI extension:
* Cast Extension:
Expand Down
4 changes: 3 additions & 1 deletion libraries/exoplayer_rtsp/src/main/java/androidx/media3/exoplayer/rtsp/RtspMediaPeriod.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -380,7 +380,9 @@ public boolean continueLoading(LoadingInfo loadingInfo) {

@Override
public boolean isLoading() {
return !loadingFinished;
return !loadingFinished
&& (rtspClient.getState() == RtspClient.RTSP_STATE_PLAYING
|| rtspClient.getState() == RtspClient.RTSP_STATE_READY);
}

@Override
Expand Down
315 changes: 207 additions & 108 deletions ...ries/exoplayer_rtsp/src/test/java/androidx/media3/exoplayer/rtsp/RtspMediaPeriodTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,26 @@
import static com.google.common.truth.Truth.assertThat;

import android.net.Uri;
import androidx.annotation.Nullable;
import androidx.media3.common.C;
import androidx.media3.common.TrackGroup;
import androidx.media3.common.util.Util;
import androidx.media3.exoplayer.LoadingInfo;
import androidx.media3.exoplayer.source.MediaPeriod;
import androidx.media3.exoplayer.source.SampleStream;
import androidx.media3.exoplayer.trackselection.ExoTrackSelection;
import androidx.media3.exoplayer.trackselection.FixedTrackSelection;
import androidx.media3.exoplayer.upstream.DefaultAllocator;
import androidx.media3.test.utils.robolectric.RobolectricUtil;
import androidx.test.ext.junit.runners.AndroidJUnit4;
import com.google.common.collect.ImmutableList;
import java.io.IOException;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.concurrent.atomic.AtomicLong;
import java.util.concurrent.atomic.AtomicReference;
import javax.net.SocketFactory;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;

Expand All @@ -39,46 +47,44 @@ public final class RtspMediaPeriodTest {

private static final long DEFAULT_TIMEOUT_MS = 8000;

private RtspMediaPeriod mediaPeriod;
private final AtomicReference<TrackGroup> trackGroupAtomicReference = new AtomicReference<>();
;
private final MediaPeriod.Callback mediaPeriodCallback =
new MediaPeriod.Callback() {
@Override
public void onPrepared(MediaPeriod mediaPeriod) {
trackGroupAtomicReference.set(mediaPeriod.getTrackGroups().get(0));
}

@Override
public void onContinueLoadingRequested(MediaPeriod source) {
source.continueLoading(new LoadingInfo.Builder().setPlaybackPositionUs(0).build());
}
};
private RtpPacketStreamDump rtpPacketStreamDump;
private RtspServer rtspServer;
private RtspMediaPeriod mediaPeriod;

@Before
public void setUp() throws IOException {
rtpPacketStreamDump = RtspTestUtils.readRtpPacketStreamDump("media/rtsp/aac-dump.json");
}

@After
public void tearDown() {
mediaPeriod.release();
Util.closeQuietly(rtspServer);
}

@Test
public void prepareMediaPeriod_refreshesSourceInfoAndCallsOnPrepared() throws Exception {
RtpPacketStreamDump rtpPacketStreamDump =
RtspTestUtils.readRtpPacketStreamDump("media/rtsp/aac-dump.json");

AtomicLong refreshedSourceDurationMs = new AtomicLong();
rtspServer =
new RtspServer(
new RtspServer.ResponseProvider() {
@Override
public RtspResponse getOptionsResponse() {
return new RtspResponse(
/* status= */ 200,
new RtspHeaders.Builder().add(RtspHeaders.PUBLIC, "OPTIONS, DESCRIBE").build());
}

@Override
public RtspResponse getDescribeResponse(Uri requestedUri, RtspHeaders headers) {
return RtspTestUtils.newDescribeResponseWithSdpMessage(
"v=0\r\n"
+ "o=- 1606776316530225 1 IN IP4 127.0.0.1\r\n"
+ "s=Exoplayer test\r\n"
+ "t=0 0\r\n"
// The session is 50.46s long.
+ "a=range:npt=0-50.46\r\n",
ImmutableList.of(rtpPacketStreamDump),
requestedUri);
}
});

AtomicBoolean prepareCallbackCalled = new AtomicBoolean();
AtomicLong refreshedSourceDurationMs = new AtomicLong();

new TestResponseProvider(
rtpPacketStreamDump,
/* getPlayResponseReference= */ null,
/* isWwwAuthenticationMode= */ false));
mediaPeriod =
new RtspMediaPeriod(
new DefaultAllocator(/* trimOnReset= */ true, C.DEFAULT_BUFFER_SEGMENT_SIZE),
Expand All @@ -89,80 +95,22 @@ public RtspResponse getDescribeResponse(Uri requestedUri, RtspHeaders headers) {
/* socketFactory= */ SocketFactory.getDefault(),
/* debugLoggingEnabled= */ false);

mediaPeriod.prepare(
new MediaPeriod.Callback() {
@Override
public void onPrepared(MediaPeriod mediaPeriod) {
prepareCallbackCalled.set(true);
}

@Override
public void onContinueLoadingRequested(MediaPeriod source) {
source.continueLoading(new LoadingInfo.Builder().setPlaybackPositionUs(0).build());
}
},
/* positionUs= */ 0);
RobolectricUtil.runMainLooperUntil(prepareCallbackCalled::get);
mediaPeriod.release();
mediaPeriod.prepare(mediaPeriodCallback, /* positionUs= */ 0);
RobolectricUtil.runMainLooperUntil(() -> trackGroupAtomicReference.get() != null);

assertThat(refreshedSourceDurationMs.get()).isEqualTo(50_460);
}

@Test
public void prepareMediaPeriod_withWwwAuthentication_refreshesSourceInfoAndCallsOnPrepared()
throws Exception {
RtpPacketStreamDump rtpPacketStreamDump =
RtspTestUtils.readRtpPacketStreamDump("media/rtsp/aac-dump.json");

AtomicLong refreshedSourceDurationMs = new AtomicLong();
rtspServer =
new RtspServer(
new RtspServer.ResponseProvider() {
@Override
public RtspResponse getOptionsResponse() {
return new RtspResponse(
/* status= */ 200,
new RtspHeaders.Builder().add(RtspHeaders.PUBLIC, "OPTIONS, DESCRIBE").build());
}

@Override
public RtspResponse getDescribeResponse(Uri requestedUri, RtspHeaders headers) {
String authorizationHeader = headers.get(RtspHeaders.AUTHORIZATION);
if (authorizationHeader == null) {
return new RtspResponse(
/* status= */ 401,
new RtspHeaders.Builder()
.add(RtspHeaders.CSEQ, headers.get(RtspHeaders.CSEQ))
.add(
RtspHeaders.WWW_AUTHENTICATE,
"Digest realm=\"RTSP server\","
+ " nonce=\"0cdfe9719e7373b7d5bb2913e2115f3f\","
+ " opaque=\"5ccc069c403ebaf9f0171e9517f40e41\"")
.add(RtspHeaders.WWW_AUTHENTICATE, "BASIC realm=\"WallyWorld\"")
.build());
}

if (!authorizationHeader.contains("Digest")) {
return new RtspResponse(
401,
new RtspHeaders.Builder()
.add(RtspHeaders.CSEQ, headers.get(RtspHeaders.CSEQ))
.build());
}

return RtspTestUtils.newDescribeResponseWithSdpMessage(
"v=0\r\n"
+ "o=- 1606776316530225 1 IN IP4 127.0.0.1\r\n"
+ "s=Exoplayer test\r\n"
+ "t=0 0\r\n"
// The session is 50.46s long.
+ "a=range:npt=0-50.46\r\n",
ImmutableList.of(rtpPacketStreamDump),
requestedUri);
}
});
AtomicBoolean prepareCallbackCalled = new AtomicBoolean();
AtomicLong refreshedSourceDurationMs = new AtomicLong();

new TestResponseProvider(
rtpPacketStreamDump,
/* getPlayResponseReference= */ null,
/* isWwwAuthenticationMode= */ true));
mediaPeriod =
new RtspMediaPeriod(
new DefaultAllocator(/* trimOnReset= */ true, C.DEFAULT_BUFFER_SEGMENT_SIZE),
Expand All @@ -174,22 +122,173 @@ public RtspResponse getDescribeResponse(Uri requestedUri, RtspHeaders headers) {
/* socketFactory= */ SocketFactory.getDefault(),
/* debugLoggingEnabled= */ false);

mediaPeriod.prepare(
new MediaPeriod.Callback() {
@Override
public void onPrepared(MediaPeriod mediaPeriod) {
prepareCallbackCalled.set(true);
}

@Override
public void onContinueLoadingRequested(MediaPeriod source) {
source.continueLoading(new LoadingInfo.Builder().setPlaybackPositionUs(0).build());
}
mediaPeriod.prepare(mediaPeriodCallback, /* positionUs= */ 0);
RobolectricUtil.runMainLooperUntil(() -> trackGroupAtomicReference.get() != null);

assertThat(refreshedSourceDurationMs.get()).isEqualTo(50_460);
}

@Test
public void isLoading_afterInit_returnsFalse() throws Exception {
rtspServer =
new RtspServer(
() ->
new RtspResponse(
/* status= */ 200,
new RtspHeaders.Builder().add(RtspHeaders.PUBLIC, "OPTIONS").build()));
mediaPeriod =
new RtspMediaPeriod(
new DefaultAllocator(/* trimOnReset= */ true, C.DEFAULT_BUFFER_SEGMENT_SIZE),
new TransferRtpDataChannelFactory(DEFAULT_TIMEOUT_MS),
RtspTestUtils.getTestUri(rtspServer.startAndGetPortNumber()),
/* listener= */ timing -> {},
/* userAgent= */ "ExoPlayer:RtspPeriodTest",
/* socketFactory= */ SocketFactory.getDefault(),
/* debugLoggingEnabled= */ false);

assertThat(mediaPeriod.isLoading()).isFalse();
}

@Test
public void isLoading_afterPrepare_returnsFalse() throws Exception {
rtspServer =
new RtspServer(
new TestResponseProvider(
rtpPacketStreamDump,
/* getPlayResponseReference= */ null,
/* isWwwAuthenticationMode= */ false));
mediaPeriod =
new RtspMediaPeriod(
new DefaultAllocator(/* trimOnReset= */ true, C.DEFAULT_BUFFER_SEGMENT_SIZE),
new TransferRtpDataChannelFactory(DEFAULT_TIMEOUT_MS),
RtspTestUtils.getTestUri(rtspServer.startAndGetPortNumber()),
/* listener= */ timing -> {},
/* userAgent= */ "ExoPlayer:RtspPeriodTest",
/* socketFactory= */ SocketFactory.getDefault(),
/* debugLoggingEnabled= */ false);

mediaPeriod.prepare(mediaPeriodCallback, /* positionUs= */ 0);
RobolectricUtil.runMainLooperUntil(() -> trackGroupAtomicReference.get() != null);

assertThat(mediaPeriod.isLoading()).isFalse();
}

@Test
public void isLoading_afterSelectTracksAndSendPlayRequest_returnsTrue() throws Exception {
AtomicBoolean getPlayResponseReference = new AtomicBoolean();
rtspServer =
new RtspServer(
new TestResponseProvider(
rtpPacketStreamDump,
/* getPlayResponseReference= */ getPlayResponseReference,
/* isWwwAuthenticationMode= */ false));
mediaPeriod =
new RtspMediaPeriod(
new DefaultAllocator(/* trimOnReset= */ true, C.DEFAULT_BUFFER_SEGMENT_SIZE),
new TransferRtpDataChannelFactory(DEFAULT_TIMEOUT_MS),
RtspTestUtils.getTestUri(rtspServer.startAndGetPortNumber()),
/* listener= */ timing -> {},
/* userAgent= */ "ExoPlayer:RtspPeriodTest",
/* socketFactory= */ SocketFactory.getDefault(),
/* debugLoggingEnabled= */ false);
mediaPeriod.prepare(mediaPeriodCallback, /* positionUs= */ 0);
RobolectricUtil.runMainLooperUntil(() -> trackGroupAtomicReference.get() != null);

SampleStream[] sampleStreams = new SampleStream[1];
// Call selectTracks to initiate RTSP SETUP Request
mediaPeriod.selectTracks(
new ExoTrackSelection[] {
new FixedTrackSelection(trackGroupAtomicReference.get(), /* track= */ 0)
},
/* mayRetainStreamFlags= */ new boolean[] {false},
sampleStreams,
/* streamResetFlags= */ new boolean[] {true},
/* positionUs= */ 0);
RobolectricUtil.runMainLooperUntil(prepareCallbackCalled::get);
mediaPeriod.release();
RobolectricUtil.runMainLooperUntil(getPlayResponseReference::get);

assertThat(refreshedSourceDurationMs.get()).isEqualTo(50_460);
assertThat(mediaPeriod.isLoading()).isTrue();
}

private static class TestResponseProvider implements RtspServer.ResponseProvider {
private static final String SESSION_ID = "00000000";

private final ImmutableList<RtpPacketStreamDump> rtpPacketStreamDumps;
@Nullable private final AtomicBoolean getPlayResponseReference;
private final boolean isWwwAuthenticationMode;

private TestResponseProvider(
RtpPacketStreamDump rtpPacketStreamDump,
@Nullable AtomicBoolean getPlayResponseReference,
boolean isWwwAuthenticationMode) {
this.rtpPacketStreamDumps = ImmutableList.of(rtpPacketStreamDump);
this.getPlayResponseReference = getPlayResponseReference;
this.isWwwAuthenticationMode = isWwwAuthenticationMode;
}

@Override
public RtspResponse getOptionsResponse() {
return new RtspResponse(
/* status= */ 200,
new RtspHeaders.Builder()
.add(RtspHeaders.PUBLIC, "OPTIONS, DESCRIBE, SETUP, PLAY")
.build());
}

@Override
public RtspResponse getDescribeResponse(Uri requestedUri, RtspHeaders headers) {
if (isWwwAuthenticationMode) {
String authorizationHeader = headers.get(RtspHeaders.AUTHORIZATION);
if (authorizationHeader == null) {
return new RtspResponse(
/* status= */ 401,
new RtspHeaders.Builder()
.add(RtspHeaders.CSEQ, headers.get(RtspHeaders.CSEQ))
.add(
RtspHeaders.WWW_AUTHENTICATE,
"Digest realm=\"RTSP server\","
+ " nonce=\"0cdfe9719e7373b7d5bb2913e2115f3f\","
+ " opaque=\"5ccc069c403ebaf9f0171e9517f40e41\"")
.add(RtspHeaders.WWW_AUTHENTICATE, "BASIC realm=\"WallyWorld\"")
.build());
}

if (!authorizationHeader.contains("Digest")) {
return new RtspResponse(
401,
new RtspHeaders.Builder()
.add(RtspHeaders.CSEQ, headers.get(RtspHeaders.CSEQ))
.build());
}
}

return RtspTestUtils.newDescribeResponseWithSdpMessage(
"v=0\r\n"
+ "o=- 1606776316530225 1 IN IP4 127.0.0.1\r\n"
+ "s=Exoplayer test\r\n"
+ "t=0 0\r\n"
// The session is 50.46s long.
+ "a=range:npt=0-50.46\r\n",
rtpPacketStreamDumps,
requestedUri);
}

@Override
public RtspResponse getSetupResponse(Uri requestedUri, RtspHeaders headers) {
return new RtspResponse(
/* status= */ 200, headers.buildUpon().add(RtspHeaders.SESSION, SESSION_ID).build());
}

@Override
public RtspResponse getPlayResponse() {
if (getPlayResponseReference != null) {
getPlayResponseReference.set(true);
}

return new RtspResponse(
/* status= */ 200,
new RtspHeaders.Builder()
.add(RtspHeaders.RTP_INFO, RtspTestUtils.getRtpInfoForDumps(rtpPacketStreamDumps))
.build());
}
}
}

0 comments on commit cf3fd1f

Please sign in to comment.