RtpH263ReaderTest.java

/*
 * Copyright 2022 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.google.android.exoplayer2.source.rtsp.reader;

import static com.google.android.exoplayer2.util.Util.getBytesFromHexString;
import static com.google.common.truth.Truth.assertThat;

import androidx.test.ext.junit.runners.AndroidJUnit4;
import com.google.android.exoplayer2.C;
import com.google.android.exoplayer2.Format;
import com.google.android.exoplayer2.source.rtsp.RtpPacket;
import com.google.android.exoplayer2.source.rtsp.RtpPayloadFormat;
import com.google.android.exoplayer2.testutil.FakeExtractorOutput;
import com.google.android.exoplayer2.testutil.FakeTrackOutput;
import com.google.android.exoplayer2.util.MimeTypes;
import com.google.android.exoplayer2.util.ParsableByteArray;
import com.google.android.exoplayer2.util.Util;
import com.google.common.collect.ImmutableMap;
import com.google.common.primitives.Bytes;
import java.util.Arrays;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;

/** Unit test for {@link RtpH263Reader}. */
@RunWith(AndroidJUnit4.class)
public final class RtpH263ReaderTest {

  private static final long MEDIA_CLOCK_FREQUENCY = 90_000;

  private static final byte[] FRAME_1_FRAGMENT_1_DATA =
      getBytesFromHexString("80020c0419b7b7d9591f03023e0c37b");
  private static final long PARTITION_1_RTP_TIMESTAMP = 2599168056L;
  private static final RtpPacket PACKET_FRAME_1_FRAGMENT_1 =
      new RtpPacket.Builder()
          .setTimestamp(PARTITION_1_RTP_TIMESTAMP)
          .setSequenceNumber(40289)
          .setMarker(false)
          .setPayloadData(
              Bytes.concat(
                  /*payload header */ getBytesFromHexString("0400"), FRAME_1_FRAGMENT_1_DATA))
          .build();
  private static final byte[] FRAME_1_FRAGMENT_2_DATA =
      getBytesFromHexString("03140e0e77d5e83021a0c37");
  private static final RtpPacket PACKET_FRAME_1_FRAGMENT_2 =
      new RtpPacket.Builder()
          .setTimestamp(PARTITION_1_RTP_TIMESTAMP)
          .setSequenceNumber(40290)
          .setMarker(true)
          .setPayloadData(
              Bytes.concat(
                  /*payload header */ getBytesFromHexString("0000"), FRAME_1_FRAGMENT_2_DATA))
          .build();
  // Needs to add 0000 to byte stream, refer to RFC4629 Section 6.1.1.
  private static final byte[] FRAME_1_DATA =
      Bytes.concat(getBytesFromHexString("0000"), FRAME_1_FRAGMENT_1_DATA, FRAME_1_FRAGMENT_2_DATA);

  private static final byte[] FRAME_2_FRAGMENT_1_DATA =
      getBytesFromHexString("800a0e023ffffffffffffffffff");
  private static final long PARTITION_2_RTP_TIMESTAMP = 2599168344L;
  private static final RtpPacket PACKET_FRAME_2_FRAGMENT_1 =
      new RtpPacket.Builder()
          .setTimestamp(PARTITION_2_RTP_TIMESTAMP)
          .setSequenceNumber(40291)
          .setMarker(false)
          .setPayloadData(
              Bytes.concat(
                  /*payload header */ getBytesFromHexString("0400"), FRAME_2_FRAGMENT_1_DATA))
          .build();
  private static final byte[] FRAME_2_FRAGMENT_2_DATA =
      getBytesFromHexString("830df80c501839dfccdbdbecac");
  private static final RtpPacket PACKET_FRAME_2_FRAGMENT_2 =
      new RtpPacket.Builder()
          .setTimestamp(PARTITION_2_RTP_TIMESTAMP)
          .setSequenceNumber(40292)
          .setMarker(true)
          .setPayloadData(
              Bytes.concat(
                  /*payload header */ getBytesFromHexString("0000"), FRAME_2_FRAGMENT_2_DATA))
          .build();
  private static final byte[] FRAME_2_DATA =
      Bytes.concat(getBytesFromHexString("0000"), FRAME_2_FRAGMENT_1_DATA, FRAME_2_FRAGMENT_2_DATA);

