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