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