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/AudioResamplerPublic.h>
30#include <media/AudioSystem.h>
31#include <media/AudioTimestamp.h>
32#include <media/AVSyncSettings.h>
33#include <media/BufferingSettings.h>
34#include <media/Metadata.h>
35
36// Fwd decl to make sure everyone agrees that the scope of struct sockaddr_in is
37// global, and not in android::
38struct sockaddr_in;
39
40namespace android {
41
42class DataSource;
43class Parcel;
44class Surface;
45class IGraphicBufferProducer;
46
47template<typename T> class SortedVector;
48
49enum player_type {
50    STAGEFRIGHT_PLAYER = 3,
51    NU_PLAYER = 4,
52    // Test players are available only in the 'test' and 'eng' builds.
53    // The shared library with the test player is passed passed as an
54    // argument to the 'test:' url in the setDataSource call.
55    TEST_PLAYER = 5,
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        enum cb_event_t {
81            CB_EVENT_FILL_BUFFER,   // Request to write more data to buffer.
82            CB_EVENT_STREAM_END,    // Sent after all the buffers queued in AF and HW are played
83                                    // back (after stop is called)
84            CB_EVENT_TEAR_DOWN      // The AudioTrack was invalidated due to use case change:
85                                    // Need to re-evaluate offloading options
86        };
87
88        // Callback returns the number of bytes actually written to the buffer.
89        typedef size_t (*AudioCallback)(
90                AudioSink *audioSink, void *buffer, size_t size, void *cookie,
91                        cb_event_t event);
92
93        virtual             ~AudioSink() {}
94        virtual bool        ready() const = 0; // audio output is open and ready
95        virtual ssize_t     bufferSize() const = 0;
96        virtual ssize_t     frameCount() const = 0;
97        virtual ssize_t     channelCount() const = 0;
98        virtual ssize_t     frameSize() const = 0;
99        virtual uint32_t    latency() const = 0;
100        virtual float       msecsPerFrame() const = 0;
101        virtual status_t    getPosition(uint32_t *position) const = 0;
102        virtual status_t    getTimestamp(AudioTimestamp &ts) const = 0;
103        virtual int64_t     getPlayedOutDurationUs(int64_t nowUs) const = 0;
104        virtual status_t    getFramesWritten(uint32_t *frameswritten) const = 0;
105        virtual audio_session_t getSessionId() const = 0;
106        virtual audio_stream_type_t getAudioStreamType() const = 0;
107        virtual uint32_t    getSampleRate() const = 0;
108        virtual int64_t     getBufferDurationInUs() const = 0;
109
110        // If no callback is specified, use the "write" API below to submit
111        // audio data.
112        virtual status_t    open(
113                uint32_t sampleRate, int channelCount, audio_channel_mask_t channelMask,
114                audio_format_t format=AUDIO_FORMAT_PCM_16_BIT,
115                int bufferCount=DEFAULT_AUDIOSINK_BUFFERCOUNT,
116                AudioCallback cb = NULL,
117                void *cookie = NULL,
118                audio_output_flags_t flags = AUDIO_OUTPUT_FLAG_NONE,
119                const audio_offload_info_t *offloadInfo = NULL,
120                bool doNotReconnect = false,
121                uint32_t suggestedFrameCount = 0) = 0;
122
123        virtual status_t    start() = 0;
124
125        /* Input parameter |size| is in byte units stored in |buffer|.
126         * Data is copied over and actual number of bytes written (>= 0)
127         * is returned, or no data is copied and a negative status code
128         * is returned (even when |blocking| is true).
129         * When |blocking| is false, AudioSink will immediately return after
130         * part of or full |buffer| is copied over.
131         * When |blocking| is true, AudioSink will wait to copy the entire
132         * buffer, unless an error occurs or the copy operation is
133         * prematurely stopped.
134         */
135        virtual ssize_t     write(const void* buffer, size_t size, bool blocking = true) = 0;
136
137        virtual void        stop() = 0;
138        virtual void        flush() = 0;
139        virtual void        pause() = 0;
140        virtual void        close() = 0;
141
142        virtual status_t    setPlaybackRate(const AudioPlaybackRate& rate) = 0;
143        virtual status_t    getPlaybackRate(AudioPlaybackRate* rate /* nonnull */) = 0;
144        virtual bool        needsTrailingPadding() { return true; }
145
146        virtual status_t    setParameters(const String8& /* keyValuePairs */) { return NO_ERROR; }
147        virtual String8     getParameters(const String8& /* keys */) { return String8::empty(); }
148
149        virtual VolumeShaper::Status applyVolumeShaper(
150                                    const sp<VolumeShaper::Configuration>& configuration,
151                                    const sp<VolumeShaper::Operation>& operation);
152        virtual sp<VolumeShaper::State> getVolumeShaperState(int id);
153    };
154
155                        MediaPlayerBase() : mCookie(0), mNotify(0) {}
156    virtual             ~MediaPlayerBase() {}
157    virtual status_t    initCheck() = 0;
158    virtual bool        hardwareOutput() = 0;
159
160    virtual status_t    setUID(uid_t /* uid */) {
161        return INVALID_OPERATION;
162    }
163
164    virtual status_t    setDataSource(
165            const sp<IMediaHTTPService> &httpService,
166            const char *url,
167            const KeyedVector<String8, String8> *headers = NULL) = 0;
168
169    virtual status_t    setDataSource(int fd, int64_t offset, int64_t length) = 0;
170
171    virtual status_t    setDataSource(const sp<IStreamSource>& /* source */) {
172        return INVALID_OPERATION;
173    }
174
175    virtual status_t    setDataSource(const sp<DataSource>& /* source */) {
176        return INVALID_OPERATION;
177    }
178
179    // pass the buffered IGraphicBufferProducer to the media player service
180    virtual status_t    setVideoSurfaceTexture(
181                                const sp<IGraphicBufferProducer>& bufferProducer) = 0;
182
183    virtual status_t    getDefaultBufferingSettings(
184                                BufferingSettings* buffering /* nonnull */) {
185        *buffering = BufferingSettings();
186        return OK;
187    }
188    virtual status_t    setBufferingSettings(const BufferingSettings& /* buffering */) {
189        return OK;
190    }
191
192    virtual status_t    prepare() = 0;
193    virtual status_t    prepareAsync() = 0;
194    virtual status_t    start() = 0;
195    virtual status_t    stop() = 0;
196    virtual status_t    pause() = 0;
197    virtual bool        isPlaying() = 0;
198    virtual status_t    setPlaybackSettings(const AudioPlaybackRate& rate) {
199        // by default, players only support setting rate to the default
200        if (!isAudioPlaybackRateEqual(rate, AUDIO_PLAYBACK_RATE_DEFAULT)) {
201            return BAD_VALUE;
202        }
203        return OK;
204    }
205    virtual status_t    getPlaybackSettings(AudioPlaybackRate* rate /* nonnull */) {
206        *rate = AUDIO_PLAYBACK_RATE_DEFAULT;
207        return OK;
208    }
209    virtual status_t    setSyncSettings(const AVSyncSettings& sync, float /* videoFps */) {
210        // By default, players only support setting sync source to default; all other sync
211        // settings are ignored. There is no requirement for getters to return set values.
212        if (sync.mSource != AVSYNC_SOURCE_DEFAULT) {
213            return BAD_VALUE;
214        }
215        return OK;
216    }
217    virtual status_t    getSyncSettings(
218                                AVSyncSettings* sync /* nonnull */, float* videoFps /* nonnull */) {
219        *sync = AVSyncSettings();
220        *videoFps = -1.f;
221        return OK;
222    }
223    virtual status_t    seekTo(
224            int msec, MediaPlayerSeekMode mode = MediaPlayerSeekMode::SEEK_PREVIOUS_SYNC) = 0;
225    virtual status_t    getCurrentPosition(int *msec) = 0;
226    virtual status_t    getDuration(int *msec) = 0;
227    virtual status_t    reset() = 0;
228    virtual status_t    setLooping(int loop) = 0;
229    virtual player_type playerType() = 0;
230    virtual status_t    setParameter(int key, const Parcel &request) = 0;
231    virtual status_t    getParameter(int key, Parcel *reply) = 0;
232
233    // default no-op implementation of optional extensions
234    virtual status_t setRetransmitEndpoint(const struct sockaddr_in* /* endpoint */) {
235        return INVALID_OPERATION;
236    }
237    virtual status_t getRetransmitEndpoint(struct sockaddr_in* /* endpoint */) {
238        return INVALID_OPERATION;
239    }
240    virtual status_t setNextPlayer(const sp<MediaPlayerBase>& /* next */) {
241        return OK;
242    }
243
244    // Invoke a generic method on the player by using opaque parcels
245    // for the request and reply.
246    //
247    // @param request Parcel that is positioned at the start of the
248    //                data sent by the java layer.
249    // @param[out] reply Parcel to hold the reply data. Cannot be null.
250    // @return OK if the call was successful.
251    virtual status_t    invoke(const Parcel& request, Parcel *reply) = 0;
252
253    // The Client in the MetadataPlayerService calls this method on
254    // the native player to retrieve all or a subset of metadata.
255    //
256    // @param ids SortedList of metadata ID to be fetch. If empty, all
257    //            the known metadata should be returned.
258    // @param[inout] records Parcel where the player appends its metadata.
259    // @return OK if the call was successful.
260    virtual status_t    getMetadata(const media::Metadata::Filter& /* ids */,
261                                    Parcel* /* records */) {
262        return INVALID_OPERATION;
263    };
264
265    void        setNotifyCallback(
266            void* cookie, notify_callback_f notifyFunc) {
267        Mutex::Autolock autoLock(mNotifyLock);
268        mCookie = cookie; mNotify = notifyFunc;
269    }
270
271    void        sendEvent(int msg, int ext1=0, int ext2=0,
272                          const Parcel *obj=NULL) {
273        notify_callback_f notifyCB;
274        void* cookie;
275        {
276            Mutex::Autolock autoLock(mNotifyLock);
277            notifyCB = mNotify;
278            cookie = mCookie;
279        }
280
281        if (notifyCB) notifyCB(cookie, msg, ext1, ext2, obj);
282    }
283
284    virtual status_t dump(int /* fd */, const Vector<String16>& /* args */) const {
285        return INVALID_OPERATION;
286    }
287
288    // Modular DRM
289    virtual status_t prepareDrm(const uint8_t uuid[16], const Vector<uint8_t>& drmSessionId) {
290        return INVALID_OPERATION;
291    }
292    virtual status_t releaseDrm() {
293        return INVALID_OPERATION;
294    }
295
296private:
297    friend class MediaPlayerService;
298
299    Mutex               mNotifyLock;
300    void*               mCookie;
301    notify_callback_f   mNotify;
302};
303
304// Implement this class for media players that use the AudioFlinger software mixer
305class MediaPlayerInterface : public MediaPlayerBase
306{
307public:
308    virtual             ~MediaPlayerInterface() { }
309    virtual bool        hardwareOutput() { return false; }
310    virtual void        setAudioSink(const sp<AudioSink>& audioSink) { mAudioSink = audioSink; }
311protected:
312    sp<AudioSink>       mAudioSink;
313};
314
315// Implement this class for media players that output audio directly to hardware
316class MediaPlayerHWInterface : public MediaPlayerBase
317{
318public:
319    virtual             ~MediaPlayerHWInterface() {}
320    virtual bool        hardwareOutput() { return true; }
321    virtual status_t    setVolume(float leftVolume, float rightVolume) = 0;
322    virtual status_t    setAudioStreamType(audio_stream_type_t streamType) = 0;
323};
324
325}; // namespace android
326
327#endif // __cplusplus
328
329
330#endif // ANDROID_MEDIAPLAYERINTERFACE_H
331