• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2007 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 
17 #ifndef ANDROID_MEDIAPLAYER_H
18 #define ANDROID_MEDIAPLAYER_H
19 
20 #include <binder/IMemory.h>
21 #include <media/IMediaPlayerClient.h>
22 #include <media/IMediaPlayer.h>
23 #include <media/IMediaDeathNotifier.h>
24 #include <media/IStreamSource.h>
25 
26 #include <utils/KeyedVector.h>
27 #include <utils/String8.h>
28 
29 class ANativeWindow;
30 
31 namespace android {
32 
33 class Surface;
34 class ISurfaceTexture;
35 
36 enum media_event_type {
37     MEDIA_NOP               = 0, // interface test message
38     MEDIA_PREPARED          = 1,
39     MEDIA_PLAYBACK_COMPLETE = 2,
40     MEDIA_BUFFERING_UPDATE  = 3,
41     MEDIA_SEEK_COMPLETE     = 4,
42     MEDIA_SET_VIDEO_SIZE    = 5,
43     MEDIA_TIMED_TEXT        = 99,
44     MEDIA_ERROR             = 100,
45     MEDIA_INFO              = 200,
46 };
47 
48 // Generic error codes for the media player framework.  Errors are fatal, the
49 // playback must abort.
50 //
51 // Errors are communicated back to the client using the
52 // MediaPlayerListener::notify method defined below.
53 // In this situation, 'notify' is invoked with the following:
54 //   'msg' is set to MEDIA_ERROR.
55 //   'ext1' should be a value from the enum media_error_type.
56 //   'ext2' contains an implementation dependant error code to provide
57 //          more details. Should default to 0 when not used.
58 //
59 // The codes are distributed as follow:
60 //   0xx: Reserved
61 //   1xx: Android Player errors. Something went wrong inside the MediaPlayer.
62 //   2xx: Media errors (e.g Codec not supported). There is a problem with the
63 //        media itself.
64 //   3xx: Runtime errors. Some extraordinary condition arose making the playback
65 //        impossible.
66 //
67 enum media_error_type {
68     // 0xx
69     MEDIA_ERROR_UNKNOWN = 1,
70     // 1xx
71     MEDIA_ERROR_SERVER_DIED = 100,
72     // 2xx
73     MEDIA_ERROR_NOT_VALID_FOR_PROGRESSIVE_PLAYBACK = 200,
74     // 3xx
75 };
76 
77 
78 // Info and warning codes for the media player framework.  These are non fatal,
79 // the playback is going on but there might be some user visible issues.
80 //
81 // Info and warning messages are communicated back to the client using the
82 // MediaPlayerListener::notify method defined below.  In this situation,
83 // 'notify' is invoked with the following:
84 //   'msg' is set to MEDIA_INFO.
85 //   'ext1' should be a value from the enum media_info_type.
86 //   'ext2' contains an implementation dependant info code to provide
87 //          more details. Should default to 0 when not used.
88 //
89 // The codes are distributed as follow:
90 //   0xx: Reserved
91 //   7xx: Android Player info/warning (e.g player lagging behind.)
92 //   8xx: Media info/warning (e.g media badly interleaved.)
93 //
94 enum media_info_type {
95     // 0xx
96     MEDIA_INFO_UNKNOWN = 1,
97     // 7xx
98     // The video is too complex for the decoder: it can't decode frames fast
99     // enough. Possibly only the audio plays fine at this stage.
100     MEDIA_INFO_VIDEO_TRACK_LAGGING = 700,
101     // MediaPlayer is temporarily pausing playback internally in order to
102     // buffer more data.
103     MEDIA_INFO_BUFFERING_START = 701,
104     // MediaPlayer is resuming playback after filling buffers.
105     MEDIA_INFO_BUFFERING_END = 702,
106     // Bandwidth in recent past
107     MEDIA_INFO_NETWORK_BANDWIDTH = 703,
108 
109     // 8xx
110     // Bad interleaving means that a media has been improperly interleaved or not
111     // interleaved at all, e.g has all the video samples first then all the audio
112     // ones. Video is playing but a lot of disk seek may be happening.
113     MEDIA_INFO_BAD_INTERLEAVING = 800,
114     // The media is not seekable (e.g live stream).
115     MEDIA_INFO_NOT_SEEKABLE = 801,
116     // New media metadata is available.
117     MEDIA_INFO_METADATA_UPDATE = 802,
118 };
119 
120 
121 
122 enum media_player_states {
123     MEDIA_PLAYER_STATE_ERROR        = 0,
124     MEDIA_PLAYER_IDLE               = 1 << 0,
125     MEDIA_PLAYER_INITIALIZED        = 1 << 1,
126     MEDIA_PLAYER_PREPARING          = 1 << 2,
127     MEDIA_PLAYER_PREPARED           = 1 << 3,
128     MEDIA_PLAYER_STARTED            = 1 << 4,
129     MEDIA_PLAYER_PAUSED             = 1 << 5,
130     MEDIA_PLAYER_STOPPED            = 1 << 6,
131     MEDIA_PLAYER_PLAYBACK_COMPLETE  = 1 << 7
132 };
133 
134 // Keep KEY_PARAMETER_* in sync with MediaPlayer.java.
135 // The same enum space is used for both set and get, in case there are future keys that
136 // can be both set and get.  But as of now, all parameters are either set only or get only.
137 enum media_parameter_keys {
138     KEY_PARAMETER_TIMED_TEXT_TRACK_INDEX = 1000,                // set only
139     KEY_PARAMETER_TIMED_TEXT_ADD_OUT_OF_BAND_SOURCE = 1001,     // set only
140 
141     // Streaming/buffering parameters
142     KEY_PARAMETER_CACHE_STAT_COLLECT_FREQ_MS = 1100,            // set only
143 
144     // Return a Parcel containing a single int, which is the channel count of the
145     // audio track, or zero for error (e.g. no audio track) or unknown.
146     KEY_PARAMETER_AUDIO_CHANNEL_COUNT = 1200,                   // get only
147 
148 };
149 
150 // ----------------------------------------------------------------------------
151 // ref-counted object for callbacks
152 class MediaPlayerListener: virtual public RefBase
153 {
154 public:
155     virtual void notify(int msg, int ext1, int ext2, const Parcel *obj) = 0;
156 };
157 
158 class MediaPlayer : public BnMediaPlayerClient,
159                     public virtual IMediaDeathNotifier
160 {
161 public:
162     MediaPlayer();
163     ~MediaPlayer();
164             void            died();
165             void            disconnect();
166 
167             status_t        setDataSource(
168                     const char *url,
169                     const KeyedVector<String8, String8> *headers);
170 
171             status_t        setDataSource(int fd, int64_t offset, int64_t length);
172             status_t        setDataSource(const sp<IStreamSource> &source);
173             status_t        setVideoSurface(const sp<Surface>& surface);
174             status_t        setVideoSurfaceTexture(
175                                     const sp<ISurfaceTexture>& surfaceTexture);
176             status_t        setListener(const sp<MediaPlayerListener>& listener);
177             status_t        prepare();
178             status_t        prepareAsync();
179             status_t        start();
180             status_t        stop();
181             status_t        pause();
182             bool            isPlaying();
183             status_t        getVideoWidth(int *w);
184             status_t        getVideoHeight(int *h);
185             status_t        seekTo(int msec);
186             status_t        getCurrentPosition(int *msec);
187             status_t        getDuration(int *msec);
188             status_t        reset();
189             status_t        setAudioStreamType(int type);
190             status_t        setLooping(int loop);
191             bool            isLooping();
192             status_t        setVolume(float leftVolume, float rightVolume);
193             void            notify(int msg, int ext1, int ext2, const Parcel *obj = NULL);
194     static  sp<IMemory>     decode(const char* url, uint32_t *pSampleRate, int* pNumChannels, int* pFormat);
195     static  sp<IMemory>     decode(int fd, int64_t offset, int64_t length, uint32_t *pSampleRate, int* pNumChannels, int* pFormat);
196             status_t        invoke(const Parcel& request, Parcel *reply);
197             status_t        setMetadataFilter(const Parcel& filter);
198             status_t        getMetadata(bool update_only, bool apply_filter, Parcel *metadata);
199             status_t        setAudioSessionId(int sessionId);
200             int             getAudioSessionId();
201             status_t        setAuxEffectSendLevel(float level);
202             status_t        attachAuxEffect(int effectId);
203             status_t        setParameter(int key, const Parcel& request);
204             status_t        getParameter(int key, Parcel* reply);
205 
206 private:
207             void            clear_l();
208             status_t        seekTo_l(int msec);
209             status_t        prepareAsync_l();
210             status_t        getDuration_l(int *msec);
211             status_t        attachNewPlayer(const sp<IMediaPlayer>& player);
212             status_t        reset_l();
213 
214     sp<IMediaPlayer>            mPlayer;
215     thread_id_t                 mLockThreadId;
216     Mutex                       mLock;
217     Mutex                       mNotifyLock;
218     Condition                   mSignal;
219     sp<MediaPlayerListener>     mListener;
220     void*                       mCookie;
221     media_player_states         mCurrentState;
222     int                         mDuration;
223     int                         mCurrentPosition;
224     int                         mSeekPosition;
225     bool                        mPrepareSync;
226     status_t                    mPrepareStatus;
227     int                         mStreamType;
228     bool                        mLoop;
229     float                       mLeftVolume;
230     float                       mRightVolume;
231     int                         mVideoWidth;
232     int                         mVideoHeight;
233     int                         mAudioSessionId;
234     float                       mSendLevel;
235 };
236 
237 }; // namespace android
238 
239 #endif // ANDROID_MEDIAPLAYER_H
240