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