Clean up some preload timeout logic values in ImaAdsLoader

tonihei · icbaker · commit a5eb4832f4e5 · 2025-07-15T05:51:20.000-07:00
We used two different preload timeouts, one hardcoded to 4 seconds and one configurable (default 10 seconds) to detect slightly different versions of the same problem that IMA doesn't preload or fail an ad metadata load. This can be aligned to use the same (configurable) timeout. Secondly, this timeout should not be less than the timeout we configured on the IMA SDK itself to load the VAST data. Otherwise IMA has no chance of timing out internally first to potentially provide a better experience (e.g. loading part of the ads instead of marking the entire ad group as failed). PiperOrigin-RevId: 783298825 (cherry picked from commit f894cd5)
diff --git a/libraries/exoplayer_ima/src/main/java/androidx/media3/exoplayer/ima/AdTagLoader.java b/libraries/exoplayer_ima/src/main/java/androidx/media3/exoplayer/ima/AdTagLoader.java
@@ -104,12 +104,6 @@
    */
   private static final long THRESHOLD_END_OF_CONTENT_MS = 5000;
 
-  /**
-   * Threshold before the start of an ad at which IMA is expected to be able to preload the ad, in
-   * milliseconds.
-   */
-  private static final long THRESHOLD_AD_PRELOAD_MS = 4000;
-
   /** The threshold below which ad cue points are treated as matching, in microseconds. */
   private static final long THRESHOLD_AD_MATCH_US = 1000;
 
@@ -144,7 +138,6 @@
   private final Handler handler;
   private final ComponentListener componentListener;
   private final ContentPlaybackAdapter contentPlaybackAdapter;
-  private final VideoAdPlayerImpl videoAdPlayerImpl;
   private final List<EventListener> eventListeners;
   private final List<VideoAdPlayer.VideoAdPlayerCallback> adCallbacks;
   private final Runnable updateAdProgressRunnable;
