MediaPlayer.java revision 4a51c20ce607c74914f90fd897f04080121ac13b
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 native_init(); 470 } 471 472 private final static String TAG = "MediaPlayer"; 473 // Name of the remote interface for the media player. Must be kept 474 // in sync with the 2nd parameter of the IMPLEMENT_META_INTERFACE 475 // macro invocation in IMediaPlayer.cpp 476 private final static String IMEDIA_PLAYER = "android.media.IMediaPlayer"; 477 478 private int mNativeContext; // accessed by native methods 479 private int mListenerContext; // accessed by native methods 480 private Surface mSurface; // accessed by native methods 481 private SurfaceHolder mSurfaceHolder; 482 private EventHandler mEventHandler; 483 private PowerManager.WakeLock mWakeLock = null; 484 private boolean mScreenOnWhilePlaying; 485 private boolean mStayAwake; 486 487 /** 488 * Default constructor. Consider using one of the create() methods for 489 * synchronously instantiating a MediaPlayer from a Uri or resource. 490 * <p>When done with the MediaPlayer, you should call {@link #release()}, 491 * to free the resources. If not released, too many MediaPlayer instances may 492 * result in an exception.</p> 493 */ 494 public MediaPlayer() { 495 496 Looper looper; 497 if ((looper = Looper.myLooper()) != null) { 498 mEventHandler = new EventHandler(this, looper); 499 } else if ((looper = Looper.getMainLooper()) != null) { 500 mEventHandler = new EventHandler(this, looper); 501 } else { 502 mEventHandler = null; 503 } 504 505 /* Native setup requires a weak reference to our object. 506 * It's easier to create it here than in C++. 507 */ 508 native_setup(new WeakReference<MediaPlayer>(this)); 509 } 510 511 /* 512 * Update the MediaPlayer ISurface. Call after updating mSurface. 513 */ 514 private native void _setVideoSurface(); 515 516 /** 517 * Create a request parcel which can be routed to the native media 518 * player using {@link #invoke(Parcel, Parcel)}. The Parcel 519 * returned has the proper InterfaceToken set. The caller should 520 * not overwrite that token, i.e it can only append data to the 521 * Parcel. 522 * 523 * @return A parcel suitable to hold a request for the native 524 * player. 525 */ 526 public Parcel newRequest() { 527 Parcel parcel = Parcel.obtain(); 528 parcel.writeInterfaceToken(IMEDIA_PLAYER); 529 return parcel; 530 } 531 532 /** 533 * Invoke a generic method on the native player using opaque 534 * parcels for the request and reply. Both payloads' format is a 535 * convention between the java caller and the native player. 536 * Must be called after setDataSource to make sure a native player 537 * exists. 538 * 539 * @param request Parcel with the data for the extension. The 540 * caller must use {@link #newRequest()} to get one. 541 * 542 * @param reply Output parcel with the data returned by the 543 * native player. 544 * 545 * @return The status code see utils/Errors.h 546 */ 547 public int invoke(Parcel request, Parcel reply) { 548 int retcode = native_invoke(request, reply); 549 reply.setDataPosition(0); 550 return retcode; 551 } 552 553 /** 554 * Sets the SurfaceHolder to use for displaying the video portion of the media. 555 * This call is optional. Not calling it when playing back a video will 556 * result in only the audio track being played. 557 * 558 * @param sh the SurfaceHolder to use for video display 559 */ 560 public void setDisplay(SurfaceHolder sh) { 561 mSurfaceHolder = sh; 562 if (sh != null) { 563 mSurface = sh.getSurface(); 564 } else { 565 mSurface = null; 566 } 567 _setVideoSurface(); 568 updateSurfaceScreenOn(); 569 } 570 571 /** 572 * Convenience method to create a MediaPlayer for a given Uri. 573 * On success, {@link #prepare()} will already have been called and must not be called again. 574 * <p>When done with the MediaPlayer, you should call {@link #release()}, 575 * to free the resources. If not released, too many MediaPlayer instances will 576 * result in an exception.</p> 577 * 578 * @param context the Context to use 579 * @param uri the Uri from which to get the datasource 580 * @return a MediaPlayer object, or null if creation failed 581 */ 582 public static MediaPlayer create(Context context, Uri uri) { 583 return create (context, uri, null); 584 } 585 586 /** 587 * Convenience method to create a MediaPlayer for a given Uri. 588 * On success, {@link #prepare()} will already have been called and must not be called again. 589 * <p>When done with the MediaPlayer, you should call {@link #release()}, 590 * to free the resources. If not released, too many MediaPlayer instances will 591 * result in an exception.</p> 592 * 593 * @param context the Context to use 594 * @param uri the Uri from which to get the datasource 595 * @param holder the SurfaceHolder to use for displaying the video 596 * @return a MediaPlayer object, or null if creation failed 597 */ 598 public static MediaPlayer create(Context context, Uri uri, SurfaceHolder holder) { 599 600 try { 601 MediaPlayer mp = new MediaPlayer(); 602 mp.setDataSource(context, uri); 603 if (holder != null) { 604 mp.setDisplay(holder); 605 } 606 mp.prepare(); 607 return mp; 608 } catch (IOException ex) { 609 Log.d(TAG, "create failed:", ex); 610 // fall through 611 } catch (IllegalArgumentException ex) { 612 Log.d(TAG, "create failed:", ex); 613 // fall through 614 } catch (SecurityException ex) { 615 Log.d(TAG, "create failed:", ex); 616 // fall through 617 } 618 619 return null; 620 } 621 622 /** 623 * Convenience method to create a MediaPlayer for a given resource id. 624 * On success, {@link #prepare()} will already have been called and must not be called again. 625 * <p>When done with the MediaPlayer, you should call {@link #release()}, 626 * to free the resources. If not released, too many MediaPlayer instances will 627 * result in an exception.</p> 628 * 629 * @param context the Context to use 630 * @param resid the raw resource id (<var>R.raw.<something></var>) for 631 * the resource to use as the datasource 632 * @return a MediaPlayer object, or null if creation failed 633 */ 634 public static MediaPlayer create(Context context, int resid) { 635 try { 636 AssetFileDescriptor afd = context.getResources().openRawResourceFd(resid); 637 if (afd == null) return null; 638 639 MediaPlayer mp = new MediaPlayer(); 640 mp.setDataSource(afd.getFileDescriptor(), afd.getStartOffset(), afd.getLength()); 641 afd.close(); 642 mp.prepare(); 643 return mp; 644 } catch (IOException ex) { 645 Log.d(TAG, "create failed:", ex); 646 // fall through 647 } catch (IllegalArgumentException ex) { 648 Log.d(TAG, "create failed:", ex); 649 // fall through 650 } catch (SecurityException ex) { 651 Log.d(TAG, "create failed:", ex); 652 // fall through 653 } 654 return null; 655 } 656 657 /** 658 * Sets the data source as a content Uri. 659 * 660 * @param context the Context to use when resolving the Uri 661 * @param uri the Content URI of the data you want to play 662 * @throws IllegalStateException if it is called in an invalid state 663 */ 664 public void setDataSource(Context context, Uri uri) 665 throws IOException, IllegalArgumentException, SecurityException, IllegalStateException { 666 667 String scheme = uri.getScheme(); 668 if(scheme == null || scheme.equals("file")) { 669 setDataSource(uri.getPath()); 670 return; 671 } 672 673 AssetFileDescriptor fd = null; 674 try { 675 ContentResolver resolver = context.getContentResolver(); 676 fd = resolver.openAssetFileDescriptor(uri, "r"); 677 if (fd == null) { 678 return; 679 } 680 // Note: using getDeclaredLength so that our behavior is the same 681 // as previous versions when the content provider is returning 682 // a full file. 683 if (fd.getDeclaredLength() < 0) { 684 setDataSource(fd.getFileDescriptor()); 685 } else { 686 setDataSource(fd.getFileDescriptor(), fd.getStartOffset(), fd.getDeclaredLength()); 687 } 688 return; 689 } catch (SecurityException ex) { 690 } catch (IOException ex) { 691 } finally { 692 if (fd != null) { 693 fd.close(); 694 } 695 } 696 Log.d(TAG, "Couldn't open file on client side, trying server side"); 697 setDataSource(uri.toString()); 698 return; 699 } 700 701 /** 702 * Sets the data source (file-path or http/rtsp URL) to use. 703 * 704 * @param path the path of the file, or the http/rtsp URL of the stream you want to play 705 * @throws IllegalStateException if it is called in an invalid state 706 */ 707 public native void setDataSource(String path) throws IOException, IllegalArgumentException, IllegalStateException; 708 709 /** 710 * Sets the data source (FileDescriptor) to use. It is the caller's responsibility 711 * to close the file descriptor. It is safe to do so as soon as this call returns. 712 * 713 * @param fd the FileDescriptor for the file you want to play 714 * @throws IllegalStateException if it is called in an invalid state 715 */ 716 public void setDataSource(FileDescriptor fd) 717 throws IOException, IllegalArgumentException, IllegalStateException { 718 // intentionally less than LONG_MAX 719 setDataSource(fd, 0, 0x7ffffffffffffffL); 720 } 721 722 /** 723 * Sets the data source (FileDescriptor) to use. It is the caller's responsibility 724 * to close the file descriptor. It is safe to do so as soon as this call returns. 725 * 726 * @param fd the FileDescriptor for the file you want to play 727 * @param offset the offset into the file where the data to be played starts, in bytes 728 * @param length the length in bytes of the data to be played 729 * @throws IllegalStateException if it is called in an invalid state 730 */ 731 public native void setDataSource(FileDescriptor fd, long offset, long length) 732 throws IOException, IllegalArgumentException, IllegalStateException; 733 734 /** 735 * Prepares the player for playback, synchronously. 736 * 737 * After setting the datasource and the display surface, you need to either 738 * call prepare() or prepareAsync(). For files, it is OK to call prepare(), 739 * which blocks until MediaPlayer is ready for playback. 740 * 741 * @throws IllegalStateException if it is called in an invalid state 742 */ 743 public native void prepare() throws IOException, IllegalStateException; 744 745 /** 746 * Prepares the player for playback, asynchronously. 747 * 748 * After setting the datasource and the display surface, you need to either 749 * call prepare() or prepareAsync(). For streams, you should call prepareAsync(), 750 * which returns immediately, rather than blocking until enough data has been 751 * buffered. 752 * 753 * @throws IllegalStateException if it is called in an invalid state 754 */ 755 public native void prepareAsync() throws IllegalStateException; 756 757 /** 758 * Starts or resumes playback. If playback had previously been paused, 759 * playback will continue from where it was paused. If playback had 760 * been stopped, or never started before, playback will start at the 761 * beginning. 762 * 763 * @throws IllegalStateException if it is called in an invalid state 764 */ 765 public void start() throws IllegalStateException { 766 stayAwake(true); 767 _start(); 768 } 769 770 private native void _start() throws IllegalStateException; 771 772 /** 773 * Stops playback after playback has been stopped or paused. 774 * 775 * @throws IllegalStateException if the internal player engine has not been 776 * initialized. 777 */ 778 public void stop() throws IllegalStateException { 779 stayAwake(false); 780 _stop(); 781 } 782 783 private native void _stop() throws IllegalStateException; 784 785 /** 786 * Pauses playback. Call start() to resume. 787 * 788 * @throws IllegalStateException if the internal player engine has not been 789 * initialized. 790 */ 791 public void pause() throws IllegalStateException { 792 stayAwake(false); 793 _pause(); 794 } 795 796 private native void _pause() throws IllegalStateException; 797 798 /** 799 * Set the low-level power management behavior for this MediaPlayer. This 800 * can be used when the MediaPlayer is not playing through a SurfaceHolder 801 * set with {@link #setDisplay(SurfaceHolder)} and thus can use the 802 * high-level {@link #setScreenOnWhilePlaying(boolean)} feature. 803 * 804 * <p>This function has the MediaPlayer access the low-level power manager 805 * service to control the device's power usage while playing is occurring. 806 * The parameter is a combination of {@link android.os.PowerManager} wake flags. 807 * Use of this method requires {@link android.Manifest.permission#WAKE_LOCK} 808 * permission. 809 * By default, no attempt is made to keep the device awake during playback. 810 * 811 * @param context the Context to use 812 * @param mode the power/wake mode to set 813 * @see android.os.PowerManager 814 */ 815 public void setWakeMode(Context context, int mode) { 816 boolean washeld = false; 817 if (mWakeLock != null) { 818 if (mWakeLock.isHeld()) { 819 washeld = true; 820 mWakeLock.release(); 821 } 822 mWakeLock = null; 823 } 824 825 PowerManager pm = (PowerManager)context.getSystemService(Context.POWER_SERVICE); 826 mWakeLock = pm.newWakeLock(mode|PowerManager.ON_AFTER_RELEASE, MediaPlayer.class.getName()); 827 mWakeLock.setReferenceCounted(false); 828 if (washeld) { 829 mWakeLock.acquire(); 830 } 831 } 832 833 /** 834 * Control whether we should use the attached SurfaceHolder to keep the 835 * screen on while video playback is occurring. This is the preferred 836 * method over {@link #setWakeMode} where possible, since it doesn't 837 * require that the application have permission for low-level wake lock 838 * access. 839 * 840 * @param screenOn Supply true to keep the screen on, false to allow it 841 * to turn off. 842 */ 843 public void setScreenOnWhilePlaying(boolean screenOn) { 844 if (mScreenOnWhilePlaying != screenOn) { 845 mScreenOnWhilePlaying = screenOn; 846 updateSurfaceScreenOn(); 847 } 848 } 849 850 private void stayAwake(boolean awake) { 851 if (mWakeLock != null) { 852 if (awake && !mWakeLock.isHeld()) { 853 mWakeLock.acquire(); 854 } else if (!awake && mWakeLock.isHeld()) { 855 mWakeLock.release(); 856 } 857 } 858 mStayAwake = awake; 859 updateSurfaceScreenOn(); 860 } 861 862 private void updateSurfaceScreenOn() { 863 if (mSurfaceHolder != null) { 864 mSurfaceHolder.setKeepScreenOn(mScreenOnWhilePlaying && mStayAwake); 865 } 866 } 867 868 /** 869 * Returns the width of the video. 870 * 871 * @return the width of the video, or 0 if there is no video, 872 * no display surface was set, or prepare()/prepareAsync() 873 * have not completed yet 874 */ 875 public native int getVideoWidth(); 876 877 /** 878 * Returns the height of the video. 879 * 880 * @return the height of the video, or 0 if there is no video, 881 * no display surface was set, or prepare()/prepareAsync() 882 * have not completed yet 883 */ 884 public native int getVideoHeight(); 885 886 /** 887 * Checks whether the MediaPlayer is playing. 888 * 889 * @return true if currently playing, false otherwise 890 */ 891 public native boolean isPlaying(); 892 893 /** 894 * Seeks to specified time position. 895 * 896 * @param msec the offset in milliseconds from the start to seek to 897 * @throws IllegalStateException if the internal player engine has not been 898 * initialized 899 */ 900 public native void seekTo(int msec) throws IllegalStateException; 901 902 /** 903 * Gets the current playback position. 904 * 905 * @return the current position in milliseconds 906 */ 907 public native int getCurrentPosition(); 908 909 /** 910 * Gets the duration of the file. 911 * 912 * @return the duration in milliseconds 913 */ 914 public native int getDuration(); 915 916 /** 917 * Gets the media metadata. 918 * 919 * @param update_only controls whether the full set of available 920 * metadata is returned or just the set that changed since the 921 * last call. See {@see #METADATA_UPDATE_ONLY} and {@see 922 * #METADATA_ALL}. 923 * 924 * @param apply_filter if true only metadata that matches the 925 * filter is returned. See {@see #APPLY_METADATA_FILTER} and {@see 926 * #BYPASS_METADATA_FILTER}. 927 * 928 * @return The metadata, possibly empty. null if an error occured. 929 // FIXME: unhide. 930 * {@hide} 931 */ 932 public Metadata getMetadata(final boolean update_only, 933 final boolean apply_filter) { 934 Parcel reply = Parcel.obtain(); 935 Metadata data = new Metadata(); 936 937 if (!native_getMetadata(update_only, apply_filter, reply)) { 938 reply.recycle(); 939 return null; 940 } 941 942 // Metadata takes over the parcel, don't recycle it unless 943 // there is an error. 944 if (!data.parse(reply)) { 945 reply.recycle(); 946 return null; 947 } 948 return data; 949 } 950 951 /** 952 * Set a filter for the metadata update notification and update 953 * retrieval. The caller provides 2 set of metadata keys, allowed 954 * and blocked. The blocked set always takes precedence over the 955 * allowed one. 956 * Metadata.MATCH_ALL and Metadata.MATCH_NONE are 2 sets available as 957 * shorthands to allow/block all or no metadata. 958 * 959 * By default, there is no filter set. 960 * 961 * @param allow Is the set of metadata the client is interested 962 * in receiving new notifications for. 963 * @param block Is the set of metadata the client is not interested 964 * in receiving new notifications for. 965 * @return The call status code. 966 * 967 // FIXME: unhide. 968 * {@hide} 969 */ 970 public int setMetadataFilter(Set<Integer> allow, Set<Integer> block) { 971 // Do our serialization manually instead of calling 972 // Parcel.writeArray since the sets are made of the same type 973 // we avoid paying the price of calling writeValue (used by 974 // writeArray) which burns an extra int per element to encode 975 // the type. 976 Parcel request = newRequest(); 977 978 // The parcel starts already with an interface token. There 979 // are 2 filters. Each one starts with a 4bytes number to 980 // store the len followed by a number of int (4 bytes as well) 981 // representing the metadata type. 982 int capacity = request.dataSize() + 4 * (1 + allow.size() + 1 + block.size()); 983 984 if (request.dataCapacity() < capacity) { 985 request.setDataCapacity(capacity); 986 } 987 988 request.writeInt(allow.size()); 989 for(Integer t: allow) { 990 request.writeInt(t); 991 } 992 request.writeInt(block.size()); 993 for(Integer t: block) { 994 request.writeInt(t); 995 } 996 return native_setMetadataFilter(request); 997 } 998 999 /** 1000 * Releases resources associated with this MediaPlayer object. 1001 * It is considered good practice to call this method when you're 1002 * done using the MediaPlayer. 1003 */ 1004 public void release() { 1005 stayAwake(false); 1006 updateSurfaceScreenOn(); 1007 mOnPreparedListener = null; 1008 mOnBufferingUpdateListener = null; 1009 mOnCompletionListener = null; 1010 mOnSeekCompleteListener = null; 1011 mOnErrorListener = null; 1012 mOnInfoListener = null; 1013 mOnVideoSizeChangedListener = null; 1014 _release(); 1015 } 1016 1017 private native void _release(); 1018 1019 /** 1020 * Resets the MediaPlayer to its uninitialized state. After calling 1021 * this method, you will have to initialize it again by setting the 1022 * data source and calling prepare(). 1023 */ 1024 public void reset() { 1025 stayAwake(false); 1026 _reset(); 1027 // make sure none of the listeners get called anymore 1028 mEventHandler.removeCallbacksAndMessages(null); 1029 } 1030 1031 private native void _reset(); 1032 1033 /** 1034 * Sets the audio stream type for this MediaPlayer. See {@link AudioManager} 1035 * for a list of stream types. 1036 * 1037 * @param streamtype the audio stream type 1038 * @see android.media.AudioManager 1039 */ 1040 public native void setAudioStreamType(int streamtype); 1041 1042 /** 1043 * Sets the player to be looping or non-looping. 1044 * 1045 * @param looping whether to loop or not 1046 */ 1047 public native void setLooping(boolean looping); 1048 1049 /** 1050 * Checks whether the MediaPlayer is looping or non-looping. 1051 * 1052 * @return true if the MediaPlayer is currently looping, false otherwise 1053 */ 1054 public native boolean isLooping(); 1055 1056 /** 1057 * Sets the volume on this player. 1058 * This API is recommended for balancing the output of audio streams 1059 * within an application. Unless you are writing an application to 1060 * control user settings, this API should be used in preference to 1061 * {@link AudioManager#setStreamVolume(int, int, int)} which sets the volume of ALL streams of 1062 * a particular type. Note that the passed volume values are raw scalars. 1063 * UI controls should be scaled logarithmically. 1064 * 1065 * @param leftVolume left volume scalar 1066 * @param rightVolume right volume scalar 1067 */ 1068 public native void setVolume(float leftVolume, float rightVolume); 1069 1070 /** 1071 * Currently not implemented, returns null. 1072 * @deprecated 1073 * @hide 1074 */ 1075 public native Bitmap getFrameAt(int msec) throws IllegalStateException; 1076 1077 /** 1078 * @param request Parcel destinated to the media player. The 1079 * Interface token must be set to the IMediaPlayer 1080 * one to be routed correctly through the system. 1081 * @param reply[out] Parcel that will contain the reply. 1082 * @return The status code. 1083 */ 1084 private native final int native_invoke(Parcel request, Parcel reply); 1085 1086 1087 /** 1088 * @param update_only If true fetch only the set of metadata that have 1089 * changed since the last invocation of getMetadata. 1090 * The set is built using the unfiltered 1091 * notifications the native player sent to the 1092 * MediaPlayerService during that period of 1093 * time. If false, all the metadatas are considered. 1094 * @param apply_filter If true, once the metadata set has been built based on 1095 * the value update_only, the current filter is applied. 1096 * @param reply[out] On return contains the serialized 1097 * metadata. Valid only if the call was successful. 1098 * @return The status code. 1099 */ 1100 private native final boolean native_getMetadata(boolean update_only, 1101 boolean apply_filter, 1102 Parcel reply); 1103 1104 /** 1105 * @param request Parcel with the 2 serialized lists of allowed 1106 * metadata types followed by the one to be 1107 * dropped. Each list starts with an integer 1108 * indicating the number of metadata type elements. 1109 * @return The status code. 1110 */ 1111 private native final int native_setMetadataFilter(Parcel request); 1112 1113 private static native final void native_init(); 1114 private native final void native_setup(Object mediaplayer_this); 1115 private native final void native_finalize(); 1116 1117 @Override 1118 protected void finalize() { native_finalize(); } 1119 1120 /* Do not change these values without updating their counterparts 1121 * in include/media/mediaplayer.h! 1122 */ 1123 private static final int MEDIA_NOP = 0; // interface test message 1124 private static final int MEDIA_PREPARED = 1; 1125 private static final int MEDIA_PLAYBACK_COMPLETE = 2; 1126 private static final int MEDIA_BUFFERING_UPDATE = 3; 1127 private static final int MEDIA_SEEK_COMPLETE = 4; 1128 private static final int MEDIA_SET_VIDEO_SIZE = 5; 1129 private static final int MEDIA_ERROR = 100; 1130 private static final int MEDIA_INFO = 200; 1131 1132 private class EventHandler extends Handler 1133 { 1134 private MediaPlayer mMediaPlayer; 1135 1136 public EventHandler(MediaPlayer mp, Looper looper) { 1137 super(looper); 1138 mMediaPlayer = mp; 1139 } 1140 1141 @Override 1142 public void handleMessage(Message msg) { 1143 if (mMediaPlayer.mNativeContext == 0) { 1144 Log.w(TAG, "mediaplayer went away with unhandled events"); 1145 return; 1146 } 1147 switch(msg.what) { 1148 case MEDIA_PREPARED: 1149 if (mOnPreparedListener != null) 1150 mOnPreparedListener.onPrepared(mMediaPlayer); 1151 return; 1152 1153 case MEDIA_PLAYBACK_COMPLETE: 1154 if (mOnCompletionListener != null) 1155 mOnCompletionListener.onCompletion(mMediaPlayer); 1156 stayAwake(false); 1157 return; 1158 1159 case MEDIA_BUFFERING_UPDATE: 1160 if (mOnBufferingUpdateListener != null) 1161 mOnBufferingUpdateListener.onBufferingUpdate(mMediaPlayer, msg.arg1); 1162 return; 1163 1164 case MEDIA_SEEK_COMPLETE: 1165 if (mOnSeekCompleteListener != null) 1166 mOnSeekCompleteListener.onSeekComplete(mMediaPlayer); 1167 return; 1168 1169 case MEDIA_SET_VIDEO_SIZE: 1170 if (mOnVideoSizeChangedListener != null) 1171 mOnVideoSizeChangedListener.onVideoSizeChanged(mMediaPlayer, msg.arg1, msg.arg2); 1172 return; 1173 1174 case MEDIA_ERROR: 1175 // For PV specific error values (msg.arg2) look in 1176 // opencore/pvmi/pvmf/include/pvmf_return_codes.h 1177 Log.e(TAG, "Error (" + msg.arg1 + "," + msg.arg2 + ")"); 1178 boolean error_was_handled = false; 1179 if (mOnErrorListener != null) { 1180 error_was_handled = mOnErrorListener.onError(mMediaPlayer, msg.arg1, msg.arg2); 1181 } 1182 if (mOnCompletionListener != null && ! error_was_handled) { 1183 mOnCompletionListener.onCompletion(mMediaPlayer); 1184 } 1185 stayAwake(false); 1186 return; 1187 1188 case MEDIA_INFO: 1189 // For PV specific code values (msg.arg2) look in 1190 // opencore/pvmi/pvmf/include/pvmf_return_codes.h 1191 Log.i(TAG, "Info (" + msg.arg1 + "," + msg.arg2 + ")"); 1192 if (mOnInfoListener != null) { 1193 mOnInfoListener.onInfo(mMediaPlayer, msg.arg1, msg.arg2); 1194 } 1195 // No real default action so far. 1196 return; 1197 1198 case MEDIA_NOP: // interface test message - ignore 1199 break; 1200 1201 default: 1202 Log.e(TAG, "Unknown message type " + msg.what); 1203 return; 1204 } 1205 } 1206 } 1207 1208 /** 1209 * Called from native code when an interesting event happens. This method 1210 * just uses the EventHandler system to post the event back to the main app thread. 1211 * We use a weak reference to the original MediaPlayer object so that the native 1212 * code is safe from the object disappearing from underneath it. (This is 1213 * the cookie passed to native_setup().) 1214 */ 1215 private static void postEventFromNative(Object mediaplayer_ref, 1216 int what, int arg1, int arg2, Object obj) 1217 { 1218 MediaPlayer mp = (MediaPlayer)((WeakReference)mediaplayer_ref).get(); 1219 if (mp == null) { 1220 return; 1221 } 1222 1223 if (mp.mEventHandler != null) { 1224 Message m = mp.mEventHandler.obtainMessage(what, arg1, arg2, obj); 1225 mp.mEventHandler.sendMessage(m); 1226 } 1227 } 1228 1229 /** 1230 * Interface definition for a callback to be invoked when the media 1231 * source is ready for playback. 1232 */ 1233 public interface OnPreparedListener 1234 { 1235 /** 1236 * Called when the media file is ready for playback. 1237 * 1238 * @param mp the MediaPlayer that is ready for playback 1239 */ 1240 void onPrepared(MediaPlayer mp); 1241 } 1242 1243 /** 1244 * Register a callback to be invoked when the media source is ready 1245 * for playback. 1246 * 1247 * @param listener the callback that will be run 1248 */ 1249 public void setOnPreparedListener(OnPreparedListener listener) 1250 { 1251 mOnPreparedListener = listener; 1252 } 1253 1254 private OnPreparedListener mOnPreparedListener; 1255 1256 /** 1257 * Interface definition for a callback to be invoked when playback of 1258 * a media source has completed. 1259 */ 1260 public interface OnCompletionListener 1261 { 1262 /** 1263 * Called when the end of a media source is reached during playback. 1264 * 1265 * @param mp the MediaPlayer that reached the end of the file 1266 */ 1267 void onCompletion(MediaPlayer mp); 1268 } 1269 1270 /** 1271 * Register a callback to be invoked when the end of a media source 1272 * has been reached during playback. 1273 * 1274 * @param listener the callback that will be run 1275 */ 1276 public void setOnCompletionListener(OnCompletionListener listener) 1277 { 1278 mOnCompletionListener = listener; 1279 } 1280 1281 private OnCompletionListener mOnCompletionListener; 1282 1283 /** 1284 * Interface definition of a callback to be invoked indicating buffering 1285 * status of a media resource being streamed over the network. 1286 */ 1287 public interface OnBufferingUpdateListener 1288 { 1289 /** 1290 * Called to update status in buffering a media stream. 1291 * 1292 * @param mp the MediaPlayer the update pertains to 1293 * @param percent the percentage (0-100) of the buffer 1294 * that has been filled thus far 1295 */ 1296 void onBufferingUpdate(MediaPlayer mp, int percent); 1297 } 1298 1299 /** 1300 * Register a callback to be invoked when the status of a network 1301 * stream's buffer has changed. 1302 * 1303 * @param listener the callback that will be run. 1304 */ 1305 public void setOnBufferingUpdateListener(OnBufferingUpdateListener listener) 1306 { 1307 mOnBufferingUpdateListener = listener; 1308 } 1309 1310 private OnBufferingUpdateListener mOnBufferingUpdateListener; 1311 1312 /** 1313 * Interface definition of a callback to be invoked indicating 1314 * the completion of a seek operation. 1315 */ 1316 public interface OnSeekCompleteListener 1317 { 1318 /** 1319 * Called to indicate the completion of a seek operation. 1320 * 1321 * @param mp the MediaPlayer that issued the seek operation 1322 */ 1323 public void onSeekComplete(MediaPlayer mp); 1324 } 1325 1326 /** 1327 * Register a callback to be invoked when a seek operation has been 1328 * completed. 1329 * 1330 * @param listener the callback that will be run 1331 */ 1332 public void setOnSeekCompleteListener(OnSeekCompleteListener listener) 1333 { 1334 mOnSeekCompleteListener = listener; 1335 } 1336 1337 private OnSeekCompleteListener mOnSeekCompleteListener; 1338 1339 /** 1340 * Interface definition of a callback to be invoked when the 1341 * video size is first known or updated 1342 */ 1343 public interface OnVideoSizeChangedListener 1344 { 1345 /** 1346 * Called to indicate the video size 1347 * 1348 * @param mp the MediaPlayer associated with this callback 1349 * @param width the width of the video 1350 * @param height the height of the video 1351 */ 1352 public void onVideoSizeChanged(MediaPlayer mp, int width, int height); 1353 } 1354 1355 /** 1356 * Register a callback to be invoked when the video size is 1357 * known or updated. 1358 * 1359 * @param listener the callback that will be run 1360 */ 1361 public void setOnVideoSizeChangedListener(OnVideoSizeChangedListener listener) 1362 { 1363 mOnVideoSizeChangedListener = listener; 1364 } 1365 1366 private OnVideoSizeChangedListener mOnVideoSizeChangedListener; 1367 1368 /* Do not change these values without updating their counterparts 1369 * in include/media/mediaplayer.h! 1370 */ 1371 /** Unspecified media player error. 1372 * @see android.media.MediaPlayer.OnErrorListener 1373 */ 1374 public static final int MEDIA_ERROR_UNKNOWN = 1; 1375 1376 /** Media server died. In this case, the application must release the 1377 * MediaPlayer object and instantiate a new one. 1378 * @see android.media.MediaPlayer.OnErrorListener 1379 */ 1380 public static final int MEDIA_ERROR_SERVER_DIED = 100; 1381 1382 /** The video is streamed and its container is not valid for progressive 1383 * playback i.e the video's index (e.g moov atom) is not at the start of the 1384 * file. 1385 * @see android.media.MediaPlayer.OnErrorListener 1386 */ 1387 public static final int MEDIA_ERROR_NOT_VALID_FOR_PROGRESSIVE_PLAYBACK = 200; 1388 1389 /** 1390 * Interface definition of a callback to be invoked when there 1391 * has been an error during an asynchronous operation (other errors 1392 * will throw exceptions at method call time). 1393 */ 1394 public interface OnErrorListener 1395 { 1396 /** 1397 * Called to indicate an error. 1398 * 1399 * @param mp the MediaPlayer the error pertains to 1400 * @param what the type of error that has occurred: 1401 * <ul> 1402 * <li>{@link #MEDIA_ERROR_UNKNOWN} 1403 * <li>{@link #MEDIA_ERROR_SERVER_DIED} 1404 * </ul> 1405 * @param extra an extra code, specific to the error. Typically 1406 * implementation dependant. 1407 * @return True if the method handled the error, false if it didn't. 1408 * Returning false, or not having an OnErrorListener at all, will 1409 * cause the OnCompletionListener to be called. 1410 */ 1411 boolean onError(MediaPlayer mp, int what, int extra); 1412 } 1413 1414 /** 1415 * Register a callback to be invoked when an error has happened 1416 * during an asynchronous operation. 1417 * 1418 * @param listener the callback that will be run 1419 */ 1420 public void setOnErrorListener(OnErrorListener listener) 1421 { 1422 mOnErrorListener = listener; 1423 } 1424 1425 private OnErrorListener mOnErrorListener; 1426 1427 1428 /* Do not change these values without updating their counterparts 1429 * in include/media/mediaplayer.h! 1430 */ 1431 /** Unspecified media player info. 1432 * @see android.media.MediaPlayer.OnInfoListener 1433 */ 1434 public static final int MEDIA_INFO_UNKNOWN = 1; 1435 1436 /** The video is too complex for the decoder: it can't decode frames fast 1437 * enough. Possibly only the audio plays fine at this stage. 1438 * @see android.media.MediaPlayer.OnInfoListener 1439 */ 1440 public static final int MEDIA_INFO_VIDEO_TRACK_LAGGING = 700; 1441 1442 /** Bad interleaving means that a media has been improperly interleaved or 1443 * not interleaved at all, e.g has all the video samples first then all the 1444 * audio ones. Video is playing but a lot of disk seeks may be happening. 1445 * @see android.media.MediaPlayer.OnInfoListener 1446 */ 1447 public static final int MEDIA_INFO_BAD_INTERLEAVING = 800; 1448 1449 /** The media cannot be seeked (e.g live stream) 1450 * @see android.media.MediaPlayer.OnInfoListener 1451 */ 1452 public static final int MEDIA_INFO_NOT_SEEKABLE = 801; 1453 1454 /** A new set of metadata is available. 1455 * @see android.media.MediaPlayer.OnInfoListener 1456 */ 1457 public static final int MEDIA_INFO_METADATA_UPDATE = 802; 1458 1459 /** 1460 * Interface definition of a callback to be invoked to communicate some 1461 * info and/or warning about the media or its playback. 1462 */ 1463 public interface OnInfoListener 1464 { 1465 /** 1466 * Called to indicate an info or a warning. 1467 * 1468 * @param mp the MediaPlayer the info pertains to. 1469 * @param what the type of info or warning. 1470 * <ul> 1471 * <li>{@link #MEDIA_INFO_UNKNOWN} 1472 * <li>{@link #MEDIA_INFO_VIDEO_TRACK_LAGGING} 1473 * <li>{@link #MEDIA_INFO_BAD_INTERLEAVING} 1474 * <li>{@link #MEDIA_INFO_NOT_SEEKABLE} 1475 * <li>{@link #MEDIA_INFO_METADATA_UPDATE} 1476 * </ul> 1477 * @param extra an extra code, specific to the info. Typically 1478 * implementation dependant. 1479 * @return True if the method handled the info, false if it didn't. 1480 * Returning false, or not having an OnErrorListener at all, will 1481 * cause the info to be discarded. 1482 */ 1483 boolean onInfo(MediaPlayer mp, int what, int extra); 1484 } 1485 1486 /** 1487 * Register a callback to be invoked when an info/warning is available. 1488 * 1489 * @param listener the callback that will be run 1490 */ 1491 public void setOnInfoListener(OnInfoListener listener) 1492 { 1493 mOnInfoListener = listener; 1494 } 1495 1496 private OnInfoListener mOnInfoListener; 1497} 1498