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