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