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 32 // Fwd decl to make sure everyone agrees that the scope of struct sockaddr_in is 33 // global, and not in android:: 34 struct sockaddr_in; 35 36 namespace android { 37 38 class Parcel; 39 class Surface; 40 class ISurfaceTexture; 41 42 template<typename T> class SortedVector; 43 44 enum player_type { 45 PV_PLAYER = 1, 46 SONIVOX_PLAYER = 2, 47 STAGEFRIGHT_PLAYER = 3, 48 NU_PLAYER = 4, 49 // Test players are available only in the 'test' and 'eng' builds. 50 // The shared library with the test player is passed passed as an 51 // argument to the 'test:' url in the setDataSource call. 52 TEST_PLAYER = 5, 53 54 AAH_RX_PLAYER = 100, 55 AAH_TX_PLAYER = 101, 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 // callback mechanism for passing messages to MediaPlayer object 70 typedef void (*notify_callback_f)(void* cookie, 71 int msg, int ext1, int ext2, const Parcel *obj); 72 73 // abstract base class - use MediaPlayerInterface 74 class MediaPlayerBase : public RefBase 75 { 76 public: 77 // AudioSink: abstraction layer for audio output 78 class AudioSink : public RefBase { 79 public: 80 // Callback returns the number of bytes actually written to the buffer. 81 typedef size_t (*AudioCallback)( 82 AudioSink *audioSink, void *buffer, size_t size, void *cookie); 83 ~AudioSink()84 virtual ~AudioSink() {} 85 virtual bool ready() const = 0; // audio output is open and ready 86 virtual bool realtime() const = 0; // audio output is real-time output 87 virtual ssize_t bufferSize() const = 0; 88 virtual ssize_t frameCount() const = 0; 89 virtual ssize_t channelCount() const = 0; 90 virtual ssize_t frameSize() const = 0; 91 virtual uint32_t latency() const = 0; 92 virtual float msecsPerFrame() const = 0; 93 virtual status_t getPosition(uint32_t *position) const = 0; 94 virtual status_t getFramesWritten(uint32_t *frameswritten) const = 0; 95 virtual int getSessionId() const = 0; 96 97 // If no callback is specified, use the "write" API below to submit 98 // audio data. 99 virtual status_t open( 100 uint32_t sampleRate, int channelCount, audio_channel_mask_t channelMask, 101 audio_format_t format=AUDIO_FORMAT_PCM_16_BIT, 102 int bufferCount=DEFAULT_AUDIOSINK_BUFFERCOUNT, 103 AudioCallback cb = NULL, 104 void *cookie = NULL, 105 audio_output_flags_t flags = AUDIO_OUTPUT_FLAG_NONE) = 0; 106 107 virtual void start() = 0; 108 virtual ssize_t write(const void* buffer, size_t size) = 0; 109 virtual void stop() = 0; 110 virtual void flush() = 0; 111 virtual void pause() = 0; 112 virtual void close() = 0; 113 setPlaybackRatePermille(int32_t rate)114 virtual status_t setPlaybackRatePermille(int32_t rate) { return INVALID_OPERATION; } needsTrailingPadding()115 virtual bool needsTrailingPadding() { return true; } 116 }; 117 MediaPlayerBase()118 MediaPlayerBase() : mCookie(0), mNotify(0) {} ~MediaPlayerBase()119 virtual ~MediaPlayerBase() {} 120 virtual status_t initCheck() = 0; 121 virtual bool hardwareOutput() = 0; 122 setUID(uid_t uid)123 virtual status_t setUID(uid_t uid) { 124 return INVALID_OPERATION; 125 } 126 127 virtual status_t setDataSource( 128 const char *url, 129 const KeyedVector<String8, String8> *headers = NULL) = 0; 130 131 virtual status_t setDataSource(int fd, int64_t offset, int64_t length) = 0; 132 setDataSource(const sp<IStreamSource> & source)133 virtual status_t setDataSource(const sp<IStreamSource> &source) { 134 return INVALID_OPERATION; 135 } 136 137 // pass the buffered ISurfaceTexture to the media player service 138 virtual status_t setVideoSurfaceTexture( 139 const sp<ISurfaceTexture>& surfaceTexture) = 0; 140 141 virtual status_t prepare() = 0; 142 virtual status_t prepareAsync() = 0; 143 virtual status_t start() = 0; 144 virtual status_t stop() = 0; 145 virtual status_t pause() = 0; 146 virtual bool isPlaying() = 0; 147 virtual status_t seekTo(int msec) = 0; 148 virtual status_t getCurrentPosition(int *msec) = 0; 149 virtual status_t getDuration(int *msec) = 0; 150 virtual status_t reset() = 0; 151 virtual status_t setLooping(int loop) = 0; 152 virtual player_type playerType() = 0; 153 virtual status_t setParameter(int key, const Parcel &request) = 0; 154 virtual status_t getParameter(int key, Parcel *reply) = 0; 155 156 // Right now, only the AAX TX player supports this functionality. For now, 157 // provide a default implementation which indicates a lack of support for 158 // this functionality to make life easier for all of the other media player 159 // maintainers out there. setRetransmitEndpoint(const struct sockaddr_in * endpoint)160 virtual status_t setRetransmitEndpoint(const struct sockaddr_in* endpoint) { 161 return INVALID_OPERATION; 162 } 163 164 // Invoke a generic method on the player by using opaque parcels 165 // for the request and reply. 166 // 167 // @param request Parcel that is positioned at the start of the 168 // data sent by the java layer. 169 // @param[out] reply Parcel to hold the reply data. Cannot be null. 170 // @return OK if the call was successful. 171 virtual status_t invoke(const Parcel& request, Parcel *reply) = 0; 172 173 // The Client in the MetadataPlayerService calls this method on 174 // the native player to retrieve all or a subset of metadata. 175 // 176 // @param ids SortedList of metadata ID to be fetch. If empty, all 177 // the known metadata should be returned. 178 // @param[inout] records Parcel where the player appends its metadata. 179 // @return OK if the call was successful. getMetadata(const media::Metadata::Filter & ids,Parcel * records)180 virtual status_t getMetadata(const media::Metadata::Filter& ids, 181 Parcel *records) { 182 return INVALID_OPERATION; 183 }; 184 setNotifyCallback(void * cookie,notify_callback_f notifyFunc)185 void setNotifyCallback( 186 void* cookie, notify_callback_f notifyFunc) { 187 Mutex::Autolock autoLock(mNotifyLock); 188 mCookie = cookie; mNotify = notifyFunc; 189 } 190 191 void sendEvent(int msg, int ext1=0, int ext2=0, 192 const Parcel *obj=NULL) { 193 Mutex::Autolock autoLock(mNotifyLock); 194 if (mNotify) mNotify(mCookie, msg, ext1, ext2, obj); 195 } 196 dump(int fd,const Vector<String16> & args)197 virtual status_t dump(int fd, const Vector<String16> &args) const { 198 return INVALID_OPERATION; 199 } 200 201 private: 202 friend class MediaPlayerService; 203 204 Mutex mNotifyLock; 205 void* mCookie; 206 notify_callback_f mNotify; 207 }; 208 209 // Implement this class for media players that use the AudioFlinger software mixer 210 class MediaPlayerInterface : public MediaPlayerBase 211 { 212 public: ~MediaPlayerInterface()213 virtual ~MediaPlayerInterface() { } hardwareOutput()214 virtual bool hardwareOutput() { return false; } setAudioSink(const sp<AudioSink> & audioSink)215 virtual void setAudioSink(const sp<AudioSink>& audioSink) { mAudioSink = audioSink; } 216 protected: 217 sp<AudioSink> mAudioSink; 218 }; 219 220 // Implement this class for media players that output audio directly to hardware 221 class MediaPlayerHWInterface : public MediaPlayerBase 222 { 223 public: ~MediaPlayerHWInterface()224 virtual ~MediaPlayerHWInterface() {} hardwareOutput()225 virtual bool hardwareOutput() { return true; } 226 virtual status_t setVolume(float leftVolume, float rightVolume) = 0; 227 virtual status_t setAudioStreamType(audio_stream_type_t streamType) = 0; 228 }; 229 230 }; // namespace android 231 232 #endif // __cplusplus 233 234 235 #endif // ANDROID_MEDIAPLAYERINTERFACE_H 236