diff options
Diffstat (limited to 'android/media/MediaPlayer2.java')
| -rw-r--r-- | android/media/MediaPlayer2.java | 2476 |
1 files changed, 2476 insertions, 0 deletions
diff --git a/android/media/MediaPlayer2.java b/android/media/MediaPlayer2.java new file mode 100644 index 00000000..d36df845 --- /dev/null +++ b/android/media/MediaPlayer2.java @@ -0,0 +1,2476 @@ +/* + * Copyright 2017 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 android.media; + +import android.annotation.CallbackExecutor; +import android.annotation.IntDef; +import android.annotation.NonNull; +import android.annotation.Nullable; +import android.content.Context; +import android.graphics.SurfaceTexture; +import android.net.Uri; +import android.os.Handler; +import android.os.Parcel; +import android.os.PersistableBundle; +import android.view.Surface; +import android.view.SurfaceHolder; +import android.media.MediaDrm; +import android.media.MediaFormat; +import android.media.MediaPlayer2Impl; +import android.media.MediaTimeProvider; +import android.media.PlaybackParams; +import android.media.SubtitleController; +import android.media.SubtitleController.Anchor; +import android.media.SubtitleData; +import android.media.SubtitleTrack.RenderingWidget; +import android.media.SyncParams; + +import java.io.FileDescriptor; +import java.io.IOException; +import java.io.InputStream; +import java.lang.AutoCloseable; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.net.InetSocketAddress; +import java.util.concurrent.Executor; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.UUID; + + +/** + * MediaPlayer2 class can be used to control playback + * of audio/video files and streams. An example on how to use the methods in + * this class can be found in {@link android.widget.VideoView}. + * + * <p>Topics covered here are: + * <ol> + * <li><a href="#StateDiagram">State Diagram</a> + * <li><a href="#Valid_and_Invalid_States">Valid and Invalid States</a> + * <li><a href="#Permissions">Permissions</a> + * <li><a href="#Callbacks">Register informational and error callbacks</a> + * </ol> + * + * <div class="special reference"> + * <h3>Developer Guides</h3> + * <p>For more information about how to use MediaPlayer2, read the + * <a href="{@docRoot}guide/topics/media/mediaplayer.html">Media Playback</a> developer guide.</p> + * </div> + * + * <a name="StateDiagram"></a> + * <h3>State Diagram</h3> + * + * <p>Playback control of audio/video files and streams is managed as a state + * machine. The following diagram shows the life cycle and the states of a + * MediaPlayer2 object driven by the supported playback control operations. + * The ovals represent the states a MediaPlayer2 object may reside + * in. The arcs represent the playback control operations that drive the object + * state transition. There are two types of arcs. The arcs with a single arrow + * head represent synchronous method calls, while those with + * a double arrow head represent asynchronous method calls.</p> + * + * <p><img src="../../../images/mediaplayer_state_diagram.gif" + * alt="MediaPlayer State diagram" + * border="0" /></p> + * + * <p>From this state diagram, one can see that a MediaPlayer2 object has the + * following states:</p> + * <ul> + * <li>When a MediaPlayer2 object is just created using <code>new</code> or + * after {@link #reset()} is called, it is in the <em>Idle</em> state; and after + * {@link #close()} is called, it is in the <em>End</em> state. Between these + * two states is the life cycle of the MediaPlayer2 object. + * <ul> + * <li>There is a subtle but important difference between a newly constructed + * MediaPlayer2 object and the MediaPlayer2 object after {@link #reset()} + * is called. It is a programming error to invoke methods such + * as {@link #getCurrentPosition()}, + * {@link #getDuration()}, {@link #getVideoHeight()}, + * {@link #getVideoWidth()}, {@link #setAudioAttributes(AudioAttributes)}, + * {@link #setVolume(float, float)}, {@link #pause()}, {@link #play()}, + * {@link #seekTo(long, int)} or + * {@link #prepareAsync()} in the <em>Idle</em> state for both cases. If any of these + * methods is called right after a MediaPlayer2 object is constructed, + * the user supplied callback method OnErrorListener.onError() won't be + * called by the internal player engine and the object state remains + * unchanged; but if these methods are called right after {@link #reset()}, + * the user supplied callback method OnErrorListener.onError() will be + * invoked by the internal player engine and the object will be + * transfered to the <em>Error</em> state. </li> + * <li>It is also recommended that once + * a MediaPlayer2 object is no longer being used, call {@link #close()} immediately + * so that resources used by the internal player engine associated with the + * MediaPlayer2 object can be released immediately. Resource may include + * singleton resources such as hardware acceleration components and + * failure to call {@link #close()} may cause subsequent instances of + * MediaPlayer2 objects to fallback to software implementations or fail + * altogether. Once the MediaPlayer2 + * object is in the <em>End</em> state, it can no longer be used and + * there is no way to bring it back to any other state. </li> + * <li>Furthermore, + * the MediaPlayer2 objects created using <code>new</code> is in the + * <em>Idle</em> state. + * </li> + * </ul> + * </li> + * <li>In general, some playback control operation may fail due to various + * reasons, such as unsupported audio/video format, poorly interleaved + * audio/video, resolution too high, streaming timeout, and the like. + * Thus, error reporting and recovery is an important concern under + * these circumstances. Sometimes, due to programming errors, invoking a playback + * control operation in an invalid state may also occur. Under all these + * error conditions, the internal player engine invokes a user supplied + * EventCallback.onError() method if an EventCallback has been + * registered beforehand via + * {@link #registerEventCallback(Executor, EventCallback)}. + * <ul> + * <li>It is important to note that once an error occurs, the + * MediaPlayer2 object enters the <em>Error</em> state (except as noted + * above), even if an error listener has not been registered by the application.</li> + * <li>In order to reuse a MediaPlayer2 object that is in the <em> + * Error</em> state and recover from the error, + * {@link #reset()} can be called to restore the object to its <em>Idle</em> + * state.</li> + * <li>It is good programming practice to have your application + * register a OnErrorListener to look out for error notifications from + * the internal player engine.</li> + * <li>IllegalStateException is + * thrown to prevent programming errors such as calling + * {@link #prepareAsync()}, {@link #setDataSource(DataSourceDesc)}, or + * {@code setPlaylist} methods in an invalid state. </li> + * </ul> + * </li> + * <li>Calling + * {@link #setDataSource(DataSourceDesc)}, or + * {@code setPlaylist} transfers a + * MediaPlayer2 object in the <em>Idle</em> state to the + * <em>Initialized</em> state. + * <ul> + * <li>An IllegalStateException is thrown if + * setDataSource() or setPlaylist() is called in any other state.</li> + * <li>It is good programming + * practice to always look out for <code>IllegalArgumentException</code> + * and <code>IOException</code> that may be thrown from + * <code>setDataSource</code> and <code>setPlaylist</code> methods.</li> + * </ul> + * </li> + * <li>A MediaPlayer2 object must first enter the <em>Prepared</em> state + * before playback can be started. + * <ul> + * <li>There are an asynchronous way that the <em>Prepared</em> state can be reached: + * a call to {@link #prepareAsync()} (asynchronous) which + * first transfers the object to the <em>Preparing</em> state after the + * call returns (which occurs almost right way) while the internal + * player engine continues working on the rest of preparation work + * until the preparation work completes. When the preparation completes, + * the internal player engine then calls a user supplied callback method, + * onInfo() of the EventCallback interface with {@link #MEDIA_INFO_PREPARED}, if an + * EventCallback is registered beforehand via + * {@link #registerEventCallback(Executor, EventCallback)}.</li> + * <li>It is important to note that + * the <em>Preparing</em> state is a transient state, and the behavior + * of calling any method with side effect while a MediaPlayer2 object is + * in the <em>Preparing</em> state is undefined.</li> + * <li>An IllegalStateException is + * thrown if {@link #prepareAsync()} is called in + * any other state.</li> + * <li>While in the <em>Prepared</em> state, properties + * such as audio/sound volume, screenOnWhilePlaying, looping can be + * adjusted by invoking the corresponding set methods.</li> + * </ul> + * </li> + * <li>To start the playback, {@link #play()} must be called. After + * {@link #play()} returns successfully, the MediaPlayer2 object is in the + * <em>Started</em> state. {@link #isPlaying()} can be called to test + * whether the MediaPlayer2 object is in the <em>Started</em> state. + * <ul> + * <li>While in the <em>Started</em> state, the internal player engine calls + * a user supplied EventCallback.onBufferingUpdate() callback + * method if an EventCallback has been registered beforehand + * via {@link #registerEventCallback(Executor, EventCallback)}. + * This callback allows applications to keep track of the buffering status + * while streaming audio/video.</li> + * <li>Calling {@link #play()} has not effect + * on a MediaPlayer2 object that is already in the <em>Started</em> state.</li> + * </ul> + * </li> + * <li>Playback can be paused and stopped, and the current playback position + * can be adjusted. Playback can be paused via {@link #pause()}. When the call to + * {@link #pause()} returns, the MediaPlayer2 object enters the + * <em>Paused</em> state. Note that the transition from the <em>Started</em> + * state to the <em>Paused</em> state and vice versa happens + * asynchronously in the player engine. It may take some time before + * the state is updated in calls to {@link #isPlaying()}, and it can be + * a number of seconds in the case of streamed content. + * <ul> + * <li>Calling {@link #play()} to resume playback for a paused + * MediaPlayer2 object, and the resumed playback + * position is the same as where it was paused. When the call to + * {@link #play()} returns, the paused MediaPlayer2 object goes back to + * the <em>Started</em> state.</li> + * <li>Calling {@link #pause()} has no effect on + * a MediaPlayer2 object that is already in the <em>Paused</em> state.</li> + * </ul> + * </li> + * <li>The playback position can be adjusted with a call to + * {@link #seekTo(long, int)}. + * <ul> + * <li>Although the asynchronuous {@link #seekTo(long, int)} + * call returns right away, the actual seek operation may take a while to + * finish, especially for audio/video being streamed. When the actual + * seek operation completes, the internal player engine calls a user + * supplied EventCallback.onInfo() with {@link #MEDIA_INFO_COMPLETE_CALL_SEEK} + * if an EventCallback has been registered beforehand via + * {@link #registerEventCallback(Executor, EventCallback)}.</li> + * <li>Please + * note that {@link #seekTo(long, int)} can also be called in the other states, + * such as <em>Prepared</em>, <em>Paused</em> and <em>PlaybackCompleted + * </em> state. When {@link #seekTo(long, int)} is called in those states, + * one video frame will be displayed if the stream has video and the requested + * position is valid. + * </li> + * <li>Furthermore, the actual current playback position + * can be retrieved with a call to {@link #getCurrentPosition()}, which + * is helpful for applications such as a Music player that need to keep + * track of the playback progress.</li> + * </ul> + * </li> + * <li>When the playback reaches the end of stream, the playback completes. + * <ul> + * <li>If the looping mode was being set to one of the values of + * {@link #LOOPING_MODE_FULL}, {@link #LOOPING_MODE_SINGLE} or + * {@link #LOOPING_MODE_SHUFFLE} with + * {@link #setLoopingMode(int)}, the MediaPlayer2 object shall remain in + * the <em>Started</em> state.</li> + * <li>If the looping mode was set to <var>false + * </var>, the player engine calls a user supplied callback method, + * EventCallback.onCompletion(), if an EventCallback is registered + * beforehand via {@link #registerEventCallback(Executor, EventCallback)}. + * The invoke of the callback signals that the object is now in the <em> + * PlaybackCompleted</em> state.</li> + * <li>While in the <em>PlaybackCompleted</em> + * state, calling {@link #play()} can restart the playback from the + * beginning of the audio/video source.</li> + * </ul> + * + * + * <a name="Valid_and_Invalid_States"></a> + * <h3>Valid and invalid states</h3> + * + * <table border="0" cellspacing="0" cellpadding="0"> + * <tr><td>Method Name </p></td> + * <td>Valid Sates </p></td> + * <td>Invalid States </p></td> + * <td>Comments </p></td></tr> + * <tr><td>attachAuxEffect </p></td> + * <td>{Initialized, Prepared, Started, Paused, Stopped, PlaybackCompleted} </p></td> + * <td>{Idle, Error} </p></td> + * <td>This method must be called after setDataSource or setPlaylist. + * Calling it does not change the object state. </p></td></tr> + * <tr><td>getAudioSessionId </p></td> + * <td>any </p></td> + * <td>{} </p></td> + * <td>This method can be called in any state and calling it does not change + * the object state. </p></td></tr> + * <tr><td>getCurrentPosition </p></td> + * <td>{Idle, Initialized, Prepared, Started, Paused, Stopped, + * PlaybackCompleted} </p></td> + * <td>{Error}</p></td> + * <td>Successful invoke of this method in a valid state does not change the + * state. Calling this method in an invalid state transfers the object + * to the <em>Error</em> state. </p></td></tr> + * <tr><td>getDuration </p></td> + * <td>{Prepared, Started, Paused, Stopped, PlaybackCompleted} </p></td> + * <td>{Idle, Initialized, Error} </p></td> + * <td>Successful invoke of this method in a valid state does not change the + * state. Calling this method in an invalid state transfers the object + * to the <em>Error</em> state. </p></td></tr> + * <tr><td>getVideoHeight </p></td> + * <td>{Idle, Initialized, Prepared, Started, Paused, Stopped, + * PlaybackCompleted}</p></td> + * <td>{Error}</p></td> + * <td>Successful invoke of this method in a valid state does not change the + * state. Calling this method in an invalid state transfers the object + * to the <em>Error</em> state. </p></td></tr> + * <tr><td>getVideoWidth </p></td> + * <td>{Idle, Initialized, Prepared, Started, Paused, Stopped, + * PlaybackCompleted}</p></td> + * <td>{Error}</p></td> + * <td>Successful invoke of this method in a valid state does not change + * the state. Calling this method in an invalid state transfers the + * object to the <em>Error</em> state. </p></td></tr> + * <tr><td>isPlaying </p></td> + * <td>{Idle, Initialized, Prepared, Started, Paused, Stopped, + * PlaybackCompleted}</p></td> + * <td>{Error}</p></td> + * <td>Successful invoke of this method in a valid state does not change + * the state. Calling this method in an invalid state transfers the + * object to the <em>Error</em> state. </p></td></tr> + * <tr><td>pause </p></td> + * <td>{Started, Paused, PlaybackCompleted}</p></td> + * <td>{Idle, Initialized, Prepared, Stopped, Error}</p></td> + * <td>Successful invoke of this method in a valid state transfers the + * object to the <em>Paused</em> state. Calling this method in an + * invalid state transfers the object to the <em>Error</em> state.</p></td></tr> + * <tr><td>prepareAsync </p></td> + * <td>{Initialized, Stopped} </p></td> + * <td>{Idle, Prepared, Started, Paused, PlaybackCompleted, Error} </p></td> + * <td>Successful invoke of this method in a valid state transfers the + * object to the <em>Preparing</em> state. Calling this method in an + * invalid state throws an IllegalStateException.</p></td></tr> + * <tr><td>release </p></td> + * <td>any </p></td> + * <td>{} </p></td> + * <td>After {@link #close()}, the object is no longer available. </p></td></tr> + * <tr><td>reset </p></td> + * <td>{Idle, Initialized, Prepared, Started, Paused, Stopped, + * PlaybackCompleted, Error}</p></td> + * <td>{}</p></td> + * <td>After {@link #reset()}, the object is like being just created.</p></td></tr> + * <tr><td>seekTo </p></td> + * <td>{Prepared, Started, Paused, PlaybackCompleted} </p></td> + * <td>{Idle, Initialized, Stopped, Error}</p></td> + * <td>Successful invoke of this method in a valid state does not change + * the state. Calling this method in an invalid state transfers the + * object to the <em>Error</em> state. </p></td></tr> + * <tr><td>setAudioAttributes </p></td> + * <td>{Idle, Initialized, Stopped, Prepared, Started, Paused, + * PlaybackCompleted}</p></td> + * <td>{Error}</p></td> + * <td>Successful invoke of this method does not change the state. In order for the + * target audio attributes type to become effective, this method must be called before + * prepareAsync().</p></td></tr> + * <tr><td>setAudioSessionId </p></td> + * <td>{Idle} </p></td> + * <td>{Initialized, Prepared, Started, Paused, Stopped, PlaybackCompleted, + * Error} </p></td> + * <td>This method must be called in idle state as the audio session ID must be known before + * calling setDataSource or setPlaylist. Calling it does not change the object + * state. </p></td></tr> + * <tr><td>setAudioStreamType (deprecated)</p></td> + * <td>{Idle, Initialized, Stopped, Prepared, Started, Paused, + * PlaybackCompleted}</p></td> + * <td>{Error}</p></td> + * <td>Successful invoke of this method does not change the state. In order for the + * target audio stream type to become effective, this method must be called before + * prepareAsync().</p></td></tr> + * <tr><td>setAuxEffectSendLevel </p></td> + * <td>any</p></td> + * <td>{} </p></td> + * <td>Calling this method does not change the object state. </p></td></tr> + * <tr><td>setDataSource </p></td> + * <td>{Idle} </p></td> + * <td>{Initialized, Prepared, Started, Paused, Stopped, PlaybackCompleted, + * Error} </p></td> + * <td>Successful invoke of this method in a valid state transfers the + * object to the <em>Initialized</em> state. Calling this method in an + * invalid state throws an IllegalStateException.</p></td></tr> + * <tr><td>setPlaylist </p></td> + * <td>{Idle} </p></td> + * <td>{Initialized, Prepared, Started, Paused, Stopped, PlaybackCompleted, + * Error} </p></td> + * <td>Successful invoke of this method in a valid state transfers the + * object to the <em>Initialized</em> state. Calling this method in an + * invalid state throws an IllegalStateException.</p></td></tr> + * <tr><td>setDisplay </p></td> + * <td>any </p></td> + * <td>{} </p></td> + * <td>This method can be called in any state and calling it does not change + * the object state. </p></td></tr> + * <tr><td>setSurface </p></td> + * <td>any </p></td> + * <td>{} </p></td> + * <td>This method can be called in any state and calling it does not change + * the object state. </p></td></tr> + * <tr><td>setLoopingMode </p></td> + * <td>{Idle, Initialized, Stopped, Prepared, Started, Paused, + * PlaybackCompleted}</p></td> + * <td>{Error}</p></td> + * <td>Successful invoke of this method in a valid state does not change + * the state. Calling this method in an + * invalid state transfers the object to the <em>Error</em> state.</p></td></tr> + * <tr><td>isLooping </p></td> + * <td>any </p></td> + * <td>{} </p></td> + * <td>This method can be called in any state and calling it does not change + * the object state. </p></td></tr> + * <tr><td>registerDrmEventCallback </p></td> + * <td>any </p></td> + * <td>{} </p></td> + * <td>This method can be called in any state and calling it does not change + * the object state. </p></td></tr> + * <tr><td>registerEventCallback </p></td> + * <td>any </p></td> + * <td>{} </p></td> + * <td>This method can be called in any state and calling it does not change + * the object state. </p></td></tr> + * <tr><td>setPlaybackParams</p></td> + * <td>{Initialized, Prepared, Started, Paused, PlaybackCompleted, Error}</p></td> + * <td>{Idle, Stopped} </p></td> + * <td>This method will change state in some cases, depending on when it's called. + * </p></td></tr> + * <tr><td>setVolume </p></td> + * <td>{Idle, Initialized, Stopped, Prepared, Started, Paused, + * PlaybackCompleted}</p></td> + * <td>{Error}</p></td> + * <td>Successful invoke of this method does not change the state. + * <tr><td>play </p></td> + * <td>{Prepared, Started, Paused, PlaybackCompleted}</p></td> + * <td>{Idle, Initialized, Stopped, Error}</p></td> + * <td>Successful invoke of this method in a valid state transfers the + * object to the <em>Started</em> state. Calling this method in an + * invalid state transfers the object to the <em>Error</em> state.</p></td></tr> + * <tr><td>stop </p></td> + * <td>{Prepared, Started, Stopped, Paused, PlaybackCompleted}</p></td> + * <td>{Idle, Initialized, Error}</p></td> + * <td>Successful invoke of this method in a valid state transfers the + * object to the <em>Stopped</em> state. Calling this method in an + * invalid state transfers the object to the <em>Error</em> state.</p></td></tr> + * <tr><td>getTrackInfo </p></td> + * <td>{Prepared, Started, Stopped, Paused, PlaybackCompleted}</p></td> + * <td>{Idle, Initialized, Error}</p></td> + * <td>Successful invoke of this method does not change the state.</p></td></tr> + * <tr><td>selectTrack </p></td> + * <td>{Prepared, Started, Stopped, Paused, PlaybackCompleted}</p></td> + * <td>{Idle, Initialized, Error}</p></td> + * <td>Successful invoke of this method does not change the state.</p></td></tr> + * <tr><td>deselectTrack </p></td> + * <td>{Prepared, Started, Stopped, Paused, PlaybackCompleted}</p></td> + * <td>{Idle, Initialized, Error}</p></td> + * <td>Successful invoke of this method does not change the state.</p></td></tr> + * + * </table> + * + * <a name="Permissions"></a> + * <h3>Permissions</h3> + * <p>One may need to declare a corresponding WAKE_LOCK permission {@link + * android.R.styleable#AndroidManifestUsesPermission <uses-permission>} + * element. + * + * <p>This class requires the {@link android.Manifest.permission#INTERNET} permission + * when used with network-based content. + * + * <a name="Callbacks"></a> + * <h3>Callbacks</h3> + * <p>Applications may want to register for informational and error + * events in order to be informed of some internal state update and + * possible runtime errors during playback or streaming. Registration for + * these events is done by properly setting the appropriate listeners (via calls + * to + * {@link #registerEventCallback(Executor, EventCallback)}, + * {@link #registerDrmEventCallback(Executor, DrmEventCallback)}). + * In order to receive the respective callback + * associated with these listeners, applications are required to create + * MediaPlayer2 objects on a thread with its own Looper running (main UI + * thread by default has a Looper running). + * + */ +public abstract class MediaPlayer2 implements SubtitleController.Listener + , AudioRouting + , AutoCloseable +{ + /** + Constant to retrieve only the new metadata since the last + call. + // FIXME: unhide. + // FIXME: add link to getMetadata(boolean, boolean) + {@hide} + */ + public static final boolean METADATA_UPDATE_ONLY = true; + + /** + Constant to retrieve all the metadata. + // FIXME: unhide. + // FIXME: add link to getMetadata(boolean, boolean) + {@hide} + */ + public static final boolean METADATA_ALL = false; + + /** + Constant to enable the metadata filter during retrieval. + // FIXME: unhide. + // FIXME: add link to getMetadata(boolean, boolean) + {@hide} + */ + public static final boolean APPLY_METADATA_FILTER = true; + + /** + Constant to disable the metadata filter during retrieval. + // FIXME: unhide. + // FIXME: add link to getMetadata(boolean, boolean) + {@hide} + */ + public static final boolean BYPASS_METADATA_FILTER = false; + + /** + * Create a MediaPlayer2 object. + * + * @return A MediaPlayer2 object created + */ + public static final MediaPlayer2 create() { + // TODO: load MediaUpdate APK + return new MediaPlayer2Impl(); + } + + /** + * @hide + */ + // add hidden empty constructor so it doesn't show in SDK + public MediaPlayer2() { } + + /** + * Create a request parcel which can be routed to the native media + * player using {@link #invoke(Parcel, Parcel)}. The Parcel + * returned has the proper InterfaceToken set. The caller should + * not overwrite that token, i.e it can only append data to the + * Parcel. + * + * @return A parcel suitable to hold a request for the native + * player. + * {@hide} + */ + public Parcel newRequest() { + return null; + } + + /** + * Invoke a generic method on the native player using opaque + * parcels for the request and reply. Both payloads' format is a + * convention between the java caller and the native player. + * Must be called after setDataSource or setPlaylist to make sure a native player + * exists. On failure, a RuntimeException is thrown. + * + * @param request Parcel with the data for the extension. The + * caller must use {@link #newRequest()} to get one. + * + * @param reply Output parcel with the data returned by the + * native player. + * {@hide} + */ + public void invoke(Parcel request, Parcel reply) { } + + /** + * Sets the {@link SurfaceHolder} to use for displaying the video + * portion of the media. + * + * Either a surface holder or surface must be set if a display or video sink + * is needed. Not calling this method or {@link #setSurface(Surface)} + * when playing back a video will result in only the audio track being played. + * A null surface holder or surface will result in only the audio track being + * played. + * + * @param sh the SurfaceHolder to use for video display + * @throws IllegalStateException if the internal player engine has not been + * initialized or has been released. + * @hide + */ + public abstract void setDisplay(SurfaceHolder sh); + + /** + * Sets the {@link Surface} to be used as the sink for the video portion of + * the media. Setting a + * Surface will un-set any Surface or SurfaceHolder that was previously set. + * A null surface will result in only the audio track being played. + * + * If the Surface sends frames to a {@link SurfaceTexture}, the timestamps + * returned from {@link SurfaceTexture#getTimestamp()} will have an + * unspecified zero point. These timestamps cannot be directly compared + * between different media sources, different instances of the same media + * source, or multiple runs of the same program. The timestamp is normally + * monotonically increasing and is unaffected by time-of-day adjustments, + * but it is reset when the position is set. + * + * @param surface The {@link Surface} to be used for the video portion of + * the media. + * @throws IllegalStateException if the internal player engine has not been + * initialized or has been released. + */ + public abstract void setSurface(Surface surface); + + /* Do not change these video scaling mode values below without updating + * their counterparts in system/window.h! Please do not forget to update + * {@link #isVideoScalingModeSupported} when new video scaling modes + * are added. + */ + /** + * Specifies a video scaling mode. The content is stretched to the + * surface rendering area. When the surface has the same aspect ratio + * as the content, the aspect ratio of the content is maintained; + * otherwise, the aspect ratio of the content is not maintained when video + * is being rendered. + * There is no content cropping with this video scaling mode. + */ + public static final int VIDEO_SCALING_MODE_SCALE_TO_FIT = 1; + + /** + * Specifies a video scaling mode. The content is scaled, maintaining + * its aspect ratio. The whole surface area is always used. When the + * aspect ratio of the content is the same as the surface, no content + * is cropped; otherwise, content is cropped to fit the surface. + * @hide + */ + public static final int VIDEO_SCALING_MODE_SCALE_TO_FIT_WITH_CROPPING = 2; + + /** + * Sets video scaling mode. To make the target video scaling mode + * effective during playback, this method must be called after + * data source is set. If not called, the default video + * scaling mode is {@link #VIDEO_SCALING_MODE_SCALE_TO_FIT}. + * + * <p> The supported video scaling modes are: + * <ul> + * <li> {@link #VIDEO_SCALING_MODE_SCALE_TO_FIT} + * </ul> + * + * @param mode target video scaling mode. Must be one of the supported + * video scaling modes; otherwise, IllegalArgumentException will be thrown. + * + * @see MediaPlayer2#VIDEO_SCALING_MODE_SCALE_TO_FIT + * @hide + */ + public void setVideoScalingMode(int mode) { } + + /** + * Discards all pending commands. + */ + public abstract void clearPendingCommands(); + + /** + * Sets the data source as described by a DataSourceDesc. + * + * @param dsd the descriptor of data source you want to play + * @throws IllegalStateException if it is called in an invalid state + * @throws NullPointerException if dsd is null + */ + public abstract void setDataSource(@NonNull DataSourceDesc dsd) throws IOException; + + /** + * Gets the current data source as described by a DataSourceDesc. + * + * @return the current DataSourceDesc + */ + public abstract DataSourceDesc getCurrentDataSource(); + + /** + * Sets the play list. + * + * If startIndex falls outside play list range, it will be clamped to the nearest index + * in the play list. + * + * @param pl the play list of data source you want to play + * @param startIndex the index of the DataSourceDesc in the play list you want to play first + * @throws IllegalStateException if it is called in an invalid state + * @throws IllegalArgumentException if pl is null or empty, or pl contains null DataSourceDesc + */ + public abstract void setPlaylist(@NonNull List<DataSourceDesc> pl, int startIndex) + throws IOException; + + /** + * Gets a copy of the play list. + * + * @return a copy of the play list used by {@link MediaPlayer2} + */ + public abstract List<DataSourceDesc> getPlaylist(); + + /** + * Sets the index of current DataSourceDesc in the play list to be played. + * + * @param index the index of DataSourceDesc in the play list you want to play + * @throws IllegalArgumentException if the play list is null + * @throws NullPointerException if index is outside play list range + */ + public abstract void setCurrentPlaylistItem(int index); + + /** + * Sets the index of next-to-be-played DataSourceDesc in the play list. + * + * @param index the index of next-to-be-played DataSourceDesc in the play list + * @throws IllegalArgumentException if the play list is null + * @throws NullPointerException if index is outside play list range + */ + public abstract void setNextPlaylistItem(int index); + + /** + * Gets the current index of play list. + * + * @return the index of the current DataSourceDesc in the play list + */ + public abstract int getCurrentPlaylistItemIndex(); + + /** + * Specifies a playback looping mode. The source will not be played in looping mode. + */ + public static final int LOOPING_MODE_NONE = 0; + /** + * Specifies a playback looping mode. The full list of source will be played in looping mode, + * and in the order specified in the play list. + */ + public static final int LOOPING_MODE_FULL = 1; + /** + * Specifies a playback looping mode. The current DataSourceDesc will be played in looping mode. + */ + public static final int LOOPING_MODE_SINGLE = 2; + /** + * Specifies a playback looping mode. The full list of source will be played in looping mode, + * and in a random order. + */ + public static final int LOOPING_MODE_SHUFFLE = 3; + + /** @hide */ + @IntDef( + value = { + LOOPING_MODE_NONE, + LOOPING_MODE_FULL, + LOOPING_MODE_SINGLE, + LOOPING_MODE_SHUFFLE, + }) + @Retention(RetentionPolicy.SOURCE) + public @interface LoopingMode {} + + /** + * Sets the looping mode of the play list. + * The mode shall be one of {@link #LOOPING_MODE_NONE}, {@link #LOOPING_MODE_FULL}, + * {@link #LOOPING_MODE_SINGLE}, {@link #LOOPING_MODE_SHUFFLE}. + * + * @param mode the mode in which the play list will be played + * @throws IllegalArgumentException if mode is not supported + */ + public abstract void setLoopingMode(@LoopingMode int mode); + + /** + * Gets the looping mode of play list. + * + * @return the looping mode of the play list + */ + public abstract int getLoopingMode(); + + /** + * Moves the DataSourceDesc at indexFrom in the play list to indexTo. + * + * @throws IllegalArgumentException if the play list is null + * @throws IndexOutOfBoundsException if indexFrom or indexTo is outside play list range + */ + public abstract void movePlaylistItem(int indexFrom, int indexTo); + + /** + * Removes the DataSourceDesc at index in the play list. + * + * If index is same as the current index of the play list, current DataSourceDesc + * will be stopped and playback moves to next source in the list. + * + * @return the removed DataSourceDesc at index in the play list + * @throws IllegalArgumentException if the play list is null + * @throws IndexOutOfBoundsException if index is outside play list range + */ + public abstract DataSourceDesc removePlaylistItem(int index); + + /** + * Inserts the DataSourceDesc to the play list at position index. + * + * This will not change the DataSourceDesc currently being played. + * If index is less than or equal to the current index of the play list, + * the current index of the play list will be incremented correspondingly. + * + * @param index the index you want to add dsd to the play list + * @param dsd the descriptor of data source you want to add to the play list + * @throws IndexOutOfBoundsException if index is outside play list range + * @throws NullPointerException if dsd is null + */ + public abstract void addPlaylistItem(int index, DataSourceDesc dsd); + + /** + * replaces the DataSourceDesc at index in the play list with given dsd. + * + * When index is same as the current index of the play list, the current source + * will be stopped and the new source will be played, except that if new + * and old source only differ on end position and current media position is + * smaller then the new end position. + * + * This will not change the DataSourceDesc currently being played. + * If index is less than or equal to the current index of the play list, + * the current index of the play list will be incremented correspondingly. + * + * @param index the index you want to add dsd to the play list + * @param dsd the descriptor of data source you want to add to the play list + * @throws IndexOutOfBoundsException if index is outside play list range + * @throws NullPointerException if dsd is null + */ + public abstract DataSourceDesc editPlaylistItem(int index, DataSourceDesc dsd); + + /** + * Prepares the player for playback, synchronously. + * + * After setting the datasource and the display surface, you need to either + * call prepare() or prepareAsync(). For files, it is OK to call prepare(), + * which blocks until MediaPlayer2 is ready for playback. + * + * @throws IOException if source can not be accessed + * @throws IllegalStateException if it is called in an invalid state + * @hide + */ + public void prepare() throws IOException { } + + /** + * Prepares the player for playback, asynchronously. + * + * After setting the datasource and the display surface, you need to + * call prepareAsync(). + * + * @throws IllegalStateException if it is called in an invalid state + */ + public abstract void prepareAsync(); + + /** + * Starts or resumes playback. If playback had previously been paused, + * playback will continue from where it was paused. If playback had + * been stopped, or never started before, playback will start at the + * beginning. + * + * @throws IllegalStateException if it is called in an invalid state + */ + public abstract void play(); + + /** + * Stops playback after playback has been started or paused. + * + * @throws IllegalStateException if the internal player engine has not been + * initialized. + * @hide + */ + public void stop() { } + + /** + * Pauses playback. Call play() to resume. + * + * @throws IllegalStateException if the internal player engine has not been + * initialized. + */ + public abstract void pause(); + + //-------------------------------------------------------------------------- + // Explicit Routing + //-------------------- + + /** + * Specifies an audio device (via an {@link AudioDeviceInfo} object) to route + * the output from this MediaPlayer2. + * @param deviceInfo The {@link AudioDeviceInfo} specifying the audio sink or source. + * If deviceInfo is null, default routing is restored. + * @return true if succesful, false if the specified {@link AudioDeviceInfo} is non-null and + * does not correspond to a valid audio device. + */ + @Override + public abstract boolean setPreferredDevice(AudioDeviceInfo deviceInfo); + + /** + * Returns the selected output specified by {@link #setPreferredDevice}. Note that this + * is not guaranteed to correspond to the actual device being used for playback. + */ + @Override + public abstract AudioDeviceInfo getPreferredDevice(); + + /** + * Returns an {@link AudioDeviceInfo} identifying the current routing of this MediaPlayer2 + * Note: The query is only valid if the MediaPlayer2 is currently playing. + * If the player is not playing, the returned device can be null or correspond to previously + * selected device when the player was last active. + */ + @Override + public abstract AudioDeviceInfo getRoutedDevice(); + + /** + * Adds an {@link AudioRouting.OnRoutingChangedListener} to receive notifications of routing + * changes on this MediaPlayer2. + * @param listener The {@link AudioRouting.OnRoutingChangedListener} interface to receive + * notifications of rerouting events. + * @param handler Specifies the {@link Handler} object for the thread on which to execute + * the callback. If <code>null</code>, the handler on the main looper will be used. + */ + @Override + public abstract void addOnRoutingChangedListener(AudioRouting.OnRoutingChangedListener listener, + Handler handler); + + /** + * Removes an {@link AudioRouting.OnRoutingChangedListener} which has been previously added + * to receive rerouting notifications. + * @param listener The previously added {@link AudioRouting.OnRoutingChangedListener} interface + * to remove. + */ + @Override + public abstract void removeOnRoutingChangedListener(AudioRouting.OnRoutingChangedListener listener); + + /** + * Set the low-level power management behavior for this MediaPlayer2. + * + * <p>This function has the MediaPlayer2 access the low-level power manager + * service to control the device's power usage while playing is occurring. + * The parameter is a combination of {@link android.os.PowerManager} wake flags. + * Use of this method requires {@link android.Manifest.permission#WAKE_LOCK} + * permission. + * By default, no attempt is made to keep the device awake during playback. + * + * @param context the Context to use + * @param mode the power/wake mode to set + * @see android.os.PowerManager + * @hide + */ + public abstract void setWakeMode(Context context, int mode); + + /** + * Control whether we should use the attached SurfaceHolder to keep the + * screen on while video playback is occurring. This is the preferred + * method over {@link #setWakeMode} where possible, since it doesn't + * require that the application have permission for low-level wake lock + * access. + * + * @param screenOn Supply true to keep the screen on, false to allow it + * to turn off. + * @hide + */ + public abstract void setScreenOnWhilePlaying(boolean screenOn); + + /** + * Returns the width of the video. + * + * @return the width of the video, or 0 if there is no video, + * no display surface was set, or the width has not been determined + * yet. The {@code EventCallback} can be registered via + * {@link #registerEventCallback(Executor, EventCallback)} to provide a + * notification {@code EventCallback.onVideoSizeChanged} when the width is available. + */ + public abstract int getVideoWidth(); + + /** + * Returns the height of the video. + * + * @return the height of the video, or 0 if there is no video, + * no display surface was set, or the height has not been determined + * yet. The {@code EventCallback} can be registered via + * {@link #registerEventCallback(Executor, EventCallback)} to provide a + * notification {@code EventCallback.onVideoSizeChanged} when the height is available. + */ + public abstract int getVideoHeight(); + + /** + * Return Metrics data about the current player. + * + * @return a {@link PersistableBundle} containing the set of attributes and values + * available for the media being handled by this instance of MediaPlayer2 + * The attributes are descibed in {@link MetricsConstants}. + * + * Additional vendor-specific fields may also be present in + * the return value. + */ + public abstract PersistableBundle getMetrics(); + + /** + * Checks whether the MediaPlayer2 is playing. + * + * @return true if currently playing, false otherwise + * @throws IllegalStateException if the internal player engine has not been + * initialized or has been released. + */ + public abstract boolean isPlaying(); + + /** + * Gets the current buffering management params used by the source component. + * Calling it only after {@code setDataSource} has been called. + * Each type of data source might have different set of default params. + * + * @return the current buffering management params used by the source component. + * @throws IllegalStateException if the internal player engine has not been + * initialized, or {@code setDataSource} has not been called. + * @hide + */ + @NonNull + public BufferingParams getBufferingParams() { + return new BufferingParams.Builder().build(); + } + + /** + * Sets buffering management params. + * The object sets its internal BufferingParams to the input, except that the input is + * invalid or not supported. + * Call it only after {@code setDataSource} has been called. + * The input is a hint to MediaPlayer2. + * + * @param params the buffering management params. + * + * @throws IllegalStateException if the internal player engine has not been + * initialized or has been released, or {@code setDataSource} has not been called. + * @throws IllegalArgumentException if params is invalid or not supported. + * @hide + */ + public void setBufferingParams(@NonNull BufferingParams params) { } + + /** + * Change playback speed of audio by resampling the audio. + * <p> + * Specifies resampling as audio mode for variable rate playback, i.e., + * resample the waveform based on the requested playback rate to get + * a new waveform, and play back the new waveform at the original sampling + * frequency. + * When rate is larger than 1.0, pitch becomes higher. + * When rate is smaller than 1.0, pitch becomes lower. + * + * @hide + */ + public static final int PLAYBACK_RATE_AUDIO_MODE_RESAMPLE = 2; + + /** + * Change playback speed of audio without changing its pitch. + * <p> + * Specifies time stretching as audio mode for variable rate playback. + * Time stretching changes the duration of the audio samples without + * affecting its pitch. + * <p> + * This mode is only supported for a limited range of playback speed factors, + * e.g. between 1/2x and 2x. + * + * @hide + */ + public static final int PLAYBACK_RATE_AUDIO_MODE_STRETCH = 1; + + /** + * Change playback speed of audio without changing its pitch, and + * possibly mute audio if time stretching is not supported for the playback + * speed. + * <p> + * Try to keep audio pitch when changing the playback rate, but allow the + * system to determine how to change audio playback if the rate is out + * of range. + * + * @hide + */ + public static final int PLAYBACK_RATE_AUDIO_MODE_DEFAULT = 0; + + /** @hide */ + @IntDef( + value = { + PLAYBACK_RATE_AUDIO_MODE_DEFAULT, + PLAYBACK_RATE_AUDIO_MODE_STRETCH, + PLAYBACK_RATE_AUDIO_MODE_RESAMPLE, + }) + @Retention(RetentionPolicy.SOURCE) + public @interface PlaybackRateAudioMode {} + + /** + * Sets playback rate and audio mode. + * + * @param rate the ratio between desired playback rate and normal one. + * @param audioMode audio playback mode. Must be one of the supported + * audio modes. + * + * @throws IllegalStateException if the internal player engine has not been + * initialized. + * @throws IllegalArgumentException if audioMode is not supported. + * + * @hide + */ + @NonNull + public PlaybackParams easyPlaybackParams(float rate, @PlaybackRateAudioMode int audioMode) { + return new PlaybackParams(); + } + + /** + * Sets playback rate using {@link PlaybackParams}. The object sets its internal + * PlaybackParams to the input, except that the object remembers previous speed + * when input speed is zero. This allows the object to resume at previous speed + * when play() is called. Calling it before the object is prepared does not change + * the object state. After the object is prepared, calling it with zero speed is + * equivalent to calling pause(). After the object is prepared, calling it with + * non-zero speed is equivalent to calling play(). + * + * @param params the playback params. + * + * @throws IllegalStateException if the internal player engine has not been + * initialized or has been released. + * @throws IllegalArgumentException if params is not supported. + */ + public abstract void setPlaybackParams(@NonNull PlaybackParams params); + + /** + * Gets the playback params, containing the current playback rate. + * + * @return the playback params. + * @throws IllegalStateException if the internal player engine has not been + * initialized. + */ + @NonNull + public abstract PlaybackParams getPlaybackParams(); + + /** + * Sets A/V sync mode. + * + * @param params the A/V sync params to apply + * + * @throws IllegalStateException if the internal player engine has not been + * initialized. + * @throws IllegalArgumentException if params are not supported. + */ + public abstract void setSyncParams(@NonNull SyncParams params); + + /** + * Gets the A/V sync mode. + * + * @return the A/V sync params + * + * @throws IllegalStateException if the internal player engine has not been + * initialized. + */ + @NonNull + public abstract SyncParams getSyncParams(); + + /** + * Seek modes used in method seekTo(long, int) to move media position + * to a specified location. + * + * Do not change these mode values without updating their counterparts + * in include/media/IMediaSource.h! + */ + /** + * This mode is used with {@link #seekTo(long, int)} to move media position to + * a sync (or key) frame associated with a data source that is located + * right before or at the given time. + * + * @see #seekTo(long, int) + */ + public static final int SEEK_PREVIOUS_SYNC = 0x00; + /** + * This mode is used with {@link #seekTo(long, int)} to move media position to + * a sync (or key) frame associated with a data source that is located + * right after or at the given time. + * + * @see #seekTo(long, int) + */ + public static final int SEEK_NEXT_SYNC = 0x01; + /** + * This mode is used with {@link #seekTo(long, int)} to move media position to + * a sync (or key) frame associated with a data source that is located + * closest to (in time) or at the given time. + * + * @see #seekTo(long, int) + */ + public static final int SEEK_CLOSEST_SYNC = 0x02; + /** + * This mode is used with {@link #seekTo(long, int)} to move media position to + * a frame (not necessarily a key frame) associated with a data source that + * is located closest to or at the given time. + * + * @see #seekTo(long, int) + */ + public static final int SEEK_CLOSEST = 0x03; + + /** @hide */ + @IntDef( + value = { + SEEK_PREVIOUS_SYNC, + SEEK_NEXT_SYNC, + SEEK_CLOSEST_SYNC, + SEEK_CLOSEST, + }) + @Retention(RetentionPolicy.SOURCE) + public @interface SeekMode {} + + /** + * Moves the media to specified time position by considering the given mode. + * <p> + * When seekTo is finished, the user will be notified via OnSeekComplete supplied by the user. + * There is at most one active seekTo processed at any time. If there is a to-be-completed + * seekTo, new seekTo requests will be queued in such a way that only the last request + * is kept. When current seekTo is completed, the queued request will be processed if + * that request is different from just-finished seekTo operation, i.e., the requested + * position or mode is different. + * + * @param msec the offset in milliseconds from the start to seek to. + * When seeking to the given time position, there is no guarantee that the data source + * has a frame located at the position. When this happens, a frame nearby will be rendered. + * If msec is negative, time position zero will be used. + * If msec is larger than duration, duration will be used. + * @param mode the mode indicating where exactly to seek to. + * Use {@link #SEEK_PREVIOUS_SYNC} if one wants to seek to a sync frame + * that has a timestamp earlier than or the same as msec. Use + * {@link #SEEK_NEXT_SYNC} if one wants to seek to a sync frame + * that has a timestamp later than or the same as msec. Use + * {@link #SEEK_CLOSEST_SYNC} if one wants to seek to a sync frame + * that has a timestamp closest to or the same as msec. Use + * {@link #SEEK_CLOSEST} if one wants to seek to a frame that may + * or may not be a sync frame but is closest to or the same as msec. + * {@link #SEEK_CLOSEST} often has larger performance overhead compared + * to the other options if there is no sync frame located at msec. + * @throws IllegalStateException if the internal player engine has not been + * initialized + * @throws IllegalArgumentException if the mode is invalid. + */ + public abstract void seekTo(long msec, @SeekMode int mode); + + /** + * Get current playback position as a {@link MediaTimestamp}. + * <p> + * The MediaTimestamp represents how the media time correlates to the system time in + * a linear fashion using an anchor and a clock rate. During regular playback, the media + * time moves fairly constantly (though the anchor frame may be rebased to a current + * system time, the linear correlation stays steady). Therefore, this method does not + * need to be called often. + * <p> + * To help users get current playback position, this method always anchors the timestamp + * to the current {@link System#nanoTime system time}, so + * {@link MediaTimestamp#getAnchorMediaTimeUs} can be used as current playback position. + * + * @return a MediaTimestamp object if a timestamp is available, or {@code null} if no timestamp + * is available, e.g. because the media player has not been initialized. + * + * @see MediaTimestamp + */ + @Nullable + public abstract MediaTimestamp getTimestamp(); + + /** + * Gets the current playback position. + * + * @return the current position in milliseconds + */ + public abstract int getCurrentPosition(); + + /** + * Gets the duration of the file. + * + * @return the duration in milliseconds, if no duration is available + * (for example, if streaming live content), -1 is returned. + */ + public abstract int getDuration(); + + /** + * Gets the media metadata. + * + * @param update_only controls whether the full set of available + * metadata is returned or just the set that changed since the + * last call. See {@see #METADATA_UPDATE_ONLY} and {@see + * #METADATA_ALL}. + * + * @param apply_filter if true only metadata that matches the + * filter is returned. See {@see #APPLY_METADATA_FILTER} and {@see + * #BYPASS_METADATA_FILTER}. + * + * @return The metadata, possibly empty. null if an error occured. + // FIXME: unhide. + * {@hide} + */ + public Metadata getMetadata(final boolean update_only, + final boolean apply_filter) { + return null; + } + + /** + * Set a filter for the metadata update notification and update + * retrieval. The caller provides 2 set of metadata keys, allowed + * and blocked. The blocked set always takes precedence over the + * allowed one. + * Metadata.MATCH_ALL and Metadata.MATCH_NONE are 2 sets available as + * shorthands to allow/block all or no metadata. + * + * By default, there is no filter set. + * + * @param allow Is the set of metadata the client is interested + * in receiving new notifications for. + * @param block Is the set of metadata the client is not interested + * in receiving new notifications for. + * @return The call status code. + * + // FIXME: unhide. + * {@hide} + */ + public int setMetadataFilter(Set<Integer> allow, Set<Integer> block) { + return 0; + } + + /** + * Set the MediaPlayer2 to start when this MediaPlayer2 finishes playback + * (i.e. reaches the end of the stream). + * The media framework will attempt to transition from this player to + * the next as seamlessly as possible. The next player can be set at + * any time before completion, but shall be after setDataSource has been + * called successfully. The next player must be prepared by the + * app, and the application should not call play() on it. + * The next MediaPlayer2 must be different from 'this'. An exception + * will be thrown if next == this. + * The application may call setNextMediaPlayer(null) to indicate no + * next player should be started at the end of playback. + * If the current player is looping, it will keep looping and the next + * player will not be started. + * + * @param next the player to start after this one completes playback. + * + * @hide + */ + public void setNextMediaPlayer(MediaPlayer2 next) { } + + /** + * Resets the MediaPlayer2 to its uninitialized state. After calling + * this method, you will have to initialize it again by setting the + * data source and calling prepareAsync(). + */ + public abstract void reset(); + + /** + * Set up a timer for {@link #TimeProvider}. {@link #TimeProvider} will be + * notified when the presentation time reaches (becomes greater than or equal to) + * the value specified. + * + * @param mediaTimeUs presentation time to get timed event callback at + * @hide + */ + public void notifyAt(long mediaTimeUs) { } + + /** + * Sets the audio attributes for this MediaPlayer2. + * See {@link AudioAttributes} for how to build and configure an instance of this class. + * You must call this method before {@link #prepareAsync()} in order + * for the audio attributes to become effective thereafter. + * @param attributes a non-null set of audio attributes + * @throws IllegalArgumentException if the attributes are null or invalid. + */ + public abstract void setAudioAttributes(AudioAttributes attributes); + + /** + * Sets the player to be looping or non-looping. + * + * @param looping whether to loop or not + * @hide + */ + public void setLooping(boolean looping) { } + + /** + * Checks whether the MediaPlayer2 is looping or non-looping. + * + * @return true if the MediaPlayer2 is currently looping, false otherwise + * @hide + */ + public boolean isLooping() { + return false; + } + + /** + * Sets the volume on this player. + * This API is recommended for balancing the output of audio streams + * within an application. Unless you are writing an application to + * control user settings, this API should be used in preference to + * {@link AudioManager#setStreamVolume(int, int, int)} which sets the volume of ALL streams of + * a particular type. Note that the passed volume values are raw scalars in range 0.0 to 1.0. + * UI controls should be scaled logarithmically. + * + * @param leftVolume left volume scalar + * @param rightVolume right volume scalar + */ + /* + * FIXME: Merge this into javadoc comment above when setVolume(float) is not @hide. + * The single parameter form below is preferred if the channel volumes don't need + * to be set independently. + */ + public abstract void setVolume(float leftVolume, float rightVolume); + + /** + * Similar, excepts sets volume of all channels to same value. + * @hide + */ + public void setVolume(float volume) { } + + /** + * Sets the audio session ID. + * + * @param sessionId the audio session ID. + * The audio session ID is a system wide unique identifier for the audio stream played by + * this MediaPlayer2 instance. + * The primary use of the audio session ID is to associate audio effects to a particular + * instance of MediaPlayer2: if an audio session ID is provided when creating an audio effect, + * this effect will be applied only to the audio content of media players within the same + * audio session and not to the output mix. + * When created, a MediaPlayer2 instance automatically generates its own audio session ID. + * However, it is possible to force this player to be part of an already existing audio session + * by calling this method. + * This method must be called before one of the overloaded <code> setDataSource </code> methods. + * @throws IllegalStateException if it is called in an invalid state + * @throws IllegalArgumentException if the sessionId is invalid. + */ + public abstract void setAudioSessionId(int sessionId); + + /** + * Returns the audio session ID. + * + * @return the audio session ID. {@see #setAudioSessionId(int)} + * Note that the audio session ID is 0 only if a problem occured when the MediaPlayer2 was contructed. + */ + public abstract int getAudioSessionId(); + + /** + * Attaches an auxiliary effect to the player. A typical auxiliary effect is a reverberation + * effect which can be applied on any sound source that directs a certain amount of its + * energy to this effect. This amount is defined by setAuxEffectSendLevel(). + * See {@link #setAuxEffectSendLevel(float)}. + * <p>After creating an auxiliary effect (e.g. + * {@link android.media.audiofx.EnvironmentalReverb}), retrieve its ID with + * {@link android.media.audiofx.AudioEffect#getId()} and use it when calling this method + * to attach the player to the effect. + * <p>To detach the effect from the player, call this method with a null effect id. + * <p>This method must be called after one of the overloaded <code> setDataSource </code> + * methods. + * @param effectId system wide unique id of the effect to attach + */ + public abstract void attachAuxEffect(int effectId); + + + /** + * Sets the send level of the player to the attached auxiliary effect. + * See {@link #attachAuxEffect(int)}. The level value range is 0 to 1.0. + * <p>By default the send level is 0, so even if an effect is attached to the player + * this method must be called for the effect to be applied. + * <p>Note that the passed level value is a raw scalar. UI controls should be scaled + * logarithmically: the gain applied by audio framework ranges from -72dB to 0dB, + * so an appropriate conversion from linear UI input x to level is: + * x == 0 -> level = 0 + * 0 < x <= R -> level = 10^(72*(x-R)/20/R) + * @param level send level scalar + */ + public abstract void setAuxEffectSendLevel(float level); + + /** + * Class for MediaPlayer2 to return each audio/video/subtitle track's metadata. + * + * @see android.media.MediaPlayer2#getTrackInfo + */ + public abstract static class TrackInfo { + /** + * Gets the track type. + * @return TrackType which indicates if the track is video, audio, timed text. + */ + public abstract int getTrackType(); + + /** + * Gets the language code of the track. + * @return a language code in either way of ISO-639-1 or ISO-639-2. + * When the language is unknown or could not be determined, + * ISO-639-2 language code, "und", is returned. + */ + public abstract String getLanguage(); + + /** + * Gets the {@link MediaFormat} of the track. If the format is + * unknown or could not be determined, null is returned. + */ + public abstract MediaFormat getFormat(); + + public static final int MEDIA_TRACK_TYPE_UNKNOWN = 0; + public static final int MEDIA_TRACK_TYPE_VIDEO = 1; + public static final int MEDIA_TRACK_TYPE_AUDIO = 2; + + /** @hide */ + public static final int MEDIA_TRACK_TYPE_TIMEDTEXT = 3; + + public static final int MEDIA_TRACK_TYPE_SUBTITLE = 4; + public static final int MEDIA_TRACK_TYPE_METADATA = 5; + + @Override + public abstract String toString(); + }; + + /** + * Returns a List of track information. + * + * @return List of track info. The total number of tracks is the array length. + * Must be called again if an external timed text source has been added after + * addTimedTextSource method is called. + * @throws IllegalStateException if it is called in an invalid state. + */ + public abstract List<TrackInfo> getTrackInfo(); + + /* Do not change these values without updating their counterparts + * in include/media/stagefright/MediaDefs.h and media/libstagefright/MediaDefs.cpp! + */ + /** + * MIME type for SubRip (SRT) container. Used in addTimedTextSource APIs. + * @hide + */ + public static final String MEDIA_MIMETYPE_TEXT_SUBRIP = "application/x-subrip"; + + /** + * MIME type for WebVTT subtitle data. + * @hide + */ + public static final String MEDIA_MIMETYPE_TEXT_VTT = "text/vtt"; + + /** + * MIME type for CEA-608 closed caption data. + * @hide + */ + public static final String MEDIA_MIMETYPE_TEXT_CEA_608 = "text/cea-608"; + + /** + * MIME type for CEA-708 closed caption data. + * @hide + */ + public static final String MEDIA_MIMETYPE_TEXT_CEA_708 = "text/cea-708"; + + /** @hide */ + public void setSubtitleAnchor( + SubtitleController controller, + SubtitleController.Anchor anchor) { } + + /** @hide */ + @Override + public void onSubtitleTrackSelected(SubtitleTrack track) { } + + /** @hide */ + public void addSubtitleSource(InputStream is, MediaFormat format) { } + + /* TODO: Limit the total number of external timed text source to a reasonable number. + */ + /** + * Adds an external timed text source file. + * + * Currently supported format is SubRip with the file extension .srt, case insensitive. + * Note that a single external timed text source may contain multiple tracks in it. + * One can find the total number of available tracks using {@link #getTrackInfo()} to see what + * additional tracks become available after this method call. + * + * @param path The file path of external timed text source file. + * @param mimeType The mime type of the file. Must be one of the mime types listed above. + * @throws IOException if the file cannot be accessed or is corrupted. + * @throws IllegalArgumentException if the mimeType is not supported. + * @throws IllegalStateException if called in an invalid state. + * @hide + */ + public void addTimedTextSource(String path, String mimeType) throws IOException { } + + /** + * Adds an external timed text source file (Uri). + * + * Currently supported format is SubRip with the file extension .srt, case insensitive. + * Note that a single external timed text source may contain multiple tracks in it. + * One can find the total number of available tracks using {@link #getTrackInfo()} to see what + * additional tracks become available after this method call. + * + * @param context the Context to use when resolving the Uri + * @param uri the Content URI of the data you want to play + * @param mimeType The mime type of the file. Must be one of the mime types listed above. + * @throws IOException if the file cannot be accessed or is corrupted. + * @throws IllegalArgumentException if the mimeType is not supported. + * @throws IllegalStateException if called in an invalid state. + * @hide + */ + public void addTimedTextSource(Context context, Uri uri, String mimeType) throws IOException { } + + /** + * Adds an external timed text source file (FileDescriptor). + * + * It is the caller's responsibility to close the file descriptor. + * It is safe to do so as soon as this call returns. + * + * Currently supported format is SubRip. Note that a single external timed text source may + * contain multiple tracks in it. One can find the total number of available tracks + * using {@link #getTrackInfo()} to see what additional tracks become available + * after this method call. + * + * @param fd the FileDescriptor for the file you want to play + * @param mimeType The mime type of the file. Must be one of the mime types listed above. + * @throws IllegalArgumentException if the mimeType is not supported. + * @throws IllegalStateException if called in an invalid state. + * @hide + */ + public void addTimedTextSource(FileDescriptor fd, String mimeType) { } + + /** + * Adds an external timed text file (FileDescriptor). + * + * It is the caller's responsibility to close the file descriptor. + * It is safe to do so as soon as this call returns. + * + * Currently supported format is SubRip. Note that a single external timed text source may + * contain multiple tracks in it. One can find the total number of available tracks + * using {@link #getTrackInfo()} to see what additional tracks become available + * after this method call. + * + * @param fd the FileDescriptor for the file you want to play + * @param offset the offset into the file where the data to be played starts, in bytes + * @param length the length in bytes of the data to be played + * @param mime The mime type of the file. Must be one of the mime types listed above. + * @throws IllegalArgumentException if the mimeType is not supported. + * @throws IllegalStateException if called in an invalid state. + * @hide + */ + public abstract void addTimedTextSource(FileDescriptor fd, long offset, long length, String mime); + + /** + * Returns the index of the audio, video, or subtitle track currently selected for playback, + * The return value is an index into the array returned by {@link #getTrackInfo()}, and can + * be used in calls to {@link #selectTrack(int)} or {@link #deselectTrack(int)}. + * + * @param trackType should be one of {@link TrackInfo#MEDIA_TRACK_TYPE_VIDEO}, + * {@link TrackInfo#MEDIA_TRACK_TYPE_AUDIO}, or + * {@link TrackInfo#MEDIA_TRACK_TYPE_SUBTITLE} + * @return index of the audio, video, or subtitle track currently selected for playback; + * a negative integer is returned when there is no selected track for {@code trackType} or + * when {@code trackType} is not one of audio, video, or subtitle. + * @throws IllegalStateException if called after {@link #close()} + * + * @see #getTrackInfo() + * @see #selectTrack(int) + * @see #deselectTrack(int) + */ + public abstract int getSelectedTrack(int trackType); + + /** + * Selects a track. + * <p> + * If a MediaPlayer2 is in invalid state, it throws an IllegalStateException exception. + * If a MediaPlayer2 is in <em>Started</em> state, the selected track is presented immediately. + * If a MediaPlayer2 is not in Started state, it just marks the track to be played. + * </p> + * <p> + * In any valid state, if it is called multiple times on the same type of track (ie. Video, + * Audio, Timed Text), the most recent one will be chosen. + * </p> + * <p> + * The first audio and video tracks are selected by default if available, even though + * this method is not called. However, no timed text track will be selected until + * this function is called. + * </p> + * <p> + * Currently, only timed text tracks or audio tracks can be selected via this method. + * In addition, the support for selecting an audio track at runtime is pretty limited + * in that an audio track can only be selected in the <em>Prepared</em> state. + * </p> + * @param index the index of the track to be selected. The valid range of the index + * is 0..total number of track - 1. The total number of tracks as well as the type of + * each individual track can be found by calling {@link #getTrackInfo()} method. + * @throws IllegalStateException if called in an invalid state. + * + * @see android.media.MediaPlayer2#getTrackInfo + */ + public abstract void selectTrack(int index); + + /** + * Deselect a track. + * <p> + * Currently, the track must be a timed text track and no audio or video tracks can be + * deselected. If the timed text track identified by index has not been + * selected before, it throws an exception. + * </p> + * @param index the index of the track to be deselected. The valid range of the index + * is 0..total number of tracks - 1. The total number of tracks as well as the type of + * each individual track can be found by calling {@link #getTrackInfo()} method. + * @throws IllegalStateException if called in an invalid state. + * + * @see android.media.MediaPlayer2#getTrackInfo + */ + public abstract void deselectTrack(int index); + + /** + * Sets the target UDP re-transmit endpoint for the low level player. + * Generally, the address portion of the endpoint is an IP multicast + * address, although a unicast address would be equally valid. When a valid + * retransmit endpoint has been set, the media player will not decode and + * render the media presentation locally. Instead, the player will attempt + * to re-multiplex its media data using the Android@Home RTP profile and + * re-transmit to the target endpoint. Receiver devices (which may be + * either the same as the transmitting device or different devices) may + * instantiate, prepare, and start a receiver player using a setDataSource + * URL of the form... + * + * aahRX://<multicastIP>:<port> + * + * to receive, decode and render the re-transmitted content. + * + * setRetransmitEndpoint may only be called before setDataSource has been + * called; while the player is in the Idle state. + * + * @param endpoint the address and UDP port of the re-transmission target or + * null if no re-transmission is to be performed. + * @throws IllegalStateException if it is called in an invalid state + * @throws IllegalArgumentException if the retransmit endpoint is supplied, + * but invalid. + * + * {@hide} pending API council + */ + public void setRetransmitEndpoint(InetSocketAddress endpoint) { } + + /** + * Releases the resources held by this {@code MediaPlayer2} object. + * + * It is considered good practice to call this method when you're + * done using the MediaPlayer2. In particular, whenever an Activity + * of an application is paused (its onPause() method is called), + * or stopped (its onStop() method is called), this method should be + * invoked to release the MediaPlayer2 object, unless the application + * has a special need to keep the object around. In addition to + * unnecessary resources (such as memory and instances of codecs) + * being held, failure to call this method immediately if a + * MediaPlayer2 object is no longer needed may also lead to + * continuous battery consumption for mobile devices, and playback + * failure for other applications if no multiple instances of the + * same codec are supported on a device. Even if multiple instances + * of the same codec are supported, some performance degradation + * may be expected when unnecessary multiple instances are used + * at the same time. + * + * {@code close()} may be safely called after a prior {@code close()}. + * This class implements the Java {@code AutoCloseable} interface and + * may be used with try-with-resources. + */ + @Override + public abstract void close(); + + /** @hide */ + public MediaTimeProvider getMediaTimeProvider() { + return null; + } + + /** + * Interface definition for callbacks to be invoked when the player has the corresponding + * events. + */ + public abstract static class EventCallback { + /** + * Called to update status in buffering a media source received through + * progressive downloading. The received buffering percentage + * indicates how much of the content has been buffered or played. + * For example a buffering update of 80 percent when half the content + * has already been played indicates that the next 30 percent of the + * content to play has been buffered. + * + * @param mp the MediaPlayer2 the update pertains to + * @param srcId the Id of this data source + * @param percent the percentage (0-100) of the content + * that has been buffered or played thus far + */ + public void onBufferingUpdate(MediaPlayer2 mp, long srcId, int percent) { } + + /** + * Called to indicate the video size + * + * The video size (width and height) could be 0 if there was no video, + * no display surface was set, or the value was not determined yet. + * + * @param mp the MediaPlayer2 associated with this callback + * @param srcId the Id of this data source + * @param width the width of the video + * @param height the height of the video + */ + public void onVideoSizeChanged(MediaPlayer2 mp, long srcId, int width, int height) { } + + /** + * Called to indicate an avaliable timed text + * + * @param mp the MediaPlayer2 associated with this callback + * @param srcId the Id of this data source + * @param text the timed text sample which contains the text + * needed to be displayed and the display format. + * @hide + */ + public void onTimedText(MediaPlayer2 mp, long srcId, TimedText text) { } + + /** + * Called to indicate avaliable timed metadata + * <p> + * This method will be called as timed metadata is extracted from the media, + * in the same order as it occurs in the media. The timing of this event is + * not controlled by the associated timestamp. + * <p> + * Currently only HTTP live streaming data URI's embedded with timed ID3 tags generates + * {@link TimedMetaData}. + * + * @see MediaPlayer2#selectTrack(int) + * @see MediaPlayer2.OnTimedMetaDataAvailableListener + * @see TimedMetaData + * + * @param mp the MediaPlayer2 associated with this callback + * @param srcId the Id of this data source + * @param data the timed metadata sample associated with this event + */ + public void onTimedMetaDataAvailable(MediaPlayer2 mp, long srcId, TimedMetaData data) { } + + /** + * Called to indicate an error. + * + * @param mp the MediaPlayer2 the error pertains to + * @param srcId the Id of this data source + * @param what the type of error that has occurred: + * <ul> + * <li>{@link #MEDIA_ERROR_UNKNOWN} + * </ul> + * @param extra an extra code, specific to the error. Typically + * implementation dependent. + * <ul> + * <li>{@link #MEDIA_ERROR_IO} + * <li>{@link #MEDIA_ERROR_MALFORMED} + * <li>{@link #MEDIA_ERROR_UNSUPPORTED} + * <li>{@link #MEDIA_ERROR_TIMED_OUT} + * <li><code>MEDIA_ERROR_SYSTEM (-2147483648)</code> - low-level system error. + * </ul> + */ + public void onError(MediaPlayer2 mp, long srcId, int what, int extra) { } + + /** + * Called to indicate an info or a warning. + * + * @param mp the MediaPlayer2 the info pertains to. + * @param srcId the Id of this data source + * @param what the type of info or warning. + * <ul> + * <li>{@link #MEDIA_INFO_UNKNOWN} + * <li>{@link #MEDIA_INFO_STARTED_AS_NEXT} + * <li>{@link #MEDIA_INFO_VIDEO_RENDERING_START} + * <li>{@link #MEDIA_INFO_AUDIO_RENDERING_START} + * <li>{@link #MEDIA_INFO_PLAYBACK_COMPLETE} + * <li>{@link #MEDIA_INFO_PLAYLIST_END} + * <li>{@link #MEDIA_INFO_PREPARED} + * <li>{@link #MEDIA_INFO_COMPLETE_CALL_PLAY} + * <li>{@link #MEDIA_INFO_COMPLETE_CALL_PAUSE} + * <li>{@link #MEDIA_INFO_COMPLETE_CALL_SEEK} + * <li>{@link #MEDIA_INFO_VIDEO_TRACK_LAGGING} + * <li>{@link #MEDIA_INFO_BUFFERING_START} + * <li>{@link #MEDIA_INFO_BUFFERING_END} + * <li><code>MEDIA_INFO_NETWORK_BANDWIDTH (703)</code> - + * bandwidth information is available (as <code>extra</code> kbps) + * <li>{@link #MEDIA_INFO_BAD_INTERLEAVING} + * <li>{@link #MEDIA_INFO_NOT_SEEKABLE} + * <li>{@link #MEDIA_INFO_METADATA_UPDATE} + * <li>{@link #MEDIA_INFO_UNSUPPORTED_SUBTITLE} + * <li>{@link #MEDIA_INFO_SUBTITLE_TIMED_OUT} + * </ul> + * @param extra an extra code, specific to the info. Typically + * implementation dependent. + */ + public void onInfo(MediaPlayer2 mp, long srcId, int what, int extra) { } + } + + /** + * Register a callback to be invoked when the media source is ready + * for playback. + * + * @param eventCallback the callback that will be run + * @param executor the executor through which the callback should be invoked + */ + public abstract void registerEventCallback(@NonNull @CallbackExecutor Executor executor, + @NonNull EventCallback eventCallback); + + /** + * Unregisters an {@link EventCallback}. + * + * @param callback an {@link EventCallback} to unregister + */ + public abstract void unregisterEventCallback(EventCallback callback); + + /** + * Interface definition of a callback to be invoked when a + * track has data available. + * + * @hide + */ + public interface OnSubtitleDataListener + { + public void onSubtitleData(MediaPlayer2 mp, SubtitleData data); + } + + /** + * Register a callback to be invoked when a track has data available. + * + * @param listener the callback that will be run + * + * @hide + */ + public void setOnSubtitleDataListener(OnSubtitleDataListener listener) { } + + + /* Do not change these values without updating their counterparts + * in include/media/mediaplayer2.h! + */ + /** Unspecified media player error. + * @see android.media.MediaPlayer2.EventCallback.onError + */ + public static final int MEDIA_ERROR_UNKNOWN = 1; + + /** The video is streamed and its container is not valid for progressive + * playback i.e the video's index (e.g moov atom) is not at the start of the + * file. + * @see android.media.MediaPlayer2.EventCallback.onError + */ + public static final int MEDIA_ERROR_NOT_VALID_FOR_PROGRESSIVE_PLAYBACK = 200; + + /** File or network related operation errors. */ + public static final int MEDIA_ERROR_IO = -1004; + /** Bitstream is not conforming to the related coding standard or file spec. */ + public static final int MEDIA_ERROR_MALFORMED = -1007; + /** Bitstream is conforming to the related coding standard or file spec, but + * the media framework does not support the feature. */ + public static final int MEDIA_ERROR_UNSUPPORTED = -1010; + /** Some operation takes too long to complete, usually more than 3-5 seconds. */ + public static final int MEDIA_ERROR_TIMED_OUT = -110; + + /** Unspecified low-level system error. This value originated from UNKNOWN_ERROR in + * system/core/include/utils/Errors.h + * @see android.media.MediaPlayer2.EventCallback.onError + * @hide + */ + public static final int MEDIA_ERROR_SYSTEM = -2147483648; + + + /* Do not change these values without updating their counterparts + * in include/media/mediaplayer2.h! + */ + /** Unspecified media player info. + * @see android.media.MediaPlayer2.EventCallback.onInfo + */ + public static final int MEDIA_INFO_UNKNOWN = 1; + + /** The player switched to this datas source because it is the + * next-to-be-played in the play list. + * @see android.media.MediaPlayer2.EventCallback.onInfo + */ + public static final int MEDIA_INFO_STARTED_AS_NEXT = 2; + + /** The player just pushed the very first video frame for rendering. + * @see android.media.MediaPlayer2.EventCallback.onInfo + */ + public static final int MEDIA_INFO_VIDEO_RENDERING_START = 3; + + /** The player just rendered the very first audio sample. + * @see android.media.MediaPlayer2.EventCallback.onInfo + */ + public static final int MEDIA_INFO_AUDIO_RENDERING_START = 4; + + /** The player just completed the playback of this data source. + * @see android.media.MediaPlayer2.EventCallback.onInfo + */ + public static final int MEDIA_INFO_PLAYBACK_COMPLETE = 5; + + /** The player just completed the playback of the full play list. + * @see android.media.MediaPlayer2.EventCallback.onInfo + */ + public static final int MEDIA_INFO_PLAYLIST_END = 6; + + /** The player just prepared a data source. + * This also serves as call completion notification for {@link #prepareAsync()}. + * @see android.media.MediaPlayer2.EventCallback.onInfo + */ + public static final int MEDIA_INFO_PREPARED = 100; + + /** The player just completed a call {@link #play()}. + * @see android.media.MediaPlayer2.EventCallback.onInfo + */ + public static final int MEDIA_INFO_COMPLETE_CALL_PLAY = 101; + + /** The player just completed a call {@link #pause()}. + * @see android.media.MediaPlayer2.EventCallback.onInfo + */ + public static final int MEDIA_INFO_COMPLETE_CALL_PAUSE = 102; + + /** The player just completed a call {@link #seekTo(long, int)}. + * @see android.media.MediaPlayer2.EventCallback.onInfo + */ + public static final int MEDIA_INFO_COMPLETE_CALL_SEEK = 103; + + /** The video is too complex for the decoder: it can't decode frames fast + * enough. Possibly only the audio plays fine at this stage. + * @see android.media.MediaPlayer2.EventCallback.onInfo + */ + public static final int MEDIA_INFO_VIDEO_TRACK_LAGGING = 700; + + /** MediaPlayer2 is temporarily pausing playback internally in order to + * buffer more data. + * @see android.media.MediaPlayer2.EventCallback.onInfo + */ + public static final int MEDIA_INFO_BUFFERING_START = 701; + + /** MediaPlayer2 is resuming playback after filling buffers. + * @see android.media.MediaPlayer2.EventCallback.onInfo + */ + public static final int MEDIA_INFO_BUFFERING_END = 702; + + /** Estimated network bandwidth information (kbps) is available; currently this event fires + * simultaneously as {@link #MEDIA_INFO_BUFFERING_START} and {@link #MEDIA_INFO_BUFFERING_END} + * when playing network files. + * @see android.media.MediaPlayer2.EventCallback.onInfo + * @hide + */ + public static final int MEDIA_INFO_NETWORK_BANDWIDTH = 703; + + /** Bad interleaving means that a media has been improperly interleaved or + * not interleaved at all, e.g has all the video samples first then all the + * audio ones. Video is playing but a lot of disk seeks may be happening. + * @see android.media.MediaPlayer2.EventCallback.onInfo + */ + public static final int MEDIA_INFO_BAD_INTERLEAVING = 800; + + /** The media cannot be seeked (e.g live stream) + * @see android.media.MediaPlayer2.EventCallback.onInfo + */ + public static final int MEDIA_INFO_NOT_SEEKABLE = 801; + + /** A new set of metadata is available. + * @see android.media.MediaPlayer2.EventCallback.onInfo + */ + public static final int MEDIA_INFO_METADATA_UPDATE = 802; + + /** A new set of external-only metadata is available. Used by + * JAVA framework to avoid triggering track scanning. + * @hide + */ + public static final int MEDIA_INFO_EXTERNAL_METADATA_UPDATE = 803; + + /** Informs that audio is not playing. Note that playback of the video + * is not interrupted. + * @see android.media.MediaPlayer2.EventCallback.onInfo + */ + public static final int MEDIA_INFO_AUDIO_NOT_PLAYING = 804; + + /** Informs that video is not playing. Note that playback of the audio + * is not interrupted. + * @see android.media.MediaPlayer2.EventCallback.onInfo + */ + public static final int MEDIA_INFO_VIDEO_NOT_PLAYING = 805; + + /** Failed to handle timed text track properly. + * @see android.media.MediaPlayer2.EventCallback.onInfo + * + * {@hide} + */ + public static final int MEDIA_INFO_TIMED_TEXT_ERROR = 900; + + /** Subtitle track was not supported by the media framework. + * @see android.media.MediaPlayer2.EventCallback.onInfo + */ + public static final int MEDIA_INFO_UNSUPPORTED_SUBTITLE = 901; + + /** Reading the subtitle track takes too long. + * @see android.media.MediaPlayer2.EventCallback.onInfo + */ + public static final int MEDIA_INFO_SUBTITLE_TIMED_OUT = 902; + + + // Modular DRM begin + + /** + * Interface definition of a callback to be invoked when the app + * can do DRM configuration (get/set properties) before the session + * is opened. This facilitates configuration of the properties, like + * 'securityLevel', which has to be set after DRM scheme creation but + * before the DRM session is opened. + * + * The only allowed DRM calls in this listener are {@code getDrmPropertyString} + * and {@code setDrmPropertyString}. + */ + public interface OnDrmConfigHelper + { + /** + * Called to give the app the opportunity to configure DRM before the session is created + * + * @param mp the {@code MediaPlayer2} associated with this callback + */ + public void onDrmConfig(MediaPlayer2 mp); + } + + /** + * Register a callback to be invoked for configuration of the DRM object before + * the session is created. + * The callback will be invoked synchronously during the execution + * of {@link #prepareDrm(UUID uuid)}. + * + * @param listener the callback that will be run + */ + public abstract void setOnDrmConfigHelper(OnDrmConfigHelper listener); + + /** + * Interface definition for callbacks to be invoked when the player has the corresponding + * DRM events. + */ + public abstract static class DrmEventCallback { + /** + * Called to indicate DRM info is available + * + * @param mp the {@code MediaPlayer2} associated with this callback + * @param drmInfo DRM info of the source including PSSH, and subset + * of crypto schemes supported by this device + */ + public void onDrmInfo(MediaPlayer2 mp, DrmInfo drmInfo) { } + + /** + * Called to notify the client that {@code prepareDrm} is finished and ready for key request/response. + * + * @param mp the {@code MediaPlayer2} associated with this callback + * @param status the result of DRM preparation which can be + * {@link #PREPARE_DRM_STATUS_SUCCESS}, + * {@link #PREPARE_DRM_STATUS_PROVISIONING_NETWORK_ERROR}, + * {@link #PREPARE_DRM_STATUS_PROVISIONING_SERVER_ERROR}, or + * {@link #PREPARE_DRM_STATUS_PREPARATION_ERROR}. + */ + public void onDrmPrepared(MediaPlayer2 mp, @PrepareDrmStatusCode int status) { } + + } + + /** + * Register a callback to be invoked when the media source is ready + * for playback. + * + * @param eventCallback the callback that will be run + * @param executor the executor through which the callback should be invoked + */ + public abstract void registerDrmEventCallback(@NonNull @CallbackExecutor Executor executor, + @NonNull DrmEventCallback eventCallback); + + /** + * Unregisters a {@link DrmEventCallback}. + * + * @param callback a {@link DrmEventCallback} to unregister + */ + public abstract void unregisterDrmEventCallback(DrmEventCallback callback); + + /** + * The status codes for {@link DrmEventCallback#onDrmPrepared} listener. + * <p> + * + * DRM preparation has succeeded. + */ + public static final int PREPARE_DRM_STATUS_SUCCESS = 0; + + /** + * The device required DRM provisioning but couldn't reach the provisioning server. + */ + public static final int PREPARE_DRM_STATUS_PROVISIONING_NETWORK_ERROR = 1; + + /** + * The device required DRM provisioning but the provisioning server denied the request. + */ + public static final int PREPARE_DRM_STATUS_PROVISIONING_SERVER_ERROR = 2; + + /** + * The DRM preparation has failed . + */ + public static final int PREPARE_DRM_STATUS_PREPARATION_ERROR = 3; + + + /** @hide */ + @IntDef({ + PREPARE_DRM_STATUS_SUCCESS, + PREPARE_DRM_STATUS_PROVISIONING_NETWORK_ERROR, + PREPARE_DRM_STATUS_PROVISIONING_SERVER_ERROR, + PREPARE_DRM_STATUS_PREPARATION_ERROR, + }) + @Retention(RetentionPolicy.SOURCE) + public @interface PrepareDrmStatusCode {} + + /** + * Retrieves the DRM Info associated with the current source + * + * @throws IllegalStateException if called before being prepared + */ + public abstract DrmInfo getDrmInfo(); + + /** + * Prepares the DRM for the current source + * <p> + * If {@code OnDrmConfigHelper} is registered, it will be called during + * preparation to allow configuration of the DRM properties before opening the + * DRM session. Note that the callback is called synchronously in the thread that called + * {@code prepareDrm}. It should be used only for a series of {@code getDrmPropertyString} + * and {@code setDrmPropertyString} calls and refrain from any lengthy operation. + * <p> + * If the device has not been provisioned before, this call also provisions the device + * which involves accessing the provisioning server and can take a variable time to + * complete depending on the network connectivity. + * If {@code OnDrmPreparedListener} is registered, prepareDrm() runs in non-blocking + * mode by launching the provisioning in the background and returning. The listener + * will be called when provisioning and preparation has finished. If a + * {@code OnDrmPreparedListener} is not registered, prepareDrm() waits till provisioning + * and preparation has finished, i.e., runs in blocking mode. + * <p> + * If {@code OnDrmPreparedListener} is registered, it is called to indicate the DRM + * session being ready. The application should not make any assumption about its call + * sequence (e.g., before or after prepareDrm returns), or the thread context that will + * execute the listener (unless the listener is registered with a handler thread). + * <p> + * + * @param uuid The UUID of the crypto scheme. If not known beforehand, it can be retrieved + * from the source through {@code getDrmInfo} or registering a {@code onDrmInfoListener}. + * + * @throws IllegalStateException if called before being prepared or the DRM was + * prepared already + * @throws UnsupportedSchemeException if the crypto scheme is not supported + * @throws ResourceBusyException if required DRM resources are in use + * @throws ProvisioningNetworkErrorException if provisioning is required but failed due to a + * network error + * @throws ProvisioningServerErrorException if provisioning is required but failed due to + * the request denied by the provisioning server + */ + public abstract void prepareDrm(@NonNull UUID uuid) + throws UnsupportedSchemeException, ResourceBusyException, + ProvisioningNetworkErrorException, ProvisioningServerErrorException; + + /** + * Releases the DRM session + * <p> + * The player has to have an active DRM session and be in stopped, or prepared + * state before this call is made. + * A {@code reset()} call will release the DRM session implicitly. + * + * @throws NoDrmSchemeException if there is no active DRM session to release + */ + public abstract void releaseDrm() throws NoDrmSchemeException; + + /** + * A key request/response exchange occurs between the app and a license server + * to obtain or release keys used to decrypt encrypted content. + * <p> + * getKeyRequest() is used to obtain an opaque key request byte array that is + * delivered to the license server. The opaque key request byte array is returned + * in KeyRequest.data. The recommended URL to deliver the key request to is + * returned in KeyRequest.defaultUrl. + * <p> + * After the app has received the key request response from the server, + * it should deliver to the response to the DRM engine plugin using the method + * {@link #provideKeyResponse}. + * + * @param keySetId is the key-set identifier of the offline keys being released when keyType is + * {@link MediaDrm#KEY_TYPE_RELEASE}. It should be set to null for other key requests, when + * keyType is {@link MediaDrm#KEY_TYPE_STREAMING} or {@link MediaDrm#KEY_TYPE_OFFLINE}. + * + * @param initData is the container-specific initialization data when the keyType is + * {@link MediaDrm#KEY_TYPE_STREAMING} or {@link MediaDrm#KEY_TYPE_OFFLINE}. Its meaning is + * interpreted based on the mime type provided in the mimeType parameter. It could + * contain, for example, the content ID, key ID or other data obtained from the content + * metadata that is required in generating the key request. + * When the keyType is {@link MediaDrm#KEY_TYPE_RELEASE}, it should be set to null. + * + * @param mimeType identifies the mime type of the content + * + * @param keyType specifies the type of the request. The request may be to acquire + * keys for streaming, {@link MediaDrm#KEY_TYPE_STREAMING}, or for offline content + * {@link MediaDrm#KEY_TYPE_OFFLINE}, or to release previously acquired + * keys ({@link MediaDrm#KEY_TYPE_RELEASE}), which are identified by a keySetId. + * + * @param optionalParameters are included in the key request message to + * allow a client application to provide additional message parameters to the server. + * This may be {@code null} if no additional parameters are to be sent. + * + * @throws NoDrmSchemeException if there is no active DRM session + */ + @NonNull + public abstract MediaDrm.KeyRequest getKeyRequest(@Nullable byte[] keySetId, @Nullable byte[] initData, + @Nullable String mimeType, @MediaDrm.KeyType int keyType, + @Nullable Map<String, String> optionalParameters) + throws NoDrmSchemeException; + + /** + * A key response is received from the license server by the app, then it is + * provided to the DRM engine plugin using provideKeyResponse. When the + * response is for an offline key request, a key-set identifier is returned that + * can be used to later restore the keys to a new session with the method + * {@ link # restoreKeys}. + * When the response is for a streaming or release request, null is returned. + * + * @param keySetId When the response is for a release request, keySetId identifies + * the saved key associated with the release request (i.e., the same keySetId + * passed to the earlier {@ link # getKeyRequest} call. It MUST be null when the + * response is for either streaming or offline key requests. + * + * @param response the byte array response from the server + * + * @throws NoDrmSchemeException if there is no active DRM session + * @throws DeniedByServerException if the response indicates that the + * server rejected the request + */ + public abstract byte[] provideKeyResponse(@Nullable byte[] keySetId, @NonNull byte[] response) + throws NoDrmSchemeException, DeniedByServerException; + + /** + * Restore persisted offline keys into a new session. keySetId identifies the + * keys to load, obtained from a prior call to {@link #provideKeyResponse}. + * + * @param keySetId identifies the saved key set to restore + */ + public abstract void restoreKeys(@NonNull byte[] keySetId) + throws NoDrmSchemeException; + + /** + * Read a DRM engine plugin String property value, given the property name string. + * <p> + * @param propertyName the property name + * + * Standard fields names are: + * {@link MediaDrm#PROPERTY_VENDOR}, {@link MediaDrm#PROPERTY_VERSION}, + * {@link MediaDrm#PROPERTY_DESCRIPTION}, {@link MediaDrm#PROPERTY_ALGORITHMS} + */ + @NonNull + public abstract String getDrmPropertyString(@NonNull @MediaDrm.StringProperty String propertyName) + throws NoDrmSchemeException; + + /** + * Set a DRM engine plugin String property value. + * <p> + * @param propertyName the property name + * @param value the property value + * + * Standard fields names are: + * {@link MediaDrm#PROPERTY_VENDOR}, {@link MediaDrm#PROPERTY_VERSION}, + * {@link MediaDrm#PROPERTY_DESCRIPTION}, {@link MediaDrm#PROPERTY_ALGORITHMS} + */ + public abstract void setDrmPropertyString(@NonNull @MediaDrm.StringProperty String propertyName, + @NonNull String value) + throws NoDrmSchemeException; + + /** + * Encapsulates the DRM properties of the source. + */ + public abstract static class DrmInfo { + /** + * Returns the PSSH info of the data source for each supported DRM scheme. + */ + public abstract Map<UUID, byte[]> getPssh(); + + /** + * Returns the intersection of the data source and the device DRM schemes. + * It effectively identifies the subset of the source's DRM schemes which + * are supported by the device too. + */ + public abstract List<UUID> getSupportedSchemes(); + }; // DrmInfo + + /** + * Thrown when a DRM method is called before preparing a DRM scheme through prepareDrm(). + * Extends MediaDrm.MediaDrmException + */ + public abstract static class NoDrmSchemeException extends MediaDrmException { + protected NoDrmSchemeException(String detailMessage) { + super(detailMessage); + } + } + + /** + * Thrown when the device requires DRM provisioning but the provisioning attempt has + * failed due to a network error (Internet reachability, timeout, etc.). + * Extends MediaDrm.MediaDrmException + */ + public abstract static class ProvisioningNetworkErrorException extends MediaDrmException { + protected ProvisioningNetworkErrorException(String detailMessage) { + super(detailMessage); + } + } + + /** + * Thrown when the device requires DRM provisioning but the provisioning attempt has + * failed due to the provisioning server denying the request. + * Extends MediaDrm.MediaDrmException + */ + public abstract static class ProvisioningServerErrorException extends MediaDrmException { + protected ProvisioningServerErrorException(String detailMessage) { + super(detailMessage); + } + } + + public static final class MetricsConstants { + private MetricsConstants() {} + + /** + * Key to extract the MIME type of the video track + * from the {@link MediaPlayer2#getMetrics} return value. + * The value is a String. + */ + public static final String MIME_TYPE_VIDEO = "android.media.mediaplayer.video.mime"; + + /** + * Key to extract the codec being used to decode the video track + * from the {@link MediaPlayer2#getMetrics} return value. + * The value is a String. + */ + public static final String CODEC_VIDEO = "android.media.mediaplayer.video.codec"; + + /** + * Key to extract the width (in pixels) of the video track + * from the {@link MediaPlayer2#getMetrics} return value. + * The value is an integer. + */ + public static final String WIDTH = "android.media.mediaplayer.width"; + + /** + * Key to extract the height (in pixels) of the video track + * from the {@link MediaPlayer2#getMetrics} return value. + * The value is an integer. + */ + public static final String HEIGHT = "android.media.mediaplayer.height"; + + /** + * Key to extract the count of video frames played + * from the {@link MediaPlayer2#getMetrics} return value. + * The value is an integer. + */ + public static final String FRAMES = "android.media.mediaplayer.frames"; + + /** + * Key to extract the count of video frames dropped + * from the {@link MediaPlayer2#getMetrics} return value. + * The value is an integer. + */ + public static final String FRAMES_DROPPED = "android.media.mediaplayer.dropped"; + + /** + * Key to extract the MIME type of the audio track + * from the {@link MediaPlayer2#getMetrics} return value. + * The value is a String. + */ + public static final String MIME_TYPE_AUDIO = "android.media.mediaplayer.audio.mime"; + + /** + * Key to extract the codec being used to decode the audio track + * from the {@link MediaPlayer2#getMetrics} return value. + * The value is a String. + */ + public static final String CODEC_AUDIO = "android.media.mediaplayer.audio.codec"; + + /** + * Key to extract the duration (in milliseconds) of the + * media being played + * from the {@link MediaPlayer2#getMetrics} return value. + * The value is a long. + */ + public static final String DURATION = "android.media.mediaplayer.durationMs"; + + /** + * Key to extract the playing time (in milliseconds) of the + * media being played + * from the {@link MediaPlayer2#getMetrics} return value. + * The value is a long. + */ + public static final String PLAYING = "android.media.mediaplayer.playingMs"; + + /** + * Key to extract the count of errors encountered while + * playing the media + * from the {@link MediaPlayer2#getMetrics} return value. + * The value is an integer. + */ + public static final String ERRORS = "android.media.mediaplayer.err"; + + /** + * Key to extract an (optional) error code detected while + * playing the media + * from the {@link MediaPlayer2#getMetrics} return value. + * The value is an integer. + */ + public static final String ERROR_CODE = "android.media.mediaplayer.errcode"; + + } +} |