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