MediaPlayer.java revision 79a9cd40f5ebb2453cb982bc17d9797a1cbdf8d8
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 {@ #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 invoke(request, reply); 750 } finally { 751 request.recycle(); 752 reply.recycle(); 753 } 754 } 755 756 /** 757 * Convenience method to create a MediaPlayer for a given Uri. 758 * On success, {@link #prepare()} will already have been called and must not be called again. 759 * <p>When done with the MediaPlayer, you should call {@link #release()}, 760 * to free the resources. If not released, too many MediaPlayer instances will 761 * result in an exception.</p> 762 * 763 * @param context the Context to use 764 * @param uri the Uri from which to get the datasource 765 * @return a MediaPlayer object, or null if creation failed 766 */ 767 public static MediaPlayer create(Context context, Uri uri) { 768 return create (context, uri, null); 769 } 770 771 /** 772 * Convenience method to create a MediaPlayer for a given Uri. 773 * On success, {@link #prepare()} will already have been called and must not be called again. 774 * <p>When done with the MediaPlayer, you should call {@link #release()}, 775 * to free the resources. If not released, too many MediaPlayer instances will 776 * result in an exception.</p> 777 * 778 * @param context the Context to use 779 * @param uri the Uri from which to get the datasource 780 * @param holder the SurfaceHolder to use for displaying the video 781 * @return a MediaPlayer object, or null if creation failed 782 */ 783 public static MediaPlayer create(Context context, Uri uri, SurfaceHolder holder) { 784 785 try { 786 MediaPlayer mp = new MediaPlayer(); 787 mp.setDataSource(context, uri); 788 if (holder != null) { 789 mp.setDisplay(holder); 790 } 791 mp.prepare(); 792 return mp; 793 } catch (IOException ex) { 794 Log.d(TAG, "create failed:", ex); 795 // fall through 796 } catch (IllegalArgumentException ex) { 797 Log.d(TAG, "create failed:", ex); 798 // fall through 799 } catch (SecurityException ex) { 800 Log.d(TAG, "create failed:", ex); 801 // fall through 802 } 803 804 return null; 805 } 806 807 // Note no convenience method to create a MediaPlayer with SurfaceTexture sink. 808 809 /** 810 * Convenience method to create a MediaPlayer for a given resource id. 811 * On success, {@link #prepare()} will already have been called and must not be called again. 812 * <p>When done with the MediaPlayer, you should call {@link #release()}, 813 * to free the resources. If not released, too many MediaPlayer instances will 814 * result in an exception.</p> 815 * 816 * @param context the Context to use 817 * @param resid the raw resource id (<var>R.raw.<something></var>) for 818 * the resource to use as the datasource 819 * @return a MediaPlayer object, or null if creation failed 820 */ 821 public static MediaPlayer create(Context context, int resid) { 822 try { 823 AssetFileDescriptor afd = context.getResources().openRawResourceFd(resid); 824 if (afd == null) return null; 825 826 MediaPlayer mp = new MediaPlayer(); 827 mp.setDataSource(afd.getFileDescriptor(), afd.getStartOffset(), afd.getLength()); 828 afd.close(); 829 mp.prepare(); 830 return mp; 831 } catch (IOException ex) { 832 Log.d(TAG, "create failed:", ex); 833 // fall through 834 } catch (IllegalArgumentException ex) { 835 Log.d(TAG, "create failed:", ex); 836 // fall through 837 } catch (SecurityException ex) { 838 Log.d(TAG, "create failed:", ex); 839 // fall through 840 } 841 return null; 842 } 843 844 /** 845 * Sets the data source as a content Uri. 846 * 847 * @param context the Context to use when resolving the Uri 848 * @param uri the Content URI of the data you want to play 849 * @throws IllegalStateException if it is called in an invalid state 850 */ 851 public void setDataSource(Context context, Uri uri) 852 throws IOException, IllegalArgumentException, SecurityException, IllegalStateException { 853 setDataSource(context, uri, null); 854 } 855 856 /** 857 * Sets the data source as a content Uri. 858 * 859 * @param context the Context to use when resolving the Uri 860 * @param uri the Content URI of the data you want to play 861 * @param headers the headers to be sent together with the request for the data 862 * @throws IllegalStateException if it is called in an invalid state 863 */ 864 public void setDataSource(Context context, Uri uri, Map<String, String> headers) 865 throws IOException, IllegalArgumentException, SecurityException, IllegalStateException { 866 867 String scheme = uri.getScheme(); 868 if(scheme == null || scheme.equals("file")) { 869 setDataSource(uri.getPath()); 870 return; 871 } 872 873 AssetFileDescriptor fd = null; 874 try { 875 ContentResolver resolver = context.getContentResolver(); 876 fd = resolver.openAssetFileDescriptor(uri, "r"); 877 if (fd == null) { 878 return; 879 } 880 // Note: using getDeclaredLength so that our behavior is the same 881 // as previous versions when the content provider is returning 882 // a full file. 883 if (fd.getDeclaredLength() < 0) { 884 setDataSource(fd.getFileDescriptor()); 885 } else { 886 setDataSource(fd.getFileDescriptor(), fd.getStartOffset(), fd.getDeclaredLength()); 887 } 888 return; 889 } catch (SecurityException ex) { 890 } catch (IOException ex) { 891 } finally { 892 if (fd != null) { 893 fd.close(); 894 } 895 } 896 897 Log.d(TAG, "Couldn't open file on client side, trying server side"); 898 setDataSource(uri.toString(), headers); 899 return; 900 } 901 902 /** 903 * Sets the data source (file-path or http/rtsp URL) to use. 904 * 905 * @param path the path of the file, or the http/rtsp URL of the stream you want to play 906 * @throws IllegalStateException if it is called in an invalid state 907 * 908 * <p>When <code>path</code> refers to a local file, the file may actually be opened by a 909 * process other than the calling application. This implies that the pathname 910 * should be an absolute path (as any other process runs with unspecified current working 911 * directory), and that the pathname should reference a world-readable file. 912 * As an alternative, the application could first open the file for reading, 913 * and then use the file descriptor form {@link #setDataSource(FileDescriptor)}. 914 */ 915 public void setDataSource(String path) 916 throws IOException, IllegalArgumentException, SecurityException, IllegalStateException { 917 setDataSource(path, null, null); 918 } 919 920 /** 921 * Sets the data source (file-path or http/rtsp URL) to use. 922 * 923 * @param path the path of the file, or the http/rtsp URL of the stream you want to play 924 * @param headers the headers associated with the http request for the stream you want to play 925 * @throws IllegalStateException if it is called in an invalid state 926 * @hide pending API council 927 */ 928 public void setDataSource(String path, Map<String, String> headers) 929 throws IOException, IllegalArgumentException, SecurityException, IllegalStateException 930 { 931 String[] keys = null; 932 String[] values = null; 933 934 if (headers != null) { 935 keys = new String[headers.size()]; 936 values = new String[headers.size()]; 937 938 int i = 0; 939 for (Map.Entry<String, String> entry: headers.entrySet()) { 940 keys[i] = entry.getKey(); 941 values[i] = entry.getValue(); 942 ++i; 943 } 944 } 945 setDataSource(path, keys, values); 946 } 947 948 private void setDataSource(String path, String[] keys, String[] values) 949 throws IOException, IllegalArgumentException, SecurityException, IllegalStateException { 950 File file = new File(path); 951 if (file.exists()) { 952 FileInputStream is = new FileInputStream(file); 953 FileDescriptor fd = is.getFD(); 954 setDataSource(fd); 955 is.close(); 956 } else { 957 _setDataSource(path, keys, values); 958 } 959 } 960 961 private native void _setDataSource( 962 String path, String[] keys, String[] values) 963 throws IOException, IllegalArgumentException, SecurityException, IllegalStateException; 964 965 /** 966 * Sets the data source (FileDescriptor) to use. It is the caller's responsibility 967 * to close the file descriptor. It is safe to do so as soon as this call returns. 968 * 969 * @param fd the FileDescriptor for the file you want to play 970 * @throws IllegalStateException if it is called in an invalid state 971 */ 972 public void setDataSource(FileDescriptor fd) 973 throws IOException, IllegalArgumentException, IllegalStateException { 974 // intentionally less than LONG_MAX 975 setDataSource(fd, 0, 0x7ffffffffffffffL); 976 } 977 978 /** 979 * Sets the data source (FileDescriptor) to use. The FileDescriptor must be 980 * seekable (N.B. a LocalSocket is not seekable). It is the caller's responsibility 981 * to close the file descriptor. It is safe to do so as soon as this call returns. 982 * 983 * @param fd the FileDescriptor for the file you want to play 984 * @param offset the offset into the file where the data to be played starts, in bytes 985 * @param length the length in bytes of the data to be played 986 * @throws IllegalStateException if it is called in an invalid state 987 */ 988 public native void setDataSource(FileDescriptor fd, long offset, long length) 989 throws IOException, IllegalArgumentException, IllegalStateException; 990 991 /** 992 * Prepares the player for playback, synchronously. 993 * 994 * After setting the datasource and the display surface, you need to either 995 * call prepare() or prepareAsync(). For files, it is OK to call prepare(), 996 * which blocks until MediaPlayer is ready for playback. 997 * 998 * @throws IllegalStateException if it is called in an invalid state 999 */ 1000 public native void prepare() throws IOException, IllegalStateException; 1001 1002 /** 1003 * Prepares the player for playback, asynchronously. 1004 * 1005 * After setting the datasource and the display surface, you need to either 1006 * call prepare() or prepareAsync(). For streams, you should call prepareAsync(), 1007 * which returns immediately, rather than blocking until enough data has been 1008 * buffered. 1009 * 1010 * @throws IllegalStateException if it is called in an invalid state 1011 */ 1012 public native void prepareAsync() throws IllegalStateException; 1013 1014 /** 1015 * Starts or resumes playback. If playback had previously been paused, 1016 * playback will continue from where it was paused. If playback had 1017 * been stopped, or never started before, playback will start at the 1018 * beginning. 1019 * 1020 * @throws IllegalStateException if it is called in an invalid state 1021 */ 1022 public void start() throws IllegalStateException { 1023 stayAwake(true); 1024 _start(); 1025 } 1026 1027 private native void _start() throws IllegalStateException; 1028 1029 /** 1030 * Stops playback after playback has been stopped or paused. 1031 * 1032 * @throws IllegalStateException if the internal player engine has not been 1033 * initialized. 1034 */ 1035 public void stop() throws IllegalStateException { 1036 stayAwake(false); 1037 _stop(); 1038 } 1039 1040 private native void _stop() throws IllegalStateException; 1041 1042 /** 1043 * Pauses playback. Call start() to resume. 1044 * 1045 * @throws IllegalStateException if the internal player engine has not been 1046 * initialized. 1047 */ 1048 public void pause() throws IllegalStateException { 1049 stayAwake(false); 1050 _pause(); 1051 } 1052 1053 private native void _pause() throws IllegalStateException; 1054 1055 /** 1056 * Set the low-level power management behavior for this MediaPlayer. This 1057 * can be used when the MediaPlayer is not playing through a SurfaceHolder 1058 * set with {@link #setDisplay(SurfaceHolder)} and thus can use the 1059 * high-level {@link #setScreenOnWhilePlaying(boolean)} feature. 1060 * 1061 * <p>This function has the MediaPlayer access the low-level power manager 1062 * service to control the device's power usage while playing is occurring. 1063 * The parameter is a combination of {@link android.os.PowerManager} wake flags. 1064 * Use of this method requires {@link android.Manifest.permission#WAKE_LOCK} 1065 * permission. 1066 * By default, no attempt is made to keep the device awake during playback. 1067 * 1068 * @param context the Context to use 1069 * @param mode the power/wake mode to set 1070 * @see android.os.PowerManager 1071 */ 1072 public void setWakeMode(Context context, int mode) { 1073 boolean washeld = false; 1074 if (mWakeLock != null) { 1075 if (mWakeLock.isHeld()) { 1076 washeld = true; 1077 mWakeLock.release(); 1078 } 1079 mWakeLock = null; 1080 } 1081 1082 PowerManager pm = (PowerManager)context.getSystemService(Context.POWER_SERVICE); 1083 mWakeLock = pm.newWakeLock(mode|PowerManager.ON_AFTER_RELEASE, MediaPlayer.class.getName()); 1084 mWakeLock.setReferenceCounted(false); 1085 if (washeld) { 1086 mWakeLock.acquire(); 1087 } 1088 } 1089 1090 /** 1091 * Control whether we should use the attached SurfaceHolder to keep the 1092 * screen on while video playback is occurring. This is the preferred 1093 * method over {@link #setWakeMode} where possible, since it doesn't 1094 * require that the application have permission for low-level wake lock 1095 * access. 1096 * 1097 * @param screenOn Supply true to keep the screen on, false to allow it 1098 * to turn off. 1099 */ 1100 public void setScreenOnWhilePlaying(boolean screenOn) { 1101 if (mScreenOnWhilePlaying != screenOn) { 1102 if (screenOn && mSurfaceHolder == null) { 1103 Log.w(TAG, "setScreenOnWhilePlaying(true) is ineffective without a SurfaceHolder"); 1104 } 1105 mScreenOnWhilePlaying = screenOn; 1106 updateSurfaceScreenOn(); 1107 } 1108 } 1109 1110 private void stayAwake(boolean awake) { 1111 if (mWakeLock != null) { 1112 if (awake && !mWakeLock.isHeld()) { 1113 mWakeLock.acquire(); 1114 } else if (!awake && mWakeLock.isHeld()) { 1115 mWakeLock.release(); 1116 } 1117 } 1118 mStayAwake = awake; 1119 updateSurfaceScreenOn(); 1120 } 1121 1122 private void updateSurfaceScreenOn() { 1123 if (mSurfaceHolder != null) { 1124 mSurfaceHolder.setKeepScreenOn(mScreenOnWhilePlaying && mStayAwake); 1125 } 1126 } 1127 1128 /** 1129 * Returns the width of the video. 1130 * 1131 * @return the width of the video, or 0 if there is no video, 1132 * no display surface was set, or the width has not been determined 1133 * yet. The OnVideoSizeChangedListener can be registered via 1134 * {@link #setOnVideoSizeChangedListener(OnVideoSizeChangedListener)} 1135 * to provide a notification when the width is available. 1136 */ 1137 public native int getVideoWidth(); 1138 1139 /** 1140 * Returns the height of the video. 1141 * 1142 * @return the height of the video, or 0 if there is no video, 1143 * no display surface was set, or the height has not been determined 1144 * yet. The OnVideoSizeChangedListener can be registered via 1145 * {@link #setOnVideoSizeChangedListener(OnVideoSizeChangedListener)} 1146 * to provide a notification when the height is available. 1147 */ 1148 public native int getVideoHeight(); 1149 1150 /** 1151 * Checks whether the MediaPlayer is playing. 1152 * 1153 * @return true if currently playing, false otherwise 1154 */ 1155 public native boolean isPlaying(); 1156 1157 /** 1158 * Seeks to specified time position. 1159 * 1160 * @param msec the offset in milliseconds from the start to seek to 1161 * @throws IllegalStateException if the internal player engine has not been 1162 * initialized 1163 */ 1164 public native void seekTo(int msec) throws IllegalStateException; 1165 1166 /** 1167 * Gets the current playback position. 1168 * 1169 * @return the current position in milliseconds 1170 */ 1171 public native int getCurrentPosition(); 1172 1173 /** 1174 * Gets the duration of the file. 1175 * 1176 * @return the duration in milliseconds 1177 */ 1178 public native int getDuration(); 1179 1180 /** 1181 * Gets the media metadata. 1182 * 1183 * @param update_only controls whether the full set of available 1184 * metadata is returned or just the set that changed since the 1185 * last call. See {@see #METADATA_UPDATE_ONLY} and {@see 1186 * #METADATA_ALL}. 1187 * 1188 * @param apply_filter if true only metadata that matches the 1189 * filter is returned. See {@see #APPLY_METADATA_FILTER} and {@see 1190 * #BYPASS_METADATA_FILTER}. 1191 * 1192 * @return The metadata, possibly empty. null if an error occured. 1193 // FIXME: unhide. 1194 * {@hide} 1195 */ 1196 public Metadata getMetadata(final boolean update_only, 1197 final boolean apply_filter) { 1198 Parcel reply = Parcel.obtain(); 1199 Metadata data = new Metadata(); 1200 1201 if (!native_getMetadata(update_only, apply_filter, reply)) { 1202 reply.recycle(); 1203 return null; 1204 } 1205 1206 // Metadata takes over the parcel, don't recycle it unless 1207 // there is an error. 1208 if (!data.parse(reply)) { 1209 reply.recycle(); 1210 return null; 1211 } 1212 return data; 1213 } 1214 1215 /** 1216 * Set a filter for the metadata update notification and update 1217 * retrieval. The caller provides 2 set of metadata keys, allowed 1218 * and blocked. The blocked set always takes precedence over the 1219 * allowed one. 1220 * Metadata.MATCH_ALL and Metadata.MATCH_NONE are 2 sets available as 1221 * shorthands to allow/block all or no metadata. 1222 * 1223 * By default, there is no filter set. 1224 * 1225 * @param allow Is the set of metadata the client is interested 1226 * in receiving new notifications for. 1227 * @param block Is the set of metadata the client is not interested 1228 * in receiving new notifications for. 1229 * @return The call status code. 1230 * 1231 // FIXME: unhide. 1232 * {@hide} 1233 */ 1234 public int setMetadataFilter(Set<Integer> allow, Set<Integer> block) { 1235 // Do our serialization manually instead of calling 1236 // Parcel.writeArray since the sets are made of the same type 1237 // we avoid paying the price of calling writeValue (used by 1238 // writeArray) which burns an extra int per element to encode 1239 // the type. 1240 Parcel request = newRequest(); 1241 1242 // The parcel starts already with an interface token. There 1243 // are 2 filters. Each one starts with a 4bytes number to 1244 // store the len followed by a number of int (4 bytes as well) 1245 // representing the metadata type. 1246 int capacity = request.dataSize() + 4 * (1 + allow.size() + 1 + block.size()); 1247 1248 if (request.dataCapacity() < capacity) { 1249 request.setDataCapacity(capacity); 1250 } 1251 1252 request.writeInt(allow.size()); 1253 for(Integer t: allow) { 1254 request.writeInt(t); 1255 } 1256 request.writeInt(block.size()); 1257 for(Integer t: block) { 1258 request.writeInt(t); 1259 } 1260 return native_setMetadataFilter(request); 1261 } 1262 1263 /** 1264 * Set the MediaPlayer to start when this MediaPlayer finishes playback 1265 * (i.e. reaches the end of the stream). 1266 * The media framework will attempt to transition from this player to 1267 * the next as seamlessly as possible. The next player can be set at 1268 * any time before completion. The next player must be prepared by the 1269 * app, and the application should not call start() on it. 1270 * The next MediaPlayer must be different from 'this'. An exception 1271 * will be thrown if next == this. 1272 * The application may call setNextMediaPlayer(null) to indicate no 1273 * next player should be started at the end of playback. 1274 * If the current player is looping, it will keep looping and the next 1275 * player will not be started. 1276 * 1277 * @param next the player to start after this one completes playback. 1278 * 1279 */ 1280 public native void setNextMediaPlayer(MediaPlayer next); 1281 1282 /** 1283 * Releases resources associated with this MediaPlayer object. 1284 * It is considered good practice to call this method when you're 1285 * done using the MediaPlayer. In particular, whenever an Activity 1286 * of an application is paused (its onPause() method is called), 1287 * or stopped (its onStop() method is called), this method should be 1288 * invoked to release the MediaPlayer object, unless the application 1289 * has a special need to keep the object around. In addition to 1290 * unnecessary resources (such as memory and instances of codecs) 1291 * being held, failure to call this method immediately if a 1292 * MediaPlayer object is no longer needed may also lead to 1293 * continuous battery consumption for mobile devices, and playback 1294 * failure for other applications if no multiple instances of the 1295 * same codec are supported on a device. Even if multiple instances 1296 * of the same codec are supported, some performance degradation 1297 * may be expected when unnecessary multiple instances are used 1298 * at the same time. 1299 */ 1300 public void release() { 1301 stayAwake(false); 1302 updateSurfaceScreenOn(); 1303 mOnPreparedListener = null; 1304 mOnBufferingUpdateListener = null; 1305 mOnCompletionListener = null; 1306 mOnSeekCompleteListener = null; 1307 mOnErrorListener = null; 1308 mOnInfoListener = null; 1309 mOnVideoSizeChangedListener = null; 1310 mOnTimedTextListener = null; 1311 _release(); 1312 } 1313 1314 private native void _release(); 1315 1316 /** 1317 * Resets the MediaPlayer to its uninitialized state. After calling 1318 * this method, you will have to initialize it again by setting the 1319 * data source and calling prepare(). 1320 */ 1321 public void reset() { 1322 stayAwake(false); 1323 _reset(); 1324 // make sure none of the listeners get called anymore 1325 mEventHandler.removeCallbacksAndMessages(null); 1326 } 1327 1328 private native void _reset(); 1329 1330 /** 1331 * Sets the audio stream type for this MediaPlayer. See {@link AudioManager} 1332 * for a list of stream types. Must call this method before prepare() or 1333 * prepareAsync() in order for the target stream type to become effective 1334 * thereafter. 1335 * 1336 * @param streamtype the audio stream type 1337 * @see android.media.AudioManager 1338 */ 1339 public native void setAudioStreamType(int streamtype); 1340 1341 /** 1342 * Sets the player to be looping or non-looping. 1343 * 1344 * @param looping whether to loop or not 1345 */ 1346 public native void setLooping(boolean looping); 1347 1348 /** 1349 * Checks whether the MediaPlayer is looping or non-looping. 1350 * 1351 * @return true if the MediaPlayer is currently looping, false otherwise 1352 */ 1353 public native boolean isLooping(); 1354 1355 /** 1356 * Sets the volume on this player. 1357 * This API is recommended for balancing the output of audio streams 1358 * within an application. Unless you are writing an application to 1359 * control user settings, this API should be used in preference to 1360 * {@link AudioManager#setStreamVolume(int, int, int)} which sets the volume of ALL streams of 1361 * a particular type. Note that the passed volume values are raw scalars. 1362 * UI controls should be scaled logarithmically. 1363 * 1364 * @param leftVolume left volume scalar 1365 * @param rightVolume right volume scalar 1366 */ 1367 public native void setVolume(float leftVolume, float rightVolume); 1368 1369 /** 1370 * Currently not implemented, returns null. 1371 * @deprecated 1372 * @hide 1373 */ 1374 public native Bitmap getFrameAt(int msec) throws IllegalStateException; 1375 1376 /** 1377 * Sets the audio session ID. 1378 * 1379 * @param sessionId the audio session ID. 1380 * The audio session ID is a system wide unique identifier for the audio stream played by 1381 * this MediaPlayer instance. 1382 * The primary use of the audio session ID is to associate audio effects to a particular 1383 * instance of MediaPlayer: if an audio session ID is provided when creating an audio effect, 1384 * this effect will be applied only to the audio content of media players within the same 1385 * audio session and not to the output mix. 1386 * When created, a MediaPlayer instance automatically generates its own audio session ID. 1387 * However, it is possible to force this player to be part of an already existing audio session 1388 * by calling this method. 1389 * This method must be called before one of the overloaded <code> setDataSource </code> methods. 1390 * @throws IllegalStateException if it is called in an invalid state 1391 */ 1392 public native void setAudioSessionId(int sessionId) throws IllegalArgumentException, IllegalStateException; 1393 1394 /** 1395 * Returns the audio session ID. 1396 * 1397 * @return the audio session ID. {@see #setAudioSessionId(int)} 1398 * Note that the audio session ID is 0 only if a problem occured when the MediaPlayer was contructed. 1399 */ 1400 public native int getAudioSessionId(); 1401 1402 /** 1403 * Attaches an auxiliary effect to the player. A typical auxiliary effect is a reverberation 1404 * effect which can be applied on any sound source that directs a certain amount of its 1405 * energy to this effect. This amount is defined by setAuxEffectSendLevel(). 1406 * {@see #setAuxEffectSendLevel(float)}. 1407 * <p>After creating an auxiliary effect (e.g. 1408 * {@link android.media.audiofx.EnvironmentalReverb}), retrieve its ID with 1409 * {@link android.media.audiofx.AudioEffect#getId()} and use it when calling this method 1410 * to attach the player to the effect. 1411 * <p>To detach the effect from the player, call this method with a null effect id. 1412 * <p>This method must be called after one of the overloaded <code> setDataSource </code> 1413 * methods. 1414 * @param effectId system wide unique id of the effect to attach 1415 */ 1416 public native void attachAuxEffect(int effectId); 1417 1418 /* Do not change these values (starting with KEY_PARAMETER) without updating 1419 * their counterparts in include/media/mediaplayer.h! 1420 */ 1421 1422 // There are currently no defined keys usable from Java with get*Parameter. 1423 // But if any keys are defined, the order must be kept in sync with include/media/mediaplayer.h. 1424 // private static final int KEY_PARAMETER_... = ...; 1425 1426 /** 1427 * Sets the parameter indicated by key. 1428 * @param key key indicates the parameter to be set. 1429 * @param value value of the parameter to be set. 1430 * @return true if the parameter is set successfully, false otherwise 1431 * {@hide} 1432 */ 1433 public native boolean setParameter(int key, Parcel value); 1434 1435 /** 1436 * Sets the parameter indicated by key. 1437 * @param key key indicates the parameter to be set. 1438 * @param value value of the parameter to be set. 1439 * @return true if the parameter is set successfully, false otherwise 1440 * {@hide} 1441 */ 1442 public boolean setParameter(int key, String value) { 1443 Parcel p = Parcel.obtain(); 1444 p.writeString(value); 1445 boolean ret = setParameter(key, p); 1446 p.recycle(); 1447 return ret; 1448 } 1449 1450 /** 1451 * Sets the parameter indicated by key. 1452 * @param key key indicates the parameter to be set. 1453 * @param value value of the parameter to be set. 1454 * @return true if the parameter is set successfully, false otherwise 1455 * {@hide} 1456 */ 1457 public boolean setParameter(int key, int value) { 1458 Parcel p = Parcel.obtain(); 1459 p.writeInt(value); 1460 boolean ret = setParameter(key, p); 1461 p.recycle(); 1462 return ret; 1463 } 1464 1465 /* 1466 * Gets the value of the parameter indicated by key. 1467 * @param key key indicates the parameter to get. 1468 * @param reply value of the parameter to get. 1469 */ 1470 private native void getParameter(int key, Parcel reply); 1471 1472 /** 1473 * Gets the value of the parameter indicated by key. 1474 * The caller is responsible for recycling the returned parcel. 1475 * @param key key indicates the parameter to get. 1476 * @return value of the parameter. 1477 * {@hide} 1478 */ 1479 public Parcel getParcelParameter(int key) { 1480 Parcel p = Parcel.obtain(); 1481 getParameter(key, p); 1482 return p; 1483 } 1484 1485 /** 1486 * Gets the value of the parameter indicated by key. 1487 * @param key key indicates the parameter to get. 1488 * @return value of the parameter. 1489 * {@hide} 1490 */ 1491 public String getStringParameter(int key) { 1492 Parcel p = Parcel.obtain(); 1493 getParameter(key, p); 1494 String ret = p.readString(); 1495 p.recycle(); 1496 return ret; 1497 } 1498 1499 /** 1500 * Gets the value of the parameter indicated by key. 1501 * @param key key indicates the parameter to get. 1502 * @return value of the parameter. 1503 * {@hide} 1504 */ 1505 public int getIntParameter(int key) { 1506 Parcel p = Parcel.obtain(); 1507 getParameter(key, p); 1508 int ret = p.readInt(); 1509 p.recycle(); 1510 return ret; 1511 } 1512 1513 /** 1514 * Sets the send level of the player to the attached auxiliary effect 1515 * {@see #attachAuxEffect(int)}. The level value range is 0 to 1.0. 1516 * <p>By default the send level is 0, so even if an effect is attached to the player 1517 * this method must be called for the effect to be applied. 1518 * <p>Note that the passed level value is a raw scalar. UI controls should be scaled 1519 * logarithmically: the gain applied by audio framework ranges from -72dB to 0dB, 1520 * so an appropriate conversion from linear UI input x to level is: 1521 * x == 0 -> level = 0 1522 * 0 < x <= R -> level = 10^(72*(x-R)/20/R) 1523 * @param level send level scalar 1524 */ 1525 public native void setAuxEffectSendLevel(float level); 1526 1527 /* 1528 * @param request Parcel destinated to the media player. The 1529 * Interface token must be set to the IMediaPlayer 1530 * one to be routed correctly through the system. 1531 * @param reply[out] Parcel that will contain the reply. 1532 * @return The status code. 1533 */ 1534 private native final int native_invoke(Parcel request, Parcel reply); 1535 1536 1537 /* 1538 * @param update_only If true fetch only the set of metadata that have 1539 * changed since the last invocation of getMetadata. 1540 * The set is built using the unfiltered 1541 * notifications the native player sent to the 1542 * MediaPlayerService during that period of 1543 * time. If false, all the metadatas are considered. 1544 * @param apply_filter If true, once the metadata set has been built based on 1545 * the value update_only, the current filter is applied. 1546 * @param reply[out] On return contains the serialized 1547 * metadata. Valid only if the call was successful. 1548 * @return The status code. 1549 */ 1550 private native final boolean native_getMetadata(boolean update_only, 1551 boolean apply_filter, 1552 Parcel reply); 1553 1554 /* 1555 * @param request Parcel with the 2 serialized lists of allowed 1556 * metadata types followed by the one to be 1557 * dropped. Each list starts with an integer 1558 * indicating the number of metadata type elements. 1559 * @return The status code. 1560 */ 1561 private native final int native_setMetadataFilter(Parcel request); 1562 1563 private static native final void native_init(); 1564 private native final void native_setup(Object mediaplayer_this); 1565 private native final void native_finalize(); 1566 1567 /** 1568 * Class for MediaPlayer to return each audio/video/subtitle track's metadata. 1569 * 1570 * @see android.media.MediaPlayer#getTrackInfo 1571 */ 1572 static public class TrackInfo implements Parcelable { 1573 /** 1574 * Gets the track type. 1575 * @return TrackType which indicates if the track is video, audio, timed text. 1576 */ 1577 public int getTrackType() { 1578 return mTrackType; 1579 } 1580 1581 /** 1582 * Gets the language code of the track. 1583 * @return a language code in either way of ISO-639-1 or ISO-639-2. 1584 * When the language is unknown or could not be determined, 1585 * ISO-639-2 language code, "und", is returned. 1586 */ 1587 public String getLanguage() { 1588 return mLanguage; 1589 } 1590 1591 public static final int MEDIA_TRACK_TYPE_UNKNOWN = 0; 1592 public static final int MEDIA_TRACK_TYPE_VIDEO = 1; 1593 public static final int MEDIA_TRACK_TYPE_AUDIO = 2; 1594 public static final int MEDIA_TRACK_TYPE_TIMEDTEXT = 3; 1595 1596 final int mTrackType; 1597 final String mLanguage; 1598 1599 TrackInfo(Parcel in) { 1600 mTrackType = in.readInt(); 1601 mLanguage = in.readString(); 1602 } 1603 1604 /** 1605 * {@inheritDoc} 1606 */ 1607 @Override 1608 public int describeContents() { 1609 return 0; 1610 } 1611 1612 /** 1613 * {@inheritDoc} 1614 */ 1615 @Override 1616 public void writeToParcel(Parcel dest, int flags) { 1617 dest.writeInt(mTrackType); 1618 dest.writeString(mLanguage); 1619 } 1620 1621 /** 1622 * Used to read a TrackInfo from a Parcel. 1623 */ 1624 static final Parcelable.Creator<TrackInfo> CREATOR 1625 = new Parcelable.Creator<TrackInfo>() { 1626 @Override 1627 public TrackInfo createFromParcel(Parcel in) { 1628 return new TrackInfo(in); 1629 } 1630 1631 @Override 1632 public TrackInfo[] newArray(int size) { 1633 return new TrackInfo[size]; 1634 } 1635 }; 1636 1637 }; 1638 1639 /** 1640 * Returns an array of track information. 1641 * 1642 * @return Array of track info. The total number of tracks is the array length. 1643 * Must be called again if an external timed text source has been added after any of the 1644 * addTimedTextSource methods are called. 1645 * @throws IllegalStateException if it is called in an invalid state. 1646 */ 1647 public TrackInfo[] getTrackInfo() throws IllegalStateException { 1648 Parcel request = Parcel.obtain(); 1649 Parcel reply = Parcel.obtain(); 1650 try { 1651 request.writeInterfaceToken(IMEDIA_PLAYER); 1652 request.writeInt(INVOKE_ID_GET_TRACK_INFO); 1653 invoke(request, reply); 1654 TrackInfo trackInfo[] = reply.createTypedArray(TrackInfo.CREATOR); 1655 return trackInfo; 1656 } finally { 1657 request.recycle(); 1658 reply.recycle(); 1659 } 1660 } 1661 1662 /* Do not change these values without updating their counterparts 1663 * in include/media/stagefright/MediaDefs.h and media/libstagefright/MediaDefs.cpp! 1664 */ 1665 /** 1666 * MIME type for SubRip (SRT) container. Used in addTimedTextSource APIs. 1667 */ 1668 public static final String MEDIA_MIMETYPE_TEXT_SUBRIP = "application/x-subrip"; 1669 1670 /* 1671 * A helper function to check if the mime type is supported by media framework. 1672 */ 1673 private static boolean availableMimeTypeForExternalSource(String mimeType) { 1674 if (mimeType == MEDIA_MIMETYPE_TEXT_SUBRIP) { 1675 return true; 1676 } 1677 return false; 1678 } 1679 1680 /* TODO: Limit the total number of external timed text source to a reasonable number. 1681 */ 1682 /** 1683 * Adds an external timed text source file. 1684 * 1685 * Currently supported format is SubRip with the file extension .srt, case insensitive. 1686 * Note that a single external timed text source may contain multiple tracks in it. 1687 * One can find the total number of available tracks using {@link #getTrackInfo()} to see what 1688 * additional tracks become available after this method call. 1689 * 1690 * @param path The file path of external timed text source file. 1691 * @param mimeType The mime type of the file. Must be one of the mime types listed above. 1692 * @throws IOException if the file cannot be accessed or is corrupted. 1693 * @throws IllegalArgumentException if the mimeType is not supported. 1694 * @throws IllegalStateException if called in an invalid state. 1695 */ 1696 public void addTimedTextSource(String path, String mimeType) 1697 throws IOException, IllegalArgumentException, IllegalStateException { 1698 if (!availableMimeTypeForExternalSource(mimeType)) { 1699 final String msg = "Illegal mimeType for timed text source: " + mimeType; 1700 throw new IllegalArgumentException(msg); 1701 } 1702 1703 File file = new File(path); 1704 if (file.exists()) { 1705 FileInputStream is = new FileInputStream(file); 1706 FileDescriptor fd = is.getFD(); 1707 addTimedTextSource(fd, mimeType); 1708 is.close(); 1709 } else { 1710 // We do not support the case where the path is not a file. 1711 throw new IOException(path); 1712 } 1713 } 1714 1715 /** 1716 * Adds an external timed text source file (Uri). 1717 * 1718 * Currently supported format is SubRip with the file extension .srt, case insensitive. 1719 * Note that a single external timed text source may contain multiple tracks in it. 1720 * One can find the total number of available tracks using {@link #getTrackInfo()} to see what 1721 * additional tracks become available after this method call. 1722 * 1723 * @param context the Context to use when resolving the Uri 1724 * @param uri the Content URI of the data you want to play 1725 * @param mimeType The mime type of the file. Must be one of the mime types listed above. 1726 * @throws IOException if the file cannot be accessed or is corrupted. 1727 * @throws IllegalArgumentException if the mimeType is not supported. 1728 * @throws IllegalStateException if called in an invalid state. 1729 */ 1730 public void addTimedTextSource(Context context, Uri uri, String mimeType) 1731 throws IOException, IllegalArgumentException, IllegalStateException { 1732 String scheme = uri.getScheme(); 1733 if(scheme == null || scheme.equals("file")) { 1734 addTimedTextSource(uri.getPath(), mimeType); 1735 return; 1736 } 1737 1738 AssetFileDescriptor fd = null; 1739 try { 1740 ContentResolver resolver = context.getContentResolver(); 1741 fd = resolver.openAssetFileDescriptor(uri, "r"); 1742 if (fd == null) { 1743 return; 1744 } 1745 addTimedTextSource(fd.getFileDescriptor(), mimeType); 1746 return; 1747 } catch (SecurityException ex) { 1748 } catch (IOException ex) { 1749 } finally { 1750 if (fd != null) { 1751 fd.close(); 1752 } 1753 } 1754 } 1755 1756 /** 1757 * Adds an external timed text source file (FileDescriptor). 1758 * 1759 * It is the caller's responsibility to close the file descriptor. 1760 * It is safe to do so as soon as this call returns. 1761 * 1762 * Currently supported format is SubRip. Note that a single external timed text source may 1763 * contain multiple tracks in it. One can find the total number of available tracks 1764 * using {@link #getTrackInfo()} to see what additional tracks become available 1765 * after this method call. 1766 * 1767 * @param fd the FileDescriptor for the file you want to play 1768 * @param mimeType The mime type of the file. Must be one of the mime types listed above. 1769 * @throws IllegalArgumentException if the mimeType is not supported. 1770 * @throws IllegalStateException if called in an invalid state. 1771 */ 1772 public void addTimedTextSource(FileDescriptor fd, String mimeType) 1773 throws IllegalArgumentException, IllegalStateException { 1774 // intentionally less than LONG_MAX 1775 addTimedTextSource(fd, 0, 0x7ffffffffffffffL, mimeType); 1776 } 1777 1778 /** 1779 * Adds an external timed text file (FileDescriptor). 1780 * 1781 * It is the caller's responsibility to close the file descriptor. 1782 * It is safe to do so as soon as this call returns. 1783 * 1784 * Currently supported format is SubRip. Note that a single external timed text source may 1785 * contain multiple tracks in it. One can find the total number of available tracks 1786 * using {@link #getTrackInfo()} to see what additional tracks become available 1787 * after this method call. 1788 * 1789 * @param fd the FileDescriptor for the file you want to play 1790 * @param offset the offset into the file where the data to be played starts, in bytes 1791 * @param length the length in bytes of the data to be played 1792 * @param mimeType The mime type of the file. Must be one of the mime types listed above. 1793 * @throws IllegalArgumentException if the mimeType is not supported. 1794 * @throws IllegalStateException if called in an invalid state. 1795 */ 1796 public void addTimedTextSource(FileDescriptor fd, long offset, long length, String mimeType) 1797 throws IllegalArgumentException, IllegalStateException { 1798 if (!availableMimeTypeForExternalSource(mimeType)) { 1799 throw new IllegalArgumentException("Illegal mimeType for timed text source: " + mimeType); 1800 } 1801 1802 Parcel request = Parcel.obtain(); 1803 Parcel reply = Parcel.obtain(); 1804 try { 1805 request.writeInterfaceToken(IMEDIA_PLAYER); 1806 request.writeInt(INVOKE_ID_ADD_EXTERNAL_SOURCE_FD); 1807 request.writeFileDescriptor(fd); 1808 request.writeLong(offset); 1809 request.writeLong(length); 1810 request.writeString(mimeType); 1811 invoke(request, reply); 1812 } finally { 1813 request.recycle(); 1814 reply.recycle(); 1815 } 1816 } 1817 1818 /** 1819 * Selects a track. 1820 * <p> 1821 * If a MediaPlayer is in invalid state, it throws an IllegalStateException exception. 1822 * If a MediaPlayer is in <em>Started</em> state, the selected track is presented immediately. 1823 * If a MediaPlayer is not in Started state, it just marks the track to be played. 1824 * </p> 1825 * <p> 1826 * In any valid state, if it is called multiple times on the same type of track (ie. Video, 1827 * Audio, Timed Text), the most recent one will be chosen. 1828 * </p> 1829 * <p> 1830 * The first audio and video tracks are selected by default if available, even though 1831 * this method is not called. However, no timed text track will be selected until 1832 * this function is called. 1833 * </p> 1834 * <p> 1835 * Currently, only timed text tracks or audio tracks can be selected via this method. 1836 * In addition, the support for selecting an audio track at runtime is pretty limited 1837 * in that an audio track can only be selected in the <em>Prepared</em> state. 1838 * </p> 1839 * @param index the index of the track to be selected. The valid range of the index 1840 * is 0..total number of track - 1. The total number of tracks as well as the type of 1841 * each individual track can be found by calling {@link #getTrackInfo()} method. 1842 * @throws IllegalStateException if called in an invalid state. 1843 * 1844 * @see android.media.MediaPlayer#getTrackInfo 1845 */ 1846 public void selectTrack(int index) throws IllegalStateException { 1847 selectOrDeselectTrack(index, true /* select */); 1848 } 1849 1850 /** 1851 * Deselect a track. 1852 * <p> 1853 * Currently, the track must be a timed text track and no audio or video tracks can be 1854 * deselected. If the timed text track identified by index has not been 1855 * selected before, it throws an exception. 1856 * </p> 1857 * @param index the index of the track to be deselected. The valid range of the index 1858 * is 0..total number of tracks - 1. The total number of tracks as well as the type of 1859 * each individual track can be found by calling {@link #getTrackInfo()} method. 1860 * @throws IllegalStateException if called in an invalid state. 1861 * 1862 * @see android.media.MediaPlayer#getTrackInfo 1863 */ 1864 public void deselectTrack(int index) throws IllegalStateException { 1865 selectOrDeselectTrack(index, false /* select */); 1866 } 1867 1868 private void selectOrDeselectTrack(int index, boolean select) 1869 throws IllegalStateException { 1870 Parcel request = Parcel.obtain(); 1871 Parcel reply = Parcel.obtain(); 1872 try { 1873 request.writeInterfaceToken(IMEDIA_PLAYER); 1874 request.writeInt(select? INVOKE_ID_SELECT_TRACK: INVOKE_ID_DESELECT_TRACK); 1875 request.writeInt(index); 1876 invoke(request, reply); 1877 } finally { 1878 request.recycle(); 1879 reply.recycle(); 1880 } 1881 } 1882 1883 1884 /** 1885 * @param reply Parcel with audio/video duration info for battery 1886 tracking usage 1887 * @return The status code. 1888 * {@hide} 1889 */ 1890 public native static int native_pullBatteryData(Parcel reply); 1891 1892 /** 1893 * Sets the target UDP re-transmit endpoint for the low level player. 1894 * Generally, the address portion of the endpoint is an IP multicast 1895 * address, although a unicast address would be equally valid. When a valid 1896 * retransmit endpoint has been set, the media player will not decode and 1897 * render the media presentation locally. Instead, the player will attempt 1898 * to re-multiplex its media data using the Android@Home RTP profile and 1899 * re-transmit to the target endpoint. Receiver devices (which may be 1900 * either the same as the transmitting device or different devices) may 1901 * instantiate, prepare, and start a receiver player using a setDataSource 1902 * URL of the form... 1903 * 1904 * aahRX://<multicastIP>:<port> 1905 * 1906 * to receive, decode and render the re-transmitted content. 1907 * 1908 * setRetransmitEndpoint may only be called before setDataSource has been 1909 * called; while the player is in the Idle state. 1910 * 1911 * @param endpoint the address and UDP port of the re-transmission target or 1912 * null if no re-transmission is to be performed. 1913 * @throws IllegalStateException if it is called in an invalid state 1914 * @throws IllegalArgumentException if the retransmit endpoint is supplied, 1915 * but invalid. 1916 * 1917 * {@hide} pending API council 1918 */ 1919 public void setRetransmitEndpoint(InetSocketAddress endpoint) 1920 throws IllegalStateException, IllegalArgumentException 1921 { 1922 String addrString = null; 1923 int port = 0; 1924 1925 if (null != endpoint) { 1926 addrString = endpoint.getAddress().getHostAddress(); 1927 port = endpoint.getPort(); 1928 } 1929 1930 int ret = native_setRetransmitEndpoint(addrString, port); 1931 if (ret != 0) { 1932 throw new IllegalArgumentException("Illegal re-transmit endpoint; native ret " + ret); 1933 } 1934 } 1935 1936 private native final int native_setRetransmitEndpoint(String addrString, int port); 1937 1938 @Override 1939 protected void finalize() { native_finalize(); } 1940 1941 /* Do not change these values without updating their counterparts 1942 * in include/media/mediaplayer.h! 1943 */ 1944 private static final int MEDIA_NOP = 0; // interface test message 1945 private static final int MEDIA_PREPARED = 1; 1946 private static final int MEDIA_PLAYBACK_COMPLETE = 2; 1947 private static final int MEDIA_BUFFERING_UPDATE = 3; 1948 private static final int MEDIA_SEEK_COMPLETE = 4; 1949 private static final int MEDIA_SET_VIDEO_SIZE = 5; 1950 private static final int MEDIA_TIMED_TEXT = 99; 1951 private static final int MEDIA_ERROR = 100; 1952 private static final int MEDIA_INFO = 200; 1953 1954 private class EventHandler extends Handler 1955 { 1956 private MediaPlayer mMediaPlayer; 1957 1958 public EventHandler(MediaPlayer mp, Looper looper) { 1959 super(looper); 1960 mMediaPlayer = mp; 1961 } 1962 1963 @Override 1964 public void handleMessage(Message msg) { 1965 if (mMediaPlayer.mNativeContext == 0) { 1966 Log.w(TAG, "mediaplayer went away with unhandled events"); 1967 return; 1968 } 1969 switch(msg.what) { 1970 case MEDIA_PREPARED: 1971 if (mOnPreparedListener != null) 1972 mOnPreparedListener.onPrepared(mMediaPlayer); 1973 return; 1974 1975 case MEDIA_PLAYBACK_COMPLETE: 1976 if (mOnCompletionListener != null) 1977 mOnCompletionListener.onCompletion(mMediaPlayer); 1978 stayAwake(false); 1979 return; 1980 1981 case MEDIA_BUFFERING_UPDATE: 1982 if (mOnBufferingUpdateListener != null) 1983 mOnBufferingUpdateListener.onBufferingUpdate(mMediaPlayer, msg.arg1); 1984 return; 1985 1986 case MEDIA_SEEK_COMPLETE: 1987 if (mOnSeekCompleteListener != null) 1988 mOnSeekCompleteListener.onSeekComplete(mMediaPlayer); 1989 return; 1990 1991 case MEDIA_SET_VIDEO_SIZE: 1992 if (mOnVideoSizeChangedListener != null) 1993 mOnVideoSizeChangedListener.onVideoSizeChanged(mMediaPlayer, msg.arg1, msg.arg2); 1994 return; 1995 1996 case MEDIA_ERROR: 1997 Log.e(TAG, "Error (" + msg.arg1 + "," + msg.arg2 + ")"); 1998 boolean error_was_handled = false; 1999 if (mOnErrorListener != null) { 2000 error_was_handled = mOnErrorListener.onError(mMediaPlayer, msg.arg1, msg.arg2); 2001 } 2002 if (mOnCompletionListener != null && ! error_was_handled) { 2003 mOnCompletionListener.onCompletion(mMediaPlayer); 2004 } 2005 stayAwake(false); 2006 return; 2007 2008 case MEDIA_INFO: 2009 if (msg.arg1 != MEDIA_INFO_VIDEO_TRACK_LAGGING) { 2010 Log.i(TAG, "Info (" + msg.arg1 + "," + msg.arg2 + ")"); 2011 } 2012 if (mOnInfoListener != null) { 2013 mOnInfoListener.onInfo(mMediaPlayer, msg.arg1, msg.arg2); 2014 } 2015 // No real default action so far. 2016 return; 2017 case MEDIA_TIMED_TEXT: 2018 if (mOnTimedTextListener == null) 2019 return; 2020 if (msg.obj == null) { 2021 mOnTimedTextListener.onTimedText(mMediaPlayer, null); 2022 } else { 2023 if (msg.obj instanceof Parcel) { 2024 Parcel parcel = (Parcel)msg.obj; 2025 TimedText text = new TimedText(parcel); 2026 mOnTimedTextListener.onTimedText(mMediaPlayer, text); 2027 } 2028 } 2029 return; 2030 2031 case MEDIA_NOP: // interface test message - ignore 2032 break; 2033 2034 default: 2035 Log.e(TAG, "Unknown message type " + msg.what); 2036 return; 2037 } 2038 } 2039 } 2040 2041 /* 2042 * Called from native code when an interesting event happens. This method 2043 * just uses the EventHandler system to post the event back to the main app thread. 2044 * We use a weak reference to the original MediaPlayer object so that the native 2045 * code is safe from the object disappearing from underneath it. (This is 2046 * the cookie passed to native_setup().) 2047 */ 2048 private static void postEventFromNative(Object mediaplayer_ref, 2049 int what, int arg1, int arg2, Object obj) 2050 { 2051 MediaPlayer mp = (MediaPlayer)((WeakReference)mediaplayer_ref).get(); 2052 if (mp == null) { 2053 return; 2054 } 2055 2056 if (what == MEDIA_INFO && arg1 == MEDIA_INFO_STARTED_AS_NEXT) { 2057 // this acquires the wakelock if needed, and sets the client side state 2058 mp.start(); 2059 } 2060 if (mp.mEventHandler != null) { 2061 Message m = mp.mEventHandler.obtainMessage(what, arg1, arg2, obj); 2062 mp.mEventHandler.sendMessage(m); 2063 } 2064 } 2065 2066 /** 2067 * Interface definition for a callback to be invoked when the media 2068 * source is ready for playback. 2069 */ 2070 public interface OnPreparedListener 2071 { 2072 /** 2073 * Called when the media file is ready for playback. 2074 * 2075 * @param mp the MediaPlayer that is ready for playback 2076 */ 2077 void onPrepared(MediaPlayer mp); 2078 } 2079 2080 /** 2081 * Register a callback to be invoked when the media source is ready 2082 * for playback. 2083 * 2084 * @param listener the callback that will be run 2085 */ 2086 public void setOnPreparedListener(OnPreparedListener listener) 2087 { 2088 mOnPreparedListener = listener; 2089 } 2090 2091 private OnPreparedListener mOnPreparedListener; 2092 2093 /** 2094 * Interface definition for a callback to be invoked when playback of 2095 * a media source has completed. 2096 */ 2097 public interface OnCompletionListener 2098 { 2099 /** 2100 * Called when the end of a media source is reached during playback. 2101 * 2102 * @param mp the MediaPlayer that reached the end of the file 2103 */ 2104 void onCompletion(MediaPlayer mp); 2105 } 2106 2107 /** 2108 * Register a callback to be invoked when the end of a media source 2109 * has been reached during playback. 2110 * 2111 * @param listener the callback that will be run 2112 */ 2113 public void setOnCompletionListener(OnCompletionListener listener) 2114 { 2115 mOnCompletionListener = listener; 2116 } 2117 2118 private OnCompletionListener mOnCompletionListener; 2119 2120 /** 2121 * Interface definition of a callback to be invoked indicating buffering 2122 * status of a media resource being streamed over the network. 2123 */ 2124 public interface OnBufferingUpdateListener 2125 { 2126 /** 2127 * Called to update status in buffering a media stream received through 2128 * progressive HTTP download. The received buffering percentage 2129 * indicates how much of the content has been buffered or played. 2130 * For example a buffering update of 80 percent when half the content 2131 * has already been played indicates that the next 30 percent of the 2132 * content to play has been buffered. 2133 * 2134 * @param mp the MediaPlayer the update pertains to 2135 * @param percent the percentage (0-100) of the content 2136 * that has been buffered or played thus far 2137 */ 2138 void onBufferingUpdate(MediaPlayer mp, int percent); 2139 } 2140 2141 /** 2142 * Register a callback to be invoked when the status of a network 2143 * stream's buffer has changed. 2144 * 2145 * @param listener the callback that will be run. 2146 */ 2147 public void setOnBufferingUpdateListener(OnBufferingUpdateListener listener) 2148 { 2149 mOnBufferingUpdateListener = listener; 2150 } 2151 2152 private OnBufferingUpdateListener mOnBufferingUpdateListener; 2153 2154 /** 2155 * Interface definition of a callback to be invoked indicating 2156 * the completion of a seek operation. 2157 */ 2158 public interface OnSeekCompleteListener 2159 { 2160 /** 2161 * Called to indicate the completion of a seek operation. 2162 * 2163 * @param mp the MediaPlayer that issued the seek operation 2164 */ 2165 public void onSeekComplete(MediaPlayer mp); 2166 } 2167 2168 /** 2169 * Register a callback to be invoked when a seek operation has been 2170 * completed. 2171 * 2172 * @param listener the callback that will be run 2173 */ 2174 public void setOnSeekCompleteListener(OnSeekCompleteListener listener) 2175 { 2176 mOnSeekCompleteListener = listener; 2177 } 2178 2179 private OnSeekCompleteListener mOnSeekCompleteListener; 2180 2181 /** 2182 * Interface definition of a callback to be invoked when the 2183 * video size is first known or updated 2184 */ 2185 public interface OnVideoSizeChangedListener 2186 { 2187 /** 2188 * Called to indicate the video size 2189 * 2190 * The video size (width and height) could be 0 if there was no video, 2191 * no display surface was set, or the value was not determined yet. 2192 * 2193 * @param mp the MediaPlayer associated with this callback 2194 * @param width the width of the video 2195 * @param height the height of the video 2196 */ 2197 public void onVideoSizeChanged(MediaPlayer mp, int width, int height); 2198 } 2199 2200 /** 2201 * Register a callback to be invoked when the video size is 2202 * known or updated. 2203 * 2204 * @param listener the callback that will be run 2205 */ 2206 public void setOnVideoSizeChangedListener(OnVideoSizeChangedListener listener) 2207 { 2208 mOnVideoSizeChangedListener = listener; 2209 } 2210 2211 private OnVideoSizeChangedListener mOnVideoSizeChangedListener; 2212 2213 /** 2214 * Interface definition of a callback to be invoked when a 2215 * timed text is available for display. 2216 */ 2217 public interface OnTimedTextListener 2218 { 2219 /** 2220 * Called to indicate an avaliable timed text 2221 * 2222 * @param mp the MediaPlayer associated with this callback 2223 * @param text the timed text sample which contains the text 2224 * needed to be displayed and the display format. 2225 */ 2226 public void onTimedText(MediaPlayer mp, TimedText text); 2227 } 2228 2229 /** 2230 * Register a callback to be invoked when a timed text is available 2231 * for display. 2232 * 2233 * @param listener the callback that will be run 2234 */ 2235 public void setOnTimedTextListener(OnTimedTextListener listener) 2236 { 2237 mOnTimedTextListener = listener; 2238 } 2239 2240 private OnTimedTextListener mOnTimedTextListener; 2241 2242 2243 /* Do not change these values without updating their counterparts 2244 * in include/media/mediaplayer.h! 2245 */ 2246 /** Unspecified media player error. 2247 * @see android.media.MediaPlayer.OnErrorListener 2248 */ 2249 public static final int MEDIA_ERROR_UNKNOWN = 1; 2250 2251 /** Media server died. In this case, the application must release the 2252 * MediaPlayer object and instantiate a new one. 2253 * @see android.media.MediaPlayer.OnErrorListener 2254 */ 2255 public static final int MEDIA_ERROR_SERVER_DIED = 100; 2256 2257 /** The video is streamed and its container is not valid for progressive 2258 * playback i.e the video's index (e.g moov atom) is not at the start of the 2259 * file. 2260 * @see android.media.MediaPlayer.OnErrorListener 2261 */ 2262 public static final int MEDIA_ERROR_NOT_VALID_FOR_PROGRESSIVE_PLAYBACK = 200; 2263 2264 /** 2265 * Interface definition of a callback to be invoked when there 2266 * has been an error during an asynchronous operation (other errors 2267 * will throw exceptions at method call time). 2268 */ 2269 public interface OnErrorListener 2270 { 2271 /** 2272 * Called to indicate an error. 2273 * 2274 * @param mp the MediaPlayer the error pertains to 2275 * @param what the type of error that has occurred: 2276 * <ul> 2277 * <li>{@link #MEDIA_ERROR_UNKNOWN} 2278 * <li>{@link #MEDIA_ERROR_SERVER_DIED} 2279 * </ul> 2280 * @param extra an extra code, specific to the error. Typically 2281 * implementation dependant. 2282 * @return True if the method handled the error, false if it didn't. 2283 * Returning false, or not having an OnErrorListener at all, will 2284 * cause the OnCompletionListener to be called. 2285 */ 2286 boolean onError(MediaPlayer mp, int what, int extra); 2287 } 2288 2289 /** 2290 * Register a callback to be invoked when an error has happened 2291 * during an asynchronous operation. 2292 * 2293 * @param listener the callback that will be run 2294 */ 2295 public void setOnErrorListener(OnErrorListener listener) 2296 { 2297 mOnErrorListener = listener; 2298 } 2299 2300 private OnErrorListener mOnErrorListener; 2301 2302 2303 /* Do not change these values without updating their counterparts 2304 * in include/media/mediaplayer.h! 2305 */ 2306 /** Unspecified media player info. 2307 * @see android.media.MediaPlayer.OnInfoListener 2308 */ 2309 public static final int MEDIA_INFO_UNKNOWN = 1; 2310 2311 /** The player was started because it was used as the next player for another 2312 * player, which just completed playback. 2313 * @see android.media.MediaPlayer.OnInfoListener 2314 * @hide 2315 */ 2316 public static final int MEDIA_INFO_STARTED_AS_NEXT = 2; 2317 2318 /** The video is too complex for the decoder: it can't decode frames fast 2319 * enough. Possibly only the audio plays fine at this stage. 2320 * @see android.media.MediaPlayer.OnInfoListener 2321 */ 2322 public static final int MEDIA_INFO_VIDEO_TRACK_LAGGING = 700; 2323 2324 /** MediaPlayer is temporarily pausing playback internally in order to 2325 * buffer more data. 2326 * @see android.media.MediaPlayer.OnInfoListener 2327 */ 2328 public static final int MEDIA_INFO_BUFFERING_START = 701; 2329 2330 /** MediaPlayer is resuming playback after filling buffers. 2331 * @see android.media.MediaPlayer.OnInfoListener 2332 */ 2333 public static final int MEDIA_INFO_BUFFERING_END = 702; 2334 2335 /** Bad interleaving means that a media has been improperly interleaved or 2336 * not interleaved at all, e.g has all the video samples first then all the 2337 * audio ones. Video is playing but a lot of disk seeks may be happening. 2338 * @see android.media.MediaPlayer.OnInfoListener 2339 */ 2340 public static final int MEDIA_INFO_BAD_INTERLEAVING = 800; 2341 2342 /** The media cannot be seeked (e.g live stream) 2343 * @see android.media.MediaPlayer.OnInfoListener 2344 */ 2345 public static final int MEDIA_INFO_NOT_SEEKABLE = 801; 2346 2347 /** A new set of metadata is available. 2348 * @see android.media.MediaPlayer.OnInfoListener 2349 */ 2350 public static final int MEDIA_INFO_METADATA_UPDATE = 802; 2351 2352 /** Failed to handle timed text track properly. 2353 * @see android.media.MediaPlayer.OnInfoListener 2354 * 2355 * {@hide} 2356 */ 2357 public static final int MEDIA_INFO_TIMED_TEXT_ERROR = 900; 2358 2359 /** 2360 * Interface definition of a callback to be invoked to communicate some 2361 * info and/or warning about the media or its playback. 2362 */ 2363 public interface OnInfoListener 2364 { 2365 /** 2366 * Called to indicate an info or a warning. 2367 * 2368 * @param mp the MediaPlayer the info pertains to. 2369 * @param what the type of info or warning. 2370 * <ul> 2371 * <li>{@link #MEDIA_INFO_UNKNOWN} 2372 * <li>{@link #MEDIA_INFO_VIDEO_TRACK_LAGGING} 2373 * <li>{@link #MEDIA_INFO_BUFFERING_START} 2374 * <li>{@link #MEDIA_INFO_BUFFERING_END} 2375 * <li>{@link #MEDIA_INFO_BAD_INTERLEAVING} 2376 * <li>{@link #MEDIA_INFO_NOT_SEEKABLE} 2377 * <li>{@link #MEDIA_INFO_METADATA_UPDATE} 2378 * </ul> 2379 * @param extra an extra code, specific to the info. Typically 2380 * implementation dependant. 2381 * @return True if the method handled the info, false if it didn't. 2382 * Returning false, or not having an OnErrorListener at all, will 2383 * cause the info to be discarded. 2384 */ 2385 boolean onInfo(MediaPlayer mp, int what, int extra); 2386 } 2387 2388 /** 2389 * Register a callback to be invoked when an info/warning is available. 2390 * 2391 * @param listener the callback that will be run 2392 */ 2393 public void setOnInfoListener(OnInfoListener listener) 2394 { 2395 mOnInfoListener = listener; 2396 } 2397 2398 private OnInfoListener mOnInfoListener; 2399 2400 /* 2401 * Test whether a given video scaling mode is supported. 2402 */ 2403 private boolean isVideoScalingModeSupported(int mode) { 2404 return (mode == VIDEO_SCALING_MODE_SCALE_TO_FIT || 2405 mode == VIDEO_SCALING_MODE_SCALE_TO_FIT_WITH_CROPPING); 2406 } 2407} 2408