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