MediaPlayer.java revision 69b8d69aadbf0e795f1a1e1adc82c78cf0b9959f
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.ParcelFileDescriptor;
28import android.os.PowerManager;
29import android.util.Log;
30import android.view.Surface;
31import android.view.SurfaceHolder;
32import android.graphics.Bitmap;
33import android.media.AudioManager;
34
35import java.io.FileDescriptor;
36import java.io.IOException;
37import java.util.Map;
38import java.util.Set;
39import java.lang.ref.WeakReference;
40
41/**
42 * MediaPlayer class can be used to control playback
43 * of audio/video files and streams. An example on how to use the methods in
44 * this class can be found in {@link android.widget.VideoView}.
45 * Please see <a href="{@docRoot}guide/topics/media/index.html">Audio and Video</a>
46 * for additional help using MediaPlayer.
47 *
48 * <p>Topics covered here are:
49 * <ol>
50 * <li><a href="#StateDiagram">State Diagram</a>
51 * <li><a href="#Valid_and_Invalid_States">Valid and Invalid States</a>
52 * <li><a href="#Permissions">Permissions</a>
53 * </ol>
54 *
55 * <a name="StateDiagram"></a>
56 * <h3>State Diagram</h3>
57 *
58 * <p>Playback control of audio/video files and streams is managed as a state
59 * machine. The following diagram shows the life cycle and the states of a
60 * MediaPlayer object driven by the supported playback control operations.
61 * The ovals represent the states a MediaPlayer object may reside
62 * in. The arcs represent the playback control operations that drive the object
63 * state transition. There are two types of arcs. The arcs with a single arrow
64 * head represent synchronous method calls, while those with
65 * a double arrow head represent asynchronous method calls.</p>
66 *
67 * <p><img src="../../../images/mediaplayer_state_diagram.gif"
68 *         alt="MediaPlayer State diagram"
69 *         border="0" /></p>
70 *
71 * <p>From this state diagram, one can see that a MediaPlayer object has the
72 *    following states:</p>
73 * <ul>
74 *     <li>When a MediaPlayer object is just created using <code>new</code> or
75 *         after {@link #reset()} is called, it is in the <em>Idle</em> state; and after
76 *         {@link #release()} is called, it is in the <em>End</em> state. Between these
77 *         two states is the life cycle of the MediaPlayer object.
78 *         <ul>
79 *         <li>There is a subtle but important difference between a newly constructed
80 *         MediaPlayer object and the MediaPlayer object after {@link #reset()}
81 *         is called. It is a programming error to invoke methods such
82 *         as {@link #getCurrentPosition()},
83 *         {@link #getDuration()}, {@link #getVideoHeight()},
84 *         {@link #getVideoWidth()}, {@link #setAudioStreamType(int)},
85 *         {@link #setLooping(boolean)},
86 *         {@link #setVolume(float, float)}, {@link #pause()}, {@link #start()},
87 *         {@link #stop()}, {@link #seekTo(int)}, {@link #prepare()} or
88 *         {@link #prepareAsync()} in the <em>Idle</em> state for both cases. If any of these
89 *         methods is called right after a MediaPlayer object is constructed,
90 *         the user supplied callback method OnErrorListener.onError() won't be
91 *         called by the internal player engine and the object state remains
92 *         unchanged; but if these methods are called right after {@link #reset()},
93 *         the user supplied callback method OnErrorListener.onError() will be
94 *         invoked by the internal player engine and the object will be
95 *         transfered to the <em>Error</em> state. </li>
96 *         <li>It is also recommended that once
97 *         a MediaPlayer object is no longer being used, call {@link #release()} immediately
98 *         so that resources used by the internal player engine associated with the
99 *         MediaPlayer object can be released immediately. Resource may include
100 *         singleton resources such as hardware acceleration components and
101 *         failure to call {@link #release()} may cause subsequent instances of
102 *         MediaPlayer objects to fallback to software implementations or fail
103 *         altogether. Once the MediaPlayer
104 *         object is in the <em>End</em> state, it can no longer be used and
105 *         there is no way to bring it back to any other state. </li>
106 *         <li>Furthermore,
107 *         the MediaPlayer objects created using <code>new</code> is in the
108 *         <em>Idle</em> state, while those created with one
109 *         of the overloaded convenient <code>create</code> methods are <em>NOT</em>
110 *         in the <em>Idle</em> state. In fact, the objects are in the <em>Prepared</em>
111 *         state if the creation using <code>create</code> method is successful.
112 *         </li>
113 *         </ul>
114 *         </li>
115 *     <li>In general, some playback control operation may fail due to various
116 *         reasons, such as unsupported audio/video format, poorly interleaved
117 *         audio/video, resolution too high, streaming timeout, and the like.
118 *         Thus, error reporting and recovery is an important concern under
119 *         these circumstances. Sometimes, due to programming errors, invoking a playback
120 *         control operation in an invalid state may also occur. Under all these
121 *         error conditions, the internal player engine invokes a user supplied
122 *         OnErrorListener.onError() method if an OnErrorListener has been
123 *         registered beforehand via
124 *         {@link #setOnErrorListener(android.media.MediaPlayer.OnErrorListener)}.
125 *         <ul>
126 *         <li>It is important to note that once an error occurs, the
127 *         MediaPlayer object enters the <em>Error</em> state (except as noted
128 *         above), even if an error listener has not been registered by the application.</li>
129 *         <li>In order to reuse a MediaPlayer object that is in the <em>
130 *         Error</em> state and recover from the error,
131 *         {@link #reset()} can be called to restore the object to its <em>Idle</em>
132 *         state.</li>
133 *         <li>It is good programming practice to have your application
134 *         register a OnErrorListener to look out for error notifications from
135 *         the internal player engine.</li>
136 *         <li>IllegalStateException is
137 *         thrown to prevent programming errors such as calling {@link #prepare()},
138 *         {@link #prepareAsync()}, or one of the overloaded <code>setDataSource
139 *         </code> methods in an invalid state. </li>
140 *         </ul>
141 *         </li>
142 *     <li>Calling
143 *         {@link #setDataSource(FileDescriptor)}, or
144 *         {@link #setDataSource(String)}, or
145 *         {@link #setDataSource(Context, Uri)}, or
146 *         {@link #setDataSource(FileDescriptor, long, long)} transfers a
147 *         MediaPlayer object in the <em>Idle</em> state to the
148 *         <em>Initialized</em> state.
149 *         <ul>
150 *         <li>An IllegalStateException is thrown if
151 *         setDataSource() is called in any other state.</li>
152 *         <li>It is good programming
153 *         practice to always look out for <code>IllegalArgumentException</code>
154 *         and <code>IOException</code> that may be thrown from the overloaded
155 *         <code>setDataSource</code> methods.</li>
156 *         </ul>
157 *         </li>
158 *     <li>A MediaPlayer object must first enter the <em>Prepared</em> state
159 *         before playback can be started.
160 *         <ul>
161 *         <li>There are two ways (synchronous vs.
162 *         asynchronous) that the <em>Prepared</em> state can be reached:
163 *         either a call to {@link #prepare()} (synchronous) which
164 *         transfers the object to the <em>Prepared</em> state once the method call
165 *         returns, or a call to {@link #prepareAsync()} (asynchronous) which
166 *         first transfers the object to the <em>Preparing</em> state after the
167 *         call returns (which occurs almost right way) while the internal
168 *         player engine continues working on the rest of preparation work
169 *         until the preparation work completes. When the preparation completes or when {@link #prepare()} call returns,
170 *         the internal player engine then calls a user supplied callback method,
171 *         onPrepared() of the OnPreparedListener interface, if an
172 *         OnPreparedListener is registered beforehand via {@link
173 *         #setOnPreparedListener(android.media.MediaPlayer.OnPreparedListener)}.</li>
174 *         <li>It is important to note that
175 *         the <em>Preparing</em> state is a transient state, and the behavior
176 *         of calling any method with side effect while a MediaPlayer object is
177 *         in the <em>Preparing</em> state is undefined.</li>
178 *         <li>An IllegalStateException is
179 *         thrown if {@link #prepare()} or {@link #prepareAsync()} is called in
180 *         any other state.</li>
181 *         <li>While in the <em>Prepared</em> state, properties
182 *         such as audio/sound volume, screenOnWhilePlaying, looping can be
183 *         adjusted by invoking the corresponding set methods.</li>
184 *         </ul>
185 *         </li>
186 *     <li>To start the playback, {@link #start()} must be called. After
187 *         {@link #start()} returns successfully, the MediaPlayer object is in the
188 *         <em>Started</em> state. {@link #isPlaying()} can be called to test
189 *         whether the MediaPlayer object is in the <em>Started</em> state.
190 *         <ul>
191 *         <li>While in the <em>Started</em> state, the internal player engine calls
192 *         a user supplied OnBufferingUpdateListener.onBufferingUpdate() callback
193 *         method if a OnBufferingUpdateListener has been registered beforehand
194 *         via {@link #setOnBufferingUpdateListener(OnBufferingUpdateListener)}.
195 *         This callback allows applications to keep track of the buffering status
196 *         while streaming audio/video.</li>
197 *         <li>Calling {@link #start()} has not effect
198 *         on a MediaPlayer object that is already in the <em>Started</em> state.</li>
199 *         </ul>
200 *         </li>
201 *     <li>Playback can be paused and stopped, and the current playback position
202 *         can be adjusted. Playback can be paused via {@link #pause()}. When the call to
203 *         {@link #pause()} returns, the MediaPlayer object enters the
204 *         <em>Paused</em> state. Note that the transition from the <em>Started</em>
205 *         state to the <em>Paused</em> state and vice versa happens
206 *         asynchronously in the player engine. It may take some time before
207 *         the state is updated in calls to {@link #isPlaying()}, and it can be
208 *         a number of seconds in the case of streamed content.
209 *         <ul>
210 *         <li>Calling {@link #start()} to resume playback for a paused
211 *         MediaPlayer object, and the resumed playback
212 *         position is the same as where it was paused. When the call to
213 *         {@link #start()} returns, the paused MediaPlayer object goes back to
214 *         the <em>Started</em> state.</li>
215 *         <li>Calling {@link #pause()} has no effect on
216 *         a MediaPlayer object that is already in the <em>Paused</em> state.</li>
217 *         </ul>
218 *         </li>
219 *     <li>Calling  {@link #stop()} stops playback and causes a
220 *         MediaPlayer in the <em>Started</em>, <em>Paused</em>, <em>Prepared
221 *         </em> or <em>PlaybackCompleted</em> state to enter the
222 *         <em>Stopped</em> state.
223 *         <ul>
224 *         <li>Once in the <em>Stopped</em> state, playback cannot be started
225 *         until {@link #prepare()} or {@link #prepareAsync()} are called to set
226 *         the MediaPlayer object to the <em>Prepared</em> state again.</li>
227 *         <li>Calling {@link #stop()} has no effect on a MediaPlayer
228 *         object that is already in the <em>Stopped</em> state.</li>
229 *         </ul>
230 *         </li>
231 *     <li>The playback position can be adjusted with a call to
232 *         {@link #seekTo(int)}.
233 *         <ul>
234 *         <li>Although the asynchronuous {@link #seekTo(int)}
235 *         call returns right way, the actual seek operation may take a while to
236 *         finish, especially for audio/video being streamed. When the actual
237 *         seek operation completes, the internal player engine calls a user
238 *         supplied OnSeekComplete.onSeekComplete() if an OnSeekCompleteListener
239 *         has been registered beforehand via
240 *         {@link #setOnSeekCompleteListener(OnSeekCompleteListener)}.</li>
241 *         <li>Please
242 *         note that {@link #seekTo(int)} can also be called in the other states,
243 *         such as <em>Prepared</em>, <em>Paused</em> and <em>PlaybackCompleted
244 *         </em> state.</li>
245 *         <li>Furthermore, the actual current playback position
246 *         can be retrieved with a call to {@link #getCurrentPosition()}, which
247 *         is helpful for applications such as a Music player that need to keep
248 *         track of the playback progress.</li>
249 *         </ul>
250 *         </li>
251 *     <li>When the playback reaches the end of stream, the playback completes.
252 *         <ul>
253 *         <li>If the looping mode was being set to <var>true</var>with
254 *         {@link #setLooping(boolean)}, the MediaPlayer object shall remain in
255 *         the <em>Started</em> state.</li>
256 *         <li>If the looping mode was set to <var>false
257 *         </var>, the player engine calls a user supplied callback method,
258 *         OnCompletion.onCompletion(), if a OnCompletionListener is registered
259 *         beforehand via {@link #setOnCompletionListener(OnCompletionListener)}.
260 *         The invoke of the callback signals that the object is now in the <em>
261 *         PlaybackCompleted</em> state.</li>
262 *         <li>While in the <em>PlaybackCompleted</em>
263 *         state, calling {@link #start()} can restart the playback from the
264 *         beginning of the audio/video source.</li>
265 * </ul>
266 *
267 *
268 * <a name="Valid_and_Invalid_States"></a>
269 * <h3>Valid and invalid states</h3>
270 *
271 * <table border="0" cellspacing="0" cellpadding="0">
272 * <tr><td>Method Name </p></td>
273 *     <td>Valid Sates </p></td>
274 *     <td>Invalid States </p></td>
275 *     <td>Comments </p></td></tr>
276 * <tr><td>attachAuxEffect </p></td>
277 *     <td>{Initialized, Prepared, Started, Paused, Stopped, PlaybackCompleted} </p></td>
278 *     <td>{Idle, Error} </p></td>
279 *     <td>This method must be called after setDataSource.
280 *     Calling it does not change the object state. </p></td></tr>
281 * <tr><td>getAudioSessionId </p></td>
282 *     <td>any </p></td>
283 *     <td>{} </p></td>
284 *     <td>This method can be called in any state and calling it does not change
285 *         the object state. </p></td></tr>
286 * <tr><td>getCurrentPosition </p></td>
287 *     <td>{Idle, Initialized, Prepared, Started, Paused, Stopped,
288 *         PlaybackCompleted} </p></td>
289 *     <td>{Error}</p></td>
290 *     <td>Successful invoke of this method in a valid state does not change the
291 *         state. Calling this method in an invalid state transfers the object
292 *         to the <em>Error</em> state. </p></td></tr>
293 * <tr><td>getDuration </p></td>
294 *     <td>{Prepared, Started, Paused, Stopped, PlaybackCompleted} </p></td>
295 *     <td>{Idle, Initialized, Error} </p></td>
296 *     <td>Successful invoke of this method in a valid state does not change the
297 *         state. Calling this method in an invalid state transfers the object
298 *         to the <em>Error</em> state. </p></td></tr>
299 * <tr><td>getVideoHeight </p></td>
300 *     <td>{Idle, Initialized, Prepared, Started, Paused, Stopped,
301 *         PlaybackCompleted}</p></td>
302 *     <td>{Error}</p></td>
303 *     <td>Successful invoke of this method in a valid state does not change the
304 *         state. Calling this method in an invalid state transfers the object
305 *         to the <em>Error</em> state.  </p></td></tr>
306 * <tr><td>getVideoWidth </p></td>
307 *     <td>{Idle, Initialized, Prepared, Started, Paused, Stopped,
308 *         PlaybackCompleted}</p></td>
309 *     <td>{Error}</p></td>
310 *     <td>Successful invoke of this method in a valid state does not change
311 *         the state. Calling this method in an invalid state transfers the
312 *         object to the <em>Error</em> state. </p></td></tr>
313 * <tr><td>isPlaying </p></td>
314 *     <td>{Idle, Initialized, Prepared, Started, Paused, Stopped,
315 *          PlaybackCompleted}</p></td>
316 *     <td>{Error}</p></td>
317 *     <td>Successful invoke of this method in a valid state does not change
318 *         the state. Calling this method in an invalid state transfers the
319 *         object to the <em>Error</em> state. </p></td></tr>
320 * <tr><td>pause </p></td>
321 *     <td>{Started, Paused}</p></td>
322 *     <td>{Idle, Initialized, Prepared, Stopped, PlaybackCompleted, Error}</p></td>
323 *     <td>Successful invoke of this method in a valid state transfers the
324 *         object to the <em>Paused</em> state. Calling this method in an
325 *         invalid state transfers the object to the <em>Error</em> state.</p></td></tr>
326 * <tr><td>prepare </p></td>
327 *     <td>{Initialized, Stopped} </p></td>
328 *     <td>{Idle, Prepared, Started, Paused, PlaybackCompleted, Error} </p></td>
329 *     <td>Successful invoke of this method in a valid state transfers the
330 *         object to the <em>Prepared</em> state. Calling this method in an
331 *         invalid state throws an IllegalStateException.</p></td></tr>
332 * <tr><td>prepareAsync </p></td>
333 *     <td>{Initialized, Stopped} </p></td>
334 *     <td>{Idle, Prepared, Started, Paused, PlaybackCompleted, Error} </p></td>
335 *     <td>Successful invoke of this method in a valid state transfers the
336 *         object to the <em>Preparing</em> state. Calling this method in an
337 *         invalid state throws an IllegalStateException.</p></td></tr>
338 * <tr><td>release </p></td>
339 *     <td>any </p></td>
340 *     <td>{} </p></td>
341 *     <td>After {@link #release()}, the object is no longer available. </p></td></tr>
342 * <tr><td>reset </p></td>
343 *     <td>{Idle, Initialized, Prepared, Started, Paused, Stopped,
344 *         PlaybackCompleted, Error}</p></td>
345 *     <td>{}</p></td>
346 *     <td>After {@link #reset()}, the object is like being just created.</p></td></tr>
347 * <tr><td>seekTo </p></td>
348 *     <td>{Prepared, Started, Paused, PlaybackCompleted} </p></td>
349 *     <td>{Idle, Initialized, Stopped, Error}</p></td>
350 *     <td>Successful invoke of this method in a valid state does not change
351 *         the state. Calling this method in an invalid state transfers the
352 *         object to the <em>Error</em> state. </p></td></tr>
353 * <tr><td>setAudioSessionId </p></td>
354 *     <td>{Idle} </p></td>
355 *     <td>{Initialized, Prepared, Started, Paused, Stopped, PlaybackCompleted,
356 *          Error} </p></td>
357 *     <td>This method must be called in idle state as the audio session ID must be known before
358 *         calling setDataSource. Calling it does not change the object state. </p></td></tr>
359 * <tr><td>setAudioStreamType </p></td>
360 *     <td>{Idle, Initialized, Stopped, Prepared, Started, Paused,
361 *          PlaybackCompleted}</p></td>
362 *     <td>{Error}</p></td>
363 *     <td>Successful invoke of this method does not change the state. In order for the
364 *         target audio stream type to become effective, this method must be called before
365 *         prepare() or prepareAsync().</p></td></tr>
366 * <tr><td>setAuxEffectSendLevel </p></td>
367 *     <td>any</p></td>
368 *     <td>{} </p></td>
369 *     <td>Calling this method does not change the object state. </p></td></tr>
370 * <tr><td>setDataSource </p></td>
371 *     <td>{Idle} </p></td>
372 *     <td>{Initialized, Prepared, Started, Paused, Stopped, PlaybackCompleted,
373 *          Error} </p></td>
374 *     <td>Successful invoke of this method in a valid state transfers the
375 *         object to the <em>Initialized</em> state. Calling this method in an
376 *         invalid state throws an IllegalStateException.</p></td></tr>
377 * <tr><td>setDisplay </p></td>
378 *     <td>any </p></td>
379 *     <td>{} </p></td>
380 *     <td>This method can be called in any state and calling it does not change
381 *         the object state. </p></td></tr>
382 * <tr><td>setLooping </p></td>
383 *     <td>{Idle, Initialized, Stopped, Prepared, Started, Paused,
384 *         PlaybackCompleted}</p></td>
385 *     <td>{Error}</p></td>
386 *     <td>Successful invoke of this method in a valid state does not change
387 *         the state. Calling this method in an
388 *         invalid state transfers the object to the <em>Error</em> state.</p></td></tr>
389 * <tr><td>isLooping </p></td>
390 *     <td>any </p></td>
391 *     <td>{} </p></td>
392 *     <td>This method can be called in any state and calling it does not change
393 *         the object state. </p></td></tr>
394 * <tr><td>setOnBufferingUpdateListener </p></td>
395 *     <td>any </p></td>
396 *     <td>{} </p></td>
397 *     <td>This method can be called in any state and calling it does not change
398 *         the object state. </p></td></tr>
399 * <tr><td>setOnCompletionListener </p></td>
400 *     <td>any </p></td>
401 *     <td>{} </p></td>
402 *     <td>This method can be called in any state and calling it does not change
403 *         the object state. </p></td></tr>
404 * <tr><td>setOnErrorListener </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>setOnPreparedListener </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>setOnSeekCompleteListener </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>setScreenOnWhilePlaying</></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>setVolume </p></td>
425 *     <td>{Idle, Initialized, Stopped, Prepared, Started, Paused,
426 *          PlaybackCompleted}</p></td>
427 *     <td>{Error}</p></td>
428 *     <td>Successful invoke of this method does not change the state.
429 * <tr><td>setWakeMode </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>start </p></td>
435 *     <td>{Prepared, Started, Paused, PlaybackCompleted}</p></td>
436 *     <td>{Idle, Initialized, Stopped, Error}</p></td>
437 *     <td>Successful invoke of this method in a valid state transfers the
438 *         object to the <em>Started</em> state. Calling this method in an
439 *         invalid state transfers the object to the <em>Error</em> state.</p></td></tr>
440 * <tr><td>stop </p></td>
441 *     <td>{Prepared, Started, Stopped, Paused, PlaybackCompleted}</p></td>
442 *     <td>{Idle, Initialized, Error}</p></td>
443 *     <td>Successful invoke of this method in a valid state transfers the
444 *         object to the <em>Stopped</em> state. Calling this method in an
445 *         invalid state transfers the object to the <em>Error</em> state.</p></td></tr>
446 *
447 * </table>
448 *
449 * <a name="Permissions"></a>
450 * <h3>Permissions</h3>
451 * <p>One may need to declare a corresponding WAKE_LOCK permission {@link
452 * android.R.styleable#AndroidManifestUsesPermission &lt;uses-permission&gt;}
453 * element.
454 *
455 */
456public class MediaPlayer
457{
458    /**
459       Constant to retrieve only the new metadata since the last
460       call.
461       // FIXME: unhide.
462       // FIXME: add link to getMetadata(boolean, boolean)
463       {@hide}
464     */
465    public static final boolean METADATA_UPDATE_ONLY = true;
466
467    /**
468       Constant to retrieve all the metadata.
469       // FIXME: unhide.
470       // FIXME: add link to getMetadata(boolean, boolean)
471       {@hide}
472     */
473    public static final boolean METADATA_ALL = false;
474
475    /**
476       Constant to enable the metadata filter during retrieval.
477       // FIXME: unhide.
478       // FIXME: add link to getMetadata(boolean, boolean)
479       {@hide}
480     */
481    public static final boolean APPLY_METADATA_FILTER = true;
482
483    /**
484       Constant to disable the metadata filter during retrieval.
485       // FIXME: unhide.
486       // FIXME: add link to getMetadata(boolean, boolean)
487       {@hide}
488     */
489    public static final boolean BYPASS_METADATA_FILTER = false;
490
491    static {
492        System.loadLibrary("media_jni");
493        native_init();
494    }
495
496    private final static String TAG = "MediaPlayer";
497    // Name of the remote interface for the media player. Must be kept
498    // in sync with the 2nd parameter of the IMPLEMENT_META_INTERFACE
499    // macro invocation in IMediaPlayer.cpp
500    private final static String IMEDIA_PLAYER = "android.media.IMediaPlayer";
501
502    private int mNativeContext; // accessed by native methods
503    private int mListenerContext; // accessed by native methods
504    private Surface mSurface; // accessed by native methods
505    private SurfaceHolder  mSurfaceHolder;
506    private EventHandler mEventHandler;
507    private PowerManager.WakeLock mWakeLock = null;
508    private boolean mScreenOnWhilePlaying;
509    private boolean mStayAwake;
510
511    /**
512     * Default constructor. Consider using one of the create() methods for
513     * synchronously instantiating a MediaPlayer from a Uri or resource.
514     * <p>When done with the MediaPlayer, you should call  {@link #release()},
515     * to free the resources. If not released, too many MediaPlayer instances may
516     * result in an exception.</p>
517     */
518    public MediaPlayer() {
519
520        Looper looper;
521        if ((looper = Looper.myLooper()) != null) {
522            mEventHandler = new EventHandler(this, looper);
523        } else if ((looper = Looper.getMainLooper()) != null) {
524            mEventHandler = new EventHandler(this, looper);
525        } else {
526            mEventHandler = null;
527        }
528
529        /* Native setup requires a weak reference to our object.
530         * It's easier to create it here than in C++.
531         */
532        native_setup(new WeakReference<MediaPlayer>(this));
533    }
534
535    /*
536     * Update the MediaPlayer ISurface. Call after updating mSurface.
537     */
538    private native void _setVideoSurface();
539
540    /**
541     * Create a request parcel which can be routed to the native media
542     * player using {@link #invoke(Parcel, Parcel)}. The Parcel
543     * returned has the proper InterfaceToken set. The caller should
544     * not overwrite that token, i.e it can only append data to the
545     * Parcel.
546     *
547     * @return A parcel suitable to hold a request for the native
548     * player.
549     * {@hide}
550     */
551    public Parcel newRequest() {
552        Parcel parcel = Parcel.obtain();
553        parcel.writeInterfaceToken(IMEDIA_PLAYER);
554        return parcel;
555    }
556
557    /**
558     * Invoke a generic method on the native player using opaque
559     * parcels for the request and reply. Both payloads' format is a
560     * convention between the java caller and the native player.
561     * Must be called after setDataSource to make sure a native player
562     * exists.
563     *
564     * @param request Parcel with the data for the extension. The
565     * caller must use {@link #newRequest()} to get one.
566     *
567     * @param reply Output parcel with the data returned by the
568     * native player.
569     *
570     * @return The status code see utils/Errors.h
571     * {@hide}
572     */
573    public int invoke(Parcel request, Parcel reply) {
574        int retcode = native_invoke(request, reply);
575        reply.setDataPosition(0);
576        return retcode;
577    }
578
579    /**
580     * Sets the SurfaceHolder to use for displaying the video portion of the media.
581     * This call is optional. Not calling it when playing back a video will
582     * result in only the audio track being played.
583     *
584     * @param sh the SurfaceHolder to use for video display
585     */
586    public void setDisplay(SurfaceHolder sh) {
587        mSurfaceHolder = sh;
588        if (sh != null) {
589            mSurface = sh.getSurface();
590        } else {
591            mSurface = null;
592        }
593        _setVideoSurface();
594        updateSurfaceScreenOn();
595    }
596
597    /**
598     * Convenience method to create a MediaPlayer for a given Uri.
599     * On success, {@link #prepare()} will already have been called and must not be called again.
600     * <p>When done with the MediaPlayer, you should call  {@link #release()},
601     * to free the resources. If not released, too many MediaPlayer instances will
602     * result in an exception.</p>
603     *
604     * @param context the Context to use
605     * @param uri the Uri from which to get the datasource
606     * @return a MediaPlayer object, or null if creation failed
607     */
608    public static MediaPlayer create(Context context, Uri uri) {
609        return create (context, uri, null);
610    }
611
612    /**
613     * Convenience method to create a MediaPlayer for a given Uri.
614     * On success, {@link #prepare()} will already have been called and must not be called again.
615     * <p>When done with the MediaPlayer, you should call  {@link #release()},
616     * to free the resources. If not released, too many MediaPlayer instances will
617     * result in an exception.</p>
618     *
619     * @param context the Context to use
620     * @param uri the Uri from which to get the datasource
621     * @param holder the SurfaceHolder to use for displaying the video
622     * @return a MediaPlayer object, or null if creation failed
623     */
624    public static MediaPlayer create(Context context, Uri uri, SurfaceHolder holder) {
625
626        try {
627            MediaPlayer mp = new MediaPlayer();
628            mp.setDataSource(context, uri);
629            if (holder != null) {
630                mp.setDisplay(holder);
631            }
632            mp.prepare();
633            return mp;
634        } catch (IOException ex) {
635            Log.d(TAG, "create failed:", ex);
636            // fall through
637        } catch (IllegalArgumentException ex) {
638            Log.d(TAG, "create failed:", ex);
639            // fall through
640        } catch (SecurityException ex) {
641            Log.d(TAG, "create failed:", ex);
642            // fall through
643        }
644
645        return null;
646    }
647
648    /**
649     * Convenience method to create a MediaPlayer for a given resource id.
650     * On success, {@link #prepare()} will already have been called and must not be called again.
651     * <p>When done with the MediaPlayer, you should call  {@link #release()},
652     * to free the resources. If not released, too many MediaPlayer instances will
653     * result in an exception.</p>
654     *
655     * @param context the Context to use
656     * @param resid the raw resource id (<var>R.raw.&lt;something></var>) for
657     *              the resource to use as the datasource
658     * @return a MediaPlayer object, or null if creation failed
659     */
660    public static MediaPlayer create(Context context, int resid) {
661        try {
662            AssetFileDescriptor afd = context.getResources().openRawResourceFd(resid);
663            if (afd == null) return null;
664
665            MediaPlayer mp = new MediaPlayer();
666            mp.setDataSource(afd.getFileDescriptor(), afd.getStartOffset(), afd.getLength());
667            afd.close();
668            mp.prepare();
669            return mp;
670        } catch (IOException ex) {
671            Log.d(TAG, "create failed:", ex);
672            // fall through
673        } catch (IllegalArgumentException ex) {
674            Log.d(TAG, "create failed:", ex);
675           // fall through
676        } catch (SecurityException ex) {
677            Log.d(TAG, "create failed:", ex);
678            // fall through
679        }
680        return null;
681    }
682
683    /**
684     * Sets the data source as a content Uri.
685     *
686     * @param context the Context to use when resolving the Uri
687     * @param uri the Content URI of the data you want to play
688     * @throws IllegalStateException if it is called in an invalid state
689     */
690    public void setDataSource(Context context, Uri uri)
691        throws IOException, IllegalArgumentException, SecurityException, IllegalStateException {
692        setDataSource(context, uri, null);
693    }
694
695    /**
696     * Sets the data source as a content Uri.
697     *
698     * @param context the Context to use when resolving the Uri
699     * @param uri the Content URI of the data you want to play
700     * @param headers the headers to be sent together with the request for the data
701     * @throws IllegalStateException if it is called in an invalid state
702     * @hide pending API council
703     */
704    public void setDataSource(Context context, Uri uri, Map<String, String> headers)
705        throws IOException, IllegalArgumentException, SecurityException, IllegalStateException {
706
707        String scheme = uri.getScheme();
708        if(scheme == null || scheme.equals("file")) {
709            setDataSource(uri.getPath());
710            return;
711        }
712
713        AssetFileDescriptor fd = null;
714        try {
715            ContentResolver resolver = context.getContentResolver();
716            fd = resolver.openAssetFileDescriptor(uri, "r");
717            if (fd == null) {
718                return;
719            }
720            // Note: using getDeclaredLength so that our behavior is the same
721            // as previous versions when the content provider is returning
722            // a full file.
723            if (fd.getDeclaredLength() < 0) {
724                setDataSource(fd.getFileDescriptor());
725            } else {
726                setDataSource(fd.getFileDescriptor(), fd.getStartOffset(), fd.getDeclaredLength());
727            }
728            return;
729        } catch (SecurityException ex) {
730        } catch (IOException ex) {
731        } finally {
732            if (fd != null) {
733                fd.close();
734            }
735        }
736        Log.d(TAG, "Couldn't open file on client side, trying server side");
737        setDataSource(uri.toString(), headers);
738        return;
739    }
740
741    /**
742     * Sets the data source (file-path or http/rtsp URL) to use.
743     *
744     * @param path the path of the file, or the http/rtsp URL of the stream you want to play
745     * @throws IllegalStateException if it is called in an invalid state
746     */
747    public native void setDataSource(String path) throws IOException, IllegalArgumentException, IllegalStateException;
748
749    /**
750     * Sets the data source (file-path or http/rtsp URL) to use.
751     *
752     * @param path the path of the file, or the http/rtsp URL of the stream you want to play
753     * @param headers the headers associated with the http request for the stream you want to play
754     * @throws IllegalStateException if it is called in an invalid state
755     * @hide pending API council
756     */
757    public native void setDataSource(String path,  Map<String, String> headers)
758            throws IOException, IllegalArgumentException, IllegalStateException;
759
760    /**
761     * Sets the data source (FileDescriptor) to use. It is the caller's responsibility
762     * to close the file descriptor. It is safe to do so as soon as this call returns.
763     *
764     * @param fd the FileDescriptor for the file you want to play
765     * @throws IllegalStateException if it is called in an invalid state
766     */
767    public void setDataSource(FileDescriptor fd)
768            throws IOException, IllegalArgumentException, IllegalStateException {
769        // intentionally less than LONG_MAX
770        setDataSource(fd, 0, 0x7ffffffffffffffL);
771    }
772
773    /**
774     * Sets the data source (FileDescriptor) to use.  The FileDescriptor must be
775     * seekable (N.B. a LocalSocket is not seekable). It is the caller's responsibility
776     * to close the file descriptor. It is safe to do so as soon as this call returns.
777     *
778     * @param fd the FileDescriptor for the file you want to play
779     * @param offset the offset into the file where the data to be played starts, in bytes
780     * @param length the length in bytes of the data to be played
781     * @throws IllegalStateException if it is called in an invalid state
782     */
783    public native void setDataSource(FileDescriptor fd, long offset, long length)
784            throws IOException, IllegalArgumentException, IllegalStateException;
785
786    /**
787     * Prepares the player for playback, synchronously.
788     *
789     * After setting the datasource and the display surface, you need to either
790     * call prepare() or prepareAsync(). For files, it is OK to call prepare(),
791     * which blocks until MediaPlayer is ready for playback.
792     *
793     * @throws IllegalStateException if it is called in an invalid state
794     */
795    public native void prepare() throws IOException, IllegalStateException;
796
797    /**
798     * Prepares the player for playback, asynchronously.
799     *
800     * After setting the datasource and the display surface, you need to either
801     * call prepare() or prepareAsync(). For streams, you should call prepareAsync(),
802     * which returns immediately, rather than blocking until enough data has been
803     * buffered.
804     *
805     * @throws IllegalStateException if it is called in an invalid state
806     */
807    public native void prepareAsync() throws IllegalStateException;
808
809    /**
810     * Starts or resumes playback. If playback had previously been paused,
811     * playback will continue from where it was paused. If playback had
812     * been stopped, or never started before, playback will start at the
813     * beginning.
814     *
815     * @throws IllegalStateException if it is called in an invalid state
816     */
817    public  void start() throws IllegalStateException {
818        stayAwake(true);
819        _start();
820    }
821
822    private native void _start() throws IllegalStateException;
823
824    /**
825     * Stops playback after playback has been stopped or paused.
826     *
827     * @throws IllegalStateException if the internal player engine has not been
828     * initialized.
829     */
830    public void stop() throws IllegalStateException {
831        stayAwake(false);
832        _stop();
833    }
834
835    private native void _stop() throws IllegalStateException;
836
837    /**
838     * Pauses playback. Call start() to resume.
839     *
840     * @throws IllegalStateException if the internal player engine has not been
841     * initialized.
842     */
843    public void pause() throws IllegalStateException {
844        stayAwake(false);
845        _pause();
846    }
847
848    private native void _pause() throws IllegalStateException;
849
850    /**
851     * Set the low-level power management behavior for this MediaPlayer.  This
852     * can be used when the MediaPlayer is not playing through a SurfaceHolder
853     * set with {@link #setDisplay(SurfaceHolder)} and thus can use the
854     * high-level {@link #setScreenOnWhilePlaying(boolean)} feature.
855     *
856     * <p>This function has the MediaPlayer access the low-level power manager
857     * service to control the device's power usage while playing is occurring.
858     * The parameter is a combination of {@link android.os.PowerManager} wake flags.
859     * Use of this method requires {@link android.Manifest.permission#WAKE_LOCK}
860     * permission.
861     * By default, no attempt is made to keep the device awake during playback.
862     *
863     * @param context the Context to use
864     * @param mode    the power/wake mode to set
865     * @see android.os.PowerManager
866     */
867    public void setWakeMode(Context context, int mode) {
868        boolean washeld = false;
869        if (mWakeLock != null) {
870            if (mWakeLock.isHeld()) {
871                washeld = true;
872                mWakeLock.release();
873            }
874            mWakeLock = null;
875        }
876
877        PowerManager pm = (PowerManager)context.getSystemService(Context.POWER_SERVICE);
878        mWakeLock = pm.newWakeLock(mode|PowerManager.ON_AFTER_RELEASE, MediaPlayer.class.getName());
879        mWakeLock.setReferenceCounted(false);
880        if (washeld) {
881            mWakeLock.acquire();
882        }
883    }
884
885    /**
886     * Control whether we should use the attached SurfaceHolder to keep the
887     * screen on while video playback is occurring.  This is the preferred
888     * method over {@link #setWakeMode} where possible, since it doesn't
889     * require that the application have permission for low-level wake lock
890     * access.
891     *
892     * @param screenOn Supply true to keep the screen on, false to allow it
893     * to turn off.
894     */
895    public void setScreenOnWhilePlaying(boolean screenOn) {
896        if (mScreenOnWhilePlaying != screenOn) {
897            mScreenOnWhilePlaying = screenOn;
898            updateSurfaceScreenOn();
899        }
900    }
901
902    private void stayAwake(boolean awake) {
903        if (mWakeLock != null) {
904            if (awake && !mWakeLock.isHeld()) {
905                mWakeLock.acquire();
906            } else if (!awake && mWakeLock.isHeld()) {
907                mWakeLock.release();
908            }
909        }
910        mStayAwake = awake;
911        updateSurfaceScreenOn();
912    }
913
914    private void updateSurfaceScreenOn() {
915        if (mSurfaceHolder != null) {
916            mSurfaceHolder.setKeepScreenOn(mScreenOnWhilePlaying && mStayAwake);
917        }
918    }
919
920    /**
921     * Returns the width of the video.
922     *
923     * @return the width of the video, or 0 if there is no video,
924     * no display surface was set, or the width has not been determined
925     * yet. The OnVideoSizeChangedListener can be registered via
926     * {@link #setOnVideoSizeChangedListener(OnVideoSizeChangedListener)}
927     * to provide a notification when the width is available.
928     */
929    public native int getVideoWidth();
930
931    /**
932     * Returns the height of the video.
933     *
934     * @return the height of the video, or 0 if there is no video,
935     * no display surface was set, or the height has not been determined
936     * yet. The OnVideoSizeChangedListener can be registered via
937     * {@link #setOnVideoSizeChangedListener(OnVideoSizeChangedListener)}
938     * to provide a notification when the height is available.
939     */
940    public native int getVideoHeight();
941
942    /**
943     * Checks whether the MediaPlayer is playing.
944     *
945     * @return true if currently playing, false otherwise
946     */
947    public native boolean isPlaying();
948
949    /**
950     * Seeks to specified time position.
951     *
952     * @param msec the offset in milliseconds from the start to seek to
953     * @throws IllegalStateException if the internal player engine has not been
954     * initialized
955     */
956    public native void seekTo(int msec) throws IllegalStateException;
957
958    /**
959     * Gets the current playback position.
960     *
961     * @return the current position in milliseconds
962     */
963    public native int getCurrentPosition();
964
965    /**
966     * Gets the duration of the file.
967     *
968     * @return the duration in milliseconds
969     */
970    public native int getDuration();
971
972    /**
973     * Gets the media metadata.
974     *
975     * @param update_only controls whether the full set of available
976     * metadata is returned or just the set that changed since the
977     * last call. See {@see #METADATA_UPDATE_ONLY} and {@see
978     * #METADATA_ALL}.
979     *
980     * @param apply_filter if true only metadata that matches the
981     * filter is returned. See {@see #APPLY_METADATA_FILTER} and {@see
982     * #BYPASS_METADATA_FILTER}.
983     *
984     * @return The metadata, possibly empty. null if an error occured.
985     // FIXME: unhide.
986     * {@hide}
987     */
988    public Metadata getMetadata(final boolean update_only,
989                                final boolean apply_filter) {
990        Parcel reply = Parcel.obtain();
991        Metadata data = new Metadata();
992
993        if (!native_getMetadata(update_only, apply_filter, reply)) {
994            reply.recycle();
995            return null;
996        }
997
998        // Metadata takes over the parcel, don't recycle it unless
999        // there is an error.
1000        if (!data.parse(reply)) {
1001            reply.recycle();
1002            return null;
1003        }
1004        return data;
1005    }
1006
1007    /**
1008     * Set a filter for the metadata update notification and update
1009     * retrieval. The caller provides 2 set of metadata keys, allowed
1010     * and blocked. The blocked set always takes precedence over the
1011     * allowed one.
1012     * Metadata.MATCH_ALL and Metadata.MATCH_NONE are 2 sets available as
1013     * shorthands to allow/block all or no metadata.
1014     *
1015     * By default, there is no filter set.
1016     *
1017     * @param allow Is the set of metadata the client is interested
1018     *              in receiving new notifications for.
1019     * @param block Is the set of metadata the client is not interested
1020     *              in receiving new notifications for.
1021     * @return The call status code.
1022     *
1023     // FIXME: unhide.
1024     * {@hide}
1025     */
1026    public int setMetadataFilter(Set<Integer> allow, Set<Integer> block) {
1027        // Do our serialization manually instead of calling
1028        // Parcel.writeArray since the sets are made of the same type
1029        // we avoid paying the price of calling writeValue (used by
1030        // writeArray) which burns an extra int per element to encode
1031        // the type.
1032        Parcel request =  newRequest();
1033
1034        // The parcel starts already with an interface token. There
1035        // are 2 filters. Each one starts with a 4bytes number to
1036        // store the len followed by a number of int (4 bytes as well)
1037        // representing the metadata type.
1038        int capacity = request.dataSize() + 4 * (1 + allow.size() + 1 + block.size());
1039
1040        if (request.dataCapacity() < capacity) {
1041            request.setDataCapacity(capacity);
1042        }
1043
1044        request.writeInt(allow.size());
1045        for(Integer t: allow) {
1046            request.writeInt(t);
1047        }
1048        request.writeInt(block.size());
1049        for(Integer t: block) {
1050            request.writeInt(t);
1051        }
1052        return native_setMetadataFilter(request);
1053    }
1054
1055    /**
1056     * Releases resources associated with this MediaPlayer object.
1057     * It is considered good practice to call this method when you're
1058     * done using the MediaPlayer.
1059     */
1060    public void release() {
1061        stayAwake(false);
1062        updateSurfaceScreenOn();
1063        mOnPreparedListener = null;
1064        mOnBufferingUpdateListener = null;
1065        mOnCompletionListener = null;
1066        mOnSeekCompleteListener = null;
1067        mOnErrorListener = null;
1068        mOnInfoListener = null;
1069        mOnVideoSizeChangedListener = null;
1070        _release();
1071    }
1072
1073    private native void _release();
1074
1075    /**
1076     * Resets the MediaPlayer to its uninitialized state. After calling
1077     * this method, you will have to initialize it again by setting the
1078     * data source and calling prepare().
1079     */
1080    public void reset() {
1081        stayAwake(false);
1082        _reset();
1083        // make sure none of the listeners get called anymore
1084        mEventHandler.removeCallbacksAndMessages(null);
1085    }
1086
1087    private native void _reset();
1088
1089    /**
1090     * Sets the audio stream type for this MediaPlayer. See {@link AudioManager}
1091     * for a list of stream types. Must call this method before prepare() or
1092     * prepareAsync() in order for the target stream type to become effective
1093     * thereafter.
1094     *
1095     * @param streamtype the audio stream type
1096     * @see android.media.AudioManager
1097     */
1098    public native void setAudioStreamType(int streamtype);
1099
1100    /**
1101     * Sets the player to be looping or non-looping.
1102     *
1103     * @param looping whether to loop or not
1104     */
1105    public native void setLooping(boolean looping);
1106
1107    /**
1108     * Checks whether the MediaPlayer is looping or non-looping.
1109     *
1110     * @return true if the MediaPlayer is currently looping, false otherwise
1111     */
1112    public native boolean isLooping();
1113
1114    /**
1115     * Sets the volume on this player.
1116     * This API is recommended for balancing the output of audio streams
1117     * within an application. Unless you are writing an application to
1118     * control user settings, this API should be used in preference to
1119     * {@link AudioManager#setStreamVolume(int, int, int)} which sets the volume of ALL streams of
1120     * a particular type. Note that the passed volume values are raw scalars.
1121     * UI controls should be scaled logarithmically.
1122     *
1123     * @param leftVolume left volume scalar
1124     * @param rightVolume right volume scalar
1125     */
1126    public native void setVolume(float leftVolume, float rightVolume);
1127
1128    /**
1129     * Currently not implemented, returns null.
1130     * @deprecated
1131     * @hide
1132     */
1133    public native Bitmap getFrameAt(int msec) throws IllegalStateException;
1134
1135    /**
1136     * Sets the audio session ID.
1137     *
1138     * @param sessionId the audio session ID.
1139     * The audio session ID is a system wide unique identifier for the audio stream played by
1140     * this MediaPlayer instance.
1141     * The primary use of the audio session ID  is to associate audio effects to a particular
1142     * instance of MediaPlayer: if an audio session ID is provided when creating an audio effect,
1143     * this effect will be applied only to the audio content of media players within the same
1144     * audio session and not to the output mix.
1145     * When created, a MediaPlayer instance automatically generates its own audio session ID.
1146     * However, it is possible to force this player to be part of an already existing audio session
1147     * by calling this method.
1148     * This method must be called before one of the overloaded <code> setDataSource </code> methods.
1149     * @throws IllegalStateException if it is called in an invalid state
1150     */
1151    public native void setAudioSessionId(int sessionId)  throws IllegalArgumentException, IllegalStateException;
1152
1153    /**
1154     * Returns the audio session ID.
1155     *
1156     * @return the audio session ID. {@see #setAudioSessionId(int)}
1157     * Note that the audio session ID is 0 only if a problem occured when the MediaPlayer was contructed.
1158     */
1159    public native int getAudioSessionId();
1160
1161    /**
1162     * Attaches an auxiliary effect to the player. A typical auxiliary effect is a reverberation
1163     * effect which can be applied on any sound source that directs a certain amount of its
1164     * energy to this effect. This amount is defined by setAuxEffectSendLevel().
1165     * {@see #setAuxEffectSendLevel(float)}.
1166     * <p>After creating an auxiliary effect (e.g.
1167     * {@link android.media.audiofx.EnvironmentalReverb}), retrieve its ID with
1168     * {@link android.media.audiofx.AudioEffect#getId()} and use it when calling this method
1169     * to attach the player to the effect.
1170     * <p>To detach the effect from the player, call this method with a null effect id.
1171     * <p>This method must be called after one of the overloaded <code> setDataSource </code>
1172     * methods.
1173     * @param effectId system wide unique id of the effect to attach
1174     */
1175    public native void attachAuxEffect(int effectId);
1176
1177    /**
1178     * Sets the send level of the player to the attached auxiliary effect
1179     * {@see #attachAuxEffect(int)}. The level value range is 0 to 1.0.
1180     * <p>By default the send level is 0, so even if an effect is attached to the player
1181     * this method must be called for the effect to be applied.
1182     * <p>Note that the passed level value is a raw scalar. UI controls should be scaled
1183     * logarithmically: the gain applied by audio framework ranges from -72dB to 0dB,
1184     * so an appropriate conversion from linear UI input x to level is:
1185     * x == 0 -> level = 0
1186     * 0 < x <= R -> level = 10^(72*(x-R)/20/R)
1187     * @param level send level scalar
1188     */
1189    public native void setAuxEffectSendLevel(float level);
1190
1191    /**
1192     * @param request Parcel destinated to the media player. The
1193     *                Interface token must be set to the IMediaPlayer
1194     *                one to be routed correctly through the system.
1195     * @param reply[out] Parcel that will contain the reply.
1196     * @return The status code.
1197     */
1198    private native final int native_invoke(Parcel request, Parcel reply);
1199
1200
1201    /**
1202     * @param update_only If true fetch only the set of metadata that have
1203     *                    changed since the last invocation of getMetadata.
1204     *                    The set is built using the unfiltered
1205     *                    notifications the native player sent to the
1206     *                    MediaPlayerService during that period of
1207     *                    time. If false, all the metadatas are considered.
1208     * @param apply_filter  If true, once the metadata set has been built based on
1209     *                     the value update_only, the current filter is applied.
1210     * @param reply[out] On return contains the serialized
1211     *                   metadata. Valid only if the call was successful.
1212     * @return The status code.
1213     */
1214    private native final boolean native_getMetadata(boolean update_only,
1215                                                    boolean apply_filter,
1216                                                    Parcel reply);
1217
1218    /**
1219     * @param request Parcel with the 2 serialized lists of allowed
1220     *                metadata types followed by the one to be
1221     *                dropped. Each list starts with an integer
1222     *                indicating the number of metadata type elements.
1223     * @return The status code.
1224     */
1225    private native final int native_setMetadataFilter(Parcel request);
1226
1227    private static native final void native_init();
1228    private native final void native_setup(Object mediaplayer_this);
1229    private native final void native_finalize();
1230
1231    @Override
1232    protected void finalize() { native_finalize(); }
1233
1234    /* Do not change these values without updating their counterparts
1235     * in include/media/mediaplayer.h!
1236     */
1237    private static final int MEDIA_NOP = 0; // interface test message
1238    private static final int MEDIA_PREPARED = 1;
1239    private static final int MEDIA_PLAYBACK_COMPLETE = 2;
1240    private static final int MEDIA_BUFFERING_UPDATE = 3;
1241    private static final int MEDIA_SEEK_COMPLETE = 4;
1242    private static final int MEDIA_SET_VIDEO_SIZE = 5;
1243    private static final int MEDIA_ERROR = 100;
1244    private static final int MEDIA_INFO = 200;
1245
1246    private class EventHandler extends Handler
1247    {
1248        private MediaPlayer mMediaPlayer;
1249
1250        public EventHandler(MediaPlayer mp, Looper looper) {
1251            super(looper);
1252            mMediaPlayer = mp;
1253        }
1254
1255        @Override
1256        public void handleMessage(Message msg) {
1257            if (mMediaPlayer.mNativeContext == 0) {
1258                Log.w(TAG, "mediaplayer went away with unhandled events");
1259                return;
1260            }
1261            switch(msg.what) {
1262            case MEDIA_PREPARED:
1263                if (mOnPreparedListener != null)
1264                    mOnPreparedListener.onPrepared(mMediaPlayer);
1265                return;
1266
1267            case MEDIA_PLAYBACK_COMPLETE:
1268                if (mOnCompletionListener != null)
1269                    mOnCompletionListener.onCompletion(mMediaPlayer);
1270                stayAwake(false);
1271                return;
1272
1273            case MEDIA_BUFFERING_UPDATE:
1274                if (mOnBufferingUpdateListener != null)
1275                    mOnBufferingUpdateListener.onBufferingUpdate(mMediaPlayer, msg.arg1);
1276                return;
1277
1278            case MEDIA_SEEK_COMPLETE:
1279              if (mOnSeekCompleteListener != null)
1280                  mOnSeekCompleteListener.onSeekComplete(mMediaPlayer);
1281              return;
1282
1283            case MEDIA_SET_VIDEO_SIZE:
1284              if (mOnVideoSizeChangedListener != null)
1285                  mOnVideoSizeChangedListener.onVideoSizeChanged(mMediaPlayer, msg.arg1, msg.arg2);
1286              return;
1287
1288            case MEDIA_ERROR:
1289                // For PV specific error values (msg.arg2) look in
1290                // opencore/pvmi/pvmf/include/pvmf_return_codes.h
1291                Log.e(TAG, "Error (" + msg.arg1 + "," + msg.arg2 + ")");
1292                boolean error_was_handled = false;
1293                if (mOnErrorListener != null) {
1294                    error_was_handled = mOnErrorListener.onError(mMediaPlayer, msg.arg1, msg.arg2);
1295                }
1296                if (mOnCompletionListener != null && ! error_was_handled) {
1297                    mOnCompletionListener.onCompletion(mMediaPlayer);
1298                }
1299                stayAwake(false);
1300                return;
1301
1302            case MEDIA_INFO:
1303                // For PV specific code values (msg.arg2) look in
1304                // opencore/pvmi/pvmf/include/pvmf_return_codes.h
1305                Log.i(TAG, "Info (" + msg.arg1 + "," + msg.arg2 + ")");
1306                if (mOnInfoListener != null) {
1307                    mOnInfoListener.onInfo(mMediaPlayer, msg.arg1, msg.arg2);
1308                }
1309                // No real default action so far.
1310                return;
1311
1312            case MEDIA_NOP: // interface test message - ignore
1313                break;
1314
1315            default:
1316                Log.e(TAG, "Unknown message type " + msg.what);
1317                return;
1318            }
1319        }
1320    }
1321
1322    /**
1323     * Called from native code when an interesting event happens.  This method
1324     * just uses the EventHandler system to post the event back to the main app thread.
1325     * We use a weak reference to the original MediaPlayer object so that the native
1326     * code is safe from the object disappearing from underneath it.  (This is
1327     * the cookie passed to native_setup().)
1328     */
1329    private static void postEventFromNative(Object mediaplayer_ref,
1330                                            int what, int arg1, int arg2, Object obj)
1331    {
1332        MediaPlayer mp = (MediaPlayer)((WeakReference)mediaplayer_ref).get();
1333        if (mp == null) {
1334            return;
1335        }
1336
1337        if (mp.mEventHandler != null) {
1338            Message m = mp.mEventHandler.obtainMessage(what, arg1, arg2, obj);
1339            mp.mEventHandler.sendMessage(m);
1340        }
1341    }
1342
1343    /**
1344     * Interface definition for a callback to be invoked when the media
1345     * source is ready for playback.
1346     */
1347    public interface OnPreparedListener
1348    {
1349        /**
1350         * Called when the media file is ready for playback.
1351         *
1352         * @param mp the MediaPlayer that is ready for playback
1353         */
1354        void onPrepared(MediaPlayer mp);
1355    }
1356
1357    /**
1358     * Register a callback to be invoked when the media source is ready
1359     * for playback.
1360     *
1361     * @param listener the callback that will be run
1362     */
1363    public void setOnPreparedListener(OnPreparedListener listener)
1364    {
1365        mOnPreparedListener = listener;
1366    }
1367
1368    private OnPreparedListener mOnPreparedListener;
1369
1370    /**
1371     * Interface definition for a callback to be invoked when playback of
1372     * a media source has completed.
1373     */
1374    public interface OnCompletionListener
1375    {
1376        /**
1377         * Called when the end of a media source is reached during playback.
1378         *
1379         * @param mp the MediaPlayer that reached the end of the file
1380         */
1381        void onCompletion(MediaPlayer mp);
1382    }
1383
1384    /**
1385     * Register a callback to be invoked when the end of a media source
1386     * has been reached during playback.
1387     *
1388     * @param listener the callback that will be run
1389     */
1390    public void setOnCompletionListener(OnCompletionListener listener)
1391    {
1392        mOnCompletionListener = listener;
1393    }
1394
1395    private OnCompletionListener mOnCompletionListener;
1396
1397    /**
1398     * Interface definition of a callback to be invoked indicating buffering
1399     * status of a media resource being streamed over the network.
1400     */
1401    public interface OnBufferingUpdateListener
1402    {
1403        /**
1404         * Called to update status in buffering a media stream.
1405         *
1406         * @param mp      the MediaPlayer the update pertains to
1407         * @param percent the percentage (0-100) of the buffer
1408         *                that has been filled thus far
1409         */
1410        void onBufferingUpdate(MediaPlayer mp, int percent);
1411    }
1412
1413    /**
1414     * Register a callback to be invoked when the status of a network
1415     * stream's buffer has changed.
1416     *
1417     * @param listener the callback that will be run.
1418     */
1419    public void setOnBufferingUpdateListener(OnBufferingUpdateListener listener)
1420    {
1421        mOnBufferingUpdateListener = listener;
1422    }
1423
1424    private OnBufferingUpdateListener mOnBufferingUpdateListener;
1425
1426    /**
1427     * Interface definition of a callback to be invoked indicating
1428     * the completion of a seek operation.
1429     */
1430    public interface OnSeekCompleteListener
1431    {
1432        /**
1433         * Called to indicate the completion of a seek operation.
1434         *
1435         * @param mp the MediaPlayer that issued the seek operation
1436         */
1437        public void onSeekComplete(MediaPlayer mp);
1438    }
1439
1440    /**
1441     * Register a callback to be invoked when a seek operation has been
1442     * completed.
1443     *
1444     * @param listener the callback that will be run
1445     */
1446    public void setOnSeekCompleteListener(OnSeekCompleteListener listener)
1447    {
1448        mOnSeekCompleteListener = listener;
1449    }
1450
1451    private OnSeekCompleteListener mOnSeekCompleteListener;
1452
1453    /**
1454     * Interface definition of a callback to be invoked when the
1455     * video size is first known or updated
1456     */
1457    public interface OnVideoSizeChangedListener
1458    {
1459        /**
1460         * Called to indicate the video size
1461         *
1462         * @param mp        the MediaPlayer associated with this callback
1463         * @param width     the width of the video
1464         * @param height    the height of the video
1465         */
1466        public void onVideoSizeChanged(MediaPlayer mp, int width, int height);
1467    }
1468
1469    /**
1470     * Register a callback to be invoked when the video size is
1471     * known or updated.
1472     *
1473     * @param listener the callback that will be run
1474     */
1475    public void setOnVideoSizeChangedListener(OnVideoSizeChangedListener listener)
1476    {
1477        mOnVideoSizeChangedListener = listener;
1478    }
1479
1480    private OnVideoSizeChangedListener mOnVideoSizeChangedListener;
1481
1482    /* Do not change these values without updating their counterparts
1483     * in include/media/mediaplayer.h!
1484     */
1485    /** Unspecified media player error.
1486     * @see android.media.MediaPlayer.OnErrorListener
1487     */
1488    public static final int MEDIA_ERROR_UNKNOWN = 1;
1489
1490    /** Media server died. In this case, the application must release the
1491     * MediaPlayer object and instantiate a new one.
1492     * @see android.media.MediaPlayer.OnErrorListener
1493     */
1494    public static final int MEDIA_ERROR_SERVER_DIED = 100;
1495
1496    /** The video is streamed and its container is not valid for progressive
1497     * playback i.e the video's index (e.g moov atom) is not at the start of the
1498     * file.
1499     * @see android.media.MediaPlayer.OnErrorListener
1500     */
1501    public static final int MEDIA_ERROR_NOT_VALID_FOR_PROGRESSIVE_PLAYBACK = 200;
1502
1503    /**
1504     * Interface definition of a callback to be invoked when there
1505     * has been an error during an asynchronous operation (other errors
1506     * will throw exceptions at method call time).
1507     */
1508    public interface OnErrorListener
1509    {
1510        /**
1511         * Called to indicate an error.
1512         *
1513         * @param mp      the MediaPlayer the error pertains to
1514         * @param what    the type of error that has occurred:
1515         * <ul>
1516         * <li>{@link #MEDIA_ERROR_UNKNOWN}
1517         * <li>{@link #MEDIA_ERROR_SERVER_DIED}
1518         * </ul>
1519         * @param extra an extra code, specific to the error. Typically
1520         * implementation dependant.
1521         * @return True if the method handled the error, false if it didn't.
1522         * Returning false, or not having an OnErrorListener at all, will
1523         * cause the OnCompletionListener to be called.
1524         */
1525        boolean onError(MediaPlayer mp, int what, int extra);
1526    }
1527
1528    /**
1529     * Register a callback to be invoked when an error has happened
1530     * during an asynchronous operation.
1531     *
1532     * @param listener the callback that will be run
1533     */
1534    public void setOnErrorListener(OnErrorListener listener)
1535    {
1536        mOnErrorListener = listener;
1537    }
1538
1539    private OnErrorListener mOnErrorListener;
1540
1541
1542    /* Do not change these values without updating their counterparts
1543     * in include/media/mediaplayer.h!
1544     */
1545    /** Unspecified media player info.
1546     * @see android.media.MediaPlayer.OnInfoListener
1547     */
1548    public static final int MEDIA_INFO_UNKNOWN = 1;
1549
1550    /** The video is too complex for the decoder: it can't decode frames fast
1551     *  enough. Possibly only the audio plays fine at this stage.
1552     * @see android.media.MediaPlayer.OnInfoListener
1553     */
1554    public static final int MEDIA_INFO_VIDEO_TRACK_LAGGING = 700;
1555
1556    /** MediaPlayer is temporarily pausing playback internally in order to
1557     * buffer more data.
1558     */
1559    public static final int MEDIA_INFO_BUFFERING_START = 701;
1560
1561    /** MediaPlayer is resuming playback after filling buffers.
1562     */
1563    public static final int MEDIA_INFO_BUFFERING_END = 702;
1564
1565    /** Bad interleaving means that a media has been improperly interleaved or
1566     * not interleaved at all, e.g has all the video samples first then all the
1567     * audio ones. Video is playing but a lot of disk seeks may be happening.
1568     * @see android.media.MediaPlayer.OnInfoListener
1569     */
1570    public static final int MEDIA_INFO_BAD_INTERLEAVING = 800;
1571
1572    /** The media cannot be seeked (e.g live stream)
1573     * @see android.media.MediaPlayer.OnInfoListener
1574     */
1575    public static final int MEDIA_INFO_NOT_SEEKABLE = 801;
1576
1577    /** A new set of metadata is available.
1578     * @see android.media.MediaPlayer.OnInfoListener
1579     */
1580    public static final int MEDIA_INFO_METADATA_UPDATE = 802;
1581
1582    /**
1583     * Interface definition of a callback to be invoked to communicate some
1584     * info and/or warning about the media or its playback.
1585     */
1586    public interface OnInfoListener
1587    {
1588        /**
1589         * Called to indicate an info or a warning.
1590         *
1591         * @param mp      the MediaPlayer the info pertains to.
1592         * @param what    the type of info or warning.
1593         * <ul>
1594         * <li>{@link #MEDIA_INFO_UNKNOWN}
1595         * <li>{@link #MEDIA_INFO_VIDEO_TRACK_LAGGING}
1596         * <li>{@link #MEDIA_INFO_BAD_INTERLEAVING}
1597         * <li>{@link #MEDIA_INFO_NOT_SEEKABLE}
1598         * <li>{@link #MEDIA_INFO_METADATA_UPDATE}
1599         * </ul>
1600         * @param extra an extra code, specific to the info. Typically
1601         * implementation dependant.
1602         * @return True if the method handled the info, false if it didn't.
1603         * Returning false, or not having an OnErrorListener at all, will
1604         * cause the info to be discarded.
1605         */
1606        boolean onInfo(MediaPlayer mp, int what, int extra);
1607    }
1608
1609    /**
1610     * Register a callback to be invoked when an info/warning is available.
1611     *
1612     * @param listener the callback that will be run
1613     */
1614    public void setOnInfoListener(OnInfoListener listener)
1615    {
1616        mOnInfoListener = listener;
1617    }
1618
1619    private OnInfoListener mOnInfoListener;
1620
1621}
1622