wseemann.media
Class FFmpegMediaPlayer

java.lang.Object
  wseemann.media.FFmpegMediaPlayer

public class FFmpegMediaPlayer
extends java.lang.Object

MediaPlayer 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 android.widget.VideoView.

Topics covered here are:

1. State Diagram
2. Valid and Invalid States
3. Permissions
4. Register informational and error callbacks

Developer Guides

For more information about how to use MediaPlayer, read the Media Playback developer guide.

State Diagram

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 MediaPlayer object driven by the supported playback control operations. The ovals represent the states a MediaPlayer 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.

From this state diagram, one can see that a MediaPlayer object has the following states:

• When a MediaPlayer object is just created using new or after reset() is called, it is in the Idle state; and after release() is called, it is in the End state. Between these two states is the life cycle of the MediaPlayer object.
  • There is a subtle but important difference between a newly constructed MediaPlayer object and the MediaPlayer object after reset() is called. It is a programming error to invoke methods such as getCurrentPosition(), getDuration(), getVideoHeight(), getVideoWidth(), setAudioStreamType(int), setLooping(boolean), setVolume(float, float), pause(), start(), stop(), seekTo(int), prepare() or prepareAsync() in the Idle state for both cases. If any of these methods is called right after a MediaPlayer 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 reset(), the user supplied callback method OnErrorListener.onError() will be invoked by the internal player engine and the object will be transfered to the Error state.
  • It is also recommended that once a MediaPlayer object is no longer being used, call release() immediately so that resources used by the internal player engine associated with the MediaPlayer object can be released immediately. Resource may include singleton resources such as hardware acceleration components and failure to call release() may cause subsequent instances of MediaPlayer objects to fallback to software implementations or fail altogether. Once the MediaPlayer object is in the End state, it can no longer be used and there is no way to bring it back to any other state.
  • Furthermore, the MediaPlayer objects created using new is in the Idle state, while those created with one of the overloaded convenient create methods are NOT in the Idle state. In fact, the objects are in the Prepared state if the creation using create method is successful.
• 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 OnErrorListener.onError() method if an OnErrorListener has been registered beforehand via #setOnErrorListener(android.media.MediaPlayer.OnErrorListener).
  • It is important to note that once an error occurs, the MediaPlayer object enters the Error state (except as noted above), even if an error listener has not been registered by the application.
  • In order to reuse a MediaPlayer object that is in the Error state and recover from the error, reset() can be called to restore the object to its Idle state.
  • It is good programming practice to have your application register a OnErrorListener to look out for error notifications from the internal player engine.
  • IllegalStateException is thrown to prevent programming errors such as calling prepare(), prepareAsync(), or one of the overloaded setDataSource methods in an invalid state.
• Calling setDataSource(FileDescriptor), or setDataSource(String), or setDataSource(Context, Uri), or setDataSource(FileDescriptor, long, long) transfers a MediaPlayer object in the Idle state to the Initialized state.
  • An IllegalStateException is thrown if setDataSource() is called in any other state.
  • It is good programming practice to always look out for IllegalArgumentException and IOException that may be thrown from the overloaded setDataSource methods.
• A MediaPlayer object must first enter the Prepared state before playback can be started.
  • There are two ways (synchronous vs. asynchronous) that the Prepared state can be reached: either a call to prepare() (synchronous) which transfers the object to the Prepared state once the method call returns, or a call to prepareAsync() (asynchronous) which first transfers the object to the Preparing 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 or when prepare() call returns, the internal player engine then calls a user supplied callback method, onPrepared() of the OnPreparedListener interface, if an OnPreparedListener is registered beforehand via #setOnPreparedListener(android.media.MediaPlayer.OnPreparedListener).
  • It is important to note that the Preparing state is a transient state, and the behavior of calling any method with side effect while a MediaPlayer object is in the Preparing state is undefined.
  • An IllegalStateException is thrown if prepare() or prepareAsync() is called in any other state.
  • While in the Prepared state, properties such as audio/sound volume, screenOnWhilePlaying, looping can be adjusted by invoking the corresponding set methods.
• To start the playback, start() must be called. After start() returns successfully, the MediaPlayer object is in the Started state. isPlaying() can be called to test whether the MediaPlayer object is in the Started state.
  • While in the Started state, the internal player engine calls a user supplied OnBufferingUpdateListener.onBufferingUpdate() callback method if a OnBufferingUpdateListener has been registered beforehand via setOnBufferingUpdateListener(OnBufferingUpdateListener). This callback allows applications to keep track of the buffering status while streaming audio/video.
  • Calling start() has not effect on a MediaPlayer object that is already in the Started state.
• Playback can be paused and stopped, and the current playback position can be adjusted. Playback can be paused via pause(). When the call to pause() returns, the MediaPlayer object enters the Paused state. Note that the transition from the Started state to the Paused state and vice versa happens asynchronously in the player engine. It may take some time before the state is updated in calls to isPlaying(), and it can be a number of seconds in the case of streamed content.
  • Calling start() to resume playback for a paused MediaPlayer object, and the resumed playback position is the same as where it was paused. When the call to start() returns, the paused MediaPlayer object goes back to the Started state.
  • Calling pause() has no effect on a MediaPlayer object that is already in the Paused state.
