mediaplayer.h revision dcb89b3b505522efde173c105a851c412f947178
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_MEDIAPLAYER_H 18#define ANDROID_MEDIAPLAYER_H 19 20#include <arpa/inet.h> 21 22#include <binder/IMemory.h> 23#include <media/IMediaPlayerClient.h> 24#include <media/IMediaPlayer.h> 25#include <media/IMediaDeathNotifier.h> 26#include <media/IStreamSource.h> 27 28#include <utils/KeyedVector.h> 29#include <utils/String8.h> 30 31class ANativeWindow; 32 33namespace android { 34 35class Surface; 36class IGraphicBufferProducer; 37 38enum media_event_type { 39 MEDIA_NOP = 0, // interface test message 40 MEDIA_PREPARED = 1, 41 MEDIA_PLAYBACK_COMPLETE = 2, 42 MEDIA_BUFFERING_UPDATE = 3, 43 MEDIA_SEEK_COMPLETE = 4, 44 MEDIA_SET_VIDEO_SIZE = 5, 45 MEDIA_STARTED = 6, 46 MEDIA_PAUSED = 7, 47 MEDIA_STOPPED = 8, 48 MEDIA_TIMED_TEXT = 99, 49 MEDIA_ERROR = 100, 50 MEDIA_INFO = 200, 51 MEDIA_SUBTITLE_DATA = 201, 52}; 53 54// Generic error codes for the media player framework. Errors are fatal, the 55// playback must abort. 56// 57// Errors are communicated back to the client using the 58// MediaPlayerListener::notify method defined below. 59// In this situation, 'notify' is invoked with the following: 60// 'msg' is set to MEDIA_ERROR. 61// 'ext1' should be a value from the enum media_error_type. 62// 'ext2' contains an implementation dependant error code to provide 63// more details. Should default to 0 when not used. 64// 65// The codes are distributed as follow: 66// 0xx: Reserved 67// 1xx: Android Player errors. Something went wrong inside the MediaPlayer. 68// 2xx: Media errors (e.g Codec not supported). There is a problem with the 69// media itself. 70// 3xx: Runtime errors. Some extraordinary condition arose making the playback 71// impossible. 72// 73enum media_error_type { 74 // 0xx 75 MEDIA_ERROR_UNKNOWN = 1, 76 // 1xx 77 MEDIA_ERROR_SERVER_DIED = 100, 78 // 2xx 79 MEDIA_ERROR_NOT_VALID_FOR_PROGRESSIVE_PLAYBACK = 200, 80 // 3xx 81}; 82 83 84// Info and warning codes for the media player framework. These are non fatal, 85// the playback is going on but there might be some user visible issues. 86// 87// Info and warning messages are communicated back to the client using the 88// MediaPlayerListener::notify method defined below. In this situation, 89// 'notify' is invoked with the following: 90// 'msg' is set to MEDIA_INFO. 91// 'ext1' should be a value from the enum media_info_type. 92// 'ext2' contains an implementation dependant info code to provide 93// more details. Should default to 0 when not used. 94// 95// The codes are distributed as follow: 96// 0xx: Reserved 97// 7xx: Android Player info/warning (e.g player lagging behind.) 98// 8xx: Media info/warning (e.g media badly interleaved.) 99// 100enum media_info_type { 101 // 0xx 102 MEDIA_INFO_UNKNOWN = 1, 103 // The player was started because it was used as the next player for another 104 // player, which just completed playback 105 MEDIA_INFO_STARTED_AS_NEXT = 2, 106 // The player just pushed the very first video frame for rendering 107 MEDIA_INFO_RENDERING_START = 3, 108 // 7xx 109 // The video is too complex for the decoder: it can't decode frames fast 110 // enough. Possibly only the audio plays fine at this stage. 111 MEDIA_INFO_VIDEO_TRACK_LAGGING = 700, 112 // MediaPlayer is temporarily pausing playback internally in order to 113 // buffer more data. 114 MEDIA_INFO_BUFFERING_START = 701, 115 // MediaPlayer is resuming playback after filling buffers. 116 MEDIA_INFO_BUFFERING_END = 702, 117 // Bandwidth in recent past 118 MEDIA_INFO_NETWORK_BANDWIDTH = 703, 119 120 // 8xx 121 // Bad interleaving means that a media has been improperly interleaved or not 122 // interleaved at all, e.g has all the video samples first then all the audio 123 // ones. Video is playing but a lot of disk seek may be happening. 124 MEDIA_INFO_BAD_INTERLEAVING = 800, 125 // The media is not seekable (e.g live stream). 126 MEDIA_INFO_NOT_SEEKABLE = 801, 127 // New media metadata is available. 128 MEDIA_INFO_METADATA_UPDATE = 802, 129 130 //9xx 131 MEDIA_INFO_TIMED_TEXT_ERROR = 900, 132}; 133 134 135 136enum media_player_states { 137 MEDIA_PLAYER_STATE_ERROR = 0, 138 MEDIA_PLAYER_IDLE = 1 << 0, 139 MEDIA_PLAYER_INITIALIZED = 1 << 1, 140 MEDIA_PLAYER_PREPARING = 1 << 2, 141 MEDIA_PLAYER_PREPARED = 1 << 3, 142 MEDIA_PLAYER_STARTED = 1 << 4, 143 MEDIA_PLAYER_PAUSED = 1 << 5, 144 MEDIA_PLAYER_STOPPED = 1 << 6, 145 MEDIA_PLAYER_PLAYBACK_COMPLETE = 1 << 7 146}; 147 148// Keep KEY_PARAMETER_* in sync with MediaPlayer.java. 149// The same enum space is used for both set and get, in case there are future keys that 150// can be both set and get. But as of now, all parameters are either set only or get only. 151enum media_parameter_keys { 152 // Streaming/buffering parameters 153 KEY_PARAMETER_CACHE_STAT_COLLECT_FREQ_MS = 1100, // set only 154 155 // Return a Parcel containing a single int, which is the channel count of the 156 // audio track, or zero for error (e.g. no audio track) or unknown. 157 KEY_PARAMETER_AUDIO_CHANNEL_COUNT = 1200, // get only 158 159 // Playback rate expressed in permille (1000 is normal speed), saved as int32_t, with negative 160 // values used for rewinding or reverse playback. 161 KEY_PARAMETER_PLAYBACK_RATE_PERMILLE = 1300, // set only 162}; 163 164// Keep INVOKE_ID_* in sync with MediaPlayer.java. 165enum media_player_invoke_ids { 166 INVOKE_ID_GET_TRACK_INFO = 1, 167 INVOKE_ID_ADD_EXTERNAL_SOURCE = 2, 168 INVOKE_ID_ADD_EXTERNAL_SOURCE_FD = 3, 169 INVOKE_ID_SELECT_TRACK = 4, 170 INVOKE_ID_UNSELECT_TRACK = 5, 171 INVOKE_ID_SET_VIDEO_SCALING_MODE = 6, 172}; 173 174// Keep MEDIA_TRACK_TYPE_* in sync with MediaPlayer.java. 175enum media_track_type { 176 MEDIA_TRACK_TYPE_UNKNOWN = 0, 177 MEDIA_TRACK_TYPE_VIDEO = 1, 178 MEDIA_TRACK_TYPE_AUDIO = 2, 179 MEDIA_TRACK_TYPE_TIMEDTEXT = 3, 180 MEDIA_TRACK_TYPE_SUBTITLE = 4, 181}; 182 183// ---------------------------------------------------------------------------- 184// ref-counted object for callbacks 185class MediaPlayerListener: virtual public RefBase 186{ 187public: 188 virtual void notify(int msg, int ext1, int ext2, const Parcel *obj) = 0; 189}; 190 191class MediaPlayer : public BnMediaPlayerClient, 192 public virtual IMediaDeathNotifier 193{ 194public: 195 MediaPlayer(); 196 ~MediaPlayer(); 197 void died(); 198 void disconnect(); 199 200 status_t setDataSource( 201 const char *url, 202 const KeyedVector<String8, String8> *headers); 203 204 status_t setDataSource(int fd, int64_t offset, int64_t length); 205 status_t setDataSource(const sp<IStreamSource> &source); 206 status_t setVideoSurfaceTexture( 207 const sp<IGraphicBufferProducer>& bufferProducer); 208 status_t setListener(const sp<MediaPlayerListener>& listener); 209 status_t prepare(); 210 status_t prepareAsync(); 211 status_t start(); 212 status_t stop(); 213 status_t pause(); 214 bool isPlaying(); 215 status_t getVideoWidth(int *w); 216 status_t getVideoHeight(int *h); 217 status_t seekTo(int msec); 218 status_t getCurrentPosition(int *msec); 219 status_t getDuration(int *msec); 220 status_t reset(); 221 status_t setAudioStreamType(audio_stream_type_t type); 222 status_t setLooping(int loop); 223 bool isLooping(); 224 status_t setVolume(float leftVolume, float rightVolume); 225 void notify(int msg, int ext1, int ext2, const Parcel *obj = NULL); 226 static sp<IMemory> decode(const char* url, uint32_t *pSampleRate, int* pNumChannels, audio_format_t* pFormat); 227 static sp<IMemory> decode(int fd, int64_t offset, int64_t length, uint32_t *pSampleRate, int* pNumChannels, audio_format_t* pFormat); 228 status_t invoke(const Parcel& request, Parcel *reply); 229 status_t setMetadataFilter(const Parcel& filter); 230 status_t getMetadata(bool update_only, bool apply_filter, Parcel *metadata); 231 status_t setAudioSessionId(int sessionId); 232 int getAudioSessionId(); 233 status_t setAuxEffectSendLevel(float level); 234 status_t attachAuxEffect(int effectId); 235 status_t setParameter(int key, const Parcel& request); 236 status_t getParameter(int key, Parcel* reply); 237 status_t setRetransmitEndpoint(const char* addrString, uint16_t port); 238 status_t setNextMediaPlayer(const sp<MediaPlayer>& player); 239 240 status_t updateProxyConfig( 241 const char *host, int32_t port, const char *exclusionList); 242 243private: 244 void clear_l(); 245 status_t seekTo_l(int msec); 246 status_t prepareAsync_l(); 247 status_t getDuration_l(int *msec); 248 status_t attachNewPlayer(const sp<IMediaPlayer>& player); 249 status_t reset_l(); 250 status_t doSetRetransmitEndpoint(const sp<IMediaPlayer>& player); 251 252 sp<IMediaPlayer> mPlayer; 253 thread_id_t mLockThreadId; 254 Mutex mLock; 255 Mutex mNotifyLock; 256 Condition mSignal; 257 sp<MediaPlayerListener> mListener; 258 void* mCookie; 259 media_player_states mCurrentState; 260 int mCurrentPosition; 261 int mSeekPosition; 262 bool mPrepareSync; 263 status_t mPrepareStatus; 264 audio_stream_type_t mStreamType; 265 bool mLoop; 266 float mLeftVolume; 267 float mRightVolume; 268 int mVideoWidth; 269 int mVideoHeight; 270 int mAudioSessionId; 271 float mSendLevel; 272 struct sockaddr_in mRetransmitEndpoint; 273 bool mRetransmitEndpointValid; 274}; 275 276}; // namespace android 277 278#endif // ANDROID_MEDIAPLAYER_H 279