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