MediaPlayer.java revision 5d55c7119820ee9bb06fc072e416fe98ba77cd28
1/* 2 * Copyright (C) 2006 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17package android.media; 18 19import android.content.ContentResolver; 20import android.content.Context; 21import android.content.res.AssetFileDescriptor; 22import android.net.Uri; 23import android.os.Handler; 24import android.os.Looper; 25import android.os.Message; 26import android.os.Parcel; 27import android.os.ParcelFileDescriptor; 28import android.os.PowerManager; 29import android.util.Log; 30import android.view.Surface; 31import android.view.SurfaceHolder; 32import android.graphics.Bitmap; 33import android.media.AudioManager; 34 35import java.io.FileDescriptor; 36import java.io.IOException; 37import java.util.Set; 38import java.lang.ref.WeakReference; 39 40/** 41 * MediaPlayer class can be used to control playback 42 * of audio/video files and streams. An example on how to use the methods in 43 * this class can be found in {@link android.widget.VideoView}. 44 * Please see <a href="{@docRoot}guide/topics/media/index.html">Audio and Video</a> 45 * for additional help using MediaPlayer. 46 * 47 * <p>Topics covered here are: 48 * <ol> 49 * <li><a href="#StateDiagram">State Diagram</a> 50 * <li><a href="#Valid_and_Invalid_States">Valid and Invalid States</a> 51 * <li><a href="#Permissions">Permissions</a> 52 * </ol> 53 * 54 * <a name="StateDiagram"></a> 55 * <h3>State Diagram</h3> 56 * 57 * <p>Playback control of audio/video files and streams is managed as a state 58 * machine. The following diagram shows the life cycle and the states of a 59 * MediaPlayer object driven by the supported playback control operations. 60 * The ovals represent the states a MediaPlayer object may reside 61 * in. The arcs represent the playback control operations that drive the object 62 * state transition. There are two types of arcs. The arcs with a single arrow 63 * head represent synchronous method calls, while those with 64 * a double arrow head represent asynchronous method calls.</p> 65 * 66 * <p><img src="../../../images/mediaplayer_state_diagram.gif" 67 * alt="MediaPlayer State diagram" 68 * border="0" /></p> 69 * 70 * <p>From this state diagram, one can see that a MediaPlayer object has the 71 * following states:</p> 72 * <ul> 73 * <li>When a MediaPlayer object is just created using <code>new</code> or 74 * after {@link #reset()} is called, it is in the <em>Idle</em> state; and after 75 * {@link #release()} is called, it is in the <em>End</em> state. Between these 76 * two states is the life cycle of the MediaPlayer object. 77 * <ul> 78 * <li>There is a subtle but important difference between a newly constructed 79 * MediaPlayer object and the MediaPlayer object after {@link #reset()} 80 * is called. It is a programming error to invoke methods such 81 * as {@link #getCurrentPosition()}, 82 * {@link #getDuration()}, {@link #getVideoHeight()}, 83 * {@link #getVideoWidth()}, {@link #setAudioStreamType(int)}, 84 * {@link #setLooping(boolean)}, 85 * {@link #setVolume(float, float)}, {@link #pause()}, {@link #start()}, 86 * {@link #stop()}, {@link #seekTo(int)}, {@link #prepare()} or 87 * {@link #prepareAsync()} in the <em>Idle</em> state for both cases. If any of these 88 * methods is called right after a MediaPlayer object is constructed, 89 * the user supplied callback method OnErrorListener.onError() won't be 90 * called by the internal player engine and the object state remains 91 * unchanged; but if these methods are called right after {@link #reset()}, 92 * the user supplied callback method OnErrorListener.onError() will be 93 * invoked by the internal player engine and the object will be 94 * transfered to the <em>Error</em> state. </li> 95 * <li>It is also recommended that once 96 * a MediaPlayer object is no longer being used, call {@link #release()} immediately 97 * so that resources used by the internal player engine associated with the 98 * MediaPlayer object can be released immediately. Resource may include 99 * singleton resources such as hardware acceleration components and 100 * failure to call {@link #release()} may cause subsequent instances of 101 * MediaPlayer objects to fallback to software implementations or fail 102 * altogether. Once the MediaPlayer 103 * object is in the <em>End</em> state, it can no longer be used and 104 * there is no way to bring it back to any other state. </li> 105 * <li>Furthermore, 106 * the MediaPlayer objects created using <code>new</code> is in the 107 * <em>Idle</em> state, while those created with one 108 * of the overloaded convenient <code>create</code> methods are <em>NOT</em> 109 * in the <em>Idle</em> state. In fact, the objects are in the <em>Prepared</em> 110 * state if the creation using <code>create</code> method is successful. 111 * </li> 112 * </ul> 113 * </li> 114 * <li>In general, some playback control operation may fail due to various 115 * reasons, such as unsupported audio/video format, poorly interleaved 116 * audio/video, resolution too high, streaming timeout, and the like. 117 * Thus, error reporting and recovery is an important concern under 118 * these circumstances. Sometimes, due to programming errors, invoking a playback 119 * control operation in an invalid state may also occur. Under all these 120 * error conditions, the internal player engine invokes a user supplied 121 * OnErrorListener.onError() method if an OnErrorListener has been 122 * registered beforehand via 123 * {@link #setOnErrorListener(android.media.MediaPlayer.OnErrorListener)}. 124 * <ul> 125 * <li>It is important to note that once an error occurs, the 126 * MediaPlayer object enters the <em>Error</em> state (except as noted 127 * above), even if an error listener has not been registered by the application.</li> 128 * <li>In order to reuse a MediaPlayer object that is in the <em> 129 * Error</em> state and recover from the error, 130 * {@link #reset()} can be called to restore the object to its <em>Idle</em> 131 * state.</li> 132 * <li>It is good programming practice to have your application 133 * register a OnErrorListener to look out for error notifications from 134 * the internal player engine.</li> 135 * <li>IlleglStateException is 136 * thrown to prevent programming errors such as calling {@link #prepare()}, 137 * {@link #prepareAsync()}, or one of the overloaded <code>setDataSource 138 * </code> methods in an invalid state. </li> 139 * </ul> 140 * </li> 141 * <li>Calling 142 * {@link #setDataSource(FileDescriptor)}, or 143 * {@link #setDataSource(String)}, or 144 * {@link #setDataSource(Context, Uri)}, or 145 * {@link #setDataSource(FileDescriptor, long, long)} transfers a 146 * MediaPlayer object in the <em>Idle</em> state to the 147 * <em>Initialized</em> state. 148 * <ul> 149 * <li>An IllegalStateException is thrown if 150 * setDataSource() is called in any other state.</li> 151 * <li>It is good programming 152 * practice to always look out for <code>IllegalArgumentException</code> 153 * and <code>IOException</code> that may be thrown from the overloaded 154 * <code>setDataSource</code> methods.</li> 155 * </ul> 156 * </li> 157 * <li>A MediaPlayer object must first enter the <em>Prepared</em> state 158 * before playback can be started. 159 * <ul> 160 * <li>There are two ways (synchronous vs. 161 * asynchronous) that the <em>Prepared</em> state can be reached: 162 * either a call to {@link #prepare()} (synchronous) which 163 * transfers the object to the <em>Prepared</em> state once the method call 164 * returns, or a call to {@link #prepareAsync()} (asynchronous) which 165 * first transfers the object to the <em>Preparing</em> state after the 166 * call returns (which occurs almost right way) while the internal 167 * player engine continues working on the rest of preparation work 168 * until the preparation work completes. When the preparation completes or when {@link #prepare()} call returns, 169 * the internal player engine then calls a user supplied callback method, 170 * onPrepared() of the OnPreparedListener interface, if an 171 * OnPreparedListener is registered beforehand via {@link 172 * #setOnPreparedListener(android.media.MediaPlayer.OnPreparedListener)}.</li> 173 * <li>It is important to note that 174 * the <em>Preparing</em> state is a transient state, and the behavior 175 * of calling any method with side effect while a MediaPlayer object is 176 * in the <em>Preparing</em> state is undefined.</li> 177 * <li>An IllegalStateException is 178 * thrown if {@link #prepare()} or {@link #prepareAsync()} is called in 179 * any other state.</li> 180 * <li>While in the <em>Prepared</em> state, properties 181 * such as audio/sound volume, screenOnWhilePlaying, looping can be 182 * adjusted by invoking the corresponding set methods.</li> 183 * </ul> 184 * </li> 185 * <li>To start the playback, {@link #start()} must be called. After 186 * {@link #start()} returns successfully, the MediaPlayer object is in the 187 * <em>Started</em> state. {@link #isPlaying()} can be called to test 188 * whether the MediaPlayer object is in the <em>Started</em> state. 189 * <ul> 190 * <li>While in the <em>Started</em> state, the internal player engine calls 191 * a user supplied OnBufferingUpdateListener.onBufferingUpdate() callback 192 * method if a OnBufferingUpdateListener has been registered beforehand 193 * via {@link #setOnBufferingUpdateListener(OnBufferingUpdateListener)}. 194 * This callback allows applications to keep track of the buffering status 195 * while streaming audio/video.</li> 196 * <li>Calling {@link #start()} has not effect 197 * on a MediaPlayer object that is already in the <em>Started</em> state.</li> 198 * </ul> 199 * </li> 200 * <li>Playback can be paused and stopped, and the current playback position 201 * can be adjusted. Playback can be paused via {@link #pause()}. When the call to 202 * {@link #pause()} returns, the MediaPlayer object enters the 203 * <em>Paused</em> state. Note that the transition from the <em>Started</em> 204 * state to the <em>Paused</em> state and vice versa happens 205 * asynchronously in the player engine. It may take some time before 206 * the state is updated in calls to {@link #isPlaying()}, and it can be 207 * a number of seconds in the case of streamed content. 208 * <ul> 209 * <li>Calling {@link #start()} to resume playback for a paused 210 * MediaPlayer object, and the resumed playback 211 * position is the same as where it was paused. When the call to 212 * {@link #start()} returns, the paused MediaPlayer object goes back to 213 * the <em>Started</em> state.</li> 214 * <li>Calling {@link #pause()} has no effect on 215 * a MediaPlayer object that is already in the <em>Paused</em> state.</li> 216 * </ul> 217 * </li> 218 * <li>Calling {@link #stop()} stops playback and causes a 219 * MediaPlayer in the <em>Started</em>, <em>Paused</em>, <em>Prepared 220 * </em> or <em>PlaybackCompleted</em> state to enter the 221 * <em>Stopped</em> state. 222 * <ul> 223 * <li>Once in the <em>Stopped</em> state, playback cannot be started 224 * until {@link #prepare()} or {@link #prepareAsync()} are called to set 225 * the MediaPlayer object to the <em>Prepared</em> state again.</li> 226 * <li>Calling {@link #stop()} has no effect on a MediaPlayer 227 * object that is already in the <em>Stopped</em> state.</li> 228 * </ul> 229 * </li> 230 * <li>The playback position can be adjusted with a call to 231 * {@link #seekTo(int)}. 232 * <ul> 233 * <li>Although the asynchronuous {@link #seekTo(int)} 234 * call returns right way, the actual seek operation may take a while to 235 * finish, especially for audio/video being streamed. When the actual 236 * seek operation completes, the internal player engine calls a user 237 * supplied OnSeekComplete.onSeekComplete() if an OnSeekCompleteListener 238 * has been registered beforehand via 239 * {@link #setOnSeekCompleteListener(OnSeekCompleteListener)}.</li> 240 * <li>Please 241 * note that {@link #seekTo(int)} can also be called in the other states, 242 * such as <em>Prepared</em>, <em>Paused</em> and <em>PlaybackCompleted 243 * </em> state.</li> 244 * <li>Furthermore, the actual current playback position 245 * can be retrieved with a call to {@link #getCurrentPosition()}, which 246 * is helpful for applications such as a Music player that need to keep 247 * track of the playback progress.</li> 248 * </ul> 249 * </li> 250 * <li>When the playback reaches the end of stream, the playback completes. 251 * <ul> 252 * <li>If the looping mode was being set to <var>true</var>with 253 * {@link #setLooping(boolean)}, the MediaPlayer object shall remain in 254 * the <em>Started</em> state.</li> 255 * <li>If the looping mode was set to <var>false 256 * </var>, the player engine calls a user supplied callback method, 257 * OnCompletion.onCompletion(), if a OnCompletionListener is registered 258 * beforehand via {@link #setOnCompletionListener(OnCompletionListener)}. 259 * The invoke of the callback signals that the object is now in the <em> 260 * PlaybackCompleted</em> state.</li> 261 * <li>While in the <em>PlaybackCompleted</em> 262 * state, calling {@link #start()} can restart the playback from the 263 * beginning of the audio/video source.</li> 264 * </ul> 265 * 266 * 267 * <a name="Valid_and_Invalid_States"></a> 268 * <h3>Valid and invalid states</h3> 269 * 270 * <table border="0" cellspacing="0" cellpadding="0"> 271 * <tr><td>Method Name </p></td> 272 * <td>Valid Sates </p></td> 273 * <td>Invalid States </p></td> 274 * <td>Comments </p></td></tr> 275 * <tr><td>getCurrentPosition </p></td> 276 * <td>{Idle, Initialized, Prepared, Started, Paused, Stopped, 277 * PlaybackCompleted} </p></td> 278 * <td>{Error}</p></td> 279 * <td>Successful invoke of this method in a valid state does not change the 280 * state. Calling this method in an invalid state transfers the object 281 * to the <em>Error</em> state. </p></td></tr> 282 * <tr><td>getDuration </p></td> 283 * <td>{Prepared, Started, Paused, Stopped, PlaybackCompleted} </p></td> 284 * <td>{Idle, Initialized, Error} </p></td> 285 * <td>Successful invoke of this method in a valid state does not change the 286 * state. Calling this method in an invalid state transfers the object 287 * to the <em>Error</em> state. </p></td></tr> 288 * <tr><td>getVideoHeight </p></td> 289 * <td>{Idle, Initialized, Prepared, Started, Paused, Stopped, 290 * PlaybackCompleted}</p></td> 291 * <td>{Error}</p></td> 292 * <td>Successful invoke of this method in a valid state does not change the 293 * state. Calling this method in an invalid state transfers the object 294 * to the <em>Error</em> state. </p></td></tr> 295 * <tr><td>getVideoWidth </p></td> 296 * <td>{Idle, Initialized, Prepared, Started, Paused, Stopped, 297 * PlaybackCompleted}</p></td> 298 * <td>{Error}</p></td> 299 * <td>Successful invoke of this method in a valid state does not change 300 * the state. Calling this method in an invalid state transfers the 301 * object to the <em>Error</em> state. </p></td></tr> 302 * <tr><td>isPlaying </p></td> 303 * <td>{Idle, Initialized, Prepared, Started, Paused, Stopped, 304 * PlaybackCompleted}</p></td> 305 * <td>{Error}</p></td> 306 * <td>Successful invoke of this method in a valid state does not change 307 * the state. Calling this method in an invalid state transfers the 308 * object to the <em>Error</em> state. </p></td></tr> 309 * <tr><td>pause </p></td> 310 * <td>{Started, Paused}</p></td> 311 * <td>{Idle, Initialized, Prepared, Stopped, PlaybackCompleted, Error}</p></td> 312 * <td>Successful invoke of this method in a valid state transfers the 313 * object to the <em>Paused</em> state. Calling this method in an 314 * invalid state transfers the object to the <em>Error</em> state.</p></td></tr> 315 * <tr><td>prepare </p></td> 316 * <td>{Initialized, Stopped} </p></td> 317 * <td>{Idle, Prepared, Started, Paused, PlaybackCompleted, Error} </p></td> 318 * <td>Successful invoke of this method in a valid state transfers the 319 * object to the <em>Prepared</em> state. Calling this method in an 320 * invalid state throws an IllegalStateException.</p></td></tr> 321 * <tr><td>prepareAsync </p></td> 322 * <td>{Initialized, Stopped} </p></td> 323 * <td>{Idle, Prepared, Started, Paused, PlaybackCompleted, Error} </p></td> 324 * <td>Successful invoke of this method in a valid state transfers the 325 * object to the <em>Preparing</em> state. Calling this method in an 326 * invalid state throws an IllegalStateException.</p></td></tr> 327 * <tr><td>release </p></td> 328 * <td>any </p></td> 329 * <td>{} </p></td> 330 * <td>After {@link #release()}, the object is no longer available. </p></td></tr> 331 * <tr><td>reset </p></td> 332 * <td>{Idle, Initialized, Prepared, Started, Paused, Stopped, 333 * PlaybackCompleted, Error}</p></td> 334 * <td>{}</p></td> 335 * <td>After {@link #reset()}, the object is like being just created.</p></td></tr> 336 * <tr><td>seekTo </p></td> 337 * <td>{Prepared, Started, Paused, PlaybackCompleted} </p></td> 338 * <td>{Idle, Initialized, Stopped, Error}</p></td> 339 * <td>Successful invoke of this method in a valid state does not change 340 * the state. Calling this method in an invalid state transfers the 341 * object to the <em>Error</em> state. </p></td></tr> 342 * <tr><td>setAudioStreamType </p></td> 343 * <td>{Idle, Initialized, Stopped, Prepared, Started, Paused, 344 * PlaybackCompleted}</p></td> 345 * <td>{Error}</p></td> 346 * <td>Successful invoke of this method does not change the state.</p></td></tr> 347 * <tr><td>setDataSource </p></td> 348 * <td>{Idle} </p></td> 349 * <td>{Initialized, Prepared, Started, Paused, Stopped, PlaybackCompleted, 350 * Error} </p></td> 351 * <td>Successful invoke of this method in a valid state transfers the 352 * object to the <em>Initialized</em> state. Calling this method in an 353 * invalid state throws an IllegalStateException.</p></td></tr> 354 * <tr><td>setDisplay </p></td> 355 * <td>any </p></td> 356 * <td>{} </p></td> 357 * <td>This method can be called in any state and calling it does not change 358 * the object state. </p></td></tr> 359 * <tr><td>setLooping </p></td> 360 * <td>{Idle, Initialized, Stopped, Prepared, Started, Paused, 361 * PlaybackCompleted}</p></td> 362 * <td>{Error}</p></td> 363 * <td>Successful invoke of this method in a valid state does not change 364 * the state. Calling this method in an 365 * invalid state transfers the object to the <em>Error</em> state.</p></td></tr> 366 * <tr><td>isLooping </p></td> 367 * <td>any </p></td> 368 * <td>{} </p></td> 369 * <td>This method can be called in any state and calling it does not change 370 * the object state. </p></td></tr> 371 * <tr><td>setOnBufferingUpdateListener </p></td> 372 * <td>any </p></td> 373 * <td>{} </p></td> 374 * <td>This method can be called in any state and calling it does not change 375 * the object state. </p></td></tr> 376 * <tr><td>setOnCompletionListener </p></td> 377 * <td>any </p></td> 378 * <td>{} </p></td> 379 * <td>This method can be called in any state and calling it does not change 380 * the object state. </p></td></tr> 381 * <tr><td>setOnErrorListener </p></td> 382 * <td>any </p></td> 383 * <td>{} </p></td> 384 * <td>This method can be called in any state and calling it does not change 385 * the object state. </p></td></tr> 386 * <tr><td>setOnPreparedListener </p></td> 387 * <td>any </p></td> 388 * <td>{} </p></td> 389 * <td>This method can be called in any state and calling it does not change 390 * the object state. </p></td></tr> 391 * <tr><td>setOnSeekCompleteListener </p></td> 392 * <td>any </p></td> 393 * <td>{} </p></td> 394 * <td>This method can be called in any state and calling it does not change 395 * the object state. </p></td></tr> 396 * <tr><td>setScreenOnWhilePlaying</></td> 397 * <td>any </p></td> 398 * <td>{} </p></td> 399 * <td>This method can be called in any state and calling it does not change 400 * the object state. </p></td></tr> 401 * <tr><td>setVolume </p></td> 402 * <td>{Idle, Initialized, Stopped, Prepared, Started, Paused, 403 * PlaybackCompleted}</p></td> 404 * <td>{Error}</p></td> 405 * <td>Successful invoke of this method does not change the state. 406 * <tr><td>setWakeMode </p></td> 407 * <td>any </p></td> 408 * <td>{} </p></td> 409 * <td>This method can be called in any state and calling it does not change 410 * the object state.</p></td></tr> 411 * <tr><td>start </p></td> 412 * <td>{Prepared, Started, Paused, PlaybackCompleted}</p></td> 413 * <td>{Idle, Initialized, Stopped, Error}</p></td> 414 * <td>Successful invoke of this method in a valid state transfers the 415 * object to the <em>Started</em> state. Calling this method in an 416 * invalid state transfers the object to the <em>Error</em> state.</p></td></tr> 417 * <tr><td>stop </p></td> 418 * <td>{Prepared, Started, Stopped, Paused, PlaybackCompleted}</p></td> 419 * <td>{Idle, Initialized, Error}</p></td> 420 * <td>Successful invoke of this method in a valid state transfers the 421 * object to the <em>Stopped</em> state. Calling this method in an 422 * invalid state transfers the object to the <em>Error</em> state.</p></td></tr> 423 * </table> 424 * 425 * <a name="Permissions"></a> 426 * <h3>Permissions</h3> 427 * <p>One may need to declare a corresponding WAKE_LOCK permission {@link 428 * android.R.styleable#AndroidManifestUsesPermission <uses-permission>} 429 * element. 430 * 431 */ 432public class MediaPlayer 433{ 434 /** 435 Constant to retrieve only the new metadata since the last 436 call. 437 // FIXME: unhide. 438 // FIXME: add link to getMetadata(boolean, boolean) 439 {@hide} 440 */ 441 public static final boolean METADATA_UPDATE_ONLY = true; 442 443 /** 444 Constant to retrieve all the metadata. 445 // FIXME: unhide. 446 // FIXME: add link to getMetadata(boolean, boolean) 447 {@hide} 448 */ 449 public static final boolean METADATA_ALL = false; 450 451 /** 452 Constant to enable the metadata filter during retrieval. 453 // FIXME: unhide. 454 // FIXME: add link to getMetadata(boolean, boolean) 455 {@hide} 456 */ 457 public static final boolean APPLY_METADATA_FILTER = true; 458 459 /** 460 Constant to disable the metadata filter during retrieval. 461 // FIXME: unhide. 462 // FIXME: add link to getMetadata(boolean, boolean) 463 {@hide} 464 */ 465 public static final boolean BYPASS_METADATA_FILTER = false; 466 467 static { 468 System.loadLibrary("media_jni"); 469 } 470 471 private final static String TAG = "MediaPlayer"; 472 // Name of the remote interface for the media player. Must be kept 473 // in sync with the 2nd parameter of the IMPLEMENT_META_INTERFACE 474 // macro invocation in IMediaPlayer.cpp 475 private final static String IMEDIA_PLAYER = "android.media.IMediaPlayer"; 476 477 private int mNativeContext; // accessed by native methods 478 private int mListenerContext; // accessed by native methods 479 private Surface mSurface; // accessed by native methods 480 private SurfaceHolder mSurfaceHolder; 481 private EventHandler mEventHandler; 482 private PowerManager.WakeLock mWakeLock = null; 483 private boolean mScreenOnWhilePlaying; 484 private boolean mStayAwake; 485 486 /** 487 * Default constructor. Consider using one of the create() methods for 488 * synchronously instantiating a MediaPlayer from a Uri or resource. 489 * <p>When done with the MediaPlayer, you should call {@link #release()}, 490 * to free the resources. If not released, too many MediaPlayer instances may 491 * result in an exception.</p> 492 */ 493 public MediaPlayer() { 494 495 Looper looper; 496 if ((looper = Looper.myLooper()) != null) { 497 mEventHandler = new EventHandler(this, looper); 498 } else if ((looper = Looper.getMainLooper()) != null) { 499 mEventHandler = new EventHandler(this, looper); 500 } else { 501 mEventHandler = null; 502 } 503 504 /* Native setup requires a weak reference to our object. 505 * It's easier to create it here than in C++. 506 */ 507 native_setup(new WeakReference<MediaPlayer>(this)); 508 } 509 510 /* 511 * Update the MediaPlayer ISurface. Call after updating mSurface. 512 */ 513 private native void _setVideoSurface(); 514 515 /** 516 * Create a request parcel which can be routed to the native media 517 * player using {@link #invoke(Parcel, Parcel)}. The Parcel 518 * returned has the proper InterfaceToken set. The caller should 519 * not overwrite that token, i.e it can only append data to the 520 * Parcel. 521 * 522 * @return A parcel suitable to hold a request for the native 523 * player. 524 */ 525 public Parcel newRequest() { 526 Parcel parcel = Parcel.obtain(); 527 parcel.writeInterfaceToken(IMEDIA_PLAYER); 528 return parcel; 529 } 530 531 /** 532 * Invoke a generic method on the native player using opaque 533 * parcels for the request and reply. Both payloads' format is a 534 * convention between the java caller and the native player. 535 * Must be called after setDataSource to make sure a native player 536 * exists. 537 * 538 * @param request Parcel with the data for the extension. The 539 * caller must use {@link #newRequest()} to get one. 540 * 541 * @param[out] reply Parcel with the data returned by the 542 * native player. 543 * 544 * @return The status code see utils/Errors.h 545 */ 546 public int invoke(Parcel request, Parcel reply) { 547 int retcode = native_invoke(request, reply); 548 reply.setDataPosition(0); 549 return retcode; 550 } 551 552 /** 553 * Sets the SurfaceHolder to use for displaying the video portion of the media. 554 * This call is optional. Not calling it when playing back a video will 555 * result in only the audio track being played. 556 * 557 * @param sh the SurfaceHolder to use for video display 558 */ 559 public void setDisplay(SurfaceHolder sh) { 560 mSurfaceHolder = sh; 561 if (sh != null) { 562 mSurface = sh.getSurface(); 563 } else { 564 mSurface = null; 565 } 566 _setVideoSurface(); 567 updateSurfaceScreenOn(); 568 } 569 570 /** 571 * Convenience method to create a MediaPlayer for a given Uri. 572 * On success, {@link #prepare()} will already have been called and must not be called again. 573 * <p>When done with the MediaPlayer, you should call {@link #release()}, 574 * to free the resources. If not released, too many MediaPlayer instances will 575 * result in an exception.</p> 576 * 577 * @param context the Context to use 578 * @param uri the Uri from which to get the datasource 579 * @return a MediaPlayer object, or null if creation failed 580 */ 581 public static MediaPlayer create(Context context, Uri uri) { 582 return create (context, uri, null); 583 } 584 585 /** 586 * Convenience method to create a MediaPlayer for a given Uri. 587 * On success, {@link #prepare()} will already have been called and must not be called again. 588 * <p>When done with the MediaPlayer, you should call {@link #release()}, 589 * to free the resources. If not released, too many MediaPlayer instances will 590 * result in an exception.</p> 591 * 592 * @param context the Context to use 593 * @param uri the Uri from which to get the datasource 594 * @param holder the SurfaceHolder to use for displaying the video 595 * @return a MediaPlayer object, or null if creation failed 596 */ 597 public static MediaPlayer create(Context context, Uri uri, SurfaceHolder holder) { 598 599 try { 600 MediaPlayer mp = new MediaPlayer(); 601 mp.setDataSource(context, uri); 602 if (holder != null) { 603 mp.setDisplay(holder); 604 } 605 mp.prepare(); 606 return mp; 607 } catch (IOException ex) { 608 Log.d(TAG, "create failed:", ex); 609 // fall through 610 } catch (IllegalArgumentException ex) { 611 Log.d(TAG, "create failed:", ex); 612 // fall through 613 } catch (SecurityException ex) { 614 Log.d(TAG, "create failed:", ex); 615 // fall through 616 } 617 618 return null; 619 } 620 621 /** 622 * Convenience method to create a MediaPlayer for a given resource id. 623 * On success, {@link #prepare()} will already have been called and must not be called again. 624 * <p>When done with the MediaPlayer, you should call {@link #release()}, 625 * to free the resources. If not released, too many MediaPlayer instances will 626 * result in an exception.</p> 627 * 628 * @param context the Context to use 629 * @param resid the raw resource id (<var>R.raw.<something></var>) for 630 * the resource to use as the datasource 631 * @return a MediaPlayer object, or null if creation failed 632 */ 633 public static MediaPlayer create(Context context, int resid) { 634 try { 635 AssetFileDescriptor afd = context.getResources().openRawResourceFd(resid); 636 if (afd == null) return null; 637 638 MediaPlayer mp = new MediaPlayer(); 639 mp.setDataSource(afd.getFileDescriptor(), afd.getStartOffset(), afd.getLength()); 640 afd.close(); 641 mp.prepare(); 642 return mp; 643 } catch (IOException ex) { 644 Log.d(TAG, "create failed:", ex); 645 // fall through 646 } catch (IllegalArgumentException ex) { 647 Log.d(TAG, "create failed:", ex); 648 // fall through 649 } catch (SecurityException ex) { 650 Log.d(TAG, "create failed:", ex); 651 // fall through 652 } 653 return null; 654 } 655 656 /** 657 * Sets the data source as a content Uri. 658 * 659 * @param context the Context to use when resolving the Uri 660 * @param uri the Content URI of the data you want to play 661 * @throws IllegalStateException if it is called in an invalid state 662 */ 663 public void setDataSource(Context context, Uri uri) 664 throws IOException, IllegalArgumentException, SecurityException, IllegalStateException { 665 666 String scheme = uri.getScheme(); 667 if(scheme == null || scheme.equals("file")) { 668 setDataSource(uri.getPath()); 669 return; 670 } 671 672 AssetFileDescriptor fd = null; 673 try { 674 ContentResolver resolver = context.getContentResolver(); 675 fd = resolver.openAssetFileDescriptor(uri, "r"); 676 if (fd == null) { 677 return; 678 } 679 // Note: using getDeclaredLength so that our behavior is the same 680 // as previous versions when the content provider is returning 681 // a full file. 682 if (fd.getDeclaredLength() < 0) { 683 setDataSource(fd.getFileDescriptor()); 684 } else { 685 setDataSource(fd.getFileDescriptor(), fd.getStartOffset(), fd.getDeclaredLength()); 686 } 687 return; 688 } catch (SecurityException ex) { 689 } catch (IOException ex) { 690 } finally { 691 if (fd != null) { 692 fd.close(); 693 } 694 } 695 Log.d(TAG, "Couldn't open file on client side, trying server side"); 696 setDataSource(uri.toString()); 697 return; 698 } 699 700 /** 701 * Sets the data source (file-path or http/rtsp URL) to use. 702 * 703 * @param path the path of the file, or the http/rtsp URL of the stream you want to play 704 * @throws IllegalStateException if it is called in an invalid state 705 */ 706 public native void setDataSource(String path) throws IOException, IllegalArgumentException, IllegalStateException; 707 708 /** 709 * Sets the data source (FileDescriptor) to use. It is the caller's responsibility 710 * to close the file descriptor. It is safe to do so as soon as this call returns. 711 * 712 * @param fd the FileDescriptor for the file you want to play 713 * @throws IllegalStateException if it is called in an invalid state 714 */ 715 public void setDataSource(FileDescriptor fd) 716 throws IOException, IllegalArgumentException, IllegalStateException { 717 // intentionally less than LONG_MAX 718 setDataSource(fd, 0, 0x7ffffffffffffffL); 719 } 720 721 /** 722 * Sets the data source (FileDescriptor) to use. It is the caller's responsibility 723 * to close the file descriptor. It is safe to do so as soon as this call returns. 724 * 725 * @param fd the FileDescriptor for the file you want to play 726 * @param offset the offset into the file where the data to be played starts, in bytes 727 * @param length the length in bytes of the data to be played 728 * @throws IllegalStateException if it is called in an invalid state 729 */ 730 public native void setDataSource(FileDescriptor fd, long offset, long length) 731 throws IOException, IllegalArgumentException, IllegalStateException; 732 733 /** 734 * Prepares the player for playback, synchronously. 735 * 736 * After setting the datasource and the display surface, you need to either 737 * call prepare() or prepareAsync(). For files, it is OK to call prepare(), 738 * which blocks until MediaPlayer is ready for playback. 739 * 740 * @throws IllegalStateException if it is called in an invalid state 741 */ 742 public native void prepare() throws IOException, IllegalStateException; 743 744 /** 745 * Prepares the player for playback, asynchronously. 746 * 747 * After setting the datasource and the display surface, you need to either 748 * call prepare() or prepareAsync(). For streams, you should call prepareAsync(), 749 * which returns immediately, rather than blocking until enough data has been 750 * buffered. 751 * 752 * @throws IllegalStateException if it is called in an invalid state 753 */ 754 public native void prepareAsync() throws IllegalStateException; 755 756 /** 757 * Starts or resumes playback. If playback had previously been paused, 758 * playback will continue from where it was paused. If playback had 759 * been stopped, or never started before, playback will start at the 760 * beginning. 761 * 762 * @throws IllegalStateException if it is called in an invalid state 763 */ 764 public void start() throws IllegalStateException { 765 stayAwake(true); 766 _start(); 767 } 768 769 private native void _start() throws IllegalStateException; 770 771 /** 772 * Stops playback after playback has been stopped or paused. 773 * 774 * @throws IllegalStateException if the internal player engine has not been 775 * initialized. 776 */ 777 public void stop() throws IllegalStateException { 778 stayAwake(false); 779 _stop(); 780 } 781 782 private native void _stop() throws IllegalStateException; 783 784 /** 785 * Pauses playback. Call start() to resume. 786 * 787 * @throws IllegalStateException if the internal player engine has not been 788 * initialized. 789 */ 790 public void pause() throws IllegalStateException { 791 stayAwake(false); 792 _pause(); 793 } 794 795 private native void _pause() throws IllegalStateException; 796 797 /** 798 * Set the low-level power management behavior for this MediaPlayer. This 799 * can be used when the MediaPlayer is not playing through a SurfaceHolder 800 * set with {@link #setDisplay(SurfaceHolder)} and thus can use the 801 * high-level {@link #setScreenOnWhilePlaying(boolean)} feature. 802 * 803 * <p>This function has the MediaPlayer access the low-level power manager 804 * service to control the device's power usage while playing is occurring. 805 * The parameter is a combination of {@link android.os.PowerManager} wake flags. 806 * Use of this method requires {@link android.Manifest.permission#WAKE_LOCK} 807 * permission. 808 * By default, no attempt is made to keep the device awake during playback. 809 * 810 * @param context the Context to use 811 * @param mode the power/wake mode to set 812 * @see android.os.PowerManager 813 */ 814 public void setWakeMode(Context context, int mode) { 815 boolean washeld = false; 816 if (mWakeLock != null) { 817 if (mWakeLock.isHeld()) { 818 washeld = true; 819 mWakeLock.release(); 820 } 821 mWakeLock = null; 822 } 823 824 PowerManager pm = (PowerManager)context.getSystemService(Context.POWER_SERVICE); 825 mWakeLock = pm.newWakeLock(mode|PowerManager.ON_AFTER_RELEASE, MediaPlayer.class.getName()); 826 mWakeLock.setReferenceCounted(false); 827 if (washeld) { 828 mWakeLock.acquire(); 829 } 830 } 831 832 /** 833 * Control whether we should use the attached SurfaceHolder to keep the 834 * screen on while video playback is occurring. This is the preferred 835 * method over {@link #setWakeMode} where possible, since it doesn't 836 * require that the application have permission for low-level wake lock 837 * access. 838 * 839 * @param screenOn Supply true to keep the screen on, false to allow it 840 * to turn off. 841 */ 842 public void setScreenOnWhilePlaying(boolean screenOn) { 843 if (mScreenOnWhilePlaying != screenOn) { 844 mScreenOnWhilePlaying = screenOn; 845 updateSurfaceScreenOn(); 846 } 847 } 848 849 private void stayAwake(boolean awake) { 850 if (mWakeLock != null) { 851 if (awake && !mWakeLock.isHeld()) { 852 mWakeLock.acquire(); 853 } else if (!awake && mWakeLock.isHeld()) { 854 mWakeLock.release(); 855 } 856 } 857 mStayAwake = awake; 858 updateSurfaceScreenOn(); 859 } 860 861 private void updateSurfaceScreenOn() { 862 if (mSurfaceHolder != null) { 863 mSurfaceHolder.setKeepScreenOn(mScreenOnWhilePlaying && mStayAwake); 864 } 865 } 866 867 /** 868 * Returns the width of the video. 869 * 870 * @return the width of the video, or 0 if there is no video, 871 * no display surface was set, or prepare()/prepareAsync() 872 * have not completed yet 873 */ 874 public native int getVideoWidth(); 875 876 /** 877 * Returns the height of the video. 878 * 879 * @return the height of the video, or 0 if there is no video, 880 * no display surface was set, or prepare()/prepareAsync() 881 * have not completed yet 882 */ 883 public native int getVideoHeight(); 884 885 /** 886 * Checks whether the MediaPlayer is playing. 887 * 888 * @return true if currently playing, false otherwise 889 */ 890 public native boolean isPlaying(); 891 892 /** 893 * Seeks to specified time position. 894 * 895 * @param msec the offset in milliseconds from the start to seek to 896 * @throws IllegalStateException if the internal player engine has not been 897 * initialized 898 */ 899 public native void seekTo(int msec) throws IllegalStateException; 900 901 /** 902 * Gets the current playback position. 903 * 904 * @return the current position in milliseconds 905 */ 906 public native int getCurrentPosition(); 907 908 /** 909 * Gets the duration of the file. 910 * 911 * @return the duration in milliseconds 912 */ 913 public native int getDuration(); 914 915 /** 916 * Gets the media metadata. 917 * 918 * @param update_only controls whether the full set of available 919 * metadata is returned or just the set that changed since the 920 * last call. See {@see #METADATA_UPDATE_ONLY} and {@see 921 * #METADATA_ALL}. 922 * 923 * @param apply_filter if true only metadata that matches the 924 * filter is returned. See {@see #APPLY_METADATA_FILTER} and {@see 925 * #BYPASS_METADATA_FILTER}. 926 * 927 * @return The metadata, possibly empty. null if an error occured. 928 // FIXME: unhide. 929 * {@hide} 930 */ 931 public Metadata getMetadata(final boolean update_only, 932 final boolean apply_filter) { 933 Parcel reply = Parcel.obtain(); 934 Metadata data = new Metadata(); 935 936 if (!native_getMetadata(update_only, apply_filter, reply)) { 937 reply.recycle(); 938 return null; 939 } 940 941 // Metadata takes over the parcel, don't recycle it unless 942 // there is an error. 943 if (!data.parse(reply)) { 944 reply.recycle(); 945 return null; 946 } 947 return data; 948 } 949 950 /** 951 * Set a filter for the metadata update notification and update 952 * retrieval. The caller provides 2 set of metadata keys, allowed 953 * and blocked. The blocked set always takes precedence over the 954 * allowed one. 955 * Metadata.MATCH_ALL and Metadata.MATCH_NONE are 2 sets available as 956 * shorthands to allow/block all or no metadata. 957 * 958 * By default, there is no filter set. 959 * 960 * @param allow Is the set of metadata the client is interested 961 * in receiving new notifications for. 962 * @param block Is the set of metadata the client is not interested 963 * in receiving new notifications for. 964 * @return The call status code. 965 * 966 // FIXME: unhide. 967 * {@hide} 968 */ 969 public int setMetadataFilter(Set<Integer> allow, Set<Integer> block) { 970 // Do our serialization manually instead of calling 971 // Parcel.writeArray since the sets are made of the same type 972 // we avoid paying the price of calling writeValue (used by 973 // writeArray) which burns an extra int per element to encode 974 // the type. 975 Parcel request = newRequest(); 976 977 // The parcel starts already with an interface token. There 978 // are 2 filters. Each one starts with a 4bytes number to 979 // store the len followed by a number of int (4 bytes as well) 980 // representing the metadata type. 981 int capacity = request.dataSize() + 4 * (1 + allow.size() + 1 + block.size()); 982 983 if (request.dataCapacity() < capacity) { 984 request.setDataCapacity(capacity); 985 } 986 987 request.writeInt(allow.size()); 988 for(Integer t: allow) { 989 request.writeInt(t); 990 } 991 request.writeInt(block.size()); 992 for(Integer t: block) { 993 request.writeInt(t); 994 } 995 return native_setMetadataFilter(request); 996 } 997 998 /** 999 * Releases resources associated with this MediaPlayer object. 1000 * It is considered good practice to call this method when you're 1001 * done using the MediaPlayer. 1002 */ 1003 public void release() { 1004 stayAwake(false); 1005 updateSurfaceScreenOn(); 1006 mOnPreparedListener = null; 1007 mOnBufferingUpdateListener = null; 1008 mOnCompletionListener = null; 1009 mOnSeekCompleteListener = null; 1010 mOnErrorListener = null; 1011 mOnInfoListener = null; 1012 mOnVideoSizeChangedListener = null; 1013 _release(); 1014 } 1015 1016 private native void _release(); 1017 1018 /** 1019 * Resets the MediaPlayer to its uninitialized state. After calling 1020 * this method, you will have to initialize it again by setting the 1021 * data source and calling prepare(). 1022 */ 1023 public void reset() { 1024 stayAwake(false); 1025 _reset(); 1026 // make sure none of the listeners get called anymore 1027 mEventHandler.removeCallbacksAndMessages(null); 1028 } 1029 1030 private native void _reset(); 1031 1032 /** 1033 * Sets the audio stream type for this MediaPlayer. See {@link AudioManager} 1034 * for a list of stream types. 1035 * 1036 * @param streamtype the audio stream type 1037 * @see android.media.AudioManager 1038 */ 1039 public native void setAudioStreamType(int streamtype); 1040 1041 /** 1042 * Sets the player to be looping or non-looping. 1043 * 1044 * @param looping whether to loop or not 1045 */ 1046 public native void setLooping(boolean looping); 1047 1048 /** 1049 * Checks whether the MediaPlayer is looping or non-looping. 1050 * 1051 * @return true if the MediaPlayer is currently looping, false otherwise 1052 */ 1053 public native boolean isLooping(); 1054 1055 /** 1056 * Sets the volume on this player. 1057 * This API is recommended for balancing the output of audio streams 1058 * within an application. Unless you are writing an application to 1059 * control user settings, this API should be used in preference to 1060 * {@link AudioManager#setStreamVolume(int, int, int)} which sets the volume of ALL streams of 1061 * a particular type. Note that the passed volume values are raw scalars. 1062 * UI controls should be scaled logarithmically. 1063 * 1064 * @param leftVolume left volume scalar 1065 * @param rightVolume right volume scalar 1066 */ 1067 public native void setVolume(float leftVolume, float rightVolume); 1068 1069 /** 1070 * Currently not implemented, returns null. 1071 * @deprecated 1072 * @hide 1073 */ 1074 public native Bitmap getFrameAt(int msec) throws IllegalStateException; 1075 1076 /** 1077 * @param request Parcel destinated to the media player. The 1078 * Interface token must be set to the IMediaPlayer 1079 * one to be routed correctly through the system. 1080 * @param reply[out] Parcel that will contain the reply. 1081 * @return The status code. 1082 */ 1083 private native final int native_invoke(Parcel request, Parcel reply); 1084 1085 1086 /** 1087 * @param update_only If true fetch only the set of metadata that have 1088 * changed since the last invocation of getMetadata. 1089 * The set is built using the unfiltered 1090 * notifications the native player sent to the 1091 * MediaPlayerService during that period of 1092 * time. If false, all the metadatas are considered. 1093 * @param apply_filter If true, once the metadata set has been built based on 1094 * the value update_only, the current filter is applied. 1095 * @param reply[out] On return contains the serialized 1096 * metadata. Valid only if the call was successful. 1097 * @return The status code. 1098 */ 1099 private native final boolean native_getMetadata(boolean update_only, 1100 boolean apply_filter, 1101 Parcel reply); 1102 1103 /** 1104 * @param request Parcel with the 2 serialized lists of allowed 1105 * metadata types followed by the one to be 1106 * dropped. Each list starts with an integer 1107 * indicating the number of metadata type elements. 1108 * @return The status code. 1109 */ 1110 private native final int native_setMetadataFilter(Parcel request); 1111 1112 private native final void native_setup(Object mediaplayer_this); 1113 private native final void native_finalize(); 1114 1115 @Override 1116 protected void finalize() { native_finalize(); } 1117 1118 /* Do not change these values without updating their counterparts 1119 * in include/media/mediaplayer.h! 1120 */ 1121 private static final int MEDIA_NOP = 0; // interface test message 1122 private static final int MEDIA_PREPARED = 1; 1123 private static final int MEDIA_PLAYBACK_COMPLETE = 2; 1124 private static final int MEDIA_BUFFERING_UPDATE = 3; 1125 private static final int MEDIA_SEEK_COMPLETE = 4; 1126 private static final int MEDIA_SET_VIDEO_SIZE = 5; 1127 private static final int MEDIA_ERROR = 100; 1128 private static final int MEDIA_INFO = 200; 1129 1130 private class EventHandler extends Handler 1131 { 1132 private MediaPlayer mMediaPlayer; 1133 1134 public EventHandler(MediaPlayer mp, Looper looper) { 1135 super(looper); 1136 mMediaPlayer = mp; 1137 } 1138 1139 @Override 1140 public void handleMessage(Message msg) { 1141 if (mMediaPlayer.mNativeContext == 0) { 1142 Log.w(TAG, "mediaplayer went away with unhandled events"); 1143 return; 1144 } 1145 switch(msg.what) { 1146 case MEDIA_PREPARED: 1147 if (mOnPreparedListener != null) 1148 mOnPreparedListener.onPrepared(mMediaPlayer); 1149 return; 1150 1151 case MEDIA_PLAYBACK_COMPLETE: 1152 if (mOnCompletionListener != null) 1153 mOnCompletionListener.onCompletion(mMediaPlayer); 1154 stayAwake(false); 1155 return; 1156 1157 case MEDIA_BUFFERING_UPDATE: 1158 if (mOnBufferingUpdateListener != null) 1159 mOnBufferingUpdateListener.onBufferingUpdate(mMediaPlayer, msg.arg1); 1160 return; 1161 1162 case MEDIA_SEEK_COMPLETE: 1163 if (mOnSeekCompleteListener != null) 1164 mOnSeekCompleteListener.onSeekComplete(mMediaPlayer); 1165 return; 1166 1167 case MEDIA_SET_VIDEO_SIZE: 1168 if (mOnVideoSizeChangedListener != null) 1169 mOnVideoSizeChangedListener.onVideoSizeChanged(mMediaPlayer, msg.arg1, msg.arg2); 1170 return; 1171 1172 case MEDIA_ERROR: 1173 // For PV specific error values (msg.arg2) look in 1174 // opencore/pvmi/pvmf/include/pvmf_return_codes.h 1175 Log.e(TAG, "Error (" + msg.arg1 + "," + msg.arg2 + ")"); 1176 boolean error_was_handled = false; 1177 if (mOnErrorListener != null) { 1178 error_was_handled = mOnErrorListener.onError(mMediaPlayer, msg.arg1, msg.arg2); 1179 } 1180 if (mOnCompletionListener != null && ! error_was_handled) { 1181 mOnCompletionListener.onCompletion(mMediaPlayer); 1182 } 1183 stayAwake(false); 1184 return; 1185 1186 case MEDIA_INFO: 1187 // For PV specific code values (msg.arg2) look in 1188 // opencore/pvmi/pvmf/include/pvmf_return_codes.h 1189 Log.i(TAG, "Info (" + msg.arg1 + "," + msg.arg2 + ")"); 1190 if (mOnInfoListener != null) { 1191 mOnInfoListener.onInfo(mMediaPlayer, msg.arg1, msg.arg2); 1192 } 1193 // No real default action so far. 1194 return; 1195 1196 case MEDIA_NOP: // interface test message - ignore 1197 break; 1198 1199 default: 1200 Log.e(TAG, "Unknown message type " + msg.what); 1201 return; 1202 } 1203 } 1204 } 1205 1206 /** 1207 * Called from native code when an interesting event happens. This method 1208 * just uses the EventHandler system to post the event back to the main app thread. 1209 * We use a weak reference to the original MediaPlayer object so that the native 1210 * code is safe from the object disappearing from underneath it. (This is 1211 * the cookie passed to native_setup().) 1212 */ 1213 private static void postEventFromNative(Object mediaplayer_ref, 1214 int what, int arg1, int arg2, Object obj) 1215 { 1216 MediaPlayer mp = (MediaPlayer)((WeakReference)mediaplayer_ref).get(); 1217 if (mp == null) { 1218 return; 1219 } 1220 1221 if (mp.mEventHandler != null) { 1222 Message m = mp.mEventHandler.obtainMessage(what, arg1, arg2, obj); 1223 mp.mEventHandler.sendMessage(m); 1224 } 1225 } 1226 1227 /** 1228 * Interface definition for a callback to be invoked when the media 1229 * source is ready for playback. 1230 */ 1231 public interface OnPreparedListener 1232 { 1233 /** 1234 * Called when the media file is ready for playback. 1235 * 1236 * @param mp the MediaPlayer that is ready for playback 1237 */ 1238 void onPrepared(MediaPlayer mp); 1239 } 1240 1241 /** 1242 * Register a callback to be invoked when the media source is ready 1243 * for playback. 1244 * 1245 * @param listener the callback that will be run 1246 */ 1247 public void setOnPreparedListener(OnPreparedListener listener) 1248 { 1249 mOnPreparedListener = listener; 1250 } 1251 1252 private OnPreparedListener mOnPreparedListener; 1253 1254 /** 1255 * Interface definition for a callback to be invoked when playback of 1256 * a media source has completed. 1257 */ 1258 public interface OnCompletionListener 1259 { 1260 /** 1261 * Called when the end of a media source is reached during playback. 1262 * 1263 * @param mp the MediaPlayer that reached the end of the file 1264 */ 1265 void onCompletion(MediaPlayer mp); 1266 } 1267 1268 /** 1269 * Register a callback to be invoked when the end of a media source 1270 * has been reached during playback. 1271 * 1272 * @param listener the callback that will be run 1273 */ 1274 public void setOnCompletionListener(OnCompletionListener listener) 1275 { 1276 mOnCompletionListener = listener; 1277 } 1278 1279 private OnCompletionListener mOnCompletionListener; 1280 1281 /** 1282 * Interface definition of a callback to be invoked indicating buffering 1283 * status of a media resource being streamed over the network. 1284 */ 1285 public interface OnBufferingUpdateListener 1286 { 1287 /** 1288 * Called to update status in buffering a media stream. 1289 * 1290 * @param mp the MediaPlayer the update pertains to 1291 * @param percent the percentage (0-100) of the buffer 1292 * that has been filled thus far 1293 */ 1294 void onBufferingUpdate(MediaPlayer mp, int percent); 1295 } 1296 1297 /** 1298 * Register a callback to be invoked when the status of a network 1299 * stream's buffer has changed. 1300 * 1301 * @param listener the callback that will be run. 1302 */ 1303 public void setOnBufferingUpdateListener(OnBufferingUpdateListener listener) 1304 { 1305 mOnBufferingUpdateListener = listener; 1306 } 1307 1308 private OnBufferingUpdateListener mOnBufferingUpdateListener; 1309 1310 /** 1311 * Interface definition of a callback to be invoked indicating 1312 * the completion of a seek operation. 1313 */ 1314 public interface OnSeekCompleteListener 1315 { 1316 /** 1317 * Called to indicate the completion of a seek operation. 1318 * 1319 * @param mp the MediaPlayer that issued the seek operation 1320 */ 1321 public void onSeekComplete(MediaPlayer mp); 1322 } 1323 1324 /** 1325 * Register a callback to be invoked when a seek operation has been 1326 * completed. 1327 * 1328 * @param listener the callback that will be run 1329 */ 1330 public void setOnSeekCompleteListener(OnSeekCompleteListener listener) 1331 { 1332 mOnSeekCompleteListener = listener; 1333 } 1334 1335 private OnSeekCompleteListener mOnSeekCompleteListener; 1336 1337 /** 1338 * Interface definition of a callback to be invoked when the 1339 * video size is first known or updated 1340 */ 1341 public interface OnVideoSizeChangedListener 1342 { 1343 /** 1344 * Called to indicate the video size 1345 * 1346 * @param mp the MediaPlayer associated with this callback 1347 * @param width the width of the video 1348 * @param height the height of the video 1349 */ 1350 public void onVideoSizeChanged(MediaPlayer mp, int width, int height); 1351 } 1352 1353 /** 1354 * Register a callback to be invoked when the video size is 1355 * known or updated. 1356 * 1357 * @param listener the callback that will be run 1358 */ 1359 public void setOnVideoSizeChangedListener(OnVideoSizeChangedListener listener) 1360 { 1361 mOnVideoSizeChangedListener = listener; 1362 } 1363 1364 private OnVideoSizeChangedListener mOnVideoSizeChangedListener; 1365 1366 /* Do not change these values without updating their counterparts 1367 * in include/media/mediaplayer.h! 1368 */ 1369 /** Unspecified media player error. 1370 * @see android.media.MediaPlayer.OnErrorListener 1371 */ 1372 public static final int MEDIA_ERROR_UNKNOWN = 1; 1373 1374 /** Media server died. In this case, the application must release the 1375 * MediaPlayer object and instantiate a new one. 1376 * @see android.media.MediaPlayer.OnErrorListener 1377 */ 1378 public static final int MEDIA_ERROR_SERVER_DIED = 100; 1379 1380 /** The video is streamed and its container is not valid for progressive 1381 * playback i.e the video's index (e.g moov atom) is not at the start of the 1382 * file. 1383 * @see android.media.MediaPlayer.OnErrorListener 1384 */ 1385 public static final int MEDIA_ERROR_NOT_VALID_FOR_PROGRESSIVE_PLAYBACK = 200; 1386 1387 /** 1388 * Interface definition of a callback to be invoked when there 1389 * has been an error during an asynchronous operation (other errors 1390 * will throw exceptions at method call time). 1391 */ 1392 public interface OnErrorListener 1393 { 1394 /** 1395 * Called to indicate an error. 1396 * 1397 * @param mp the MediaPlayer the error pertains to 1398 * @param what the type of error that has occurred: 1399 * <ul> 1400 * <li>{@link #MEDIA_ERROR_UNKNOWN} 1401 * <li>{@link #MEDIA_ERROR_SERVER_DIED} 1402 * </ul> 1403 * @param extra an extra code, specific to the error. Typically 1404 * implementation dependant. 1405 * @return True if the method handled the error, false if it didn't. 1406 * Returning false, or not having an OnErrorListener at all, will 1407 * cause the OnCompletionListener to be called. 1408 */ 1409 boolean onError(MediaPlayer mp, int what, int extra); 1410 } 1411 1412 /** 1413 * Register a callback to be invoked when an error has happened 1414 * during an asynchronous operation. 1415 * 1416 * @param listener the callback that will be run 1417 */ 1418 public void setOnErrorListener(OnErrorListener listener) 1419 { 1420 mOnErrorListener = listener; 1421 } 1422 1423 private OnErrorListener mOnErrorListener; 1424 1425 1426 /* Do not change these values without updating their counterparts 1427 * in include/media/mediaplayer.h! 1428 */ 1429 /** Unspecified media player info. 1430 * @see android.media.MediaPlayer.OnInfoListener 1431 */ 1432 public static final int MEDIA_INFO_UNKNOWN = 1; 1433 1434 /** The video is too complex for the decoder: it can't decode frames fast 1435 * enough. Possibly only the audio plays fine at this stage. 1436 * @see android.media.MediaPlayer.OnInfoListener 1437 */ 1438 public static final int MEDIA_INFO_VIDEO_TRACK_LAGGING = 700; 1439 1440 /** Bad interleaving means that a media has been improperly interleaved or 1441 * not interleaved at all, e.g has all the video samples first then all the 1442 * audio ones. Video is playing but a lot of disk seeks may be happening. 1443 * @see android.media.MediaPlayer.OnInfoListener 1444 */ 1445 public static final int MEDIA_INFO_BAD_INTERLEAVING = 800; 1446 1447 /** The media cannot be seeked (e.g live stream) 1448 * @see android.media.MediaPlayer.OnInfoListener 1449 */ 1450 public static final int MEDIA_INFO_NOT_SEEKABLE = 801; 1451 1452 /** A new set of metadata is available. 1453 * @see android.media.MediaPlayer.OnInfoListener 1454 */ 1455 public static final int MEDIA_INFO_METADATA_UPDATE = 802; 1456 1457 /** 1458 * Interface definition of a callback to be invoked to communicate some 1459 * info and/or warning about the media or its playback. 1460 */ 1461 public interface OnInfoListener 1462 { 1463 /** 1464 * Called to indicate an info or a warning. 1465 * 1466 * @param mp the MediaPlayer the info pertains to. 1467 * @param what the type of info or warning. 1468 * <ul> 1469 * <li>{@link #MEDIA_INFO_UNKNOWN} 1470 * <li>{@link #MEDIA_INFO_VIDEO_TRACK_LAGGING} 1471 * <li>{@link #MEDIA_INFO_BAD_INTERLEAVING} 1472 * <li>{@link #MEDIA_INFO_NOT_SEEKABLE} 1473 * <li>{@link #MEDIA_INFO_METADATA_UPDATE} 1474 * </ul> 1475 * @param extra an extra code, specific to the info. Typically 1476 * implementation dependant. 1477 * @return True if the method handled the info, false if it didn't. 1478 * Returning false, or not having an OnErrorListener at all, will 1479 * cause the info to be discarded. 1480 */ 1481 boolean onInfo(MediaPlayer mp, int what, int extra); 1482 } 1483 1484 /** 1485 * Register a callback to be invoked when an info/warning is available. 1486 * 1487 * @param listener the callback that will be run 1488 */ 1489 public void setOnInfoListener(OnInfoListener listener) 1490 { 1491 mOnInfoListener = listener; 1492 } 1493 1494 private OnInfoListener mOnInfoListener; 1495} 1496