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