MediaPlayerInterface.h revision ee4e1b1a63758941460ae79a064249d3a5189443 
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/AudioTimestamp.h>
31#include <media/Metadata.h>
32
33// Fwd decl to make sure everyone agrees that the scope of struct sockaddr_in is
34// global, and not in android::
35struct sockaddr_in;
36
37namespace android {
38
39class DataSource;
40class Parcel;
41class Surface;
42class IGraphicBufferProducer;
43
44template<typename T> class SortedVector;
45
46enum player_type {
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
55
56#define DEFAULT_AUDIOSINK_BUFFERCOUNT 4
57#define DEFAULT_AUDIOSINK_BUFFERSIZE 1200
58#define DEFAULT_AUDIOSINK_SAMPLERATE 44100
59
60// when the channel mask isn't known, use the channel count to derive a mask in AudioSink::open()
61#define CHANNEL_MASK_USE_CHANNEL_ORDER 0
62
63// duration below which we do not allow deep audio buffering
64#define AUDIO_SINK_MIN_DEEP_BUFFER_DURATION_US 5000000
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        enum cb_event_t {
78            CB_EVENT_FILL_BUFFER,   // Request to write more data to buffer.
79            CB_EVENT_STREAM_END,    // Sent after all the buffers queued in AF and HW are played
80                                    // back (after stop is called)
81            CB_EVENT_TEAR_DOWN      // The AudioTrack was invalidated due to use case change:
82                                    // Need to re-evaluate offloading options
83        };
84
85        // Callback returns the number of bytes actually written to the buffer.
86        typedef size_t (*AudioCallback)(
87                AudioSink *audioSink, void *buffer, size_t size, void *cookie,
88                        cb_event_t event);
89
90        virtual             ~AudioSink() {}
91        virtual bool        ready() const = 0; // audio output is open and ready
92        virtual ssize_t     bufferSize() const = 0;
93        virtual ssize_t     frameCount() const = 0;
94        virtual ssize_t     channelCount() const = 0;
95        virtual ssize_t     frameSize() const = 0;
96        virtual uint32_t    latency() const = 0;
97        virtual float       msecsPerFrame() const = 0;
98        virtual status_t    getPosition(uint32_t *position) const = 0;
99        virtual status_t    getTimestamp(AudioTimestamp &ts) const = 0;
100        virtual status_t    getFramesWritten(uint32_t *frameswritten) const = 0;
101        virtual int         getSessionId() const = 0;
102        virtual audio_stream_type_t getAudioStreamType() const = 0;
103        virtual uint32_t    getSampleRate() const = 0;
104
105        // If no callback is specified, use the "write" API below to submit
106        // audio data.
107        virtual status_t    open(
108                uint32_t sampleRate, int channelCount, audio_channel_mask_t channelMask,
109                audio_format_t format=AUDIO_FORMAT_PCM_16_BIT,
110                int bufferCount=DEFAULT_AUDIOSINK_BUFFERCOUNT,
111                AudioCallback cb = NULL,
112                void *cookie = NULL,
113                audio_output_flags_t flags = AUDIO_OUTPUT_FLAG_NONE,
114                const audio_offload_info_t *offloadInfo = NULL) = 0;
115
116        virtual status_t    start() = 0;
117
118        /* Input parameter |size| is in byte units stored in |buffer|.
119         * Data is copied over and actual number of bytes written (>= 0)
120         * is returned, or no data is copied and a negative status code
121         * is returned (even when |blocking| is true).
122         * When |blocking| is false, AudioSink will immediately return after
123         * part of or full |buffer| is copied over.
124         * When |blocking| is true, AudioSink will wait to copy the entire
125         * buffer, unless an error occurs or the copy operation is
126         * prematurely stopped.
127         */
128        virtual ssize_t     write(const void* buffer, size_t size, bool blocking = true) = 0;
129
130        virtual void        stop() = 0;
131        virtual void        flush() = 0;
132        virtual void        pause() = 0;
133        virtual void        close() = 0;
134
135        virtual status_t    setPlaybackRatePermille(int32_t /* rate */) { return INVALID_OPERATION;}
136        virtual bool        needsTrailingPadding() { return true; }
137
138        virtual status_t    setParameters(const String8& /* keyValuePairs */) { return NO_ERROR; }
139        virtual String8     getParameters(const String8& /* keys */) { return String8::empty(); }
140    };
141
142                        MediaPlayerBase() : mCookie(0), mNotify(0) {}
143    virtual             ~MediaPlayerBase() {}
144    virtual status_t    initCheck() = 0;
145    virtual bool        hardwareOutput() = 0;
146
147    virtual status_t    setUID(uid_t /* uid */) {
148        return INVALID_OPERATION;
149    }
150
151    virtual status_t    setDataSource(
152            const sp<IMediaHTTPService> &httpService,
153            const char *url,
154            const KeyedVector<String8, String8> *headers = NULL) = 0;
155
156    virtual status_t    setDataSource(int fd, int64_t offset, int64_t length) = 0;
157
158    virtual status_t    setDataSource(const sp<IStreamSource>& /* source */) {
159        return INVALID_OPERATION;
160    }
161
162    virtual status_t    setDataSource(const sp<DataSource>& /* source */) {
163        return INVALID_OPERATION;
164    }
165
166    // pass the buffered IGraphicBufferProducer to the media player service
167    virtual status_t    setVideoSurfaceTexture(
168                                const sp<IGraphicBufferProducer>& bufferProducer) = 0;
169
170    virtual status_t    prepare() = 0;
171    virtual status_t    prepareAsync() = 0;
172    virtual status_t    start() = 0;
173    virtual status_t    stop() = 0;
174    virtual status_t    pause() = 0;
175    virtual bool        isPlaying() = 0;
176    virtual status_t    setPlaybackRate(float /* rate */) { return INVALID_OPERATION; }
177    virtual status_t    seekTo(int msec) = 0;
178    virtual status_t    getCurrentPosition(int *msec) = 0;
179    virtual status_t    getDuration(int *msec) = 0;
180    virtual status_t    reset() = 0;
181    virtual status_t    setLooping(int loop) = 0;
182    virtual player_type playerType() = 0;
183    virtual status_t    setParameter(int key, const Parcel &request) = 0;
184    virtual status_t    getParameter(int key, Parcel *reply) = 0;
185
186    // default no-op implementation of optional extensions
187    virtual status_t setRetransmitEndpoint(const struct sockaddr_in* /* endpoint */) {
188        return INVALID_OPERATION;
189    }
190    virtual status_t getRetransmitEndpoint(struct sockaddr_in* /* endpoint */) {
191        return INVALID_OPERATION;
192    }
193    virtual status_t setNextPlayer(const sp<MediaPlayerBase>& /* next */) {
194        return OK;
195    }
196
197    // Invoke a generic method on the player by using opaque parcels
198    // for the request and reply.
199    //
200    // @param request Parcel that is positioned at the start of the
201    //                data sent by the java layer.
202    // @param[out] reply Parcel to hold the reply data. Cannot be null.
203    // @return OK if the call was successful.
204    virtual status_t    invoke(const Parcel& request, Parcel *reply) = 0;
205
206    // The Client in the MetadataPlayerService calls this method on
207    // the native player to retrieve all or a subset of metadata.
208    //
209    // @param ids SortedList of metadata ID to be fetch. If empty, all
210    //            the known metadata should be returned.
211    // @param[inout] records Parcel where the player appends its metadata.
212    // @return OK if the call was successful.
213    virtual status_t    getMetadata(const media::Metadata::Filter& /* ids */,
214                                    Parcel* /* records */) {
215        return INVALID_OPERATION;
216    };
217
218    void        setNotifyCallback(
219            void* cookie, notify_callback_f notifyFunc) {
220        Mutex::Autolock autoLock(mNotifyLock);
221        mCookie = cookie; mNotify = notifyFunc;
222    }
223
224    void        sendEvent(int msg, int ext1=0, int ext2=0,
225                          const Parcel *obj=NULL) {
226        notify_callback_f notifyCB;
227        void* cookie;
228        {
229            Mutex::Autolock autoLock(mNotifyLock);
230            notifyCB = mNotify;
231            cookie = mCookie;
232        }
233
234        if (notifyCB) notifyCB(cookie, msg, ext1, ext2, obj);
235    }
236
237    virtual status_t dump(int /* fd */, const Vector<String16>& /* args */) const {
238        return INVALID_OPERATION;
239    }
240
241private:
242    friend class MediaPlayerService;
243
244    Mutex               mNotifyLock;
245    void*               mCookie;
246    notify_callback_f   mNotify;
247};
248
249// Implement this class for media players that use the AudioFlinger software mixer
250class MediaPlayerInterface : public MediaPlayerBase
251{
252public:
253    virtual             ~MediaPlayerInterface() { }
254    virtual bool        hardwareOutput() { return false; }
255    virtual void        setAudioSink(const sp<AudioSink>& audioSink) { mAudioSink = audioSink; }
256protected:
257    sp<AudioSink>       mAudioSink;
258};
259
260// Implement this class for media players that output audio directly to hardware
261class MediaPlayerHWInterface : public MediaPlayerBase
262{
263public:
264    virtual             ~MediaPlayerHWInterface() {}
265    virtual bool        hardwareOutput() { return true; }
266    virtual status_t    setVolume(float leftVolume, float rightVolume) = 0;
267    virtual status_t    setAudioStreamType(audio_stream_type_t streamType) = 0;
268};
269
270}; // namespace android
271
272#endif // __cplusplus
273
274
275#endif // ANDROID_MEDIAPLAYERINTERFACE_H
276