@@ -265,7 +258,6 @@ public AdTagLoader(
     handler = Util.createHandler(getImaLooper(), /* callback= */ null);
     componentListener = new ComponentListener();
     contentPlaybackAdapter = new ContentPlaybackAdapter();
-    videoAdPlayerImpl = new VideoAdPlayerImpl();
     eventListeners = new ArrayList<>();
     adCallbacks = new ArrayList<>(/* initialCapacity= */ 1);
     if (configuration.applicationVideoAdPlayerCallback != null) {
@@ -283,6 +275,7 @@ public AdTagLoader(
     timeline = Timeline.EMPTY;
     adPlaybackState = AdPlaybackState.NONE;
     adLoadTimeoutRunnable = this::handleAdLoadTimeout;
+    VideoAdPlayerImpl videoAdPlayerImpl = new VideoAdPlayerImpl();
     if (adViewGroup != null) {
       adDisplayContainer =
           imaFactory.createAdDisplayContainer(adViewGroup, /* player= */ videoAdPlayerImpl);
@@ -1375,7 +1368,7 @@ public VideoProgressUpdate getContentProgress() {
         // may be stuck. Detect this case and signal an error if applicable.
         long stuckElapsedRealtimeMs =
             SystemClock.elapsedRealtime() - waitingForPreloadElapsedRealtimeMs;
-        if (stuckElapsedRealtimeMs >= THRESHOLD_AD_PRELOAD_MS) {
+        if (stuckElapsedRealtimeMs >= configuration.adPreloadTimeoutMs) {
           waitingForPreloadElapsedRealtimeMs = C.TIME_UNSET;
           handleAdGroupLoadError(new IOException("Ad preloading timed out"));
           maybeNotifyPendingAdLoadError();
diff --git a/libraries/exoplayer_ima/src/main/java/androidx/media3/exoplayer/ima/ImaAdsLoader.java b/libraries/exoplayer_ima/src/main/java/androidx/media3/exoplayer/ima/ImaAdsLoader.java
@@ -280,6 +280,9 @@ public Builder setEnableContinuousPlayback(boolean enableContinuousPlayback) {
      * <p>The purpose of this timeout is to avoid playback getting stuck in the unexpected case that
      * the IMA SDK does not load an ad break based on the player's reported content position.
      *
+     * <p>The value will be adjusted to be greater or equal to the one in {@link
+     * #setVastLoadTimeoutMs(int)} if provided.
+     *
      * @param adPreloadTimeoutMs The timeout buffering duration in milliseconds, or {@link
      *     C#TIME_UNSET} for no timeout.
      * @return This builder, for convenience.
@@ -396,6 +399,9 @@ public Builder setDebugModeEnabled(boolean debugModeEnabled) {
 
     /** Returns a new {@link ImaAdsLoader}. */
     public ImaAdsLoader build() {
+      if (vastLoadTimeoutMs != TIMEOUT_UNSET && adPreloadTimeoutMs < vastLoadTimeoutMs) {
+        adPreloadTimeoutMs = vastLoadTimeoutMs;
+      }
       return new ImaAdsLoader(
           context,
           new ImaUtil.Configuration(
diff --git a/libraries/exoplayer_ima/src/test/java/androidx/media3/exoplayer/ima/ImaAdsLoaderTest.java b/libraries/exoplayer_ima/src/test/java/androidx/media3/exoplayer/ima/ImaAdsLoaderTest.java
@@ -503,7 +503,7 @@ public void playback_withAdNotPreloadingAfterTimeout_hasErrorAdGroup() {
         /* periodIndex= */ 0, Util.usToMs(adGroupPositionInWindowUs));
     fakePlayer.setState(Player.STATE_BUFFERING, /* playWhenReady= */ true);
     // Advance past the timeout and simulate polling content progress.
-    ShadowSystemClock.advanceBy(Duration.ofSeconds(5));
+    ShadowSystemClock.advanceBy(Duration.ofSeconds(11));
     contentProgressProvider.getContentProgress();
 
     assertThat(getAdPlaybackState(/* periodIndex= */ 0))
@@ -515,6 +515,114 @@ public void playback_withAdNotPreloadingAfterTimeout_hasErrorAdGroup() {
                 .withAdLoadError(/* adGroupIndex= */ 0, /* adIndexInAdGroup= */ 0));
   }
 
+  @Test
+  public void playback_withCustomAdPreloadTimeout_triggersErrorAfterTimeout() {
+    imaAdsLoader =
+        new ImaAdsLoader.Builder(getApplicationContext())
+            .setImaFactory(mockImaFactory)
+            .setImaSdkSettings(mockImaSdkSettings)
+            .setAdPreloadTimeoutMs(3_000)
+            .build();
+    imaAdsLoader.setPlayer(fakePlayer);
+    adsMediaSource =
+        new AdsMediaSource(
+            new FakeMediaSource(CONTENT_TIMELINE),
+            TEST_DATA_SPEC,
+            TEST_ADS_ID,
+            new DefaultMediaSourceFactory((Context) getApplicationContext()),
+            imaAdsLoader,
+            adViewProvider,
+            /* useLazyContentSourcePreparation= */ true);
+
+    // Simulate an ad at 2 seconds.
+    long adGroupPositionInWindowUs = 2 * C.MICROS_PER_SECOND;
+    long adGroupTimeUs =
+        adGroupPositionInWindowUs
+            + TimelineWindowDefinition.DEFAULT_WINDOW_OFFSET_IN_FIRST_PERIOD_US;
+    ImmutableList<Float> cuePoints = ImmutableList.of((float) adGroupTimeUs / C.MICROS_PER_SECOND);
+    when(mockAdsManager.getAdCuePoints()).thenReturn(cuePoints);
+
+    // Advance playback to just before the midroll and simulate buffering.
+    imaAdsLoader.start(
+        adsMediaSource, TEST_DATA_SPEC, TEST_ADS_ID, adViewProvider, adsLoaderListener);
+    fakePlayer.setPlayingContentPosition(
+        /* periodIndex= */ 0, Util.usToMs(adGroupPositionInWindowUs));
+    fakePlayer.setState(Player.STATE_BUFFERING, /* playWhenReady= */ true);
+
+    // Advance past the custom timeout.
+    ShadowSystemClock.advanceBy(Duration.ofSeconds(4));
+    contentProgressProvider.getContentProgress();
+
+    // Verify that the ad group is in an error state.
+    assertThat(getAdPlaybackState(/* periodIndex= */ 0))
+        .isEqualTo(
+            new AdPlaybackState(TEST_ADS_ID, getAdGroupTimesUsForCuePoints(cuePoints))
+                .withContentDurationUs(CONTENT_PERIOD_DURATION_US)
+                .withAdDurationsUs(new long[][] {{TEST_AD_DURATION_US}})
+                .withAdCount(/* adGroupIndex= */ 0, /* adCount= */ 1)
+                .withAdLoadError(/* adGroupIndex= */ 0, /* adIndexInAdGroup= */ 0));
+  }
+
+  @Test
+  public void
+      playback_withAdPreloadTimeoutLessThanVastLoadTimeout_adPreloadTimeoutIncreasedToVastLoadTimeout() {
+    imaAdsLoader =
+        new ImaAdsLoader.Builder(getApplicationContext())
+            .setImaFactory(mockImaFactory)
+            .setImaSdkSettings(mockImaSdkSettings)
+            .setVastLoadTimeoutMs(5_000)
+            .setAdPreloadTimeoutMs(3_000)
+            .build();
+    imaAdsLoader.setPlayer(fakePlayer);
+    adsMediaSource =
+        new AdsMediaSource(
+            new FakeMediaSource(CONTENT_TIMELINE),
+            TEST_DATA_SPEC,
+            TEST_ADS_ID,
+            new DefaultMediaSourceFactory((Context) getApplicationContext()),
+            imaAdsLoader,
+            adViewProvider,
+            /* useLazyContentSourcePreparation= */ true);
+
+    // Simulate an ad at 2 seconds.
+    long adGroupPositionInWindowUs = 2 * C.MICROS_PER_SECOND;
+    long adGroupTimeUs =
+        adGroupPositionInWindowUs
+            + TimelineWindowDefinition.DEFAULT_WINDOW_OFFSET_IN_FIRST_PERIOD_US;
+    ImmutableList<Float> cuePoints = ImmutableList.of((float) adGroupTimeUs / C.MICROS_PER_SECOND);
+    when(mockAdsManager.getAdCuePoints()).thenReturn(cuePoints);
+
+    // Advance playback to just before the midroll and simulate buffering.
+    imaAdsLoader.start(
+        adsMediaSource, TEST_DATA_SPEC, TEST_ADS_ID, adViewProvider, adsLoaderListener);
+    fakePlayer.setPlayingContentPosition(
+        /* periodIndex= */ 0, Util.usToMs(adGroupPositionInWindowUs));
+    fakePlayer.setState(Player.STATE_BUFFERING, /* playWhenReady= */ true);
+
+    // Advance past the original adPreloadTimeout (3s) but not the vastLoadTimeout (5s).
+    ShadowSystemClock.advanceBy(Duration.ofSeconds(4));
+    contentProgressProvider.getContentProgress();
+
+    // Verify that the ad has not errored out, as the timeout should be 5s.
+    assertThat(getAdPlaybackState(/* periodIndex= */ 0))
+        .isEqualTo(
+            new AdPlaybackState(TEST_ADS_ID, getAdGroupTimesUsForCuePoints(cuePoints))
+                .withContentDurationUs(CONTENT_PERIOD_DURATION_US));
+
+    // Advance past the vastLoadTimeout.
+    ShadowSystemClock.advanceBy(Duration.ofSeconds(2)); // Total advance is 6s.
+    contentProgressProvider.getContentProgress();
+
+    // Verify that the ad group is now in an error state.
+    assertThat(getAdPlaybackState(/* periodIndex= */ 0))
+        .isEqualTo(
+            new AdPlaybackState(TEST_ADS_ID, getAdGroupTimesUsForCuePoints(cuePoints))
+                .withContentDurationUs(CONTENT_PERIOD_DURATION_US)
+                .withAdDurationsUs(new long[][] {{TEST_AD_DURATION_US}})
+                .withAdCount(/* adGroupIndex= */ 0, /* adCount= */ 1)
+                .withAdLoadError(/* adGroupIndex= */ 0, /* adIndexInAdGroup= */ 0));
+  }
+
   @Test
   public void startPlaybackAfterMidroll_doesNotSkipMidroll() {
     // Simulate an ad at 2 seconds, and starting playback with an initial seek position at the ad.
@@ -561,7 +669,7 @@ public void startPlaybackAfterMidroll_withAdNotPreloadingAfterTimeout_hasErrorAd
     imaAdsLoader.start(
         adsMediaSource, TEST_DATA_SPEC, TEST_ADS_ID, adViewProvider, adsLoaderListener);
     contentProgressProvider.getContentProgress();
-    ShadowSystemClock.advanceBy(Duration.ofSeconds(5));
+    ShadowSystemClock.advanceBy(Duration.ofSeconds(11));
     contentProgressProvider.getContentProgress();
 
     assertThat(getAdPlaybackState(/* periodIndex= */ 0))
