MediaPlayerInterface.h revision 761defc341c5ce9019a42919c441f035f665ec0d 
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_MEDIAPLAYERINTERFACE_H
18#define ANDROID_MEDIAPLAYERINTERFACE_H
19
20#ifdef __cplusplus
21
22#include <sys/types.h>
23#include <utils/Errors.h>
24#include <utils/KeyedVector.h>
25#include <utils/String8.h>
26#include <utils/RefBase.h>
27
28#include <media/mediaplayer.h>
29#include <media/AudioSystem.h>
30#include <media/Metadata.h>
31
32namespace android {
33
34class Parcel;
35class Surface;
36class ISurfaceTexture;
37
38template<typename T> class SortedVector;
39
40enum player_type {
41    PV_PLAYER = 1,
42    SONIVOX_PLAYER = 2,
43    STAGEFRIGHT_PLAYER = 3,
44    NU_PLAYER = 4,
45    // Test players are available only in the 'test' and 'eng' builds.
46    // The shared library with the test player is passed passed as an
47    // argument to the 'test:' url in the setDataSource call.
48    TEST_PLAYER = 5,
49
50    AAH_RX_PLAYER = 100,
51    AAH_TX_PLAYER = 101,
52};
53
54
55#define DEFAULT_AUDIOSINK_BUFFERCOUNT 4
56#define DEFAULT_AUDIOSINK_BUFFERSIZE 1200
57#define DEFAULT_AUDIOSINK_SAMPLERATE 44100
58
59
60// callback mechanism for passing messages to MediaPlayer object
61typedef void (*notify_callback_f)(void* cookie,
62        int msg, int ext1, int ext2, const Parcel *obj);
63
64// abstract base class - use MediaPlayerInterface
65class MediaPlayerBase : public RefBase
66{
67public:
68    // AudioSink: abstraction layer for audio output
69    class AudioSink : public RefBase {
70    public:
71        // Callback returns the number of bytes actually written to the buffer.
72        typedef size_t (*AudioCallback)(
73                AudioSink *audioSink, void *buffer, size_t size, void *cookie);
74
75        virtual             ~AudioSink() {}
76        virtual bool        ready() const = 0; // audio output is open and ready
77        virtual bool        realtime() const = 0; // audio output is real-time output
78        virtual ssize_t     bufferSize() const = 0;
79        virtual ssize_t     frameCount() const = 0;
80        virtual ssize_t     channelCount() const = 0;
81        virtual ssize_t     frameSize() const = 0;
82        virtual uint32_t    latency() const = 0;
83        virtual float       msecsPerFrame() const = 0;
84        virtual status_t    getPosition(uint32_t *position) = 0;
85        virtual int         getSessionId() = 0;
86
87        // If no callback is specified, use the "write" API below to submit
88        // audio data.
89        virtual status_t    open(
90                uint32_t sampleRate, int channelCount,
91                audio_format_t format=AUDIO_FORMAT_PCM_16_BIT,
92                int bufferCount=DEFAULT_AUDIOSINK_BUFFERCOUNT,
93                AudioCallback cb = NULL,
94                void *cookie = NULL) = 0;
95
96        virtual void        start() = 0;
97        virtual ssize_t     write(const void* buffer, size_t size) = 0;
98        virtual void        stop() = 0;
99        virtual void        flush() = 0;
100        virtual void        pause() = 0;
101        virtual void        close() = 0;
102
103        virtual status_t    setPlaybackRatePermille(int32_t rate) { return INVALID_OPERATION; }
104    };
105
106                        MediaPlayerBase() : mCookie(0), mNotify(0) {}
107    virtual             ~MediaPlayerBase() {}
108    virtual status_t    initCheck() = 0;
109    virtual bool        hardwareOutput() = 0;
110
111    virtual status_t    setUID(uid_t uid) {
112        return INVALID_OPERATION;
113    }
114
115    virtual status_t    setDataSource(
116            const char *url,
117            const KeyedVector<String8, String8> *headers = NULL) = 0;
118
119    virtual status_t    setDataSource(int fd, int64_t offset, int64_t length) = 0;
120
121    virtual status_t    setDataSource(const sp<IStreamSource> &source) {
122        return INVALID_OPERATION;
123    }
124
125    // pass the buffered ISurfaceTexture to the media player service
126    virtual status_t    setVideoSurfaceTexture(
127                                const sp<ISurfaceTexture>& surfaceTexture) = 0;
128
129    virtual status_t    prepare() = 0;
130    virtual status_t    prepareAsync() = 0;
131    virtual status_t    start() = 0;
132    virtual status_t    stop() = 0;
133    virtual status_t    pause() = 0;
134    virtual bool        isPlaying() = 0;
135    virtual status_t    seekTo(int msec) = 0;
136    virtual status_t    getCurrentPosition(int *msec) = 0;
137    virtual status_t    getDuration(int *msec) = 0;
138    virtual status_t    reset() = 0;
139    virtual status_t    setLooping(int loop) = 0;
140    virtual player_type playerType() = 0;
141    virtual status_t    setParameter(int key, const Parcel &request) = 0;
142    virtual status_t    getParameter(int key, Parcel *reply) = 0;
143
144    // Invoke a generic method on the player by using opaque parcels
145    // for the request and reply.
146    //
147    // @param request Parcel that is positioned at the start of the
148    //                data sent by the java layer.
149    // @param[out] reply Parcel to hold the reply data. Cannot be null.
150    // @return OK if the call was successful.
151    virtual status_t    invoke(const Parcel& request, Parcel *reply) = 0;
152
153    // The Client in the MetadataPlayerService calls this method on
154    // the native player to retrieve all or a subset of metadata.
155    //
156    // @param ids SortedList of metadata ID to be fetch. If empty, all
157    //            the known metadata should be returned.
158    // @param[inout] records Parcel where the player appends its metadata.
159    // @return OK if the call was successful.
160    virtual status_t    getMetadata(const media::Metadata::Filter& ids,
161                                    Parcel *records) {
162        return INVALID_OPERATION;
163    };
164
165    void        setNotifyCallback(
166            void* cookie, notify_callback_f notifyFunc) {
167        Mutex::Autolock autoLock(mNotifyLock);
168        mCookie = cookie; mNotify = notifyFunc;
169    }
170
171    void        sendEvent(int msg, int ext1=0, int ext2=0,
172                          const Parcel *obj=NULL) {
173        Mutex::Autolock autoLock(mNotifyLock);
174        if (mNotify) mNotify(mCookie, msg, ext1, ext2, obj);
175    }
176
177    virtual status_t dump(int fd, const Vector<String16> &args) const {
178        return INVALID_OPERATION;
179    }
180
181private:
182    friend class MediaPlayerService;
183
184    Mutex               mNotifyLock;
185    void*               mCookie;
186    notify_callback_f   mNotify;
187};
188
189// Implement this class for media players that use the AudioFlinger software mixer
190class MediaPlayerInterface : public MediaPlayerBase
191{
192public:
193    virtual             ~MediaPlayerInterface() { }
194    virtual bool        hardwareOutput() { return false; }
195    virtual void        setAudioSink(const sp<AudioSink>& audioSink) { mAudioSink = audioSink; }
196protected:
197    sp<AudioSink>       mAudioSink;
198};
199
200// Implement this class for media players that output audio directly to hardware
201class MediaPlayerHWInterface : public MediaPlayerBase
202{
203public:
204    virtual             ~MediaPlayerHWInterface() {}
205    virtual bool        hardwareOutput() { return true; }
206    virtual status_t    setVolume(float leftVolume, float rightVolume) = 0;
207    virtual status_t    setAudioStreamType(audio_stream_type_t streamType) = 0;
208};
209
210}; // namespace android
211
212#endif // __cplusplus
213
214
215#endif // ANDROID_MEDIAPLAYERINTERFACE_H
216