AudioTrack enhancements.

- Workaround issue where video may freeze whilst audio continues
  on some devices that have entered bad states.
- Fix wrap-around for playbacks lasting more than 27 hours.

library/src/main/java/com/google/android/exoplayer/audio/AudioTrack.java

@@ -109,14 +109,14 @@ public final class AudioTrack {
    *
    *
    * <p>This is a fail safe that should not be required on correctly functioning devices.
    * <p>This is a fail safe that should not be required on correctly functioning devices.
    */
    */
-  private static final long MAX_AUDIO_TIMESTAMP_OFFSET_US = 10 * C.MICROS_PER_SECOND;
+  private static final long MAX_AUDIO_TIMESTAMP_OFFSET_US = 5 * C.MICROS_PER_SECOND;
 
 
   /**
   /**
    * AudioTrack latencies are deemed impossibly large if they are greater than this amount.
    * AudioTrack latencies are deemed impossibly large if they are greater than this amount.
    *
    *
    * <p>This is a fail safe that should not be required on correctly functioning devices.
    * <p>This is a fail safe that should not be required on correctly functioning devices.
    */
    */
-  private static final long MAX_LATENCY_US = 10 * C.MICROS_PER_SECOND;
+  private static final long MAX_LATENCY_US = 5 * C.MICROS_PER_SECOND;
 
 
   /** Value for ac3Bitrate before the bitrate has been calculated. */
   /** Value for ac3Bitrate before the bitrate has been calculated. */
   private static final int UNKNOWN_AC3_BITRATE = 0;
   private static final int UNKNOWN_AC3_BITRATE = 0;
@@ -130,10 +130,10 @@ public final class AudioTrack {
   private static final int MIN_TIMESTAMP_SAMPLE_INTERVAL_US = 500000;
   private static final int MIN_TIMESTAMP_SAMPLE_INTERVAL_US = 500000;
 
 
   private final ConditionVariable releasingConditionVariable;
   private final ConditionVariable releasingConditionVariable;
-  private final AudioTimestampCompat audioTimestampCompat;
   private final long[] playheadOffsets;
   private final long[] playheadOffsets;
 
 
   private android.media.AudioTrack audioTrack;
   private android.media.AudioTrack audioTrack;
+  private AudioTrackUtil audioTrackUtil;
   private int sampleRate;
   private int sampleRate;
   private int channelConfig;
   private int channelConfig;
   private int encoding;
   private int encoding;
@@ -147,8 +147,6 @@ public final class AudioTrack {
   private long lastPlayheadSampleTimeUs;
   private long lastPlayheadSampleTimeUs;
   private boolean audioTimestampSet;
   private boolean audioTimestampSet;
   private long lastTimestampSampleTimeUs;
   private long lastTimestampSampleTimeUs;
-  private long lastRawPlaybackHeadPosition;
-  private long rawPlaybackHeadWrapCount;
 
 
   private Method getLatencyMethod;
   private Method getLatencyMethod;
   private long submittedBytes;
   private long submittedBytes;
@@ -169,11 +167,6 @@ public final class AudioTrack {
 
 
   public AudioTrack() {
   public AudioTrack() {
     releasingConditionVariable = new ConditionVariable(true);
     releasingConditionVariable = new ConditionVariable(true);
-    if (Util.SDK_INT >= 19) {
-      audioTimestampCompat = new AudioTimestampCompatV19();
-    } else {
-      audioTimestampCompat = new NoopAudioTimestampCompat();
-    }
     if (Util.SDK_INT >= 18) {
     if (Util.SDK_INT >= 18) {
       try {
       try {
         getLatencyMethod =
         getLatencyMethod =
@@ -219,15 +212,15 @@ public final class AudioTrack {
     long currentPositionUs;
     long currentPositionUs;
     if (audioTimestampSet) {
     if (audioTimestampSet) {
       // How long ago in the past the audio timestamp is (negative if it's in the future).
       // How long ago in the past the audio timestamp is (negative if it's in the future).
-      long presentationDiff = systemClockUs - (audioTimestampCompat.getNanoTime() / 1000);
+      long presentationDiff = systemClockUs - (audioTrackUtil.getTimestampNanoTime() / 1000);
       long framesDiff = durationUsToFrames(presentationDiff);
       long framesDiff = durationUsToFrames(presentationDiff);
       // The position of the frame that's currently being presented.
       // The position of the frame that's currently being presented.
-      long currentFramePosition = audioTimestampCompat.getFramePosition() + framesDiff;
+      long currentFramePosition = audioTrackUtil.getTimestampFramePosition() + framesDiff;
       currentPositionUs = framesToDurationUs(currentFramePosition) + startMediaTimeUs;
       currentPositionUs = framesToDurationUs(currentFramePosition) + startMediaTimeUs;
     } else {
     } else {
       if (playheadOffsetCount == 0) {
       if (playheadOffsetCount == 0) {
         // The AudioTrack has started, but we don't have any samples to compute a smoothed position.
         // The AudioTrack has started, but we don't have any samples to compute a smoothed position.
-        currentPositionUs = getPlaybackPositionUs() + startMediaTimeUs;
+        currentPositionUs = audioTrackUtil.getPlaybackHeadPositionUs() + startMediaTimeUs;
       } else {
       } else {
         // getPlayheadPositionUs() only has a granularity of ~20ms, so we base the position off the
         // getPlayheadPositionUs() only has a granularity of ~20ms, so we base the position off the
         // system clock (and a smoothed offset between it and the playhead position) so as to
         // system clock (and a smoothed offset between it and the playhead position) so as to
@@ -274,7 +267,13 @@ public final class AudioTrack {
       audioTrack = new android.media.AudioTrack(AudioManager.STREAM_MUSIC, sampleRate,
       audioTrack = new android.media.AudioTrack(AudioManager.STREAM_MUSIC, sampleRate,
           channelConfig, encoding, bufferSize, android.media.AudioTrack.MODE_STREAM, sessionId);
           channelConfig, encoding, bufferSize, android.media.AudioTrack.MODE_STREAM, sessionId);
     }
     }
+
     checkAudioTrackInitialized();
     checkAudioTrackInitialized();
+    if (Util.SDK_INT >= 19) {
+      audioTrackUtil = new AudioTrackUtilV19(audioTrack);
+    } else {
+      audioTrackUtil = new AudioTrackUtil(audioTrack);
+    }
     setVolume(volume);
     setVolume(volume);
     return audioTrack.getAudioSessionId();
     return audioTrack.getAudioSessionId();
   }
   }
@@ -440,7 +439,8 @@ public final class AudioTrack {
     int bytesWritten = 0;
     int bytesWritten = 0;
     if (Util.SDK_INT < 21) {
     if (Util.SDK_INT < 21) {
       // Work out how many bytes we can write without the risk of blocking.
       // Work out how many bytes we can write without the risk of blocking.
-      int bytesPending = (int) (submittedBytes - (getPlaybackPositionFrames() * frameSize));
+      int bytesPending =
+          (int) (submittedBytes - (audioTrackUtil.getPlaybackHeadPosition() * frameSize));
       int bytesToWrite = bufferSize - bytesPending;
       int bytesToWrite = bufferSize - bytesPending;
       if (bytesToWrite > 0) {
       if (bytesToWrite > 0) {
         bytesToWrite = Math.min(temporaryBufferSize, bytesToWrite);
         bytesToWrite = Math.min(temporaryBufferSize, bytesToWrite);
@@ -473,7 +473,8 @@ public final class AudioTrack {
 
 
   /** Returns whether the audio track has more data pending that will be played back. */
   /** Returns whether the audio track has more data pending that will be played back. */
   public boolean hasPendingData() {
   public boolean hasPendingData() {
-    return isInitialized() && bytesToFrames(submittedBytes) > getPlaybackPositionFrames();
+    return isInitialized()
+        && bytesToFrames(submittedBytes) > audioTrackUtil.getPlaybackHeadPosition();
   }
   }
 
 
   /** Returns whether enough data has been supplied via {@link #handleBuffer} to begin playback. */
   /** Returns whether enough data has been supplied via {@link #handleBuffer} to begin playback. */
@@ -520,8 +521,6 @@ public final class AudioTrack {
     if (isInitialized()) {
     if (isInitialized()) {
       submittedBytes = 0;
       submittedBytes = 0;
       temporaryBufferSize = 0;
       temporaryBufferSize = 0;
-      lastRawPlaybackHeadPosition = 0;
-      rawPlaybackHeadWrapCount = 0;
       startMediaTimeUs = START_NOT_SET;
       startMediaTimeUs = START_NOT_SET;
       resetSyncParams();
       resetSyncParams();
       int playState = audioTrack.getPlayState();
       int playState = audioTrack.getPlayState();
@@ -531,6 +530,7 @@ public final class AudioTrack {
       // AudioTrack.release can take some time, so we call it on a background thread.
       // AudioTrack.release can take some time, so we call it on a background thread.
       final android.media.AudioTrack toRelease = audioTrack;
       final android.media.AudioTrack toRelease = audioTrack;
       audioTrack = null;
       audioTrack = null;
+      audioTrackUtil = null;
       releasingConditionVariable.close();
       releasingConditionVariable.close();
       new Thread() {
       new Thread() {
         @Override
         @Override
@@ -552,7 +552,7 @@ public final class AudioTrack {
 
 
   /** Updates the audio track latency and playback position parameters. */
   /** Updates the audio track latency and playback position parameters. */
   private void maybeSampleSyncParams() {
   private void maybeSampleSyncParams() {
-    long playbackPositionUs = getPlaybackPositionUs();
+    long playbackPositionUs = audioTrackUtil.getPlaybackHeadPositionUs();
     if (playbackPositionUs == 0) {
     if (playbackPositionUs == 0) {
       // The AudioTrack hasn't output anything yet.
       // The AudioTrack hasn't output anything yet.
       return;
       return;
@@ -573,18 +573,27 @@ public final class AudioTrack {
     }
     }
 
 
     if (systemClockUs - lastTimestampSampleTimeUs >= MIN_TIMESTAMP_SAMPLE_INTERVAL_US) {
     if (systemClockUs - lastTimestampSampleTimeUs >= MIN_TIMESTAMP_SAMPLE_INTERVAL_US) {
-      audioTimestampSet = audioTimestampCompat.update(audioTrack);
+      audioTimestampSet = audioTrackUtil.updateTimestamp();
       if (audioTimestampSet) {
       if (audioTimestampSet) {
         // Perform sanity checks on the timestamp.
         // Perform sanity checks on the timestamp.
-        long audioTimestampUs = audioTimestampCompat.getNanoTime() / 1000;
+        long audioTimestampUs = audioTrackUtil.getTimestampNanoTime() / 1000;
+        long audioTimestampFramePosition = audioTrackUtil.getTimestampFramePosition();
         if (audioTimestampUs < resumeSystemTimeUs) {
         if (audioTimestampUs < resumeSystemTimeUs) {
           // The timestamp corresponds to a time before the track was most recently resumed.
           // The timestamp corresponds to a time before the track was most recently resumed.
           audioTimestampSet = false;
           audioTimestampSet = false;
         } else if (Math.abs(audioTimestampUs - systemClockUs) > MAX_AUDIO_TIMESTAMP_OFFSET_US) {
         } else if (Math.abs(audioTimestampUs - systemClockUs) > MAX_AUDIO_TIMESTAMP_OFFSET_US) {
           // The timestamp time base is probably wrong.
           // The timestamp time base is probably wrong.
           audioTimestampSet = false;
           audioTimestampSet = false;
-          Log.w(TAG, "Spurious audio timestamp: " + audioTimestampCompat.getFramePosition() + ", "
-              + audioTimestampUs + ", " + systemClockUs);
+          Log.w(TAG, "Spurious audio timestamp (system clock mismatch): "
+              + audioTimestampFramePosition + ", " + audioTimestampUs + ", " + systemClockUs + ", "
+              + playbackPositionUs);
+        } else if (Math.abs(framesToDurationUs(audioTimestampFramePosition) - playbackPositionUs)
+            > MAX_AUDIO_TIMESTAMP_OFFSET_US) {
+          // The timestamp frame position is probably wrong.
+          audioTimestampSet = false;
+          Log.w(TAG, "Spurious audio timestamp (frame position mismatch): "
+              + audioTimestampFramePosition + ", " + audioTimestampUs + ", " + systemClockUs + ", "
+              + playbackPositionUs);
         }
         }
       }
       }
       if (getLatencyMethod != null) {
       if (getLatencyMethod != null) {
@@ -634,29 +643,6 @@ public final class AudioTrack {
     throw new InitializationException(state, sampleRate, channelConfig, bufferSize);
     throw new InitializationException(state, sampleRate, channelConfig, bufferSize);
   }
   }
 
 
-  /**
-   * {@link android.media.AudioTrack#getPlaybackHeadPosition()} returns a value intended to be
-   * interpreted as an unsigned 32 bit integer, which also wraps around periodically. This method
-   * returns the playback head position as a long that will only wrap around if the value exceeds
-   * {@link Long#MAX_VALUE} (which in practice will never happen).
-   *
-   * @return {@link android.media.AudioTrack#getPlaybackHeadPosition()} of {@link #audioTrack}
-   *     expressed as a long.
-   */
-  private long getPlaybackPositionFrames() {
-    long rawPlaybackHeadPosition = 0xFFFFFFFFL & audioTrack.getPlaybackHeadPosition();
-    if (lastRawPlaybackHeadPosition > rawPlaybackHeadPosition) {
-      // The value must have wrapped around.
-      rawPlaybackHeadWrapCount++;
-    }
-    lastRawPlaybackHeadPosition = rawPlaybackHeadPosition;
-    return rawPlaybackHeadPosition + (rawPlaybackHeadWrapCount << 32);
-  }
-
-  private long getPlaybackPositionUs() {
-    return framesToDurationUs(getPlaybackPositionFrames());
-  }
-
   private long bytesToFrames(long byteCount) {
   private long bytesToFrames(long byteCount) {
     if (isAc3) {
     if (isAc3) {
       return
       return
@@ -684,72 +670,126 @@ public final class AudioTrack {
   }
   }
 
 
   /**
   /**
-   * Interface exposing the {@link android.media.AudioTimestamp} methods we need that were added in
-   * SDK 19.
+   * Wraps an {@link android.media.AudioTrack} to expose useful utility methods.
    */
    */
-  private interface AudioTimestampCompat {
+  private static class AudioTrackUtil {
 
 
-    /**
-     * Returns true if the audioTimestamp was retrieved from the audioTrack.
-     */
-    boolean update(android.media.AudioTrack audioTrack);
+    protected final android.media.AudioTrack audioTrack;
+    private final int sampleRate;
 
 
-    long getNanoTime();
+    private long lastRawPlaybackHeadPosition;
+    private long rawPlaybackHeadWrapCount;
 
 
-    long getFramePosition();
+    public AudioTrackUtil(android.media.AudioTrack audioTrack) {
+      this.audioTrack = audioTrack;
+      this.sampleRate = audioTrack.getSampleRate();
+    }
 
 
+    /**
+     * {@link android.media.AudioTrack#getPlaybackHeadPosition()} returns a value intended to be
+     * interpreted as an unsigned 32 bit integer, which also wraps around periodically. This method
+     * returns the playback head position as a long that will only wrap around if the value exceeds
+     * {@link Long#MAX_VALUE} (which in practice will never happen).
+     *
+     * @return {@link android.media.AudioTrack#getPlaybackHeadPosition()} of {@link #audioTrack}
+     *     expressed as a long.
+     */
+    public long getPlaybackHeadPosition() {
+      long rawPlaybackHeadPosition = 0xFFFFFFFFL & audioTrack.getPlaybackHeadPosition();
+      if (lastRawPlaybackHeadPosition > rawPlaybackHeadPosition) {
+        // The value must have wrapped around.
+        rawPlaybackHeadWrapCount++;
+      }
+      lastRawPlaybackHeadPosition = rawPlaybackHeadPosition;
+      return rawPlaybackHeadPosition + (rawPlaybackHeadWrapCount << 32);
     }
     }
 
 
     /**
     /**
-   * The AudioTimestampCompat implementation for SDK < 19 that does nothing or throws an exception.
+     * Returns {@link #getPlaybackHeadPosition()} expressed as microseconds.
      */
      */
-  private static final class NoopAudioTimestampCompat implements AudioTimestampCompat {
+    public long getPlaybackHeadPositionUs() {
+      return (getPlaybackHeadPosition() * C.MICROS_PER_SECOND) / sampleRate;
+    }
 
 
-    @Override
-    public boolean update(android.media.AudioTrack audioTrack) {
+    /**
+     * Updates the values returned by {@link #getTimestampNanoTime()} and
+     * {@link #getTimestampFramePosition()}.
+     *
+     * @return True if the timestamp values were updated. False otherwise.
+     */
+    public boolean updateTimestamp() {
       return false;
       return false;
     }
     }
 
 
-    @Override
-    public long getNanoTime() {
-      // Should never be called if initTimestamp() returned false.
+    /**
+     * Returns the {@link android.media.AudioTimestamp#nanoTime} obtained during the most recent
+     * call to {@link #updateTimestamp()} that returned true.
+     *
+     * @return The nanoTime obtained during the most recent call to {@link #updateTimestamp()} that
+     *     returned true.
+     * @throws UnsupportedOperationException If the implementation does not support audio timestamp
+     *     queries. {@link #updateTimestamp()} will always return false in this case.
+     */
+    public long getTimestampNanoTime() {
+      // Should never be called if updateTimestamp() returned false.
       throw new UnsupportedOperationException();
       throw new UnsupportedOperationException();
     }
     }
 
 
-    @Override
-    public long getFramePosition() {
-      // Should never be called if initTimestamp() returned false.
+    /**
+     * Returns the {@link android.media.AudioTimestamp#framePosition} obtained during the most
+     * recent call to {@link #updateTimestamp()} that returned true. The value is adjusted so that
+     * wrap around only occurs if the value exceeds {@link Long#MAX_VALUE} (which in practice will
+     * never happen).
+     *
+     * @return The framePosition obtained during the most recent call to {@link #updateTimestamp()}
+     *     that returned true.
+     * @throws UnsupportedOperationException If the implementation does not support audio timestamp
+     *     queries. {@link #updateTimestamp()} will always return false in this case.
+     */
+    public long getTimestampFramePosition() {
+      // Should never be called if updateTimestamp() returned false.
       throw new UnsupportedOperationException();
       throw new UnsupportedOperationException();
     }
     }
 
 
   }
   }
 
 
-  /**
-   * The AudioTimestampCompat implementation for SDK >= 19 that simply calls through to the actual
-   * implementations added in SDK 19.
-   */
   @TargetApi(19)
   @TargetApi(19)
-  private static final class AudioTimestampCompatV19 implements AudioTimestampCompat {
+  private static class AudioTrackUtilV19 extends AudioTrackUtil {
 
 
     private final AudioTimestamp audioTimestamp;
     private final AudioTimestamp audioTimestamp;
 
 
-    public AudioTimestampCompatV19() {
+    private long rawTimestampFramePositionWrapCount;
+    private long lastRawTimestampFramePosition;
+    private long lastTimestampFramePosition;
+
+    public AudioTrackUtilV19(android.media.AudioTrack audioTrack) {
+      super(audioTrack);
       audioTimestamp = new AudioTimestamp();
       audioTimestamp = new AudioTimestamp();
     }
     }
 
 
     @Override
     @Override
-    public boolean update(android.media.AudioTrack audioTrack) {
-      return audioTrack.getTimestamp(audioTimestamp);
+    public boolean updateTimestamp() {
+      boolean updated = audioTrack.getTimestamp(audioTimestamp);
+      if (updated) {
+        long rawFramePosition = audioTimestamp.framePosition;
+        if (lastRawTimestampFramePosition > rawFramePosition) {
+          // The value must have wrapped around.
+          rawTimestampFramePositionWrapCount++;
+        }
+        lastRawTimestampFramePosition = rawFramePosition;
+        lastTimestampFramePosition = rawFramePosition + (rawTimestampFramePositionWrapCount << 32);
+      }
+      return updated;
     }
     }
 
 
     @Override
     @Override
-    public long getNanoTime() {
+    public long getTimestampNanoTime() {
       return audioTimestamp.nanoTime;
       return audioTimestamp.nanoTime;
     }
     }
 
 
     @Override
     @Override
-    public long getFramePosition() {
-      return audioTimestamp.framePosition;
+    public long getTimestampFramePosition() {
+      return lastTimestampFramePosition;
     }
     }
 
 
   }
   }