MediaPlayer.java revision 77e351f81e5a893e1843fa5babbd63754b4a0ea1
1/* 2 * Copyright (C) 2006 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17package android.media; 18 19import android.annotation.IntDef; 20import android.annotation.NonNull; 21import android.annotation.Nullable; 22import android.app.ActivityThread; 23import android.content.ContentResolver; 24import android.content.Context; 25import android.content.res.AssetFileDescriptor; 26import android.net.Uri; 27import android.os.Handler; 28import android.os.HandlerThread; 29import android.os.IBinder; 30import android.os.Looper; 31import android.os.Message; 32import android.os.Parcel; 33import android.os.Parcelable; 34import android.os.Process; 35import android.os.PowerManager; 36import android.os.SystemProperties; 37import android.provider.Settings; 38import android.system.ErrnoException; 39import android.system.OsConstants; 40import android.util.Log; 41import android.util.Pair; 42import android.view.Surface; 43import android.view.SurfaceHolder; 44import android.widget.VideoView; 45import android.graphics.SurfaceTexture; 46import android.media.AudioManager; 47import android.media.MediaFormat; 48import android.media.MediaTimeProvider; 49import android.media.PlaybackParams; 50import android.media.SubtitleController; 51import android.media.SubtitleController.Anchor; 52import android.media.SubtitleData; 53import android.media.SubtitleTrack.RenderingWidget; 54import android.media.SyncParams; 55 56import com.android.internal.util.Preconditions; 57 58import libcore.io.IoBridge; 59import libcore.io.Libcore; 60 61import java.io.ByteArrayOutputStream; 62import java.io.File; 63import java.io.FileDescriptor; 64import java.io.FileInputStream; 65import java.io.IOException; 66import java.io.InputStream; 67import java.lang.Runnable; 68import java.lang.annotation.Retention; 69import java.lang.annotation.RetentionPolicy; 70import java.net.InetSocketAddress; 71import java.util.BitSet; 72import java.util.Map; 73import java.util.Scanner; 74import java.util.Set; 75import java.util.Vector; 76import java.lang.ref.WeakReference; 77 78/** 79 * MediaPlayer class can be used to control playback 80 * of audio/video files and streams. An example on how to use the methods in 81 * this class can be found in {@link android.widget.VideoView}. 82 * 83 * <p>Topics covered here are: 84 * <ol> 85 * <li><a href="#StateDiagram">State Diagram</a> 86 * <li><a href="#Valid_and_Invalid_States">Valid and Invalid States</a> 87 * <li><a href="#Permissions">Permissions</a> 88 * <li><a href="#Callbacks">Register informational and error callbacks</a> 89 * </ol> 90 * 91 * <div class="special reference"> 92 * <h3>Developer Guides</h3> 93 * <p>For more information about how to use MediaPlayer, read the 94 * <a href="{@docRoot}guide/topics/media/mediaplayer.html">Media Playback</a> developer guide.</p> 95 * </div> 96 * 97 * <a name="StateDiagram"></a> 98 * <h3>State Diagram</h3> 99 * 100 * <p>Playback control of audio/video files and streams is managed as a state 101 * machine. The following diagram shows the life cycle and the states of a 102 * MediaPlayer object driven by the supported playback control operations. 103 * The ovals represent the states a MediaPlayer object may reside 104 * in. The arcs represent the playback control operations that drive the object 105 * state transition. There are two types of arcs. The arcs with a single arrow 106 * head represent synchronous method calls, while those with 107 * a double arrow head represent asynchronous method calls.</p> 108 * 109 * <p><img src="../../../images/mediaplayer_state_diagram.gif" 110 * alt="MediaPlayer State diagram" 111 * border="0" /></p> 112 * 113 * <p>From this state diagram, one can see that a MediaPlayer object has the 114 * following states:</p> 115 * <ul> 116 * <li>When a MediaPlayer object is just created using <code>new</code> or 117 * after {@link #reset()} is called, it is in the <em>Idle</em> state; and after 118 * {@link #release()} is called, it is in the <em>End</em> state. Between these 119 * two states is the life cycle of the MediaPlayer object. 120 * <ul> 121 * <li>There is a subtle but important difference between a newly constructed 122 * MediaPlayer object and the MediaPlayer object after {@link #reset()} 123 * is called. It is a programming error to invoke methods such 124 * as {@link #getCurrentPosition()}, 125 * {@link #getDuration()}, {@link #getVideoHeight()}, 126 * {@link #getVideoWidth()}, {@link #setAudioStreamType(int)}, 127 * {@link #setLooping(boolean)}, 128 * {@link #setVolume(float, float)}, {@link #pause()}, {@link #start()}, 129 * {@link #stop()}, {@link #seekTo(int)}, {@link #prepare()} or 130 * {@link #prepareAsync()} in the <em>Idle</em> state for both cases. If any of these 131 * methods is called right after a MediaPlayer object is constructed, 132 * the user supplied callback method OnErrorListener.onError() won't be 133 * called by the internal player engine and the object state remains 134 * unchanged; but if these methods are called right after {@link #reset()}, 135 * the user supplied callback method OnErrorListener.onError() will be 136 * invoked by the internal player engine and the object will be 137 * transfered to the <em>Error</em> state. </li> 138 * <li>It is also recommended that once 139 * a MediaPlayer object is no longer being used, call {@link #release()} immediately 140 * so that resources used by the internal player engine associated with the 141 * MediaPlayer object can be released immediately. Resource may include 142 * singleton resources such as hardware acceleration components and 143 * failure to call {@link #release()} may cause subsequent instances of 144 * MediaPlayer objects to fallback to software implementations or fail 145 * altogether. Once the MediaPlayer 146 * object is in the <em>End</em> state, it can no longer be used and 147 * there is no way to bring it back to any other state. </li> 148 * <li>Furthermore, 149 * the MediaPlayer objects created using <code>new</code> is in the 150 * <em>Idle</em> state, while those created with one 151 * of the overloaded convenient <code>create</code> methods are <em>NOT</em> 152 * in the <em>Idle</em> state. In fact, the objects are in the <em>Prepared</em> 153 * state if the creation using <code>create</code> method is successful. 154 * </li> 155 * </ul> 156 * </li> 157 * <li>In general, some playback control operation may fail due to various 158 * reasons, such as unsupported audio/video format, poorly interleaved 159 * audio/video, resolution too high, streaming timeout, and the like. 160 * Thus, error reporting and recovery is an important concern under 161 * these circumstances. Sometimes, due to programming errors, invoking a playback 162 * control operation in an invalid state may also occur. Under all these 163 * error conditions, the internal player engine invokes a user supplied 164 * OnErrorListener.onError() method if an OnErrorListener has been 165 * registered beforehand via 166 * {@link #setOnErrorListener(android.media.MediaPlayer.OnErrorListener)}. 167 * <ul> 168 * <li>It is important to note that once an error occurs, the 169 * MediaPlayer object enters the <em>Error</em> state (except as noted 170 * above), even if an error listener has not been registered by the application.</li> 171 * <li>In order to reuse a MediaPlayer object that is in the <em> 172 * Error</em> state and recover from the error, 173 * {@link #reset()} can be called to restore the object to its <em>Idle</em> 174 * state.</li> 175 * <li>It is good programming practice to have your application 176 * register a OnErrorListener to look out for error notifications from 177 * the internal player engine.</li> 178 * <li>IllegalStateException is 179 * thrown to prevent programming errors such as calling {@link #prepare()}, 180 * {@link #prepareAsync()}, or one of the overloaded <code>setDataSource 181 * </code> methods in an invalid state. </li> 182 * </ul> 183 * </li> 184 * <li>Calling 185 * {@link #setDataSource(FileDescriptor)}, or 186 * {@link #setDataSource(String)}, or 187 * {@link #setDataSource(Context, Uri)}, or 188 * {@link #setDataSource(FileDescriptor, long, long)}, or 189 * {@link #setDataSource(MediaDataSource)} transfers a 190 * MediaPlayer object in the <em>Idle</em> state to the 191 * <em>Initialized</em> state. 192 * <ul> 193 * <li>An IllegalStateException is thrown if 194 * setDataSource() is called in any other state.</li> 195 * <li>It is good programming 196 * practice to always look out for <code>IllegalArgumentException</code> 197 * and <code>IOException</code> that may be thrown from the overloaded 198 * <code>setDataSource</code> methods.</li> 199 * </ul> 200 * </li> 201 * <li>A MediaPlayer object must first enter the <em>Prepared</em> state 202 * before playback can be started. 203 * <ul> 204 * <li>There are two ways (synchronous vs. 205 * asynchronous) that the <em>Prepared</em> state can be reached: 206 * either a call to {@link #prepare()} (synchronous) which 207 * transfers the object to the <em>Prepared</em> state once the method call 208 * returns, or a call to {@link #prepareAsync()} (asynchronous) which 209 * first transfers the object to the <em>Preparing</em> state after the 210 * call returns (which occurs almost right way) while the internal 211 * player engine continues working on the rest of preparation work 212 * until the preparation work completes. When the preparation completes or when {@link #prepare()} call returns, 213 * the internal player engine then calls a user supplied callback method, 214 * onPrepared() of the OnPreparedListener interface, if an 215 * OnPreparedListener is registered beforehand via {@link 216 * #setOnPreparedListener(android.media.MediaPlayer.OnPreparedListener)}.</li> 217 * <li>It is important to note that 218 * the <em>Preparing</em> state is a transient state, and the behavior 219 * of calling any method with side effect while a MediaPlayer object is 220 * in the <em>Preparing</em> state is undefined.</li> 221 * <li>An IllegalStateException is 222 * thrown if {@link #prepare()} or {@link #prepareAsync()} is called in 223 * any other state.</li> 224 * <li>While in the <em>Prepared</em> state, properties 225 * such as audio/sound volume, screenOnWhilePlaying, looping can be 226 * adjusted by invoking the corresponding set methods.</li> 227 * </ul> 228 * </li> 229 * <li>To start the playback, {@link #start()} must be called. After 230 * {@link #start()} returns successfully, the MediaPlayer object is in the 231 * <em>Started</em> state. {@link #isPlaying()} can be called to test 232 * whether the MediaPlayer object is in the <em>Started</em> state. 233 * <ul> 234 * <li>While in the <em>Started</em> state, the internal player engine calls 235 * a user supplied OnBufferingUpdateListener.onBufferingUpdate() callback 236 * method if a OnBufferingUpdateListener has been registered beforehand 237 * via {@link #setOnBufferingUpdateListener(OnBufferingUpdateListener)}. 238 * This callback allows applications to keep track of the buffering status 239 * while streaming audio/video.</li> 240 * <li>Calling {@link #start()} has not effect 241 * on a MediaPlayer object that is already in the <em>Started</em> state.</li> 242 * </ul> 243 * </li> 244 * <li>Playback can be paused and stopped, and the current playback position 245 * can be adjusted. Playback can be paused via {@link #pause()}. When the call to 246 * {@link #pause()} returns, the MediaPlayer object enters the 247 * <em>Paused</em> state. Note that the transition from the <em>Started</em> 248 * state to the <em>Paused</em> state and vice versa happens 249 * asynchronously in the player engine. It may take some time before 250 * the state is updated in calls to {@link #isPlaying()}, and it can be 251 * a number of seconds in the case of streamed content. 252 * <ul> 253 * <li>Calling {@link #start()} to resume playback for a paused 254 * MediaPlayer object, and the resumed playback 255 * position is the same as where it was paused. When the call to 256 * {@link #start()} returns, the paused MediaPlayer object goes back to 257 * the <em>Started</em> state.</li> 258 * <li>Calling {@link #pause()} has no effect on 259 * a MediaPlayer object that is already in the <em>Paused</em> state.</li> 260 * </ul> 261 * </li> 262 * <li>Calling {@link #stop()} stops playback and causes a 263 * MediaPlayer in the <em>Started</em>, <em>Paused</em>, <em>Prepared 264 * </em> or <em>PlaybackCompleted</em> state to enter the 265 * <em>Stopped</em> state. 266 * <ul> 267 * <li>Once in the <em>Stopped</em> state, playback cannot be started 268 * until {@link #prepare()} or {@link #prepareAsync()} are called to set 269 * the MediaPlayer object to the <em>Prepared</em> state again.</li> 270 * <li>Calling {@link #stop()} has no effect on a MediaPlayer 271 * object that is already in the <em>Stopped</em> state.</li> 272 * </ul> 273 * </li> 274 * <li>The playback position can be adjusted with a call to 275 * {@link #seekTo(int)}. 276 * <ul> 277 * <li>Although the asynchronuous {@link #seekTo(int)} 278 * call returns right way, the actual seek operation may take a while to 279 * finish, especially for audio/video being streamed. When the actual 280 * seek operation completes, the internal player engine calls a user 281 * supplied OnSeekComplete.onSeekComplete() if an OnSeekCompleteListener 282 * has been registered beforehand via 283 * {@link #setOnSeekCompleteListener(OnSeekCompleteListener)}.</li> 284 * <li>Please 285 * note that {@link #seekTo(int)} can also be called in the other states, 286 * such as <em>Prepared</em>, <em>Paused</em> and <em>PlaybackCompleted 287 * </em> state.</li> 288 * <li>Furthermore, the actual current playback position 289 * can be retrieved with a call to {@link #getCurrentPosition()}, which 290 * is helpful for applications such as a Music player that need to keep 291 * track of the playback progress.</li> 292 * </ul> 293 * </li> 294 * <li>When the playback reaches the end of stream, the playback completes. 295 * <ul> 296 * <li>If the looping mode was being set to <var>true</var>with 297 * {@link #setLooping(boolean)}, the MediaPlayer object shall remain in 298 * the <em>Started</em> state.</li> 299 * <li>If the looping mode was set to <var>false 300 * </var>, the player engine calls a user supplied callback method, 301 * OnCompletion.onCompletion(), if a OnCompletionListener is registered 302 * beforehand via {@link #setOnCompletionListener(OnCompletionListener)}. 303 * The invoke of the callback signals that the object is now in the <em> 304 * PlaybackCompleted</em> state.</li> 305 * <li>While in the <em>PlaybackCompleted</em> 306 * state, calling {@link #start()} can restart the playback from the 307 * beginning of the audio/video source.</li> 308 * </ul> 309 * 310 * 311 * <a name="Valid_and_Invalid_States"></a> 312 * <h3>Valid and invalid states</h3> 313 * 314 * <table border="0" cellspacing="0" cellpadding="0"> 315 * <tr><td>Method Name </p></td> 316 * <td>Valid Sates </p></td> 317 * <td>Invalid States </p></td> 318 * <td>Comments </p></td></tr> 319 * <tr><td>attachAuxEffect </p></td> 320 * <td>{Initialized, Prepared, Started, Paused, Stopped, PlaybackCompleted} </p></td> 321 * <td>{Idle, Error} </p></td> 322 * <td>This method must be called after setDataSource. 323 * Calling it does not change the object state. </p></td></tr> 324 * <tr><td>getAudioSessionId </p></td> 325 * <td>any </p></td> 326 * <td>{} </p></td> 327 * <td>This method can be called in any state and calling it does not change 328 * the object state. </p></td></tr> 329 * <tr><td>getCurrentPosition </p></td> 330 * <td>{Idle, Initialized, Prepared, Started, Paused, Stopped, 331 * PlaybackCompleted} </p></td> 332 * <td>{Error}</p></td> 333 * <td>Successful invoke of this method in a valid state does not change the 334 * state. Calling this method in an invalid state transfers the object 335 * to the <em>Error</em> state. </p></td></tr> 336 * <tr><td>getDuration </p></td> 337 * <td>{Prepared, Started, Paused, Stopped, PlaybackCompleted} </p></td> 338 * <td>{Idle, Initialized, Error} </p></td> 339 * <td>Successful invoke of this method in a valid state does not change the 340 * state. Calling this method in an invalid state transfers the object 341 * to the <em>Error</em> state. </p></td></tr> 342 * <tr><td>getVideoHeight </p></td> 343 * <td>{Idle, Initialized, Prepared, Started, Paused, Stopped, 344 * PlaybackCompleted}</p></td> 345 * <td>{Error}</p></td> 346 * <td>Successful invoke of this method in a valid state does not change the 347 * state. Calling this method in an invalid state transfers the object 348 * to the <em>Error</em> state. </p></td></tr> 349 * <tr><td>getVideoWidth </p></td> 350 * <td>{Idle, Initialized, Prepared, Started, Paused, Stopped, 351 * PlaybackCompleted}</p></td> 352 * <td>{Error}</p></td> 353 * <td>Successful invoke of this method in a valid state does not change 354 * the state. Calling this method in an invalid state transfers the 355 * object to the <em>Error</em> state. </p></td></tr> 356 * <tr><td>isPlaying </p></td> 357 * <td>{Idle, Initialized, Prepared, Started, Paused, Stopped, 358 * PlaybackCompleted}</p></td> 359 * <td>{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>pause </p></td> 364 * <td>{Started, Paused, PlaybackCompleted}</p></td> 365 * <td>{Idle, Initialized, Prepared, Stopped, Error}</p></td> 366 * <td>Successful invoke of this method in a valid state transfers the 367 * object to the <em>Paused</em> state. Calling this method in an 368 * invalid state transfers the object to the <em>Error</em> state.</p></td></tr> 369 * <tr><td>prepare </p></td> 370 * <td>{Initialized, Stopped} </p></td> 371 * <td>{Idle, Prepared, Started, Paused, PlaybackCompleted, Error} </p></td> 372 * <td>Successful invoke of this method in a valid state transfers the 373 * object to the <em>Prepared</em> state. Calling this method in an 374 * invalid state throws an IllegalStateException.</p></td></tr> 375 * <tr><td>prepareAsync </p></td> 376 * <td>{Initialized, Stopped} </p></td> 377 * <td>{Idle, Prepared, Started, Paused, PlaybackCompleted, Error} </p></td> 378 * <td>Successful invoke of this method in a valid state transfers the 379 * object to the <em>Preparing</em> state. Calling this method in an 380 * invalid state throws an IllegalStateException.</p></td></tr> 381 * <tr><td>release </p></td> 382 * <td>any </p></td> 383 * <td>{} </p></td> 384 * <td>After {@link #release()}, the object is no longer available. </p></td></tr> 385 * <tr><td>reset </p></td> 386 * <td>{Idle, Initialized, Prepared, Started, Paused, Stopped, 387 * PlaybackCompleted, Error}</p></td> 388 * <td>{}</p></td> 389 * <td>After {@link #reset()}, the object is like being just created.</p></td></tr> 390 * <tr><td>seekTo </p></td> 391 * <td>{Prepared, Started, Paused, PlaybackCompleted} </p></td> 392 * <td>{Idle, Initialized, Stopped, Error}</p></td> 393 * <td>Successful invoke of this method in a valid state does not change 394 * the state. Calling this method in an invalid state transfers the 395 * object to the <em>Error</em> state. </p></td></tr> 396 * <tr><td>setAudioAttributes </p></td> 397 * <td>{Idle, Initialized, Stopped, Prepared, Started, Paused, 398 * PlaybackCompleted}</p></td> 399 * <td>{Error}</p></td> 400 * <td>Successful invoke of this method does not change the state. In order for the 401 * target audio attributes type to become effective, this method must be called before 402 * prepare() or prepareAsync().</p></td></tr> 403 * <tr><td>setAudioSessionId </p></td> 404 * <td>{Idle} </p></td> 405 * <td>{Initialized, Prepared, Started, Paused, Stopped, PlaybackCompleted, 406 * Error} </p></td> 407 * <td>This method must be called in idle state as the audio session ID must be known before 408 * calling setDataSource. Calling it does not change the object state. </p></td></tr> 409 * <tr><td>setAudioStreamType </p></td> 410 * <td>{Idle, Initialized, Stopped, Prepared, Started, Paused, 411 * PlaybackCompleted}</p></td> 412 * <td>{Error}</p></td> 413 * <td>Successful invoke of this method does not change the state. In order for the 414 * target audio stream type to become effective, this method must be called before 415 * prepare() or prepareAsync().</p></td></tr> 416 * <tr><td>setAuxEffectSendLevel </p></td> 417 * <td>any</p></td> 418 * <td>{} </p></td> 419 * <td>Calling this method does not change the object state. </p></td></tr> 420 * <tr><td>setDataSource </p></td> 421 * <td>{Idle} </p></td> 422 * <td>{Initialized, Prepared, Started, Paused, Stopped, PlaybackCompleted, 423 * Error} </p></td> 424 * <td>Successful invoke of this method in a valid state transfers the 425 * object to the <em>Initialized</em> state. Calling this method in an 426 * invalid state throws an IllegalStateException.</p></td></tr> 427 * <tr><td>setDisplay </p></td> 428 * <td>any </p></td> 429 * <td>{} </p></td> 430 * <td>This method can be called in any state and calling it does not change 431 * the object state. </p></td></tr> 432 * <tr><td>setSurface </p></td> 433 * <td>any </p></td> 434 * <td>{} </p></td> 435 * <td>This method can be called in any state and calling it does not change 436 * the object state. </p></td></tr> 437 * <tr><td>setVideoScalingMode </p></td> 438 * <td>{Initialized, Prepared, Started, Paused, Stopped, PlaybackCompleted} </p></td> 439 * <td>{Idle, Error}</p></td> 440 * <td>Successful invoke of this method does not change the state.</p></td></tr> 441 * <tr><td>setLooping </p></td> 442 * <td>{Idle, Initialized, Stopped, Prepared, Started, Paused, 443 * PlaybackCompleted}</p></td> 444 * <td>{Error}</p></td> 445 * <td>Successful invoke of this method in a valid state does not change 446 * the state. Calling this method in an 447 * invalid state transfers the object to the <em>Error</em> state.</p></td></tr> 448 * <tr><td>isLooping </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>setOnBufferingUpdateListener </p></td> 454 * <td>any </p></td> 455 * <td>{} </p></td> 456 * <td>This method can be called in any state and calling it does not change 457 * the object state. </p></td></tr> 458 * <tr><td>setOnCompletionListener </p></td> 459 * <td>any </p></td> 460 * <td>{} </p></td> 461 * <td>This method can be called in any state and calling it does not change 462 * the object state. </p></td></tr> 463 * <tr><td>setOnErrorListener </p></td> 464 * <td>any </p></td> 465 * <td>{} </p></td> 466 * <td>This method can be called in any state and calling it does not change 467 * the object state. </p></td></tr> 468 * <tr><td>setOnPreparedListener </p></td> 469 * <td>any </p></td> 470 * <td>{} </p></td> 471 * <td>This method can be called in any state and calling it does not change 472 * the object state. </p></td></tr> 473 * <tr><td>setOnSeekCompleteListener </p></td> 474 * <td>any </p></td> 475 * <td>{} </p></td> 476 * <td>This method can be called in any state and calling it does not change 477 * the object state. </p></td></tr> 478 * <tr><td>setPlaybackParams</p></td> 479 * <td>any </p></td> 480 * <td>{} </p></td> 481 * <td>This method can be called in any state and calling it does not change 482 * the object state. </p></td></tr> 483 * <tr><td>setScreenOnWhilePlaying</></td> 484 * <td>any </p></td> 485 * <td>{} </p></td> 486 * <td>This method can be called in any state and calling it does not change 487 * the object state. </p></td></tr> 488 * <tr><td>setVolume </p></td> 489 * <td>{Idle, Initialized, Stopped, Prepared, Started, Paused, 490 * PlaybackCompleted}</p></td> 491 * <td>{Error}</p></td> 492 * <td>Successful invoke of this method does not change the state. 493 * <tr><td>setWakeMode </p></td> 494 * <td>any </p></td> 495 * <td>{} </p></td> 496 * <td>This method can be called in any state and calling it does not change 497 * the object state.</p></td></tr> 498 * <tr><td>start </p></td> 499 * <td>{Prepared, Started, Paused, PlaybackCompleted}</p></td> 500 * <td>{Idle, Initialized, Stopped, Error}</p></td> 501 * <td>Successful invoke of this method in a valid state transfers the 502 * object to the <em>Started</em> state. Calling this method in an 503 * invalid state transfers the object to the <em>Error</em> state.</p></td></tr> 504 * <tr><td>stop </p></td> 505 * <td>{Prepared, Started, Stopped, Paused, PlaybackCompleted}</p></td> 506 * <td>{Idle, Initialized, Error}</p></td> 507 * <td>Successful invoke of this method in a valid state transfers the 508 * object to the <em>Stopped</em> state. Calling this method in an 509 * invalid state transfers the object to the <em>Error</em> state.</p></td></tr> 510 * <tr><td>getTrackInfo </p></td> 511 * <td>{Prepared, Started, Stopped, Paused, PlaybackCompleted}</p></td> 512 * <td>{Idle, Initialized, Error}</p></td> 513 * <td>Successful invoke of this method does not change the state.</p></td></tr> 514 * <tr><td>addTimedTextSource </p></td> 515 * <td>{Prepared, Started, Stopped, Paused, PlaybackCompleted}</p></td> 516 * <td>{Idle, Initialized, Error}</p></td> 517 * <td>Successful invoke of this method does not change the state.</p></td></tr> 518 * <tr><td>selectTrack </p></td> 519 * <td>{Prepared, Started, Stopped, Paused, PlaybackCompleted}</p></td> 520 * <td>{Idle, Initialized, Error}</p></td> 521 * <td>Successful invoke of this method does not change the state.</p></td></tr> 522 * <tr><td>deselectTrack </p></td> 523 * <td>{Prepared, Started, Stopped, Paused, PlaybackCompleted}</p></td> 524 * <td>{Idle, Initialized, Error}</p></td> 525 * <td>Successful invoke of this method does not change the state.</p></td></tr> 526 * 527 * </table> 528 * 529 * <a name="Permissions"></a> 530 * <h3>Permissions</h3> 531 * <p>One may need to declare a corresponding WAKE_LOCK permission {@link 532 * android.R.styleable#AndroidManifestUsesPermission <uses-permission>} 533 * element. 534 * 535 * <p>This class requires the {@link android.Manifest.permission#INTERNET} permission 536 * when used with network-based content. 537 * 538 * <a name="Callbacks"></a> 539 * <h3>Callbacks</h3> 540 * <p>Applications may want to register for informational and error 541 * events in order to be informed of some internal state update and 542 * possible runtime errors during playback or streaming. Registration for 543 * these events is done by properly setting the appropriate listeners (via calls 544 * to 545 * {@link #setOnPreparedListener(OnPreparedListener)}setOnPreparedListener, 546 * {@link #setOnVideoSizeChangedListener(OnVideoSizeChangedListener)}setOnVideoSizeChangedListener, 547 * {@link #setOnSeekCompleteListener(OnSeekCompleteListener)}setOnSeekCompleteListener, 548 * {@link #setOnCompletionListener(OnCompletionListener)}setOnCompletionListener, 549 * {@link #setOnBufferingUpdateListener(OnBufferingUpdateListener)}setOnBufferingUpdateListener, 550 * {@link #setOnInfoListener(OnInfoListener)}setOnInfoListener, 551 * {@link #setOnErrorListener(OnErrorListener)}setOnErrorListener, etc). 552 * In order to receive the respective callback 553 * associated with these listeners, applications are required to create 554 * MediaPlayer objects on a thread with its own Looper running (main UI 555 * thread by default has a Looper running). 556 * 557 */ 558public class MediaPlayer extends PlayerBase 559 implements SubtitleController.Listener 560{ 561 /** 562 Constant to retrieve only the new metadata since the last 563 call. 564 // FIXME: unhide. 565 // FIXME: add link to getMetadata(boolean, boolean) 566 {@hide} 567 */ 568 public static final boolean METADATA_UPDATE_ONLY = true; 569 570 /** 571 Constant to retrieve all the metadata. 572 // FIXME: unhide. 573 // FIXME: add link to getMetadata(boolean, boolean) 574 {@hide} 575 */ 576 public static final boolean METADATA_ALL = false; 577 578 /** 579 Constant to enable the metadata filter during retrieval. 580 // FIXME: unhide. 581 // FIXME: add link to getMetadata(boolean, boolean) 582 {@hide} 583 */ 584 public static final boolean APPLY_METADATA_FILTER = true; 585 586 /** 587 Constant to disable the metadata filter during retrieval. 588 // FIXME: unhide. 589 // FIXME: add link to getMetadata(boolean, boolean) 590 {@hide} 591 */ 592 public static final boolean BYPASS_METADATA_FILTER = false; 593 594 static { 595 System.loadLibrary("media_jni"); 596 native_init(); 597 } 598 599 private final static String TAG = "MediaPlayer"; 600 // Name of the remote interface for the media player. Must be kept 601 // in sync with the 2nd parameter of the IMPLEMENT_META_INTERFACE 602 // macro invocation in IMediaPlayer.cpp 603 private final static String IMEDIA_PLAYER = "android.media.IMediaPlayer"; 604 605 private long mNativeContext; // accessed by native methods 606 private long mNativeSurfaceTexture; // accessed by native methods 607 private int mListenerContext; // accessed by native methods 608 private SurfaceHolder mSurfaceHolder; 609 private EventHandler mEventHandler; 610 private PowerManager.WakeLock mWakeLock = null; 611 private boolean mScreenOnWhilePlaying; 612 private boolean mStayAwake; 613 private int mStreamType = AudioManager.USE_DEFAULT_STREAM_TYPE; 614 private int mUsage = -1; 615 private boolean mBypassInterruptionPolicy; 616 617 /** 618 * Default constructor. Consider using one of the create() methods for 619 * synchronously instantiating a MediaPlayer from a Uri or resource. 620 * <p>When done with the MediaPlayer, you should call {@link #release()}, 621 * to free the resources. If not released, too many MediaPlayer instances may 622 * result in an exception.</p> 623 */ 624 public MediaPlayer() { 625 super(new AudioAttributes.Builder().build()); 626 627 Looper looper; 628 if ((looper = Looper.myLooper()) != null) { 629 mEventHandler = new EventHandler(this, looper); 630 } else if ((looper = Looper.getMainLooper()) != null) { 631 mEventHandler = new EventHandler(this, looper); 632 } else { 633 mEventHandler = null; 634 } 635 636 mTimeProvider = new TimeProvider(this); 637 mOpenSubtitleSources = new Vector<InputStream>(); 638 639 /* Native setup requires a weak reference to our object. 640 * It's easier to create it here than in C++. 641 */ 642 native_setup(new WeakReference<MediaPlayer>(this)); 643 } 644 645 /* 646 * Update the MediaPlayer SurfaceTexture. 647 * Call after setting a new display surface. 648 */ 649 private native void _setVideoSurface(Surface surface); 650 651 /* Do not change these values (starting with INVOKE_ID) without updating 652 * their counterparts in include/media/mediaplayer.h! 653 */ 654 private static final int INVOKE_ID_GET_TRACK_INFO = 1; 655 private static final int INVOKE_ID_ADD_EXTERNAL_SOURCE = 2; 656 private static final int INVOKE_ID_ADD_EXTERNAL_SOURCE_FD = 3; 657 private static final int INVOKE_ID_SELECT_TRACK = 4; 658 private static final int INVOKE_ID_DESELECT_TRACK = 5; 659 private static final int INVOKE_ID_SET_VIDEO_SCALE_MODE = 6; 660 private static final int INVOKE_ID_GET_SELECTED_TRACK = 7; 661 662 /** 663 * Create a request parcel which can be routed to the native media 664 * player using {@link #invoke(Parcel, Parcel)}. The Parcel 665 * returned has the proper InterfaceToken set. The caller should 666 * not overwrite that token, i.e it can only append data to the 667 * Parcel. 668 * 669 * @return A parcel suitable to hold a request for the native 670 * player. 671 * {@hide} 672 */ 673 public Parcel newRequest() { 674 Parcel parcel = Parcel.obtain(); 675 parcel.writeInterfaceToken(IMEDIA_PLAYER); 676 return parcel; 677 } 678 679 /** 680 * Invoke a generic method on the native player using opaque 681 * parcels for the request and reply. Both payloads' format is a 682 * convention between the java caller and the native player. 683 * Must be called after setDataSource to make sure a native player 684 * exists. On failure, a RuntimeException is thrown. 685 * 686 * @param request Parcel with the data for the extension. The 687 * caller must use {@link #newRequest()} to get one. 688 * 689 * @param reply Output parcel with the data returned by the 690 * native player. 691 * {@hide} 692 */ 693 public void invoke(Parcel request, Parcel reply) { 694 int retcode = native_invoke(request, reply); 695 reply.setDataPosition(0); 696 if (retcode != 0) { 697 throw new RuntimeException("failure code: " + retcode); 698 } 699 } 700 701 /** 702 * Sets the {@link SurfaceHolder} to use for displaying the video 703 * portion of the media. 704 * 705 * Either a surface holder or surface must be set if a display or video sink 706 * is needed. Not calling this method or {@link #setSurface(Surface)} 707 * when playing back a video will result in only the audio track being played. 708 * A null surface holder or surface will result in only the audio track being 709 * played. 710 * 711 * @param sh the SurfaceHolder to use for video display 712 * @throws IllegalStateException if the internal player engine has not been 713 * initialized or has been released. 714 */ 715 public void setDisplay(SurfaceHolder sh) { 716 mSurfaceHolder = sh; 717 Surface surface; 718 if (sh != null) { 719 surface = sh.getSurface(); 720 } else { 721 surface = null; 722 } 723 _setVideoSurface(surface); 724 updateSurfaceScreenOn(); 725 } 726 727 /** 728 * Sets the {@link Surface} to be used as the sink for the video portion of 729 * the media. This is similar to {@link #setDisplay(SurfaceHolder)}, but 730 * does not support {@link #setScreenOnWhilePlaying(boolean)}. Setting a 731 * Surface will un-set any Surface or SurfaceHolder that was previously set. 732 * A null surface will result in only the audio track being played. 733 * 734 * If the Surface sends frames to a {@link SurfaceTexture}, the timestamps 735 * returned from {@link SurfaceTexture#getTimestamp()} will have an 736 * unspecified zero point. These timestamps cannot be directly compared 737 * between different media sources, different instances of the same media 738 * source, or multiple runs of the same program. The timestamp is normally 739 * monotonically increasing and is unaffected by time-of-day adjustments, 740 * but it is reset when the position is set. 741 * 742 * @param surface The {@link Surface} to be used for the video portion of 743 * the media. 744 * @throws IllegalStateException if the internal player engine has not been 745 * initialized or has been released. 746 */ 747 public void setSurface(Surface surface) { 748 if (mScreenOnWhilePlaying && surface != null) { 749 Log.w(TAG, "setScreenOnWhilePlaying(true) is ineffective for Surface"); 750 } 751 mSurfaceHolder = null; 752 _setVideoSurface(surface); 753 updateSurfaceScreenOn(); 754 } 755 756 /* Do not change these video scaling mode values below without updating 757 * their counterparts in system/window.h! Please do not forget to update 758 * {@link #isVideoScalingModeSupported} when new video scaling modes 759 * are added. 760 */ 761 /** 762 * Specifies a video scaling mode. The content is stretched to the 763 * surface rendering area. When the surface has the same aspect ratio 764 * as the content, the aspect ratio of the content is maintained; 765 * otherwise, the aspect ratio of the content is not maintained when video 766 * is being rendered. Unlike {@link #VIDEO_SCALING_MODE_SCALE_TO_FIT_WITH_CROPPING}, 767 * there is no content cropping with this video scaling mode. 768 */ 769 public static final int VIDEO_SCALING_MODE_SCALE_TO_FIT = 1; 770 771 /** 772 * Specifies a video scaling mode. The content is scaled, maintaining 773 * its aspect ratio. The whole surface area is always used. When the 774 * aspect ratio of the content is the same as the surface, no content 775 * is cropped; otherwise, content is cropped to fit the surface. 776 */ 777 public static final int VIDEO_SCALING_MODE_SCALE_TO_FIT_WITH_CROPPING = 2; 778 /** 779 * Sets video scaling mode. To make the target video scaling mode 780 * effective during playback, this method must be called after 781 * data source is set. If not called, the default video 782 * scaling mode is {@link #VIDEO_SCALING_MODE_SCALE_TO_FIT}. 783 * 784 * <p> The supported video scaling modes are: 785 * <ul> 786 * <li> {@link #VIDEO_SCALING_MODE_SCALE_TO_FIT} 787 * <li> {@link #VIDEO_SCALING_MODE_SCALE_TO_FIT_WITH_CROPPING} 788 * </ul> 789 * 790 * @param mode target video scaling mode. Must be one of the supported 791 * video scaling modes; otherwise, IllegalArgumentException will be thrown. 792 * 793 * @see MediaPlayer#VIDEO_SCALING_MODE_SCALE_TO_FIT 794 * @see MediaPlayer#VIDEO_SCALING_MODE_SCALE_TO_FIT_WITH_CROPPING 795 */ 796 public void setVideoScalingMode(int mode) { 797 if (!isVideoScalingModeSupported(mode)) { 798 final String msg = "Scaling mode " + mode + " is not supported"; 799 throw new IllegalArgumentException(msg); 800 } 801 Parcel request = Parcel.obtain(); 802 Parcel reply = Parcel.obtain(); 803 try { 804 request.writeInterfaceToken(IMEDIA_PLAYER); 805 request.writeInt(INVOKE_ID_SET_VIDEO_SCALE_MODE); 806 request.writeInt(mode); 807 invoke(request, reply); 808 } finally { 809 request.recycle(); 810 reply.recycle(); 811 } 812 } 813 814 /** 815 * Convenience method to create a MediaPlayer for a given Uri. 816 * On success, {@link #prepare()} will already have been called and must not be called again. 817 * <p>When done with the MediaPlayer, you should call {@link #release()}, 818 * to free the resources. If not released, too many MediaPlayer instances will 819 * result in an exception.</p> 820 * <p>Note that since {@link #prepare()} is called automatically in this method, 821 * you cannot change the audio stream type (see {@link #setAudioStreamType(int)}), audio 822 * session ID (see {@link #setAudioSessionId(int)}) or audio attributes 823 * (see {@link #setAudioAttributes(AudioAttributes)} of the new MediaPlayer.</p> 824 * 825 * @param context the Context to use 826 * @param uri the Uri from which to get the datasource 827 * @return a MediaPlayer object, or null if creation failed 828 */ 829 public static MediaPlayer create(Context context, Uri uri) { 830 return create (context, uri, null); 831 } 832 833 /** 834 * Convenience method to create a MediaPlayer for a given Uri. 835 * On success, {@link #prepare()} will already have been called and must not be called again. 836 * <p>When done with the MediaPlayer, you should call {@link #release()}, 837 * to free the resources. If not released, too many MediaPlayer instances will 838 * result in an exception.</p> 839 * <p>Note that since {@link #prepare()} is called automatically in this method, 840 * you cannot change the audio stream type (see {@link #setAudioStreamType(int)}), audio 841 * session ID (see {@link #setAudioSessionId(int)}) or audio attributes 842 * (see {@link #setAudioAttributes(AudioAttributes)} of the new MediaPlayer.</p> 843 * 844 * @param context the Context to use 845 * @param uri the Uri from which to get the datasource 846 * @param holder the SurfaceHolder to use for displaying the video 847 * @return a MediaPlayer object, or null if creation failed 848 */ 849 public static MediaPlayer create(Context context, Uri uri, SurfaceHolder holder) { 850 int s = AudioSystem.newAudioSessionId(); 851 return create(context, uri, holder, null, s > 0 ? s : 0); 852 } 853 854 /** 855 * Same factory method as {@link #create(Context, Uri, SurfaceHolder)} but that lets you specify 856 * the audio attributes and session ID to be used by the new MediaPlayer instance. 857 * @param context the Context to use 858 * @param uri the Uri from which to get the datasource 859 * @param holder the SurfaceHolder to use for displaying the video, may be null. 860 * @param audioAttributes the {@link AudioAttributes} to be used by the media player. 861 * @param audioSessionId the audio session ID to be used by the media player, 862 * see {@link AudioManager#generateAudioSessionId()} to obtain a new session. 863 * @return a MediaPlayer object, or null if creation failed 864 */ 865 public static MediaPlayer create(Context context, Uri uri, SurfaceHolder holder, 866 AudioAttributes audioAttributes, int audioSessionId) { 867 868 try { 869 MediaPlayer mp = new MediaPlayer(); 870 final AudioAttributes aa = audioAttributes != null ? audioAttributes : 871 new AudioAttributes.Builder().build(); 872 mp.setAudioAttributes(aa); 873 mp.setAudioSessionId(audioSessionId); 874 mp.setDataSource(context, uri); 875 if (holder != null) { 876 mp.setDisplay(holder); 877 } 878 mp.prepare(); 879 return mp; 880 } catch (IOException ex) { 881 Log.d(TAG, "create failed:", ex); 882 // fall through 883 } catch (IllegalArgumentException ex) { 884 Log.d(TAG, "create failed:", ex); 885 // fall through 886 } catch (SecurityException ex) { 887 Log.d(TAG, "create failed:", ex); 888 // fall through 889 } 890 891 return null; 892 } 893 894 // Note no convenience method to create a MediaPlayer with SurfaceTexture sink. 895 896 /** 897 * Convenience method to create a MediaPlayer for a given resource id. 898 * On success, {@link #prepare()} will already have been called and must not be called again. 899 * <p>When done with the MediaPlayer, you should call {@link #release()}, 900 * to free the resources. If not released, too many MediaPlayer instances will 901 * result in an exception.</p> 902 * <p>Note that since {@link #prepare()} is called automatically in this method, 903 * you cannot change the audio stream type (see {@link #setAudioStreamType(int)}), audio 904 * session ID (see {@link #setAudioSessionId(int)}) or audio attributes 905 * (see {@link #setAudioAttributes(AudioAttributes)} of the new MediaPlayer.</p> 906 * 907 * @param context the Context to use 908 * @param resid the raw resource id (<var>R.raw.<something></var>) for 909 * the resource to use as the datasource 910 * @return a MediaPlayer object, or null if creation failed 911 */ 912 public static MediaPlayer create(Context context, int resid) { 913 int s = AudioSystem.newAudioSessionId(); 914 return create(context, resid, null, s > 0 ? s : 0); 915 } 916 917 /** 918 * Same factory method as {@link #create(Context, int)} but that lets you specify the audio 919 * attributes and session ID to be used by the new MediaPlayer instance. 920 * @param context the Context to use 921 * @param resid the raw resource id (<var>R.raw.<something></var>) for 922 * the resource to use as the datasource 923 * @param audioAttributes the {@link AudioAttributes} to be used by the media player. 924 * @param audioSessionId the audio session ID to be used by the media player, 925 * see {@link AudioManager#generateAudioSessionId()} to obtain a new session. 926 * @return a MediaPlayer object, or null if creation failed 927 */ 928 public static MediaPlayer create(Context context, int resid, 929 AudioAttributes audioAttributes, int audioSessionId) { 930 try { 931 AssetFileDescriptor afd = context.getResources().openRawResourceFd(resid); 932 if (afd == null) return null; 933 934 MediaPlayer mp = new MediaPlayer(); 935 936 final AudioAttributes aa = audioAttributes != null ? audioAttributes : 937 new AudioAttributes.Builder().build(); 938 mp.setAudioAttributes(aa); 939 mp.setAudioSessionId(audioSessionId); 940 941 mp.setDataSource(afd.getFileDescriptor(), afd.getStartOffset(), afd.getLength()); 942 afd.close(); 943 mp.prepare(); 944 return mp; 945 } catch (IOException ex) { 946 Log.d(TAG, "create failed:", ex); 947 // fall through 948 } catch (IllegalArgumentException ex) { 949 Log.d(TAG, "create failed:", ex); 950 // fall through 951 } catch (SecurityException ex) { 952 Log.d(TAG, "create failed:", ex); 953 // fall through 954 } 955 return null; 956 } 957 958 /** 959 * Sets the data source as a content Uri. 960 * 961 * @param context the Context to use when resolving the Uri 962 * @param uri the Content URI of the data you want to play 963 * @throws IllegalStateException if it is called in an invalid state 964 */ 965 public void setDataSource(@NonNull Context context, @NonNull Uri uri) 966 throws IOException, IllegalArgumentException, SecurityException, IllegalStateException { 967 setDataSource(context, uri, null); 968 } 969 970 /** 971 * Sets the data source as a content Uri. 972 * 973 * @param context the Context to use when resolving the Uri 974 * @param uri the Content URI of the data you want to play 975 * @param headers the headers to be sent together with the request for the data 976 * Note that the cross domain redirection is allowed by default, but that can be 977 * changed with key/value pairs through the headers parameter with 978 * "android-allow-cross-domain-redirect" as the key and "0" or "1" as the value 979 * to disallow or allow cross domain redirection. 980 * @throws IllegalStateException if it is called in an invalid state 981 */ 982 public void setDataSource(@NonNull Context context, @NonNull Uri uri, 983 @Nullable Map<String, String> headers) throws IOException, IllegalArgumentException, 984 SecurityException, IllegalStateException { 985 final ContentResolver resolver = context.getContentResolver(); 986 final String scheme = uri.getScheme(); 987 if (ContentResolver.SCHEME_FILE.equals(scheme)) { 988 setDataSource(uri.getPath()); 989 return; 990 } else if (ContentResolver.SCHEME_CONTENT.equals(scheme) 991 && Settings.AUTHORITY.equals(uri.getAuthority())) { 992 // Try cached ringtone first since the actual provider may not be 993 // encryption aware, or it may be stored on CE media storage 994 final int type = RingtoneManager.getDefaultType(uri); 995 final Uri cacheUri = RingtoneManager.getCacheForType(type); 996 final Uri actualUri = RingtoneManager.getActualDefaultRingtoneUri(context, type); 997 if (attemptDataSource(resolver, cacheUri)) { 998 return; 999 } else if (attemptDataSource(resolver, actualUri)) { 1000 return; 1001 } else { 1002 setDataSource(uri.toString(), headers); 1003 } 1004 } else { 1005 // Try requested Uri locally first, or fallback to media server 1006 if (attemptDataSource(resolver, uri)) { 1007 return; 1008 } else { 1009 setDataSource(uri.toString(), headers); 1010 } 1011 } 1012 } 1013 1014 private boolean attemptDataSource(ContentResolver resolver, Uri uri) { 1015 try (AssetFileDescriptor afd = resolver.openAssetFileDescriptor(uri, "r")) { 1016 setDataSource(afd); 1017 return true; 1018 } catch (NullPointerException | SecurityException | IOException ex) { 1019 Log.w(TAG, "Couldn't open " + uri + ": " + ex); 1020 return false; 1021 } 1022 } 1023 1024 /** 1025 * Sets the data source (file-path or http/rtsp URL) to use. 1026 * 1027 * @param path the path of the file, or the http/rtsp URL of the stream you want to play 1028 * @throws IllegalStateException if it is called in an invalid state 1029 * 1030 * <p>When <code>path</code> refers to a local file, the file may actually be opened by a 1031 * process other than the calling application. This implies that the pathname 1032 * should be an absolute path (as any other process runs with unspecified current working 1033 * directory), and that the pathname should reference a world-readable file. 1034 * As an alternative, the application could first open the file for reading, 1035 * and then use the file descriptor form {@link #setDataSource(FileDescriptor)}. 1036 */ 1037 public void setDataSource(String path) 1038 throws IOException, IllegalArgumentException, SecurityException, IllegalStateException { 1039 setDataSource(path, null, null); 1040 } 1041 1042 /** 1043 * Sets the data source (file-path or http/rtsp URL) to use. 1044 * 1045 * @param path the path of the file, or the http/rtsp URL of the stream you want to play 1046 * @param headers the headers associated with the http request for the stream you want to play 1047 * @throws IllegalStateException if it is called in an invalid state 1048 * @hide pending API council 1049 */ 1050 public void setDataSource(String path, Map<String, String> headers) 1051 throws IOException, IllegalArgumentException, SecurityException, IllegalStateException 1052 { 1053 String[] keys = null; 1054 String[] values = null; 1055 1056 if (headers != null) { 1057 keys = new String[headers.size()]; 1058 values = new String[headers.size()]; 1059 1060 int i = 0; 1061 for (Map.Entry<String, String> entry: headers.entrySet()) { 1062 keys[i] = entry.getKey(); 1063 values[i] = entry.getValue(); 1064 ++i; 1065 } 1066 } 1067 setDataSource(path, keys, values); 1068 } 1069 1070 private void setDataSource(String path, String[] keys, String[] values) 1071 throws IOException, IllegalArgumentException, SecurityException, IllegalStateException { 1072 final Uri uri = Uri.parse(path); 1073 final String scheme = uri.getScheme(); 1074 if ("file".equals(scheme)) { 1075 path = uri.getPath(); 1076 } else if (scheme != null) { 1077 // handle non-file sources 1078 nativeSetDataSource( 1079 MediaHTTPService.createHttpServiceBinderIfNecessary(path), 1080 path, 1081 keys, 1082 values); 1083 return; 1084 } 1085 1086 final File file = new File(path); 1087 if (file.exists()) { 1088 FileInputStream is = new FileInputStream(file); 1089 FileDescriptor fd = is.getFD(); 1090 setDataSource(fd); 1091 is.close(); 1092 } else { 1093 throw new IOException("setDataSource failed."); 1094 } 1095 } 1096 1097 private native void nativeSetDataSource( 1098 IBinder httpServiceBinder, String path, String[] keys, String[] values) 1099 throws IOException, IllegalArgumentException, SecurityException, IllegalStateException; 1100 1101 /** 1102 * Sets the data source (AssetFileDescriptor) to use. It is the caller's 1103 * responsibility to close the file descriptor. It is safe to do so as soon 1104 * as this call returns. 1105 * 1106 * @param afd the AssetFileDescriptor for the file you want to play 1107 * @throws IllegalStateException if it is called in an invalid state 1108 * @throws IllegalArgumentException if afd is not a valid AssetFileDescriptor 1109 * @throws IOException if afd can not be read 1110 */ 1111 public void setDataSource(@NonNull AssetFileDescriptor afd) 1112 throws IOException, IllegalArgumentException, IllegalStateException { 1113 Preconditions.checkNotNull(afd); 1114 // Note: using getDeclaredLength so that our behavior is the same 1115 // as previous versions when the content provider is returning 1116 // a full file. 1117 if (afd.getDeclaredLength() < 0) { 1118 setDataSource(afd.getFileDescriptor()); 1119 } else { 1120 setDataSource(afd.getFileDescriptor(), afd.getStartOffset(), afd.getDeclaredLength()); 1121 } 1122 } 1123 1124 /** 1125 * Sets the data source (FileDescriptor) to use. It is the caller's responsibility 1126 * to close the file descriptor. It is safe to do so as soon as this call returns. 1127 * 1128 * @param fd the FileDescriptor for the file you want to play 1129 * @throws IllegalStateException if it is called in an invalid state 1130 * @throws IllegalArgumentException if fd is not a valid FileDescriptor 1131 * @throws IOException if fd can not be read 1132 */ 1133 public void setDataSource(FileDescriptor fd) 1134 throws IOException, IllegalArgumentException, IllegalStateException { 1135 // intentionally less than LONG_MAX 1136 setDataSource(fd, 0, 0x7ffffffffffffffL); 1137 } 1138 1139 /** 1140 * Sets the data source (FileDescriptor) to use. The FileDescriptor must be 1141 * seekable (N.B. a LocalSocket is not seekable). It is the caller's responsibility 1142 * to close the file descriptor. It is safe to do so as soon as this call returns. 1143 * 1144 * @param fd the FileDescriptor for the file you want to play 1145 * @param offset the offset into the file where the data to be played starts, in bytes 1146 * @param length the length in bytes of the data to be played 1147 * @throws IllegalStateException if it is called in an invalid state 1148 * @throws IllegalArgumentException if fd is not a valid FileDescriptor 1149 * @throws IOException if fd can not be read 1150 */ 1151 public void setDataSource(FileDescriptor fd, long offset, long length) 1152 throws IOException, IllegalArgumentException, IllegalStateException { 1153 _setDataSource(fd, offset, length); 1154 } 1155 1156 private native void _setDataSource(FileDescriptor fd, long offset, long length) 1157 throws IOException, IllegalArgumentException, IllegalStateException; 1158 1159 /** 1160 * Sets the data source (MediaDataSource) to use. 1161 * 1162 * @param dataSource the MediaDataSource for the media you want to play 1163 * @throws IllegalStateException if it is called in an invalid state 1164 * @throws IllegalArgumentException if dataSource is not a valid MediaDataSource 1165 */ 1166 public void setDataSource(MediaDataSource dataSource) 1167 throws IllegalArgumentException, IllegalStateException { 1168 _setDataSource(dataSource); 1169 } 1170 1171 private native void _setDataSource(MediaDataSource dataSource) 1172 throws IllegalArgumentException, IllegalStateException; 1173 1174 /** 1175 * Prepares the player for playback, synchronously. 1176 * 1177 * After setting the datasource and the display surface, you need to either 1178 * call prepare() or prepareAsync(). For files, it is OK to call prepare(), 1179 * which blocks until MediaPlayer is ready for playback. 1180 * 1181 * @throws IllegalStateException if it is called in an invalid state 1182 */ 1183 public void prepare() throws IOException, IllegalStateException { 1184 _prepare(); 1185 scanInternalSubtitleTracks(); 1186 } 1187 1188 private native void _prepare() throws IOException, IllegalStateException; 1189 1190 /** 1191 * Prepares the player for playback, asynchronously. 1192 * 1193 * After setting the datasource and the display surface, you need to either 1194 * call prepare() or prepareAsync(). For streams, you should call prepareAsync(), 1195 * which returns immediately, rather than blocking until enough data has been 1196 * buffered. 1197 * 1198 * @throws IllegalStateException if it is called in an invalid state 1199 */ 1200 public native void prepareAsync() throws IllegalStateException; 1201 1202 /** 1203 * Starts or resumes playback. If playback had previously been paused, 1204 * playback will continue from where it was paused. If playback had 1205 * been stopped, or never started before, playback will start at the 1206 * beginning. 1207 * 1208 * @throws IllegalStateException if it is called in an invalid state 1209 */ 1210 public void start() throws IllegalStateException { 1211 baseStart(); 1212 stayAwake(true); 1213 _start(); 1214 } 1215 1216 private native void _start() throws IllegalStateException; 1217 1218 1219 private int getAudioStreamType() { 1220 if (mStreamType == AudioManager.USE_DEFAULT_STREAM_TYPE) { 1221 mStreamType = _getAudioStreamType(); 1222 } 1223 return mStreamType; 1224 } 1225 1226 private native int _getAudioStreamType() throws IllegalStateException; 1227 1228 /** 1229 * Stops playback after playback has been stopped or paused. 1230 * 1231 * @throws IllegalStateException if the internal player engine has not been 1232 * initialized. 1233 */ 1234 public void stop() throws IllegalStateException { 1235 stayAwake(false); 1236 _stop(); 1237 } 1238 1239 private native void _stop() throws IllegalStateException; 1240 1241 /** 1242 * Pauses playback. Call start() to resume. 1243 * 1244 * @throws IllegalStateException if the internal player engine has not been 1245 * initialized. 1246 */ 1247 public void pause() throws IllegalStateException { 1248 stayAwake(false); 1249 _pause(); 1250 } 1251 1252 private native void _pause() throws IllegalStateException; 1253 1254 /** 1255 * Set the low-level power management behavior for this MediaPlayer. This 1256 * can be used when the MediaPlayer is not playing through a SurfaceHolder 1257 * set with {@link #setDisplay(SurfaceHolder)} and thus can use the 1258 * high-level {@link #setScreenOnWhilePlaying(boolean)} feature. 1259 * 1260 * <p>This function has the MediaPlayer access the low-level power manager 1261 * service to control the device's power usage while playing is occurring. 1262 * The parameter is a combination of {@link android.os.PowerManager} wake flags. 1263 * Use of this method requires {@link android.Manifest.permission#WAKE_LOCK} 1264 * permission. 1265 * By default, no attempt is made to keep the device awake during playback. 1266 * 1267 * @param context the Context to use 1268 * @param mode the power/wake mode to set 1269 * @see android.os.PowerManager 1270 */ 1271 public void setWakeMode(Context context, int mode) { 1272 boolean washeld = false; 1273 1274 /* Disable persistant wakelocks in media player based on property */ 1275 if (SystemProperties.getBoolean("audio.offload.ignore_setawake", false) == true) { 1276 Log.w(TAG, "IGNORING setWakeMode " + mode); 1277 return; 1278 } 1279 1280 if (mWakeLock != null) { 1281 if (mWakeLock.isHeld()) { 1282 washeld = true; 1283 mWakeLock.release(); 1284 } 1285 mWakeLock = null; 1286 } 1287 1288 PowerManager pm = (PowerManager)context.getSystemService(Context.POWER_SERVICE); 1289 mWakeLock = pm.newWakeLock(mode|PowerManager.ON_AFTER_RELEASE, MediaPlayer.class.getName()); 1290 mWakeLock.setReferenceCounted(false); 1291 if (washeld) { 1292 mWakeLock.acquire(); 1293 } 1294 } 1295 1296 /** 1297 * Control whether we should use the attached SurfaceHolder to keep the 1298 * screen on while video playback is occurring. This is the preferred 1299 * method over {@link #setWakeMode} where possible, since it doesn't 1300 * require that the application have permission for low-level wake lock 1301 * access. 1302 * 1303 * @param screenOn Supply true to keep the screen on, false to allow it 1304 * to turn off. 1305 */ 1306 public void setScreenOnWhilePlaying(boolean screenOn) { 1307 if (mScreenOnWhilePlaying != screenOn) { 1308 if (screenOn && mSurfaceHolder == null) { 1309 Log.w(TAG, "setScreenOnWhilePlaying(true) is ineffective without a SurfaceHolder"); 1310 } 1311 mScreenOnWhilePlaying = screenOn; 1312 updateSurfaceScreenOn(); 1313 } 1314 } 1315 1316 private void stayAwake(boolean awake) { 1317 if (mWakeLock != null) { 1318 if (awake && !mWakeLock.isHeld()) { 1319 mWakeLock.acquire(); 1320 } else if (!awake && mWakeLock.isHeld()) { 1321 mWakeLock.release(); 1322 } 1323 } 1324 mStayAwake = awake; 1325 updateSurfaceScreenOn(); 1326 } 1327 1328 private void updateSurfaceScreenOn() { 1329 if (mSurfaceHolder != null) { 1330 mSurfaceHolder.setKeepScreenOn(mScreenOnWhilePlaying && mStayAwake); 1331 } 1332 } 1333 1334 /** 1335 * Returns the width of the video. 1336 * 1337 * @return the width of the video, or 0 if there is no video, 1338 * no display surface was set, or the width has not been determined 1339 * yet. The OnVideoSizeChangedListener can be registered via 1340 * {@link #setOnVideoSizeChangedListener(OnVideoSizeChangedListener)} 1341 * to provide a notification when the width is available. 1342 */ 1343 public native int getVideoWidth(); 1344 1345 /** 1346 * Returns the height of the video. 1347 * 1348 * @return the height of the video, or 0 if there is no video, 1349 * no display surface was set, or the height has not been determined 1350 * yet. The OnVideoSizeChangedListener can be registered via 1351 * {@link #setOnVideoSizeChangedListener(OnVideoSizeChangedListener)} 1352 * to provide a notification when the height is available. 1353 */ 1354 public native int getVideoHeight(); 1355 1356 /** 1357 * Checks whether the MediaPlayer is playing. 1358 * 1359 * @return true if currently playing, false otherwise 1360 * @throws IllegalStateException if the internal player engine has not been 1361 * initialized or has been released. 1362 */ 1363 public native boolean isPlaying(); 1364 1365 /** 1366 * Change playback speed of audio by resampling the audio. 1367 * <p> 1368 * Specifies resampling as audio mode for variable rate playback, i.e., 1369 * resample the waveform based on the requested playback rate to get 1370 * a new waveform, and play back the new waveform at the original sampling 1371 * frequency. 1372 * When rate is larger than 1.0, pitch becomes higher. 1373 * When rate is smaller than 1.0, pitch becomes lower. 1374 * 1375 * @hide 1376 */ 1377 public static final int PLAYBACK_RATE_AUDIO_MODE_RESAMPLE = 2; 1378 1379 /** 1380 * Change playback speed of audio without changing its pitch. 1381 * <p> 1382 * Specifies time stretching as audio mode for variable rate playback. 1383 * Time stretching changes the duration of the audio samples without 1384 * affecting its pitch. 1385 * <p> 1386 * This mode is only supported for a limited range of playback speed factors, 1387 * e.g. between 1/2x and 2x. 1388 * 1389 * @hide 1390 */ 1391 public static final int PLAYBACK_RATE_AUDIO_MODE_STRETCH = 1; 1392 1393 /** 1394 * Change playback speed of audio without changing its pitch, and 1395 * possibly mute audio if time stretching is not supported for the playback 1396 * speed. 1397 * <p> 1398 * Try to keep audio pitch when changing the playback rate, but allow the 1399 * system to determine how to change audio playback if the rate is out 1400 * of range. 1401 * 1402 * @hide 1403 */ 1404 public static final int PLAYBACK_RATE_AUDIO_MODE_DEFAULT = 0; 1405 1406 /** @hide */ 1407 @IntDef( 1408 value = { 1409 PLAYBACK_RATE_AUDIO_MODE_DEFAULT, 1410 PLAYBACK_RATE_AUDIO_MODE_STRETCH, 1411 PLAYBACK_RATE_AUDIO_MODE_RESAMPLE, 1412 }) 1413 @Retention(RetentionPolicy.SOURCE) 1414 public @interface PlaybackRateAudioMode {} 1415 1416 /** 1417 * Sets playback rate and audio mode. 1418 * 1419 * @param rate the ratio between desired playback rate and normal one. 1420 * @param audioMode audio playback mode. Must be one of the supported 1421 * audio modes. 1422 * 1423 * @throws IllegalStateException if the internal player engine has not been 1424 * initialized. 1425 * @throws IllegalArgumentException if audioMode is not supported. 1426 * 1427 * @hide 1428 */ 1429 @NonNull 1430 public PlaybackParams easyPlaybackParams(float rate, @PlaybackRateAudioMode int audioMode) { 1431 PlaybackParams params = new PlaybackParams(); 1432 params.allowDefaults(); 1433 switch (audioMode) { 1434 case PLAYBACK_RATE_AUDIO_MODE_DEFAULT: 1435 params.setSpeed(rate).setPitch(1.0f); 1436 break; 1437 case PLAYBACK_RATE_AUDIO_MODE_STRETCH: 1438 params.setSpeed(rate).setPitch(1.0f) 1439 .setAudioFallbackMode(params.AUDIO_FALLBACK_MODE_FAIL); 1440 break; 1441 case PLAYBACK_RATE_AUDIO_MODE_RESAMPLE: 1442 params.setSpeed(rate).setPitch(rate); 1443 break; 1444 default: 1445 final String msg = "Audio playback mode " + audioMode + " is not supported"; 1446 throw new IllegalArgumentException(msg); 1447 } 1448 return params; 1449 } 1450 1451 /** 1452 * Sets playback rate using {@link PlaybackParams}. 1453 * 1454 * @param params the playback params. 1455 * 1456 * @throws IllegalStateException if the internal player engine has not been 1457 * initialized. 1458 * @throws IllegalArgumentException if params is not supported. 1459 */ 1460 public native void setPlaybackParams(@NonNull PlaybackParams params); 1461 1462 /** 1463 * Gets the playback params, containing the current playback rate. 1464 * 1465 * @return the playback params. 1466 * @throws IllegalStateException if the internal player engine has not been 1467 * initialized. 1468 */ 1469 @NonNull 1470 public native PlaybackParams getPlaybackParams(); 1471 1472 /** 1473 * Sets A/V sync mode. 1474 * 1475 * @param params the A/V sync params to apply 1476 * 1477 * @throws IllegalStateException if the internal player engine has not been 1478 * initialized. 1479 * @throws IllegalArgumentException if params are not supported. 1480 */ 1481 public native void setSyncParams(@NonNull SyncParams params); 1482 1483 /** 1484 * Gets the A/V sync mode. 1485 * 1486 * @return the A/V sync params 1487 * 1488 * @throws IllegalStateException if the internal player engine has not been 1489 * initialized. 1490 */ 1491 @NonNull 1492 public native SyncParams getSyncParams(); 1493 1494 /** 1495 * Seeks to specified time position. 1496 * 1497 * @param msec the offset in milliseconds from the start to seek to 1498 * @throws IllegalStateException if the internal player engine has not been 1499 * initialized 1500 */ 1501 public native void seekTo(int msec) throws IllegalStateException; 1502 1503 /** 1504 * Get current playback position as a {@link MediaTimestamp}. 1505 * <p> 1506 * The MediaTimestamp represents how the media time correlates to the system time in 1507 * a linear fashion using an anchor and a clock rate. During regular playback, the media 1508 * time moves fairly constantly (though the anchor frame may be rebased to a current 1509 * system time, the linear correlation stays steady). Therefore, this method does not 1510 * need to be called often. 1511 * <p> 1512 * To help users get current playback position, this method always anchors the timestamp 1513 * to the current {@link System#nanoTime system time}, so 1514 * {@link MediaTimestamp#getAnchorMediaTimeUs} can be used as current playback position. 1515 * 1516 * @return a MediaTimestamp object if a timestamp is available, or {@code null} if no timestamp 1517 * is available, e.g. because the media player has not been initialized. 1518 * 1519 * @see MediaTimestamp 1520 */ 1521 @Nullable 1522 public MediaTimestamp getTimestamp() 1523 { 1524 try { 1525 // TODO: get the timestamp from native side 1526 return new MediaTimestamp( 1527 getCurrentPosition() * 1000L, 1528 System.nanoTime(), 1529 isPlaying() ? getPlaybackParams().getSpeed() : 0.f); 1530 } catch (IllegalStateException e) { 1531 return null; 1532 } 1533 } 1534 1535 /** 1536 * Gets the current playback position. 1537 * 1538 * @return the current position in milliseconds 1539 */ 1540 public native int getCurrentPosition(); 1541 1542 /** 1543 * Gets the duration of the file. 1544 * 1545 * @return the duration in milliseconds, if no duration is available 1546 * (for example, if streaming live content), -1 is returned. 1547 */ 1548 public native int getDuration(); 1549 1550 /** 1551 * Gets the media metadata. 1552 * 1553 * @param update_only controls whether the full set of available 1554 * metadata is returned or just the set that changed since the 1555 * last call. See {@see #METADATA_UPDATE_ONLY} and {@see 1556 * #METADATA_ALL}. 1557 * 1558 * @param apply_filter if true only metadata that matches the 1559 * filter is returned. See {@see #APPLY_METADATA_FILTER} and {@see 1560 * #BYPASS_METADATA_FILTER}. 1561 * 1562 * @return The metadata, possibly empty. null if an error occured. 1563 // FIXME: unhide. 1564 * {@hide} 1565 */ 1566 public Metadata getMetadata(final boolean update_only, 1567 final boolean apply_filter) { 1568 Parcel reply = Parcel.obtain(); 1569 Metadata data = new Metadata(); 1570 1571 if (!native_getMetadata(update_only, apply_filter, reply)) { 1572 reply.recycle(); 1573 return null; 1574 } 1575 1576 // Metadata takes over the parcel, don't recycle it unless 1577 // there is an error. 1578 if (!data.parse(reply)) { 1579 reply.recycle(); 1580 return null; 1581 } 1582 return data; 1583 } 1584 1585 /** 1586 * Set a filter for the metadata update notification and update 1587 * retrieval. The caller provides 2 set of metadata keys, allowed 1588 * and blocked. The blocked set always takes precedence over the 1589 * allowed one. 1590 * Metadata.MATCH_ALL and Metadata.MATCH_NONE are 2 sets available as 1591 * shorthands to allow/block all or no metadata. 1592 * 1593 * By default, there is no filter set. 1594 * 1595 * @param allow Is the set of metadata the client is interested 1596 * in receiving new notifications for. 1597 * @param block Is the set of metadata the client is not interested 1598 * in receiving new notifications for. 1599 * @return The call status code. 1600 * 1601 // FIXME: unhide. 1602 * {@hide} 1603 */ 1604 public int setMetadataFilter(Set<Integer> allow, Set<Integer> block) { 1605 // Do our serialization manually instead of calling 1606 // Parcel.writeArray since the sets are made of the same type 1607 // we avoid paying the price of calling writeValue (used by 1608 // writeArray) which burns an extra int per element to encode 1609 // the type. 1610 Parcel request = newRequest(); 1611 1612 // The parcel starts already with an interface token. There 1613 // are 2 filters. Each one starts with a 4bytes number to 1614 // store the len followed by a number of int (4 bytes as well) 1615 // representing the metadata type. 1616 int capacity = request.dataSize() + 4 * (1 + allow.size() + 1 + block.size()); 1617 1618 if (request.dataCapacity() < capacity) { 1619 request.setDataCapacity(capacity); 1620 } 1621 1622 request.writeInt(allow.size()); 1623 for(Integer t: allow) { 1624 request.writeInt(t); 1625 } 1626 request.writeInt(block.size()); 1627 for(Integer t: block) { 1628 request.writeInt(t); 1629 } 1630 return native_setMetadataFilter(request); 1631 } 1632 1633 /** 1634 * Set the MediaPlayer to start when this MediaPlayer finishes playback 1635 * (i.e. reaches the end of the stream). 1636 * The media framework will attempt to transition from this player to 1637 * the next as seamlessly as possible. The next player can be set at 1638 * any time before completion. The next player must be prepared by the 1639 * app, and the application should not call start() on it. 1640 * The next MediaPlayer must be different from 'this'. An exception 1641 * will be thrown if next == this. 1642 * The application may call setNextMediaPlayer(null) to indicate no 1643 * next player should be started at the end of playback. 1644 * If the current player is looping, it will keep looping and the next 1645 * player will not be started. 1646 * 1647 * @param next the player to start after this one completes playback. 1648 * 1649 */ 1650 public native void setNextMediaPlayer(MediaPlayer next); 1651 1652 /** 1653 * Releases resources associated with this MediaPlayer object. 1654 * It is considered good practice to call this method when you're 1655 * done using the MediaPlayer. In particular, whenever an Activity 1656 * of an application is paused (its onPause() method is called), 1657 * or stopped (its onStop() method is called), this method should be 1658 * invoked to release the MediaPlayer object, unless the application 1659 * has a special need to keep the object around. In addition to 1660 * unnecessary resources (such as memory and instances of codecs) 1661 * being held, failure to call this method immediately if a 1662 * MediaPlayer object is no longer needed may also lead to 1663 * continuous battery consumption for mobile devices, and playback 1664 * failure for other applications if no multiple instances of the 1665 * same codec are supported on a device. Even if multiple instances 1666 * of the same codec are supported, some performance degradation 1667 * may be expected when unnecessary multiple instances are used 1668 * at the same time. 1669 */ 1670 public void release() { 1671 baseRelease(); 1672 stayAwake(false); 1673 updateSurfaceScreenOn(); 1674 mOnPreparedListener = null; 1675 mOnBufferingUpdateListener = null; 1676 mOnCompletionListener = null; 1677 mOnSeekCompleteListener = null; 1678 mOnErrorListener = null; 1679 mOnInfoListener = null; 1680 mOnVideoSizeChangedListener = null; 1681 mOnTimedTextListener = null; 1682 if (mTimeProvider != null) { 1683 mTimeProvider.close(); 1684 mTimeProvider = null; 1685 } 1686 mOnSubtitleDataListener = null; 1687 _release(); 1688 } 1689 1690 private native void _release(); 1691 1692 /** 1693 * Resets the MediaPlayer to its uninitialized state. After calling 1694 * this method, you will have to initialize it again by setting the 1695 * data source and calling prepare(). 1696 */ 1697 public void reset() { 1698 mSelectedSubtitleTrackIndex = -1; 1699 synchronized(mOpenSubtitleSources) { 1700 for (final InputStream is: mOpenSubtitleSources) { 1701 try { 1702 is.close(); 1703 } catch (IOException e) { 1704 } 1705 } 1706 mOpenSubtitleSources.clear(); 1707 } 1708 if (mSubtitleController != null) { 1709 mSubtitleController.reset(); 1710 } 1711 if (mTimeProvider != null) { 1712 mTimeProvider.close(); 1713 mTimeProvider = null; 1714 } 1715 1716 stayAwake(false); 1717 _reset(); 1718 // make sure none of the listeners get called anymore 1719 if (mEventHandler != null) { 1720 mEventHandler.removeCallbacksAndMessages(null); 1721 } 1722 1723 synchronized (mIndexTrackPairs) { 1724 mIndexTrackPairs.clear(); 1725 mInbandTrackIndices.clear(); 1726 }; 1727 } 1728 1729 private native void _reset(); 1730 1731 /** 1732 * Sets the audio stream type for this MediaPlayer. See {@link AudioManager} 1733 * for a list of stream types. Must call this method before prepare() or 1734 * prepareAsync() in order for the target stream type to become effective 1735 * thereafter. 1736 * 1737 * @param streamtype the audio stream type 1738 * @see android.media.AudioManager 1739 */ 1740 public void setAudioStreamType(int streamtype) { 1741 baseUpdateAudioAttributes( 1742 new AudioAttributes.Builder().setInternalLegacyStreamType(streamtype).build()); 1743 _setAudioStreamType(streamtype); 1744 mStreamType = streamtype; 1745 } 1746 1747 private native void _setAudioStreamType(int streamtype); 1748 1749 // Keep KEY_PARAMETER_* in sync with include/media/mediaplayer.h 1750 private final static int KEY_PARAMETER_AUDIO_ATTRIBUTES = 1400; 1751 /** 1752 * Sets the parameter indicated by key. 1753 * @param key key indicates the parameter to be set. 1754 * @param value value of the parameter to be set. 1755 * @return true if the parameter is set successfully, false otherwise 1756 * {@hide} 1757 */ 1758 private native boolean setParameter(int key, Parcel value); 1759 1760 /** 1761 * Sets the audio attributes for this MediaPlayer. 1762 * See {@link AudioAttributes} for how to build and configure an instance of this class. 1763 * You must call this method before {@link #prepare()} or {@link #prepareAsync()} in order 1764 * for the audio attributes to become effective thereafter. 1765 * @param attributes a non-null set of audio attributes 1766 */ 1767 public void setAudioAttributes(AudioAttributes attributes) throws IllegalArgumentException { 1768 if (attributes == null) { 1769 final String msg = "Cannot set AudioAttributes to null"; 1770 throw new IllegalArgumentException(msg); 1771 } 1772 baseUpdateAudioAttributes(attributes); 1773 mUsage = attributes.getUsage(); 1774 mBypassInterruptionPolicy = (attributes.getAllFlags() 1775 & AudioAttributes.FLAG_BYPASS_INTERRUPTION_POLICY) != 0; 1776 Parcel pattributes = Parcel.obtain(); 1777 attributes.writeToParcel(pattributes, AudioAttributes.FLATTEN_TAGS); 1778 setParameter(KEY_PARAMETER_AUDIO_ATTRIBUTES, pattributes); 1779 pattributes.recycle(); 1780 } 1781 1782 /** 1783 * Sets the player to be looping or non-looping. 1784 * 1785 * @param looping whether to loop or not 1786 */ 1787 public native void setLooping(boolean looping); 1788 1789 /** 1790 * Checks whether the MediaPlayer is looping or non-looping. 1791 * 1792 * @return true if the MediaPlayer is currently looping, false otherwise 1793 */ 1794 public native boolean isLooping(); 1795 1796 /** 1797 * Sets the volume on this player. 1798 * This API is recommended for balancing the output of audio streams 1799 * within an application. Unless you are writing an application to 1800 * control user settings, this API should be used in preference to 1801 * {@link AudioManager#setStreamVolume(int, int, int)} which sets the volume of ALL streams of 1802 * a particular type. Note that the passed volume values are raw scalars in range 0.0 to 1.0. 1803 * UI controls should be scaled logarithmically. 1804 * 1805 * @param leftVolume left volume scalar 1806 * @param rightVolume right volume scalar 1807 */ 1808 /* 1809 * FIXME: Merge this into javadoc comment above when setVolume(float) is not @hide. 1810 * The single parameter form below is preferred if the channel volumes don't need 1811 * to be set independently. 1812 */ 1813 public void setVolume(float leftVolume, float rightVolume) { 1814 baseSetVolume(leftVolume, rightVolume); 1815 } 1816 1817 @Override 1818 void playerSetVolume(float leftVolume, float rightVolume) { 1819 _setVolume(leftVolume, rightVolume); 1820 } 1821 1822 private native void _setVolume(float leftVolume, float rightVolume); 1823 1824 /** 1825 * Similar, excepts sets volume of all channels to same value. 1826 * @hide 1827 */ 1828 public void setVolume(float volume) { 1829 setVolume(volume, volume); 1830 } 1831 1832 /** 1833 * Sets the audio session ID. 1834 * 1835 * @param sessionId the audio session ID. 1836 * The audio session ID is a system wide unique identifier for the audio stream played by 1837 * this MediaPlayer instance. 1838 * The primary use of the audio session ID is to associate audio effects to a particular 1839 * instance of MediaPlayer: if an audio session ID is provided when creating an audio effect, 1840 * this effect will be applied only to the audio content of media players within the same 1841 * audio session and not to the output mix. 1842 * When created, a MediaPlayer instance automatically generates its own audio session ID. 1843 * However, it is possible to force this player to be part of an already existing audio session 1844 * by calling this method. 1845 * This method must be called before one of the overloaded <code> setDataSource </code> methods. 1846 * @throws IllegalStateException if it is called in an invalid state 1847 */ 1848 public native void setAudioSessionId(int sessionId) throws IllegalArgumentException, IllegalStateException; 1849 1850 /** 1851 * Returns the audio session ID. 1852 * 1853 * @return the audio session ID. {@see #setAudioSessionId(int)} 1854 * Note that the audio session ID is 0 only if a problem occured when the MediaPlayer was contructed. 1855 */ 1856 public native int getAudioSessionId(); 1857 1858 /** 1859 * Attaches an auxiliary effect to the player. A typical auxiliary effect is a reverberation 1860 * effect which can be applied on any sound source that directs a certain amount of its 1861 * energy to this effect. This amount is defined by setAuxEffectSendLevel(). 1862 * See {@link #setAuxEffectSendLevel(float)}. 1863 * <p>After creating an auxiliary effect (e.g. 1864 * {@link android.media.audiofx.EnvironmentalReverb}), retrieve its ID with 1865 * {@link android.media.audiofx.AudioEffect#getId()} and use it when calling this method 1866 * to attach the player to the effect. 1867 * <p>To detach the effect from the player, call this method with a null effect id. 1868 * <p>This method must be called after one of the overloaded <code> setDataSource </code> 1869 * methods. 1870 * @param effectId system wide unique id of the effect to attach 1871 */ 1872 public native void attachAuxEffect(int effectId); 1873 1874 1875 /** 1876 * Sets the send level of the player to the attached auxiliary effect. 1877 * See {@link #attachAuxEffect(int)}. The level value range is 0 to 1.0. 1878 * <p>By default the send level is 0, so even if an effect is attached to the player 1879 * this method must be called for the effect to be applied. 1880 * <p>Note that the passed level value is a raw scalar. UI controls should be scaled 1881 * logarithmically: the gain applied by audio framework ranges from -72dB to 0dB, 1882 * so an appropriate conversion from linear UI input x to level is: 1883 * x == 0 -> level = 0 1884 * 0 < x <= R -> level = 10^(72*(x-R)/20/R) 1885 * @param level send level scalar 1886 */ 1887 public void setAuxEffectSendLevel(float level) { 1888 baseSetAuxEffectSendLevel(level); 1889 } 1890 1891 @Override 1892 int playerSetAuxEffectSendLevel(float level) { 1893 _setAuxEffectSendLevel(level); 1894 return AudioSystem.SUCCESS; 1895 } 1896 1897 private native void _setAuxEffectSendLevel(float level); 1898 1899 /* 1900 * @param request Parcel destinated to the media player. The 1901 * Interface token must be set to the IMediaPlayer 1902 * one to be routed correctly through the system. 1903 * @param reply[out] Parcel that will contain the reply. 1904 * @return The status code. 1905 */ 1906 private native final int native_invoke(Parcel request, Parcel reply); 1907 1908 1909 /* 1910 * @param update_only If true fetch only the set of metadata that have 1911 * changed since the last invocation of getMetadata. 1912 * The set is built using the unfiltered 1913 * notifications the native player sent to the 1914 * MediaPlayerService during that period of 1915 * time. If false, all the metadatas are considered. 1916 * @param apply_filter If true, once the metadata set has been built based on 1917 * the value update_only, the current filter is applied. 1918 * @param reply[out] On return contains the serialized 1919 * metadata. Valid only if the call was successful. 1920 * @return The status code. 1921 */ 1922 private native final boolean native_getMetadata(boolean update_only, 1923 boolean apply_filter, 1924 Parcel reply); 1925 1926 /* 1927 * @param request Parcel with the 2 serialized lists of allowed 1928 * metadata types followed by the one to be 1929 * dropped. Each list starts with an integer 1930 * indicating the number of metadata type elements. 1931 * @return The status code. 1932 */ 1933 private native final int native_setMetadataFilter(Parcel request); 1934 1935 private static native final void native_init(); 1936 private native final void native_setup(Object mediaplayer_this); 1937 private native final void native_finalize(); 1938 1939 /** 1940 * Class for MediaPlayer to return each audio/video/subtitle track's metadata. 1941 * 1942 * @see android.media.MediaPlayer#getTrackInfo 1943 */ 1944 static public class TrackInfo implements Parcelable { 1945 /** 1946 * Gets the track type. 1947 * @return TrackType which indicates if the track is video, audio, timed text. 1948 */ 1949 public int getTrackType() { 1950 return mTrackType; 1951 } 1952 1953 /** 1954 * Gets the language code of the track. 1955 * @return a language code in either way of ISO-639-1 or ISO-639-2. 1956 * When the language is unknown or could not be determined, 1957 * ISO-639-2 language code, "und", is returned. 1958 */ 1959 public String getLanguage() { 1960 String language = mFormat.getString(MediaFormat.KEY_LANGUAGE); 1961 return language == null ? "und" : language; 1962 } 1963 1964 /** 1965 * Gets the {@link MediaFormat} of the track. If the format is 1966 * unknown or could not be determined, null is returned. 1967 */ 1968 public MediaFormat getFormat() { 1969 if (mTrackType == MEDIA_TRACK_TYPE_TIMEDTEXT 1970 || mTrackType == MEDIA_TRACK_TYPE_SUBTITLE) { 1971 return mFormat; 1972 } 1973 return null; 1974 } 1975 1976 public static final int MEDIA_TRACK_TYPE_UNKNOWN = 0; 1977 public static final int MEDIA_TRACK_TYPE_VIDEO = 1; 1978 public static final int MEDIA_TRACK_TYPE_AUDIO = 2; 1979 public static final int MEDIA_TRACK_TYPE_TIMEDTEXT = 3; 1980 public static final int MEDIA_TRACK_TYPE_SUBTITLE = 4; 1981 public static final int MEDIA_TRACK_TYPE_METADATA = 5; 1982 1983 final int mTrackType; 1984 final MediaFormat mFormat; 1985 1986 TrackInfo(Parcel in) { 1987 mTrackType = in.readInt(); 1988 // TODO: parcel in the full MediaFormat; currently we are using createSubtitleFormat 1989 // even for audio/video tracks, meaning we only set the mime and language. 1990 String mime = in.readString(); 1991 String language = in.readString(); 1992 mFormat = MediaFormat.createSubtitleFormat(mime, language); 1993 1994 if (mTrackType == MEDIA_TRACK_TYPE_SUBTITLE) { 1995 mFormat.setInteger(MediaFormat.KEY_IS_AUTOSELECT, in.readInt()); 1996 mFormat.setInteger(MediaFormat.KEY_IS_DEFAULT, in.readInt()); 1997 mFormat.setInteger(MediaFormat.KEY_IS_FORCED_SUBTITLE, in.readInt()); 1998 } 1999 } 2000 2001 /** @hide */ 2002 TrackInfo(int type, MediaFormat format) { 2003 mTrackType = type; 2004 mFormat = format; 2005 } 2006 2007 /** 2008 * {@inheritDoc} 2009 */ 2010 @Override 2011 public int describeContents() { 2012 return 0; 2013 } 2014 2015 /** 2016 * {@inheritDoc} 2017 */ 2018 @Override 2019 public void writeToParcel(Parcel dest, int flags) { 2020 dest.writeInt(mTrackType); 2021 dest.writeString(getLanguage()); 2022 2023 if (mTrackType == MEDIA_TRACK_TYPE_SUBTITLE) { 2024 dest.writeString(mFormat.getString(MediaFormat.KEY_MIME)); 2025 dest.writeInt(mFormat.getInteger(MediaFormat.KEY_IS_AUTOSELECT)); 2026 dest.writeInt(mFormat.getInteger(MediaFormat.KEY_IS_DEFAULT)); 2027 dest.writeInt(mFormat.getInteger(MediaFormat.KEY_IS_FORCED_SUBTITLE)); 2028 } 2029 } 2030 2031 @Override 2032 public String toString() { 2033 StringBuilder out = new StringBuilder(128); 2034 out.append(getClass().getName()); 2035 out.append('{'); 2036 switch (mTrackType) { 2037 case MEDIA_TRACK_TYPE_VIDEO: 2038 out.append("VIDEO"); 2039 break; 2040 case MEDIA_TRACK_TYPE_AUDIO: 2041 out.append("AUDIO"); 2042 break; 2043 case MEDIA_TRACK_TYPE_TIMEDTEXT: 2044 out.append("TIMEDTEXT"); 2045 break; 2046 case MEDIA_TRACK_TYPE_SUBTITLE: 2047 out.append("SUBTITLE"); 2048 break; 2049 default: 2050 out.append("UNKNOWN"); 2051 break; 2052 } 2053 out.append(", " + mFormat.toString()); 2054 out.append("}"); 2055 return out.toString(); 2056 } 2057 2058 /** 2059 * Used to read a TrackInfo from a Parcel. 2060 */ 2061 static final Parcelable.Creator<TrackInfo> CREATOR 2062 = new Parcelable.Creator<TrackInfo>() { 2063 @Override 2064 public TrackInfo createFromParcel(Parcel in) { 2065 return new TrackInfo(in); 2066 } 2067 2068 @Override 2069 public TrackInfo[] newArray(int size) { 2070 return new TrackInfo[size]; 2071 } 2072 }; 2073 2074 }; 2075 2076 // We would like domain specific classes with more informative names than the `first` and `second` 2077 // in generic Pair, but we would also like to avoid creating new/trivial classes. As a compromise 2078 // we document the meanings of `first` and `second` here: 2079 // 2080 // Pair.first - inband track index; non-null iff representing an inband track. 2081 // Pair.second - a SubtitleTrack registered with mSubtitleController; non-null iff representing 2082 // an inband subtitle track or any out-of-band track (subtitle or timedtext). 2083 private Vector<Pair<Integer, SubtitleTrack>> mIndexTrackPairs = new Vector<>(); 2084 private BitSet mInbandTrackIndices = new BitSet(); 2085 2086 /** 2087 * Returns an array of track information. 2088 * 2089 * @return Array of track info. The total number of tracks is the array length. 2090 * Must be called again if an external timed text source has been added after any of the 2091 * addTimedTextSource methods are called. 2092 * @throws IllegalStateException if it is called in an invalid state. 2093 */ 2094 public TrackInfo[] getTrackInfo() throws IllegalStateException { 2095 TrackInfo trackInfo[] = getInbandTrackInfo(); 2096 // add out-of-band tracks 2097 synchronized (mIndexTrackPairs) { 2098 TrackInfo allTrackInfo[] = new TrackInfo[mIndexTrackPairs.size()]; 2099 for (int i = 0; i < allTrackInfo.length; i++) { 2100 Pair<Integer, SubtitleTrack> p = mIndexTrackPairs.get(i); 2101 if (p.first != null) { 2102 // inband track 2103 allTrackInfo[i] = trackInfo[p.first]; 2104 } else { 2105 SubtitleTrack track = p.second; 2106 allTrackInfo[i] = new TrackInfo(track.getTrackType(), track.getFormat()); 2107 } 2108 } 2109 return allTrackInfo; 2110 } 2111 } 2112 2113 private TrackInfo[] getInbandTrackInfo() throws IllegalStateException { 2114 Parcel request = Parcel.obtain(); 2115 Parcel reply = Parcel.obtain(); 2116 try { 2117 request.writeInterfaceToken(IMEDIA_PLAYER); 2118 request.writeInt(INVOKE_ID_GET_TRACK_INFO); 2119 invoke(request, reply); 2120 TrackInfo trackInfo[] = reply.createTypedArray(TrackInfo.CREATOR); 2121 return trackInfo; 2122 } finally { 2123 request.recycle(); 2124 reply.recycle(); 2125 } 2126 } 2127 2128 /* Do not change these values without updating their counterparts 2129 * in include/media/stagefright/MediaDefs.h and media/libstagefright/MediaDefs.cpp! 2130 */ 2131 /** 2132 * MIME type for SubRip (SRT) container. Used in addTimedTextSource APIs. 2133 */ 2134 public static final String MEDIA_MIMETYPE_TEXT_SUBRIP = "application/x-subrip"; 2135 2136 /** 2137 * MIME type for WebVTT subtitle data. 2138 * @hide 2139 */ 2140 public static final String MEDIA_MIMETYPE_TEXT_VTT = "text/vtt"; 2141 2142 /** 2143 * MIME type for CEA-608 closed caption data. 2144 * @hide 2145 */ 2146 public static final String MEDIA_MIMETYPE_TEXT_CEA_608 = "text/cea-608"; 2147 2148 /** 2149 * MIME type for CEA-708 closed caption data. 2150 * @hide 2151 */ 2152 public static final String MEDIA_MIMETYPE_TEXT_CEA_708 = "text/cea-708"; 2153 2154 /* 2155 * A helper function to check if the mime type is supported by media framework. 2156 */ 2157 private static boolean availableMimeTypeForExternalSource(String mimeType) { 2158 if (MEDIA_MIMETYPE_TEXT_SUBRIP.equals(mimeType)) { 2159 return true; 2160 } 2161 return false; 2162 } 2163 2164 private SubtitleController mSubtitleController; 2165 2166 /** @hide */ 2167 public void setSubtitleAnchor( 2168 SubtitleController controller, 2169 SubtitleController.Anchor anchor) { 2170 // TODO: create SubtitleController in MediaPlayer 2171 mSubtitleController = controller; 2172 mSubtitleController.setAnchor(anchor); 2173 } 2174 2175 /** 2176 * The private version of setSubtitleAnchor is used internally to set mSubtitleController if 2177 * necessary when clients don't provide their own SubtitleControllers using the public version 2178 * {@link #setSubtitleAnchor(SubtitleController, Anchor)} (e.g. {@link VideoView} provides one). 2179 */ 2180 private synchronized void setSubtitleAnchor() { 2181 if (mSubtitleController == null) { 2182 final HandlerThread thread = new HandlerThread("SetSubtitleAnchorThread"); 2183 thread.start(); 2184 Handler handler = new Handler(thread.getLooper()); 2185 handler.post(new Runnable() { 2186 @Override 2187 public void run() { 2188 Context context = ActivityThread.currentApplication(); 2189 mSubtitleController = new SubtitleController(context, mTimeProvider, MediaPlayer.this); 2190 mSubtitleController.setAnchor(new Anchor() { 2191 @Override 2192 public void setSubtitleWidget(RenderingWidget subtitleWidget) { 2193 } 2194 2195 @Override 2196 public Looper getSubtitleLooper() { 2197 return Looper.getMainLooper(); 2198 } 2199 }); 2200 thread.getLooper().quitSafely(); 2201 } 2202 }); 2203 try { 2204 thread.join(); 2205 } catch (InterruptedException e) { 2206 Thread.currentThread().interrupt(); 2207 Log.w(TAG, "failed to join SetSubtitleAnchorThread"); 2208 } 2209 } 2210 } 2211 2212 private int mSelectedSubtitleTrackIndex = -1; 2213 private Vector<InputStream> mOpenSubtitleSources; 2214 2215 private OnSubtitleDataListener mSubtitleDataListener = new OnSubtitleDataListener() { 2216 @Override 2217 public void onSubtitleData(MediaPlayer mp, SubtitleData data) { 2218 int index = data.getTrackIndex(); 2219 synchronized (mIndexTrackPairs) { 2220 for (Pair<Integer, SubtitleTrack> p : mIndexTrackPairs) { 2221 if (p.first != null && p.first == index && p.second != null) { 2222 // inband subtitle track that owns data 2223 SubtitleTrack track = p.second; 2224 track.onData(data); 2225 } 2226 } 2227 } 2228 } 2229 }; 2230 2231 /** @hide */ 2232 @Override 2233 public void onSubtitleTrackSelected(SubtitleTrack track) { 2234 if (mSelectedSubtitleTrackIndex >= 0) { 2235 try { 2236 selectOrDeselectInbandTrack(mSelectedSubtitleTrackIndex, false); 2237 } catch (IllegalStateException e) { 2238 } 2239 mSelectedSubtitleTrackIndex = -1; 2240 } 2241 setOnSubtitleDataListener(null); 2242 if (track == null) { 2243 return; 2244 } 2245 2246 synchronized (mIndexTrackPairs) { 2247 for (Pair<Integer, SubtitleTrack> p : mIndexTrackPairs) { 2248 if (p.first != null && p.second == track) { 2249 // inband subtitle track that is selected 2250 mSelectedSubtitleTrackIndex = p.first; 2251 break; 2252 } 2253 } 2254 } 2255 2256 if (mSelectedSubtitleTrackIndex >= 0) { 2257 try { 2258 selectOrDeselectInbandTrack(mSelectedSubtitleTrackIndex, true); 2259 } catch (IllegalStateException e) { 2260 } 2261 setOnSubtitleDataListener(mSubtitleDataListener); 2262 } 2263 // no need to select out-of-band tracks 2264 } 2265 2266 /** @hide */ 2267 public void addSubtitleSource(InputStream is, MediaFormat format) 2268 throws IllegalStateException 2269 { 2270 final InputStream fIs = is; 2271 final MediaFormat fFormat = format; 2272 2273 if (is != null) { 2274 // Ensure all input streams are closed. It is also a handy 2275 // way to implement timeouts in the future. 2276 synchronized(mOpenSubtitleSources) { 2277 mOpenSubtitleSources.add(is); 2278 } 2279 } else { 2280 Log.w(TAG, "addSubtitleSource called with null InputStream"); 2281 } 2282 2283 getMediaTimeProvider(); 2284 2285 // process each subtitle in its own thread 2286 final HandlerThread thread = new HandlerThread("SubtitleReadThread", 2287 Process.THREAD_PRIORITY_BACKGROUND + Process.THREAD_PRIORITY_MORE_FAVORABLE); 2288 thread.start(); 2289 Handler handler = new Handler(thread.getLooper()); 2290 handler.post(new Runnable() { 2291 private int addTrack() { 2292 if (fIs == null || mSubtitleController == null) { 2293 return MEDIA_INFO_UNSUPPORTED_SUBTITLE; 2294 } 2295 2296 SubtitleTrack track = mSubtitleController.addTrack(fFormat); 2297 if (track == null) { 2298 return MEDIA_INFO_UNSUPPORTED_SUBTITLE; 2299 } 2300 2301 // TODO: do the conversion in the subtitle track 2302 Scanner scanner = new Scanner(fIs, "UTF-8"); 2303 String contents = scanner.useDelimiter("\\A").next(); 2304 synchronized(mOpenSubtitleSources) { 2305 mOpenSubtitleSources.remove(fIs); 2306 } 2307 scanner.close(); 2308 synchronized (mIndexTrackPairs) { 2309 mIndexTrackPairs.add(Pair.<Integer, SubtitleTrack>create(null, track)); 2310 } 2311 Handler h = mTimeProvider.mEventHandler; 2312 int what = TimeProvider.NOTIFY; 2313 int arg1 = TimeProvider.NOTIFY_TRACK_DATA; 2314 Pair<SubtitleTrack, byte[]> trackData = Pair.create(track, contents.getBytes()); 2315 Message m = h.obtainMessage(what, arg1, 0, trackData); 2316 h.sendMessage(m); 2317 return MEDIA_INFO_EXTERNAL_METADATA_UPDATE; 2318 } 2319 2320 public void run() { 2321 int res = addTrack(); 2322 if (mEventHandler != null) { 2323 Message m = mEventHandler.obtainMessage(MEDIA_INFO, res, 0, null); 2324 mEventHandler.sendMessage(m); 2325 } 2326 thread.getLooper().quitSafely(); 2327 } 2328 }); 2329 } 2330 2331 private void scanInternalSubtitleTracks() { 2332 if (mSubtitleController == null) { 2333 Log.d(TAG, "setSubtitleAnchor in MediaPlayer"); 2334 setSubtitleAnchor(); 2335 } 2336 2337 populateInbandTracks(); 2338 2339 if (mSubtitleController != null) { 2340 mSubtitleController.selectDefaultTrack(); 2341 } 2342 } 2343 2344 private void populateInbandTracks() { 2345 TrackInfo[] tracks = getInbandTrackInfo(); 2346 synchronized (mIndexTrackPairs) { 2347 for (int i = 0; i < tracks.length; i++) { 2348 if (mInbandTrackIndices.get(i)) { 2349 continue; 2350 } else { 2351 mInbandTrackIndices.set(i); 2352 } 2353 2354 // newly appeared inband track 2355 if (tracks[i].getTrackType() == TrackInfo.MEDIA_TRACK_TYPE_SUBTITLE) { 2356 SubtitleTrack track = mSubtitleController.addTrack( 2357 tracks[i].getFormat()); 2358 mIndexTrackPairs.add(Pair.create(i, track)); 2359 } else { 2360 mIndexTrackPairs.add(Pair.<Integer, SubtitleTrack>create(i, null)); 2361 } 2362 } 2363 } 2364 } 2365 2366 /* TODO: Limit the total number of external timed text source to a reasonable number. 2367 */ 2368 /** 2369 * Adds an external timed text source file. 2370 * 2371 * Currently supported format is SubRip with the file extension .srt, case insensitive. 2372 * Note that a single external timed text source may contain multiple tracks in it. 2373 * One can find the total number of available tracks using {@link #getTrackInfo()} to see what 2374 * additional tracks become available after this method call. 2375 * 2376 * @param path The file path of external timed text source file. 2377 * @param mimeType The mime type of the file. Must be one of the mime types listed above. 2378 * @throws IOException if the file cannot be accessed or is corrupted. 2379 * @throws IllegalArgumentException if the mimeType is not supported. 2380 * @throws IllegalStateException if called in an invalid state. 2381 */ 2382 public void addTimedTextSource(String path, String mimeType) 2383 throws IOException, IllegalArgumentException, IllegalStateException { 2384 if (!availableMimeTypeForExternalSource(mimeType)) { 2385 final String msg = "Illegal mimeType for timed text source: " + mimeType; 2386 throw new IllegalArgumentException(msg); 2387 } 2388 2389 File file = new File(path); 2390 if (file.exists()) { 2391 FileInputStream is = new FileInputStream(file); 2392 FileDescriptor fd = is.getFD(); 2393 addTimedTextSource(fd, mimeType); 2394 is.close(); 2395 } else { 2396 // We do not support the case where the path is not a file. 2397 throw new IOException(path); 2398 } 2399 } 2400 2401 /** 2402 * Adds an external timed text source file (Uri). 2403 * 2404 * Currently supported format is SubRip with the file extension .srt, case insensitive. 2405 * Note that a single external timed text source may contain multiple tracks in it. 2406 * One can find the total number of available tracks using {@link #getTrackInfo()} to see what 2407 * additional tracks become available after this method call. 2408 * 2409 * @param context the Context to use when resolving the Uri 2410 * @param uri the Content URI of the data you want to play 2411 * @param mimeType The mime type of the file. Must be one of the mime types listed above. 2412 * @throws IOException if the file cannot be accessed or is corrupted. 2413 * @throws IllegalArgumentException if the mimeType is not supported. 2414 * @throws IllegalStateException if called in an invalid state. 2415 */ 2416 public void addTimedTextSource(Context context, Uri uri, String mimeType) 2417 throws IOException, IllegalArgumentException, IllegalStateException { 2418 String scheme = uri.getScheme(); 2419 if(scheme == null || scheme.equals("file")) { 2420 addTimedTextSource(uri.getPath(), mimeType); 2421 return; 2422 } 2423 2424 AssetFileDescriptor fd = null; 2425 try { 2426 ContentResolver resolver = context.getContentResolver(); 2427 fd = resolver.openAssetFileDescriptor(uri, "r"); 2428 if (fd == null) { 2429 return; 2430 } 2431 addTimedTextSource(fd.getFileDescriptor(), mimeType); 2432 return; 2433 } catch (SecurityException ex) { 2434 } catch (IOException ex) { 2435 } finally { 2436 if (fd != null) { 2437 fd.close(); 2438 } 2439 } 2440 } 2441 2442 /** 2443 * Adds an external timed text source file (FileDescriptor). 2444 * 2445 * It is the caller's responsibility to close the file descriptor. 2446 * It is safe to do so as soon as this call returns. 2447 * 2448 * Currently supported format is SubRip. Note that a single external timed text source may 2449 * contain multiple tracks in it. One can find the total number of available tracks 2450 * using {@link #getTrackInfo()} to see what additional tracks become available 2451 * after this method call. 2452 * 2453 * @param fd the FileDescriptor for the file you want to play 2454 * @param mimeType The mime type of the file. Must be one of the mime types listed above. 2455 * @throws IllegalArgumentException if the mimeType is not supported. 2456 * @throws IllegalStateException if called in an invalid state. 2457 */ 2458 public void addTimedTextSource(FileDescriptor fd, String mimeType) 2459 throws IllegalArgumentException, IllegalStateException { 2460 // intentionally less than LONG_MAX 2461 addTimedTextSource(fd, 0, 0x7ffffffffffffffL, mimeType); 2462 } 2463 2464 /** 2465 * Adds an external timed text file (FileDescriptor). 2466 * 2467 * It is the caller's responsibility to close the file descriptor. 2468 * It is safe to do so as soon as this call returns. 2469 * 2470 * Currently supported format is SubRip. Note that a single external timed text source may 2471 * contain multiple tracks in it. One can find the total number of available tracks 2472 * using {@link #getTrackInfo()} to see what additional tracks become available 2473 * after this method call. 2474 * 2475 * @param fd the FileDescriptor for the file you want to play 2476 * @param offset the offset into the file where the data to be played starts, in bytes 2477 * @param length the length in bytes of the data to be played 2478 * @param mime The mime type of the file. Must be one of the mime types listed above. 2479 * @throws IllegalArgumentException if the mimeType is not supported. 2480 * @throws IllegalStateException if called in an invalid state. 2481 */ 2482 public void addTimedTextSource(FileDescriptor fd, long offset, long length, String mime) 2483 throws IllegalArgumentException, IllegalStateException { 2484 if (!availableMimeTypeForExternalSource(mime)) { 2485 throw new IllegalArgumentException("Illegal mimeType for timed text source: " + mime); 2486 } 2487 2488 FileDescriptor fd2; 2489 try { 2490 fd2 = Libcore.os.dup(fd); 2491 } catch (ErrnoException ex) { 2492 Log.e(TAG, ex.getMessage(), ex); 2493 throw new RuntimeException(ex); 2494 } 2495 2496 final MediaFormat fFormat = new MediaFormat(); 2497 fFormat.setString(MediaFormat.KEY_MIME, mime); 2498 fFormat.setInteger(MediaFormat.KEY_IS_TIMED_TEXT, 1); 2499 2500 // A MediaPlayer created by a VideoView should already have its mSubtitleController set. 2501 if (mSubtitleController == null) { 2502 setSubtitleAnchor(); 2503 } 2504 2505 if (!mSubtitleController.hasRendererFor(fFormat)) { 2506 // test and add not atomic 2507 Context context = ActivityThread.currentApplication(); 2508 mSubtitleController.registerRenderer(new SRTRenderer(context, mEventHandler)); 2509 } 2510 final SubtitleTrack track = mSubtitleController.addTrack(fFormat); 2511 synchronized (mIndexTrackPairs) { 2512 mIndexTrackPairs.add(Pair.<Integer, SubtitleTrack>create(null, track)); 2513 } 2514 2515 getMediaTimeProvider(); 2516 2517 final FileDescriptor fd3 = fd2; 2518 final long offset2 = offset; 2519 final long length2 = length; 2520 final HandlerThread thread = new HandlerThread( 2521 "TimedTextReadThread", 2522 Process.THREAD_PRIORITY_BACKGROUND + Process.THREAD_PRIORITY_MORE_FAVORABLE); 2523 thread.start(); 2524 Handler handler = new Handler(thread.getLooper()); 2525 handler.post(new Runnable() { 2526 private int addTrack() { 2527 InputStream is = null; 2528 final ByteArrayOutputStream bos = new ByteArrayOutputStream(); 2529 try { 2530 Libcore.os.lseek(fd3, offset2, OsConstants.SEEK_SET); 2531 byte[] buffer = new byte[4096]; 2532 for (long total = 0; total < length2;) { 2533 int bytesToRead = (int) Math.min(buffer.length, length2 - total); 2534 int bytes = IoBridge.read(fd3, buffer, 0, bytesToRead); 2535 if (bytes < 0) { 2536 break; 2537 } else { 2538 bos.write(buffer, 0, bytes); 2539 total += bytes; 2540 } 2541 } 2542 Handler h = mTimeProvider.mEventHandler; 2543 int what = TimeProvider.NOTIFY; 2544 int arg1 = TimeProvider.NOTIFY_TRACK_DATA; 2545 Pair<SubtitleTrack, byte[]> trackData = Pair.create(track, bos.toByteArray()); 2546 Message m = h.obtainMessage(what, arg1, 0, trackData); 2547 h.sendMessage(m); 2548 return MEDIA_INFO_EXTERNAL_METADATA_UPDATE; 2549 } catch (Exception e) { 2550 Log.e(TAG, e.getMessage(), e); 2551 return MEDIA_INFO_TIMED_TEXT_ERROR; 2552 } finally { 2553 if (is != null) { 2554 try { 2555 is.close(); 2556 } catch (IOException e) { 2557 Log.e(TAG, e.getMessage(), e); 2558 } 2559 } 2560 } 2561 } 2562 2563 public void run() { 2564 int res = addTrack(); 2565 if (mEventHandler != null) { 2566 Message m = mEventHandler.obtainMessage(MEDIA_INFO, res, 0, null); 2567 mEventHandler.sendMessage(m); 2568 } 2569 thread.getLooper().quitSafely(); 2570 } 2571 }); 2572 } 2573 2574 /** 2575 * Returns the index of the audio, video, or subtitle track currently selected for playback, 2576 * The return value is an index into the array returned by {@link #getTrackInfo()}, and can 2577 * be used in calls to {@link #selectTrack(int)} or {@link #deselectTrack(int)}. 2578 * 2579 * @param trackType should be one of {@link TrackInfo#MEDIA_TRACK_TYPE_VIDEO}, 2580 * {@link TrackInfo#MEDIA_TRACK_TYPE_AUDIO}, or 2581 * {@link TrackInfo#MEDIA_TRACK_TYPE_SUBTITLE} 2582 * @return index of the audio, video, or subtitle track currently selected for playback; 2583 * a negative integer is returned when there is no selected track for {@code trackType} or 2584 * when {@code trackType} is not one of audio, video, or subtitle. 2585 * @throws IllegalStateException if called after {@link #release()} 2586 * 2587 * @see #getTrackInfo() 2588 * @see #selectTrack(int) 2589 * @see #deselectTrack(int) 2590 */ 2591 public int getSelectedTrack(int trackType) throws IllegalStateException { 2592 if (mSubtitleController != null 2593 && (trackType == TrackInfo.MEDIA_TRACK_TYPE_SUBTITLE 2594 || trackType == TrackInfo.MEDIA_TRACK_TYPE_TIMEDTEXT)) { 2595 SubtitleTrack subtitleTrack = mSubtitleController.getSelectedTrack(); 2596 if (subtitleTrack != null) { 2597 synchronized (mIndexTrackPairs) { 2598 for (int i = 0; i < mIndexTrackPairs.size(); i++) { 2599 Pair<Integer, SubtitleTrack> p = mIndexTrackPairs.get(i); 2600 if (p.second == subtitleTrack && subtitleTrack.getTrackType() == trackType) { 2601 return i; 2602 } 2603 } 2604 } 2605 } 2606 } 2607 2608 Parcel request = Parcel.obtain(); 2609 Parcel reply = Parcel.obtain(); 2610 try { 2611 request.writeInterfaceToken(IMEDIA_PLAYER); 2612 request.writeInt(INVOKE_ID_GET_SELECTED_TRACK); 2613 request.writeInt(trackType); 2614 invoke(request, reply); 2615 int inbandTrackIndex = reply.readInt(); 2616 synchronized (mIndexTrackPairs) { 2617 for (int i = 0; i < mIndexTrackPairs.size(); i++) { 2618 Pair<Integer, SubtitleTrack> p = mIndexTrackPairs.get(i); 2619 if (p.first != null && p.first == inbandTrackIndex) { 2620 return i; 2621 } 2622 } 2623 } 2624 return -1; 2625 } finally { 2626 request.recycle(); 2627 reply.recycle(); 2628 } 2629 } 2630 2631 /** 2632 * Selects a track. 2633 * <p> 2634 * If a MediaPlayer is in invalid state, it throws an IllegalStateException exception. 2635 * If a MediaPlayer is in <em>Started</em> state, the selected track is presented immediately. 2636 * If a MediaPlayer is not in Started state, it just marks the track to be played. 2637 * </p> 2638 * <p> 2639 * In any valid state, if it is called multiple times on the same type of track (ie. Video, 2640 * Audio, Timed Text), the most recent one will be chosen. 2641 * </p> 2642 * <p> 2643 * The first audio and video tracks are selected by default if available, even though 2644 * this method is not called. However, no timed text track will be selected until 2645 * this function is called. 2646 * </p> 2647 * <p> 2648 * Currently, only timed text tracks or audio tracks can be selected via this method. 2649 * In addition, the support for selecting an audio track at runtime is pretty limited 2650 * in that an audio track can only be selected in the <em>Prepared</em> state. 2651 * </p> 2652 * @param index the index of the track to be selected. The valid range of the index 2653 * is 0..total number of track - 1. The total number of tracks as well as the type of 2654 * each individual track can be found by calling {@link #getTrackInfo()} method. 2655 * @throws IllegalStateException if called in an invalid state. 2656 * 2657 * @see android.media.MediaPlayer#getTrackInfo 2658 */ 2659 public void selectTrack(int index) throws IllegalStateException { 2660 selectOrDeselectTrack(index, true /* select */); 2661 } 2662 2663 /** 2664 * Deselect a track. 2665 * <p> 2666 * Currently, the track must be a timed text track and no audio or video tracks can be 2667 * deselected. If the timed text track identified by index has not been 2668 * selected before, it throws an exception. 2669 * </p> 2670 * @param index the index of the track to be deselected. The valid range of the index 2671 * is 0..total number of tracks - 1. The total number of tracks as well as the type of 2672 * each individual track can be found by calling {@link #getTrackInfo()} method. 2673 * @throws IllegalStateException if called in an invalid state. 2674 * 2675 * @see android.media.MediaPlayer#getTrackInfo 2676 */ 2677 public void deselectTrack(int index) throws IllegalStateException { 2678 selectOrDeselectTrack(index, false /* select */); 2679 } 2680 2681 private void selectOrDeselectTrack(int index, boolean select) 2682 throws IllegalStateException { 2683 // handle subtitle track through subtitle controller 2684 populateInbandTracks(); 2685 2686 Pair<Integer,SubtitleTrack> p = null; 2687 try { 2688 p = mIndexTrackPairs.get(index); 2689 } catch (ArrayIndexOutOfBoundsException e) { 2690 // ignore bad index 2691 return; 2692 } 2693 2694 SubtitleTrack track = p.second; 2695 if (track == null) { 2696 // inband (de)select 2697 selectOrDeselectInbandTrack(p.first, select); 2698 return; 2699 } 2700 2701 if (mSubtitleController == null) { 2702 return; 2703 } 2704 2705 if (!select) { 2706 // out-of-band deselect 2707 if (mSubtitleController.getSelectedTrack() == track) { 2708 mSubtitleController.selectTrack(null); 2709 } else { 2710 Log.w(TAG, "trying to deselect track that was not selected"); 2711 } 2712 return; 2713 } 2714 2715 // out-of-band select 2716 if (track.getTrackType() == TrackInfo.MEDIA_TRACK_TYPE_TIMEDTEXT) { 2717 int ttIndex = getSelectedTrack(TrackInfo.MEDIA_TRACK_TYPE_TIMEDTEXT); 2718 synchronized (mIndexTrackPairs) { 2719 if (ttIndex >= 0 && ttIndex < mIndexTrackPairs.size()) { 2720 Pair<Integer,SubtitleTrack> p2 = mIndexTrackPairs.get(ttIndex); 2721 if (p2.first != null && p2.second == null) { 2722 // deselect inband counterpart 2723 selectOrDeselectInbandTrack(p2.first, false); 2724 } 2725 } 2726 } 2727 } 2728 mSubtitleController.selectTrack(track); 2729 } 2730 2731 private void selectOrDeselectInbandTrack(int index, boolean select) 2732 throws IllegalStateException { 2733 Parcel request = Parcel.obtain(); 2734 Parcel reply = Parcel.obtain(); 2735 try { 2736 request.writeInterfaceToken(IMEDIA_PLAYER); 2737 request.writeInt(select? INVOKE_ID_SELECT_TRACK: INVOKE_ID_DESELECT_TRACK); 2738 request.writeInt(index); 2739 invoke(request, reply); 2740 } finally { 2741 request.recycle(); 2742 reply.recycle(); 2743 } 2744 } 2745 2746 2747 /** 2748 * @param reply Parcel with audio/video duration info for battery 2749 tracking usage 2750 * @return The status code. 2751 * {@hide} 2752 */ 2753 public native static int native_pullBatteryData(Parcel reply); 2754 2755 /** 2756 * Sets the target UDP re-transmit endpoint for the low level player. 2757 * Generally, the address portion of the endpoint is an IP multicast 2758 * address, although a unicast address would be equally valid. When a valid 2759 * retransmit endpoint has been set, the media player will not decode and 2760 * render the media presentation locally. Instead, the player will attempt 2761 * to re-multiplex its media data using the Android@Home RTP profile and 2762 * re-transmit to the target endpoint. Receiver devices (which may be 2763 * either the same as the transmitting device or different devices) may 2764 * instantiate, prepare, and start a receiver player using a setDataSource 2765 * URL of the form... 2766 * 2767 * aahRX://<multicastIP>:<port> 2768 * 2769 * to receive, decode and render the re-transmitted content. 2770 * 2771 * setRetransmitEndpoint may only be called before setDataSource has been 2772 * called; while the player is in the Idle state. 2773 * 2774 * @param endpoint the address and UDP port of the re-transmission target or 2775 * null if no re-transmission is to be performed. 2776 * @throws IllegalStateException if it is called in an invalid state 2777 * @throws IllegalArgumentException if the retransmit endpoint is supplied, 2778 * but invalid. 2779 * 2780 * {@hide} pending API council 2781 */ 2782 public void setRetransmitEndpoint(InetSocketAddress endpoint) 2783 throws IllegalStateException, IllegalArgumentException 2784 { 2785 String addrString = null; 2786 int port = 0; 2787 2788 if (null != endpoint) { 2789 addrString = endpoint.getAddress().getHostAddress(); 2790 port = endpoint.getPort(); 2791 } 2792 2793 int ret = native_setRetransmitEndpoint(addrString, port); 2794 if (ret != 0) { 2795 throw new IllegalArgumentException("Illegal re-transmit endpoint; native ret " + ret); 2796 } 2797 } 2798 2799 private native final int native_setRetransmitEndpoint(String addrString, int port); 2800 2801 @Override 2802 protected void finalize() { 2803 baseRelease(); 2804 native_finalize(); 2805 } 2806 2807 /* Do not change these values without updating their counterparts 2808 * in include/media/mediaplayer.h! 2809 */ 2810 private static final int MEDIA_NOP = 0; // interface test message 2811 private static final int MEDIA_PREPARED = 1; 2812 private static final int MEDIA_PLAYBACK_COMPLETE = 2; 2813 private static final int MEDIA_BUFFERING_UPDATE = 3; 2814 private static final int MEDIA_SEEK_COMPLETE = 4; 2815 private static final int MEDIA_SET_VIDEO_SIZE = 5; 2816 private static final int MEDIA_STARTED = 6; 2817 private static final int MEDIA_PAUSED = 7; 2818 private static final int MEDIA_STOPPED = 8; 2819 private static final int MEDIA_SKIPPED = 9; 2820 private static final int MEDIA_TIMED_TEXT = 99; 2821 private static final int MEDIA_ERROR = 100; 2822 private static final int MEDIA_INFO = 200; 2823 private static final int MEDIA_SUBTITLE_DATA = 201; 2824 private static final int MEDIA_META_DATA = 202; 2825 2826 private TimeProvider mTimeProvider; 2827 2828 /** @hide */ 2829 public MediaTimeProvider getMediaTimeProvider() { 2830 if (mTimeProvider == null) { 2831 mTimeProvider = new TimeProvider(this); 2832 } 2833 return mTimeProvider; 2834 } 2835 2836 private class EventHandler extends Handler 2837 { 2838 private MediaPlayer mMediaPlayer; 2839 2840 public EventHandler(MediaPlayer mp, Looper looper) { 2841 super(looper); 2842 mMediaPlayer = mp; 2843 } 2844 2845 @Override 2846 public void handleMessage(Message msg) { 2847 if (mMediaPlayer.mNativeContext == 0) { 2848 Log.w(TAG, "mediaplayer went away with unhandled events"); 2849 return; 2850 } 2851 switch(msg.what) { 2852 case MEDIA_PREPARED: 2853 try { 2854 scanInternalSubtitleTracks(); 2855 } catch (RuntimeException e) { 2856 // send error message instead of crashing; 2857 // send error message instead of inlining a call to onError 2858 // to avoid code duplication. 2859 Message msg2 = obtainMessage( 2860 MEDIA_ERROR, MEDIA_ERROR_UNKNOWN, MEDIA_ERROR_UNSUPPORTED, null); 2861 sendMessage(msg2); 2862 } 2863 OnPreparedListener onPreparedListener = mOnPreparedListener; 2864 if (onPreparedListener != null) 2865 onPreparedListener.onPrepared(mMediaPlayer); 2866 return; 2867 2868 case MEDIA_PLAYBACK_COMPLETE: 2869 { 2870 OnCompletionListener onCompletionListener = mOnCompletionListener; 2871 if (onCompletionListener != null) 2872 onCompletionListener.onCompletion(mMediaPlayer); 2873 } 2874 stayAwake(false); 2875 return; 2876 2877 case MEDIA_STOPPED: 2878 { 2879 TimeProvider timeProvider = mTimeProvider; 2880 if (timeProvider != null) { 2881 timeProvider.onStopped(); 2882 } 2883 } 2884 break; 2885 2886 case MEDIA_STARTED: 2887 case MEDIA_PAUSED: 2888 { 2889 TimeProvider timeProvider = mTimeProvider; 2890 if (timeProvider != null) { 2891 timeProvider.onPaused(msg.what == MEDIA_PAUSED); 2892 } 2893 } 2894 break; 2895 2896 case MEDIA_BUFFERING_UPDATE: 2897 OnBufferingUpdateListener onBufferingUpdateListener = mOnBufferingUpdateListener; 2898 if (onBufferingUpdateListener != null) 2899 onBufferingUpdateListener.onBufferingUpdate(mMediaPlayer, msg.arg1); 2900 return; 2901 2902 case MEDIA_SEEK_COMPLETE: 2903 OnSeekCompleteListener onSeekCompleteListener = mOnSeekCompleteListener; 2904 if (onSeekCompleteListener != null) { 2905 onSeekCompleteListener.onSeekComplete(mMediaPlayer); 2906 } 2907 // fall through 2908 2909 case MEDIA_SKIPPED: 2910 { 2911 TimeProvider timeProvider = mTimeProvider; 2912 if (timeProvider != null) { 2913 timeProvider.onSeekComplete(mMediaPlayer); 2914 } 2915 } 2916 return; 2917 2918 case MEDIA_SET_VIDEO_SIZE: 2919 OnVideoSizeChangedListener onVideoSizeChangedListener = mOnVideoSizeChangedListener; 2920 if (onVideoSizeChangedListener != null) { 2921 onVideoSizeChangedListener.onVideoSizeChanged( 2922 mMediaPlayer, msg.arg1, msg.arg2); 2923 } 2924 return; 2925 2926 case MEDIA_ERROR: 2927 Log.e(TAG, "Error (" + msg.arg1 + "," + msg.arg2 + ")"); 2928 boolean error_was_handled = false; 2929 OnErrorListener onErrorListener = mOnErrorListener; 2930 if (onErrorListener != null) { 2931 error_was_handled = onErrorListener.onError(mMediaPlayer, msg.arg1, msg.arg2); 2932 } 2933 { 2934 OnCompletionListener onCompletionListener = mOnCompletionListener; 2935 if (onCompletionListener != null && ! error_was_handled) { 2936 onCompletionListener.onCompletion(mMediaPlayer); 2937 } 2938 } 2939 stayAwake(false); 2940 return; 2941 2942 case MEDIA_INFO: 2943 switch (msg.arg1) { 2944 case MEDIA_INFO_VIDEO_TRACK_LAGGING: 2945 Log.i(TAG, "Info (" + msg.arg1 + "," + msg.arg2 + ")"); 2946 break; 2947 case MEDIA_INFO_METADATA_UPDATE: 2948 try { 2949 scanInternalSubtitleTracks(); 2950 } catch (RuntimeException e) { 2951 Message msg2 = obtainMessage( 2952 MEDIA_ERROR, MEDIA_ERROR_UNKNOWN, MEDIA_ERROR_UNSUPPORTED, null); 2953 sendMessage(msg2); 2954 } 2955 // fall through 2956 2957 case MEDIA_INFO_EXTERNAL_METADATA_UPDATE: 2958 msg.arg1 = MEDIA_INFO_METADATA_UPDATE; 2959 // update default track selection 2960 if (mSubtitleController != null) { 2961 mSubtitleController.selectDefaultTrack(); 2962 } 2963 break; 2964 case MEDIA_INFO_BUFFERING_START: 2965 case MEDIA_INFO_BUFFERING_END: 2966 TimeProvider timeProvider = mTimeProvider; 2967 if (timeProvider != null) { 2968 timeProvider.onBuffering(msg.arg1 == MEDIA_INFO_BUFFERING_START); 2969 } 2970 break; 2971 } 2972 2973 OnInfoListener onInfoListener = mOnInfoListener; 2974 if (onInfoListener != null) { 2975 onInfoListener.onInfo(mMediaPlayer, msg.arg1, msg.arg2); 2976 } 2977 // No real default action so far. 2978 return; 2979 case MEDIA_TIMED_TEXT: 2980 OnTimedTextListener onTimedTextListener = mOnTimedTextListener; 2981 if (onTimedTextListener == null) 2982 return; 2983 if (msg.obj == null) { 2984 onTimedTextListener.onTimedText(mMediaPlayer, null); 2985 } else { 2986 if (msg.obj instanceof Parcel) { 2987 Parcel parcel = (Parcel)msg.obj; 2988 TimedText text = new TimedText(parcel); 2989 parcel.recycle(); 2990 onTimedTextListener.onTimedText(mMediaPlayer, text); 2991 } 2992 } 2993 return; 2994 2995 case MEDIA_SUBTITLE_DATA: 2996 OnSubtitleDataListener onSubtitleDataListener = mOnSubtitleDataListener; 2997 if (onSubtitleDataListener == null) { 2998 return; 2999 } 3000 if (msg.obj instanceof Parcel) { 3001 Parcel parcel = (Parcel) msg.obj; 3002 SubtitleData data = new SubtitleData(parcel); 3003 parcel.recycle(); 3004 onSubtitleDataListener.onSubtitleData(mMediaPlayer, data); 3005 } 3006 return; 3007 3008 case MEDIA_META_DATA: 3009 OnTimedMetaDataAvailableListener onTimedMetaDataAvailableListener = 3010 mOnTimedMetaDataAvailableListener; 3011 if (onTimedMetaDataAvailableListener == null) { 3012 return; 3013 } 3014 if (msg.obj instanceof Parcel) { 3015 Parcel parcel = (Parcel) msg.obj; 3016 TimedMetaData data = TimedMetaData.createTimedMetaDataFromParcel(parcel); 3017 parcel.recycle(); 3018 onTimedMetaDataAvailableListener.onTimedMetaDataAvailable(mMediaPlayer, data); 3019 } 3020 return; 3021 3022 case MEDIA_NOP: // interface test message - ignore 3023 break; 3024 3025 default: 3026 Log.e(TAG, "Unknown message type " + msg.what); 3027 return; 3028 } 3029 } 3030 } 3031 3032 /* 3033 * Called from native code when an interesting event happens. This method 3034 * just uses the EventHandler system to post the event back to the main app thread. 3035 * We use a weak reference to the original MediaPlayer object so that the native 3036 * code is safe from the object disappearing from underneath it. (This is 3037 * the cookie passed to native_setup().) 3038 */ 3039 private static void postEventFromNative(Object mediaplayer_ref, 3040 int what, int arg1, int arg2, Object obj) 3041 { 3042 MediaPlayer mp = (MediaPlayer)((WeakReference)mediaplayer_ref).get(); 3043 if (mp == null) { 3044 return; 3045 } 3046 3047 if (what == MEDIA_INFO && arg1 == MEDIA_INFO_STARTED_AS_NEXT) { 3048 // this acquires the wakelock if needed, and sets the client side state 3049 mp.start(); 3050 } 3051 if (mp.mEventHandler != null) { 3052 Message m = mp.mEventHandler.obtainMessage(what, arg1, arg2, obj); 3053 mp.mEventHandler.sendMessage(m); 3054 } 3055 } 3056 3057 /** 3058 * Interface definition for a callback to be invoked when the media 3059 * source is ready for playback. 3060 */ 3061 public interface OnPreparedListener 3062 { 3063 /** 3064 * Called when the media file is ready for playback. 3065 * 3066 * @param mp the MediaPlayer that is ready for playback 3067 */ 3068 void onPrepared(MediaPlayer mp); 3069 } 3070 3071 /** 3072 * Register a callback to be invoked when the media source is ready 3073 * for playback. 3074 * 3075 * @param listener the callback that will be run 3076 */ 3077 public void setOnPreparedListener(OnPreparedListener listener) 3078 { 3079 mOnPreparedListener = listener; 3080 } 3081 3082 private OnPreparedListener mOnPreparedListener; 3083 3084 /** 3085 * Interface definition for a callback to be invoked when playback of 3086 * a media source has completed. 3087 */ 3088 public interface OnCompletionListener 3089 { 3090 /** 3091 * Called when the end of a media source is reached during playback. 3092 * 3093 * @param mp the MediaPlayer that reached the end of the file 3094 */ 3095 void onCompletion(MediaPlayer mp); 3096 } 3097 3098 /** 3099 * Register a callback to be invoked when the end of a media source 3100 * has been reached during playback. 3101 * 3102 * @param listener the callback that will be run 3103 */ 3104 public void setOnCompletionListener(OnCompletionListener listener) 3105 { 3106 mOnCompletionListener = listener; 3107 } 3108 3109 private OnCompletionListener mOnCompletionListener; 3110 3111 /** 3112 * Interface definition of a callback to be invoked indicating buffering 3113 * status of a media resource being streamed over the network. 3114 */ 3115 public interface OnBufferingUpdateListener 3116 { 3117 /** 3118 * Called to update status in buffering a media stream received through 3119 * progressive HTTP download. The received buffering percentage 3120 * indicates how much of the content has been buffered or played. 3121 * For example a buffering update of 80 percent when half the content 3122 * has already been played indicates that the next 30 percent of the 3123 * content to play has been buffered. 3124 * 3125 * @param mp the MediaPlayer the update pertains to 3126 * @param percent the percentage (0-100) of the content 3127 * that has been buffered or played thus far 3128 */ 3129 void onBufferingUpdate(MediaPlayer mp, int percent); 3130 } 3131 3132 /** 3133 * Register a callback to be invoked when the status of a network 3134 * stream's buffer has changed. 3135 * 3136 * @param listener the callback that will be run. 3137 */ 3138 public void setOnBufferingUpdateListener(OnBufferingUpdateListener listener) 3139 { 3140 mOnBufferingUpdateListener = listener; 3141 } 3142 3143 private OnBufferingUpdateListener mOnBufferingUpdateListener; 3144 3145 /** 3146 * Interface definition of a callback to be invoked indicating 3147 * the completion of a seek operation. 3148 */ 3149 public interface OnSeekCompleteListener 3150 { 3151 /** 3152 * Called to indicate the completion of a seek operation. 3153 * 3154 * @param mp the MediaPlayer that issued the seek operation 3155 */ 3156 public void onSeekComplete(MediaPlayer mp); 3157 } 3158 3159 /** 3160 * Register a callback to be invoked when a seek operation has been 3161 * completed. 3162 * 3163 * @param listener the callback that will be run 3164 */ 3165 public void setOnSeekCompleteListener(OnSeekCompleteListener listener) 3166 { 3167 mOnSeekCompleteListener = listener; 3168 } 3169 3170 private OnSeekCompleteListener mOnSeekCompleteListener; 3171 3172 /** 3173 * Interface definition of a callback to be invoked when the 3174 * video size is first known or updated 3175 */ 3176 public interface OnVideoSizeChangedListener 3177 { 3178 /** 3179 * Called to indicate the video size 3180 * 3181 * The video size (width and height) could be 0 if there was no video, 3182 * no display surface was set, or the value was not determined yet. 3183 * 3184 * @param mp the MediaPlayer associated with this callback 3185 * @param width the width of the video 3186 * @param height the height of the video 3187 */ 3188 public void onVideoSizeChanged(MediaPlayer mp, int width, int height); 3189 } 3190 3191 /** 3192 * Register a callback to be invoked when the video size is 3193 * known or updated. 3194 * 3195 * @param listener the callback that will be run 3196 */ 3197 public void setOnVideoSizeChangedListener(OnVideoSizeChangedListener listener) 3198 { 3199 mOnVideoSizeChangedListener = listener; 3200 } 3201 3202 private OnVideoSizeChangedListener mOnVideoSizeChangedListener; 3203 3204 /** 3205 * Interface definition of a callback to be invoked when a 3206 * timed text is available for display. 3207 */ 3208 public interface OnTimedTextListener 3209 { 3210 /** 3211 * Called to indicate an avaliable timed text 3212 * 3213 * @param mp the MediaPlayer associated with this callback 3214 * @param text the timed text sample which contains the text 3215 * needed to be displayed and the display format. 3216 */ 3217 public void onTimedText(MediaPlayer mp, TimedText text); 3218 } 3219 3220 /** 3221 * Register a callback to be invoked when a timed text is available 3222 * for display. 3223 * 3224 * @param listener the callback that will be run 3225 */ 3226 public void setOnTimedTextListener(OnTimedTextListener listener) 3227 { 3228 mOnTimedTextListener = listener; 3229 } 3230 3231 private OnTimedTextListener mOnTimedTextListener; 3232 3233 /** 3234 * Interface definition of a callback to be invoked when a 3235 * track has data available. 3236 * 3237 * @hide 3238 */ 3239 public interface OnSubtitleDataListener 3240 { 3241 public void onSubtitleData(MediaPlayer mp, SubtitleData data); 3242 } 3243 3244 /** 3245 * Register a callback to be invoked when a track has data available. 3246 * 3247 * @param listener the callback that will be run 3248 * 3249 * @hide 3250 */ 3251 public void setOnSubtitleDataListener(OnSubtitleDataListener listener) 3252 { 3253 mOnSubtitleDataListener = listener; 3254 } 3255 3256 private OnSubtitleDataListener mOnSubtitleDataListener; 3257 3258 /** 3259 * Interface definition of a callback to be invoked when a 3260 * track has timed metadata available. 3261 * 3262 * @see MediaPlayer#setOnTimedMetaDataAvailableListener(OnTimedMetaDataAvailableListener) 3263 */ 3264 public interface OnTimedMetaDataAvailableListener 3265 { 3266 /** 3267 * Called to indicate avaliable timed metadata 3268 * <p> 3269 * This method will be called as timed metadata is extracted from the media, 3270 * in the same order as it occurs in the media. The timing of this event is 3271 * not controlled by the associated timestamp. 3272 * 3273 * @param mp the MediaPlayer associated with this callback 3274 * @param data the timed metadata sample associated with this event 3275 */ 3276 public void onTimedMetaDataAvailable(MediaPlayer mp, TimedMetaData data); 3277 } 3278 3279 /** 3280 * Register a callback to be invoked when a selected track has timed metadata available. 3281 * <p> 3282 * Currently only HTTP live streaming data URI's embedded with timed ID3 tags generates 3283 * {@link TimedMetaData}. 3284 * 3285 * @see MediaPlayer#selectTrack(int) 3286 * @see MediaPlayer.OnTimedMetaDataAvailableListener 3287 * @see TimedMetaData 3288 * 3289 * @param listener the callback that will be run 3290 */ 3291 public void setOnTimedMetaDataAvailableListener(OnTimedMetaDataAvailableListener listener) 3292 { 3293 mOnTimedMetaDataAvailableListener = listener; 3294 } 3295 3296 private OnTimedMetaDataAvailableListener mOnTimedMetaDataAvailableListener; 3297 3298 /* Do not change these values without updating their counterparts 3299 * in include/media/mediaplayer.h! 3300 */ 3301 /** Unspecified media player error. 3302 * @see android.media.MediaPlayer.OnErrorListener 3303 */ 3304 public static final int MEDIA_ERROR_UNKNOWN = 1; 3305 3306 /** Media server died. In this case, the application must release the 3307 * MediaPlayer object and instantiate a new one. 3308 * @see android.media.MediaPlayer.OnErrorListener 3309 */ 3310 public static final int MEDIA_ERROR_SERVER_DIED = 100; 3311 3312 /** The video is streamed and its container is not valid for progressive 3313 * playback i.e the video's index (e.g moov atom) is not at the start of the 3314 * file. 3315 * @see android.media.MediaPlayer.OnErrorListener 3316 */ 3317 public static final int MEDIA_ERROR_NOT_VALID_FOR_PROGRESSIVE_PLAYBACK = 200; 3318 3319 /** File or network related operation errors. */ 3320 public static final int MEDIA_ERROR_IO = -1004; 3321 /** Bitstream is not conforming to the related coding standard or file spec. */ 3322 public static final int MEDIA_ERROR_MALFORMED = -1007; 3323 /** Bitstream is conforming to the related coding standard or file spec, but 3324 * the media framework does not support the feature. */ 3325 public static final int MEDIA_ERROR_UNSUPPORTED = -1010; 3326 /** Some operation takes too long to complete, usually more than 3-5 seconds. */ 3327 public static final int MEDIA_ERROR_TIMED_OUT = -110; 3328 3329 /** Unspecified low-level system error. This value originated from UNKNOWN_ERROR in 3330 * system/core/include/utils/Errors.h 3331 * @see android.media.MediaPlayer.OnErrorListener 3332 * @hide 3333 */ 3334 public static final int MEDIA_ERROR_SYSTEM = -2147483648; 3335 3336 /** 3337 * Interface definition of a callback to be invoked when there 3338 * has been an error during an asynchronous operation (other errors 3339 * will throw exceptions at method call time). 3340 */ 3341 public interface OnErrorListener 3342 { 3343 /** 3344 * Called to indicate an error. 3345 * 3346 * @param mp the MediaPlayer the error pertains to 3347 * @param what the type of error that has occurred: 3348 * <ul> 3349 * <li>{@link #MEDIA_ERROR_UNKNOWN} 3350 * <li>{@link #MEDIA_ERROR_SERVER_DIED} 3351 * </ul> 3352 * @param extra an extra code, specific to the error. Typically 3353 * implementation dependent. 3354 * <ul> 3355 * <li>{@link #MEDIA_ERROR_IO} 3356 * <li>{@link #MEDIA_ERROR_MALFORMED} 3357 * <li>{@link #MEDIA_ERROR_UNSUPPORTED} 3358 * <li>{@link #MEDIA_ERROR_TIMED_OUT} 3359 * <li><code>MEDIA_ERROR_SYSTEM (-2147483648)</code> - low-level system error. 3360 * </ul> 3361 * @return True if the method handled the error, false if it didn't. 3362 * Returning false, or not having an OnErrorListener at all, will 3363 * cause the OnCompletionListener to be called. 3364 */ 3365 boolean onError(MediaPlayer mp, int what, int extra); 3366 } 3367 3368 /** 3369 * Register a callback to be invoked when an error has happened 3370 * during an asynchronous operation. 3371 * 3372 * @param listener the callback that will be run 3373 */ 3374 public void setOnErrorListener(OnErrorListener listener) 3375 { 3376 mOnErrorListener = listener; 3377 } 3378 3379 private OnErrorListener mOnErrorListener; 3380 3381 3382 /* Do not change these values without updating their counterparts 3383 * in include/media/mediaplayer.h! 3384 */ 3385 /** Unspecified media player info. 3386 * @see android.media.MediaPlayer.OnInfoListener 3387 */ 3388 public static final int MEDIA_INFO_UNKNOWN = 1; 3389 3390 /** The player was started because it was used as the next player for another 3391 * player, which just completed playback. 3392 * @see android.media.MediaPlayer.OnInfoListener 3393 * @hide 3394 */ 3395 public static final int MEDIA_INFO_STARTED_AS_NEXT = 2; 3396 3397 /** The player just pushed the very first video frame for rendering. 3398 * @see android.media.MediaPlayer.OnInfoListener 3399 */ 3400 public static final int MEDIA_INFO_VIDEO_RENDERING_START = 3; 3401 3402 /** The video is too complex for the decoder: it can't decode frames fast 3403 * enough. Possibly only the audio plays fine at this stage. 3404 * @see android.media.MediaPlayer.OnInfoListener 3405 */ 3406 public static final int MEDIA_INFO_VIDEO_TRACK_LAGGING = 700; 3407 3408 /** MediaPlayer is temporarily pausing playback internally in order to 3409 * buffer more data. 3410 * @see android.media.MediaPlayer.OnInfoListener 3411 */ 3412 public static final int MEDIA_INFO_BUFFERING_START = 701; 3413 3414 /** MediaPlayer is resuming playback after filling buffers. 3415 * @see android.media.MediaPlayer.OnInfoListener 3416 */ 3417 public static final int MEDIA_INFO_BUFFERING_END = 702; 3418 3419 /** Estimated network bandwidth information (kbps) is available; currently this event fires 3420 * simultaneously as {@link #MEDIA_INFO_BUFFERING_START} and {@link #MEDIA_INFO_BUFFERING_END} 3421 * when playing network files. 3422 * @see android.media.MediaPlayer.OnInfoListener 3423 * @hide 3424 */ 3425 public static final int MEDIA_INFO_NETWORK_BANDWIDTH = 703; 3426 3427 /** Bad interleaving means that a media has been improperly interleaved or 3428 * not interleaved at all, e.g has all the video samples first then all the 3429 * audio ones. Video is playing but a lot of disk seeks may be happening. 3430 * @see android.media.MediaPlayer.OnInfoListener 3431 */ 3432 public static final int MEDIA_INFO_BAD_INTERLEAVING = 800; 3433 3434 /** The media cannot be seeked (e.g live stream) 3435 * @see android.media.MediaPlayer.OnInfoListener 3436 */ 3437 public static final int MEDIA_INFO_NOT_SEEKABLE = 801; 3438 3439 /** A new set of metadata is available. 3440 * @see android.media.MediaPlayer.OnInfoListener 3441 */ 3442 public static final int MEDIA_INFO_METADATA_UPDATE = 802; 3443 3444 /** A new set of external-only metadata is available. Used by 3445 * JAVA framework to avoid triggering track scanning. 3446 * @hide 3447 */ 3448 public static final int MEDIA_INFO_EXTERNAL_METADATA_UPDATE = 803; 3449 3450 /** Failed to handle timed text track properly. 3451 * @see android.media.MediaPlayer.OnInfoListener 3452 * 3453 * {@hide} 3454 */ 3455 public static final int MEDIA_INFO_TIMED_TEXT_ERROR = 900; 3456 3457 /** Subtitle track was not supported by the media framework. 3458 * @see android.media.MediaPlayer.OnInfoListener 3459 */ 3460 public static final int MEDIA_INFO_UNSUPPORTED_SUBTITLE = 901; 3461 3462 /** Reading the subtitle track takes too long. 3463 * @see android.media.MediaPlayer.OnInfoListener 3464 */ 3465 public static final int MEDIA_INFO_SUBTITLE_TIMED_OUT = 902; 3466 3467 /** 3468 * Interface definition of a callback to be invoked to communicate some 3469 * info and/or warning about the media or its playback. 3470 */ 3471 public interface OnInfoListener 3472 { 3473 /** 3474 * Called to indicate an info or a warning. 3475 * 3476 * @param mp the MediaPlayer the info pertains to. 3477 * @param what the type of info or warning. 3478 * <ul> 3479 * <li>{@link #MEDIA_INFO_UNKNOWN} 3480 * <li>{@link #MEDIA_INFO_VIDEO_TRACK_LAGGING} 3481 * <li>{@link #MEDIA_INFO_VIDEO_RENDERING_START} 3482 * <li>{@link #MEDIA_INFO_BUFFERING_START} 3483 * <li>{@link #MEDIA_INFO_BUFFERING_END} 3484 * <li><code>MEDIA_INFO_NETWORK_BANDWIDTH (703)</code> - 3485 * bandwidth information is available (as <code>extra</code> kbps) 3486 * <li>{@link #MEDIA_INFO_BAD_INTERLEAVING} 3487 * <li>{@link #MEDIA_INFO_NOT_SEEKABLE} 3488 * <li>{@link #MEDIA_INFO_METADATA_UPDATE} 3489 * <li>{@link #MEDIA_INFO_UNSUPPORTED_SUBTITLE} 3490 * <li>{@link #MEDIA_INFO_SUBTITLE_TIMED_OUT} 3491 * </ul> 3492 * @param extra an extra code, specific to the info. Typically 3493 * implementation dependent. 3494 * @return True if the method handled the info, false if it didn't. 3495 * Returning false, or not having an OnErrorListener at all, will 3496 * cause the info to be discarded. 3497 */ 3498 boolean onInfo(MediaPlayer mp, int what, int extra); 3499 } 3500 3501 /** 3502 * Register a callback to be invoked when an info/warning is available. 3503 * 3504 * @param listener the callback that will be run 3505 */ 3506 public void setOnInfoListener(OnInfoListener listener) 3507 { 3508 mOnInfoListener = listener; 3509 } 3510 3511 private OnInfoListener mOnInfoListener; 3512 3513 /* 3514 * Test whether a given video scaling mode is supported. 3515 */ 3516 private boolean isVideoScalingModeSupported(int mode) { 3517 return (mode == VIDEO_SCALING_MODE_SCALE_TO_FIT || 3518 mode == VIDEO_SCALING_MODE_SCALE_TO_FIT_WITH_CROPPING); 3519 } 3520 3521 /** @hide */ 3522 static class TimeProvider implements MediaPlayer.OnSeekCompleteListener, 3523 MediaTimeProvider { 3524 private static final String TAG = "MTP"; 3525 private static final long MAX_NS_WITHOUT_POSITION_CHECK = 5000000000L; 3526 private static final long MAX_EARLY_CALLBACK_US = 1000; 3527 private static final long TIME_ADJUSTMENT_RATE = 2; /* meaning 1/2 */ 3528 private long mLastTimeUs = 0; 3529 private MediaPlayer mPlayer; 3530 private boolean mPaused = true; 3531 private boolean mStopped = true; 3532 private boolean mBuffering; 3533 private long mLastReportedTime; 3534 private long mTimeAdjustment; 3535 // since we are expecting only a handful listeners per stream, there is 3536 // no need for log(N) search performance 3537 private MediaTimeProvider.OnMediaTimeListener mListeners[]; 3538 private long mTimes[]; 3539 private long mLastNanoTime; 3540 private Handler mEventHandler; 3541 private boolean mRefresh = false; 3542 private boolean mPausing = false; 3543 private boolean mSeeking = false; 3544 private static final int NOTIFY = 1; 3545 private static final int NOTIFY_TIME = 0; 3546 private static final int REFRESH_AND_NOTIFY_TIME = 1; 3547 private static final int NOTIFY_STOP = 2; 3548 private static final int NOTIFY_SEEK = 3; 3549 private static final int NOTIFY_TRACK_DATA = 4; 3550 private HandlerThread mHandlerThread; 3551 3552 /** @hide */ 3553 public boolean DEBUG = false; 3554 3555 public TimeProvider(MediaPlayer mp) { 3556 mPlayer = mp; 3557 try { 3558 getCurrentTimeUs(true, false); 3559 } catch (IllegalStateException e) { 3560 // we assume starting position 3561 mRefresh = true; 3562 } 3563 3564 Looper looper; 3565 if ((looper = Looper.myLooper()) == null && 3566 (looper = Looper.getMainLooper()) == null) { 3567 // Create our own looper here in case MP was created without one 3568 mHandlerThread = new HandlerThread("MediaPlayerMTPEventThread", 3569 Process.THREAD_PRIORITY_FOREGROUND); 3570 mHandlerThread.start(); 3571 looper = mHandlerThread.getLooper(); 3572 } 3573 mEventHandler = new EventHandler(looper); 3574 3575 mListeners = new MediaTimeProvider.OnMediaTimeListener[0]; 3576 mTimes = new long[0]; 3577 mLastTimeUs = 0; 3578 mTimeAdjustment = 0; 3579 } 3580 3581 private void scheduleNotification(int type, long delayUs) { 3582 // ignore time notifications until seek is handled 3583 if (mSeeking && 3584 (type == NOTIFY_TIME || type == REFRESH_AND_NOTIFY_TIME)) { 3585 return; 3586 } 3587 3588 if (DEBUG) Log.v(TAG, "scheduleNotification " + type + " in " + delayUs); 3589 mEventHandler.removeMessages(NOTIFY); 3590 Message msg = mEventHandler.obtainMessage(NOTIFY, type, 0); 3591 mEventHandler.sendMessageDelayed(msg, (int) (delayUs / 1000)); 3592 } 3593 3594 /** @hide */ 3595 public void close() { 3596 mEventHandler.removeMessages(NOTIFY); 3597 if (mHandlerThread != null) { 3598 mHandlerThread.quitSafely(); 3599 mHandlerThread = null; 3600 } 3601 } 3602 3603 /** @hide */ 3604 protected void finalize() { 3605 if (mHandlerThread != null) { 3606 mHandlerThread.quitSafely(); 3607 } 3608 } 3609 3610 /** @hide */ 3611 public void onPaused(boolean paused) { 3612 synchronized(this) { 3613 if (DEBUG) Log.d(TAG, "onPaused: " + paused); 3614 if (mStopped) { // handle as seek if we were stopped 3615 mStopped = false; 3616 mSeeking = true; 3617 scheduleNotification(NOTIFY_SEEK, 0 /* delay */); 3618 } else { 3619 mPausing = paused; // special handling if player disappeared 3620 mSeeking = false; 3621 scheduleNotification(REFRESH_AND_NOTIFY_TIME, 0 /* delay */); 3622 } 3623 } 3624 } 3625 3626 /** @hide */ 3627 public void onBuffering(boolean buffering) { 3628 synchronized (this) { 3629 if (DEBUG) Log.d(TAG, "onBuffering: " + buffering); 3630 mBuffering = buffering; 3631 scheduleNotification(REFRESH_AND_NOTIFY_TIME, 0 /* delay */); 3632 } 3633 } 3634 3635 /** @hide */ 3636 public void onStopped() { 3637 synchronized(this) { 3638 if (DEBUG) Log.d(TAG, "onStopped"); 3639 mPaused = true; 3640 mStopped = true; 3641 mSeeking = false; 3642 mBuffering = false; 3643 scheduleNotification(NOTIFY_STOP, 0 /* delay */); 3644 } 3645 } 3646 3647 /** @hide */ 3648 @Override 3649 public void onSeekComplete(MediaPlayer mp) { 3650 synchronized(this) { 3651 mStopped = false; 3652 mSeeking = true; 3653 scheduleNotification(NOTIFY_SEEK, 0 /* delay */); 3654 } 3655 } 3656 3657 /** @hide */ 3658 public void onNewPlayer() { 3659 if (mRefresh) { 3660 synchronized(this) { 3661 mStopped = false; 3662 mSeeking = true; 3663 mBuffering = false; 3664 scheduleNotification(NOTIFY_SEEK, 0 /* delay */); 3665 } 3666 } 3667 } 3668 3669 private synchronized void notifySeek() { 3670 mSeeking = false; 3671 try { 3672 long timeUs = getCurrentTimeUs(true, false); 3673 if (DEBUG) Log.d(TAG, "onSeekComplete at " + timeUs); 3674 3675 for (MediaTimeProvider.OnMediaTimeListener listener: mListeners) { 3676 if (listener == null) { 3677 break; 3678 } 3679 listener.onSeek(timeUs); 3680 } 3681 } catch (IllegalStateException e) { 3682 // we should not be there, but at least signal pause 3683 if (DEBUG) Log.d(TAG, "onSeekComplete but no player"); 3684 mPausing = true; // special handling if player disappeared 3685 notifyTimedEvent(false /* refreshTime */); 3686 } 3687 } 3688 3689 private synchronized void notifyTrackData(Pair<SubtitleTrack, byte[]> trackData) { 3690 SubtitleTrack track = trackData.first; 3691 byte[] data = trackData.second; 3692 track.onData(data, true /* eos */, ~0 /* runID: keep forever */); 3693 } 3694 3695 private synchronized void notifyStop() { 3696 for (MediaTimeProvider.OnMediaTimeListener listener: mListeners) { 3697 if (listener == null) { 3698 break; 3699 } 3700 listener.onStop(); 3701 } 3702 } 3703 3704 private int registerListener(MediaTimeProvider.OnMediaTimeListener listener) { 3705 int i = 0; 3706 for (; i < mListeners.length; i++) { 3707 if (mListeners[i] == listener || mListeners[i] == null) { 3708 break; 3709 } 3710 } 3711 3712 // new listener 3713 if (i >= mListeners.length) { 3714 MediaTimeProvider.OnMediaTimeListener[] newListeners = 3715 new MediaTimeProvider.OnMediaTimeListener[i + 1]; 3716 long[] newTimes = new long[i + 1]; 3717 System.arraycopy(mListeners, 0, newListeners, 0, mListeners.length); 3718 System.arraycopy(mTimes, 0, newTimes, 0, mTimes.length); 3719 mListeners = newListeners; 3720 mTimes = newTimes; 3721 } 3722 3723 if (mListeners[i] == null) { 3724 mListeners[i] = listener; 3725 mTimes[i] = MediaTimeProvider.NO_TIME; 3726 } 3727 return i; 3728 } 3729 3730 public void notifyAt( 3731 long timeUs, MediaTimeProvider.OnMediaTimeListener listener) { 3732 synchronized(this) { 3733 if (DEBUG) Log.d(TAG, "notifyAt " + timeUs); 3734 mTimes[registerListener(listener)] = timeUs; 3735 scheduleNotification(NOTIFY_TIME, 0 /* delay */); 3736 } 3737 } 3738 3739 public void scheduleUpdate(MediaTimeProvider.OnMediaTimeListener listener) { 3740 synchronized(this) { 3741 if (DEBUG) Log.d(TAG, "scheduleUpdate"); 3742 int i = registerListener(listener); 3743 3744 if (!mStopped) { 3745 mTimes[i] = 0; 3746 scheduleNotification(NOTIFY_TIME, 0 /* delay */); 3747 } 3748 } 3749 } 3750 3751 public void cancelNotifications( 3752 MediaTimeProvider.OnMediaTimeListener listener) { 3753 synchronized(this) { 3754 int i = 0; 3755 for (; i < mListeners.length; i++) { 3756 if (mListeners[i] == listener) { 3757 System.arraycopy(mListeners, i + 1, 3758 mListeners, i, mListeners.length - i - 1); 3759 System.arraycopy(mTimes, i + 1, 3760 mTimes, i, mTimes.length - i - 1); 3761 mListeners[mListeners.length - 1] = null; 3762 mTimes[mTimes.length - 1] = NO_TIME; 3763 break; 3764 } else if (mListeners[i] == null) { 3765 break; 3766 } 3767 } 3768 3769 scheduleNotification(NOTIFY_TIME, 0 /* delay */); 3770 } 3771 } 3772 3773 private synchronized void notifyTimedEvent(boolean refreshTime) { 3774 // figure out next callback 3775 long nowUs; 3776 try { 3777 nowUs = getCurrentTimeUs(refreshTime, true); 3778 } catch (IllegalStateException e) { 3779 // assume we paused until new player arrives 3780 mRefresh = true; 3781 mPausing = true; // this ensures that call succeeds 3782 nowUs = getCurrentTimeUs(refreshTime, true); 3783 } 3784 long nextTimeUs = nowUs; 3785 3786 if (mSeeking) { 3787 // skip timed-event notifications until seek is complete 3788 return; 3789 } 3790 3791 if (DEBUG) { 3792 StringBuilder sb = new StringBuilder(); 3793 sb.append("notifyTimedEvent(").append(mLastTimeUs).append(" -> ") 3794 .append(nowUs).append(") from {"); 3795 boolean first = true; 3796 for (long time: mTimes) { 3797 if (time == NO_TIME) { 3798 continue; 3799 } 3800 if (!first) sb.append(", "); 3801 sb.append(time); 3802 first = false; 3803 } 3804 sb.append("}"); 3805 Log.d(TAG, sb.toString()); 3806 } 3807 3808 Vector<MediaTimeProvider.OnMediaTimeListener> activatedListeners = 3809 new Vector<MediaTimeProvider.OnMediaTimeListener>(); 3810 for (int ix = 0; ix < mTimes.length; ix++) { 3811 if (mListeners[ix] == null) { 3812 break; 3813 } 3814 if (mTimes[ix] <= NO_TIME) { 3815 // ignore, unless we were stopped 3816 } else if (mTimes[ix] <= nowUs + MAX_EARLY_CALLBACK_US) { 3817 activatedListeners.add(mListeners[ix]); 3818 if (DEBUG) Log.d(TAG, "removed"); 3819 mTimes[ix] = NO_TIME; 3820 } else if (nextTimeUs == nowUs || mTimes[ix] < nextTimeUs) { 3821 nextTimeUs = mTimes[ix]; 3822 } 3823 } 3824 3825 if (nextTimeUs > nowUs && !mPaused) { 3826 // schedule callback at nextTimeUs 3827 if (DEBUG) Log.d(TAG, "scheduling for " + nextTimeUs + " and " + nowUs); 3828 scheduleNotification(NOTIFY_TIME, nextTimeUs - nowUs); 3829 } else { 3830 mEventHandler.removeMessages(NOTIFY); 3831 // no more callbacks 3832 } 3833 3834 for (MediaTimeProvider.OnMediaTimeListener listener: activatedListeners) { 3835 listener.onTimedEvent(nowUs); 3836 } 3837 } 3838 3839 private long getEstimatedTime(long nanoTime, boolean monotonic) { 3840 if (mPaused) { 3841 mLastReportedTime = mLastTimeUs + mTimeAdjustment; 3842 } else { 3843 long timeSinceRead = (nanoTime - mLastNanoTime) / 1000; 3844 mLastReportedTime = mLastTimeUs + timeSinceRead; 3845 if (mTimeAdjustment > 0) { 3846 long adjustment = 3847 mTimeAdjustment - timeSinceRead / TIME_ADJUSTMENT_RATE; 3848 if (adjustment <= 0) { 3849 mTimeAdjustment = 0; 3850 } else { 3851 mLastReportedTime += adjustment; 3852 } 3853 } 3854 } 3855 return mLastReportedTime; 3856 } 3857 3858 public long getCurrentTimeUs(boolean refreshTime, boolean monotonic) 3859 throws IllegalStateException { 3860 synchronized (this) { 3861 // we always refresh the time when the paused-state changes, because 3862 // we expect to have received the pause-change event delayed. 3863 if (mPaused && !refreshTime) { 3864 return mLastReportedTime; 3865 } 3866 3867 long nanoTime = System.nanoTime(); 3868 if (refreshTime || 3869 nanoTime >= mLastNanoTime + MAX_NS_WITHOUT_POSITION_CHECK) { 3870 try { 3871 mLastTimeUs = mPlayer.getCurrentPosition() * 1000L; 3872 mPaused = !mPlayer.isPlaying() || mBuffering; 3873 if (DEBUG) Log.v(TAG, (mPaused ? "paused" : "playing") + " at " + mLastTimeUs); 3874 } catch (IllegalStateException e) { 3875 if (mPausing) { 3876 // if we were pausing, get last estimated timestamp 3877 mPausing = false; 3878 getEstimatedTime(nanoTime, monotonic); 3879 mPaused = true; 3880 if (DEBUG) Log.d(TAG, "illegal state, but pausing: estimating at " + mLastReportedTime); 3881 return mLastReportedTime; 3882 } 3883 // TODO get time when prepared 3884 throw e; 3885 } 3886 mLastNanoTime = nanoTime; 3887 if (monotonic && mLastTimeUs < mLastReportedTime) { 3888 /* have to adjust time */ 3889 mTimeAdjustment = mLastReportedTime - mLastTimeUs; 3890 if (mTimeAdjustment > 1000000) { 3891 // schedule seeked event if time jumped significantly 3892 // TODO: do this properly by introducing an exception 3893 mStopped = false; 3894 mSeeking = true; 3895 scheduleNotification(NOTIFY_SEEK, 0 /* delay */); 3896 } 3897 } else { 3898 mTimeAdjustment = 0; 3899 } 3900 } 3901 3902 return getEstimatedTime(nanoTime, monotonic); 3903 } 3904 } 3905 3906 private class EventHandler extends Handler { 3907 public EventHandler(Looper looper) { 3908 super(looper); 3909 } 3910 3911 @Override 3912 public void handleMessage(Message msg) { 3913 if (msg.what == NOTIFY) { 3914 switch (msg.arg1) { 3915 case NOTIFY_TIME: 3916 notifyTimedEvent(false /* refreshTime */); 3917 break; 3918 case REFRESH_AND_NOTIFY_TIME: 3919 notifyTimedEvent(true /* refreshTime */); 3920 break; 3921 case NOTIFY_STOP: 3922 notifyStop(); 3923 break; 3924 case NOTIFY_SEEK: 3925 notifySeek(); 3926 break; 3927 case NOTIFY_TRACK_DATA: 3928 notifyTrackData((Pair<SubtitleTrack, byte[]>)msg.obj); 3929 break; 3930 } 3931 } 3932 } 3933 } 3934 } 3935} 3936