Add FlacExtractorSeekTest

PiperOrigin-RevId: 285823771

library/core/src/test/java/com/google/android/exoplayer2/extractor/flac/FlacExtractorSeekTest.java

@@ -0,0 +1,300 @@
+/*
+ * Copyright (C) 2019 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.extractor.flac;
+
+import static com.google.common.truth.Truth.assertThat;
+
+import android.net.Uri;
+import androidx.test.core.app.ApplicationProvider;
+import androidx.test.ext.junit.runners.AndroidJUnit4;
+import com.google.android.exoplayer2.C;
+import com.google.android.exoplayer2.extractor.SeekMap;
+import com.google.android.exoplayer2.testutil.FakeExtractorOutput;
+import com.google.android.exoplayer2.testutil.FakeTrackOutput;
+import com.google.android.exoplayer2.testutil.TestUtil;
+import com.google.android.exoplayer2.upstream.DefaultDataSource;
+import com.google.android.exoplayer2.upstream.DefaultDataSourceFactory;
+import com.google.android.exoplayer2.util.Util;
+import java.io.IOException;
+import java.util.List;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+/** Seeking tests for {@link FlacExtractor}. */
+@RunWith(AndroidJUnit4.class)
+public class FlacExtractorSeekTest {
+
+  private static final String TEST_FILE_SEEK_TABLE = "flac/bear.flac";
+  private static final String TEST_FILE_BINARY_SEARCH = "flac/bear_one_metadata_block.flac";
+  private static final String TEST_FILE_UNSEEKABLE = "flac/bear_no_seek_table_no_num_samples.flac";
+  private static final int DURATION_US = 2_741_000;
+
+  private FlacExtractor extractor;
+  private FakeExtractorOutput extractorOutput;
+  private DefaultDataSource dataSource;
+
+  @Before
+  public void setUp() throws Exception {
+    extractor = new FlacExtractor();
+    extractorOutput = new FakeExtractorOutput();
+    dataSource =
+        new DefaultDataSourceFactory(ApplicationProvider.getApplicationContext(), "UserAgent")
+            .createDataSource();
+  }
+
+  @Test
+  public void flacExtractorReads_seekTable_returnSeekableSeekMap()
+      throws IOException, InterruptedException {
+    Uri fileUri = TestUtil.buildAssetUri(TEST_FILE_SEEK_TABLE);
+
+    SeekMap seekMap = TestUtil.extractSeekMap(extractor, extractorOutput, dataSource, fileUri);
+
+    assertThat(seekMap).isNotNull();
+    assertThat(seekMap.getDurationUs()).isEqualTo(DURATION_US);
+    assertThat(seekMap.isSeekable()).isTrue();
+  }
+
+  @Test
+  public void seeking_seekTable_handlesSeekToZero() throws IOException, InterruptedException {
+    String fileName = TEST_FILE_SEEK_TABLE;
+    Uri fileUri = TestUtil.buildAssetUri(fileName);
+    SeekMap seekMap = TestUtil.extractSeekMap(extractor, extractorOutput, dataSource, fileUri);
+    FakeTrackOutput trackOutput = extractorOutput.trackOutputs.get(0);
+
+    long targetSeekTimeUs = 0;
+    int extractedFrameIndex =
+        TestUtil.seekToTimeUs(
+            extractor, seekMap, targetSeekTimeUs, dataSource, trackOutput, fileUri);
+
+    assertThat(extractedFrameIndex).isNotEqualTo(C.INDEX_UNSET);
+    assertFirstFrameAfterSeekPrecedesTargetSeekTime(
+        fileName, trackOutput, targetSeekTimeUs, extractedFrameIndex);
+  }
+
+  @Test
+  public void seeking_seekTable_handlesSeekToEoF() throws IOException, InterruptedException {
+    String fileName = TEST_FILE_SEEK_TABLE;
+    Uri fileUri = TestUtil.buildAssetUri(fileName);
+    SeekMap seekMap = TestUtil.extractSeekMap(extractor, extractorOutput, dataSource, fileUri);
+    FakeTrackOutput trackOutput = extractorOutput.trackOutputs.get(0);
+
+    long targetSeekTimeUs = seekMap.getDurationUs();
+    int extractedFrameIndex =
+        TestUtil.seekToTimeUs(
+            extractor, seekMap, targetSeekTimeUs, dataSource, trackOutput, fileUri);
+
+    assertThat(extractedFrameIndex).isNotEqualTo(C.INDEX_UNSET);
+    assertFirstFrameAfterSeekPrecedesTargetSeekTime(
+        fileName, trackOutput, targetSeekTimeUs, extractedFrameIndex);
+  }
+
+  @Test
+  public void seeking_seekTable_handlesSeekingBackward() throws IOException, InterruptedException {
+    String fileName = TEST_FILE_SEEK_TABLE;
+    Uri fileUri = TestUtil.buildAssetUri(fileName);
+    SeekMap seekMap = TestUtil.extractSeekMap(extractor, extractorOutput, dataSource, fileUri);
+    FakeTrackOutput trackOutput = extractorOutput.trackOutputs.get(0);
+
+    long firstSeekTimeUs = 1_234_000;
+    TestUtil.seekToTimeUs(extractor, seekMap, firstSeekTimeUs, dataSource, trackOutput, fileUri);
+    long targetSeekTimeUs = 987_000;
+    int extractedFrameIndex =
+        TestUtil.seekToTimeUs(
+            extractor, seekMap, targetSeekTimeUs, dataSource, trackOutput, fileUri);
+
+    assertThat(extractedFrameIndex).isNotEqualTo(C.INDEX_UNSET);
+    assertFirstFrameAfterSeekPrecedesTargetSeekTime(
+        fileName, trackOutput, targetSeekTimeUs, extractedFrameIndex);
+  }
+
+  @Test
+  public void seeking_seekTable_handlesSeekingForward() throws IOException, InterruptedException {
+    String fileName = TEST_FILE_SEEK_TABLE;
+    Uri fileUri = TestUtil.buildAssetUri(fileName);
+    SeekMap seekMap = TestUtil.extractSeekMap(extractor, extractorOutput, dataSource, fileUri);
+    FakeTrackOutput trackOutput = extractorOutput.trackOutputs.get(0);
+
+    long firstSeekTimeUs = 987_000;
+    TestUtil.seekToTimeUs(extractor, seekMap, firstSeekTimeUs, dataSource, trackOutput, fileUri);
+    long targetSeekTimeUs = 1_234_000;
+    int extractedFrameIndex =
+        TestUtil.seekToTimeUs(
+            extractor, seekMap, targetSeekTimeUs, dataSource, trackOutput, fileUri);
+
+    assertThat(extractedFrameIndex).isNotEqualTo(C.INDEX_UNSET);
+    assertFirstFrameAfterSeekPrecedesTargetSeekTime(
+        fileName, trackOutput, targetSeekTimeUs, extractedFrameIndex);
+  }
+
+  @Test
+  public void flacExtractorReads_binarySearch_returnSeekableSeekMap()
+      throws IOException, InterruptedException {
+    Uri fileUri = TestUtil.buildAssetUri(TEST_FILE_BINARY_SEARCH);
+
+    SeekMap seekMap = TestUtil.extractSeekMap(extractor, extractorOutput, dataSource, fileUri);
+
+    assertThat(seekMap).isNotNull();
+    assertThat(seekMap.getDurationUs()).isEqualTo(DURATION_US);
+    assertThat(seekMap.isSeekable()).isTrue();
+  }
+
+  @Test
+  public void seeking_binarySearch_handlesSeekToZero() throws IOException, InterruptedException {
+    String fileName = TEST_FILE_BINARY_SEARCH;
+    Uri fileUri = TestUtil.buildAssetUri(fileName);
+    SeekMap seekMap = TestUtil.extractSeekMap(extractor, extractorOutput, dataSource, fileUri);
+    FakeTrackOutput trackOutput = extractorOutput.trackOutputs.get(0);
+
+    long targetSeekTimeUs = 0;
+    int extractedFrameIndex =
+        TestUtil.seekToTimeUs(
+            extractor, seekMap, targetSeekTimeUs, dataSource, trackOutput, fileUri);
+
+    assertThat(extractedFrameIndex).isNotEqualTo(C.INDEX_UNSET);
+    assertFirstFrameAfterSeekContainsTargetSeekTime(
+        fileName, trackOutput, targetSeekTimeUs, extractedFrameIndex);
+  }
+
+  @Test
+  public void seeking_binarySearch_handlesSeekToEoF() throws IOException, InterruptedException {
+    String fileName = TEST_FILE_BINARY_SEARCH;
+    Uri fileUri = TestUtil.buildAssetUri(fileName);
+    SeekMap seekMap = TestUtil.extractSeekMap(extractor, extractorOutput, dataSource, fileUri);
+    FakeTrackOutput trackOutput = extractorOutput.trackOutputs.get(0);
+
+    long targetSeekTimeUs = seekMap.getDurationUs();
+    int extractedFrameIndex =
+        TestUtil.seekToTimeUs(
+            extractor, seekMap, targetSeekTimeUs, dataSource, trackOutput, fileUri);
+
+    assertThat(extractedFrameIndex).isNotEqualTo(C.INDEX_UNSET);
+    assertFirstFrameAfterSeekContainsTargetSeekTime(
+        fileName, trackOutput, targetSeekTimeUs, extractedFrameIndex);
+  }
+
+  @Test
+  public void seeking_binarySearch_handlesSeekingBackward()
+      throws IOException, InterruptedException {
+    String fileName = TEST_FILE_BINARY_SEARCH;
+    Uri fileUri = TestUtil.buildAssetUri(fileName);
+    SeekMap seekMap = TestUtil.extractSeekMap(extractor, extractorOutput, dataSource, fileUri);
+    FakeTrackOutput trackOutput = extractorOutput.trackOutputs.get(0);
+
+    long firstSeekTimeUs = 1_234_000;
+    TestUtil.seekToTimeUs(extractor, seekMap, firstSeekTimeUs, dataSource, trackOutput, fileUri);
+    long targetSeekTimeUs = 987_000;
+    int extractedFrameIndex =
+        TestUtil.seekToTimeUs(
+            extractor, seekMap, targetSeekTimeUs, dataSource, trackOutput, fileUri);
+
+    assertThat(extractedFrameIndex).isNotEqualTo(C.INDEX_UNSET);
+    assertFirstFrameAfterSeekContainsTargetSeekTime(
+        fileName, trackOutput, targetSeekTimeUs, extractedFrameIndex);
+  }
+
+  @Test
+  public void seeking_binarySearch_handlesSeekingForward()
+      throws IOException, InterruptedException {
+    String fileName = TEST_FILE_BINARY_SEARCH;
+    Uri fileUri = TestUtil.buildAssetUri(fileName);
+    SeekMap seekMap = TestUtil.extractSeekMap(extractor, extractorOutput, dataSource, fileUri);
+    FakeTrackOutput trackOutput = extractorOutput.trackOutputs.get(0);
+
+    long firstSeekTimeUs = 987_000;
+    TestUtil.seekToTimeUs(extractor, seekMap, firstSeekTimeUs, dataSource, trackOutput, fileUri);
+    long targetSeekTimeUs = 1_234_000;
+    int extractedFrameIndex =
+        TestUtil.seekToTimeUs(
+            extractor, seekMap, targetSeekTimeUs, dataSource, trackOutput, fileUri);
+
+    assertThat(extractedFrameIndex).isNotEqualTo(C.INDEX_UNSET);
+    assertFirstFrameAfterSeekContainsTargetSeekTime(
+        fileName, trackOutput, targetSeekTimeUs, extractedFrameIndex);
+  }
+
+  @Test
+  public void flacExtractorReads_unseekable_returnUnseekableSeekMap()
+      throws IOException, InterruptedException {
+    Uri fileUri = TestUtil.buildAssetUri(TEST_FILE_UNSEEKABLE);
+
+    SeekMap seekMap = TestUtil.extractSeekMap(extractor, extractorOutput, dataSource, fileUri);
+
+    assertThat(seekMap).isNotNull();
+    assertThat(seekMap.getDurationUs()).isEqualTo(C.TIME_UNSET);
+    assertThat(seekMap.isSeekable()).isFalse();
+  }
+
+  private static void assertFirstFrameAfterSeekContainsTargetSeekTime(
+      String fileName,
+      FakeTrackOutput trackOutput,
+      long targetSeekTimeUs,
+      int firstFrameIndexAfterSeek)
+      throws IOException, InterruptedException {
+    FakeTrackOutput expectedTrackOutput = getExpectedTrackOutput(fileName);
+    int expectedFrameIndex = getFrameIndex(expectedTrackOutput, targetSeekTimeUs);
+
+    trackOutput.assertSample(
+        firstFrameIndexAfterSeek,
+        expectedTrackOutput.getSampleData(expectedFrameIndex),
+        expectedTrackOutput.getSampleTimeUs(expectedFrameIndex),
+        expectedTrackOutput.getSampleFlags(expectedFrameIndex),
+        expectedTrackOutput.getSampleCryptoData(expectedFrameIndex));
+  }
+
+  private static void assertFirstFrameAfterSeekPrecedesTargetSeekTime(
+      String fileName,
+      FakeTrackOutput trackOutput,
+      long targetSeekTimeUs,
+      int firstFrameIndexAfterSeek)
+      throws IOException, InterruptedException {
+    FakeTrackOutput expectedTrackOutput = getExpectedTrackOutput(fileName);
+    int maxFrameIndex = getFrameIndex(expectedTrackOutput, targetSeekTimeUs);
+
+    long firstFrameAfterSeekTimeUs = trackOutput.getSampleTimeUs(firstFrameIndexAfterSeek);
+    assertThat(firstFrameAfterSeekTimeUs).isAtMost(targetSeekTimeUs);
+
+    boolean frameFound = false;
+    for (int i = maxFrameIndex; i >= 0; i--) {
+      if (firstFrameAfterSeekTimeUs == expectedTrackOutput.getSampleTimeUs(i)) {
+        trackOutput.assertSample(
+            firstFrameIndexAfterSeek,
+            expectedTrackOutput.getSampleData(i),
+            expectedTrackOutput.getSampleTimeUs(i),
+            expectedTrackOutput.getSampleFlags(i),
+            expectedTrackOutput.getSampleCryptoData(i));
+        frameFound = true;
+        break;
+      }
+    }
+
+    assertThat(frameFound).isTrue();
+  }
+
+  private static FakeTrackOutput getExpectedTrackOutput(String fileName)
+      throws IOException, InterruptedException {
+    return TestUtil.extractAllSamplesFromFile(
+            new FlacExtractor(), ApplicationProvider.getApplicationContext(), fileName)
+        .trackOutputs
+        .get(0);
+  }
+
+  private static int getFrameIndex(FakeTrackOutput expectedTrackOutput, long targetSeekTimeUs) {
+    List<Long> frameTimes = expectedTrackOutput.getSampleTimesUs();
+    return Util.binarySearchFloor(
+        frameTimes, targetSeekTimeUs, /* inclusive= */ true, /* stayInBounds= */ false);
+  }
+}

