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