MediaPlayerInterface.h revision f933441648ef6a71dee783d733aac17b9508b452 
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 ISurface;
36class Surface;
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, int msg, int ext1, int ext2);
59
60// abstract base class - use MediaPlayerInterface
61class MediaPlayerBase : public RefBase
62{
63public:
64    // AudioSink: abstraction layer for audio output
65    class AudioSink : public RefBase {
66    public:
67        // Callback returns the number of bytes actually written to the buffer.
68        typedef size_t (*AudioCallback)(
69                AudioSink *audioSink, void *buffer, size_t size, void *cookie);
70
71        virtual             ~AudioSink() {}
72        virtual bool        ready() const = 0; // audio output is open and ready
73        virtual bool        realtime() const = 0; // audio output is real-time output
74        virtual ssize_t     bufferSize() const = 0;
75        virtual ssize_t     frameCount() const = 0;
76        virtual ssize_t     channelCount() const = 0;
77        virtual ssize_t     frameSize() const = 0;
78        virtual uint32_t    latency() const = 0;
79        virtual float       msecsPerFrame() const = 0;
80        virtual status_t    getPosition(uint32_t *position) = 0;
81        virtual int         getSessionId() = 0;
82
83        // If no callback is specified, use the "write" API below to submit
84        // audio data.
85        virtual status_t    open(
86                uint32_t sampleRate, int channelCount,
87                int format=AudioSystem::PCM_16_BIT,
88                int bufferCount=DEFAULT_AUDIOSINK_BUFFERCOUNT,
89                AudioCallback cb = NULL,
90                void *cookie = NULL) = 0;
91
92        virtual void        start() = 0;
93        virtual ssize_t     write(const void* buffer, size_t size) = 0;
94        virtual void        stop() = 0;
95        virtual void        flush() = 0;
96        virtual void        pause() = 0;
97        virtual void        close() = 0;
98    };
99
100                        MediaPlayerBase() : mCookie(0), mNotify(0) {}
101    virtual             ~MediaPlayerBase() {}
102    virtual status_t    initCheck() = 0;
103    virtual bool        hardwareOutput() = 0;
104
105    virtual status_t    setDataSource(
106            const char *url,
107            const KeyedVector<String8, String8> *headers = NULL) = 0;
108
109    virtual status_t    setDataSource(int fd, int64_t offset, int64_t length) = 0;
110
111    virtual status_t    setDataSource(const sp<IStreamSource> &source) {
112        return INVALID_OPERATION;
113    }
114
115    virtual status_t    setVideoSurface(const sp<Surface>& surface) = 0;
116    virtual status_t    prepare() = 0;
117    virtual status_t    prepareAsync() = 0;
118    virtual status_t    start() = 0;
119    virtual status_t    stop() = 0;
120    virtual status_t    pause() = 0;
121    virtual bool        isPlaying() = 0;
122    virtual status_t    seekTo(int msec) = 0;
123    virtual status_t    getCurrentPosition(int *msec) = 0;
124    virtual status_t    getDuration(int *msec) = 0;
125    virtual status_t    reset() = 0;
126    virtual status_t    setLooping(int loop) = 0;
127    virtual player_type playerType() = 0;
128
129    virtual void        setNotifyCallback(void* cookie, notify_callback_f notifyFunc) {
130                            mCookie = cookie; mNotify = notifyFunc; }
131    // Invoke a generic method on the player by using opaque parcels
132    // for the request and reply.
133    //
134    // @param request Parcel that is positioned at the start of the
135    //                data sent by the java layer.
136    // @param[out] reply Parcel to hold the reply data. Cannot be null.
137    // @return OK if the call was successful.
138    virtual status_t    invoke(const Parcel& request, Parcel *reply) = 0;
139
140    // The Client in the MetadataPlayerService calls this method on
141    // the native player to retrieve all or a subset of metadata.
142    //
143    // @param ids SortedList of metadata ID to be fetch. If empty, all
144    //            the known metadata should be returned.
145    // @param[inout] records Parcel where the player appends its metadata.
146    // @return OK if the call was successful.
147    virtual status_t    getMetadata(const media::Metadata::Filter& ids,
148                                    Parcel *records) {
149        return INVALID_OPERATION;
150    };
151
152    virtual void        sendEvent(int msg, int ext1=0, int ext2=0) { if (mNotify) mNotify(mCookie, msg, ext1, ext2); }
153
154protected:
155    void*               mCookie;
156    notify_callback_f   mNotify;
157};
158
159// Implement this class for media players that use the AudioFlinger software mixer
160class MediaPlayerInterface : public MediaPlayerBase
161{
162public:
163    virtual             ~MediaPlayerInterface() { }
164    virtual bool        hardwareOutput() { return false; }
165    virtual void        setAudioSink(const sp<AudioSink>& audioSink) { mAudioSink = audioSink; }
166protected:
167    sp<AudioSink>       mAudioSink;
168};
169
170// Implement this class for media players that output directo to hardware
171class MediaPlayerHWInterface : public MediaPlayerBase
172{
173public:
174    virtual             ~MediaPlayerHWInterface() {}
175    virtual bool        hardwareOutput() { return true; }
176    virtual status_t    setVolume(float leftVolume, float rightVolume) = 0;
177    virtual status_t    setAudioStreamType(int streamType) = 0;
178};
179
180}; // namespace android
181
182#endif // __cplusplus
183
184
185#endif // ANDROID_MEDIAPLAYERINTERFACE_H
186