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