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