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