mediaplayer.h revision dd172fce75b2a1c3cb3a5d3b3bbb5020b1ae8675 
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 <ui/Surface.h>
22#include <media/IMediaPlayerClient.h>
23#include <media/IMediaPlayer.h>
24#include <media/IMediaDeathNotifier.h>
25
26namespace android {
27
28enum media_event_type {
29    MEDIA_NOP               = 0, // interface test message
30    MEDIA_PREPARED          = 1,
31    MEDIA_PLAYBACK_COMPLETE = 2,
32    MEDIA_BUFFERING_UPDATE  = 3,
33    MEDIA_SEEK_COMPLETE     = 4,
34    MEDIA_SET_VIDEO_SIZE    = 5,
35    MEDIA_ERROR             = 100,
36    MEDIA_INFO              = 200,
37};
38
39// Generic error codes for the media player framework.  Errors are fatal, the
40// playback must abort.
41//
42// Errors are communicated back to the client using the
43// MediaPlayerListener::notify method defined below.
44// In this situation, 'notify' is invoked with the following:
45//   'msg' is set to MEDIA_ERROR.
46//   'ext1' should be a value from the enum media_error_type.
47//   'ext2' contains an implementation dependant error code to provide
48//          more details. Should default to 0 when not used.
49//
50// The codes are distributed as follow:
51//   0xx: Reserved
52//   1xx: Android Player errors. Something went wrong inside the MediaPlayer.
53//   2xx: Media errors (e.g Codec not supported). There is a problem with the
54//        media itself.
55//   3xx: Runtime errors. Some extraordinary condition arose making the playback
56//        impossible.
57//
58enum media_error_type {
59    // 0xx
60    MEDIA_ERROR_UNKNOWN = 1,
61    // 1xx
62    MEDIA_ERROR_SERVER_DIED = 100,
63    // 2xx
64    MEDIA_ERROR_NOT_VALID_FOR_PROGRESSIVE_PLAYBACK = 200,
65    // 3xx
66};
67
68
69// Info and warning codes for the media player framework.  These are non fatal,
70// the playback is going on but there might be some user visible issues.
71//
72// Info and warning messages are communicated back to the client using the
73// MediaPlayerListener::notify method defined below.  In this situation,
74// 'notify' is invoked with the following:
75//   'msg' is set to MEDIA_INFO.
76//   'ext1' should be a value from the enum media_info_type.
77//   'ext2' contains an implementation dependant info code to provide
78//          more details. Should default to 0 when not used.
79//
80// The codes are distributed as follow:
81//   0xx: Reserved
82//   7xx: Android Player info/warning (e.g player lagging behind.)
83//   8xx: Media info/warning (e.g media badly interleaved.)
84//
85enum media_info_type {
86    // 0xx
87    MEDIA_INFO_UNKNOWN = 1,
88    // 7xx
89    // The video is too complex for the decoder: it can't decode frames fast
90    // enough. Possibly only the audio plays fine at this stage.
91    MEDIA_INFO_VIDEO_TRACK_LAGGING = 700,
92    // 8xx
93    // Bad interleaving means that a media has been improperly interleaved or not
94    // interleaved at all, e.g has all the video samples first then all the audio
95    // ones. Video is playing but a lot of disk seek may be happening.
96    MEDIA_INFO_BAD_INTERLEAVING = 800,
97    // The media is not seekable (e.g live stream).
98    MEDIA_INFO_NOT_SEEKABLE = 801,
99    // New media metadata is available.
100    MEDIA_INFO_METADATA_UPDATE = 802,
101};
102
103
104
105enum media_player_states {
106    MEDIA_PLAYER_STATE_ERROR        = 0,
107    MEDIA_PLAYER_IDLE               = 1 << 0,
108    MEDIA_PLAYER_INITIALIZED        = 1 << 1,
109    MEDIA_PLAYER_PREPARING          = 1 << 2,
110    MEDIA_PLAYER_PREPARED           = 1 << 3,
111    MEDIA_PLAYER_STARTED            = 1 << 4,
112    MEDIA_PLAYER_PAUSED             = 1 << 5,
113    MEDIA_PLAYER_STOPPED            = 1 << 6,
114    MEDIA_PLAYER_PLAYBACK_COMPLETE  = 1 << 7
115};
116
117// ----------------------------------------------------------------------------
118// ref-counted object for callbacks
119class MediaPlayerListener: virtual public RefBase
120{
121public:
122    virtual void notify(int msg, int ext1, int ext2) = 0;
123};
124
125class MediaPlayer : public BnMediaPlayerClient,
126                    public virtual IMediaDeathNotifier
127{
128public:
129    MediaPlayer();
130    ~MediaPlayer();
131            void            died();
132            void            disconnect();
133            status_t        setDataSource(const char *url);
134            status_t        setDataSource(int fd, int64_t offset, int64_t length);
135            status_t        setVideoSurface(const sp<Surface>& surface);
136            status_t        setListener(const sp<MediaPlayerListener>& listener);
137            status_t        prepare();
138            status_t        prepareAsync();
139            status_t        start();
140            status_t        stop();
141            status_t        pause();
142            bool            isPlaying();
143            status_t        getVideoWidth(int *w);
144            status_t        getVideoHeight(int *h);
145            status_t        seekTo(int msec);
146            status_t        getCurrentPosition(int *msec);
147            status_t        getDuration(int *msec);
148            status_t        reset();
149            status_t        setAudioStreamType(int type);
150            status_t        setLooping(int loop);
151            bool            isLooping();
152            status_t        setVolume(float leftVolume, float rightVolume);
153            void            notify(int msg, int ext1, int ext2);
154    static  sp<IMemory>     decode(const char* url, uint32_t *pSampleRate, int* pNumChannels, int* pFormat);
155    static  sp<IMemory>     decode(int fd, int64_t offset, int64_t length, uint32_t *pSampleRate, int* pNumChannels, int* pFormat);
156    static  int             snoop(short *data, int len, int kind);
157            status_t        invoke(const Parcel& request, Parcel *reply);
158            status_t        setMetadataFilter(const Parcel& filter);
159            status_t        getMetadata(bool update_only, bool apply_filter, Parcel *metadata);
160private:
161            void            clear_l();
162            status_t        seekTo_l(int msec);
163            status_t        prepareAsync_l();
164            status_t        getDuration_l(int *msec);
165            status_t        setDataSource(const sp<IMediaPlayer>& player);
166
167    sp<IMediaPlayer>            mPlayer;
168    thread_id_t                 mLockThreadId;
169    Mutex                       mLock;
170    Mutex                       mNotifyLock;
171    Condition                   mSignal;
172    sp<MediaPlayerListener>     mListener;
173    void*                       mCookie;
174    media_player_states         mCurrentState;
175    int                         mDuration;
176    int                         mCurrentPosition;
177    int                         mSeekPosition;
178    bool                        mPrepareSync;
179    status_t                    mPrepareStatus;
180    int                         mStreamType;
181    bool                        mLoop;
182    float                       mLeftVolume;
183    float                       mRightVolume;
184    int                         mVideoWidth;
185    int                         mVideoHeight;
186};
187
188}; // namespace android
189
190#endif // ANDROID_MEDIAPLAYER_H
191