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/AudioResamplerPublic.h> 30#include <media/AudioSystem.h> 31#include <media/AudioTimestamp.h> 32#include <media/AVSyncSettings.h> 33#include <media/Metadata.h> 34 35// Fwd decl to make sure everyone agrees that the scope of struct sockaddr_in is 36// global, and not in android:: 37struct sockaddr_in; 38 39namespace android { 40 41class DataSource; 42class Parcel; 43class Surface; 44class IGraphicBufferProducer; 45 46template<typename T> class SortedVector; 47 48enum player_type { 49 STAGEFRIGHT_PLAYER = 3, 50 NU_PLAYER = 4, 51 // Test players are available only in the 'test' and 'eng' builds. 52 // The shared library with the test player is passed passed as an 53 // argument to the 'test:' url in the setDataSource call. 54 TEST_PLAYER = 5, 55}; 56 57 58#define DEFAULT_AUDIOSINK_BUFFERCOUNT 4 59#define DEFAULT_AUDIOSINK_BUFFERSIZE 1200 60#define DEFAULT_AUDIOSINK_SAMPLERATE 44100 61 62// when the channel mask isn't known, use the channel count to derive a mask in AudioSink::open() 63#define CHANNEL_MASK_USE_CHANNEL_ORDER 0 64 65// duration below which we do not allow deep audio buffering 66#define AUDIO_SINK_MIN_DEEP_BUFFER_DURATION_US 5000000 67 68// callback mechanism for passing messages to MediaPlayer object 69typedef void (*notify_callback_f)(void* cookie, 70 int msg, int ext1, int ext2, const Parcel *obj); 71 72// abstract base class - use MediaPlayerInterface 73class MediaPlayerBase : public RefBase 74{ 75public: 76 // AudioSink: abstraction layer for audio output 77 class AudioSink : public RefBase { 78 public: 79 enum cb_event_t { 80 CB_EVENT_FILL_BUFFER, // Request to write more data to buffer. 81 CB_EVENT_STREAM_END, // Sent after all the buffers queued in AF and HW are played 82 // back (after stop is called) 83 CB_EVENT_TEAR_DOWN // The AudioTrack was invalidated due to use case change: 84 // Need to re-evaluate offloading options 85 }; 86 87 // Callback returns the number of bytes actually written to the buffer. 88 typedef size_t (*AudioCallback)( 89 AudioSink *audioSink, void *buffer, size_t size, void *cookie, 90 cb_event_t event); 91 92 virtual ~AudioSink() {} 93 virtual bool ready() const = 0; // audio output is open and ready 94 virtual ssize_t bufferSize() const = 0; 95 virtual ssize_t frameCount() const = 0; 96 virtual ssize_t channelCount() const = 0; 97 virtual ssize_t frameSize() const = 0; 98 virtual uint32_t latency() const = 0; 99 virtual float msecsPerFrame() const = 0; 100 virtual status_t getPosition(uint32_t *position) const = 0; 101 virtual status_t getTimestamp(AudioTimestamp &ts) const = 0; 102 virtual int64_t getPlayedOutDurationUs(int64_t nowUs) const = 0; 103 virtual status_t getFramesWritten(uint32_t *frameswritten) const = 0; 104 virtual audio_session_t getSessionId() const = 0; 105 virtual audio_stream_type_t getAudioStreamType() const = 0; 106 virtual uint32_t getSampleRate() const = 0; 107 virtual int64_t getBufferDurationInUs() const = 0; 108 109 // If no callback is specified, use the "write" API below to submit 110 // audio data. 111 virtual status_t open( 112 uint32_t sampleRate, int channelCount, audio_channel_mask_t channelMask, 113 audio_format_t format=AUDIO_FORMAT_PCM_16_BIT, 114 int bufferCount=DEFAULT_AUDIOSINK_BUFFERCOUNT, 115 AudioCallback cb = NULL, 116 void *cookie = NULL, 117 audio_output_flags_t flags = AUDIO_OUTPUT_FLAG_NONE, 118 const audio_offload_info_t *offloadInfo = NULL, 119 bool doNotReconnect = false, 120 uint32_t suggestedFrameCount = 0) = 0; 121 122 virtual status_t start() = 0; 123 124 /* Input parameter |size| is in byte units stored in |buffer|. 125 * Data is copied over and actual number of bytes written (>= 0) 126 * is returned, or no data is copied and a negative status code 127 * is returned (even when |blocking| is true). 128 * When |blocking| is false, AudioSink will immediately return after 129 * part of or full |buffer| is copied over. 130 * When |blocking| is true, AudioSink will wait to copy the entire 131 * buffer, unless an error occurs or the copy operation is 132 * prematurely stopped. 133 */ 134 virtual ssize_t write(const void* buffer, size_t size, bool blocking = true) = 0; 135 136 virtual void stop() = 0; 137 virtual void flush() = 0; 138 virtual void pause() = 0; 139 virtual void close() = 0; 140 141 virtual status_t setPlaybackRate(const AudioPlaybackRate& rate) = 0; 142 virtual status_t getPlaybackRate(AudioPlaybackRate* rate /* nonnull */) = 0; 143 virtual bool needsTrailingPadding() { return true; } 144 145 virtual status_t setParameters(const String8& /* keyValuePairs */) { return NO_ERROR; } 146 virtual String8 getParameters(const String8& /* keys */) { return String8::empty(); } 147 }; 148 149 MediaPlayerBase() : mCookie(0), mNotify(0) {} 150 virtual ~MediaPlayerBase() {} 151 virtual status_t initCheck() = 0; 152 virtual bool hardwareOutput() = 0; 153 154 virtual status_t setUID(uid_t /* uid */) { 155 return INVALID_OPERATION; 156 } 157 158 virtual status_t setDataSource( 159 const sp<IMediaHTTPService> &httpService, 160 const char *url, 161 const KeyedVector<String8, String8> *headers = NULL) = 0; 162 163 virtual status_t setDataSource(int fd, int64_t offset, int64_t length) = 0; 164 165 virtual status_t setDataSource(const sp<IStreamSource>& /* source */) { 166 return INVALID_OPERATION; 167 } 168 169 virtual status_t setDataSource(const sp<DataSource>& /* source */) { 170 return INVALID_OPERATION; 171 } 172 173 // pass the buffered IGraphicBufferProducer to the media player service 174 virtual status_t setVideoSurfaceTexture( 175 const sp<IGraphicBufferProducer>& bufferProducer) = 0; 176 177 virtual status_t prepare() = 0; 178 virtual status_t prepareAsync() = 0; 179 virtual status_t start() = 0; 180 virtual status_t stop() = 0; 181 virtual status_t pause() = 0; 182 virtual bool isPlaying() = 0; 183 virtual status_t setPlaybackSettings(const AudioPlaybackRate& rate) { 184 // by default, players only support setting rate to the default 185 if (!isAudioPlaybackRateEqual(rate, AUDIO_PLAYBACK_RATE_DEFAULT)) { 186 return BAD_VALUE; 187 } 188 return OK; 189 } 190 virtual status_t getPlaybackSettings(AudioPlaybackRate* rate /* nonnull */) { 191 *rate = AUDIO_PLAYBACK_RATE_DEFAULT; 192 return OK; 193 } 194 virtual status_t setSyncSettings(const AVSyncSettings& sync, float /* videoFps */) { 195 // By default, players only support setting sync source to default; all other sync 196 // settings are ignored. There is no requirement for getters to return set values. 197 if (sync.mSource != AVSYNC_SOURCE_DEFAULT) { 198 return BAD_VALUE; 199 } 200 return OK; 201 } 202 virtual status_t getSyncSettings( 203 AVSyncSettings* sync /* nonnull */, float* videoFps /* nonnull */) { 204 *sync = AVSyncSettings(); 205 *videoFps = -1.f; 206 return OK; 207 } 208 virtual status_t seekTo(int msec) = 0; 209 virtual status_t getCurrentPosition(int *msec) = 0; 210 virtual status_t getDuration(int *msec) = 0; 211 virtual status_t reset() = 0; 212 virtual status_t setLooping(int loop) = 0; 213 virtual player_type playerType() = 0; 214 virtual status_t setParameter(int key, const Parcel &request) = 0; 215 virtual status_t getParameter(int key, Parcel *reply) = 0; 216 217 // default no-op implementation of optional extensions 218 virtual status_t setRetransmitEndpoint(const struct sockaddr_in* /* endpoint */) { 219 return INVALID_OPERATION; 220 } 221 virtual status_t getRetransmitEndpoint(struct sockaddr_in* /* endpoint */) { 222 return INVALID_OPERATION; 223 } 224 virtual status_t setNextPlayer(const sp<MediaPlayerBase>& /* next */) { 225 return OK; 226 } 227 228 // Invoke a generic method on the player by using opaque parcels 229 // for the request and reply. 230 // 231 // @param request Parcel that is positioned at the start of the 232 // data sent by the java layer. 233 // @param[out] reply Parcel to hold the reply data. Cannot be null. 234 // @return OK if the call was successful. 235 virtual status_t invoke(const Parcel& request, Parcel *reply) = 0; 236 237 // The Client in the MetadataPlayerService calls this method on 238 // the native player to retrieve all or a subset of metadata. 239 // 240 // @param ids SortedList of metadata ID to be fetch. If empty, all 241 // the known metadata should be returned. 242 // @param[inout] records Parcel where the player appends its metadata. 243 // @return OK if the call was successful. 244 virtual status_t getMetadata(const media::Metadata::Filter& /* ids */, 245 Parcel* /* records */) { 246 return INVALID_OPERATION; 247 }; 248 249 void setNotifyCallback( 250 void* cookie, notify_callback_f notifyFunc) { 251 Mutex::Autolock autoLock(mNotifyLock); 252 mCookie = cookie; mNotify = notifyFunc; 253 } 254 255 void sendEvent(int msg, int ext1=0, int ext2=0, 256 const Parcel *obj=NULL) { 257 notify_callback_f notifyCB; 258 void* cookie; 259 { 260 Mutex::Autolock autoLock(mNotifyLock); 261 notifyCB = mNotify; 262 cookie = mCookie; 263 } 264 265 if (notifyCB) notifyCB(cookie, msg, ext1, ext2, obj); 266 } 267 268 virtual status_t dump(int /* fd */, const Vector<String16>& /* args */) const { 269 return INVALID_OPERATION; 270 } 271 272private: 273 friend class MediaPlayerService; 274 275 Mutex mNotifyLock; 276 void* mCookie; 277 notify_callback_f mNotify; 278}; 279 280// Implement this class for media players that use the AudioFlinger software mixer 281class MediaPlayerInterface : public MediaPlayerBase 282{ 283public: 284 virtual ~MediaPlayerInterface() { } 285 virtual bool hardwareOutput() { return false; } 286 virtual void setAudioSink(const sp<AudioSink>& audioSink) { mAudioSink = audioSink; } 287protected: 288 sp<AudioSink> mAudioSink; 289}; 290 291// Implement this class for media players that output audio directly to hardware 292class MediaPlayerHWInterface : public MediaPlayerBase 293{ 294public: 295 virtual ~MediaPlayerHWInterface() {} 296 virtual bool hardwareOutput() { return true; } 297 virtual status_t setVolume(float leftVolume, float rightVolume) = 0; 298 virtual status_t setAudioStreamType(audio_stream_type_t streamType) = 0; 299}; 300 301}; // namespace android 302 303#endif // __cplusplus 304 305 306#endif // ANDROID_MEDIAPLAYERINTERFACE_H 307