  private static final long PARTITION_2_PRESENTATION_TIMESTAMP_US =
      Util.scaleLargeTimestamp(
          (PARTITION_2_RTP_TIMESTAMP - PARTITION_1_RTP_TIMESTAMP),
          /* multiplier= */ C.MICROS_PER_SECOND,
          /* divisor= */ MEDIA_CLOCK_FREQUENCY);

  private static final RtpPayloadFormat H263_FORMAT =
      new RtpPayloadFormat(
          new Format.Builder()
              .setSampleMimeType(MimeTypes.VIDEO_H263)
              .setWidth(352)
              .setHeight(288)
              .build(),
          /* rtpPayloadType= */ 96,
          /* clockRate= */ (int) MEDIA_CLOCK_FREQUENCY,
          /* fmtpParameters= */ ImmutableMap.of());

  private FakeExtractorOutput extractorOutput;

  @Before
  public void setUp() {
    extractorOutput = new FakeExtractorOutput();
  }

  @Test
  public void consume_validPackets() {
    RtpH263Reader h263Reader = new RtpH263Reader(H263_FORMAT);
    h263Reader.createTracks(extractorOutput, /* trackId= */ 0);
    h263Reader.onReceivingFirstPacket(
        PACKET_FRAME_1_FRAGMENT_1.timestamp, PACKET_FRAME_1_FRAGMENT_1.sequenceNumber);
    consume(h263Reader, PACKET_FRAME_1_FRAGMENT_1);
    consume(h263Reader, PACKET_FRAME_1_FRAGMENT_2);
    consume(h263Reader, PACKET_FRAME_2_FRAGMENT_1);
    consume(h263Reader, PACKET_FRAME_2_FRAGMENT_2);

    FakeTrackOutput trackOutput = extractorOutput.trackOutputs.get(0);
    assertThat(trackOutput.getSampleCount()).isEqualTo(2);
    assertThat(trackOutput.getSampleData(0)).isEqualTo(FRAME_1_DATA);
    assertThat(trackOutput.getSampleTimeUs(0)).isEqualTo(0);
    assertThat(trackOutput.getSampleData(1)).isEqualTo(FRAME_2_DATA);
    assertThat(trackOutput.getSampleTimeUs(1)).isEqualTo(PARTITION_2_PRESENTATION_TIMESTAMP_US);
  }

  @Test
  public void consume_fragmentedFrameMissingFirstFragment() {
    RtpH263Reader h263Reader = new RtpH263Reader(H263_FORMAT);
    h263Reader.createTracks(extractorOutput, /* trackId= */ 0);
    h263Reader.onReceivingFirstPacket(
        PACKET_FRAME_1_FRAGMENT_1.timestamp, PACKET_FRAME_1_FRAGMENT_1.sequenceNumber);
    consume(h263Reader, PACKET_FRAME_1_FRAGMENT_2);
    consume(h263Reader, PACKET_FRAME_2_FRAGMENT_1);
    consume(h263Reader, PACKET_FRAME_2_FRAGMENT_2);

    FakeTrackOutput trackOutput = extractorOutput.trackOutputs.get(0);
    assertThat(trackOutput.getSampleCount()).isEqualTo(1);
    assertThat(trackOutput.getSampleData(0)).isEqualTo(FRAME_2_DATA);
    assertThat(trackOutput.getSampleTimeUs(0)).isEqualTo(PARTITION_2_PRESENTATION_TIMESTAMP_US);
  }

