MediaPlayerInterface.h revision 1173118eace0e9e347cb007f0da817cee87579ed
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; 37class ISurfaceTexture; 38 39template<typename T> class SortedVector; 40 41enum player_type { 42 PV_PLAYER = 1, 43 SONIVOX_PLAYER = 2, 44 STAGEFRIGHT_PLAYER = 3, 45 NU_PLAYER = 4, 46 // Test players are available only in the 'test' and 'eng' builds. 47 // The shared library with the test player is passed passed as an 48 // argument to the 'test:' url in the setDataSource call. 49 TEST_PLAYER = 5, 50}; 51 52 53#define DEFAULT_AUDIOSINK_BUFFERCOUNT 4 54#define DEFAULT_AUDIOSINK_BUFFERSIZE 1200 55#define DEFAULT_AUDIOSINK_SAMPLERATE 44100 56 57 58// callback mechanism for passing messages to MediaPlayer object 59typedef void (*notify_callback_f)(void* cookie, int msg, int ext1, int ext2); 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 int format=AudioSystem::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 setDataSource( 107 const char *url, 108 const KeyedVector<String8, String8> *headers = NULL) = 0; 109 110 virtual status_t setDataSource(int fd, int64_t offset, int64_t length) = 0; 111 112 virtual status_t setDataSource(const sp<IStreamSource> &source) { 113 return INVALID_OPERATION; 114 } 115 116 // pass the buffered Surface to the media player service 117 virtual status_t setVideoSurface(const sp<Surface>& surface) = 0; 118 119 // pass the buffered ISurfaceTexture to the media player service 120 virtual status_t setVideoSurfaceTexture( 121 const sp<ISurfaceTexture>& surfaceTexture) = 0; 122 123 virtual status_t prepare() = 0; 124 virtual status_t prepareAsync() = 0; 125 virtual status_t start() = 0; 126 virtual status_t stop() = 0; 127 virtual status_t pause() = 0; 128 virtual bool isPlaying() = 0; 129 virtual status_t seekTo(int msec) = 0; 130 virtual status_t getCurrentPosition(int *msec) = 0; 131 virtual status_t getDuration(int *msec) = 0; 132 virtual status_t reset() = 0; 133 virtual status_t setLooping(int loop) = 0; 134 virtual player_type playerType() = 0; 135 136 // Invoke a generic method on the player by using opaque parcels 137 // for the request and reply. 138 // 139 // @param request Parcel that is positioned at the start of the 140 // data sent by the java layer. 141 // @param[out] reply Parcel to hold the reply data. Cannot be null. 142 // @return OK if the call was successful. 143 virtual status_t invoke(const Parcel& request, Parcel *reply) = 0; 144 145 // The Client in the MetadataPlayerService calls this method on 146 // the native player to retrieve all or a subset of metadata. 147 // 148 // @param ids SortedList of metadata ID to be fetch. If empty, all 149 // the known metadata should be returned. 150 // @param[inout] records Parcel where the player appends its metadata. 151 // @return OK if the call was successful. 152 virtual status_t getMetadata(const media::Metadata::Filter& ids, 153 Parcel *records) { 154 return INVALID_OPERATION; 155 }; 156 157 void setNotifyCallback( 158 void* cookie, notify_callback_f notifyFunc) { 159 Mutex::Autolock autoLock(mNotifyLock); 160 mCookie = cookie; mNotify = notifyFunc; 161 } 162 163 void sendEvent(int msg, int ext1=0, int ext2=0) { 164 Mutex::Autolock autoLock(mNotifyLock); 165 if (mNotify) mNotify(mCookie, msg, ext1, ext2); 166 } 167 168private: 169 friend class MediaPlayerService; 170 171 Mutex mNotifyLock; 172 void* mCookie; 173 notify_callback_f mNotify; 174}; 175 176// Implement this class for media players that use the AudioFlinger software mixer 177class MediaPlayerInterface : public MediaPlayerBase 178{ 179public: 180 virtual ~MediaPlayerInterface() { } 181 virtual bool hardwareOutput() { return false; } 182 virtual void setAudioSink(const sp<AudioSink>& audioSink) { mAudioSink = audioSink; } 183protected: 184 sp<AudioSink> mAudioSink; 185}; 186 187// Implement this class for media players that output audio directly to hardware 188class MediaPlayerHWInterface : public MediaPlayerBase 189{ 190public: 191 virtual ~MediaPlayerHWInterface() {} 192 virtual bool hardwareOutput() { return true; } 193 virtual status_t setVolume(float leftVolume, float rightVolume) = 0; 194 virtual status_t setAudioStreamType(int streamType) = 0; 195}; 196 197}; // namespace android 198 199#endif // __cplusplus 200 201 202#endif // ANDROID_MEDIAPLAYERINTERFACE_H 203