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