testutils/src/main/java/com/google/android/exoplayer2/testutil/TestUtil.java

@@ -377,14 +377,15 @@ public class TestUtil {
    * input until we can extract at least one sample following the seek position, or until
    * end-of-input is reached.
    *
-   * @param extractor The {@link Extractor} to extractor from input.
+   * @param extractor The {@link Extractor} to extract from input.
    * @param seekMap The {@link SeekMap} of the stream from the given input.
    * @param seekTimeUs The seek time, in micro-seconds.
    * @param trackOutput The {@link FakeTrackOutput} to store the extracted samples.
    * @param dataSource The {@link DataSource} that will be used to read from the input.
    * @param uri The Uri of the input.
    * @return The index of the first extracted sample written to the given {@code trackOutput} after
-   *     the seek is completed, or -1 if the seek is completed without any extracted sample.
+   *     the seek is completed, or {@link C#INDEX_UNSET} if the seek is completed without any
+   *     extracted sample.
    */
   public static int seekToTimeUs(
       Extractor extractor,
@@ -420,8 +421,9 @@ public class TestUtil {
         extractorInput =
             TestUtil.getExtractorInputFromPosition(dataSource, positionHolder.position, uri);
         extractorReadResult = Extractor.RESULT_CONTINUE;
-      } else if (extractorReadResult == Extractor.RESULT_END_OF_INPUT) {
+      } else if (extractorReadResult == Extractor.RESULT_END_OF_INPUT
-        return -1;
+          && trackOutput.getSampleCount() == numSampleBeforeSeek) {
+        return C.INDEX_UNSET;
       } else if (trackOutput.getSampleCount() > numSampleBeforeSeek) {
         // First index after seek = num sample before seek.
         return numSampleBeforeSeek;