MediaPlayer.java revision 3e72eb5245a439525976dbb9a67280b9b26b9f14
1/*
2 * Copyright (C) 2006 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.media;
18
19import android.content.BroadcastReceiver;
20import android.content.ContentResolver;
21import android.content.Context;
22import android.content.Intent;
23import android.content.IntentFilter;
24import android.content.res.AssetFileDescriptor;
25import android.net.Proxy;
26import android.net.ProxyProperties;
27import android.net.Uri;
28import android.os.Handler;
29import android.os.Looper;
30import android.os.Message;
31import android.os.Parcel;
32import android.os.Parcelable;
33import android.os.ParcelFileDescriptor;
34import android.os.PowerManager;
35import android.util.Log;
36import android.view.Surface;
37import android.view.SurfaceHolder;
38import android.graphics.Bitmap;
39import android.graphics.SurfaceTexture;
40import android.media.AudioManager;
41
42import java.io.File;
43import java.io.FileDescriptor;
44import java.io.FileInputStream;
45import java.io.IOException;
46import java.net.InetSocketAddress;
47import java.util.Map;
48import java.util.Set;
49import java.lang.ref.WeakReference;
50
51/**
52 * MediaPlayer class can be used to control playback
53 * of audio/video files and streams. An example on how to use the methods in
54 * this class can be found in {@link android.widget.VideoView}.
55 *
56 * <p>Topics covered here are:
57 * <ol>
58 * <li><a href="#StateDiagram">State Diagram</a>
59 * <li><a href="#Valid_and_Invalid_States">Valid and Invalid States</a>
60 * <li><a href="#Permissions">Permissions</a>
61 * <li><a href="#Callbacks">Register informational and error callbacks</a>
62 * </ol>
63 *
64 * <div class="special reference">
65 * <h3>Developer Guides</h3>
66 * <p>For more information about how to use MediaPlayer, read the
67 * <a href="{@docRoot}guide/topics/media/mediaplayer.html">Media Playback</a> developer guide.</p>
68 * </div>
69 *
70 * <a name="StateDiagram"></a>
71 * <h3>State Diagram</h3>
72 *
73 * <p>Playback control of audio/video files and streams is managed as a state
74 * machine. The following diagram shows the life cycle and the states of a
75 * MediaPlayer object driven by the supported playback control operations.
76 * The ovals represent the states a MediaPlayer object may reside
77 * in. The arcs represent the playback control operations that drive the object
78 * state transition. There are two types of arcs. The arcs with a single arrow
79 * head represent synchronous method calls, while those with
80 * a double arrow head represent asynchronous method calls.</p>
81 *
82 * <p><img src="../../../images/mediaplayer_state_diagram.gif"
83 *         alt="MediaPlayer State diagram"
84 *         border="0" /></p>
85 *
86 * <p>From this state diagram, one can see that a MediaPlayer object has the
87 *    following states:</p>
88 * <ul>
89 *     <li>When a MediaPlayer object is just created using <code>new</code> or
90 *         after {@link #reset()} is called, it is in the <em>Idle</em> state; and after
91 *         {@link #release()} is called, it is in the <em>End</em> state. Between these
92 *         two states is the life cycle of the MediaPlayer object.
93 *         <ul>
94 *         <li>There is a subtle but important difference between a newly constructed
95 *         MediaPlayer object and the MediaPlayer object after {@link #reset()}
96 *         is called. It is a programming error to invoke methods such
97 *         as {@link #getCurrentPosition()},
98 *         {@link #getDuration()}, {@link #getVideoHeight()},
99 *         {@link #getVideoWidth()}, {@link #setAudioStreamType(int)},
100 *         {@link #setLooping(boolean)},
101 *         {@link #setVolume(float, float)}, {@link #pause()}, {@link #start()},
102 *         {@link #stop()}, {@link #seekTo(int)}, {@link #prepare()} or
103 *         {@link #prepareAsync()} in the <em>Idle</em> state for both cases. If any of these
104 *         methods is called right after a MediaPlayer object is constructed,
105 *         the user supplied callback method OnErrorListener.onError() won't be
106 *         called by the internal player engine and the object state remains
107 *         unchanged; but if these methods are called right after {@link #reset()},
108 *         the user supplied callback method OnErrorListener.onError() will be
109 *         invoked by the internal player engine and the object will be
110 *         transfered to the <em>Error</em> state. </li>
111 *         <li>It is also recommended that once
112 *         a MediaPlayer object is no longer being used, call {@link #release()} immediately
113 *         so that resources used by the internal player engine associated with the
114 *         MediaPlayer object can be released immediately. Resource may include
115 *         singleton resources such as hardware acceleration components and
116 *         failure to call {@link #release()} may cause subsequent instances of
117 *         MediaPlayer objects to fallback to software implementations or fail
118 *         altogether. Once the MediaPlayer
119 *         object is in the <em>End</em> state, it can no longer be used and
120 *         there is no way to bring it back to any other state. </li>
121 *         <li>Furthermore,
122 *         the MediaPlayer objects created using <code>new</code> is in the
123 *         <em>Idle</em> state, while those created with one
124 *         of the overloaded convenient <code>create</code> methods are <em>NOT</em>
125 *         in the <em>Idle</em> state. In fact, the objects are in the <em>Prepared</em>
126 *         state if the creation using <code>create</code> method is successful.
127 *         </li>
128 *         </ul>
129 *         </li>
130 *     <li>In general, some playback control operation may fail due to various
131 *         reasons, such as unsupported audio/video format, poorly interleaved
132 *         audio/video, resolution too high, streaming timeout, and the like.
133 *         Thus, error reporting and recovery is an important concern under
134 *         these circumstances. Sometimes, due to programming errors, invoking a playback
135 *         control operation in an invalid state may also occur. Under all these
136 *         error conditions, the internal player engine invokes a user supplied
137 *         OnErrorListener.onError() method if an OnErrorListener has been
138 *         registered beforehand via
139 *         {@link #setOnErrorListener(android.media.MediaPlayer.OnErrorListener)}.
140 *         <ul>
141 *         <li>It is important to note that once an error occurs, the
142 *         MediaPlayer object enters the <em>Error</em> state (except as noted
143 *         above), even if an error listener has not been registered by the application.</li>
144 *         <li>In order to reuse a MediaPlayer object that is in the <em>
145 *         Error</em> state and recover from the error,
146 *         {@link #reset()} can be called to restore the object to its <em>Idle</em>
147 *         state.</li>
148 *         <li>It is good programming practice to have your application
149 *         register a OnErrorListener to look out for error notifications from
150 *         the internal player engine.</li>
151 *         <li>IllegalStateException is
152 *         thrown to prevent programming errors such as calling {@link #prepare()},
153 *         {@link #prepareAsync()}, or one of the overloaded <code>setDataSource
154 *         </code> methods in an invalid state. </li>
155 *         </ul>
156 *         </li>
157 *     <li>Calling
158 *         {@link #setDataSource(FileDescriptor)}, or
159 *         {@link #setDataSource(String)}, or
160 *         {@link #setDataSource(Context, Uri)}, or
161 *         {@link #setDataSource(FileDescriptor, long, long)} transfers a
162 *         MediaPlayer object in the <em>Idle</em> state to the
163 *         <em>Initialized</em> state.
164 *         <ul>
165 *         <li>An IllegalStateException is thrown if
166 *         setDataSource() is called in any other state.</li>
167 *         <li>It is good programming
168 *         practice to always look out for <code>IllegalArgumentException</code>
169 *         and <code>IOException</code> that may be thrown from the overloaded
170 *         <code>setDataSource</code> methods.</li>
171 *         </ul>
172 *         </li>
173 *     <li>A MediaPlayer object must first enter the <em>Prepared</em> state
174 *         before playback can be started.
175 *         <ul>
176 *         <li>There are two ways (synchronous vs.
177 *         asynchronous) that the <em>Prepared</em> state can be reached:
178 *         either a call to {@link #prepare()} (synchronous) which
179 *         transfers the object to the <em>Prepared</em> state once the method call
180 *         returns, or a call to {@link #prepareAsync()} (asynchronous) which
181 *         first transfers the object to the <em>Preparing</em> state after the
182 *         call returns (which occurs almost right way) while the internal
183 *         player engine continues working on the rest of preparation work
184 *         until the preparation work completes. When the preparation completes or when {@link #prepare()} call returns,
185 *         the internal player engine then calls a user supplied callback method,
186 *         onPrepared() of the OnPreparedListener interface, if an
187 *         OnPreparedListener is registered beforehand via {@link
188 *         #setOnPreparedListener(android.media.MediaPlayer.OnPreparedListener)}.</li>
189 *         <li>It is important to note that
190 *         the <em>Preparing</em> state is a transient state, and the behavior
191 *         of calling any method with side effect while a MediaPlayer object is
192 *         in the <em>Preparing</em> state is undefined.</li>
193 *         <li>An IllegalStateException is
194 *         thrown if {@link #prepare()} or {@link #prepareAsync()} is called in
195 *         any other state.</li>
196 *         <li>While in the <em>Prepared</em> state, properties
197 *         such as audio/sound volume, screenOnWhilePlaying, looping can be
198 *         adjusted by invoking the corresponding set methods.</li>
199 *         </ul>
200 *         </li>
201 *     <li>To start the playback, {@link #start()} must be called. After
202 *         {@link #start()} returns successfully, the MediaPlayer object is in the
203 *         <em>Started</em> state. {@link #isPlaying()} can be called to test
204 *         whether the MediaPlayer object is in the <em>Started</em> state.
205 *         <ul>
206 *         <li>While in the <em>Started</em> state, the internal player engine calls
207 *         a user supplied OnBufferingUpdateListener.onBufferingUpdate() callback
208 *         method if a OnBufferingUpdateListener has been registered beforehand
209 *         via {@link #setOnBufferingUpdateListener(OnBufferingUpdateListener)}.
210 *         This callback allows applications to keep track of the buffering status
211 *         while streaming audio/video.</li>
212 *         <li>Calling {@link #start()} has not effect
213 *         on a MediaPlayer object that is already in the <em>Started</em> state.</li>
214 *         </ul>
215 *         </li>
216 *     <li>Playback can be paused and stopped, and the current playback position
217 *         can be adjusted. Playback can be paused via {@link #pause()}. When the call to
218 *         {@link #pause()} returns, the MediaPlayer object enters the
219 *         <em>Paused</em> state. Note that the transition from the <em>Started</em>
220 *         state to the <em>Paused</em> state and vice versa happens
221 *         asynchronously in the player engine. It may take some time before
222 *         the state is updated in calls to {@link #isPlaying()}, and it can be
223 *         a number of seconds in the case of streamed content.
224 *         <ul>
225 *         <li>Calling {@link #start()} to resume playback for a paused
226 *         MediaPlayer object, and the resumed playback
227 *         position is the same as where it was paused. When the call to
228 *         {@link #start()} returns, the paused MediaPlayer object goes back to
229 *         the <em>Started</em> state.</li>
230 *         <li>Calling {@link #pause()} has no effect on
231 *         a MediaPlayer object that is already in the <em>Paused</em> state.</li>
232 *         </ul>
233 *         </li>
234 *     <li>Calling  {@link #stop()} stops playback and causes a
235 *         MediaPlayer in the <em>Started</em>, <em>Paused</em>, <em>Prepared
236 *         </em> or <em>PlaybackCompleted</em> state to enter the
237 *         <em>Stopped</em> state.
238 *         <ul>
239 *         <li>Once in the <em>Stopped</em> state, playback cannot be started
240 *         until {@link #prepare()} or {@link #prepareAsync()} are called to set
241 *         the MediaPlayer object to the <em>Prepared</em> state again.</li>
242 *         <li>Calling {@link #stop()} has no effect on a MediaPlayer
243 *         object that is already in the <em>Stopped</em> state.</li>
244 *         </ul>
245 *         </li>
246 *     <li>The playback position can be adjusted with a call to
247 *         {@link #seekTo(int)}.
248 *         <ul>
249 *         <li>Although the asynchronuous {@link #seekTo(int)}
250 *         call returns right way, the actual seek operation may take a while to
251 *         finish, especially for audio/video being streamed. When the actual
252 *         seek operation completes, the internal player engine calls a user
253 *         supplied OnSeekComplete.onSeekComplete() if an OnSeekCompleteListener
254 *         has been registered beforehand via
255 *         {@link #setOnSeekCompleteListener(OnSeekCompleteListener)}.</li>
256 *         <li>Please
257 *         note that {@link #seekTo(int)} can also be called in the other states,
258 *         such as <em>Prepared</em>, <em>Paused</em> and <em>PlaybackCompleted
259 *         </em> state.</li>
260 *         <li>Furthermore, the actual current playback position
261 *         can be retrieved with a call to {@link #getCurrentPosition()}, which
262 *         is helpful for applications such as a Music player that need to keep
263 *         track of the playback progress.</li>
264 *         </ul>
265 *         </li>
266 *     <li>When the playback reaches the end of stream, the playback completes.
267 *         <ul>
268 *         <li>If the looping mode was being set to <var>true</var>with
269 *         {@link #setLooping(boolean)}, the MediaPlayer object shall remain in
270 *         the <em>Started</em> state.</li>
271 *         <li>If the looping mode was set to <var>false
272 *         </var>, the player engine calls a user supplied callback method,
273 *         OnCompletion.onCompletion(), if a OnCompletionListener is registered
274 *         beforehand via {@link #setOnCompletionListener(OnCompletionListener)}.
275 *         The invoke of the callback signals that the object is now in the <em>
276 *         PlaybackCompleted</em> state.</li>
277 *         <li>While in the <em>PlaybackCompleted</em>
278 *         state, calling {@link #start()} can restart the playback from the
279 *         beginning of the audio/video source.</li>
280 * </ul>
281 *
282 *
283 * <a name="Valid_and_Invalid_States"></a>
284 * <h3>Valid and invalid states</h3>
285 *
286 * <table border="0" cellspacing="0" cellpadding="0">
287 * <tr><td>Method Name </p></td>
288 *     <td>Valid Sates </p></td>
289 *     <td>Invalid States </p></td>
290 *     <td>Comments </p></td></tr>
291 * <tr><td>attachAuxEffect </p></td>
292 *     <td>{Initialized, Prepared, Started, Paused, Stopped, PlaybackCompleted} </p></td>
293 *     <td>{Idle, Error} </p></td>
294 *     <td>This method must be called after setDataSource.
295 *     Calling it does not change the object state. </p></td></tr>
296 * <tr><td>getAudioSessionId </p></td>
297 *     <td>any </p></td>
298 *     <td>{} </p></td>
299 *     <td>This method can be called in any state and calling it does not change
300 *         the object state. </p></td></tr>
301 * <tr><td>getCurrentPosition </p></td>
302 *     <td>{Idle, Initialized, Prepared, Started, Paused, Stopped,
303 *         PlaybackCompleted} </p></td>
304 *     <td>{Error}</p></td>
305 *     <td>Successful invoke of this method in a valid state does not change the
306 *         state. Calling this method in an invalid state transfers the object
307 *         to the <em>Error</em> state. </p></td></tr>
308 * <tr><td>getDuration </p></td>
309 *     <td>{Prepared, Started, Paused, Stopped, PlaybackCompleted} </p></td>
310 *     <td>{Idle, Initialized, Error} </p></td>
311 *     <td>Successful invoke of this method in a valid state does not change the
312 *         state. Calling this method in an invalid state transfers the object
313 *         to the <em>Error</em> state. </p></td></tr>
314 * <tr><td>getVideoHeight </p></td>
315 *     <td>{Idle, Initialized, Prepared, Started, Paused, Stopped,
316 *         PlaybackCompleted}</p></td>
317 *     <td>{Error}</p></td>
318 *     <td>Successful invoke of this method in a valid state does not change the
319 *         state. Calling this method in an invalid state transfers the object
320 *         to the <em>Error</em> state.  </p></td></tr>
321 * <tr><td>getVideoWidth </p></td>
322 *     <td>{Idle, Initialized, Prepared, Started, Paused, Stopped,
323 *         PlaybackCompleted}</p></td>
324 *     <td>{Error}</p></td>
325 *     <td>Successful invoke of this method in a valid state does not change
326 *         the state. Calling this method in an invalid state transfers the
327 *         object to the <em>Error</em> state. </p></td></tr>
328 * <tr><td>isPlaying </p></td>
329 *     <td>{Idle, Initialized, Prepared, Started, Paused, Stopped,
330 *          PlaybackCompleted}</p></td>
331 *     <td>{Error}</p></td>
332 *     <td>Successful invoke of this method in a valid state does not change
333 *         the state. Calling this method in an invalid state transfers the
334 *         object to the <em>Error</em> state. </p></td></tr>
335 * <tr><td>pause </p></td>
336 *     <td>{Started, Paused, PlaybackCompleted}</p></td>
337 *     <td>{Idle, Initialized, Prepared, Stopped, Error}</p></td>
338 *     <td>Successful invoke of this method in a valid state transfers the
339 *         object to the <em>Paused</em> state. Calling this method in an
340 *         invalid state transfers the object to the <em>Error</em> state.</p></td></tr>
341 * <tr><td>prepare </p></td>
342 *     <td>{Initialized, Stopped} </p></td>
343 *     <td>{Idle, Prepared, Started, Paused, PlaybackCompleted, Error} </p></td>
344 *     <td>Successful invoke of this method in a valid state transfers the
345 *         object to the <em>Prepared</em> state. Calling this method in an
346 *         invalid state throws an IllegalStateException.</p></td></tr>
347 * <tr><td>prepareAsync </p></td>
348 *     <td>{Initialized, Stopped} </p></td>
349 *     <td>{Idle, Prepared, Started, Paused, PlaybackCompleted, Error} </p></td>
350 *     <td>Successful invoke of this method in a valid state transfers the
351 *         object to the <em>Preparing</em> state. Calling this method in an
352 *         invalid state throws an IllegalStateException.</p></td></tr>
353 * <tr><td>release </p></td>
354 *     <td>any </p></td>
355 *     <td>{} </p></td>
356 *     <td>After {@link #release()}, the object is no longer available. </p></td></tr>
357 * <tr><td>reset </p></td>
358 *     <td>{Idle, Initialized, Prepared, Started, Paused, Stopped,
359 *         PlaybackCompleted, Error}</p></td>
360 *     <td>{}</p></td>
361 *     <td>After {@link #reset()}, the object is like being just created.</p></td></tr>
362 * <tr><td>seekTo </p></td>
363 *     <td>{Prepared, Started, Paused, PlaybackCompleted} </p></td>
364 *     <td>{Idle, Initialized, Stopped, Error}</p></td>
365 *     <td>Successful invoke of this method in a valid state does not change
366 *         the state. Calling this method in an invalid state transfers the
367 *         object to the <em>Error</em> state. </p></td></tr>
368 * <tr><td>setAudioSessionId </p></td>
369 *     <td>{Idle} </p></td>
370 *     <td>{Initialized, Prepared, Started, Paused, Stopped, PlaybackCompleted,
371 *          Error} </p></td>
372 *     <td>This method must be called in idle state as the audio session ID must be known before
373 *         calling setDataSource. Calling it does not change the object state. </p></td></tr>
374 * <tr><td>setAudioStreamType </p></td>
375 *     <td>{Idle, Initialized, Stopped, Prepared, Started, Paused,
376 *          PlaybackCompleted}</p></td>
377 *     <td>{Error}</p></td>
378 *     <td>Successful invoke of this method does not change the state. In order for the
379 *         target audio stream type to become effective, this method must be called before
380 *         prepare() or prepareAsync().</p></td></tr>
381 * <tr><td>setAuxEffectSendLevel </p></td>
382 *     <td>any</p></td>
383 *     <td>{} </p></td>
384 *     <td>Calling this method does not change the object state. </p></td></tr>
385 * <tr><td>setDataSource </p></td>
386 *     <td>{Idle} </p></td>
387 *     <td>{Initialized, Prepared, Started, Paused, Stopped, PlaybackCompleted,
388 *          Error} </p></td>
389 *     <td>Successful invoke of this method in a valid state transfers the
390 *         object to the <em>Initialized</em> state. Calling this method in an
391 *         invalid state throws an IllegalStateException.</p></td></tr>
392 * <tr><td>setDisplay </p></td>
393 *     <td>any </p></td>
394 *     <td>{} </p></td>
395 *     <td>This method can be called in any state and calling it does not change
396 *         the object state. </p></td></tr>
397 * <tr><td>setSurface </p></td>
398 *     <td>any </p></td>
399 *     <td>{} </p></td>
400 *     <td>This method can be called in any state and calling it does not change
401 *         the object state. </p></td></tr>
402 * <tr><td>setVideoScalingMode </p></td>
403 *     <td>{Initialized, Prepared, Started, Paused, Stopped, PlaybackCompleted} </p></td>
404 *     <td>{Idle, Error}</p></td>
405 *     <td>Successful invoke of this method does not change the state.</p></td></tr>
406 * <tr><td>setLooping </p></td>
407 *     <td>{Idle, Initialized, Stopped, Prepared, Started, Paused,
408 *         PlaybackCompleted}</p></td>
409 *     <td>{Error}</p></td>
410 *     <td>Successful invoke of this method in a valid state does not change
411 *         the state. Calling this method in an
412 *         invalid state transfers the object to the <em>Error</em> state.</p></td></tr>
413 * <tr><td>isLooping </p></td>
414 *     <td>any </p></td>
415 *     <td>{} </p></td>
416 *     <td>This method can be called in any state and calling it does not change
417 *         the object state. </p></td></tr>
418 * <tr><td>setOnBufferingUpdateListener </p></td>
419 *     <td>any </p></td>
420 *     <td>{} </p></td>
421 *     <td>This method can be called in any state and calling it does not change
422 *         the object state. </p></td></tr>
423 * <tr><td>setOnCompletionListener </p></td>
424 *     <td>any </p></td>
425 *     <td>{} </p></td>
426 *     <td>This method can be called in any state and calling it does not change
427 *         the object state. </p></td></tr>
428 * <tr><td>setOnErrorListener </p></td>
429 *     <td>any </p></td>
430 *     <td>{} </p></td>
431 *     <td>This method can be called in any state and calling it does not change
432 *         the object state. </p></td></tr>
433 * <tr><td>setOnPreparedListener </p></td>
434 *     <td>any </p></td>
435 *     <td>{} </p></td>
436 *     <td>This method can be called in any state and calling it does not change
437 *         the object state. </p></td></tr>
438 * <tr><td>setOnSeekCompleteListener </p></td>
439 *     <td>any </p></td>
440 *     <td>{} </p></td>
441 *     <td>This method can be called in any state and calling it does not change
442 *         the object state. </p></td></tr>
443 * <tr><td>setScreenOnWhilePlaying</></td>
444 *     <td>any </p></td>
445 *     <td>{} </p></td>
446 *     <td>This method can be called in any state and calling it does not change
447 *         the object state.  </p></td></tr>
448 * <tr><td>setVolume </p></td>
449 *     <td>{Idle, Initialized, Stopped, Prepared, Started, Paused,
450 *          PlaybackCompleted}</p></td>
451 *     <td>{Error}</p></td>
452 *     <td>Successful invoke of this method does not change the state.
453 * <tr><td>setWakeMode </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>start </p></td>
459 *     <td>{Prepared, Started, Paused, PlaybackCompleted}</p></td>
460 *     <td>{Idle, Initialized, Stopped, Error}</p></td>
461 *     <td>Successful invoke of this method in a valid state transfers the
462 *         object to the <em>Started</em> state. Calling this method in an
463 *         invalid state transfers the object to the <em>Error</em> state.</p></td></tr>
464 * <tr><td>stop </p></td>
465 *     <td>{Prepared, Started, Stopped, Paused, PlaybackCompleted}</p></td>
466 *     <td>{Idle, Initialized, Error}</p></td>
467 *     <td>Successful invoke of this method in a valid state transfers the
468 *         object to the <em>Stopped</em> state. Calling this method in an
469 *         invalid state transfers the object to the <em>Error</em> state.</p></td></tr>
470 * <tr><td>getTrackInfo </p></td>
471 *     <td>{Prepared, Started, Stopped, Paused, PlaybackCompleted}</p></td>
472 *     <td>{Idle, Initialized, Error}</p></td>
473 *     <td>Successful invoke of this method does not change the state.</p></td></tr>
474 * <tr><td>addTimedTextSource </p></td>
475 *     <td>{Prepared, Started, Stopped, Paused, PlaybackCompleted}</p></td>
476 *     <td>{Idle, Initialized, Error}</p></td>
477 *     <td>Successful invoke of this method does not change the state.</p></td></tr>
478 * <tr><td>selectTrack </p></td>
479 *     <td>{Prepared, Started, Stopped, Paused, PlaybackCompleted}</p></td>
480 *     <td>{Idle, Initialized, Error}</p></td>
481 *     <td>Successful invoke of this method does not change the state.</p></td></tr>
482 * <tr><td>deselectTrack </p></td>
483 *     <td>{Prepared, Started, Stopped, Paused, PlaybackCompleted}</p></td>
484 *     <td>{Idle, Initialized, Error}</p></td>
485 *     <td>Successful invoke of this method does not change the state.</p></td></tr>
486 *
487 * </table>
488 *
489 * <a name="Permissions"></a>
490 * <h3>Permissions</h3>
491 * <p>One may need to declare a corresponding WAKE_LOCK permission {@link
492 * android.R.styleable#AndroidManifestUsesPermission &lt;uses-permission&gt;}
493 * element.
494 *
495 * <p>This class requires the {@link android.Manifest.permission#INTERNET} permission
496 * when used with network-based content.
497 *
498 * <a name="Callbacks"></a>
499 * <h3>Callbacks</h3>
500 * <p>Applications may want to register for informational and error
501 * events in order to be informed of some internal state update and
502 * possible runtime errors during playback or streaming. Registration for
503 * these events is done by properly setting the appropriate listeners (via calls
504 * to
505 * {@link #setOnPreparedListener(OnPreparedListener)}setOnPreparedListener,
506 * {@link #setOnVideoSizeChangedListener(OnVideoSizeChangedListener)}setOnVideoSizeChangedListener,
507 * {@link #setOnSeekCompleteListener(OnSeekCompleteListener)}setOnSeekCompleteListener,
508 * {@link #setOnCompletionListener(OnCompletionListener)}setOnCompletionListener,
509 * {@link #setOnBufferingUpdateListener(OnBufferingUpdateListener)}setOnBufferingUpdateListener,
510 * {@link #setOnInfoListener(OnInfoListener)}setOnInfoListener,
511 * {@link #setOnErrorListener(OnErrorListener)}setOnErrorListener, etc).
512 * In order to receive the respective callback
513 * associated with these listeners, applications are required to create
514 * MediaPlayer objects on a thread with its own Looper running (main UI
515 * thread by default has a Looper running).
516 *
517 */
518public class MediaPlayer
519{
520    /**
521       Constant to retrieve only the new metadata since the last
522       call.
523       // FIXME: unhide.
524       // FIXME: add link to getMetadata(boolean, boolean)
525       {@hide}
526     */
527    public static final boolean METADATA_UPDATE_ONLY = true;
528
529    /**
530       Constant to retrieve all the metadata.
531       // FIXME: unhide.
532       // FIXME: add link to getMetadata(boolean, boolean)
533       {@hide}
534     */
535    public static final boolean METADATA_ALL = false;
536
537    /**
538       Constant to enable the metadata filter during retrieval.
539       // FIXME: unhide.
540       // FIXME: add link to getMetadata(boolean, boolean)
541       {@hide}
542     */
543    public static final boolean APPLY_METADATA_FILTER = true;
544
545    /**
546       Constant to disable the metadata filter during retrieval.
547       // FIXME: unhide.
548       // FIXME: add link to getMetadata(boolean, boolean)
549       {@hide}
550     */
551    public static final boolean BYPASS_METADATA_FILTER = false;
552
553    static {
554        System.loadLibrary("media_jni");
555        native_init();
556    }
557
558    private final static String TAG = "MediaPlayer";
559    // Name of the remote interface for the media player. Must be kept
560    // in sync with the 2nd parameter of the IMPLEMENT_META_INTERFACE
561    // macro invocation in IMediaPlayer.cpp
562    private final static String IMEDIA_PLAYER = "android.media.IMediaPlayer";
563
564    private int mNativeContext; // accessed by native methods
565    private int mNativeSurfaceTexture;  // accessed by native methods
566    private int mListenerContext; // accessed by native methods
567    private SurfaceHolder mSurfaceHolder;
568    private EventHandler mEventHandler;
569    private PowerManager.WakeLock mWakeLock = null;
570    private boolean mScreenOnWhilePlaying;
571    private boolean mStayAwake;
572
573    /**
574     * Default constructor. Consider using one of the create() methods for
575     * synchronously instantiating a MediaPlayer from a Uri or resource.
576     * <p>When done with the MediaPlayer, you should call  {@link #release()},
577     * to free the resources. If not released, too many MediaPlayer instances may
578     * result in an exception.</p>
579     */
580    public MediaPlayer() {
581
582        Looper looper;
583        if ((looper = Looper.myLooper()) != null) {
584            mEventHandler = new EventHandler(this, looper);
585        } else if ((looper = Looper.getMainLooper()) != null) {
586            mEventHandler = new EventHandler(this, looper);
587        } else {
588            mEventHandler = null;
589        }
590
591        /* Native setup requires a weak reference to our object.
592         * It's easier to create it here than in C++.
593         */
594        native_setup(new WeakReference<MediaPlayer>(this));
595    }
596
597    /*
598     * Update the MediaPlayer SurfaceTexture.
599     * Call after setting a new display surface.
600     */
601    private native void _setVideoSurface(Surface surface);
602
603    /* Do not change these values (starting with INVOKE_ID) without updating
604     * their counterparts in include/media/mediaplayer.h!
605     */
606    private static final int INVOKE_ID_GET_TRACK_INFO = 1;
607    private static final int INVOKE_ID_ADD_EXTERNAL_SOURCE = 2;
608    private static final int INVOKE_ID_ADD_EXTERNAL_SOURCE_FD = 3;
609    private static final int INVOKE_ID_SELECT_TRACK = 4;
610    private static final int INVOKE_ID_DESELECT_TRACK = 5;
611    private static final int INVOKE_ID_SET_VIDEO_SCALE_MODE = 6;
612
613    /**
614     * Create a request parcel which can be routed to the native media
615     * player using {@link #invoke(Parcel, Parcel)}. The Parcel
616     * returned has the proper InterfaceToken set. The caller should
617     * not overwrite that token, i.e it can only append data to the
618     * Parcel.
619     *
620     * @return A parcel suitable to hold a request for the native
621     * player.
622     */
623    private Parcel newRequest() {
624        Parcel parcel = Parcel.obtain();
625        parcel.writeInterfaceToken(IMEDIA_PLAYER);
626        return parcel;
627    }
628
629    /**
630     * Invoke a generic method on the native player using opaque
631     * parcels for the request and reply. Both payloads' format is a
632     * convention between the java caller and the native player.
633     * Must be called after setDataSource to make sure a native player
634     * exists. On failure, a RuntimeException is thrown.
635     *
636     * @param request Parcel with the data for the extension. The
637     * caller must use {@link #newRequest()} to get one.
638     *
639     * @param reply Output parcel with the data returned by the
640     * native player.
641     */
642    private void invoke(Parcel request, Parcel reply) {
643        int retcode = native_invoke(request, reply);
644        reply.setDataPosition(0);
645        if (retcode != 0) {
646            throw new RuntimeException("failure code: " + retcode);
647        }
648    }
649
650    /**
651     * Sets the {@link SurfaceHolder} to use for displaying the video
652     * portion of the media.
653     *
654     * Either a surface holder or surface must be set if a display or video sink
655     * is needed.  Not calling this method or {@link #setSurface(Surface)}
656     * when playing back a video will result in only the audio track being played.
657     * A null surface holder or surface will result in only the audio track being
658     * played.
659     *
660     * @param sh the SurfaceHolder to use for video display
661     */
662    public void setDisplay(SurfaceHolder sh) {
663        mSurfaceHolder = sh;
664        Surface surface;
665        if (sh != null) {
666            surface = sh.getSurface();
667        } else {
668            surface = null;
669        }
670        _setVideoSurface(surface);
671        updateSurfaceScreenOn();
672    }
673
674    /**
675     * Sets the {@link Surface} to be used as the sink for the video portion of
676     * the media. This is similar to {@link #setDisplay(SurfaceHolder)}, but
677     * does not support {@link #setScreenOnWhilePlaying(boolean)}.  Setting a
678     * Surface will un-set any Surface or SurfaceHolder that was previously set.
679     * A null surface will result in only the audio track being played.
680     *
681     * If the Surface sends frames to a {@link SurfaceTexture}, the timestamps
682     * returned from {@link SurfaceTexture#getTimestamp()} will have an
683     * unspecified zero point.  These timestamps cannot be directly compared
684     * between different media sources, different instances of the same media
685     * source, or multiple runs of the same program.  The timestamp is normally
686     * monotonically increasing and is unaffected by time-of-day adjustments,
687     * but it is reset when the position is set.
688     *
689     * @param surface The {@link Surface} to be used for the video portion of
690     * the media.
691     */
692    public void setSurface(Surface surface) {
693        if (mScreenOnWhilePlaying && surface != null) {
694            Log.w(TAG, "setScreenOnWhilePlaying(true) is ineffective for Surface");
695        }
696        mSurfaceHolder = null;
697        _setVideoSurface(surface);
698        updateSurfaceScreenOn();
699    }
700
701    /* Do not change these video scaling mode values below without updating
702     * their counterparts in system/window.h! Please do not forget to update
703     * {@link #isVideoScalingModeSupported} when new video scaling modes
704     * are added.
705     */
706    /**
707     * Specifies a video scaling mode. The content is stretched to the
708     * surface rendering area. When the surface has the same aspect ratio
709     * as the content, the aspect ratio of the content is maintained;
710     * otherwise, the aspect ratio of the content is not maintained when video
711     * is being rendered. Unlike {@link #VIDEO_SCALING_MODE_SCALE_TO_FIT_WITH_CROPPING},
712     * there is no content cropping with this video scaling mode.
713     */
714    public static final int VIDEO_SCALING_MODE_SCALE_TO_FIT = 1;
715
716    /**
717     * Specifies a video scaling mode. The content is scaled, maintaining
718     * its aspect ratio. The whole surface area is always used. When the
719     * aspect ratio of the content is the same as the surface, no content
720     * is cropped; otherwise, content is cropped to fit the surface.
721     */
722    public static final int VIDEO_SCALING_MODE_SCALE_TO_FIT_WITH_CROPPING = 2;
723    /**
724     * Sets video scaling mode. To make the target video scaling mode
725     * effective during playback, this method must be called after
726     * data source is set. If not called, the default video
727     * scaling mode is {@link #VIDEO_SCALING_MODE_SCALE_TO_FIT}.
728     *
729     * <p> The supported video scaling modes are:
730     * <ul>
731     * <li> {@link #VIDEO_SCALING_MODE_SCALE_TO_FIT}
732     * <li> {@link #VIDEO_SCALING_MODE_SCALE_TO_FIT_WITH_CROPPING}
733     * </ul>
734     *
735     * @param mode target video scaling mode. Most be one of the supported
736     * video scaling modes; otherwise, IllegalArgumentException will be thrown.
737     *
738     * @see MediaPlayer#VIDEO_SCALING_MODE_SCALE_TO_FIT
739     * @see MediaPlayer#VIDEO_SCALING_MODE_SCALE_TO_FIT_WITH_CROPPING
740     */
741    public void setVideoScalingMode(int mode) {
742        if (!isVideoScalingModeSupported(mode)) {
743            final String msg = "Scaling mode " + mode + " is not supported";
744            throw new IllegalArgumentException(msg);
745        }
746        Parcel request = Parcel.obtain();
747        Parcel reply = Parcel.obtain();
748        try {
749            request.writeInterfaceToken(IMEDIA_PLAYER);
750            request.writeInt(INVOKE_ID_SET_VIDEO_SCALE_MODE);
751            request.writeInt(mode);
752            invoke(request, reply);
753        } finally {
754            request.recycle();
755            reply.recycle();
756        }
757    }
758
759    /**
760     * Convenience method to create a MediaPlayer for a given Uri.
761     * On success, {@link #prepare()} will already have been called and must not be called again.
762     * <p>When done with the MediaPlayer, you should call  {@link #release()},
763     * to free the resources. If not released, too many MediaPlayer instances will
764     * result in an exception.</p>
765     *
766     * @param context the Context to use
767     * @param uri the Uri from which to get the datasource
768     * @return a MediaPlayer object, or null if creation failed
769     */
770    public static MediaPlayer create(Context context, Uri uri) {
771        return create (context, uri, null);
772    }
773
774    /**
775     * Convenience method to create a MediaPlayer for a given Uri.
776     * On success, {@link #prepare()} will already have been called and must not be called again.
777     * <p>When done with the MediaPlayer, you should call  {@link #release()},
778     * to free the resources. If not released, too many MediaPlayer instances will
779     * result in an exception.</p>
780     *
781     * @param context the Context to use
782     * @param uri the Uri from which to get the datasource
783     * @param holder the SurfaceHolder to use for displaying the video
784     * @return a MediaPlayer object, or null if creation failed
785     */
786    public static MediaPlayer create(Context context, Uri uri, SurfaceHolder holder) {
787
788        try {
789            MediaPlayer mp = new MediaPlayer();
790            mp.setDataSource(context, uri);
791            if (holder != null) {
792                mp.setDisplay(holder);
793            }
794            mp.prepare();
795            return mp;
796        } catch (IOException ex) {
797            Log.d(TAG, "create failed:", ex);
798            // fall through
799        } catch (IllegalArgumentException ex) {
800            Log.d(TAG, "create failed:", ex);
801            // fall through
802        } catch (SecurityException ex) {
803            Log.d(TAG, "create failed:", ex);
804            // fall through
805        }
806
807        return null;
808    }
809
810    // Note no convenience method to create a MediaPlayer with SurfaceTexture sink.
811
812    /**
813     * Convenience method to create a MediaPlayer for a given resource id.
814     * On success, {@link #prepare()} will already have been called and must not be called again.
815     * <p>When done with the MediaPlayer, you should call  {@link #release()},
816     * to free the resources. If not released, too many MediaPlayer instances will
817     * result in an exception.</p>
818     *
819     * @param context the Context to use
820     * @param resid the raw resource id (<var>R.raw.&lt;something></var>) for
821     *              the resource to use as the datasource
822     * @return a MediaPlayer object, or null if creation failed
823     */
824    public static MediaPlayer create(Context context, int resid) {
825        try {
826            AssetFileDescriptor afd = context.getResources().openRawResourceFd(resid);
827            if (afd == null) return null;
828
829            MediaPlayer mp = new MediaPlayer();
830            mp.setDataSource(afd.getFileDescriptor(), afd.getStartOffset(), afd.getLength());
831            afd.close();
832            mp.prepare();
833            return mp;
834        } catch (IOException ex) {
835            Log.d(TAG, "create failed:", ex);
836            // fall through
837        } catch (IllegalArgumentException ex) {
838            Log.d(TAG, "create failed:", ex);
839           // fall through
840        } catch (SecurityException ex) {
841            Log.d(TAG, "create failed:", ex);
842            // fall through
843        }
844        return null;
845    }
846
847    /**
848     * Sets the data source as a content Uri.
849     *
850     * @param context the Context to use when resolving the Uri
851     * @param uri the Content URI of the data you want to play
852     * @throws IllegalStateException if it is called in an invalid state
853     */
854    public void setDataSource(Context context, Uri uri)
855        throws IOException, IllegalArgumentException, SecurityException, IllegalStateException {
856        setDataSource(context, uri, null);
857    }
858
859    /**
860     * Sets the data source as a content Uri.
861     *
862     * @param context the Context to use when resolving the Uri
863     * @param uri the Content URI of the data you want to play
864     * @param headers the headers to be sent together with the request for the data
865     * @throws IllegalStateException if it is called in an invalid state
866     */
867    public void setDataSource(Context context, Uri uri, Map<String, String> headers)
868        throws IOException, IllegalArgumentException, SecurityException, IllegalStateException {
869        disableProxyListener();
870
871        String scheme = uri.getScheme();
872        if(scheme == null || scheme.equals("file")) {
873            setDataSource(uri.getPath());
874            return;
875        }
876
877        AssetFileDescriptor fd = null;
878        try {
879            ContentResolver resolver = context.getContentResolver();
880            fd = resolver.openAssetFileDescriptor(uri, "r");
881            if (fd == null) {
882                return;
883            }
884            // Note: using getDeclaredLength so that our behavior is the same
885            // as previous versions when the content provider is returning
886            // a full file.
887            if (fd.getDeclaredLength() < 0) {
888                setDataSource(fd.getFileDescriptor());
889            } else {
890                setDataSource(fd.getFileDescriptor(), fd.getStartOffset(), fd.getDeclaredLength());
891            }
892            return;
893        } catch (SecurityException ex) {
894        } catch (IOException ex) {
895        } finally {
896            if (fd != null) {
897                fd.close();
898            }
899        }
900
901        Log.d(TAG, "Couldn't open file on client side, trying server side");
902
903        setDataSource(uri.toString(), headers);
904
905        if (scheme.equalsIgnoreCase("http")
906                || scheme.equalsIgnoreCase("https")) {
907            setupProxyListener(context);
908        }
909    }
910
911    /**
912     * Sets the data source (file-path or http/rtsp URL) to use.
913     *
914     * @param path the path of the file, or the http/rtsp URL of the stream you want to play
915     * @throws IllegalStateException if it is called in an invalid state
916     *
917     * <p>When <code>path</code> refers to a local file, the file may actually be opened by a
918     * process other than the calling application.  This implies that the pathname
919     * should be an absolute path (as any other process runs with unspecified current working
920     * directory), and that the pathname should reference a world-readable file.
921     * As an alternative, the application could first open the file for reading,
922     * and then use the file descriptor form {@link #setDataSource(FileDescriptor)}.
923     */
924    public void setDataSource(String path)
925            throws IOException, IllegalArgumentException, SecurityException, IllegalStateException {
926        setDataSource(path, null, null);
927    }
928
929    /**
930     * Sets the data source (file-path or http/rtsp URL) to use.
931     *
932     * @param path the path of the file, or the http/rtsp URL of the stream you want to play
933     * @param headers the headers associated with the http request for the stream you want to play
934     * @throws IllegalStateException if it is called in an invalid state
935     * @hide pending API council
936     */
937    public void setDataSource(String path, Map<String, String> headers)
938            throws IOException, IllegalArgumentException, SecurityException, IllegalStateException
939    {
940        String[] keys = null;
941        String[] values = null;
942
943        if (headers != null) {
944            keys = new String[headers.size()];
945            values = new String[headers.size()];
946
947            int i = 0;
948            for (Map.Entry<String, String> entry: headers.entrySet()) {
949                keys[i] = entry.getKey();
950                values[i] = entry.getValue();
951                ++i;
952            }
953        }
954        setDataSource(path, keys, values);
955    }
956
957    private void setDataSource(String path, String[] keys, String[] values)
958            throws IOException, IllegalArgumentException, SecurityException, IllegalStateException {
959        disableProxyListener();
960
961        final Uri uri = Uri.parse(path);
962        if ("file".equals(uri.getScheme())) {
963            path = uri.getPath();
964        }
965
966        final File file = new File(path);
967        if (file.exists()) {
968            FileInputStream is = new FileInputStream(file);
969            FileDescriptor fd = is.getFD();
970            setDataSource(fd);
971            is.close();
972        } else {
973            _setDataSource(path, keys, values);
974        }
975    }
976
977    private native void _setDataSource(
978        String path, String[] keys, String[] values)
979        throws IOException, IllegalArgumentException, SecurityException, IllegalStateException;
980
981    /**
982     * Sets the data source (FileDescriptor) to use. It is the caller's responsibility
983     * to close the file descriptor. It is safe to do so as soon as this call returns.
984     *
985     * @param fd the FileDescriptor for the file you want to play
986     * @throws IllegalStateException if it is called in an invalid state
987     */
988    public void setDataSource(FileDescriptor fd)
989            throws IOException, IllegalArgumentException, IllegalStateException {
990        // intentionally less than LONG_MAX
991        setDataSource(fd, 0, 0x7ffffffffffffffL);
992    }
993
994    /**
995     * Sets the data source (FileDescriptor) to use.  The FileDescriptor must be
996     * seekable (N.B. a LocalSocket is not seekable). It is the caller's responsibility
997     * to close the file descriptor. It is safe to do so as soon as this call returns.
998     *
999     * @param fd the FileDescriptor for the file you want to play
1000     * @param offset the offset into the file where the data to be played starts, in bytes
1001     * @param length the length in bytes of the data to be played
1002     * @throws IllegalStateException if it is called in an invalid state
1003     */
1004    public void setDataSource(FileDescriptor fd, long offset, long length)
1005            throws IOException, IllegalArgumentException, IllegalStateException {
1006        disableProxyListener();
1007        _setDataSource(fd, offset, length);
1008    }
1009
1010    private native void _setDataSource(FileDescriptor fd, long offset, long length)
1011            throws IOException, IllegalArgumentException, IllegalStateException;
1012
1013    /**
1014     * Prepares the player for playback, synchronously.
1015     *
1016     * After setting the datasource and the display surface, you need to either
1017     * call prepare() or prepareAsync(). For files, it is OK to call prepare(),
1018     * which blocks until MediaPlayer is ready for playback.
1019     *
1020     * @throws IllegalStateException if it is called in an invalid state
1021     */
1022    public native void prepare() throws IOException, IllegalStateException;
1023
1024    /**
1025     * Prepares the player for playback, asynchronously.
1026     *
1027     * After setting the datasource and the display surface, you need to either
1028     * call prepare() or prepareAsync(). For streams, you should call prepareAsync(),
1029     * which returns immediately, rather than blocking until enough data has been
1030     * buffered.
1031     *
1032     * @throws IllegalStateException if it is called in an invalid state
1033     */
1034    public native void prepareAsync() throws IllegalStateException;
1035
1036    /**
1037     * Starts or resumes playback. If playback had previously been paused,
1038     * playback will continue from where it was paused. If playback had
1039     * been stopped, or never started before, playback will start at the
1040     * beginning.
1041     *
1042     * @throws IllegalStateException if it is called in an invalid state
1043     */
1044    public  void start() throws IllegalStateException {
1045        stayAwake(true);
1046        _start();
1047    }
1048
1049    private native void _start() throws IllegalStateException;
1050
1051    /**
1052     * Stops playback after playback has been stopped or paused.
1053     *
1054     * @throws IllegalStateException if the internal player engine has not been
1055     * initialized.
1056     */
1057    public void stop() throws IllegalStateException {
1058        stayAwake(false);
1059        _stop();
1060    }
1061
1062    private native void _stop() throws IllegalStateException;
1063
1064    /**
1065     * Pauses playback. Call start() to resume.
1066     *
1067     * @throws IllegalStateException if the internal player engine has not been
1068     * initialized.
1069     */
1070    public void pause() throws IllegalStateException {
1071        stayAwake(false);
1072        _pause();
1073    }
1074
1075    private native void _pause() throws IllegalStateException;
1076
1077    /**
1078     * Set the low-level power management behavior for this MediaPlayer.  This
1079     * can be used when the MediaPlayer is not playing through a SurfaceHolder
1080     * set with {@link #setDisplay(SurfaceHolder)} and thus can use the
1081     * high-level {@link #setScreenOnWhilePlaying(boolean)} feature.
1082     *
1083     * <p>This function has the MediaPlayer access the low-level power manager
1084     * service to control the device's power usage while playing is occurring.
1085     * The parameter is a combination of {@link android.os.PowerManager} wake flags.
1086     * Use of this method requires {@link android.Manifest.permission#WAKE_LOCK}
1087     * permission.
1088     * By default, no attempt is made to keep the device awake during playback.
1089     *
1090     * @param context the Context to use
1091     * @param mode    the power/wake mode to set
1092     * @see android.os.PowerManager
1093     */
1094    public void setWakeMode(Context context, int mode) {
1095        boolean washeld = false;
1096        if (mWakeLock != null) {
1097            if (mWakeLock.isHeld()) {
1098                washeld = true;
1099                mWakeLock.release();
1100            }
1101            mWakeLock = null;
1102        }
1103
1104        PowerManager pm = (PowerManager)context.getSystemService(Context.POWER_SERVICE);
1105        mWakeLock = pm.newWakeLock(mode|PowerManager.ON_AFTER_RELEASE, MediaPlayer.class.getName());
1106        mWakeLock.setReferenceCounted(false);
1107        if (washeld) {
1108            mWakeLock.acquire();
1109        }
1110    }
1111
1112    /**
1113     * Control whether we should use the attached SurfaceHolder to keep the
1114     * screen on while video playback is occurring.  This is the preferred
1115     * method over {@link #setWakeMode} where possible, since it doesn't
1116     * require that the application have permission for low-level wake lock
1117     * access.
1118     *
1119     * @param screenOn Supply true to keep the screen on, false to allow it
1120     * to turn off.
1121     */
1122    public void setScreenOnWhilePlaying(boolean screenOn) {
1123        if (mScreenOnWhilePlaying != screenOn) {
1124            if (screenOn && mSurfaceHolder == null) {
1125                Log.w(TAG, "setScreenOnWhilePlaying(true) is ineffective without a SurfaceHolder");
1126            }
1127            mScreenOnWhilePlaying = screenOn;
1128            updateSurfaceScreenOn();
1129        }
1130    }
1131
1132    private void stayAwake(boolean awake) {
1133        if (mWakeLock != null) {
1134            if (awake && !mWakeLock.isHeld()) {
1135                mWakeLock.acquire();
1136            } else if (!awake && mWakeLock.isHeld()) {
1137                mWakeLock.release();
1138            }
1139        }
1140        mStayAwake = awake;
1141        updateSurfaceScreenOn();
1142    }
1143
1144    private void updateSurfaceScreenOn() {
1145        if (mSurfaceHolder != null) {
1146            mSurfaceHolder.setKeepScreenOn(mScreenOnWhilePlaying && mStayAwake);
1147        }
1148    }
1149
1150    /**
1151     * Returns the width of the video.
1152     *
1153     * @return the width of the video, or 0 if there is no video,
1154     * no display surface was set, or the width has not been determined
1155     * yet. The OnVideoSizeChangedListener can be registered via
1156     * {@link #setOnVideoSizeChangedListener(OnVideoSizeChangedListener)}
1157     * to provide a notification when the width is available.
1158     */
1159    public native int getVideoWidth();
1160
1161    /**
1162     * Returns the height of the video.
1163     *
1164     * @return the height of the video, or 0 if there is no video,
1165     * no display surface was set, or the height has not been determined
1166     * yet. The OnVideoSizeChangedListener can be registered via
1167     * {@link #setOnVideoSizeChangedListener(OnVideoSizeChangedListener)}
1168     * to provide a notification when the height is available.
1169     */
1170    public native int getVideoHeight();
1171
1172    /**
1173     * Checks whether the MediaPlayer is playing.
1174     *
1175     * @return true if currently playing, false otherwise
1176     * @throws IllegalStateException if the internal player engine has not been
1177     * initialized or has been released.
1178     */
1179    public native boolean isPlaying();
1180
1181    /**
1182     * Seeks to specified time position.
1183     *
1184     * @param msec the offset in milliseconds from the start to seek to
1185     * @throws IllegalStateException if the internal player engine has not been
1186     * initialized
1187     */
1188    public native void seekTo(int msec) throws IllegalStateException;
1189
1190    /**
1191     * Gets the current playback position.
1192     *
1193     * @return the current position in milliseconds
1194     */
1195    public native int getCurrentPosition();
1196
1197    /**
1198     * Gets the duration of the file.
1199     *
1200     * @return the duration in milliseconds, if no duration is available
1201     *         (for example, if streaming live content), -1 is returned.
1202     */
1203    public native int getDuration();
1204
1205    /**
1206     * Gets the media metadata.
1207     *
1208     * @param update_only controls whether the full set of available
1209     * metadata is returned or just the set that changed since the
1210     * last call. See {@see #METADATA_UPDATE_ONLY} and {@see
1211     * #METADATA_ALL}.
1212     *
1213     * @param apply_filter if true only metadata that matches the
1214     * filter is returned. See {@see #APPLY_METADATA_FILTER} and {@see
1215     * #BYPASS_METADATA_FILTER}.
1216     *
1217     * @return The metadata, possibly empty. null if an error occured.
1218     // FIXME: unhide.
1219     * {@hide}
1220     */
1221    public Metadata getMetadata(final boolean update_only,
1222                                final boolean apply_filter) {
1223        Parcel reply = Parcel.obtain();
1224        Metadata data = new Metadata();
1225
1226        if (!native_getMetadata(update_only, apply_filter, reply)) {
1227            reply.recycle();
1228            return null;
1229        }
1230
1231        // Metadata takes over the parcel, don't recycle it unless
1232        // there is an error.
1233        if (!data.parse(reply)) {
1234            reply.recycle();
1235            return null;
1236        }
1237        return data;
1238    }
1239
1240    /**
1241     * Set a filter for the metadata update notification and update
1242     * retrieval. The caller provides 2 set of metadata keys, allowed
1243     * and blocked. The blocked set always takes precedence over the
1244     * allowed one.
1245     * Metadata.MATCH_ALL and Metadata.MATCH_NONE are 2 sets available as
1246     * shorthands to allow/block all or no metadata.
1247     *
1248     * By default, there is no filter set.
1249     *
1250     * @param allow Is the set of metadata the client is interested
1251     *              in receiving new notifications for.
1252     * @param block Is the set of metadata the client is not interested
1253     *              in receiving new notifications for.
1254     * @return The call status code.
1255     *
1256     // FIXME: unhide.
1257     * {@hide}
1258     */
1259    public int setMetadataFilter(Set<Integer> allow, Set<Integer> block) {
1260        // Do our serialization manually instead of calling
1261        // Parcel.writeArray since the sets are made of the same type
1262        // we avoid paying the price of calling writeValue (used by
1263        // writeArray) which burns an extra int per element to encode
1264        // the type.
1265        Parcel request =  newRequest();
1266
1267        // The parcel starts already with an interface token. There
1268        // are 2 filters. Each one starts with a 4bytes number to
1269        // store the len followed by a number of int (4 bytes as well)
1270        // representing the metadata type.
1271        int capacity = request.dataSize() + 4 * (1 + allow.size() + 1 + block.size());
1272
1273        if (request.dataCapacity() < capacity) {
1274            request.setDataCapacity(capacity);
1275        }
1276
1277        request.writeInt(allow.size());
1278        for(Integer t: allow) {
1279            request.writeInt(t);
1280        }
1281        request.writeInt(block.size());
1282        for(Integer t: block) {
1283            request.writeInt(t);
1284        }
1285        return native_setMetadataFilter(request);
1286    }
1287
1288    /**
1289     * Set the MediaPlayer to start when this MediaPlayer finishes playback
1290     * (i.e. reaches the end of the stream).
1291     * The media framework will attempt to transition from this player to
1292     * the next as seamlessly as possible. The next player can be set at
1293     * any time before completion. The next player must be prepared by the
1294     * app, and the application should not call start() on it.
1295     * The next MediaPlayer must be different from 'this'. An exception
1296     * will be thrown if next == this.
1297     * The application may call setNextMediaPlayer(null) to indicate no
1298     * next player should be started at the end of playback.
1299     * If the current player is looping, it will keep looping and the next
1300     * player will not be started.
1301     *
1302     * @param next the player to start after this one completes playback.
1303     *
1304     */
1305    public native void setNextMediaPlayer(MediaPlayer next);
1306
1307    /**
1308     * Releases resources associated with this MediaPlayer object.
1309     * It is considered good practice to call this method when you're
1310     * done using the MediaPlayer. In particular, whenever an Activity
1311     * of an application is paused (its onPause() method is called),
1312     * or stopped (its onStop() method is called), this method should be
1313     * invoked to release the MediaPlayer object, unless the application
1314     * has a special need to keep the object around. In addition to
1315     * unnecessary resources (such as memory and instances of codecs)
1316     * being held, failure to call this method immediately if a
1317     * MediaPlayer object is no longer needed may also lead to
1318     * continuous battery consumption for mobile devices, and playback
1319     * failure for other applications if no multiple instances of the
1320     * same codec are supported on a device. Even if multiple instances
1321     * of the same codec are supported, some performance degradation
1322     * may be expected when unnecessary multiple instances are used
1323     * at the same time.
1324     */
1325    public void release() {
1326        stayAwake(false);
1327        updateSurfaceScreenOn();
1328        mOnPreparedListener = null;
1329        mOnBufferingUpdateListener = null;
1330        mOnCompletionListener = null;
1331        mOnSeekCompleteListener = null;
1332        mOnErrorListener = null;
1333        mOnInfoListener = null;
1334        mOnVideoSizeChangedListener = null;
1335        mOnTimedTextListener = null;
1336        _release();
1337    }
1338
1339    private native void _release();
1340
1341    /**
1342     * Resets the MediaPlayer to its uninitialized state. After calling
1343     * this method, you will have to initialize it again by setting the
1344     * data source and calling prepare().
1345     */
1346    public void reset() {
1347        stayAwake(false);
1348        _reset();
1349        // make sure none of the listeners get called anymore
1350        mEventHandler.removeCallbacksAndMessages(null);
1351
1352        disableProxyListener();
1353    }
1354
1355    private native void _reset();
1356
1357    /**
1358     * Sets the audio stream type for this MediaPlayer. See {@link AudioManager}
1359     * for a list of stream types. Must call this method before prepare() or
1360     * prepareAsync() in order for the target stream type to become effective
1361     * thereafter.
1362     *
1363     * @param streamtype the audio stream type
1364     * @see android.media.AudioManager
1365     */
1366    public native void setAudioStreamType(int streamtype);
1367
1368    /**
1369     * Sets the player to be looping or non-looping.
1370     *
1371     * @param looping whether to loop or not
1372     */
1373    public native void setLooping(boolean looping);
1374
1375    /**
1376     * Checks whether the MediaPlayer is looping or non-looping.
1377     *
1378     * @return true if the MediaPlayer is currently looping, false otherwise
1379     */
1380    public native boolean isLooping();
1381
1382    /**
1383     * Sets the volume on this player.
1384     * This API is recommended for balancing the output of audio streams
1385     * within an application. Unless you are writing an application to
1386     * control user settings, this API should be used in preference to
1387     * {@link AudioManager#setStreamVolume(int, int, int)} which sets the volume of ALL streams of
1388     * a particular type. Note that the passed volume values are raw scalars in range 0.0 to 1.0.
1389     * UI controls should be scaled logarithmically.
1390     *
1391     * @param leftVolume left volume scalar
1392     * @param rightVolume right volume scalar
1393     */
1394    /*
1395     * FIXME: Merge this into javadoc comment above when setVolume(float) is not @hide.
1396     * The single parameter form below is preferred if the channel volumes don't need
1397     * to be set independently.
1398     */
1399    public native void setVolume(float leftVolume, float rightVolume);
1400
1401    /**
1402     * Similar, excepts sets volume of all channels to same value.
1403     * @hide
1404     */
1405    public void setVolume(float volume) {
1406        setVolume(volume, volume);
1407    }
1408
1409    /**
1410     * Sets the audio session ID.
1411     *
1412     * @param sessionId the audio session ID.
1413     * The audio session ID is a system wide unique identifier for the audio stream played by
1414     * this MediaPlayer instance.
1415     * The primary use of the audio session ID  is to associate audio effects to a particular
1416     * instance of MediaPlayer: if an audio session ID is provided when creating an audio effect,
1417     * this effect will be applied only to the audio content of media players within the same
1418     * audio session and not to the output mix.
1419     * When created, a MediaPlayer instance automatically generates its own audio session ID.
1420     * However, it is possible to force this player to be part of an already existing audio session
1421     * by calling this method.
1422     * This method must be called before one of the overloaded <code> setDataSource </code> methods.
1423     * @throws IllegalStateException if it is called in an invalid state
1424     */
1425    public native void setAudioSessionId(int sessionId)  throws IllegalArgumentException, IllegalStateException;
1426
1427    /**
1428     * Returns the audio session ID.
1429     *
1430     * @return the audio session ID. {@see #setAudioSessionId(int)}
1431     * Note that the audio session ID is 0 only if a problem occured when the MediaPlayer was contructed.
1432     */
1433    public native int getAudioSessionId();
1434
1435    /**
1436     * Attaches an auxiliary effect to the player. A typical auxiliary effect is a reverberation
1437     * effect which can be applied on any sound source that directs a certain amount of its
1438     * energy to this effect. This amount is defined by setAuxEffectSendLevel().
1439     * {@see #setAuxEffectSendLevel(float)}.
1440     * <p>After creating an auxiliary effect (e.g.
1441     * {@link android.media.audiofx.EnvironmentalReverb}), retrieve its ID with
1442     * {@link android.media.audiofx.AudioEffect#getId()} and use it when calling this method
1443     * to attach the player to the effect.
1444     * <p>To detach the effect from the player, call this method with a null effect id.
1445     * <p>This method must be called after one of the overloaded <code> setDataSource </code>
1446     * methods.
1447     * @param effectId system wide unique id of the effect to attach
1448     */
1449    public native void attachAuxEffect(int effectId);
1450
1451
1452    /**
1453     * Sets the send level of the player to the attached auxiliary effect
1454     * {@see #attachAuxEffect(int)}. The level value range is 0 to 1.0.
1455     * <p>By default the send level is 0, so even if an effect is attached to the player
1456     * this method must be called for the effect to be applied.
1457     * <p>Note that the passed level value is a raw scalar. UI controls should be scaled
1458     * logarithmically: the gain applied by audio framework ranges from -72dB to 0dB,
1459     * so an appropriate conversion from linear UI input x to level is:
1460     * x == 0 -> level = 0
1461     * 0 < x <= R -> level = 10^(72*(x-R)/20/R)
1462     * @param level send level scalar
1463     */
1464    public native void setAuxEffectSendLevel(float level);
1465
1466    /*
1467     * @param request Parcel destinated to the media player. The
1468     *                Interface token must be set to the IMediaPlayer
1469     *                one to be routed correctly through the system.
1470     * @param reply[out] Parcel that will contain the reply.
1471     * @return The status code.
1472     */
1473    private native final int native_invoke(Parcel request, Parcel reply);
1474
1475
1476    /*
1477     * @param update_only If true fetch only the set of metadata that have
1478     *                    changed since the last invocation of getMetadata.
1479     *                    The set is built using the unfiltered
1480     *                    notifications the native player sent to the
1481     *                    MediaPlayerService during that period of
1482     *                    time. If false, all the metadatas are considered.
1483     * @param apply_filter  If true, once the metadata set has been built based on
1484     *                     the value update_only, the current filter is applied.
1485     * @param reply[out] On return contains the serialized
1486     *                   metadata. Valid only if the call was successful.
1487     * @return The status code.
1488     */
1489    private native final boolean native_getMetadata(boolean update_only,
1490                                                    boolean apply_filter,
1491                                                    Parcel reply);
1492
1493    /*
1494     * @param request Parcel with the 2 serialized lists of allowed
1495     *                metadata types followed by the one to be
1496     *                dropped. Each list starts with an integer
1497     *                indicating the number of metadata type elements.
1498     * @return The status code.
1499     */
1500    private native final int native_setMetadataFilter(Parcel request);
1501
1502    private static native final void native_init();
1503    private native final void native_setup(Object mediaplayer_this);
1504    private native final void native_finalize();
1505
1506    /**
1507     * Class for MediaPlayer to return each audio/video/subtitle track's metadata.
1508     *
1509     * @see android.media.MediaPlayer#getTrackInfo
1510     */
1511    static public class TrackInfo implements Parcelable {
1512        /**
1513         * Gets the track type.
1514         * @return TrackType which indicates if the track is video, audio, timed text.
1515         */
1516        public int getTrackType() {
1517            return mTrackType;
1518        }
1519
1520        /**
1521         * Gets the language code of the track.
1522         * @return a language code in either way of ISO-639-1 or ISO-639-2.
1523         * When the language is unknown or could not be determined,
1524         * ISO-639-2 language code, "und", is returned.
1525         */
1526        public String getLanguage() {
1527            return mLanguage;
1528        }
1529
1530        public static final int MEDIA_TRACK_TYPE_UNKNOWN = 0;
1531        public static final int MEDIA_TRACK_TYPE_VIDEO = 1;
1532        public static final int MEDIA_TRACK_TYPE_AUDIO = 2;
1533        public static final int MEDIA_TRACK_TYPE_TIMEDTEXT = 3;
1534
1535        final int mTrackType;
1536        final String mLanguage;
1537
1538        TrackInfo(Parcel in) {
1539            mTrackType = in.readInt();
1540            mLanguage = in.readString();
1541        }
1542
1543        /**
1544         * {@inheritDoc}
1545         */
1546        @Override
1547        public int describeContents() {
1548            return 0;
1549        }
1550
1551        /**
1552         * {@inheritDoc}
1553         */
1554        @Override
1555        public void writeToParcel(Parcel dest, int flags) {
1556            dest.writeInt(mTrackType);
1557            dest.writeString(mLanguage);
1558        }
1559
1560        /**
1561         * Used to read a TrackInfo from a Parcel.
1562         */
1563        static final Parcelable.Creator<TrackInfo> CREATOR
1564                = new Parcelable.Creator<TrackInfo>() {
1565                    @Override
1566                    public TrackInfo createFromParcel(Parcel in) {
1567                        return new TrackInfo(in);
1568                    }
1569
1570                    @Override
1571                    public TrackInfo[] newArray(int size) {
1572                        return new TrackInfo[size];
1573                    }
1574                };
1575
1576    };
1577
1578    /**
1579     * Returns an array of track information.
1580     *
1581     * @return Array of track info. The total number of tracks is the array length.
1582     * Must be called again if an external timed text source has been added after any of the
1583     * addTimedTextSource methods are called.
1584     * @throws IllegalStateException if it is called in an invalid state.
1585     */
1586    public TrackInfo[] getTrackInfo() throws IllegalStateException {
1587        Parcel request = Parcel.obtain();
1588        Parcel reply = Parcel.obtain();
1589        try {
1590            request.writeInterfaceToken(IMEDIA_PLAYER);
1591            request.writeInt(INVOKE_ID_GET_TRACK_INFO);
1592            invoke(request, reply);
1593            TrackInfo trackInfo[] = reply.createTypedArray(TrackInfo.CREATOR);
1594            return trackInfo;
1595        } finally {
1596            request.recycle();
1597            reply.recycle();
1598        }
1599    }
1600
1601    /* Do not change these values without updating their counterparts
1602     * in include/media/stagefright/MediaDefs.h and media/libstagefright/MediaDefs.cpp!
1603     */
1604    /**
1605     * MIME type for SubRip (SRT) container. Used in addTimedTextSource APIs.
1606     */
1607    public static final String MEDIA_MIMETYPE_TEXT_SUBRIP = "application/x-subrip";
1608
1609    /*
1610     * A helper function to check if the mime type is supported by media framework.
1611     */
1612    private static boolean availableMimeTypeForExternalSource(String mimeType) {
1613        if (mimeType == MEDIA_MIMETYPE_TEXT_SUBRIP) {
1614            return true;
1615        }
1616        return false;
1617    }
1618
1619    /* TODO: Limit the total number of external timed text source to a reasonable number.
1620     */
1621    /**
1622     * Adds an external timed text source file.
1623     *
1624     * Currently supported format is SubRip with the file extension .srt, case insensitive.
1625     * Note that a single external timed text source may contain multiple tracks in it.
1626     * One can find the total number of available tracks using {@link #getTrackInfo()} to see what
1627     * additional tracks become available after this method call.
1628     *
1629     * @param path The file path of external timed text source file.
1630     * @param mimeType The mime type of the file. Must be one of the mime types listed above.
1631     * @throws IOException if the file cannot be accessed or is corrupted.
1632     * @throws IllegalArgumentException if the mimeType is not supported.
1633     * @throws IllegalStateException if called in an invalid state.
1634     */
1635    public void addTimedTextSource(String path, String mimeType)
1636            throws IOException, IllegalArgumentException, IllegalStateException {
1637        if (!availableMimeTypeForExternalSource(mimeType)) {
1638            final String msg = "Illegal mimeType for timed text source: " + mimeType;
1639            throw new IllegalArgumentException(msg);
1640        }
1641
1642        File file = new File(path);
1643        if (file.exists()) {
1644            FileInputStream is = new FileInputStream(file);
1645            FileDescriptor fd = is.getFD();
1646            addTimedTextSource(fd, mimeType);
1647            is.close();
1648        } else {
1649            // We do not support the case where the path is not a file.
1650            throw new IOException(path);
1651        }
1652    }
1653
1654    /**
1655     * Adds an external timed text source file (Uri).
1656     *
1657     * Currently supported format is SubRip with the file extension .srt, case insensitive.
1658     * Note that a single external timed text source may contain multiple tracks in it.
1659     * One can find the total number of available tracks using {@link #getTrackInfo()} to see what
1660     * additional tracks become available after this method call.
1661     *
1662     * @param context the Context to use when resolving the Uri
1663     * @param uri the Content URI of the data you want to play
1664     * @param mimeType The mime type of the file. Must be one of the mime types listed above.
1665     * @throws IOException if the file cannot be accessed or is corrupted.
1666     * @throws IllegalArgumentException if the mimeType is not supported.
1667     * @throws IllegalStateException if called in an invalid state.
1668     */
1669    public void addTimedTextSource(Context context, Uri uri, String mimeType)
1670            throws IOException, IllegalArgumentException, IllegalStateException {
1671        String scheme = uri.getScheme();
1672        if(scheme == null || scheme.equals("file")) {
1673            addTimedTextSource(uri.getPath(), mimeType);
1674            return;
1675        }
1676
1677        AssetFileDescriptor fd = null;
1678        try {
1679            ContentResolver resolver = context.getContentResolver();
1680            fd = resolver.openAssetFileDescriptor(uri, "r");
1681            if (fd == null) {
1682                return;
1683            }
1684            addTimedTextSource(fd.getFileDescriptor(), mimeType);
1685            return;
1686        } catch (SecurityException ex) {
1687        } catch (IOException ex) {
1688        } finally {
1689            if (fd != null) {
1690                fd.close();
1691            }
1692        }
1693    }
1694
1695    /**
1696     * Adds an external timed text source file (FileDescriptor).
1697     *
1698     * It is the caller's responsibility to close the file descriptor.
1699     * It is safe to do so as soon as this call returns.
1700     *
1701     * Currently supported format is SubRip. Note that a single external timed text source may
1702     * contain multiple tracks in it. One can find the total number of available tracks
1703     * using {@link #getTrackInfo()} to see what additional tracks become available
1704     * after this method call.
1705     *
1706     * @param fd the FileDescriptor for the file you want to play
1707     * @param mimeType The mime type of the file. Must be one of the mime types listed above.
1708     * @throws IllegalArgumentException if the mimeType is not supported.
1709     * @throws IllegalStateException if called in an invalid state.
1710     */
1711    public void addTimedTextSource(FileDescriptor fd, String mimeType)
1712            throws IllegalArgumentException, IllegalStateException {
1713        // intentionally less than LONG_MAX
1714        addTimedTextSource(fd, 0, 0x7ffffffffffffffL, mimeType);
1715    }
1716
1717    /**
1718     * Adds an external timed text file (FileDescriptor).
1719     *
1720     * It is the caller's responsibility to close the file descriptor.
1721     * It is safe to do so as soon as this call returns.
1722     *
1723     * Currently supported format is SubRip. Note that a single external timed text source may
1724     * contain multiple tracks in it. One can find the total number of available tracks
1725     * using {@link #getTrackInfo()} to see what additional tracks become available
1726     * after this method call.
1727     *
1728     * @param fd the FileDescriptor for the file you want to play
1729     * @param offset the offset into the file where the data to be played starts, in bytes
1730     * @param length the length in bytes of the data to be played
1731     * @param mimeType The mime type of the file. Must be one of the mime types listed above.
1732     * @throws IllegalArgumentException if the mimeType is not supported.
1733     * @throws IllegalStateException if called in an invalid state.
1734     */
1735    public void addTimedTextSource(FileDescriptor fd, long offset, long length, String mimeType)
1736            throws IllegalArgumentException, IllegalStateException {
1737        if (!availableMimeTypeForExternalSource(mimeType)) {
1738            throw new IllegalArgumentException("Illegal mimeType for timed text source: " + mimeType);
1739        }
1740
1741        Parcel request = Parcel.obtain();
1742        Parcel reply = Parcel.obtain();
1743        try {
1744            request.writeInterfaceToken(IMEDIA_PLAYER);
1745            request.writeInt(INVOKE_ID_ADD_EXTERNAL_SOURCE_FD);
1746            request.writeFileDescriptor(fd);
1747            request.writeLong(offset);
1748            request.writeLong(length);
1749            request.writeString(mimeType);
1750            invoke(request, reply);
1751        } finally {
1752            request.recycle();
1753            reply.recycle();
1754        }
1755    }
1756
1757    /**
1758     * Selects a track.
1759     * <p>
1760     * If a MediaPlayer is in invalid state, it throws an IllegalStateException exception.
1761     * If a MediaPlayer is in <em>Started</em> state, the selected track is presented immediately.
1762     * If a MediaPlayer is not in Started state, it just marks the track to be played.
1763     * </p>
1764     * <p>
1765     * In any valid state, if it is called multiple times on the same type of track (ie. Video,
1766     * Audio, Timed Text), the most recent one will be chosen.
1767     * </p>
1768     * <p>
1769     * The first audio and video tracks are selected by default if available, even though
1770     * this method is not called. However, no timed text track will be selected until
1771     * this function is called.
1772     * </p>
1773     * <p>
1774     * Currently, only timed text tracks or audio tracks can be selected via this method.
1775     * In addition, the support for selecting an audio track at runtime is pretty limited
1776     * in that an audio track can only be selected in the <em>Prepared</em> state.
1777     * </p>
1778     * @param index the index of the track to be selected. The valid range of the index
1779     * is 0..total number of track - 1. The total number of tracks as well as the type of
1780     * each individual track can be found by calling {@link #getTrackInfo()} method.
1781     * @throws IllegalStateException if called in an invalid state.
1782     *
1783     * @see android.media.MediaPlayer#getTrackInfo
1784     */
1785    public void selectTrack(int index) throws IllegalStateException {
1786        selectOrDeselectTrack(index, true /* select */);
1787    }
1788
1789    /**
1790     * Deselect a track.
1791     * <p>
1792     * Currently, the track must be a timed text track and no audio or video tracks can be
1793     * deselected. If the timed text track identified by index has not been
1794     * selected before, it throws an exception.
1795     * </p>
1796     * @param index the index of the track to be deselected. The valid range of the index
1797     * is 0..total number of tracks - 1. The total number of tracks as well as the type of
1798     * each individual track can be found by calling {@link #getTrackInfo()} method.
1799     * @throws IllegalStateException if called in an invalid state.
1800     *
1801     * @see android.media.MediaPlayer#getTrackInfo
1802     */
1803    public void deselectTrack(int index) throws IllegalStateException {
1804        selectOrDeselectTrack(index, false /* select */);
1805    }
1806
1807    private void selectOrDeselectTrack(int index, boolean select)
1808            throws IllegalStateException {
1809        Parcel request = Parcel.obtain();
1810        Parcel reply = Parcel.obtain();
1811        try {
1812            request.writeInterfaceToken(IMEDIA_PLAYER);
1813            request.writeInt(select? INVOKE_ID_SELECT_TRACK: INVOKE_ID_DESELECT_TRACK);
1814            request.writeInt(index);
1815            invoke(request, reply);
1816        } finally {
1817            request.recycle();
1818            reply.recycle();
1819        }
1820    }
1821
1822
1823    /**
1824     * @param reply Parcel with audio/video duration info for battery
1825                    tracking usage
1826     * @return The status code.
1827     * {@hide}
1828     */
1829    public native static int native_pullBatteryData(Parcel reply);
1830
1831    /**
1832     * Sets the target UDP re-transmit endpoint for the low level player.
1833     * Generally, the address portion of the endpoint is an IP multicast
1834     * address, although a unicast address would be equally valid.  When a valid
1835     * retransmit endpoint has been set, the media player will not decode and
1836     * render the media presentation locally.  Instead, the player will attempt
1837     * to re-multiplex its media data using the Android@Home RTP profile and
1838     * re-transmit to the target endpoint.  Receiver devices (which may be
1839     * either the same as the transmitting device or different devices) may
1840     * instantiate, prepare, and start a receiver player using a setDataSource
1841     * URL of the form...
1842     *
1843     * aahRX://&lt;multicastIP&gt;:&lt;port&gt;
1844     *
1845     * to receive, decode and render the re-transmitted content.
1846     *
1847     * setRetransmitEndpoint may only be called before setDataSource has been
1848     * called; while the player is in the Idle state.
1849     *
1850     * @param endpoint the address and UDP port of the re-transmission target or
1851     * null if no re-transmission is to be performed.
1852     * @throws IllegalStateException if it is called in an invalid state
1853     * @throws IllegalArgumentException if the retransmit endpoint is supplied,
1854     * but invalid.
1855     *
1856     * {@hide} pending API council
1857     */
1858    public void setRetransmitEndpoint(InetSocketAddress endpoint)
1859            throws IllegalStateException, IllegalArgumentException
1860    {
1861        String addrString = null;
1862        int port = 0;
1863
1864        if (null != endpoint) {
1865            addrString = endpoint.getAddress().getHostAddress();
1866            port = endpoint.getPort();
1867        }
1868
1869        int ret = native_setRetransmitEndpoint(addrString, port);
1870        if (ret != 0) {
1871            throw new IllegalArgumentException("Illegal re-transmit endpoint; native ret " + ret);
1872        }
1873    }
1874
1875    private native final int native_setRetransmitEndpoint(String addrString, int port);
1876
1877    @Override
1878    protected void finalize() { native_finalize(); }
1879
1880    /* Do not change these values without updating their counterparts
1881     * in include/media/mediaplayer.h!
1882     */
1883    private static final int MEDIA_NOP = 0; // interface test message
1884    private static final int MEDIA_PREPARED = 1;
1885    private static final int MEDIA_PLAYBACK_COMPLETE = 2;
1886    private static final int MEDIA_BUFFERING_UPDATE = 3;
1887    private static final int MEDIA_SEEK_COMPLETE = 4;
1888    private static final int MEDIA_SET_VIDEO_SIZE = 5;
1889    private static final int MEDIA_TIMED_TEXT = 99;
1890    private static final int MEDIA_ERROR = 100;
1891    private static final int MEDIA_INFO = 200;
1892
1893    private class EventHandler extends Handler
1894    {
1895        private MediaPlayer mMediaPlayer;
1896
1897        public EventHandler(MediaPlayer mp, Looper looper) {
1898            super(looper);
1899            mMediaPlayer = mp;
1900        }
1901
1902        @Override
1903        public void handleMessage(Message msg) {
1904            if (mMediaPlayer.mNativeContext == 0) {
1905                Log.w(TAG, "mediaplayer went away with unhandled events");
1906                return;
1907            }
1908            switch(msg.what) {
1909            case MEDIA_PREPARED:
1910                if (mOnPreparedListener != null)
1911                    mOnPreparedListener.onPrepared(mMediaPlayer);
1912                return;
1913
1914            case MEDIA_PLAYBACK_COMPLETE:
1915                if (mOnCompletionListener != null)
1916                    mOnCompletionListener.onCompletion(mMediaPlayer);
1917                stayAwake(false);
1918                return;
1919
1920            case MEDIA_BUFFERING_UPDATE:
1921                if (mOnBufferingUpdateListener != null)
1922                    mOnBufferingUpdateListener.onBufferingUpdate(mMediaPlayer, msg.arg1);
1923                return;
1924
1925            case MEDIA_SEEK_COMPLETE:
1926              if (mOnSeekCompleteListener != null)
1927                  mOnSeekCompleteListener.onSeekComplete(mMediaPlayer);
1928              return;
1929
1930            case MEDIA_SET_VIDEO_SIZE:
1931              if (mOnVideoSizeChangedListener != null)
1932                  mOnVideoSizeChangedListener.onVideoSizeChanged(mMediaPlayer, msg.arg1, msg.arg2);
1933              return;
1934
1935            case MEDIA_ERROR:
1936                Log.e(TAG, "Error (" + msg.arg1 + "," + msg.arg2 + ")");
1937                boolean error_was_handled = false;
1938                if (mOnErrorListener != null) {
1939                    error_was_handled = mOnErrorListener.onError(mMediaPlayer, msg.arg1, msg.arg2);
1940                }
1941                if (mOnCompletionListener != null && ! error_was_handled) {
1942                    mOnCompletionListener.onCompletion(mMediaPlayer);
1943                }
1944                stayAwake(false);
1945                return;
1946
1947            case MEDIA_INFO:
1948                if (msg.arg1 != MEDIA_INFO_VIDEO_TRACK_LAGGING) {
1949                    Log.i(TAG, "Info (" + msg.arg1 + "," + msg.arg2 + ")");
1950                }
1951                if (mOnInfoListener != null) {
1952                    mOnInfoListener.onInfo(mMediaPlayer, msg.arg1, msg.arg2);
1953                }
1954                // No real default action so far.
1955                return;
1956            case MEDIA_TIMED_TEXT:
1957                if (mOnTimedTextListener == null)
1958                    return;
1959                if (msg.obj == null) {
1960                    mOnTimedTextListener.onTimedText(mMediaPlayer, null);
1961                } else {
1962                    if (msg.obj instanceof Parcel) {
1963                        Parcel parcel = (Parcel)msg.obj;
1964                        TimedText text = new TimedText(parcel);
1965                        parcel.recycle();
1966                        mOnTimedTextListener.onTimedText(mMediaPlayer, text);
1967                    }
1968                }
1969                return;
1970
1971            case MEDIA_NOP: // interface test message - ignore
1972                break;
1973
1974            default:
1975                Log.e(TAG, "Unknown message type " + msg.what);
1976                return;
1977            }
1978        }
1979    }
1980
1981    /*
1982     * Called from native code when an interesting event happens.  This method
1983     * just uses the EventHandler system to post the event back to the main app thread.
1984     * We use a weak reference to the original MediaPlayer object so that the native
1985     * code is safe from the object disappearing from underneath it.  (This is
1986     * the cookie passed to native_setup().)
1987     */
1988    private static void postEventFromNative(Object mediaplayer_ref,
1989                                            int what, int arg1, int arg2, Object obj)
1990    {
1991        MediaPlayer mp = (MediaPlayer)((WeakReference)mediaplayer_ref).get();
1992        if (mp == null) {
1993            return;
1994        }
1995
1996        if (what == MEDIA_INFO && arg1 == MEDIA_INFO_STARTED_AS_NEXT) {
1997            // this acquires the wakelock if needed, and sets the client side state
1998            mp.start();
1999        }
2000        if (mp.mEventHandler != null) {
2001            Message m = mp.mEventHandler.obtainMessage(what, arg1, arg2, obj);
2002            mp.mEventHandler.sendMessage(m);
2003        }
2004    }
2005
2006    /**
2007     * Interface definition for a callback to be invoked when the media
2008     * source is ready for playback.
2009     */
2010    public interface OnPreparedListener
2011    {
2012        /**
2013         * Called when the media file is ready for playback.
2014         *
2015         * @param mp the MediaPlayer that is ready for playback
2016         */
2017        void onPrepared(MediaPlayer mp);
2018    }
2019
2020    /**
2021     * Register a callback to be invoked when the media source is ready
2022     * for playback.
2023     *
2024     * @param listener the callback that will be run
2025     */
2026    public void setOnPreparedListener(OnPreparedListener listener)
2027    {
2028        mOnPreparedListener = listener;
2029    }
2030
2031    private OnPreparedListener mOnPreparedListener;
2032
2033    /**
2034     * Interface definition for a callback to be invoked when playback of
2035     * a media source has completed.
2036     */
2037    public interface OnCompletionListener
2038    {
2039        /**
2040         * Called when the end of a media source is reached during playback.
2041         *
2042         * @param mp the MediaPlayer that reached the end of the file
2043         */
2044        void onCompletion(MediaPlayer mp);
2045    }
2046
2047    /**
2048     * Register a callback to be invoked when the end of a media source
2049     * has been reached during playback.
2050     *
2051     * @param listener the callback that will be run
2052     */
2053    public void setOnCompletionListener(OnCompletionListener listener)
2054    {
2055        mOnCompletionListener = listener;
2056    }
2057
2058    private OnCompletionListener mOnCompletionListener;
2059
2060    /**
2061     * Interface definition of a callback to be invoked indicating buffering
2062     * status of a media resource being streamed over the network.
2063     */
2064    public interface OnBufferingUpdateListener
2065    {
2066        /**
2067         * Called to update status in buffering a media stream received through
2068         * progressive HTTP download. The received buffering percentage
2069         * indicates how much of the content has been buffered or played.
2070         * For example a buffering update of 80 percent when half the content
2071         * has already been played indicates that the next 30 percent of the
2072         * content to play has been buffered.
2073         *
2074         * @param mp      the MediaPlayer the update pertains to
2075         * @param percent the percentage (0-100) of the content
2076         *                that has been buffered or played thus far
2077         */
2078        void onBufferingUpdate(MediaPlayer mp, int percent);
2079    }
2080
2081    /**
2082     * Register a callback to be invoked when the status of a network
2083     * stream's buffer has changed.
2084     *
2085     * @param listener the callback that will be run.
2086     */
2087    public void setOnBufferingUpdateListener(OnBufferingUpdateListener listener)
2088    {
2089        mOnBufferingUpdateListener = listener;
2090    }
2091
2092    private OnBufferingUpdateListener mOnBufferingUpdateListener;
2093
2094    /**
2095     * Interface definition of a callback to be invoked indicating
2096     * the completion of a seek operation.
2097     */
2098    public interface OnSeekCompleteListener
2099    {
2100        /**
2101         * Called to indicate the completion of a seek operation.
2102         *
2103         * @param mp the MediaPlayer that issued the seek operation
2104         */
2105        public void onSeekComplete(MediaPlayer mp);
2106    }
2107
2108    /**
2109     * Register a callback to be invoked when a seek operation has been
2110     * completed.
2111     *
2112     * @param listener the callback that will be run
2113     */
2114    public void setOnSeekCompleteListener(OnSeekCompleteListener listener)
2115    {
2116        mOnSeekCompleteListener = listener;
2117    }
2118
2119    private OnSeekCompleteListener mOnSeekCompleteListener;
2120
2121    /**
2122     * Interface definition of a callback to be invoked when the
2123     * video size is first known or updated
2124     */
2125    public interface OnVideoSizeChangedListener
2126    {
2127        /**
2128         * Called to indicate the video size
2129         *
2130         * The video size (width and height) could be 0 if there was no video,
2131         * no display surface was set, or the value was not determined yet.
2132         *
2133         * @param mp        the MediaPlayer associated with this callback
2134         * @param width     the width of the video
2135         * @param height    the height of the video
2136         */
2137        public void onVideoSizeChanged(MediaPlayer mp, int width, int height);
2138    }
2139
2140    /**
2141     * Register a callback to be invoked when the video size is
2142     * known or updated.
2143     *
2144     * @param listener the callback that will be run
2145     */
2146    public void setOnVideoSizeChangedListener(OnVideoSizeChangedListener listener)
2147    {
2148        mOnVideoSizeChangedListener = listener;
2149    }
2150
2151    private OnVideoSizeChangedListener mOnVideoSizeChangedListener;
2152
2153    /**
2154     * Interface definition of a callback to be invoked when a
2155     * timed text is available for display.
2156     */
2157    public interface OnTimedTextListener
2158    {
2159        /**
2160         * Called to indicate an avaliable timed text
2161         *
2162         * @param mp             the MediaPlayer associated with this callback
2163         * @param text           the timed text sample which contains the text
2164         *                       needed to be displayed and the display format.
2165         */
2166        public void onTimedText(MediaPlayer mp, TimedText text);
2167    }
2168
2169    /**
2170     * Register a callback to be invoked when a timed text is available
2171     * for display.
2172     *
2173     * @param listener the callback that will be run
2174     */
2175    public void setOnTimedTextListener(OnTimedTextListener listener)
2176    {
2177        mOnTimedTextListener = listener;
2178    }
2179
2180    private OnTimedTextListener mOnTimedTextListener;
2181
2182
2183    /* Do not change these values without updating their counterparts
2184     * in include/media/mediaplayer.h!
2185     */
2186    /** Unspecified media player error.
2187     * @see android.media.MediaPlayer.OnErrorListener
2188     */
2189    public static final int MEDIA_ERROR_UNKNOWN = 1;
2190
2191    /** Media server died. In this case, the application must release the
2192     * MediaPlayer object and instantiate a new one.
2193     * @see android.media.MediaPlayer.OnErrorListener
2194     */
2195    public static final int MEDIA_ERROR_SERVER_DIED = 100;
2196
2197    /** The video is streamed and its container is not valid for progressive
2198     * playback i.e the video's index (e.g moov atom) is not at the start of the
2199     * file.
2200     * @see android.media.MediaPlayer.OnErrorListener
2201     */
2202    public static final int MEDIA_ERROR_NOT_VALID_FOR_PROGRESSIVE_PLAYBACK = 200;
2203
2204    /** File or network related operation errors. */
2205    public static final int MEDIA_ERROR_IO = -1004;
2206    /** Bitstream is not conforming to the related coding standard or file spec. */
2207    public static final int MEDIA_ERROR_MALFORMED = -1007;
2208    /** Bitstream is conforming to the related coding standard or file spec, but
2209     * the media framework does not support the feature. */
2210    public static final int MEDIA_ERROR_UNSUPPORTED = -1010;
2211    /** Some operation takes too long to complete, usually more than 3-5 seconds. */
2212    public static final int MEDIA_ERROR_TIMED_OUT = -110;
2213
2214    /**
2215     * Interface definition of a callback to be invoked when there
2216     * has been an error during an asynchronous operation (other errors
2217     * will throw exceptions at method call time).
2218     */
2219    public interface OnErrorListener
2220    {
2221        /**
2222         * Called to indicate an error.
2223         *
2224         * @param mp      the MediaPlayer the error pertains to
2225         * @param what    the type of error that has occurred:
2226         * <ul>
2227         * <li>{@link #MEDIA_ERROR_UNKNOWN}
2228         * <li>{@link #MEDIA_ERROR_SERVER_DIED}
2229         * </ul>
2230         * @param extra an extra code, specific to the error. Typically
2231         * implementation dependent.
2232         * <ul>
2233         * <li>{@link #MEDIA_ERROR_IO}
2234         * <li>{@link #MEDIA_ERROR_MALFORMED}
2235         * <li>{@link #MEDIA_ERROR_UNSUPPORTED}
2236         * <li>{@link #MEDIA_ERROR_TIMED_OUT}
2237         * </ul>
2238         * @return True if the method handled the error, false if it didn't.
2239         * Returning false, or not having an OnErrorListener at all, will
2240         * cause the OnCompletionListener to be called.
2241         */
2242        boolean onError(MediaPlayer mp, int what, int extra);
2243    }
2244
2245    /**
2246     * Register a callback to be invoked when an error has happened
2247     * during an asynchronous operation.
2248     *
2249     * @param listener the callback that will be run
2250     */
2251    public void setOnErrorListener(OnErrorListener listener)
2252    {
2253        mOnErrorListener = listener;
2254    }
2255
2256    private OnErrorListener mOnErrorListener;
2257
2258
2259    /* Do not change these values without updating their counterparts
2260     * in include/media/mediaplayer.h!
2261     */
2262    /** Unspecified media player info.
2263     * @see android.media.MediaPlayer.OnInfoListener
2264     */
2265    public static final int MEDIA_INFO_UNKNOWN = 1;
2266
2267    /** The player was started because it was used as the next player for another
2268     * player, which just completed playback.
2269     * @see android.media.MediaPlayer.OnInfoListener
2270     * @hide
2271     */
2272    public static final int MEDIA_INFO_STARTED_AS_NEXT = 2;
2273
2274    /** The player just pushed the very first video frame for rendering.
2275     * @see android.media.MediaPlayer.OnInfoListener
2276     */
2277    public static final int MEDIA_INFO_VIDEO_RENDERING_START = 3;
2278
2279    /** The video is too complex for the decoder: it can't decode frames fast
2280     *  enough. Possibly only the audio plays fine at this stage.
2281     * @see android.media.MediaPlayer.OnInfoListener
2282     */
2283    public static final int MEDIA_INFO_VIDEO_TRACK_LAGGING = 700;
2284
2285    /** MediaPlayer is temporarily pausing playback internally in order to
2286     * buffer more data.
2287     * @see android.media.MediaPlayer.OnInfoListener
2288     */
2289    public static final int MEDIA_INFO_BUFFERING_START = 701;
2290
2291    /** MediaPlayer is resuming playback after filling buffers.
2292     * @see android.media.MediaPlayer.OnInfoListener
2293     */
2294    public static final int MEDIA_INFO_BUFFERING_END = 702;
2295
2296    /** Bad interleaving means that a media has been improperly interleaved or
2297     * not interleaved at all, e.g has all the video samples first then all the
2298     * audio ones. Video is playing but a lot of disk seeks may be happening.
2299     * @see android.media.MediaPlayer.OnInfoListener
2300     */
2301    public static final int MEDIA_INFO_BAD_INTERLEAVING = 800;
2302
2303    /** The media cannot be seeked (e.g live stream)
2304     * @see android.media.MediaPlayer.OnInfoListener
2305     */
2306    public static final int MEDIA_INFO_NOT_SEEKABLE = 801;
2307
2308    /** A new set of metadata is available.
2309     * @see android.media.MediaPlayer.OnInfoListener
2310     */
2311    public static final int MEDIA_INFO_METADATA_UPDATE = 802;
2312
2313    /** Failed to handle timed text track properly.
2314     * @see android.media.MediaPlayer.OnInfoListener
2315     *
2316     * {@hide}
2317     */
2318    public static final int MEDIA_INFO_TIMED_TEXT_ERROR = 900;
2319
2320    /**
2321     * Interface definition of a callback to be invoked to communicate some
2322     * info and/or warning about the media or its playback.
2323     */
2324    public interface OnInfoListener
2325    {
2326        /**
2327         * Called to indicate an info or a warning.
2328         *
2329         * @param mp      the MediaPlayer the info pertains to.
2330         * @param what    the type of info or warning.
2331         * <ul>
2332         * <li>{@link #MEDIA_INFO_UNKNOWN}
2333         * <li>{@link #MEDIA_INFO_VIDEO_TRACK_LAGGING}
2334         * <li>{@link #MEDIA_INFO_VIDEO_RENDERING_START}
2335         * <li>{@link #MEDIA_INFO_BUFFERING_START}
2336         * <li>{@link #MEDIA_INFO_BUFFERING_END}
2337         * <li>{@link #MEDIA_INFO_BAD_INTERLEAVING}
2338         * <li>{@link #MEDIA_INFO_NOT_SEEKABLE}
2339         * <li>{@link #MEDIA_INFO_METADATA_UPDATE}
2340         * </ul>
2341         * @param extra an extra code, specific to the info. Typically
2342         * implementation dependent.
2343         * @return True if the method handled the info, false if it didn't.
2344         * Returning false, or not having an OnErrorListener at all, will
2345         * cause the info to be discarded.
2346         */
2347        boolean onInfo(MediaPlayer mp, int what, int extra);
2348    }
2349
2350    /**
2351     * Register a callback to be invoked when an info/warning is available.
2352     *
2353     * @param listener the callback that will be run
2354     */
2355    public void setOnInfoListener(OnInfoListener listener)
2356    {
2357        mOnInfoListener = listener;
2358    }
2359
2360    private OnInfoListener mOnInfoListener;
2361
2362    /*
2363     * Test whether a given video scaling mode is supported.
2364     */
2365    private boolean isVideoScalingModeSupported(int mode) {
2366        return (mode == VIDEO_SCALING_MODE_SCALE_TO_FIT ||
2367                mode == VIDEO_SCALING_MODE_SCALE_TO_FIT_WITH_CROPPING);
2368    }
2369
2370    private Context mProxyContext = null;
2371    private ProxyReceiver mProxyReceiver = null;
2372
2373    private void setupProxyListener(Context context) {
2374        IntentFilter filter = new IntentFilter();
2375        filter.addAction(Proxy.PROXY_CHANGE_ACTION);
2376        mProxyReceiver = new ProxyReceiver();
2377        mProxyContext = context;
2378
2379        Intent currentProxy =
2380            context.getApplicationContext().registerReceiver(mProxyReceiver, filter);
2381
2382        if (currentProxy != null) {
2383            handleProxyBroadcast(currentProxy);
2384        }
2385    }
2386
2387    private void disableProxyListener() {
2388        if (mProxyReceiver == null) {
2389            return;
2390        }
2391
2392        Context appContext = mProxyContext.getApplicationContext();
2393        if (appContext != null) {
2394            appContext.unregisterReceiver(mProxyReceiver);
2395        }
2396
2397        mProxyReceiver = null;
2398        mProxyContext = null;
2399    }
2400
2401    private void handleProxyBroadcast(Intent intent) {
2402        ProxyProperties props =
2403            (ProxyProperties)intent.getExtra(Proxy.EXTRA_PROXY_INFO);
2404
2405        if (props == null || props.getHost() == null) {
2406            updateProxyConfig(null);
2407        } else {
2408            updateProxyConfig(props);
2409        }
2410    }
2411
2412    private class ProxyReceiver extends BroadcastReceiver {
2413        @Override
2414        public void onReceive(Context context, Intent intent) {
2415            if (intent.getAction().equals(Proxy.PROXY_CHANGE_ACTION)) {
2416                handleProxyBroadcast(intent);
2417            }
2418        }
2419    }
2420
2421    private native void updateProxyConfig(ProxyProperties props);
2422}
2423