MediaPlayer.java revision 068225de0197df07a0247b2877666ea91c22c992
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.Parcelable; 28import android.os.ParcelFileDescriptor; 29import android.os.PowerManager; 30import android.util.Log; 31import android.view.Surface; 32import android.view.SurfaceHolder; 33import android.graphics.Bitmap; 34import android.graphics.SurfaceTexture; 35import android.media.AudioManager; 36 37import java.io.File; 38import java.io.FileDescriptor; 39import java.io.FileInputStream; 40import java.io.IOException; 41import java.net.InetSocketAddress; 42import java.util.Map; 43import java.util.Set; 44import java.lang.ref.WeakReference; 45 46/** 47 * MediaPlayer class can be used to control playback 48 * of audio/video files and streams. An example on how to use the methods in 49 * this class can be found in {@link android.widget.VideoView}. 50 * 51 * <p>Topics covered here are: 52 * <ol> 53 * <li><a href="#StateDiagram">State Diagram</a> 54 * <li><a href="#Valid_and_Invalid_States">Valid and Invalid States</a> 55 * <li><a href="#Permissions">Permissions</a> 56 * <li><a href="#Callbacks">Register informational and error callbacks</a> 57 * </ol> 58 * 59 * <div class="special reference"> 60 * <h3>Developer Guides</h3> 61 * <p>For more information about how to use MediaPlayer, read the 62 * <a href="{@docRoot}guide/topics/media/mediaplayer.html">Media Playback</a> developer guide.</p> 63 * </div> 64 * 65 * <a name="StateDiagram"></a> 66 * <h3>State Diagram</h3> 67 * 68 * <p>Playback control of audio/video files and streams is managed as a state 69 * machine. The following diagram shows the life cycle and the states of a 70 * MediaPlayer object driven by the supported playback control operations. 71 * The ovals represent the states a MediaPlayer object may reside 72 * in. The arcs represent the playback control operations that drive the object 73 * state transition. There are two types of arcs. The arcs with a single arrow 74 * head represent synchronous method calls, while those with 75 * a double arrow head represent asynchronous method calls.</p> 76 * 77 * <p><img src="../../../images/mediaplayer_state_diagram.gif" 78 * alt="MediaPlayer State diagram" 79 * border="0" /></p> 80 * 81 * <p>From this state diagram, one can see that a MediaPlayer object has the 82 * following states:</p> 83 * <ul> 84 * <li>When a MediaPlayer object is just created using <code>new</code> or 85 * after {@link #reset()} is called, it is in the <em>Idle</em> state; and after 86 * {@link #release()} is called, it is in the <em>End</em> state. Between these 87 * two states is the life cycle of the MediaPlayer object. 88 * <ul> 89 * <li>There is a subtle but important difference between a newly constructed 90 * MediaPlayer object and the MediaPlayer object after {@link #reset()} 91 * is called. It is a programming error to invoke methods such 92 * as {@link #getCurrentPosition()}, 93 * {@link #getDuration()}, {@link #getVideoHeight()}, 94 * {@link #getVideoWidth()}, {@link #setAudioStreamType(int)}, 95 * {@link #setLooping(boolean)}, 96 * {@link #setVolume(float, float)}, {@link #pause()}, {@link #start()}, 97 * {@link #stop()}, {@link #seekTo(int)}, {@link #prepare()} or 98 * {@link #prepareAsync()} in the <em>Idle</em> state for both cases. If any of these 99 * methods is called right after a MediaPlayer object is constructed, 100 * the user supplied callback method OnErrorListener.onError() won't be 101 * called by the internal player engine and the object state remains 102 * unchanged; but if these methods are called right after {@link #reset()}, 103 * the user supplied callback method OnErrorListener.onError() will be 104 * invoked by the internal player engine and the object will be 105 * transfered to the <em>Error</em> state. </li> 106 * <li>It is also recommended that once 107 * a MediaPlayer object is no longer being used, call {@link #release()} immediately 108 * so that resources used by the internal player engine associated with the 109 * MediaPlayer object can be released immediately. Resource may include 110 * singleton resources such as hardware acceleration components and 111 * failure to call {@link #release()} may cause subsequent instances of 112 * MediaPlayer objects to fallback to software implementations or fail 113 * altogether. Once the MediaPlayer 114 * object is in the <em>End</em> state, it can no longer be used and 115 * there is no way to bring it back to any other state. </li> 116 * <li>Furthermore, 117 * the MediaPlayer objects created using <code>new</code> is in the 118 * <em>Idle</em> state, while those created with one 119 * of the overloaded convenient <code>create</code> methods are <em>NOT</em> 120 * in the <em>Idle</em> state. In fact, the objects are in the <em>Prepared</em> 121 * state if the creation using <code>create</code> method is successful. 122 * </li> 123 * </ul> 124 * </li> 125 * <li>In general, some playback control operation may fail due to various 126 * reasons, such as unsupported audio/video format, poorly interleaved 127 * audio/video, resolution too high, streaming timeout, and the like. 128 * Thus, error reporting and recovery is an important concern under 129 * these circumstances. Sometimes, due to programming errors, invoking a playback 130 * control operation in an invalid state may also occur. Under all these 131 * error conditions, the internal player engine invokes a user supplied 132 * OnErrorListener.onError() method if an OnErrorListener has been 133 * registered beforehand via 134 * {@link #setOnErrorListener(android.media.MediaPlayer.OnErrorListener)}. 135 * <ul> 136 * <li>It is important to note that once an error occurs, the 137 * MediaPlayer object enters the <em>Error</em> state (except as noted 138 * above), even if an error listener has not been registered by the application.</li> 139 * <li>In order to reuse a MediaPlayer object that is in the <em> 140 * Error</em> state and recover from the error, 141 * {@link #reset()} can be called to restore the object to its <em>Idle</em> 142 * state.</li> 143 * <li>It is good programming practice to have your application 144 * register a OnErrorListener to look out for error notifications from 145 * the internal player engine.</li> 146 * <li>IllegalStateException is 147 * thrown to prevent programming errors such as calling {@link #prepare()}, 148 * {@link #prepareAsync()}, or one of the overloaded <code>setDataSource 149 * </code> methods in an invalid state. </li> 150 * </ul> 151 * </li> 152 * <li>Calling 153 * {@link #setDataSource(FileDescriptor)}, or 154 * {@link #setDataSource(String)}, or 155 * {@link #setDataSource(Context, Uri)}, or 156 * {@link #setDataSource(FileDescriptor, long, long)} transfers a 157 * MediaPlayer object in the <em>Idle</em> state to the 158 * <em>Initialized</em> state. 159 * <ul> 160 * <li>An IllegalStateException is thrown if 161 * setDataSource() is called in any other state.</li> 162 * <li>It is good programming 163 * practice to always look out for <code>IllegalArgumentException</code> 164 * and <code>IOException</code> that may be thrown from the overloaded 165 * <code>setDataSource</code> methods.</li> 166 * </ul> 167 * </li> 168 * <li>A MediaPlayer object must first enter the <em>Prepared</em> state 169 * before playback can be started. 170 * <ul> 171 * <li>There are two ways (synchronous vs. 172 * asynchronous) that the <em>Prepared</em> state can be reached: 173 * either a call to {@link #prepare()} (synchronous) which 174 * transfers the object to the <em>Prepared</em> state once the method call 175 * returns, or a call to {@link #prepareAsync()} (asynchronous) which 176 * first transfers the object to the <em>Preparing</em> state after the 177 * call returns (which occurs almost right way) while the internal 178 * player engine continues working on the rest of preparation work 179 * until the preparation work completes. When the preparation completes or when {@link #prepare()} call returns, 180 * the internal player engine then calls a user supplied callback method, 181 * onPrepared() of the OnPreparedListener interface, if an 182 * OnPreparedListener is registered beforehand via {@link 183 * #setOnPreparedListener(android.media.MediaPlayer.OnPreparedListener)}.</li> 184 * <li>It is important to note that 185 * the <em>Preparing</em> state is a transient state, and the behavior 186 * of calling any method with side effect while a MediaPlayer object is 187 * in the <em>Preparing</em> state is undefined.</li> 188 * <li>An IllegalStateException is 189 * thrown if {@link #prepare()} or {@link #prepareAsync()} is called in 190 * any other state.</li> 191 * <li>While in the <em>Prepared</em> state, properties 192 * such as audio/sound volume, screenOnWhilePlaying, looping can be 193 * adjusted by invoking the corresponding set methods.</li> 194 * </ul> 195 * </li> 196 * <li>To start the playback, {@link #start()} must be called. After 197 * {@link #start()} returns successfully, the MediaPlayer object is in the 198 * <em>Started</em> state. {@link #isPlaying()} can be called to test 199 * whether the MediaPlayer object is in the <em>Started</em> state. 200 * <ul> 201 * <li>While in the <em>Started</em> state, the internal player engine calls 202 * a user supplied OnBufferingUpdateListener.onBufferingUpdate() callback 203 * method if a OnBufferingUpdateListener has been registered beforehand 204 * via {@link #setOnBufferingUpdateListener(OnBufferingUpdateListener)}. 205 * This callback allows applications to keep track of the buffering status 206 * while streaming audio/video.</li> 207 * <li>Calling {@link #start()} has not effect 208 * on a MediaPlayer object that is already in the <em>Started</em> state.</li> 209 * </ul> 210 * </li> 211 * <li>Playback can be paused and stopped, and the current playback position 212 * can be adjusted. Playback can be paused via {@link #pause()}. When the call to 213 * {@link #pause()} returns, the MediaPlayer object enters the 214 * <em>Paused</em> state. Note that the transition from the <em>Started</em> 215 * state to the <em>Paused</em> state and vice versa happens 216 * asynchronously in the player engine. It may take some time before 217 * the state is updated in calls to {@link #isPlaying()}, and it can be 218 * a number of seconds in the case of streamed content. 219 * <ul> 220 * <li>Calling {@link #start()} to resume playback for a paused 221 * MediaPlayer object, and the resumed playback 222 * position is the same as where it was paused. When the call to 223 * {@link #start()} returns, the paused MediaPlayer object goes back to 224 * the <em>Started</em> state.</li> 225 * <li>Calling {@link #pause()} has no effect on 226 * a MediaPlayer object that is already in the <em>Paused</em> state.</li> 227 * </ul> 228 * </li> 229 * <li>Calling {@link #stop()} stops playback and causes a 230 * MediaPlayer in the <em>Started</em>, <em>Paused</em>, <em>Prepared 231 * </em> or <em>PlaybackCompleted</em> state to enter the 232 * <em>Stopped</em> state. 233 * <ul> 234 * <li>Once in the <em>Stopped</em> state, playback cannot be started 235 * until {@link #prepare()} or {@link #prepareAsync()} are called to set 236 * the MediaPlayer object to the <em>Prepared</em> state again.</li> 237 * <li>Calling {@link #stop()} has no effect on a MediaPlayer 238 * object that is already in the <em>Stopped</em> state.</li> 239 * </ul> 240 * </li> 241 * <li>The playback position can be adjusted with a call to 242 * {@link #seekTo(int)}. 243 * <ul> 244 * <li>Although the asynchronuous {@link #seekTo(int)} 245 * call returns right way, the actual seek operation may take a while to 246 * finish, especially for audio/video being streamed. When the actual 247 * seek operation completes, the internal player engine calls a user 248 * supplied OnSeekComplete.onSeekComplete() if an OnSeekCompleteListener 249 * has been registered beforehand via 250 * {@link #setOnSeekCompleteListener(OnSeekCompleteListener)}.</li> 251 * <li>Please 252 * note that {@link #seekTo(int)} can also be called in the other states, 253 * such as <em>Prepared</em>, <em>Paused</em> and <em>PlaybackCompleted 254 * </em> state.</li> 255 * <li>Furthermore, the actual current playback position 256 * can be retrieved with a call to {@link #getCurrentPosition()}, which 257 * is helpful for applications such as a Music player that need to keep 258 * track of the playback progress.</li> 259 * </ul> 260 * </li> 261 * <li>When the playback reaches the end of stream, the playback completes. 262 * <ul> 263 * <li>If the looping mode was being set to <var>true</var>with 264 * {@link #setLooping(boolean)}, the MediaPlayer object shall remain in 265 * the <em>Started</em> state.</li> 266 * <li>If the looping mode was set to <var>false 267 * </var>, the player engine calls a user supplied callback method, 268 * OnCompletion.onCompletion(), if a OnCompletionListener is registered 269 * beforehand via {@link #setOnCompletionListener(OnCompletionListener)}. 270 * The invoke of the callback signals that the object is now in the <em> 271 * PlaybackCompleted</em> state.</li> 272 * <li>While in the <em>PlaybackCompleted</em> 273 * state, calling {@link #start()} can restart the playback from the 274 * beginning of the audio/video source.</li> 275 * </ul> 276 * 277 * 278 * <a name="Valid_and_Invalid_States"></a> 279 * <h3>Valid and invalid states</h3> 280 * 281 * <table border="0" cellspacing="0" cellpadding="0"> 282 * <tr><td>Method Name </p></td> 283 * <td>Valid Sates </p></td> 284 * <td>Invalid States </p></td> 285 * <td>Comments </p></td></tr> 286 * <tr><td>attachAuxEffect </p></td> 287 * <td>{Initialized, Prepared, Started, Paused, Stopped, PlaybackCompleted} </p></td> 288 * <td>{Idle, Error} </p></td> 289 * <td>This method must be called after setDataSource. 290 * Calling it does not change the object state. </p></td></tr> 291 * <tr><td>getAudioSessionId </p></td> 292 * <td>any </p></td> 293 * <td>{} </p></td> 294 * <td>This method can be called in any state and calling it does not change 295 * the object state. </p></td></tr> 296 * <tr><td>getCurrentPosition </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 the 301 * state. Calling this method in an invalid state transfers the object 302 * to the <em>Error</em> state. </p></td></tr> 303 * <tr><td>getDuration </p></td> 304 * <td>{Prepared, Started, Paused, Stopped, PlaybackCompleted} </p></td> 305 * <td>{Idle, Initialized, Error} </p></td> 306 * <td>Successful invoke of this method in a valid state does not change the 307 * state. Calling this method in an invalid state transfers the object 308 * to the <em>Error</em> state. </p></td></tr> 309 * <tr><td>getVideoHeight </p></td> 310 * <td>{Idle, Initialized, Prepared, Started, Paused, Stopped, 311 * PlaybackCompleted}</p></td> 312 * <td>{Error}</p></td> 313 * <td>Successful invoke of this method in a valid state does not change the 314 * state. Calling this method in an invalid state transfers the object 315 * to the <em>Error</em> state. </p></td></tr> 316 * <tr><td>getVideoWidth </p></td> 317 * <td>{Idle, Initialized, Prepared, Started, Paused, Stopped, 318 * PlaybackCompleted}</p></td> 319 * <td>{Error}</p></td> 320 * <td>Successful invoke of this method in a valid state does not change 321 * the state. Calling this method in an invalid state transfers the 322 * object to the <em>Error</em> state. </p></td></tr> 323 * <tr><td>isPlaying </p></td> 324 * <td>{Idle, Initialized, Prepared, Started, Paused, Stopped, 325 * PlaybackCompleted}</p></td> 326 * <td>{Error}</p></td> 327 * <td>Successful invoke of this method in a valid state does not change 328 * the state. Calling this method in an invalid state transfers the 329 * object to the <em>Error</em> state. </p></td></tr> 330 * <tr><td>pause </p></td> 331 * <td>{Started, Paused}</p></td> 332 * <td>{Idle, Initialized, Prepared, Stopped, PlaybackCompleted, Error}</p></td> 333 * <td>Successful invoke of this method in a valid state transfers the 334 * object to the <em>Paused</em> state. Calling this method in an 335 * invalid state transfers the object to the <em>Error</em> state.</p></td></tr> 336 * <tr><td>prepare </p></td> 337 * <td>{Initialized, Stopped} </p></td> 338 * <td>{Idle, Prepared, Started, Paused, PlaybackCompleted, Error} </p></td> 339 * <td>Successful invoke of this method in a valid state transfers the 340 * object to the <em>Prepared</em> state. Calling this method in an 341 * invalid state throws an IllegalStateException.</p></td></tr> 342 * <tr><td>prepareAsync </p></td> 343 * <td>{Initialized, Stopped} </p></td> 344 * <td>{Idle, Prepared, Started, Paused, PlaybackCompleted, Error} </p></td> 345 * <td>Successful invoke of this method in a valid state transfers the 346 * object to the <em>Preparing</em> state. Calling this method in an 347 * invalid state throws an IllegalStateException.</p></td></tr> 348 * <tr><td>release </p></td> 349 * <td>any </p></td> 350 * <td>{} </p></td> 351 * <td>After {@link #release()}, the object is no longer available. </p></td></tr> 352 * <tr><td>reset </p></td> 353 * <td>{Idle, Initialized, Prepared, Started, Paused, Stopped, 354 * PlaybackCompleted, Error}</p></td> 355 * <td>{}</p></td> 356 * <td>After {@link #reset()}, the object is like being just created.</p></td></tr> 357 * <tr><td>seekTo </p></td> 358 * <td>{Prepared, Started, Paused, PlaybackCompleted} </p></td> 359 * <td>{Idle, Initialized, Stopped, Error}</p></td> 360 * <td>Successful invoke of this method in a valid state does not change 361 * the state. Calling this method in an invalid state transfers the 362 * object to the <em>Error</em> state. </p></td></tr> 363 * <tr><td>setAudioSessionId </p></td> 364 * <td>{Idle} </p></td> 365 * <td>{Initialized, Prepared, Started, Paused, Stopped, PlaybackCompleted, 366 * Error} </p></td> 367 * <td>This method must be called in idle state as the audio session ID must be known before 368 * calling setDataSource. Calling it does not change the object state. </p></td></tr> 369 * <tr><td>setAudioStreamType </p></td> 370 * <td>{Idle, Initialized, Stopped, Prepared, Started, Paused, 371 * PlaybackCompleted}</p></td> 372 * <td>{Error}</p></td> 373 * <td>Successful invoke of this method does not change the state. In order for the 374 * target audio stream type to become effective, this method must be called before 375 * prepare() or prepareAsync().</p></td></tr> 376 * <tr><td>setAuxEffectSendLevel </p></td> 377 * <td>any</p></td> 378 * <td>{} </p></td> 379 * <td>Calling this method does not change the object state. </p></td></tr> 380 * <tr><td>setDataSource </p></td> 381 * <td>{Idle} </p></td> 382 * <td>{Initialized, Prepared, Started, Paused, Stopped, PlaybackCompleted, 383 * Error} </p></td> 384 * <td>Successful invoke of this method in a valid state transfers the 385 * object to the <em>Initialized</em> state. Calling this method in an 386 * invalid state throws an IllegalStateException.</p></td></tr> 387 * <tr><td>setDisplay </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>setSurface </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>setVideoScalingMode </p></td> 398 * <td>{Initialized, Prepared, Started, Paused, Stopped, PlaybackCompleted} </p></td> 399 * <td>{Idle, Error}</p></td> 400 * <td>Successful invoke of this method does not change the state.</p></td></tr> 401 * <tr><td>setLooping </p></td> 402 * <td>{Idle, Initialized, Stopped, Prepared, Started, Paused, 403 * PlaybackCompleted}</p></td> 404 * <td>{Error}</p></td> 405 * <td>Successful invoke of this method in a valid state does not change 406 * the state. Calling this method in an 407 * invalid state transfers the object to the <em>Error</em> state.</p></td></tr> 408 * <tr><td>isLooping </p></td> 409 * <td>any </p></td> 410 * <td>{} </p></td> 411 * <td>This method can be called in any state and calling it does not change 412 * the object state. </p></td></tr> 413 * <tr><td>setOnBufferingUpdateListener </p></td> 414 * <td>any </p></td> 415 * <td>{} </p></td> 416 * <td>This method can be called in any state and calling it does not change 417 * the object state. </p></td></tr> 418 * <tr><td>setOnCompletionListener </p></td> 419 * <td>any </p></td> 420 * <td>{} </p></td> 421 * <td>This method can be called in any state and calling it does not change 422 * the object state. </p></td></tr> 423 * <tr><td>setOnErrorListener </p></td> 424 * <td>any </p></td> 425 * <td>{} </p></td> 426 * <td>This method can be called in any state and calling it does not change 427 * the object state. </p></td></tr> 428 * <tr><td>setOnPreparedListener </p></td> 429 * <td>any </p></td> 430 * <td>{} </p></td> 431 * <td>This method can be called in any state and calling it does not change 432 * the object state. </p></td></tr> 433 * <tr><td>setOnSeekCompleteListener </p></td> 434 * <td>any </p></td> 435 * <td>{} </p></td> 436 * <td>This method can be called in any state and calling it does not change 437 * the object state. </p></td></tr> 438 * <tr><td>setScreenOnWhilePlaying</></td> 439 * <td>any </p></td> 440 * <td>{} </p></td> 441 * <td>This method can be called in any state and calling it does not change 442 * the object state. </p></td></tr> 443 * <tr><td>setVolume </p></td> 444 * <td>{Idle, Initialized, Stopped, Prepared, Started, Paused, 445 * PlaybackCompleted}</p></td> 446 * <td>{Error}</p></td> 447 * <td>Successful invoke of this method does not change the state. 448 * <tr><td>setWakeMode </p></td> 449 * <td>any </p></td> 450 * <td>{} </p></td> 451 * <td>This method can be called in any state and calling it does not change 452 * the object state.</p></td></tr> 453 * <tr><td>start </p></td> 454 * <td>{Prepared, Started, Paused, PlaybackCompleted}</p></td> 455 * <td>{Idle, Initialized, Stopped, Error}</p></td> 456 * <td>Successful invoke of this method in a valid state transfers the 457 * object to the <em>Started</em> state. Calling this method in an 458 * invalid state transfers the object to the <em>Error</em> state.</p></td></tr> 459 * <tr><td>stop </p></td> 460 * <td>{Prepared, Started, Stopped, Paused, PlaybackCompleted}</p></td> 461 * <td>{Idle, Initialized, Error}</p></td> 462 * <td>Successful invoke of this method in a valid state transfers the 463 * object to the <em>Stopped</em> state. Calling this method in an 464 * invalid state transfers the object to the <em>Error</em> state.</p></td></tr> 465 * <tr><td>getTrackInfo </p></td> 466 * <td>{Prepared, Started, Stopped, Paused, PlaybackCompleted}</p></td> 467 * <td>{Idle, Initialized, Error}</p></td> 468 * <td>Successful invoke of this method does not change the state.</p></td></tr> 469 * <tr><td>addTimedTextSource </p></td> 470 * <td>{Prepared, Started, Stopped, Paused, PlaybackCompleted}</p></td> 471 * <td>{Idle, Initialized, Error}</p></td> 472 * <td>Successful invoke of this method does not change the state.</p></td></tr> 473 * <tr><td>selectTrack </p></td> 474 * <td>{Prepared, Started, Stopped, Paused, PlaybackCompleted}</p></td> 475 * <td>{Idle, Initialized, Error}</p></td> 476 * <td>Successful invoke of this method does not change the state.</p></td></tr> 477 * <tr><td>deselectTrack </p></td> 478 * <td>{Prepared, Started, Stopped, Paused, PlaybackCompleted}</p></td> 479 * <td>{Idle, Initialized, Error}</p></td> 480 * <td>Successful invoke of this method does not change the state.</p></td></tr> 481 * 482 * </table> 483 * 484 * <a name="Permissions"></a> 485 * <h3>Permissions</h3> 486 * <p>One may need to declare a corresponding WAKE_LOCK permission {@link 487 * android.R.styleable#AndroidManifestUsesPermission <uses-permission>} 488 * element. 489 * 490 * <p>This class requires the {@link android.Manifest.permission#INTERNET} permission 491 * when used with network-based content. 492 * 493 * <a name="Callbacks"></a> 494 * <h3>Callbacks</h3> 495 * <p>Applications may want to register for informational and error 496 * events in order to be informed of some internal state update and 497 * possible runtime errors during playback or streaming. Registration for 498 * these events is done by properly setting the appropriate listeners (via calls 499 * to 500 * {@link #setOnPreparedListener(OnPreparedListener)}setOnPreparedListener, 501 * {@link #setOnVideoSizeChangedListener(OnVideoSizeChangedListener)}setOnVideoSizeChangedListener, 502 * {@link #setOnSeekCompleteListener(OnSeekCompleteListener)}setOnSeekCompleteListener, 503 * {@link #setOnCompletionListener(OnCompletionListener)}setOnCompletionListener, 504 * {@link #setOnBufferingUpdateListener(OnBufferingUpdateListener)}setOnBufferingUpdateListener, 505 * {@link #setOnInfoListener(OnInfoListener)}setOnInfoListener, 506 * {@link #setOnErrorListener(OnErrorListener)}setOnErrorListener, etc). 507 * In order to receive the respective callback 508 * associated with these listeners, applications are required to create 509 * MediaPlayer objects on a thread with its own Looper running (main UI 510 * thread by default has a Looper running). 511 * 512 */ 513public class MediaPlayer 514{ 515 /** 516 Constant to retrieve only the new metadata since the last 517 call. 518 // FIXME: unhide. 519 // FIXME: add link to getMetadata(boolean, boolean) 520 {@hide} 521 */ 522 public static final boolean METADATA_UPDATE_ONLY = true; 523 524 /** 525 Constant to retrieve all the metadata. 526 // FIXME: unhide. 527 // FIXME: add link to getMetadata(boolean, boolean) 528 {@hide} 529 */ 530 public static final boolean METADATA_ALL = false; 531 532 /** 533 Constant to enable the metadata filter during retrieval. 534 // FIXME: unhide. 535 // FIXME: add link to getMetadata(boolean, boolean) 536 {@hide} 537 */ 538 public static final boolean APPLY_METADATA_FILTER = true; 539 540 /** 541 Constant to disable the metadata filter during retrieval. 542 // FIXME: unhide. 543 // FIXME: add link to getMetadata(boolean, boolean) 544 {@hide} 545 */ 546 public static final boolean BYPASS_METADATA_FILTER = false; 547 548 static { 549 System.loadLibrary("media_jni"); 550 native_init(); 551 } 552 553 private final static String TAG = "MediaPlayer"; 554 // Name of the remote interface for the media player. Must be kept 555 // in sync with the 2nd parameter of the IMPLEMENT_META_INTERFACE 556 // macro invocation in IMediaPlayer.cpp 557 private final static String IMEDIA_PLAYER = "android.media.IMediaPlayer"; 558 559 private int mNativeContext; // accessed by native methods 560 private int mNativeSurfaceTexture; // accessed by native methods 561 private int mListenerContext; // accessed by native methods 562 private SurfaceHolder mSurfaceHolder; 563 private EventHandler mEventHandler; 564 private PowerManager.WakeLock mWakeLock = null; 565 private boolean mScreenOnWhilePlaying; 566 private boolean mStayAwake; 567 568 /** 569 * Default constructor. Consider using one of the create() methods for 570 * synchronously instantiating a MediaPlayer from a Uri or resource. 571 * <p>When done with the MediaPlayer, you should call {@link #release()}, 572 * to free the resources. If not released, too many MediaPlayer instances may 573 * result in an exception.</p> 574 */ 575 public MediaPlayer() { 576 577 Looper looper; 578 if ((looper = Looper.myLooper()) != null) { 579 mEventHandler = new EventHandler(this, looper); 580 } else if ((looper = Looper.getMainLooper()) != null) { 581 mEventHandler = new EventHandler(this, looper); 582 } else { 583 mEventHandler = null; 584 } 585 586 /* Native setup requires a weak reference to our object. 587 * It's easier to create it here than in C++. 588 */ 589 native_setup(new WeakReference<MediaPlayer>(this)); 590 } 591 592 /* 593 * Update the MediaPlayer SurfaceTexture. 594 * Call after setting a new display surface. 595 */ 596 private native void _setVideoSurface(Surface surface); 597 598 /* Do not change these values (starting with INVOKE_ID) without updating 599 * their counterparts in include/media/mediaplayer.h! 600 */ 601 private static final int INVOKE_ID_GET_TRACK_INFO = 1; 602 private static final int INVOKE_ID_ADD_EXTERNAL_SOURCE = 2; 603 private static final int INVOKE_ID_ADD_EXTERNAL_SOURCE_FD = 3; 604 private static final int INVOKE_ID_SELECT_TRACK = 4; 605 private static final int INVOKE_ID_DESELECT_TRACK = 5; 606 private static final int INVOKE_ID_SET_VIDEO_SCALE_MODE = 6; 607 608 /** 609 * Create a request parcel which can be routed to the native media 610 * player using {@link #invoke(Parcel, Parcel)}. The Parcel 611 * returned has the proper InterfaceToken set. The caller should 612 * not overwrite that token, i.e it can only append data to the 613 * Parcel. 614 * 615 * @return A parcel suitable to hold a request for the native 616 * player. 617 * {@hide} 618 */ 619 public Parcel newRequest() { 620 Parcel parcel = Parcel.obtain(); 621 parcel.writeInterfaceToken(IMEDIA_PLAYER); 622 return parcel; 623 } 624 625 /** 626 * Invoke a generic method on the native player using opaque 627 * parcels for the request and reply. Both payloads' format is a 628 * convention between the java caller and the native player. 629 * Must be called after setDataSource to make sure a native player 630 * exists. On failure, a RuntimeException is thrown. 631 * 632 * @param request Parcel with the data for the extension. The 633 * caller must use {@link #newRequest()} to get one. 634 * 635 * @param reply Output parcel with the data returned by the 636 * native player. 637 * 638 * {@hide} 639 */ 640 public void invoke(Parcel request, Parcel reply) { 641 int retcode = native_invoke(request, reply); 642 reply.setDataPosition(0); 643 if (retcode != 0) { 644 throw new RuntimeException("failure code: " + retcode); 645 } 646 } 647 648 /** 649 * Sets the {@link SurfaceHolder} to use for displaying the video 650 * portion of the media. 651 * 652 * Either a surface holder or surface must be set if a display or video sink 653 * is needed. Not calling this method or {@link #setSurface(Surface)} 654 * when playing back a video will result in only the audio track being played. 655 * A null surface holder or surface will result in only the audio track being 656 * played. 657 * 658 * @param sh the SurfaceHolder to use for video display 659 */ 660 public void setDisplay(SurfaceHolder sh) { 661 mSurfaceHolder = sh; 662 Surface surface; 663 if (sh != null) { 664 surface = sh.getSurface(); 665 } else { 666 surface = null; 667 } 668 _setVideoSurface(surface); 669 updateSurfaceScreenOn(); 670 } 671 672 /** 673 * Sets the {@link Surface} to be used as the sink for the video portion of 674 * the media. This is similar to {@link #setDisplay(SurfaceHolder)}, but 675 * does not support {@link #setScreenOnWhilePlaying(boolean)}. Setting a 676 * Surface will un-set any Surface or SurfaceHolder that was previously set. 677 * A null surface will result in only the audio track being played. 678 * 679 * If the Surface sends frames to a {@link SurfaceTexture}, the timestamps 680 * returned from {@link SurfaceTexture#getTimestamp()} will have an 681 * unspecified zero point. These timestamps cannot be directly compared 682 * between different media sources, different instances of the same media 683 * source, or multiple runs of the same program. The timestamp is normally 684 * monotonically increasing and is unaffected by time-of-day adjustments, 685 * but it is reset when the position is set. 686 * 687 * @param surface The {@link Surface} to be used for the video portion of 688 * the media. 689 */ 690 public void setSurface(Surface surface) { 691 if (mScreenOnWhilePlaying && surface != null) { 692 Log.w(TAG, "setScreenOnWhilePlaying(true) is ineffective for Surface"); 693 } 694 mSurfaceHolder = null; 695 _setVideoSurface(surface); 696 updateSurfaceScreenOn(); 697 } 698 699 /* Do not change these video scaling mode values below without updating 700 * their counterparts in system/window.h! Please do not forget to update 701 * {@link #isVideoScalingModeSupported} when new video scaling modes 702 * are added. 703 */ 704 /** 705 * Specifies a video scaling mode. The content is stretched to the 706 * surface rendering area. When the surface has the same aspect ratio 707 * as the content, the aspect ratio of the content is maintained; 708 * otherwise, the aspect ratio of the content is not maintained when video 709 * is being rendered. Unlike {@link #VIDEO_SCALING_MODE_SCALE_TO_FIT_WITH_CROPPING}, 710 * there is no content cropping with this video scaling mode. 711 */ 712 public static final int VIDEO_SCALING_MODE_SCALE_TO_FIT = 1; 713 714 /** 715 * Specifies a video scaling mode. The content is scaled, maintaining 716 * its aspect ratio. The whole surface area is always used. When the 717 * aspect ratio of the content is the same as the surface, no content 718 * is cropped; otherwise, content is cropped to fit the surface. 719 */ 720 public static final int VIDEO_SCALING_MODE_SCALE_TO_FIT_WITH_CROPPING = 2; 721 /** 722 * Sets video scaling mode. To make the target video scaling mode 723 * effective during playback, this method must be called after 724 * data source is set. If not called, the default video 725 * scaling mode is {@link #VIDEO_SCALING_MODE_SCALE_TO_FIT}. 726 * 727 * <p> The supported video scaling modes are: 728 * <ul> 729 * <li> {@link #VIDEO_SCALING_MODE_SCALE_TO_FIT} 730 * <li> {@link #VIDEO_SCALING_MODE_SCALE_TO_FIT_WITH_CROPPING} 731 * </ul> 732 * 733 * @param mode target video scaling mode. Most be one of the supported 734 * video scaling modes; otherwise, IllegalArgumentException will be thrown. 735 * 736 * @see MediaPlayer#VIDEO_SCALING_MODE_SCALE_TO_FIT 737 * @see MediaPlayer#VIDEO_SCALING_MODE_SCALE_TO_FIT_WITH_CROPPING 738 */ 739 public void setVideoScalingMode(int mode) { 740 if (!isVideoScalingModeSupported(mode)) { 741 final String msg = "Scaling mode " + mode + " is not supported"; 742 throw new IllegalArgumentException(msg); 743 } 744 Parcel request = Parcel.obtain(); 745 Parcel reply = Parcel.obtain(); 746 try { 747 request.writeInterfaceToken(IMEDIA_PLAYER); 748 request.writeInt(INVOKE_ID_SET_VIDEO_SCALE_MODE); 749 request.writeInt(mode); 750 invoke(request, reply); 751 } finally { 752 request.recycle(); 753 reply.recycle(); 754 } 755 } 756 757 /** 758 * Convenience method to create a MediaPlayer for a given Uri. 759 * On success, {@link #prepare()} will already have been called and must not be called again. 760 * <p>When done with the MediaPlayer, you should call {@link #release()}, 761 * to free the resources. If not released, too many MediaPlayer instances will 762 * result in an exception.</p> 763 * 764 * @param context the Context to use 765 * @param uri the Uri from which to get the datasource 766 * @return a MediaPlayer object, or null if creation failed 767 */ 768 public static MediaPlayer create(Context context, Uri uri) { 769 return create (context, uri, null); 770 } 771 772 /** 773 * Convenience method to create a MediaPlayer for a given Uri. 774 * On success, {@link #prepare()} will already have been called and must not be called again. 775 * <p>When done with the MediaPlayer, you should call {@link #release()}, 776 * to free the resources. If not released, too many MediaPlayer instances will 777 * result in an exception.</p> 778 * 779 * @param context the Context to use 780 * @param uri the Uri from which to get the datasource 781 * @param holder the SurfaceHolder to use for displaying the video 782 * @return a MediaPlayer object, or null if creation failed 783 */ 784 public static MediaPlayer create(Context context, Uri uri, SurfaceHolder holder) { 785 786 try { 787 MediaPlayer mp = new MediaPlayer(); 788 mp.setDataSource(context, uri); 789 if (holder != null) { 790 mp.setDisplay(holder); 791 } 792 mp.prepare(); 793 return mp; 794 } catch (IOException ex) { 795 Log.d(TAG, "create failed:", ex); 796 // fall through 797 } catch (IllegalArgumentException ex) { 798 Log.d(TAG, "create failed:", ex); 799 // fall through 800 } catch (SecurityException ex) { 801 Log.d(TAG, "create failed:", ex); 802 // fall through 803 } 804 805 return null; 806 } 807 808 // Note no convenience method to create a MediaPlayer with SurfaceTexture sink. 809 810 /** 811 * Convenience method to create a MediaPlayer for a given resource id. 812 * On success, {@link #prepare()} will already have been called and must not be called again. 813 * <p>When done with the MediaPlayer, you should call {@link #release()}, 814 * to free the resources. If not released, too many MediaPlayer instances will 815 * result in an exception.</p> 816 * 817 * @param context the Context to use 818 * @param resid the raw resource id (<var>R.raw.<something></var>) for 819 * the resource to use as the datasource 820 * @return a MediaPlayer object, or null if creation failed 821 */ 822 public static MediaPlayer create(Context context, int resid) { 823 try { 824 AssetFileDescriptor afd = context.getResources().openRawResourceFd(resid); 825 if (afd == null) return null; 826 827 MediaPlayer mp = new MediaPlayer(); 828 mp.setDataSource(afd.getFileDescriptor(), afd.getStartOffset(), afd.getLength()); 829 afd.close(); 830 mp.prepare(); 831 return mp; 832 } catch (IOException ex) { 833 Log.d(TAG, "create failed:", ex); 834 // fall through 835 } catch (IllegalArgumentException ex) { 836 Log.d(TAG, "create failed:", ex); 837 // fall through 838 } catch (SecurityException ex) { 839 Log.d(TAG, "create failed:", ex); 840 // fall through 841 } 842 return null; 843 } 844 845 /** 846 * Sets the data source as a content Uri. 847 * 848 * @param context the Context to use when resolving the Uri 849 * @param uri the Content URI of the data you want to play 850 * @throws IllegalStateException if it is called in an invalid state 851 */ 852 public void setDataSource(Context context, Uri uri) 853 throws IOException, IllegalArgumentException, SecurityException, IllegalStateException { 854 setDataSource(context, uri, null); 855 } 856 857 /** 858 * Sets the data source as a content Uri. 859 * 860 * @param context the Context to use when resolving the Uri 861 * @param uri the Content URI of the data you want to play 862 * @param headers the headers to be sent together with the request for the data 863 * @throws IllegalStateException if it is called in an invalid state 864 */ 865 public void setDataSource(Context context, Uri uri, Map<String, String> headers) 866 throws IOException, IllegalArgumentException, SecurityException, IllegalStateException { 867 868 String scheme = uri.getScheme(); 869 if(scheme == null || scheme.equals("file")) { 870 setDataSource(uri.getPath()); 871 return; 872 } 873 874 AssetFileDescriptor fd = null; 875 try { 876 ContentResolver resolver = context.getContentResolver(); 877 fd = resolver.openAssetFileDescriptor(uri, "r"); 878 if (fd == null) { 879 return; 880 } 881 // Note: using getDeclaredLength so that our behavior is the same 882 // as previous versions when the content provider is returning 883 // a full file. 884 if (fd.getDeclaredLength() < 0) { 885 setDataSource(fd.getFileDescriptor()); 886 } else { 887 setDataSource(fd.getFileDescriptor(), fd.getStartOffset(), fd.getDeclaredLength()); 888 } 889 return; 890 } catch (SecurityException ex) { 891 } catch (IOException ex) { 892 } finally { 893 if (fd != null) { 894 fd.close(); 895 } 896 } 897 898 Log.d(TAG, "Couldn't open file on client side, trying server side"); 899 setDataSource(uri.toString(), headers); 900 return; 901 } 902 903 /** 904 * Sets the data source (file-path or http/rtsp URL) to use. 905 * 906 * @param path the path of the file, or the http/rtsp URL of the stream you want to play 907 * @throws IllegalStateException if it is called in an invalid state 908 * 909 * <p>When <code>path</code> refers to a local file, the file may actually be opened by a 910 * process other than the calling application. This implies that the pathname 911 * should be an absolute path (as any other process runs with unspecified current working 912 * directory), and that the pathname should reference a world-readable file. 913 * As an alternative, the application could first open the file for reading, 914 * and then use the file descriptor form {@link #setDataSource(FileDescriptor)}. 915 */ 916 public void setDataSource(String path) 917 throws IOException, IllegalArgumentException, SecurityException, IllegalStateException { 918 setDataSource(path, null, null); 919 } 920 921 /** 922 * Sets the data source (file-path or http/rtsp URL) to use. 923 * 924 * @param path the path of the file, or the http/rtsp URL of the stream you want to play 925 * @param headers the headers associated with the http request for the stream you want to play 926 * @throws IllegalStateException if it is called in an invalid state 927 * @hide pending API council 928 */ 929 public void setDataSource(String path, Map<String, String> headers) 930 throws IOException, IllegalArgumentException, SecurityException, IllegalStateException 931 { 932 String[] keys = null; 933 String[] values = null; 934 935 if (headers != null) { 936 keys = new String[headers.size()]; 937 values = new String[headers.size()]; 938 939 int i = 0; 940 for (Map.Entry<String, String> entry: headers.entrySet()) { 941 keys[i] = entry.getKey(); 942 values[i] = entry.getValue(); 943 ++i; 944 } 945 } 946 setDataSource(path, keys, values); 947 } 948 949 private void setDataSource(String path, String[] keys, String[] values) 950 throws IOException, IllegalArgumentException, SecurityException, IllegalStateException { 951 File file = new File(path); 952 if (file.exists()) { 953 FileInputStream is = new FileInputStream(file); 954 FileDescriptor fd = is.getFD(); 955 setDataSource(fd); 956 is.close(); 957 } else { 958 _setDataSource(path, keys, values); 959 } 960 } 961 962 private native void _setDataSource( 963 String path, String[] keys, String[] values) 964 throws IOException, IllegalArgumentException, SecurityException, IllegalStateException; 965 966 /** 967 * Sets the data source (FileDescriptor) to use. It is the caller's responsibility 968 * to close the file descriptor. It is safe to do so as soon as this call returns. 969 * 970 * @param fd the FileDescriptor for the file you want to play 971 * @throws IllegalStateException if it is called in an invalid state 972 */ 973 public void setDataSource(FileDescriptor fd) 974 throws IOException, IllegalArgumentException, IllegalStateException { 975 // intentionally less than LONG_MAX 976 setDataSource(fd, 0, 0x7ffffffffffffffL); 977 } 978 979 /** 980 * Sets the data source (FileDescriptor) to use. The FileDescriptor must be 981 * seekable (N.B. a LocalSocket is not seekable). It is the caller's responsibility 982 * to close the file descriptor. It is safe to do so as soon as this call returns. 983 * 984 * @param fd the FileDescriptor for the file you want to play 985 * @param offset the offset into the file where the data to be played starts, in bytes 986 * @param length the length in bytes of the data to be played 987 * @throws IllegalStateException if it is called in an invalid state 988 */ 989 public native void setDataSource(FileDescriptor fd, long offset, long length) 990 throws IOException, IllegalArgumentException, IllegalStateException; 991 992 /** 993 * Prepares the player for playback, synchronously. 994 * 995 * After setting the datasource and the display surface, you need to either 996 * call prepare() or prepareAsync(). For files, it is OK to call prepare(), 997 * which blocks until MediaPlayer is ready for playback. 998 * 999 * @throws IllegalStateException if it is called in an invalid state 1000 */ 1001 public native void prepare() throws IOException, IllegalStateException; 1002 1003 /** 1004 * Prepares the player for playback, asynchronously. 1005 * 1006 * After setting the datasource and the display surface, you need to either 1007 * call prepare() or prepareAsync(). For streams, you should call prepareAsync(), 1008 * which returns immediately, rather than blocking until enough data has been 1009 * buffered. 1010 * 1011 * @throws IllegalStateException if it is called in an invalid state 1012 */ 1013 public native void prepareAsync() throws IllegalStateException; 1014 1015 /** 1016 * Starts or resumes playback. If playback had previously been paused, 1017 * playback will continue from where it was paused. If playback had 1018 * been stopped, or never started before, playback will start at the 1019 * beginning. 1020 * 1021 * @throws IllegalStateException if it is called in an invalid state 1022 */ 1023 public void start() throws IllegalStateException { 1024 stayAwake(true); 1025 _start(); 1026 } 1027 1028 private native void _start() throws IllegalStateException; 1029 1030 /** 1031 * Stops playback after playback has been stopped or paused. 1032 * 1033 * @throws IllegalStateException if the internal player engine has not been 1034 * initialized. 1035 */ 1036 public void stop() throws IllegalStateException { 1037 stayAwake(false); 1038 _stop(); 1039 } 1040 1041 private native void _stop() throws IllegalStateException; 1042 1043 /** 1044 * Pauses playback. Call start() to resume. 1045 * 1046 * @throws IllegalStateException if the internal player engine has not been 1047 * initialized. 1048 */ 1049 public void pause() throws IllegalStateException { 1050 stayAwake(false); 1051 _pause(); 1052 } 1053 1054 private native void _pause() throws IllegalStateException; 1055 1056 /** 1057 * Set the low-level power management behavior for this MediaPlayer. This 1058 * can be used when the MediaPlayer is not playing through a SurfaceHolder 1059 * set with {@link #setDisplay(SurfaceHolder)} and thus can use the 1060 * high-level {@link #setScreenOnWhilePlaying(boolean)} feature. 1061 * 1062 * <p>This function has the MediaPlayer access the low-level power manager 1063 * service to control the device's power usage while playing is occurring. 1064 * The parameter is a combination of {@link android.os.PowerManager} wake flags. 1065 * Use of this method requires {@link android.Manifest.permission#WAKE_LOCK} 1066 * permission. 1067 * By default, no attempt is made to keep the device awake during playback. 1068 * 1069 * @param context the Context to use 1070 * @param mode the power/wake mode to set 1071 * @see android.os.PowerManager 1072 */ 1073 public void setWakeMode(Context context, int mode) { 1074 boolean washeld = false; 1075 if (mWakeLock != null) { 1076 if (mWakeLock.isHeld()) { 1077 washeld = true; 1078 mWakeLock.release(); 1079 } 1080 mWakeLock = null; 1081 } 1082 1083 PowerManager pm = (PowerManager)context.getSystemService(Context.POWER_SERVICE); 1084 mWakeLock = pm.newWakeLock(mode|PowerManager.ON_AFTER_RELEASE, MediaPlayer.class.getName()); 1085 mWakeLock.setReferenceCounted(false); 1086 if (washeld) { 1087 mWakeLock.acquire(); 1088 } 1089 } 1090 1091 /** 1092 * Control whether we should use the attached SurfaceHolder to keep the 1093 * screen on while video playback is occurring. This is the preferred 1094 * method over {@link #setWakeMode} where possible, since it doesn't 1095 * require that the application have permission for low-level wake lock 1096 * access. 1097 * 1098 * @param screenOn Supply true to keep the screen on, false to allow it 1099 * to turn off. 1100 */ 1101 public void setScreenOnWhilePlaying(boolean screenOn) { 1102 if (mScreenOnWhilePlaying != screenOn) { 1103 if (screenOn && mSurfaceHolder == null) { 1104 Log.w(TAG, "setScreenOnWhilePlaying(true) is ineffective without a SurfaceHolder"); 1105 } 1106 mScreenOnWhilePlaying = screenOn; 1107 updateSurfaceScreenOn(); 1108 } 1109 } 1110 1111 private void stayAwake(boolean awake) { 1112 if (mWakeLock != null) { 1113 if (awake && !mWakeLock.isHeld()) { 1114 mWakeLock.acquire(); 1115 } else if (!awake && mWakeLock.isHeld()) { 1116 mWakeLock.release(); 1117 } 1118 } 1119 mStayAwake = awake; 1120 updateSurfaceScreenOn(); 1121 } 1122 1123 private void updateSurfaceScreenOn() { 1124 if (mSurfaceHolder != null) { 1125 mSurfaceHolder.setKeepScreenOn(mScreenOnWhilePlaying && mStayAwake); 1126 } 1127 } 1128 1129 /** 1130 * Returns the width of the video. 1131 * 1132 * @return the width of the video, or 0 if there is no video, 1133 * no display surface was set, or the width has not been determined 1134 * yet. The OnVideoSizeChangedListener can be registered via 1135 * {@link #setOnVideoSizeChangedListener(OnVideoSizeChangedListener)} 1136 * to provide a notification when the width is available. 1137 */ 1138 public native int getVideoWidth(); 1139 1140 /** 1141 * Returns the height of the video. 1142 * 1143 * @return the height of the video, or 0 if there is no video, 1144 * no display surface was set, or the height has not been determined 1145 * yet. The OnVideoSizeChangedListener can be registered via 1146 * {@link #setOnVideoSizeChangedListener(OnVideoSizeChangedListener)} 1147 * to provide a notification when the height is available. 1148 */ 1149 public native int getVideoHeight(); 1150 1151 /** 1152 * Checks whether the MediaPlayer is playing. 1153 * 1154 * @return true if currently playing, false otherwise 1155 * @throws IllegalStateException if the internal player engine has not been 1156 * initialized or has been released. 1157 */ 1158 public native boolean isPlaying(); 1159 1160 /** 1161 * Seeks to specified time position. 1162 * 1163 * @param msec the offset in milliseconds from the start to seek to 1164 * @throws IllegalStateException if the internal player engine has not been 1165 * initialized 1166 */ 1167 public native void seekTo(int msec) throws IllegalStateException; 1168 1169 /** 1170 * Gets the current playback position. 1171 * 1172 * @return the current position in milliseconds 1173 */ 1174 public native int getCurrentPosition(); 1175 1176 /** 1177 * Gets the duration of the file. 1178 * 1179 * @return the duration in milliseconds 1180 */ 1181 public native int getDuration(); 1182 1183 /** 1184 * Gets the media metadata. 1185 * 1186 * @param update_only controls whether the full set of available 1187 * metadata is returned or just the set that changed since the 1188 * last call. See {@see #METADATA_UPDATE_ONLY} and {@see 1189 * #METADATA_ALL}. 1190 * 1191 * @param apply_filter if true only metadata that matches the 1192 * filter is returned. See {@see #APPLY_METADATA_FILTER} and {@see 1193 * #BYPASS_METADATA_FILTER}. 1194 * 1195 * @return The metadata, possibly empty. null if an error occured. 1196 // FIXME: unhide. 1197 * {@hide} 1198 */ 1199 public Metadata getMetadata(final boolean update_only, 1200 final boolean apply_filter) { 1201 Parcel reply = Parcel.obtain(); 1202 Metadata data = new Metadata(); 1203 1204 if (!native_getMetadata(update_only, apply_filter, reply)) { 1205 reply.recycle(); 1206 return null; 1207 } 1208 1209 // Metadata takes over the parcel, don't recycle it unless 1210 // there is an error. 1211 if (!data.parse(reply)) { 1212 reply.recycle(); 1213 return null; 1214 } 1215 return data; 1216 } 1217 1218 /** 1219 * Set a filter for the metadata update notification and update 1220 * retrieval. The caller provides 2 set of metadata keys, allowed 1221 * and blocked. The blocked set always takes precedence over the 1222 * allowed one. 1223 * Metadata.MATCH_ALL and Metadata.MATCH_NONE are 2 sets available as 1224 * shorthands to allow/block all or no metadata. 1225 * 1226 * By default, there is no filter set. 1227 * 1228 * @param allow Is the set of metadata the client is interested 1229 * in receiving new notifications for. 1230 * @param block Is the set of metadata the client is not interested 1231 * in receiving new notifications for. 1232 * @return The call status code. 1233 * 1234 // FIXME: unhide. 1235 * {@hide} 1236 */ 1237 public int setMetadataFilter(Set<Integer> allow, Set<Integer> block) { 1238 // Do our serialization manually instead of calling 1239 // Parcel.writeArray since the sets are made of the same type 1240 // we avoid paying the price of calling writeValue (used by 1241 // writeArray) which burns an extra int per element to encode 1242 // the type. 1243 Parcel request = newRequest(); 1244 1245 // The parcel starts already with an interface token. There 1246 // are 2 filters. Each one starts with a 4bytes number to 1247 // store the len followed by a number of int (4 bytes as well) 1248 // representing the metadata type. 1249 int capacity = request.dataSize() + 4 * (1 + allow.size() + 1 + block.size()); 1250 1251 if (request.dataCapacity() < capacity) { 1252 request.setDataCapacity(capacity); 1253 } 1254 1255 request.writeInt(allow.size()); 1256 for(Integer t: allow) { 1257 request.writeInt(t); 1258 } 1259 request.writeInt(block.size()); 1260 for(Integer t: block) { 1261 request.writeInt(t); 1262 } 1263 return native_setMetadataFilter(request); 1264 } 1265 1266 /** 1267 * Set the MediaPlayer to start when this MediaPlayer finishes playback 1268 * (i.e. reaches the end of the stream). 1269 * The media framework will attempt to transition from this player to 1270 * the next as seamlessly as possible. The next player can be set at 1271 * any time before completion. The next player must be prepared by the 1272 * app, and the application should not call start() on it. 1273 * The next MediaPlayer must be different from 'this'. An exception 1274 * will be thrown if next == this. 1275 * The application may call setNextMediaPlayer(null) to indicate no 1276 * next player should be started at the end of playback. 1277 * If the current player is looping, it will keep looping and the next 1278 * player will not be started. 1279 * 1280 * @param next the player to start after this one completes playback. 1281 * 1282 */ 1283 public native void setNextMediaPlayer(MediaPlayer next); 1284 1285 /** 1286 * Releases resources associated with this MediaPlayer object. 1287 * It is considered good practice to call this method when you're 1288 * done using the MediaPlayer. In particular, whenever an Activity 1289 * of an application is paused (its onPause() method is called), 1290 * or stopped (its onStop() method is called), this method should be 1291 * invoked to release the MediaPlayer object, unless the application 1292 * has a special need to keep the object around. In addition to 1293 * unnecessary resources (such as memory and instances of codecs) 1294 * being held, failure to call this method immediately if a 1295 * MediaPlayer object is no longer needed may also lead to 1296 * continuous battery consumption for mobile devices, and playback 1297 * failure for other applications if no multiple instances of the 1298 * same codec are supported on a device. Even if multiple instances 1299 * of the same codec are supported, some performance degradation 1300 * may be expected when unnecessary multiple instances are used 1301 * at the same time. 1302 */ 1303 public void release() { 1304 stayAwake(false); 1305 updateSurfaceScreenOn(); 1306 mOnPreparedListener = null; 1307 mOnBufferingUpdateListener = null; 1308 mOnCompletionListener = null; 1309 mOnSeekCompleteListener = null; 1310 mOnErrorListener = null; 1311 mOnInfoListener = null; 1312 mOnVideoSizeChangedListener = null; 1313 mOnTimedTextListener = null; 1314 _release(); 1315 } 1316 1317 private native void _release(); 1318 1319 /** 1320 * Resets the MediaPlayer to its uninitialized state. After calling 1321 * this method, you will have to initialize it again by setting the 1322 * data source and calling prepare(). 1323 */ 1324 public void reset() { 1325 stayAwake(false); 1326 _reset(); 1327 // make sure none of the listeners get called anymore 1328 mEventHandler.removeCallbacksAndMessages(null); 1329 } 1330 1331 private native void _reset(); 1332 1333 /** 1334 * Sets the audio stream type for this MediaPlayer. See {@link AudioManager} 1335 * for a list of stream types. Must call this method before prepare() or 1336 * prepareAsync() in order for the target stream type to become effective 1337 * thereafter. 1338 * 1339 * @param streamtype the audio stream type 1340 * @see android.media.AudioManager 1341 */ 1342 public native void setAudioStreamType(int streamtype); 1343 1344 /** 1345 * Sets the player to be looping or non-looping. 1346 * 1347 * @param looping whether to loop or not 1348 */ 1349 public native void setLooping(boolean looping); 1350 1351 /** 1352 * Checks whether the MediaPlayer is looping or non-looping. 1353 * 1354 * @return true if the MediaPlayer is currently looping, false otherwise 1355 */ 1356 public native boolean isLooping(); 1357 1358 /** 1359 * Sets the volume on this player. 1360 * This API is recommended for balancing the output of audio streams 1361 * within an application. Unless you are writing an application to 1362 * control user settings, this API should be used in preference to 1363 * {@link AudioManager#setStreamVolume(int, int, int)} which sets the volume of ALL streams of 1364 * a particular type. Note that the passed volume values are raw scalars in range 0.0 to 1.0. 1365 * UI controls should be scaled logarithmically. 1366 * 1367 * @param leftVolume left volume scalar 1368 * @param rightVolume right volume scalar 1369 */ 1370 /* 1371 * FIXME: Merge this into javadoc comment above when setVolume(float) is not @hide. 1372 * The single parameter form below is preferred if the channel volumes don't need 1373 * to be set independently. 1374 */ 1375 public native void setVolume(float leftVolume, float rightVolume); 1376 1377 /** 1378 * Similar, excepts sets volume of all channels to same value. 1379 * @hide 1380 */ 1381 public void setVolume(float volume) { 1382 setVolume(volume, volume); 1383 } 1384 1385 /** 1386 * Currently not implemented, returns null. 1387 * @deprecated 1388 * @hide 1389 */ 1390 public native Bitmap getFrameAt(int msec) throws IllegalStateException; 1391 1392 /** 1393 * Sets the audio session ID. 1394 * 1395 * @param sessionId the audio session ID. 1396 * The audio session ID is a system wide unique identifier for the audio stream played by 1397 * this MediaPlayer instance. 1398 * The primary use of the audio session ID is to associate audio effects to a particular 1399 * instance of MediaPlayer: if an audio session ID is provided when creating an audio effect, 1400 * this effect will be applied only to the audio content of media players within the same 1401 * audio session and not to the output mix. 1402 * When created, a MediaPlayer instance automatically generates its own audio session ID. 1403 * However, it is possible to force this player to be part of an already existing audio session 1404 * by calling this method. 1405 * This method must be called before one of the overloaded <code> setDataSource </code> methods. 1406 * @throws IllegalStateException if it is called in an invalid state 1407 */ 1408 public native void setAudioSessionId(int sessionId) throws IllegalArgumentException, IllegalStateException; 1409 1410 /** 1411 * Returns the audio session ID. 1412 * 1413 * @return the audio session ID. {@see #setAudioSessionId(int)} 1414 * Note that the audio session ID is 0 only if a problem occured when the MediaPlayer was contructed. 1415 */ 1416 public native int getAudioSessionId(); 1417 1418 /** 1419 * Attaches an auxiliary effect to the player. A typical auxiliary effect is a reverberation 1420 * effect which can be applied on any sound source that directs a certain amount of its 1421 * energy to this effect. This amount is defined by setAuxEffectSendLevel(). 1422 * {@see #setAuxEffectSendLevel(float)}. 1423 * <p>After creating an auxiliary effect (e.g. 1424 * {@link android.media.audiofx.EnvironmentalReverb}), retrieve its ID with 1425 * {@link android.media.audiofx.AudioEffect#getId()} and use it when calling this method 1426 * to attach the player to the effect. 1427 * <p>To detach the effect from the player, call this method with a null effect id. 1428 * <p>This method must be called after one of the overloaded <code> setDataSource </code> 1429 * methods. 1430 * @param effectId system wide unique id of the effect to attach 1431 */ 1432 public native void attachAuxEffect(int effectId); 1433 1434 /* Do not change these values (starting with KEY_PARAMETER) without updating 1435 * their counterparts in include/media/mediaplayer.h! 1436 */ 1437 1438 // There are currently no defined keys usable from Java with get*Parameter. 1439 // But if any keys are defined, the order must be kept in sync with include/media/mediaplayer.h. 1440 // private static final int KEY_PARAMETER_... = ...; 1441 1442 /** 1443 * Sets the parameter indicated by key. 1444 * @param key key indicates the parameter to be set. 1445 * @param value value of the parameter to be set. 1446 * @return true if the parameter is set successfully, false otherwise 1447 * {@hide} 1448 */ 1449 public native boolean setParameter(int key, Parcel value); 1450 1451 /** 1452 * Sets the parameter indicated by key. 1453 * @param key key indicates the parameter to be set. 1454 * @param value value of the parameter to be set. 1455 * @return true if the parameter is set successfully, false otherwise 1456 * {@hide} 1457 */ 1458 public boolean setParameter(int key, String value) { 1459 Parcel p = Parcel.obtain(); 1460 p.writeString(value); 1461 boolean ret = setParameter(key, p); 1462 p.recycle(); 1463 return ret; 1464 } 1465 1466 /** 1467 * Sets the parameter indicated by key. 1468 * @param key key indicates the parameter to be set. 1469 * @param value value of the parameter to be set. 1470 * @return true if the parameter is set successfully, false otherwise 1471 * {@hide} 1472 */ 1473 public boolean setParameter(int key, int value) { 1474 Parcel p = Parcel.obtain(); 1475 p.writeInt(value); 1476 boolean ret = setParameter(key, p); 1477 p.recycle(); 1478 return ret; 1479 } 1480 1481 /* 1482 * Gets the value of the parameter indicated by key. 1483 * @param key key indicates the parameter to get. 1484 * @param reply value of the parameter to get. 1485 */ 1486 private native void getParameter(int key, Parcel reply); 1487 1488 /** 1489 * Gets the value of the parameter indicated by key. 1490 * The caller is responsible for recycling the returned parcel. 1491 * @param key key indicates the parameter to get. 1492 * @return value of the parameter. 1493 * {@hide} 1494 */ 1495 public Parcel getParcelParameter(int key) { 1496 Parcel p = Parcel.obtain(); 1497 getParameter(key, p); 1498 return p; 1499 } 1500 1501 /** 1502 * Gets the value of the parameter indicated by key. 1503 * @param key key indicates the parameter to get. 1504 * @return value of the parameter. 1505 * {@hide} 1506 */ 1507 public String getStringParameter(int key) { 1508 Parcel p = Parcel.obtain(); 1509 getParameter(key, p); 1510 String ret = p.readString(); 1511 p.recycle(); 1512 return ret; 1513 } 1514 1515 /** 1516 * Gets the value of the parameter indicated by key. 1517 * @param key key indicates the parameter to get. 1518 * @return value of the parameter. 1519 * {@hide} 1520 */ 1521 public int getIntParameter(int key) { 1522 Parcel p = Parcel.obtain(); 1523 getParameter(key, p); 1524 int ret = p.readInt(); 1525 p.recycle(); 1526 return ret; 1527 } 1528 1529 /** 1530 * Sets the send level of the player to the attached auxiliary effect 1531 * {@see #attachAuxEffect(int)}. The level value range is 0 to 1.0. 1532 * <p>By default the send level is 0, so even if an effect is attached to the player 1533 * this method must be called for the effect to be applied. 1534 * <p>Note that the passed level value is a raw scalar. UI controls should be scaled 1535 * logarithmically: the gain applied by audio framework ranges from -72dB to 0dB, 1536 * so an appropriate conversion from linear UI input x to level is: 1537 * x == 0 -> level = 0 1538 * 0 < x <= R -> level = 10^(72*(x-R)/20/R) 1539 * @param level send level scalar 1540 */ 1541 public native void setAuxEffectSendLevel(float level); 1542 1543 /* 1544 * @param request Parcel destinated to the media player. The 1545 * Interface token must be set to the IMediaPlayer 1546 * one to be routed correctly through the system. 1547 * @param reply[out] Parcel that will contain the reply. 1548 * @return The status code. 1549 */ 1550 private native final int native_invoke(Parcel request, Parcel reply); 1551 1552 1553 /* 1554 * @param update_only If true fetch only the set of metadata that have 1555 * changed since the last invocation of getMetadata. 1556 * The set is built using the unfiltered 1557 * notifications the native player sent to the 1558 * MediaPlayerService during that period of 1559 * time. If false, all the metadatas are considered. 1560 * @param apply_filter If true, once the metadata set has been built based on 1561 * the value update_only, the current filter is applied. 1562 * @param reply[out] On return contains the serialized 1563 * metadata. Valid only if the call was successful. 1564 * @return The status code. 1565 */ 1566 private native final boolean native_getMetadata(boolean update_only, 1567 boolean apply_filter, 1568 Parcel reply); 1569 1570 /* 1571 * @param request Parcel with the 2 serialized lists of allowed 1572 * metadata types followed by the one to be 1573 * dropped. Each list starts with an integer 1574 * indicating the number of metadata type elements. 1575 * @return The status code. 1576 */ 1577 private native final int native_setMetadataFilter(Parcel request); 1578 1579 private static native final void native_init(); 1580 private native final void native_setup(Object mediaplayer_this); 1581 private native final void native_finalize(); 1582 1583 /** 1584 * Class for MediaPlayer to return each audio/video/subtitle track's metadata. 1585 * 1586 * @see android.media.MediaPlayer#getTrackInfo 1587 */ 1588 static public class TrackInfo implements Parcelable { 1589 /** 1590 * Gets the track type. 1591 * @return TrackType which indicates if the track is video, audio, timed text. 1592 */ 1593 public int getTrackType() { 1594 return mTrackType; 1595 } 1596 1597 /** 1598 * Gets the language code of the track. 1599 * @return a language code in either way of ISO-639-1 or ISO-639-2. 1600 * When the language is unknown or could not be determined, 1601 * ISO-639-2 language code, "und", is returned. 1602 */ 1603 public String getLanguage() { 1604 return mLanguage; 1605 } 1606 1607 public static final int MEDIA_TRACK_TYPE_UNKNOWN = 0; 1608 public static final int MEDIA_TRACK_TYPE_VIDEO = 1; 1609 public static final int MEDIA_TRACK_TYPE_AUDIO = 2; 1610 public static final int MEDIA_TRACK_TYPE_TIMEDTEXT = 3; 1611 1612 final int mTrackType; 1613 final String mLanguage; 1614 1615 TrackInfo(Parcel in) { 1616 mTrackType = in.readInt(); 1617 mLanguage = in.readString(); 1618 } 1619 1620 /** 1621 * {@inheritDoc} 1622 */ 1623 @Override 1624 public int describeContents() { 1625 return 0; 1626 } 1627 1628 /** 1629 * {@inheritDoc} 1630 */ 1631 @Override 1632 public void writeToParcel(Parcel dest, int flags) { 1633 dest.writeInt(mTrackType); 1634 dest.writeString(mLanguage); 1635 } 1636 1637 /** 1638 * Used to read a TrackInfo from a Parcel. 1639 */ 1640 static final Parcelable.Creator<TrackInfo> CREATOR 1641 = new Parcelable.Creator<TrackInfo>() { 1642 @Override 1643 public TrackInfo createFromParcel(Parcel in) { 1644 return new TrackInfo(in); 1645 } 1646 1647 @Override 1648 public TrackInfo[] newArray(int size) { 1649 return new TrackInfo[size]; 1650 } 1651 }; 1652 1653 }; 1654 1655 /** 1656 * Returns an array of track information. 1657 * 1658 * @return Array of track info. The total number of tracks is the array length. 1659 * Must be called again if an external timed text source has been added after any of the 1660 * addTimedTextSource methods are called. 1661 * @throws IllegalStateException if it is called in an invalid state. 1662 */ 1663 public TrackInfo[] getTrackInfo() throws IllegalStateException { 1664 Parcel request = Parcel.obtain(); 1665 Parcel reply = Parcel.obtain(); 1666 try { 1667 request.writeInterfaceToken(IMEDIA_PLAYER); 1668 request.writeInt(INVOKE_ID_GET_TRACK_INFO); 1669 invoke(request, reply); 1670 TrackInfo trackInfo[] = reply.createTypedArray(TrackInfo.CREATOR); 1671 return trackInfo; 1672 } finally { 1673 request.recycle(); 1674 reply.recycle(); 1675 } 1676 } 1677 1678 /* Do not change these values without updating their counterparts 1679 * in include/media/stagefright/MediaDefs.h and media/libstagefright/MediaDefs.cpp! 1680 */ 1681 /** 1682 * MIME type for SubRip (SRT) container. Used in addTimedTextSource APIs. 1683 */ 1684 public static final String MEDIA_MIMETYPE_TEXT_SUBRIP = "application/x-subrip"; 1685 1686 /* 1687 * A helper function to check if the mime type is supported by media framework. 1688 */ 1689 private static boolean availableMimeTypeForExternalSource(String mimeType) { 1690 if (mimeType == MEDIA_MIMETYPE_TEXT_SUBRIP) { 1691 return true; 1692 } 1693 return false; 1694 } 1695 1696 /* TODO: Limit the total number of external timed text source to a reasonable number. 1697 */ 1698 /** 1699 * Adds an external timed text source file. 1700 * 1701 * Currently supported format is SubRip with the file extension .srt, case insensitive. 1702 * Note that a single external timed text source may contain multiple tracks in it. 1703 * One can find the total number of available tracks using {@link #getTrackInfo()} to see what 1704 * additional tracks become available after this method call. 1705 * 1706 * @param path The file path of external timed text source file. 1707 * @param mimeType The mime type of the file. Must be one of the mime types listed above. 1708 * @throws IOException if the file cannot be accessed or is corrupted. 1709 * @throws IllegalArgumentException if the mimeType is not supported. 1710 * @throws IllegalStateException if called in an invalid state. 1711 */ 1712 public void addTimedTextSource(String path, String mimeType) 1713 throws IOException, IllegalArgumentException, IllegalStateException { 1714 if (!availableMimeTypeForExternalSource(mimeType)) { 1715 final String msg = "Illegal mimeType for timed text source: " + mimeType; 1716 throw new IllegalArgumentException(msg); 1717 } 1718 1719 File file = new File(path); 1720 if (file.exists()) { 1721 FileInputStream is = new FileInputStream(file); 1722 FileDescriptor fd = is.getFD(); 1723 addTimedTextSource(fd, mimeType); 1724 is.close(); 1725 } else { 1726 // We do not support the case where the path is not a file. 1727 throw new IOException(path); 1728 } 1729 } 1730 1731 /** 1732 * Adds an external timed text source file (Uri). 1733 * 1734 * Currently supported format is SubRip with the file extension .srt, case insensitive. 1735 * Note that a single external timed text source may contain multiple tracks in it. 1736 * One can find the total number of available tracks using {@link #getTrackInfo()} to see what 1737 * additional tracks become available after this method call. 1738 * 1739 * @param context the Context to use when resolving the Uri 1740 * @param uri the Content URI of the data you want to play 1741 * @param mimeType The mime type of the file. Must be one of the mime types listed above. 1742 * @throws IOException if the file cannot be accessed or is corrupted. 1743 * @throws IllegalArgumentException if the mimeType is not supported. 1744 * @throws IllegalStateException if called in an invalid state. 1745 */ 1746 public void addTimedTextSource(Context context, Uri uri, String mimeType) 1747 throws IOException, IllegalArgumentException, IllegalStateException { 1748 String scheme = uri.getScheme(); 1749 if(scheme == null || scheme.equals("file")) { 1750 addTimedTextSource(uri.getPath(), mimeType); 1751 return; 1752 } 1753 1754 AssetFileDescriptor fd = null; 1755 try { 1756 ContentResolver resolver = context.getContentResolver(); 1757 fd = resolver.openAssetFileDescriptor(uri, "r"); 1758 if (fd == null) { 1759 return; 1760 } 1761 addTimedTextSource(fd.getFileDescriptor(), mimeType); 1762 return; 1763 } catch (SecurityException ex) { 1764 } catch (IOException ex) { 1765 } finally { 1766 if (fd != null) { 1767 fd.close(); 1768 } 1769 } 1770 } 1771 1772 /** 1773 * Adds an external timed text source file (FileDescriptor). 1774 * 1775 * It is the caller's responsibility to close the file descriptor. 1776 * It is safe to do so as soon as this call returns. 1777 * 1778 * Currently supported format is SubRip. Note that a single external timed text source may 1779 * contain multiple tracks in it. One can find the total number of available tracks 1780 * using {@link #getTrackInfo()} to see what additional tracks become available 1781 * after this method call. 1782 * 1783 * @param fd the FileDescriptor for the file you want to play 1784 * @param mimeType The mime type of the file. Must be one of the mime types listed above. 1785 * @throws IllegalArgumentException if the mimeType is not supported. 1786 * @throws IllegalStateException if called in an invalid state. 1787 */ 1788 public void addTimedTextSource(FileDescriptor fd, String mimeType) 1789 throws IllegalArgumentException, IllegalStateException { 1790 // intentionally less than LONG_MAX 1791 addTimedTextSource(fd, 0, 0x7ffffffffffffffL, mimeType); 1792 } 1793 1794 /** 1795 * Adds an external timed text file (FileDescriptor). 1796 * 1797 * It is the caller's responsibility to close the file descriptor. 1798 * It is safe to do so as soon as this call returns. 1799 * 1800 * Currently supported format is SubRip. Note that a single external timed text source may 1801 * contain multiple tracks in it. One can find the total number of available tracks 1802 * using {@link #getTrackInfo()} to see what additional tracks become available 1803 * after this method call. 1804 * 1805 * @param fd the FileDescriptor for the file you want to play 1806 * @param offset the offset into the file where the data to be played starts, in bytes 1807 * @param length the length in bytes of the data to be played 1808 * @param mimeType The mime type of the file. Must be one of the mime types listed above. 1809 * @throws IllegalArgumentException if the mimeType is not supported. 1810 * @throws IllegalStateException if called in an invalid state. 1811 */ 1812 public void addTimedTextSource(FileDescriptor fd, long offset, long length, String mimeType) 1813 throws IllegalArgumentException, IllegalStateException { 1814 if (!availableMimeTypeForExternalSource(mimeType)) { 1815 throw new IllegalArgumentException("Illegal mimeType for timed text source: " + mimeType); 1816 } 1817 1818 Parcel request = Parcel.obtain(); 1819 Parcel reply = Parcel.obtain(); 1820 try { 1821 request.writeInterfaceToken(IMEDIA_PLAYER); 1822 request.writeInt(INVOKE_ID_ADD_EXTERNAL_SOURCE_FD); 1823 request.writeFileDescriptor(fd); 1824 request.writeLong(offset); 1825 request.writeLong(length); 1826 request.writeString(mimeType); 1827 invoke(request, reply); 1828 } finally { 1829 request.recycle(); 1830 reply.recycle(); 1831 } 1832 } 1833 1834 /** 1835 * Selects a track. 1836 * <p> 1837 * If a MediaPlayer is in invalid state, it throws an IllegalStateException exception. 1838 * If a MediaPlayer is in <em>Started</em> state, the selected track is presented immediately. 1839 * If a MediaPlayer is not in Started state, it just marks the track to be played. 1840 * </p> 1841 * <p> 1842 * In any valid state, if it is called multiple times on the same type of track (ie. Video, 1843 * Audio, Timed Text), the most recent one will be chosen. 1844 * </p> 1845 * <p> 1846 * The first audio and video tracks are selected by default if available, even though 1847 * this method is not called. However, no timed text track will be selected until 1848 * this function is called. 1849 * </p> 1850 * <p> 1851 * Currently, only timed text tracks or audio tracks can be selected via this method. 1852 * In addition, the support for selecting an audio track at runtime is pretty limited 1853 * in that an audio track can only be selected in the <em>Prepared</em> state. 1854 * </p> 1855 * @param index the index of the track to be selected. The valid range of the index 1856 * is 0..total number of track - 1. The total number of tracks as well as the type of 1857 * each individual track can be found by calling {@link #getTrackInfo()} method. 1858 * @throws IllegalStateException if called in an invalid state. 1859 * 1860 * @see android.media.MediaPlayer#getTrackInfo 1861 */ 1862 public void selectTrack(int index) throws IllegalStateException { 1863 selectOrDeselectTrack(index, true /* select */); 1864 } 1865 1866 /** 1867 * Deselect a track. 1868 * <p> 1869 * Currently, the track must be a timed text track and no audio or video tracks can be 1870 * deselected. If the timed text track identified by index has not been 1871 * selected before, it throws an exception. 1872 * </p> 1873 * @param index the index of the track to be deselected. The valid range of the index 1874 * is 0..total number of tracks - 1. The total number of tracks as well as the type of 1875 * each individual track can be found by calling {@link #getTrackInfo()} method. 1876 * @throws IllegalStateException if called in an invalid state. 1877 * 1878 * @see android.media.MediaPlayer#getTrackInfo 1879 */ 1880 public void deselectTrack(int index) throws IllegalStateException { 1881 selectOrDeselectTrack(index, false /* select */); 1882 } 1883 1884 private void selectOrDeselectTrack(int index, boolean select) 1885 throws IllegalStateException { 1886 Parcel request = Parcel.obtain(); 1887 Parcel reply = Parcel.obtain(); 1888 try { 1889 request.writeInterfaceToken(IMEDIA_PLAYER); 1890 request.writeInt(select? INVOKE_ID_SELECT_TRACK: INVOKE_ID_DESELECT_TRACK); 1891 request.writeInt(index); 1892 invoke(request, reply); 1893 } finally { 1894 request.recycle(); 1895 reply.recycle(); 1896 } 1897 } 1898 1899 1900 /** 1901 * @param reply Parcel with audio/video duration info for battery 1902 tracking usage 1903 * @return The status code. 1904 * {@hide} 1905 */ 1906 public native static int native_pullBatteryData(Parcel reply); 1907 1908 /** 1909 * Sets the target UDP re-transmit endpoint for the low level player. 1910 * Generally, the address portion of the endpoint is an IP multicast 1911 * address, although a unicast address would be equally valid. When a valid 1912 * retransmit endpoint has been set, the media player will not decode and 1913 * render the media presentation locally. Instead, the player will attempt 1914 * to re-multiplex its media data using the Android@Home RTP profile and 1915 * re-transmit to the target endpoint. Receiver devices (which may be 1916 * either the same as the transmitting device or different devices) may 1917 * instantiate, prepare, and start a receiver player using a setDataSource 1918 * URL of the form... 1919 * 1920 * aahRX://<multicastIP>:<port> 1921 * 1922 * to receive, decode and render the re-transmitted content. 1923 * 1924 * setRetransmitEndpoint may only be called before setDataSource has been 1925 * called; while the player is in the Idle state. 1926 * 1927 * @param endpoint the address and UDP port of the re-transmission target or 1928 * null if no re-transmission is to be performed. 1929 * @throws IllegalStateException if it is called in an invalid state 1930 * @throws IllegalArgumentException if the retransmit endpoint is supplied, 1931 * but invalid. 1932 * 1933 * {@hide} pending API council 1934 */ 1935 public void setRetransmitEndpoint(InetSocketAddress endpoint) 1936 throws IllegalStateException, IllegalArgumentException 1937 { 1938 String addrString = null; 1939 int port = 0; 1940 1941 if (null != endpoint) { 1942 addrString = endpoint.getAddress().getHostAddress(); 1943 port = endpoint.getPort(); 1944 } 1945 1946 int ret = native_setRetransmitEndpoint(addrString, port); 1947 if (ret != 0) { 1948 throw new IllegalArgumentException("Illegal re-transmit endpoint; native ret " + ret); 1949 } 1950 } 1951 1952 private native final int native_setRetransmitEndpoint(String addrString, int port); 1953 1954 @Override 1955 protected void finalize() { native_finalize(); } 1956 1957 /* Do not change these values without updating their counterparts 1958 * in include/media/mediaplayer.h! 1959 */ 1960 private static final int MEDIA_NOP = 0; // interface test message 1961 private static final int MEDIA_PREPARED = 1; 1962 private static final int MEDIA_PLAYBACK_COMPLETE = 2; 1963 private static final int MEDIA_BUFFERING_UPDATE = 3; 1964 private static final int MEDIA_SEEK_COMPLETE = 4; 1965 private static final int MEDIA_SET_VIDEO_SIZE = 5; 1966 private static final int MEDIA_TIMED_TEXT = 99; 1967 private static final int MEDIA_ERROR = 100; 1968 private static final int MEDIA_INFO = 200; 1969 1970 private class EventHandler extends Handler 1971 { 1972 private MediaPlayer mMediaPlayer; 1973 1974 public EventHandler(MediaPlayer mp, Looper looper) { 1975 super(looper); 1976 mMediaPlayer = mp; 1977 } 1978 1979 @Override 1980 public void handleMessage(Message msg) { 1981 if (mMediaPlayer.mNativeContext == 0) { 1982 Log.w(TAG, "mediaplayer went away with unhandled events"); 1983 return; 1984 } 1985 switch(msg.what) { 1986 case MEDIA_PREPARED: 1987 if (mOnPreparedListener != null) 1988 mOnPreparedListener.onPrepared(mMediaPlayer); 1989 return; 1990 1991 case MEDIA_PLAYBACK_COMPLETE: 1992 if (mOnCompletionListener != null) 1993 mOnCompletionListener.onCompletion(mMediaPlayer); 1994 stayAwake(false); 1995 return; 1996 1997 case MEDIA_BUFFERING_UPDATE: 1998 if (mOnBufferingUpdateListener != null) 1999 mOnBufferingUpdateListener.onBufferingUpdate(mMediaPlayer, msg.arg1); 2000 return; 2001 2002 case MEDIA_SEEK_COMPLETE: 2003 if (mOnSeekCompleteListener != null) 2004 mOnSeekCompleteListener.onSeekComplete(mMediaPlayer); 2005 return; 2006 2007 case MEDIA_SET_VIDEO_SIZE: 2008 if (mOnVideoSizeChangedListener != null) 2009 mOnVideoSizeChangedListener.onVideoSizeChanged(mMediaPlayer, msg.arg1, msg.arg2); 2010 return; 2011 2012 case MEDIA_ERROR: 2013 Log.e(TAG, "Error (" + msg.arg1 + "," + msg.arg2 + ")"); 2014 boolean error_was_handled = false; 2015 if (mOnErrorListener != null) { 2016 error_was_handled = mOnErrorListener.onError(mMediaPlayer, msg.arg1, msg.arg2); 2017 } 2018 if (mOnCompletionListener != null && ! error_was_handled) { 2019 mOnCompletionListener.onCompletion(mMediaPlayer); 2020 } 2021 stayAwake(false); 2022 return; 2023 2024 case MEDIA_INFO: 2025 if (msg.arg1 != MEDIA_INFO_VIDEO_TRACK_LAGGING) { 2026 Log.i(TAG, "Info (" + msg.arg1 + "," + msg.arg2 + ")"); 2027 } 2028 if (mOnInfoListener != null) { 2029 mOnInfoListener.onInfo(mMediaPlayer, msg.arg1, msg.arg2); 2030 } 2031 // No real default action so far. 2032 return; 2033 case MEDIA_TIMED_TEXT: 2034 if (mOnTimedTextListener == null) 2035 return; 2036 if (msg.obj == null) { 2037 mOnTimedTextListener.onTimedText(mMediaPlayer, null); 2038 } else { 2039 if (msg.obj instanceof Parcel) { 2040 Parcel parcel = (Parcel)msg.obj; 2041 TimedText text = new TimedText(parcel); 2042 parcel.recycle(); 2043 mOnTimedTextListener.onTimedText(mMediaPlayer, text); 2044 } 2045 } 2046 return; 2047 2048 case MEDIA_NOP: // interface test message - ignore 2049 break; 2050 2051 default: 2052 Log.e(TAG, "Unknown message type " + msg.what); 2053 return; 2054 } 2055 } 2056 } 2057 2058 /* 2059 * Called from native code when an interesting event happens. This method 2060 * just uses the EventHandler system to post the event back to the main app thread. 2061 * We use a weak reference to the original MediaPlayer object so that the native 2062 * code is safe from the object disappearing from underneath it. (This is 2063 * the cookie passed to native_setup().) 2064 */ 2065 private static void postEventFromNative(Object mediaplayer_ref, 2066 int what, int arg1, int arg2, Object obj) 2067 { 2068 MediaPlayer mp = (MediaPlayer)((WeakReference)mediaplayer_ref).get(); 2069 if (mp == null) { 2070 return; 2071 } 2072 2073 if (what == MEDIA_INFO && arg1 == MEDIA_INFO_STARTED_AS_NEXT) { 2074 // this acquires the wakelock if needed, and sets the client side state 2075 mp.start(); 2076 } 2077 if (mp.mEventHandler != null) { 2078 Message m = mp.mEventHandler.obtainMessage(what, arg1, arg2, obj); 2079 mp.mEventHandler.sendMessage(m); 2080 } 2081 } 2082 2083 /** 2084 * Interface definition for a callback to be invoked when the media 2085 * source is ready for playback. 2086 */ 2087 public interface OnPreparedListener 2088 { 2089 /** 2090 * Called when the media file is ready for playback. 2091 * 2092 * @param mp the MediaPlayer that is ready for playback 2093 */ 2094 void onPrepared(MediaPlayer mp); 2095 } 2096 2097 /** 2098 * Register a callback to be invoked when the media source is ready 2099 * for playback. 2100 * 2101 * @param listener the callback that will be run 2102 */ 2103 public void setOnPreparedListener(OnPreparedListener listener) 2104 { 2105 mOnPreparedListener = listener; 2106 } 2107 2108 private OnPreparedListener mOnPreparedListener; 2109 2110 /** 2111 * Interface definition for a callback to be invoked when playback of 2112 * a media source has completed. 2113 */ 2114 public interface OnCompletionListener 2115 { 2116 /** 2117 * Called when the end of a media source is reached during playback. 2118 * 2119 * @param mp the MediaPlayer that reached the end of the file 2120 */ 2121 void onCompletion(MediaPlayer mp); 2122 } 2123 2124 /** 2125 * Register a callback to be invoked when the end of a media source 2126 * has been reached during playback. 2127 * 2128 * @param listener the callback that will be run 2129 */ 2130 public void setOnCompletionListener(OnCompletionListener listener) 2131 { 2132 mOnCompletionListener = listener; 2133 } 2134 2135 private OnCompletionListener mOnCompletionListener; 2136 2137 /** 2138 * Interface definition of a callback to be invoked indicating buffering 2139 * status of a media resource being streamed over the network. 2140 */ 2141 public interface OnBufferingUpdateListener 2142 { 2143 /** 2144 * Called to update status in buffering a media stream received through 2145 * progressive HTTP download. The received buffering percentage 2146 * indicates how much of the content has been buffered or played. 2147 * For example a buffering update of 80 percent when half the content 2148 * has already been played indicates that the next 30 percent of the 2149 * content to play has been buffered. 2150 * 2151 * @param mp the MediaPlayer the update pertains to 2152 * @param percent the percentage (0-100) of the content 2153 * that has been buffered or played thus far 2154 */ 2155 void onBufferingUpdate(MediaPlayer mp, int percent); 2156 } 2157 2158 /** 2159 * Register a callback to be invoked when the status of a network 2160 * stream's buffer has changed. 2161 * 2162 * @param listener the callback that will be run. 2163 */ 2164 public void setOnBufferingUpdateListener(OnBufferingUpdateListener listener) 2165 { 2166 mOnBufferingUpdateListener = listener; 2167 } 2168 2169 private OnBufferingUpdateListener mOnBufferingUpdateListener; 2170 2171 /** 2172 * Interface definition of a callback to be invoked indicating 2173 * the completion of a seek operation. 2174 */ 2175 public interface OnSeekCompleteListener 2176 { 2177 /** 2178 * Called to indicate the completion of a seek operation. 2179 * 2180 * @param mp the MediaPlayer that issued the seek operation 2181 */ 2182 public void onSeekComplete(MediaPlayer mp); 2183 } 2184 2185 /** 2186 * Register a callback to be invoked when a seek operation has been 2187 * completed. 2188 * 2189 * @param listener the callback that will be run 2190 */ 2191 public void setOnSeekCompleteListener(OnSeekCompleteListener listener) 2192 { 2193 mOnSeekCompleteListener = listener; 2194 } 2195 2196 private OnSeekCompleteListener mOnSeekCompleteListener; 2197 2198 /** 2199 * Interface definition of a callback to be invoked when the 2200 * video size is first known or updated 2201 */ 2202 public interface OnVideoSizeChangedListener 2203 { 2204 /** 2205 * Called to indicate the video size 2206 * 2207 * The video size (width and height) could be 0 if there was no video, 2208 * no display surface was set, or the value was not determined yet. 2209 * 2210 * @param mp the MediaPlayer associated with this callback 2211 * @param width the width of the video 2212 * @param height the height of the video 2213 */ 2214 public void onVideoSizeChanged(MediaPlayer mp, int width, int height); 2215 } 2216 2217 /** 2218 * Register a callback to be invoked when the video size is 2219 * known or updated. 2220 * 2221 * @param listener the callback that will be run 2222 */ 2223 public void setOnVideoSizeChangedListener(OnVideoSizeChangedListener listener) 2224 { 2225 mOnVideoSizeChangedListener = listener; 2226 } 2227 2228 private OnVideoSizeChangedListener mOnVideoSizeChangedListener; 2229 2230 /** 2231 * Interface definition of a callback to be invoked when a 2232 * timed text is available for display. 2233 */ 2234 public interface OnTimedTextListener 2235 { 2236 /** 2237 * Called to indicate an avaliable timed text 2238 * 2239 * @param mp the MediaPlayer associated with this callback 2240 * @param text the timed text sample which contains the text 2241 * needed to be displayed and the display format. 2242 */ 2243 public void onTimedText(MediaPlayer mp, TimedText text); 2244 } 2245 2246 /** 2247 * Register a callback to be invoked when a timed text is available 2248 * for display. 2249 * 2250 * @param listener the callback that will be run 2251 */ 2252 public void setOnTimedTextListener(OnTimedTextListener listener) 2253 { 2254 mOnTimedTextListener = listener; 2255 } 2256 2257 private OnTimedTextListener mOnTimedTextListener; 2258 2259 2260 /* Do not change these values without updating their counterparts 2261 * in include/media/mediaplayer.h! 2262 */ 2263 /** Unspecified media player error. 2264 * @see android.media.MediaPlayer.OnErrorListener 2265 */ 2266 public static final int MEDIA_ERROR_UNKNOWN = 1; 2267 2268 /** Media server died. In this case, the application must release the 2269 * MediaPlayer object and instantiate a new one. 2270 * @see android.media.MediaPlayer.OnErrorListener 2271 */ 2272 public static final int MEDIA_ERROR_SERVER_DIED = 100; 2273 2274 /** The video is streamed and its container is not valid for progressive 2275 * playback i.e the video's index (e.g moov atom) is not at the start of the 2276 * file. 2277 * @see android.media.MediaPlayer.OnErrorListener 2278 */ 2279 public static final int MEDIA_ERROR_NOT_VALID_FOR_PROGRESSIVE_PLAYBACK = 200; 2280 2281 /** File or network related operation errors. */ 2282 public static final int MEDIA_ERROR_IO = -1004; 2283 /** Bitstream is not conforming to the related coding standard or file spec. */ 2284 public static final int MEDIA_ERROR_MALFORMED = -1007; 2285 /** Bitstream is conforming to the related coding standard or file spec, but 2286 * the media framework does not support the feature. */ 2287 public static final int MEDIA_ERROR_UNSUPPORTED = -1010; 2288 /** Some operation takes too long to complete, usually more than 3-5 seconds. */ 2289 public static final int MEDIA_ERROR_TIMED_OUT = -110; 2290 2291 /** 2292 * Interface definition of a callback to be invoked when there 2293 * has been an error during an asynchronous operation (other errors 2294 * will throw exceptions at method call time). 2295 */ 2296 public interface OnErrorListener 2297 { 2298 /** 2299 * Called to indicate an error. 2300 * 2301 * @param mp the MediaPlayer the error pertains to 2302 * @param what the type of error that has occurred: 2303 * <ul> 2304 * <li>{@link #MEDIA_ERROR_UNKNOWN} 2305 * <li>{@link #MEDIA_ERROR_SERVER_DIED} 2306 * </ul> 2307 * @param extra an extra code, specific to the error. Typically 2308 * implementation dependent. 2309 * <ul> 2310 * <li>{@link #MEDIA_ERROR_IO} 2311 * <li>{@link #MEDIA_ERROR_MALFORMED} 2312 * <li>{@link #MEDIA_ERROR_UNSUPPORTED} 2313 * <li>{@link #MEDIA_ERROR_TIMED_OUT} 2314 * </ul> 2315 * @return True if the method handled the error, false if it didn't. 2316 * Returning false, or not having an OnErrorListener at all, will 2317 * cause the OnCompletionListener to be called. 2318 */ 2319 boolean onError(MediaPlayer mp, int what, int extra); 2320 } 2321 2322 /** 2323 * Register a callback to be invoked when an error has happened 2324 * during an asynchronous operation. 2325 * 2326 * @param listener the callback that will be run 2327 */ 2328 public void setOnErrorListener(OnErrorListener listener) 2329 { 2330 mOnErrorListener = listener; 2331 } 2332 2333 private OnErrorListener mOnErrorListener; 2334 2335 2336 /* Do not change these values without updating their counterparts 2337 * in include/media/mediaplayer.h! 2338 */ 2339 /** Unspecified media player info. 2340 * @see android.media.MediaPlayer.OnInfoListener 2341 */ 2342 public static final int MEDIA_INFO_UNKNOWN = 1; 2343 2344 /** The player was started because it was used as the next player for another 2345 * player, which just completed playback. 2346 * @see android.media.MediaPlayer.OnInfoListener 2347 * @hide 2348 */ 2349 public static final int MEDIA_INFO_STARTED_AS_NEXT = 2; 2350 2351 /** The player just pushed the very first video frame for rendering. 2352 * @see android.media.MediaPlayer.OnInfoListener 2353 */ 2354 public static final int MEDIA_INFO_VIDEO_RENDERING_START = 3; 2355 2356 /** The video is too complex for the decoder: it can't decode frames fast 2357 * enough. Possibly only the audio plays fine at this stage. 2358 * @see android.media.MediaPlayer.OnInfoListener 2359 */ 2360 public static final int MEDIA_INFO_VIDEO_TRACK_LAGGING = 700; 2361 2362 /** MediaPlayer is temporarily pausing playback internally in order to 2363 * buffer more data. 2364 * @see android.media.MediaPlayer.OnInfoListener 2365 */ 2366 public static final int MEDIA_INFO_BUFFERING_START = 701; 2367 2368 /** MediaPlayer is resuming playback after filling buffers. 2369 * @see android.media.MediaPlayer.OnInfoListener 2370 */ 2371 public static final int MEDIA_INFO_BUFFERING_END = 702; 2372 2373 /** Bad interleaving means that a media has been improperly interleaved or 2374 * not interleaved at all, e.g has all the video samples first then all the 2375 * audio ones. Video is playing but a lot of disk seeks may be happening. 2376 * @see android.media.MediaPlayer.OnInfoListener 2377 */ 2378 public static final int MEDIA_INFO_BAD_INTERLEAVING = 800; 2379 2380 /** The media cannot be seeked (e.g live stream) 2381 * @see android.media.MediaPlayer.OnInfoListener 2382 */ 2383 public static final int MEDIA_INFO_NOT_SEEKABLE = 801; 2384 2385 /** A new set of metadata is available. 2386 * @see android.media.MediaPlayer.OnInfoListener 2387 */ 2388 public static final int MEDIA_INFO_METADATA_UPDATE = 802; 2389 2390 /** Failed to handle timed text track properly. 2391 * @see android.media.MediaPlayer.OnInfoListener 2392 * 2393 * {@hide} 2394 */ 2395 public static final int MEDIA_INFO_TIMED_TEXT_ERROR = 900; 2396 2397 /** 2398 * Interface definition of a callback to be invoked to communicate some 2399 * info and/or warning about the media or its playback. 2400 */ 2401 public interface OnInfoListener 2402 { 2403 /** 2404 * Called to indicate an info or a warning. 2405 * 2406 * @param mp the MediaPlayer the info pertains to. 2407 * @param what the type of info or warning. 2408 * <ul> 2409 * <li>{@link #MEDIA_INFO_UNKNOWN} 2410 * <li>{@link #MEDIA_INFO_VIDEO_TRACK_LAGGING} 2411 * <li>{@link #MEDIA_INFO_VIDEO_RENDERING_START} 2412 * <li>{@link #MEDIA_INFO_BUFFERING_START} 2413 * <li>{@link #MEDIA_INFO_BUFFERING_END} 2414 * <li>{@link #MEDIA_INFO_BAD_INTERLEAVING} 2415 * <li>{@link #MEDIA_INFO_NOT_SEEKABLE} 2416 * <li>{@link #MEDIA_INFO_METADATA_UPDATE} 2417 * </ul> 2418 * @param extra an extra code, specific to the info. Typically 2419 * implementation dependent. 2420 * @return True if the method handled the info, false if it didn't. 2421 * Returning false, or not having an OnErrorListener at all, will 2422 * cause the info to be discarded. 2423 */ 2424 boolean onInfo(MediaPlayer mp, int what, int extra); 2425 } 2426 2427 /** 2428 * Register a callback to be invoked when an info/warning is available. 2429 * 2430 * @param listener the callback that will be run 2431 */ 2432 public void setOnInfoListener(OnInfoListener listener) 2433 { 2434 mOnInfoListener = listener; 2435 } 2436 2437 private OnInfoListener mOnInfoListener; 2438 2439 /* 2440 * Test whether a given video scaling mode is supported. 2441 */ 2442 private boolean isVideoScalingModeSupported(int mode) { 2443 return (mode == VIDEO_SCALING_MODE_SCALE_TO_FIT || 2444 mode == VIDEO_SCALING_MODE_SCALE_TO_FIT_WITH_CROPPING); 2445 } 2446} 2447