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