The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 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 | |
Nicolas Catania | 8f5fcab | 2009-07-13 14:37:49 -0700 | [diff] [blame] | 22 | #include <sys/types.h> |
Nicolas Catania | 8f5fcab | 2009-07-13 14:37:49 -0700 | [diff] [blame] | 23 | #include <utils/Errors.h> |
Andreas Huber | 2564300 | 2010-01-28 11:19:57 -0800 | [diff] [blame] | 24 | #include <utils/KeyedVector.h> |
| 25 | #include <utils/String8.h> |
| 26 | #include <utils/RefBase.h> |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 27 | |
| 28 | #include <media/mediaplayer.h> |
| 29 | #include <media/AudioSystem.h> |
niko | bc72692 | 2009-07-20 15:07:26 -0700 | [diff] [blame] | 30 | #include <media/Metadata.h> |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 31 | |
John Grossman | 720aa28 | 2012-02-22 15:38:35 -0800 | [diff] [blame] | 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 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 36 | namespace android { |
| 37 | |
Nicolas Catania | 20cb94e | 2009-05-12 23:25:55 -0700 | [diff] [blame] | 38 | class Parcel; |
Andreas Huber | e3c0183 | 2010-08-16 08:49:37 -0700 | [diff] [blame] | 39 | class Surface; |
Glenn Kasten | cc562a3 | 2011-02-08 17:26:17 -0800 | [diff] [blame] | 40 | class ISurfaceTexture; |
Mathias Agopian | 000479f | 2010-02-09 17:46:37 -0800 | [diff] [blame] | 41 | |
niko | 8994837 | 2009-07-16 16:39:53 -0700 | [diff] [blame] | 42 | template<typename T> class SortedVector; |
Nicolas Catania | 20cb94e | 2009-05-12 23:25:55 -0700 | [diff] [blame] | 43 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 44 | enum player_type { |
| 45 | PV_PLAYER = 1, |
| 46 | SONIVOX_PLAYER = 2, |
Andreas Huber | a158746 | 2010-12-15 15:17:42 -0800 | [diff] [blame] | 47 | STAGEFRIGHT_PLAYER = 3, |
| 48 | NU_PLAYER = 4, |
Nicolas Catania | 8f5fcab | 2009-07-13 14:37:49 -0700 | [diff] [blame] | 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, |
John Grossman | d72031c | 2012-02-09 15:09:05 -0800 | [diff] [blame] | 53 | |
| 54 | AAH_RX_PLAYER = 100, |
| 55 | AAH_TX_PLAYER = 101, |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 56 | }; |
| 57 | |
Nicolas Catania | 20cb94e | 2009-05-12 23:25:55 -0700 | [diff] [blame] | 58 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 59 | #define DEFAULT_AUDIOSINK_BUFFERCOUNT 4 |
| 60 | #define DEFAULT_AUDIOSINK_BUFFERSIZE 1200 |
| 61 | #define DEFAULT_AUDIOSINK_SAMPLERATE 44100 |
| 62 | |
Jean-Michel Trivi | 4ed260f | 2012-03-02 14:54:07 -0800 | [diff] [blame] | 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 |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 65 | |
| 66 | // callback mechanism for passing messages to MediaPlayer object |
Gloria Wang | 162ee49 | 2011-04-11 17:23:27 -0700 | [diff] [blame] | 67 | typedef void (*notify_callback_f)(void* cookie, |
| 68 | int msg, int ext1, int ext2, const Parcel *obj); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 69 | |
| 70 | // abstract base class - use MediaPlayerInterface |
| 71 | class MediaPlayerBase : public RefBase |
| 72 | { |
| 73 | public: |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 74 | // AudioSink: abstraction layer for audio output |
| 75 | class AudioSink : public RefBase { |
| 76 | public: |
Andreas Huber | 6ed937e | 2010-02-09 16:59:18 -0800 | [diff] [blame] | 77 | // Callback returns the number of bytes actually written to the buffer. |
| 78 | typedef size_t (*AudioCallback)( |
Andreas Huber | e46b7be | 2009-07-14 16:56:47 -0700 | [diff] [blame] | 79 | AudioSink *audioSink, void *buffer, size_t size, void *cookie); |
| 80 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 81 | virtual ~AudioSink() {} |
| 82 | virtual bool ready() const = 0; // audio output is open and ready |
| 83 | virtual bool realtime() const = 0; // audio output is real-time output |
| 84 | virtual ssize_t bufferSize() const = 0; |
| 85 | virtual ssize_t frameCount() const = 0; |
| 86 | virtual ssize_t channelCount() const = 0; |
| 87 | virtual ssize_t frameSize() const = 0; |
| 88 | virtual uint32_t latency() const = 0; |
| 89 | virtual float msecsPerFrame() const = 0; |
Eric Laurent | 0986e79 | 2010-01-19 17:37:09 -0800 | [diff] [blame] | 90 | virtual status_t getPosition(uint32_t *position) = 0; |
Eric Laurent | b3bdf3f | 2010-10-07 18:23:03 -0700 | [diff] [blame] | 91 | virtual int getSessionId() = 0; |
Andreas Huber | e46b7be | 2009-07-14 16:56:47 -0700 | [diff] [blame] | 92 | |
| 93 | // If no callback is specified, use the "write" API below to submit |
Andreas Huber | 6ed937e | 2010-02-09 16:59:18 -0800 | [diff] [blame] | 94 | // audio data. |
Andreas Huber | e46b7be | 2009-07-14 16:56:47 -0700 | [diff] [blame] | 95 | virtual status_t open( |
Jean-Michel Trivi | 4ed260f | 2012-03-02 14:54:07 -0800 | [diff] [blame] | 96 | uint32_t sampleRate, int channelCount, audio_channel_mask_t channelMask, |
Glenn Kasten | 1c5a89d | 2012-01-04 09:36:37 -0800 | [diff] [blame] | 97 | audio_format_t format=AUDIO_FORMAT_PCM_16_BIT, |
Andreas Huber | e46b7be | 2009-07-14 16:56:47 -0700 | [diff] [blame] | 98 | int bufferCount=DEFAULT_AUDIOSINK_BUFFERCOUNT, |
| 99 | AudioCallback cb = NULL, |
| 100 | void *cookie = NULL) = 0; |
| 101 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 102 | virtual void start() = 0; |
| 103 | virtual ssize_t write(const void* buffer, size_t size) = 0; |
| 104 | virtual void stop() = 0; |
| 105 | virtual void flush() = 0; |
| 106 | virtual void pause() = 0; |
| 107 | virtual void close() = 0; |
Jean-Michel Trivi | e901a5c | 2012-02-02 09:06:31 -0800 | [diff] [blame] | 108 | |
| 109 | virtual status_t setPlaybackRatePermille(int32_t rate) { return INVALID_OPERATION; } |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 110 | }; |
| 111 | |
| 112 | MediaPlayerBase() : mCookie(0), mNotify(0) {} |
| 113 | virtual ~MediaPlayerBase() {} |
| 114 | virtual status_t initCheck() = 0; |
| 115 | virtual bool hardwareOutput() = 0; |
Andreas Huber | 2564300 | 2010-01-28 11:19:57 -0800 | [diff] [blame] | 116 | |
Andreas Huber | 603d739 | 2011-06-30 15:47:02 -0700 | [diff] [blame] | 117 | virtual status_t setUID(uid_t uid) { |
| 118 | return INVALID_OPERATION; |
| 119 | } |
| 120 | |
Andreas Huber | 2564300 | 2010-01-28 11:19:57 -0800 | [diff] [blame] | 121 | virtual status_t setDataSource( |
| 122 | const char *url, |
| 123 | const KeyedVector<String8, String8> *headers = NULL) = 0; |
| 124 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 125 | virtual status_t setDataSource(int fd, int64_t offset, int64_t length) = 0; |
Andreas Huber | 52b52cd | 2010-11-23 11:41:34 -0800 | [diff] [blame] | 126 | |
| 127 | virtual status_t setDataSource(const sp<IStreamSource> &source) { |
| 128 | return INVALID_OPERATION; |
| 129 | } |
| 130 | |
Glenn Kasten | cc562a3 | 2011-02-08 17:26:17 -0800 | [diff] [blame] | 131 | // pass the buffered ISurfaceTexture to the media player service |
| 132 | virtual status_t setVideoSurfaceTexture( |
| 133 | const sp<ISurfaceTexture>& surfaceTexture) = 0; |
| 134 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 135 | virtual status_t prepare() = 0; |
| 136 | virtual status_t prepareAsync() = 0; |
| 137 | virtual status_t start() = 0; |
| 138 | virtual status_t stop() = 0; |
| 139 | virtual status_t pause() = 0; |
| 140 | virtual bool isPlaying() = 0; |
| 141 | virtual status_t seekTo(int msec) = 0; |
| 142 | virtual status_t getCurrentPosition(int *msec) = 0; |
| 143 | virtual status_t getDuration(int *msec) = 0; |
| 144 | virtual status_t reset() = 0; |
| 145 | virtual status_t setLooping(int loop) = 0; |
| 146 | virtual player_type playerType() = 0; |
Gloria Wang | d01ec6e | 2011-04-25 17:28:22 -0700 | [diff] [blame] | 147 | virtual status_t setParameter(int key, const Parcel &request) = 0; |
| 148 | virtual status_t getParameter(int key, Parcel *reply) = 0; |
Andreas Huber | fbb3885 | 2010-02-12 12:35:58 -0800 | [diff] [blame] | 149 | |
John Grossman | 720aa28 | 2012-02-22 15:38:35 -0800 | [diff] [blame] | 150 | // Right now, only the AAX TX player supports this functionality. For now, |
| 151 | // provide a default implementation which indicates a lack of support for |
| 152 | // this functionality to make life easier for all of the other media player |
| 153 | // maintainers out there. |
| 154 | virtual status_t setRetransmitEndpoint(const struct sockaddr_in* endpoint) { |
| 155 | return INVALID_OPERATION; |
| 156 | } |
| 157 | |
Nicolas Catania | 20cb94e | 2009-05-12 23:25:55 -0700 | [diff] [blame] | 158 | // Invoke a generic method on the player by using opaque parcels |
| 159 | // for the request and reply. |
niko | 8994837 | 2009-07-16 16:39:53 -0700 | [diff] [blame] | 160 | // |
Nicolas Catania | 20cb94e | 2009-05-12 23:25:55 -0700 | [diff] [blame] | 161 | // @param request Parcel that is positioned at the start of the |
| 162 | // data sent by the java layer. |
| 163 | // @param[out] reply Parcel to hold the reply data. Cannot be null. |
niko | 8994837 | 2009-07-16 16:39:53 -0700 | [diff] [blame] | 164 | // @return OK if the call was successful. |
Nicolas Catania | 20cb94e | 2009-05-12 23:25:55 -0700 | [diff] [blame] | 165 | virtual status_t invoke(const Parcel& request, Parcel *reply) = 0; |
niko | 8994837 | 2009-07-16 16:39:53 -0700 | [diff] [blame] | 166 | |
| 167 | // The Client in the MetadataPlayerService calls this method on |
| 168 | // the native player to retrieve all or a subset of metadata. |
| 169 | // |
| 170 | // @param ids SortedList of metadata ID to be fetch. If empty, all |
| 171 | // the known metadata should be returned. |
| 172 | // @param[inout] records Parcel where the player appends its metadata. |
| 173 | // @return OK if the call was successful. |
niko | bc72692 | 2009-07-20 15:07:26 -0700 | [diff] [blame] | 174 | virtual status_t getMetadata(const media::Metadata::Filter& ids, |
| 175 | Parcel *records) { |
| 176 | return INVALID_OPERATION; |
| 177 | }; |
niko | 8994837 | 2009-07-16 16:39:53 -0700 | [diff] [blame] | 178 | |
Andreas Huber | 2ffbb18 | 2011-01-26 11:19:19 -0800 | [diff] [blame] | 179 | void setNotifyCallback( |
| 180 | void* cookie, notify_callback_f notifyFunc) { |
| 181 | Mutex::Autolock autoLock(mNotifyLock); |
| 182 | mCookie = cookie; mNotify = notifyFunc; |
| 183 | } |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 184 | |
Gloria Wang | 162ee49 | 2011-04-11 17:23:27 -0700 | [diff] [blame] | 185 | void sendEvent(int msg, int ext1=0, int ext2=0, |
| 186 | const Parcel *obj=NULL) { |
Andreas Huber | 2ffbb18 | 2011-01-26 11:19:19 -0800 | [diff] [blame] | 187 | Mutex::Autolock autoLock(mNotifyLock); |
Gloria Wang | 162ee49 | 2011-04-11 17:23:27 -0700 | [diff] [blame] | 188 | if (mNotify) mNotify(mCookie, msg, ext1, ext2, obj); |
Andreas Huber | 2ffbb18 | 2011-01-26 11:19:19 -0800 | [diff] [blame] | 189 | } |
| 190 | |
Andreas Huber | fddf5d9 | 2011-06-07 15:52:25 -0700 | [diff] [blame] | 191 | virtual status_t dump(int fd, const Vector<String16> &args) const { |
| 192 | return INVALID_OPERATION; |
| 193 | } |
| 194 | |
Andreas Huber | 2ffbb18 | 2011-01-26 11:19:19 -0800 | [diff] [blame] | 195 | private: |
| 196 | friend class MediaPlayerService; |
| 197 | |
| 198 | Mutex mNotifyLock; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 199 | void* mCookie; |
| 200 | notify_callback_f mNotify; |
| 201 | }; |
| 202 | |
| 203 | // Implement this class for media players that use the AudioFlinger software mixer |
| 204 | class MediaPlayerInterface : public MediaPlayerBase |
| 205 | { |
| 206 | public: |
| 207 | virtual ~MediaPlayerInterface() { } |
| 208 | virtual bool hardwareOutput() { return false; } |
| 209 | virtual void setAudioSink(const sp<AudioSink>& audioSink) { mAudioSink = audioSink; } |
| 210 | protected: |
| 211 | sp<AudioSink> mAudioSink; |
| 212 | }; |
| 213 | |
Glenn Kasten | cc562a3 | 2011-02-08 17:26:17 -0800 | [diff] [blame] | 214 | // Implement this class for media players that output audio directly to hardware |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 215 | class MediaPlayerHWInterface : public MediaPlayerBase |
| 216 | { |
| 217 | public: |
| 218 | virtual ~MediaPlayerHWInterface() {} |
| 219 | virtual bool hardwareOutput() { return true; } |
| 220 | virtual status_t setVolume(float leftVolume, float rightVolume) = 0; |
Glenn Kasten | bc1d77b | 2012-01-12 16:38:12 -0800 | [diff] [blame] | 221 | virtual status_t setAudioStreamType(audio_stream_type_t streamType) = 0; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 222 | }; |
| 223 | |
| 224 | }; // namespace android |
| 225 | |
| 226 | #endif // __cplusplus |
| 227 | |
| 228 | |
| 229 | #endif // ANDROID_MEDIAPLAYERINTERFACE_H |