blob: 4c05fc37c8ce988af179a50c5e03428123121e52 [file] [log] [blame]
The Android Open Source Project89fa4ad2009-03-03 19:31:44 -08001/*
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
John Grossmanc795b642012-02-22 15:38:35 -080020#include <arpa/inet.h>
21
Mathias Agopian75624082009-05-19 19:08:10 -070022#include <binder/IMemory.h>
The Android Open Source Project89fa4ad2009-03-03 19:31:44 -080023#include <media/IMediaPlayerClient.h>
24#include <media/IMediaPlayer.h>
James Dongdd172fc2010-01-15 18:13:58 -080025#include <media/IMediaDeathNotifier.h>
Dave Burked681bbb2011-08-30 14:39:17 +010026#include <media/IStreamSource.h>
The Android Open Source Project89fa4ad2009-03-03 19:31:44 -080027
Andreas Huber2db84552010-01-28 11:19:57 -080028#include <utils/KeyedVector.h>
29#include <utils/String8.h>
30
Jamie Gennis61c7ef52011-07-13 12:59:34 -070031class ANativeWindow;
32
The Android Open Source Project89fa4ad2009-03-03 19:31:44 -080033namespace android {
34
Mathias Agopian3cf61352010-02-09 17:46:37 -080035class Surface;
Andy McFadden484566c2012-12-18 09:46:54 -080036class IGraphicBufferProducer;
Mathias Agopian3cf61352010-02-09 17:46:37 -080037
The Android Open Source Project89fa4ad2009-03-03 19:31:44 -080038enum 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,
Lajos Molnarcbaffcf2013-08-14 18:30:38 -070045 MEDIA_STARTED = 6,
46 MEDIA_PAUSED = 7,
47 MEDIA_STOPPED = 8,
Lajos Molnar6218fdc2013-09-25 08:09:41 -070048 MEDIA_SKIPPED = 9,
Gloria Wangb483c472011-04-11 17:23:27 -070049 MEDIA_TIMED_TEXT = 99,
The Android Open Source Project89fa4ad2009-03-03 19:31:44 -080050 MEDIA_ERROR = 100,
The Android Open Source Project65e731f2009-03-11 12:11:56 -070051 MEDIA_INFO = 200,
Chong Zhangdcb89b32013-08-06 09:44:47 -070052 MEDIA_SUBTITLE_DATA = 201,
The Android Open Source Project89fa4ad2009-03-03 19:31:44 -080053};
54
The Android Open Source Project65e731f2009-03-11 12:11:56 -070055// Generic error codes for the media player framework. Errors are fatal, the
56// playback must abort.
57//
58// Errors are communicated back to the client using the
59// MediaPlayerListener::notify method defined below.
60// In this situation, 'notify' is invoked with the following:
61// 'msg' is set to MEDIA_ERROR.
62// 'ext1' should be a value from the enum media_error_type.
63// 'ext2' contains an implementation dependant error code to provide
64// more details. Should default to 0 when not used.
65//
66// The codes are distributed as follow:
67// 0xx: Reserved
68// 1xx: Android Player errors. Something went wrong inside the MediaPlayer.
69// 2xx: Media errors (e.g Codec not supported). There is a problem with the
70// media itself.
71// 3xx: Runtime errors. Some extraordinary condition arose making the playback
72// impossible.
73//
74enum media_error_type {
75 // 0xx
76 MEDIA_ERROR_UNKNOWN = 1,
77 // 1xx
78 MEDIA_ERROR_SERVER_DIED = 100,
79 // 2xx
80 MEDIA_ERROR_NOT_VALID_FOR_PROGRESSIVE_PLAYBACK = 200,
81 // 3xx
82};
83
84
85// Info and warning codes for the media player framework. These are non fatal,
86// the playback is going on but there might be some user visible issues.
87//
88// Info and warning messages are communicated back to the client using the
89// MediaPlayerListener::notify method defined below. In this situation,
90// 'notify' is invoked with the following:
91// 'msg' is set to MEDIA_INFO.
92// 'ext1' should be a value from the enum media_info_type.
Ravi K Yenduri387eac42009-06-21 17:19:58 -050093// 'ext2' contains an implementation dependant info code to provide
The Android Open Source Project65e731f2009-03-11 12:11:56 -070094// more details. Should default to 0 when not used.
95//
96// The codes are distributed as follow:
97// 0xx: Reserved
98// 7xx: Android Player info/warning (e.g player lagging behind.)
99// 8xx: Media info/warning (e.g media badly interleaved.)
Nicolas Catania66095182009-06-11 16:33:49 -0700100//
The Android Open Source Project65e731f2009-03-11 12:11:56 -0700101enum media_info_type {
102 // 0xx
103 MEDIA_INFO_UNKNOWN = 1,
Marco Nelissen6b74d672012-02-28 16:07:44 -0800104 // The player was started because it was used as the next player for another
105 // player, which just completed playback
106 MEDIA_INFO_STARTED_AS_NEXT = 2,
James Dongc374dae2012-07-19 19:18:06 -0700107 // The player just pushed the very first video frame for rendering
108 MEDIA_INFO_RENDERING_START = 3,
The Android Open Source Project65e731f2009-03-11 12:11:56 -0700109 // 7xx
110 // The video is too complex for the decoder: it can't decode frames fast
111 // enough. Possibly only the audio plays fine at this stage.
112 MEDIA_INFO_VIDEO_TRACK_LAGGING = 700,
Andreas Huber0a5baa92010-06-10 11:17:50 -0700113 // MediaPlayer is temporarily pausing playback internally in order to
114 // buffer more data.
115 MEDIA_INFO_BUFFERING_START = 701,
116 // MediaPlayer is resuming playback after filling buffers.
117 MEDIA_INFO_BUFFERING_END = 702,
James Dong5b1b8a92011-05-25 19:37:03 -0700118 // Bandwidth in recent past
119 MEDIA_INFO_NETWORK_BANDWIDTH = 703,
120
The Android Open Source Project65e731f2009-03-11 12:11:56 -0700121 // 8xx
122 // Bad interleaving means that a media has been improperly interleaved or not
123 // interleaved at all, e.g has all the video samples first then all the audio
124 // ones. Video is playing but a lot of disk seek may be happening.
125 MEDIA_INFO_BAD_INTERLEAVING = 800,
126 // The media is not seekable (e.g live stream).
127 MEDIA_INFO_NOT_SEEKABLE = 801,
Nicolas Cataniaa7e0e8b2009-07-08 08:57:42 -0700128 // New media metadata is available.
129 MEDIA_INFO_METADATA_UPDATE = 802,
Insun Kangf9d660a2012-02-16 20:28:27 +0900130
131 //9xx
132 MEDIA_INFO_TIMED_TEXT_ERROR = 900,
The Android Open Source Project65e731f2009-03-11 12:11:56 -0700133};
134
135
The Android Open Source Project89fa4ad2009-03-03 19:31:44 -0800136
137enum media_player_states {
138 MEDIA_PLAYER_STATE_ERROR = 0,
139 MEDIA_PLAYER_IDLE = 1 << 0,
140 MEDIA_PLAYER_INITIALIZED = 1 << 1,
141 MEDIA_PLAYER_PREPARING = 1 << 2,
142 MEDIA_PLAYER_PREPARED = 1 << 3,
143 MEDIA_PLAYER_STARTED = 1 << 4,
144 MEDIA_PLAYER_PAUSED = 1 << 5,
145 MEDIA_PLAYER_STOPPED = 1 << 6,
146 MEDIA_PLAYER_PLAYBACK_COMPLETE = 1 << 7
147};
148
Glenn Kastencd25fed2011-07-25 09:26:22 -0700149// Keep KEY_PARAMETER_* in sync with MediaPlayer.java.
150// The same enum space is used for both set and get, in case there are future keys that
151// can be both set and get. But as of now, all parameters are either set only or get only.
152enum media_parameter_keys {
James Dong5b1b8a92011-05-25 19:37:03 -0700153 // Streaming/buffering parameters
Glenn Kastencd25fed2011-07-25 09:26:22 -0700154 KEY_PARAMETER_CACHE_STAT_COLLECT_FREQ_MS = 1100, // set only
155
156 // Return a Parcel containing a single int, which is the channel count of the
157 // audio track, or zero for error (e.g. no audio track) or unknown.
158 KEY_PARAMETER_AUDIO_CHANNEL_COUNT = 1200, // get only
159
Jean-Michel Trivi7a8b0ed2012-02-02 09:06:31 -0800160 // Playback rate expressed in permille (1000 is normal speed), saved as int32_t, with negative
161 // values used for rewinding or reverse playback.
162 KEY_PARAMETER_PLAYBACK_RATE_PERMILLE = 1300, // set only
Gloria Wang7a1e3e82011-05-03 15:59:03 -0700163};
Glenn Kastencd25fed2011-07-25 09:26:22 -0700164
Insun Kangf9d660a2012-02-16 20:28:27 +0900165// Keep INVOKE_ID_* in sync with MediaPlayer.java.
166enum media_player_invoke_ids {
167 INVOKE_ID_GET_TRACK_INFO = 1,
168 INVOKE_ID_ADD_EXTERNAL_SOURCE = 2,
169 INVOKE_ID_ADD_EXTERNAL_SOURCE_FD = 3,
170 INVOKE_ID_SELECT_TRACK = 4,
171 INVOKE_ID_UNSELECT_TRACK = 5,
James Dong4f6eed02012-04-30 14:38:12 -0700172 INVOKE_ID_SET_VIDEO_SCALING_MODE = 6,
Insun Kangf9d660a2012-02-16 20:28:27 +0900173};
174
175// Keep MEDIA_TRACK_TYPE_* in sync with MediaPlayer.java.
176enum media_track_type {
177 MEDIA_TRACK_TYPE_UNKNOWN = 0,
178 MEDIA_TRACK_TYPE_VIDEO = 1,
179 MEDIA_TRACK_TYPE_AUDIO = 2,
180 MEDIA_TRACK_TYPE_TIMEDTEXT = 3,
Chong Zhangdcb89b32013-08-06 09:44:47 -0700181 MEDIA_TRACK_TYPE_SUBTITLE = 4,
Insun Kangf9d660a2012-02-16 20:28:27 +0900182};
183
The Android Open Source Project89fa4ad2009-03-03 19:31:44 -0800184// ----------------------------------------------------------------------------
185// ref-counted object for callbacks
186class MediaPlayerListener: virtual public RefBase
187{
188public:
Gloria Wangb483c472011-04-11 17:23:27 -0700189 virtual void notify(int msg, int ext1, int ext2, const Parcel *obj) = 0;
The Android Open Source Project89fa4ad2009-03-03 19:31:44 -0800190};
191
James Dongdd172fc2010-01-15 18:13:58 -0800192class MediaPlayer : public BnMediaPlayerClient,
193 public virtual IMediaDeathNotifier
The Android Open Source Project89fa4ad2009-03-03 19:31:44 -0800194{
195public:
196 MediaPlayer();
197 ~MediaPlayer();
James Dongdd172fc2010-01-15 18:13:58 -0800198 void died();
The Android Open Source Project89fa4ad2009-03-03 19:31:44 -0800199 void disconnect();
Andreas Huber2db84552010-01-28 11:19:57 -0800200
201 status_t setDataSource(
202 const char *url,
203 const KeyedVector<String8, String8> *headers);
204
The Android Open Source Project89fa4ad2009-03-03 19:31:44 -0800205 status_t setDataSource(int fd, int64_t offset, int64_t length);
Dave Burked681bbb2011-08-30 14:39:17 +0100206 status_t setDataSource(const sp<IStreamSource> &source);
Glenn Kasten11731182011-02-08 17:26:17 -0800207 status_t setVideoSurfaceTexture(
Andy McFadden484566c2012-12-18 09:46:54 -0800208 const sp<IGraphicBufferProducer>& bufferProducer);
The Android Open Source Project89fa4ad2009-03-03 19:31:44 -0800209 status_t setListener(const sp<MediaPlayerListener>& listener);
210 status_t prepare();
211 status_t prepareAsync();
212 status_t start();
213 status_t stop();
214 status_t pause();
215 bool isPlaying();
216 status_t getVideoWidth(int *w);
217 status_t getVideoHeight(int *h);
218 status_t seekTo(int msec);
219 status_t getCurrentPosition(int *msec);
220 status_t getDuration(int *msec);
221 status_t reset();
Glenn Kastenfff6d712012-01-12 16:38:12 -0800222 status_t setAudioStreamType(audio_stream_type_t type);
The Android Open Source Project89fa4ad2009-03-03 19:31:44 -0800223 status_t setLooping(int loop);
224 bool isLooping();
225 status_t setVolume(float leftVolume, float rightVolume);
Gloria Wangb483c472011-04-11 17:23:27 -0700226 void notify(int msg, int ext1, int ext2, const Parcel *obj = NULL);
Eric Laurent3d00aa62013-09-24 09:53:27 -0700227 static status_t decode(const char* url, uint32_t *pSampleRate, int* pNumChannels,
228 audio_format_t* pFormat,
229 const sp<IMemoryHeap>& heap, size_t *pSize);
230 static status_t decode(int fd, int64_t offset, int64_t length, uint32_t *pSampleRate,
231 int* pNumChannels, audio_format_t* pFormat,
232 const sp<IMemoryHeap>& heap, size_t *pSize);
Nicolas Catania1d187f12009-05-12 23:25:55 -0700233 status_t invoke(const Parcel& request, Parcel *reply);
Nicolas Cataniaa7e0e8b2009-07-08 08:57:42 -0700234 status_t setMetadataFilter(const Parcel& filter);
Nicolas Catania8e1b6cc2009-07-09 09:21:33 -0700235 status_t getMetadata(bool update_only, bool apply_filter, Parcel *metadata);
Eric Laurenta514bdb2010-06-21 09:27:30 -0700236 status_t setAudioSessionId(int sessionId);
237 int getAudioSessionId();
Eric Laurent2beeb502010-07-16 07:43:46 -0700238 status_t setAuxEffectSendLevel(float level);
239 status_t attachAuxEffect(int effectId);
Gloria Wang4f9e47f2011-04-25 17:28:22 -0700240 status_t setParameter(int key, const Parcel& request);
241 status_t getParameter(int key, Parcel* reply);
John Grossmanc795b642012-02-22 15:38:35 -0800242 status_t setRetransmitEndpoint(const char* addrString, uint16_t port);
Marco Nelissen6b74d672012-02-28 16:07:44 -0800243 status_t setNextMediaPlayer(const sp<MediaPlayer>& player);
Gloria Wang4f9e47f2011-04-25 17:28:22 -0700244
Andreas Huberb7319a72013-05-29 14:20:52 -0700245 status_t updateProxyConfig(
246 const char *host, int32_t port, const char *exclusionList);
247
The Android Open Source Project89fa4ad2009-03-03 19:31:44 -0800248private:
249 void clear_l();
250 status_t seekTo_l(int msec);
251 status_t prepareAsync_l();
252 status_t getDuration_l(int *msec);
Dave Burked681bbb2011-08-30 14:39:17 +0100253 status_t attachNewPlayer(const sp<IMediaPlayer>& player);
Jamie Gennis61c7ef52011-07-13 12:59:34 -0700254 status_t reset_l();
John Grossmanc795b642012-02-22 15:38:35 -0800255 status_t doSetRetransmitEndpoint(const sp<IMediaPlayer>& player);
The Android Open Source Project89fa4ad2009-03-03 19:31:44 -0800256
The Android Open Source Project89fa4ad2009-03-03 19:31:44 -0800257 sp<IMediaPlayer> mPlayer;
Jason Sams1af452f2009-03-24 18:45:22 -0700258 thread_id_t mLockThreadId;
The Android Open Source Project89fa4ad2009-03-03 19:31:44 -0800259 Mutex mLock;
260 Mutex mNotifyLock;
261 Condition mSignal;
262 sp<MediaPlayerListener> mListener;
263 void* mCookie;
264 media_player_states mCurrentState;
The Android Open Source Project89fa4ad2009-03-03 19:31:44 -0800265 int mCurrentPosition;
266 int mSeekPosition;
267 bool mPrepareSync;
268 status_t mPrepareStatus;
Glenn Kastenfff6d712012-01-12 16:38:12 -0800269 audio_stream_type_t mStreamType;
The Android Open Source Project89fa4ad2009-03-03 19:31:44 -0800270 bool mLoop;
271 float mLeftVolume;
272 float mRightVolume;
273 int mVideoWidth;
274 int mVideoHeight;
Eric Laurenta514bdb2010-06-21 09:27:30 -0700275 int mAudioSessionId;
Eric Laurent2beeb502010-07-16 07:43:46 -0700276 float mSendLevel;
John Grossmanc795b642012-02-22 15:38:35 -0800277 struct sockaddr_in mRetransmitEndpoint;
278 bool mRetransmitEndpointValid;
The Android Open Source Project89fa4ad2009-03-03 19:31:44 -0800279};
280
281}; // namespace android
282
283#endif // ANDROID_MEDIAPLAYER_H