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