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