• Calling stop() stops playback and causes a MediaPlayer in the Started, Paused, Prepared or PlaybackCompleted state to enter the Stopped state.
  • Once in the Stopped state, playback cannot be started until prepare() or prepareAsync() are called to set the MediaPlayer object to the Prepared state again.
  • Calling stop() has no effect on a MediaPlayer object that is already in the Stopped state.
• The playback position can be adjusted with a call to seekTo(int).
  • Although the asynchronuous seekTo(int) call returns right way, 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 OnSeekComplete.onSeekComplete() if an OnSeekCompleteListener has been registered beforehand via setOnSeekCompleteListener(OnSeekCompleteListener).
  • Please note that seekTo(int) can also be called in the other states, such as Prepared, Paused and PlaybackCompleted state.
  • Furthermore, the actual current playback position can be retrieved with a call to getCurrentPosition(), which is helpful for applications such as a Music player that need to keep track of the playback progress.
• When the playback reaches the end of stream, the playback completes.
  • If the looping mode was being set to truewith setLooping(boolean), the MediaPlayer object shall remain in the Started state.
  • If the looping mode was set to false , the player engine calls a user supplied callback method, OnCompletion.onCompletion(), if a OnCompletionListener is registered beforehand via setOnCompletionListener(OnCompletionListener). The invoke of the callback signals that the object is now in the PlaybackCompleted state.
  • While in the PlaybackCompleted state, calling start() can restart the playback from the beginning of the audio/video source.

  Valid and invalid states

  Method Name	Valid Sates	Invalid States	Comments
  attachAuxEffect	{Initialized, Prepared, Started, Paused, Stopped, PlaybackCompleted}	{Idle, Error}	This method must be called after setDataSource. Calling it does not change the object state.
  getAudioSessionId	any	{}	This method can be called in any state and calling it does not change the object state.
  getCurrentPosition	{Idle, Initialized, Prepared, Started, Paused, Stopped, PlaybackCompleted}	{Error}	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 Error state.
  getDuration	{Prepared, Started, Paused, Stopped, PlaybackCompleted}	{Idle, Initialized, Error}	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 Error state.
  getVideoHeight	{Idle, Initialized, Prepared, Started, Paused, Stopped, PlaybackCompleted}	{Error}	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 Error state.
  getVideoWidth	{Idle, Initialized, Prepared, Started, Paused, Stopped, PlaybackCompleted}	{Error}	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 Error state.
  isPlaying	{Idle, Initialized, Prepared, Started, Paused, Stopped, PlaybackCompleted}	{Error}	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 Error state.
  pause	{Started, Paused}	{Idle, Initialized, Prepared, Stopped, PlaybackCompleted, Error}	Successful invoke of this method in a valid state transfers the object to the Paused state. Calling this method in an invalid state transfers the object to the Error state.
  prepare	{Initialized, Stopped}	{Idle, Prepared, Started, Paused, PlaybackCompleted, Error}	Successful invoke of this method in a valid state transfers the object to the Prepared state. Calling this method in an invalid state throws an IllegalStateException.
  prepareAsync	{Initialized, Stopped}	{Idle, Prepared, Started, Paused, PlaybackCompleted, Error}	Successful invoke of this method in a valid state transfers the object to the Preparing state. Calling this method in an invalid state throws an IllegalStateException.
  release	any	{}	After release(), the object is no longer available.
  reset	{Idle, Initialized, Prepared, Started, Paused, Stopped, PlaybackCompleted, Error}	{}	After reset(), the object is like being just created.
  seekTo	{Prepared, Started, Paused, PlaybackCompleted}	{Idle, Initialized, Stopped, Error}	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 Error state.
  setAudioSessionId	{Idle}	{Initialized, Prepared, Started, Paused, Stopped, PlaybackCompleted, Error}	This method must be called in idle state as the audio session ID must be known before calling setDataSource. Calling it does not change the object state.
  setAudioStreamType	{Idle, Initialized, Stopped, Prepared, Started, Paused, PlaybackCompleted}	{Error}	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 prepare() or prepareAsync().
  setAuxEffectSendLevel	any	{}	Calling this method does not change the object state.
  setDataSource	{Idle}	{Initialized, Prepared, Started, Paused, Stopped, PlaybackCompleted, Error}	Successful invoke of this method in a valid state transfers the object to the Initialized state. Calling this method in an invalid state throws an IllegalStateException.
  setDisplay	any	{}	This method can be called in any state and calling it does not change the object state.
  setSurface	any	{}	This method can be called in any state and calling it does not change the object state.
  setLooping	{Idle, Initialized, Stopped, Prepared, Started, Paused, PlaybackCompleted}	{Error}	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 Error state.
  isLooping	any	{}	This method can be called in any state and calling it does not change the object state.
  setOnBufferingUpdateListener	any	{}	This method can be called in any state and calling it does not change the object state.
  setOnCompletionListener	any	{}	This method can be called in any state and calling it does not change the object state.
  setOnErrorListener	any	{}	This method can be called in any state and calling it does not change the object state.
  setOnPreparedListener	any	{}	This method can be called in any state and calling it does not change the object state.
  setOnSeekCompleteListener	any	{}	This method can be called in any state and calling it does not change the object state.
  setScreenOnWhilePlaying	any	{}	This method can be called in any state and calling it does not change the object state.
  setVolume	{Idle, Initialized, Stopped, Prepared, Started, Paused, PlaybackCompleted}	{Error}	Successful invoke of this method does not change the state.
  setWakeMode	any	{}	This method can be called in any state and calling it does not change the object state.
  start	{Prepared, Started, Paused, PlaybackCompleted}	{Idle, Initialized, Stopped, Error}	Successful invoke of this method in a valid state transfers the object to the Started state. Calling this method in an invalid state transfers the object to the Error state.
  stop	{Prepared, Started, Stopped, Paused, PlaybackCompleted}	{Idle, Initialized, Error}	Successful invoke of this method in a valid state transfers the object to the Stopped state. Calling this method in an invalid state transfers the object to the Error state.

  Permissions

  One may need to declare a corresponding WAKE_LOCK permission <uses-permission> element.

  This class requires the android.Manifest.permission#INTERNET permission when used with network-based content.

  Callbacks

  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 setOnPreparedListener(OnPreparedListener)setOnPreparedListener, setOnVideoSizeChangedListener(OnVideoSizeChangedListener)setOnVideoSizeChangedListener, setOnSeekCompleteListener(OnSeekCompleteListener)setOnSeekCompleteListener, setOnCompletionListener(OnCompletionListener)setOnCompletionListener, setOnBufferingUpdateListener(OnBufferingUpdateListener)setOnBufferingUpdateListener, setOnInfoListener(OnInfoListener)setOnInfoListener, setOnErrorListener(OnErrorListener)setOnErrorListener, etc). In order to receive the respective callback associated with these listeners, applications are required to create MediaPlayer objects on a thread with its own Looper running (main UI thread by default has a Looper running).

  Nested Class Summary

  static interface	FFmpegMediaPlayer.OnBufferingUpdateListener Interface definition of a callback to be invoked indicating buffering status of a media resource being streamed over the network.
  static interface	FFmpegMediaPlayer.OnCompletionListener Interface definition for a callback to be invoked when playback of a media source has completed.
  static interface	FFmpegMediaPlayer.OnErrorListener Interface definition of a callback to be invoked when there has been an error during an asynchronous operation (other errors will throw exceptions at method call time).
  static interface	FFmpegMediaPlayer.OnInfoListener Interface definition of a callback to be invoked to communicate some info and/or warning about the media or its playback.
  static interface	FFmpegMediaPlayer.OnPreparedListener Interface definition for a callback to be invoked when the media source is ready for playback.
  static interface	FFmpegMediaPlayer.OnSeekCompleteListener Interface definition of a callback to be invoked indicating the completion of a seek operation.
  static interface	FFmpegMediaPlayer.OnTimedTextListener Interface definition of a callback to be invoked when a timed text is available for display.
  static interface	FFmpegMediaPlayer.OnVideoSizeChangedListener Interface definition of a callback to be invoked when the video size is first known or updated

  Field Summary

  static boolean	APPLY_METADATA_FILTER Constant to enable the metadata filter during retrieval.
  static boolean	BYPASS_METADATA_FILTER Constant to disable the metadata filter during retrieval.
  static int	MEDIA_ERROR_NOT_VALID_FOR_PROGRESSIVE_PLAYBACK 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.
  static int	MEDIA_ERROR_SERVER_DIED Media server died.
  static int	MEDIA_ERROR_UNKNOWN Unspecified media player error.
  static int	MEDIA_INFO_BAD_INTERLEAVING 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.
  static int	MEDIA_INFO_BUFFERING_END MediaPlayer is resuming playback after filling buffers.
  static int	MEDIA_INFO_BUFFERING_START MediaPlayer is temporarily pausing playback internally in order to buffer more data.
  static int	MEDIA_INFO_METADATA_UPDATE A new set of metadata is available.
  static int	MEDIA_INFO_NOT_SEEKABLE The media cannot be seeked (e.g live stream)
  static int	MEDIA_INFO_UNKNOWN Unspecified media player info.
  static int	MEDIA_INFO_VIDEO_TRACK_LAGGING The video is too complex for the decoder: it can't decode frames fast enough.
  static boolean	METADATA_ALL Constant to retrieve all the metadata.
  static boolean	METADATA_UPDATE_ONLY Constant to retrieve only the new metadata since the last call.

  Constructor Summary

  FFmpegMediaPlayer()
  Default constructor.

  Method Summary

  void	attachAuxEffect(int effectId) Attaches an auxiliary effect to the player.
  static FFmpegMediaPlayer	create(Context context, int resid) Convenience method to create a MediaPlayer for a given resource id.
  static FFmpegMediaPlayer	create(Context context, Uri uri) Convenience method to create a MediaPlayer for a given Uri.
  static FFmpegMediaPlayer	create(Context context, Uri uri, SurfaceHolder holder) Convenience method to create a MediaPlayer for a given Uri.
  boolean	disableTimedText() Disables timed text display.
  boolean	enableTimedText() Enables the first timed text track if any.
  boolean	enableTimedTextTrackIndex(int index)
  protected void	finalize()
  int	getAudioSessionId() Returns the audio session ID.
  int	getCurrentPosition() Gets the current playback position.
  int	getDuration() Gets the duration of the file.
  Bitmap	getFrameAt(int msec) Deprecated.
  int	getIntParameter(int key) Gets the value of the parameter indicated by key.
  Metadata	getMetadata(boolean update_only, boolean apply_filter) Gets the media metadata.
  Parcel	getParcelParameter(int key) Gets the value of the parameter indicated by key.
  java.lang.String	getStringParameter(int key) Gets the value of the parameter indicated by key.
  int	getVideoHeight() Returns the height of the video.
  int	getVideoWidth() Returns the width of the video.
  int	invoke(Parcel request, Parcel reply) Invoke a generic method on the native player using opaque parcels for the request and reply.
  boolean	isLooping() Checks whether the MediaPlayer is looping or non-looping.
  boolean	isPlaying() Checks whether the MediaPlayer is playing.
  static int	native_pullBatteryData(Parcel reply)
  Parcel	newRequest() Create a request parcel which can be routed to the native media player using invoke(Parcel, Parcel).
  void	pause() Pauses playback.
  void	prepare() Prepares the player for playback, synchronously.
  void	prepareAsync() Prepares the player for playback, asynchronously.
  void	release() Releases resources associated with this MediaPlayer object.
  void	reset() Resets the MediaPlayer to its uninitialized state.
  void	seekTo(int msec) Seeks to specified time position.
  void	setAudioSessionId(int sessionId) Sets the audio session ID.
  void	setAudioStreamType(int streamtype) Sets the audio stream type for this MediaPlayer.
  void	setAuxEffectSendLevel(float level) Sets the send level of the player to the attached auxiliary effect attachAuxEffect(int).
  void	setDataSource(Context context, Uri uri) Sets the data source as a content Uri.
  void	setDataSource(Context context, Uri uri, java.util.Map<java.lang.String,java.lang.String> headers) Sets the data source as a content Uri.
  void	setDataSource(java.io.FileDescriptor fd) Sets the data source (FileDescriptor) to use.
  void	setDataSource(java.io.FileDescriptor fd, long offset, long length) Sets the data source (FileDescriptor) to use.
  void	setDataSource(java.lang.String path) Sets the data source (file-path or http/rtsp URL) to use.
  void	setDisplay(SurfaceHolder sh) Sets the SurfaceHolder to use for displaying the video portion of the media.
  void	setLooping(boolean looping) Sets the player to be looping or non-looping.
  int	setMetadataFilter(java.util.Set<java.lang.String> allow, java.util.Set<java.lang.String> block) Set a filter for the metadata update notification and update retrieval.
  void	setOnBufferingUpdateListener(FFmpegMediaPlayer.OnBufferingUpdateListener listener) Register a callback to be invoked when the status of a network stream's buffer has changed.
  void	setOnCompletionListener(FFmpegMediaPlayer.OnCompletionListener listener) Register a callback to be invoked when the end of a media source has been reached during playback.
  void	setOnErrorListener(FFmpegMediaPlayer.OnErrorListener listener) Register a callback to be invoked when an error has happened during an asynchronous operation.
  void	setOnInfoListener(FFmpegMediaPlayer.OnInfoListener listener) Register a callback to be invoked when an info/warning is available.
  void	setOnPreparedListener(FFmpegMediaPlayer.OnPreparedListener listener) Register a callback to be invoked when the media source is ready for playback.
  void	setOnSeekCompleteListener(FFmpegMediaPlayer.OnSeekCompleteListener listener) Register a callback to be invoked when a seek operation has been completed.
  void	setOnTimedTextListener(FFmpegMediaPlayer.OnTimedTextListener listener) Register a callback to be invoked when a timed text is available for display.
  void	setOnVideoSizeChangedListener(FFmpegMediaPlayer.OnVideoSizeChangedListener listener) Register a callback to be invoked when the video size is known or updated.
  boolean	setParameter(int key, Parcel value) Sets the parameter indicated by key.
  void	setScreenOnWhilePlaying(boolean screenOn) Control whether we should use the attached SurfaceHolder to keep the screen on while video playback is occurring.
  void	setSurface(Surface surface) Sets the Surface to be used as the sink for the video portion of the media.
  void	setVolume(float leftVolume, float rightVolume) Sets the volume on this player.
  void	setWakeMode(Context context, int mode) Set the low-level power management behavior for this MediaPlayer.
  void	start() Starts or resumes playback.
  void	stop() Stops playback after playback has been stopped or paused.

  Methods inherited from class java.lang.Object

  clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  Field Detail

  METADATA_UPDATE_ONLY

  public static final boolean METADATA_UPDATE_ONLY

  Constant to retrieve only the new metadata since the last call. // FIXME: unhide. // FIXME: add link to getMetadata(boolean, boolean)

  See Also:

  Constant Field Values

  METADATA_ALL

  public static final boolean METADATA_ALL

  Constant to retrieve all the metadata. // FIXME: unhide. // FIXME: add link to getMetadata(boolean, boolean)

  See Also:

  Constant Field Values

  APPLY_METADATA_FILTER

  public static final boolean APPLY_METADATA_FILTER

  Constant to enable the metadata filter during retrieval. // FIXME: unhide. // FIXME: add link to getMetadata(boolean, boolean)

  See Also:

  Constant Field Values

  BYPASS_METADATA_FILTER

  public static final boolean BYPASS_METADATA_FILTER

  Constant to disable the metadata filter during retrieval. // FIXME: unhide. // FIXME: add link to getMetadata(boolean, boolean)

  See Also:

  Constant Field Values

  MEDIA_ERROR_UNKNOWN

  public static final int MEDIA_ERROR_UNKNOWN

  Unspecified media player error.

  See Also:

  android.media.MediaPlayer.OnErrorListener, Constant Field Values

  MEDIA_ERROR_SERVER_DIED

  public static final int MEDIA_ERROR_SERVER_DIED

  Media server died. In this case, the application must release the MediaPlayer object and instantiate a new one.

  See Also:

  android.media.MediaPlayer.OnErrorListener, Constant Field Values

  MEDIA_ERROR_NOT_VALID_FOR_PROGRESSIVE_PLAYBACK

  public static final int MEDIA_ERROR_NOT_VALID_FOR_PROGRESSIVE_PLAYBACK

  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 Also:

  android.media.MediaPlayer.OnErrorListener, Constant Field Values

  MEDIA_INFO_UNKNOWN

  public static final int MEDIA_INFO_UNKNOWN

  Unspecified media player info.

  See Also:

  android.media.MediaPlayer.OnInfoListener, Constant Field Values

  MEDIA_INFO_VIDEO_TRACK_LAGGING

  public static final int MEDIA_INFO_VIDEO_TRACK_LAGGING

  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 Also:

  android.media.MediaPlayer.OnInfoListener, Constant Field Values

  MEDIA_INFO_BUFFERING_START

  public static final int MEDIA_INFO_BUFFERING_START

  MediaPlayer is temporarily pausing playback internally in order to buffer more data.

  See Also:

  android.media.MediaPlayer.OnInfoListener, Constant Field Values

  MEDIA_INFO_BUFFERING_END

  public static final int MEDIA_INFO_BUFFERING_END

  MediaPlayer is resuming playback after filling buffers.

  See Also:

  android.media.MediaPlayer.OnInfoListener, Constant Field Values

  MEDIA_INFO_BAD_INTERLEAVING

  public static final int MEDIA_INFO_BAD_INTERLEAVING

  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 Also:

  android.media.MediaPlayer.OnInfoListener, Constant Field Values

  MEDIA_INFO_NOT_SEEKABLE

  public static final int MEDIA_INFO_NOT_SEEKABLE

  The media cannot be seeked (e.g live stream)

  See Also:

  android.media.MediaPlayer.OnInfoListener, Constant Field Values

  MEDIA_INFO_METADATA_UPDATE

  public static final int MEDIA_INFO_METADATA_UPDATE

  A new set of metadata is available.

  See Also:

  android.media.MediaPlayer.OnInfoListener, Constant Field Values

  Constructor Detail

  FFmpegMediaPlayer

  public FFmpegMediaPlayer()

  Default constructor. Consider using one of the create() methods for synchronously instantiating a MediaPlayer from a Uri or resource.

  When done with the MediaPlayer, you should call release(), to free the resources. If not released, too many MediaPlayer instances may result in an exception.

  Method Detail

  newRequest

  public Parcel newRequest()

  Create a request parcel which can be routed to the native media player using 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.

  Returns:

  A parcel suitable to hold a request for the native player.

  invoke

  public int invoke(Parcel request,
                    Parcel reply)

  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 to make sure a native player exists.

  Parameters:

  request - Parcel with the data for the extension. The caller must use newRequest() to get one.

  reply - Output parcel with the data returned by the native player.

  Returns:

  The status code see utils/Errors.h

  setDisplay

  public void setDisplay(SurfaceHolder sh)

  Sets the 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 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.

  Parameters:

  sh - the SurfaceHolder to use for video display

  setSurface

  public void setSurface(Surface surface)

  Sets the Surface to be used as the sink for the video portion of the media. This is similar to setDisplay(SurfaceHolder), but does not support setScreenOnWhilePlaying(boolean). 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 SurfaceTexture, the timestamps returned from 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.

  Parameters:

  surface - The Surface to be used for the video portion of the media.

  create

  public static FFmpegMediaPlayer create(Context context,
                                         Uri uri)

  Convenience method to create a MediaPlayer for a given Uri. On success, prepare() will already have been called and must not be called again.

  When done with the MediaPlayer, you should call release(), to free the resources. If not released, too many MediaPlayer instances will result in an exception.

  Parameters:

  context - the Context to use

  uri - the Uri from which to get the datasource

  Returns:

  a MediaPlayer object, or null if creation failed

  create

  public static FFmpegMediaPlayer create(Context context,
                                         Uri uri,
                                         SurfaceHolder holder)

  Convenience method to create a MediaPlayer for a given Uri. On success, prepare() will already have been called and must not be called again.

  When done with the MediaPlayer, you should call release(), to free the resources. If not released, too many MediaPlayer instances will result in an exception.

  Parameters:

  context - the Context to use

  uri - the Uri from which to get the datasource

  holder - the SurfaceHolder to use for displaying the video

  Returns:

  a MediaPlayer object, or null if creation failed

  create

  public static FFmpegMediaPlayer create(Context context,
                                         int resid)

  Convenience method to create a MediaPlayer for a given resource id. On success, prepare() will already have been called and must not be called again.

  When done with the MediaPlayer, you should call release(), to free the resources. If not released, too many MediaPlayer instances will result in an exception.

  Parameters:

  context - the Context to use

  resid - the raw resource id (R.raw.<something>) for the resource to use as the datasource

  Returns:

  a MediaPlayer object, or null if creation failed

  setDataSource

  public void setDataSource(Context context,
                            Uri uri)
                     throws java.io.IOException,
                            java.lang.IllegalArgumentException,
                            java.lang.SecurityException,
                            java.lang.IllegalStateException

  Sets the data source as a content Uri.

  Parameters:

  context - the Context to use when resolving the Uri

  uri - the Content URI of the data you want to play

  Throws:

  java.lang.IllegalStateException - if it is called in an invalid state

  java.io.IOException

  java.lang.IllegalArgumentException

  java.lang.SecurityException

  setDataSource

  public void setDataSource(Context context,
                            Uri uri,
                            java.util.Map<java.lang.String,java.lang.String> headers)
                     throws java.io.IOException,
                            java.lang.IllegalArgumentException,
                            java.lang.SecurityException,
                            java.lang.IllegalStateException

  Sets the data source as a content Uri.

  Parameters:

  context - the Context to use when resolving the Uri

  uri - the Content URI of the data you want to play

  headers - the headers to be sent together with the request for the data

  Throws:

  java.lang.IllegalStateException - if it is called in an invalid state

  java.io.IOException

  java.lang.IllegalArgumentException

  java.lang.SecurityException

  setDataSource

  public void setDataSource(java.lang.String path)
                     throws java.io.IOException,
                            java.lang.IllegalArgumentException,
                            java.lang.SecurityException,
                            java.lang.IllegalStateException

  Sets the data source (file-path or http/rtsp URL) to use.

  Parameters:

  path - the path of the file, or the http/rtsp URL of the stream you want to play

  Throws:

  java.lang.IllegalStateException - if it is called in an invalid state

  When path refers to a local file, the file may actually be opened by a process other than the calling application. This implies that the pathname should be an absolute path (as any other process runs with unspecified current working directory), and that the pathname should reference a world-readable file. As an alternative, the application could first open the file for reading, and then use the file descriptor form setDataSource(FileDescriptor).

  java.io.IOException

  java.lang.IllegalArgumentException

  java.lang.SecurityException

  setDataSource

  public void setDataSource(java.io.FileDescriptor fd)
                     throws java.io.IOException,
                            java.lang.IllegalArgumentException,
                            java.lang.IllegalStateException

  Sets the data source (FileDescriptor) to use. It is the caller's responsibility to close the file descriptor. It is safe to do so as soon as this call returns.

  Parameters:

  fd - the FileDescriptor for the file you want to play

  Throws:

  java.lang.IllegalStateException - if it is called in an invalid state

  java.io.IOException

  java.lang.IllegalArgumentException

  setDataSource

  public void setDataSource(java.io.FileDescriptor fd,
                            long offset,
                            long length)
                     throws java.io.IOException,
                            java.lang.IllegalArgumentException,
                            java.lang.IllegalStateException

  Sets the data source (FileDescriptor) to use. The FileDescriptor must be seekable (N.B. a LocalSocket is not seekable). It is the caller's responsibility to close the file descriptor. It is safe to do so as soon as this call returns.

  Parameters:

  fd - the FileDescriptor for the file you want to play

  offset - the offset into the file where the data to be played starts, in bytes

  length - the length in bytes of the data to be played

  Throws:

  java.lang.IllegalStateException - if it is called in an invalid state

  java.io.IOException

  java.lang.IllegalArgumentException

  prepare

  public void prepare()
               throws java.io.IOException,
                      java.lang.IllegalStateException

  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 MediaPlayer is ready for playback.

  Throws:

  java.lang.IllegalStateException - if it is called in an invalid state

  java.io.IOException

  prepareAsync

  public void prepareAsync()
                    throws java.lang.IllegalStateException

  Prepares the player for playback, asynchronously. After setting the datasource and the display surface, you need to either call prepare() or prepareAsync(). For streams, you should call prepareAsync(), which returns immediately, rather than blocking until enough data has been buffered.

  Throws:

  java.lang.IllegalStateException - if it is called in an invalid state

  start

  public void start()
             throws java.lang.IllegalStateException

  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:

  java.lang.IllegalStateException - if it is called in an invalid state

  stop

  public void stop()
            throws java.lang.IllegalStateException

  Stops playback after playback has been stopped or paused.

  Throws:

  java.lang.IllegalStateException - if the internal player engine has not been initialized.

  pause

  public void pause()
             throws java.lang.IllegalStateException

  Pauses playback. Call start() to resume.

  Throws:

  java.lang.IllegalStateException - if the internal player engine has not been initialized.

  setWakeMode

  public void setWakeMode(Context context,
                          int mode)

  Set the low-level power management behavior for this MediaPlayer. This can be used when the MediaPlayer is not playing through a SurfaceHolder set with setDisplay(SurfaceHolder) and thus can use the high-level setScreenOnWhilePlaying(boolean) feature.

  This function has the MediaPlayer access the low-level power manager service to control the device's power usage while playing is occurring. The parameter is a combination of android.os.PowerManager wake flags. Use of this method requires android.Manifest.permission#WAKE_LOCK permission. By default, no attempt is made to keep the device awake during playback.

  Parameters:

  context - the Context to use

  mode - the power/wake mode to set

  See Also:

  android.os.PowerManager

  setScreenOnWhilePlaying

  public void setScreenOnWhilePlaying(boolean screenOn)

  Control whether we should use the attached SurfaceHolder to keep the screen on while video playback is occurring. This is the preferred method over setWakeMode(Context, int) where possible, since it doesn't require that the application have permission for low-level wake lock access.

  Parameters:

  screenOn - Supply true to keep the screen on, false to allow it to turn off.

  getVideoWidth

  public int getVideoWidth()

  Returns the width of the video.

  Returns:

  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 OnVideoSizeChangedListener can be registered via setOnVideoSizeChangedListener(OnVideoSizeChangedListener) to provide a notification when the width is available.

  getVideoHeight

  public int getVideoHeight()

  Returns the height of the video.

  Returns:

  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 OnVideoSizeChangedListener can be registered via setOnVideoSizeChangedListener(OnVideoSizeChangedListener) to provide a notification when the height is available.

  isPlaying

  public boolean isPlaying()

  Checks whether the MediaPlayer is playing.

  Returns:

  true if currently playing, false otherwise

  seekTo

  public void seekTo(int msec)
              throws java.lang.IllegalStateException

  Seeks to specified time position.

  Parameters:

  msec - the offset in milliseconds from the start to seek to

  Throws:

  java.lang.IllegalStateException - if the internal player engine has not been initialized

  getCurrentPosition

  public int getCurrentPosition()

  Gets the current playback position.

  Returns:

  the current position in milliseconds

  getDuration

  public int getDuration()

  Gets the duration of the file.

  Returns:

  the duration in milliseconds

  getMetadata

  public Metadata getMetadata(boolean update_only,
                              boolean apply_filter)

  Gets the media metadata.

  Parameters:

  update_only - controls whether the full set of available metadata is returned or just the set that changed since the last call. See METADATA_UPDATE_ONLY and METADATA_ALL.

  apply_filter - if true only metadata that matches the filter is returned. See APPLY_METADATA_FILTER and BYPASS_METADATA_FILTER.

  Returns:

  The metadata, possibly empty. null if an error occured. // FIXME: unhide.

  setMetadataFilter

  public int setMetadataFilter(java.util.Set<java.lang.String> allow,
                               java.util.Set<java.lang.String> block)

  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.

  Parameters:

  allow - Is the set of metadata the client is interested in receiving new notifications for.

  block - Is the set of metadata the client is not interested in receiving new notifications for.

  Returns:

  The call status code. // FIXME: unhide.

  release

  public void release()

  Releases resources associated with this MediaPlayer object. It is considered good practice to call this method when you're done using the MediaPlayer. For instance, whenever the Activity of an application is paused, this method should be invoked to release the MediaPlayer object. In addition to unnecessary resources (such as memory and instances of codecs) being hold, failure to call this method immediately if a MediaPlayer object is no longer needed may also lead to continuous battery consumption for mobile devices, and playback failure if no multiple instances of the same codec is supported on a device.

  reset

  public void reset()

  Resets the MediaPlayer to its uninitialized state. After calling this method, you will have to initialize it again by setting the data source and calling prepare().

  setAudioStreamType

  public void setAudioStreamType(int streamtype)

  Sets the audio stream type for this MediaPlayer. See AudioManager for a list of stream types. Must call this method before prepare() or prepareAsync() in order for the target stream type to become effective thereafter.

  Parameters:

  streamtype - the audio stream type

  See Also:

  android.media.AudioManager

  setLooping

  public void setLooping(boolean looping)

  Sets the player to be looping or non-looping.

  Parameters:

  looping - whether to loop or not

  isLooping

  public boolean isLooping()

  Checks whether the MediaPlayer is looping or non-looping.

  Returns:

  true if the MediaPlayer is currently looping, false otherwise

  setVolume

  public void setVolume(float leftVolume,
                        float rightVolume)

  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 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. UI controls should be scaled logarithmically.

  Parameters:

  leftVolume - left volume scalar

  rightVolume - right volume scalar

  getFrameAt

  public Bitmap getFrameAt(int msec)
                    throws java.lang.IllegalStateException

  Deprecated.

  Currently not implemented, returns null.

  Throws:

  java.lang.IllegalStateException

  setAudioSessionId

  public void setAudioSessionId(int sessionId)
                         throws java.lang.IllegalArgumentException,
                                java.lang.IllegalStateException

  Sets the audio session ID.

  Parameters:

  sessionId - the audio session ID. The audio session ID is a system wide unique identifier for the audio stream played by this MediaPlayer instance. The primary use of the audio session ID is to associate audio effects to a particular instance of MediaPlayer: 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 MediaPlayer 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 setDataSource methods.

  Throws:

  java.lang.IllegalStateException - if it is called in an invalid state

  java.lang.IllegalArgumentException

  getAudioSessionId

  public int getAudioSessionId()

  Returns the audio session ID.

  Returns:

  the audio session ID. setAudioSessionId(int) Note that the audio session ID is 0 only if a problem occured when the MediaPlayer was contructed.

  attachAuxEffect

  public void attachAuxEffect(int effectId)

  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(). setAuxEffectSendLevel(float).

  After creating an auxiliary effect (e.g. android.media.audiofx.EnvironmentalReverb), retrieve its ID with android.media.audiofx.AudioEffect#getId() and use it when calling this method to attach the player to the effect.

  To detach the effect from the player, call this method with a null effect id.

  This method must be called after one of the overloaded setDataSource methods.

  Parameters:

  effectId - system wide unique id of the effect to attach

  setParameter

  public boolean setParameter(int key,
                              Parcel value)

  Sets the parameter indicated by key.

  Parameters:

  key - key indicates the parameter to be set.

  value - value of the parameter to be set.

  Returns:

  true if the parameter is set successfully, false otherwise

  getParcelParameter

  public Parcel getParcelParameter(int key)

  Gets the value of the parameter indicated by key. The caller is responsible for recycling the returned parcel.

  Parameters:

  key - key indicates the parameter to get.

  Returns:

  value of the parameter.

  getStringParameter

  public java.lang.String getStringParameter(int key)

  Gets the value of the parameter indicated by key.

  Parameters:

  key - key indicates the parameter to get.

  Returns:

  value of the parameter.

  getIntParameter

  public int getIntParameter(int key)

  Gets the value of the parameter indicated by key.

  Parameters:

  key - key indicates the parameter to get.

  Returns:

  value of the parameter.

  setAuxEffectSendLevel

  public void setAuxEffectSendLevel(float level)

  Sets the send level of the player to the attached auxiliary effect attachAuxEffect(int). The level value range is 0 to 1.0.

  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.

  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)

  Parameters:

  level - send level scalar

  enableTimedTextTrackIndex

  public boolean enableTimedTextTrackIndex(int index)

  Parameters:

  index - The index of the text track to be turned on.

  Returns:

  true if the text track is enabled successfully.

  enableTimedText

  public boolean enableTimedText()

  Enables the first timed text track if any.

  Returns:

  true if the text track is enabled successfully

  disableTimedText

  public boolean disableTimedText()

  Disables timed text display.

  Returns:

  true if the text track is disabled successfully.

  native_pullBatteryData

  public static int native_pullBatteryData(Parcel reply)

  Parameters:

  reply - Parcel with audio/video duration info for battery tracking usage

  Returns:

  The status code.

  finalize

  protected void finalize()

  Overrides:

  finalize in class java.lang.Object

  setOnPreparedListener

  public void setOnPreparedListener(FFmpegMediaPlayer.OnPreparedListener listener)

  Register a callback to be invoked when the media source is ready for playback.

  Parameters:

  listener - the callback that will be run

  setOnCompletionListener

  public void setOnCompletionListener(FFmpegMediaPlayer.OnCompletionListener listener)

  Register a callback to be invoked when the end of a media source has been reached during playback.

  Parameters:

  listener - the callback that will be run

  setOnBufferingUpdateListener

  public void setOnBufferingUpdateListener(FFmpegMediaPlayer.OnBufferingUpdateListener listener)

  Register a callback to be invoked when the status of a network stream's buffer has changed.

  Parameters:

  listener - the callback that will be run.

  setOnSeekCompleteListener

  public void setOnSeekCompleteListener(FFmpegMediaPlayer.OnSeekCompleteListener listener)

  Register a callback to be invoked when a seek operation has been completed.

  Parameters:

  listener - the callback that will be run

  setOnVideoSizeChangedListener

  public void setOnVideoSizeChangedListener(FFmpegMediaPlayer.OnVideoSizeChangedListener listener)

  Register a callback to be invoked when the video size is known or updated.

  Parameters:

  listener - the callback that will be run

  setOnTimedTextListener

  public void setOnTimedTextListener(FFmpegMediaPlayer.OnTimedTextListener listener)

  Register a callback to be invoked when a timed text is available for display.

  Parameters:

  listener - the callback that will be run

  setOnErrorListener

  public void setOnErrorListener(FFmpegMediaPlayer.OnErrorListener listener)

  Register a callback to be invoked when an error has happened during an asynchronous operation.

  Parameters:

  listener - the callback that will be run

  setOnInfoListener

  public void setOnInfoListener(FFmpegMediaPlayer.OnInfoListener listener)

  Register a callback to be invoked when an info/warning is available.

  Parameters:

  listener - the callback that will be run