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