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