MediaPlayerInterface.h revision 5e49afd05566820517747b9a8071c99ec0918328 
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 IGraphicBufferProducer;
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
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 bool        realtime() const = 0; // audio output is real-time output
93        virtual ssize_t     bufferSize() const = 0;
94        virtual ssize_t     frameCount() const = 0;
95        virtual ssize_t     channelCount() const = 0;
96        virtual ssize_t     frameSize() const = 0;
97        virtual uint32_t    latency() const = 0;
98        virtual float       msecsPerFrame() const = 0;
99        virtual status_t    getPosition(uint32_t *position) 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        virtual ssize_t     write(const void* buffer, size_t size) = 0;
118        virtual void        stop() = 0;
119        virtual void        flush() = 0;
120        virtual void        pause() = 0;
121        virtual void        close() = 0;
122
123        virtual status_t    setPlaybackRatePermille(int32_t rate) { return INVALID_OPERATION; }
124        virtual bool        needsTrailingPadding() { return true; }
125
126        virtual status_t    setParameters(const String8& keyValuePairs) { return NO_ERROR; };
127        virtual String8     getParameters(const String8& keys) { return String8::empty(); };
128    };
129
130                        MediaPlayerBase() : mCookie(0), mNotify(0) {}
131    virtual             ~MediaPlayerBase() {}
132    virtual status_t    initCheck() = 0;
133    virtual bool        hardwareOutput() = 0;
134
135    virtual status_t    setUID(uid_t uid) {
136        return INVALID_OPERATION;
137    }
138
139    virtual status_t    setDataSource(
140            const char *url,
141            const KeyedVector<String8, String8> *headers = NULL) = 0;
142
143    virtual status_t    setDataSource(int fd, int64_t offset, int64_t length) = 0;
144
145    virtual status_t    setDataSource(const sp<IStreamSource> &source) {
146        return INVALID_OPERATION;
147    }
148
149    // pass the buffered IGraphicBufferProducer to the media player service
150    virtual status_t    setVideoSurfaceTexture(
151                                const sp<IGraphicBufferProducer>& bufferProducer) = 0;
152
153    virtual status_t    prepare() = 0;
154    virtual status_t    prepareAsync() = 0;
155    virtual status_t    start() = 0;
156    virtual status_t    stop() = 0;
157    virtual status_t    pause() = 0;
158    virtual bool        isPlaying() = 0;
159    virtual status_t    seekTo(int msec) = 0;
160    virtual status_t    getCurrentPosition(int *msec) = 0;
161    virtual status_t    getDuration(int *msec) = 0;
162    virtual status_t    reset() = 0;
163    virtual status_t    setLooping(int loop) = 0;
164    virtual player_type playerType() = 0;
165    virtual status_t    setParameter(int key, const Parcel &request) = 0;
166    virtual status_t    getParameter(int key, Parcel *reply) = 0;
167
168    // default no-op implementation of optional extensions
169    virtual status_t setRetransmitEndpoint(const struct sockaddr_in* endpoint) {
170        return INVALID_OPERATION;
171    }
172    virtual status_t getRetransmitEndpoint(struct sockaddr_in* endpoint) {
173        return INVALID_OPERATION;
174    }
175    virtual status_t setNextPlayer(const sp<MediaPlayerBase>& next) {
176        return OK;
177    }
178
179    // Invoke a generic method on the player by using opaque parcels
180    // for the request and reply.
181    //
182    // @param request Parcel that is positioned at the start of the
183    //                data sent by the java layer.
184    // @param[out] reply Parcel to hold the reply data. Cannot be null.
185    // @return OK if the call was successful.
186    virtual status_t    invoke(const Parcel& request, Parcel *reply) = 0;
187
188    // The Client in the MetadataPlayerService calls this method on
189    // the native player to retrieve all or a subset of metadata.
190    //
191    // @param ids SortedList of metadata ID to be fetch. If empty, all
192    //            the known metadata should be returned.
193    // @param[inout] records Parcel where the player appends its metadata.
194    // @return OK if the call was successful.
195    virtual status_t    getMetadata(const media::Metadata::Filter& ids,
196                                    Parcel *records) {
197        return INVALID_OPERATION;
198    };
199
200    void        setNotifyCallback(
201            void* cookie, notify_callback_f notifyFunc) {
202        Mutex::Autolock autoLock(mNotifyLock);
203        mCookie = cookie; mNotify = notifyFunc;
204    }
205
206    void        sendEvent(int msg, int ext1=0, int ext2=0,
207                          const Parcel *obj=NULL) {
208        Mutex::Autolock autoLock(mNotifyLock);
209        if (mNotify) mNotify(mCookie, msg, ext1, ext2, obj);
210    }
211
212    virtual status_t dump(int fd, const Vector<String16> &args) const {
213        return INVALID_OPERATION;
214    }
215
216    virtual status_t updateProxyConfig(
217            const char *host, int32_t port, const char *exclusionList) {
218        return INVALID_OPERATION;
219    }
220
221private:
222    friend class MediaPlayerService;
223
224    Mutex               mNotifyLock;
225    void*               mCookie;
226    notify_callback_f   mNotify;
227};
228
229// Implement this class for media players that use the AudioFlinger software mixer
230class MediaPlayerInterface : public MediaPlayerBase
231{
232public:
233    virtual             ~MediaPlayerInterface() { }
234    virtual bool        hardwareOutput() { return false; }
235    virtual void        setAudioSink(const sp<AudioSink>& audioSink) { mAudioSink = audioSink; }
236protected:
237    sp<AudioSink>       mAudioSink;
238};
239
240// Implement this class for media players that output audio directly to hardware
241class MediaPlayerHWInterface : public MediaPlayerBase
242{
243public:
244    virtual             ~MediaPlayerHWInterface() {}
245    virtual bool        hardwareOutput() { return true; }
246    virtual status_t    setVolume(float leftVolume, float rightVolume) = 0;
247    virtual status_t    setAudioStreamType(audio_stream_type_t streamType) = 0;
248};
249
250}; // namespace android
251
252#endif // __cplusplus
253
254
255#endif // ANDROID_MEDIAPLAYERINTERFACE_H
256