  @Test
  public void consume_fragmentedFrameMissingBoundaryFragment() {
    RtpH263Reader h263Reader = new RtpH263Reader(H263_FORMAT);
    h263Reader.createTracks(extractorOutput, /* trackId= */ 0);
    h263Reader.onReceivingFirstPacket(
        PACKET_FRAME_1_FRAGMENT_1.timestamp, PACKET_FRAME_1_FRAGMENT_1.sequenceNumber);
    consume(h263Reader, PACKET_FRAME_1_FRAGMENT_1);
    consume(h263Reader, PACKET_FRAME_2_FRAGMENT_1);
    consume(h263Reader, PACKET_FRAME_2_FRAGMENT_2);

    FakeTrackOutput trackOutput = extractorOutput.trackOutputs.get(0);
    assertThat(trackOutput.getSampleCount()).isEqualTo(2);
    assertThat(trackOutput.getSampleData(0))
        .isEqualTo(Bytes.concat(getBytesFromHexString("0000"), FRAME_1_FRAGMENT_1_DATA));
    assertThat(trackOutput.getSampleTimeUs(0)).isEqualTo(0);
    assertThat(trackOutput.getSampleData(1)).isEqualTo(FRAME_2_DATA);
    assertThat(trackOutput.getSampleTimeUs(1)).isEqualTo(PARTITION_2_PRESENTATION_TIMESTAMP_US);
  }

  @Test
  public void consume_outOfOrderPackets() {
    RtpH263Reader h263Reader = new RtpH263Reader(H263_FORMAT);
    h263Reader.createTracks(extractorOutput, /* trackId= */ 0);
    h263Reader.onReceivingFirstPacket(
        PACKET_FRAME_1_FRAGMENT_1.timestamp, PACKET_FRAME_1_FRAGMENT_1.sequenceNumber);
    consume(h263Reader, PACKET_FRAME_1_FRAGMENT_1);
    consume(h263Reader, PACKET_FRAME_2_FRAGMENT_1);
    consume(h263Reader, PACKET_FRAME_1_FRAGMENT_2);
    consume(h263Reader, PACKET_FRAME_2_FRAGMENT_2);

    FakeTrackOutput trackOutput = extractorOutput.trackOutputs.get(0);
    assertThat(trackOutput.getSampleCount()).isEqualTo(2);
    assertThat(trackOutput.getSampleData(0))
        .isEqualTo(Bytes.concat(getBytesFromHexString("0000"), FRAME_1_FRAGMENT_1_DATA));
    assertThat(trackOutput.getSampleTimeUs(0)).isEqualTo(0);
    assertThat(trackOutput.getSampleData(1)).isEqualTo(FRAME_2_DATA);
    assertThat(trackOutput.getSampleTimeUs(1)).isEqualTo(PARTITION_2_PRESENTATION_TIMESTAMP_US);
  }

  private static void consume(RtpH263Reader h263Reader, RtpPacket rtpPacket) {
    rtpPacket = copyPacket(rtpPacket);
    h263Reader.consume(
        new ParsableByteArray(rtpPacket.payloadData),
        rtpPacket.timestamp,
        rtpPacket.sequenceNumber,
        rtpPacket.marker);
  }

  private static RtpPacket copyPacket(RtpPacket packet) {
    RtpPacket.Builder builder =
        new RtpPacket.Builder()
            .setPadding(packet.padding)
            .setMarker(packet.marker)
            .setPayloadType(packet.payloadType)
            .setSequenceNumber(packet.sequenceNumber)
            .setTimestamp(packet.timestamp)
            .setSsrc(packet.ssrc);

    if (packet.csrc.length > 0) {
      builder.setCsrc(Arrays.copyOf(packet.csrc, packet.csrc.length));
    }
    if (packet.payloadData.length > 0) {
      builder.setPayloadData(Arrays.copyOf(packet.payloadData, packet.payloadData.length));
    }
    return builder.build();
  }
}