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 namespace android { 33 34 class Parcel; 35 class ISurface; 36 37 template<typename T> class SortedVector; 38 39 enum player_type { 40 PV_PLAYER = 1, 41 SONIVOX_PLAYER = 2, 42 STAGEFRIGHT_PLAYER = 4, 43 // Test players are available only in the 'test' and 'eng' builds. 44 // The shared library with the test player is passed passed as an 45 // argument to the 'test:' url in the setDataSource call. 46 TEST_PLAYER = 5, 47 }; 48 49 50 #define DEFAULT_AUDIOSINK_BUFFERCOUNT 4 51 #define DEFAULT_AUDIOSINK_BUFFERSIZE 1200 52 #define DEFAULT_AUDIOSINK_SAMPLERATE 44100 53 54 55 // callback mechanism for passing messages to MediaPlayer object 56 typedef void (*notify_callback_f)(void* cookie, int msg, int ext1, int ext2); 57 58 // abstract base class - use MediaPlayerInterface 59 class MediaPlayerBase : public RefBase 60 { 61 public: 62 // AudioSink: abstraction layer for audio output 63 class AudioSink : public RefBase { 64 public: 65 // Callback returns the number of bytes actually written to the buffer. 66 typedef size_t (*AudioCallback)( 67 AudioSink *audioSink, void *buffer, size_t size, void *cookie); 68 69 virtual ~AudioSink() {} 70 virtual bool ready() const = 0; // audio output is open and ready 71 virtual bool realtime() const = 0; // audio output is real-time output 72 virtual ssize_t bufferSize() const = 0; 73 virtual ssize_t frameCount() const = 0; 74 virtual ssize_t channelCount() const = 0; 75 virtual ssize_t frameSize() const = 0; 76 virtual uint32_t latency() const = 0; 77 virtual float msecsPerFrame() const = 0; 78 virtual status_t getPosition(uint32_t *position) = 0; 79 virtual int getSessionId() = 0; 80 81 // If no callback is specified, use the "write" API below to submit 82 // audio data. 83 virtual status_t open( 84 uint32_t sampleRate, int channelCount, 85 int format=AudioSystem::PCM_16_BIT, 86 int bufferCount=DEFAULT_AUDIOSINK_BUFFERCOUNT, 87 AudioCallback cb = NULL, 88 void *cookie = NULL) = 0; 89 90 virtual void start() = 0; 91 virtual ssize_t write(const void* buffer, size_t size) = 0; 92 virtual void stop() = 0; 93 virtual void flush() = 0; 94 virtual void pause() = 0; 95 virtual void close() = 0; 96 }; 97 98 MediaPlayerBase() : mCookie(0), mNotify(0) {} 99 virtual ~MediaPlayerBase() {} 100 virtual status_t initCheck() = 0; 101 virtual bool hardwareOutput() = 0; 102 103 virtual status_t setDataSource( 104 const char *url, 105 const KeyedVector<String8, String8> *headers = NULL) = 0; 106 107 virtual status_t setDataSource(int fd, int64_t offset, int64_t length) = 0; 108 virtual status_t setVideoSurface(const sp<ISurface>& surface) = 0; 109 virtual status_t prepare() = 0; 110 virtual status_t prepareAsync() = 0; 111 virtual status_t start() = 0; 112 virtual status_t stop() = 0; 113 virtual status_t pause() = 0; 114 virtual bool isPlaying() = 0; 115 virtual status_t seekTo(int msec) = 0; 116 virtual status_t getCurrentPosition(int *msec) = 0; 117 virtual status_t getDuration(int *msec) = 0; 118 virtual status_t reset() = 0; 119 virtual status_t setLooping(int loop) = 0; 120 virtual player_type playerType() = 0; 121 virtual status_t suspend() { return INVALID_OPERATION; } 122 virtual status_t resume() { return INVALID_OPERATION; } 123 124 virtual void setNotifyCallback(void* cookie, notify_callback_f notifyFunc) { 125 mCookie = cookie; mNotify = notifyFunc; } 126 // Invoke a generic method on the player by using opaque parcels 127 // for the request and reply. 128 // 129 // @param request Parcel that is positioned at the start of the 130 // data sent by the java layer. 131 // @param[out] reply Parcel to hold the reply data. Cannot be null. 132 // @return OK if the call was successful. 133 virtual status_t invoke(const Parcel& request, Parcel *reply) = 0; 134 135 // The Client in the MetadataPlayerService calls this method on 136 // the native player to retrieve all or a subset of metadata. 137 // 138 // @param ids SortedList of metadata ID to be fetch. If empty, all 139 // the known metadata should be returned. 140 // @param[inout] records Parcel where the player appends its metadata. 141 // @return OK if the call was successful. 142 virtual status_t getMetadata(const media::Metadata::Filter& ids, 143 Parcel *records) { 144 return INVALID_OPERATION; 145 }; 146 147 virtual void sendEvent(int msg, int ext1=0, int ext2=0) { if (mNotify) mNotify(mCookie, msg, ext1, ext2); } 148 149 protected: 150 void* mCookie; 151 notify_callback_f mNotify; 152 }; 153 154 // Implement this class for media players that use the AudioFlinger software mixer 155 class MediaPlayerInterface : public MediaPlayerBase 156 { 157 public: 158 virtual ~MediaPlayerInterface() { } 159 virtual bool hardwareOutput() { return false; } 160 virtual void setAudioSink(const sp<AudioSink>& audioSink) { mAudioSink = audioSink; } 161 protected: 162 sp<AudioSink> mAudioSink; 163 }; 164 165 // Implement this class for media players that output directo to hardware 166 class MediaPlayerHWInterface : public MediaPlayerBase 167 { 168 public: 169 virtual ~MediaPlayerHWInterface() {} 170 virtual bool hardwareOutput() { return true; } 171 virtual status_t setVolume(float leftVolume, float rightVolume) = 0; 172 virtual status_t setAudioStreamType(int streamType) = 0; 173 }; 174 175 }; // namespace android 176 177 #endif // __cplusplus 178 179 180 #endif // ANDROID_MEDIAPLAYERINTERFACE_H 181
