4 * Copyright (c) 2000 - 2011 Samsung Electronics Co., Ltd. All rights reserved.
6 * Contact: JongHyuk Choi <jhchoi.choi@samsung.com>, YeJin Cho <cho.yejin@samsung.com>, YoungHwan An <younghwan_.an@samsung.com>
8 * Licensed under the Apache License, Version 2.0 (the "License");
9 * you may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
22 #ifndef __MM_PLAYER_PRIV_H__
23 #define __MM_PLAYER_PRIV_H__
25 /*===========================================================================================
29 ========================================================================================== */
37 #include "mm_player.h"
38 #include "mm_player_internal.h"
39 #include "mm_player_audioeffect.h"
40 #include "mm_message.h"
41 #include "mm_player_utils.h"
42 #include "mm_player_asm.h"
43 #include "mm_player_pd.h"
44 #include "mm_player_streaming.h"
46 /*===========================================================================================
48 | GLOBAL DEFINITIONS AND DECLARATIONS FOR MODULE |
50 ========================================================================================== */
52 /*---------------------------------------------------------------------------
54 ---------------------------------------------------------------------------*/
56 #define MM_PLAYER_IMGB_MPLANE_MAX 4
57 #define MM_PLAYER_STREAM_COUNT_MAX 3
59 #define MM_PLAYER_CAST(x_player) ((mm_player_t *)(x_player))
61 * @x_player: MMHandleType of player
63 * Get the PD downloader of this player.
65 #define MM_PLAYER_GET_PD(x_player) (MM_PLAYER_CAST(x_player)->pd_downloader)
67 * @x_player: MMHandleType of player
69 * Get the attributes handle of this player.
71 #define MM_PLAYER_GET_ATTRS(x_player) (MM_PLAYER_CAST(x_player)->attrs)
73 /*---------------------------------------------------------------------------
74 | GLOBAL CONSTANT DEFINITIONS: |
75 ---------------------------------------------------------------------------*/
78 TAG_AUDIO_CODEC = 0x0001,
79 TAG_VIDEO_CODEC = 0x0002,
84 TAG_COPYRIGHT = 0x0040,
86 TAG_DESCRIPTION = 0x0100,
87 TAG_TRACK_NUMBER = 0x0200
90 enum content_attr_flag
92 ATTR_MISSING_ONLY = 0x0001,
93 ATTR_DURATION = 0x0002,
96 ATTR_BITRATE = 0x0010,
100 /* async mode makes trouble. alsasink sometimes fails to pause. */
109 * Enumerations of Player Mode
112 MM_PLAYER_MODE_NONE, /**< Player mode None */
113 MM_PLAYER_MODE_MIDI, /**< Player mode Midi */
114 MM_PLAYER_MODE_GST, /**< Player mode Gstreamer */
119 * Enumerations of Player Uri type
121 enum MMPlayerUriType {
122 MM_PLAYER_URI_TYPE_NONE, /**< Player URI type None */
123 MM_PLAYER_URI_TYPE_URL_RTSP, /**< Player URI type RTSP */
124 MM_PLAYER_URI_TYPE_URL_HTTP,/**< Player URI type HTTP */
125 MM_PLAYER_URI_TYPE_URL_MMS,/**< Player URI type MMS */
126 MM_PLAYER_URI_TYPE_MEM, /**< Player URI type Mem */
127 MM_PLAYER_URI_TYPE_FILE, /**< Player URI type File */
128 MM_PLAYER_URI_TYPE_URL, /**< Player URI type URL */
129 MM_PLAYER_URI_TYPE_BUFF, /**< Player URI type Buffer */
130 MM_PLAYER_URI_TYPE_HLS, /**< Player URI type http live streaming */
131 MM_PLAYER_URI_TYPE_TEMP, /**< Player URI type Temp */
134 typedef enum _MissingCodec
136 MISSING_PLUGIN_NONE = 0x00,
137 MISSING_PLUGIN_AUDIO = 0x01,
138 MISSING_PLUGIN_VIDEO = 0x02
142 typedef enum _FoundCodec
144 FOUND_PLUGIN_NONE = 0x00,
145 FOUND_PLUGIN_AUDIO = 0x01,
146 FOUND_PLUGIN_VIDEO = 0x02
149 /* main pipeline's element id */
152 MMPLAYER_M_PIPE = 0, /* NOTE : MMPLAYER_M_PIPE should be zero */
156 /* it could be a decodebin or could be a typefind. depends on player ini */
159 /* NOTE : we need two fakesink to autoplug without decodebin.
160 * first one will hold whole pipeline state. and second one will hold state of
161 * a sink-decodebin for an elementary stream. no metter if there's more then one
162 * elementary streams because MSL reuse it.
164 MMPLAYER_M_SRC_FAKESINK,
165 MMPLAYER_M_SRC_2ND_FAKESINK,
167 /* streaming plugin */
172 /* FIXIT : if there's really no usage for following IDs. remove it */
182 /* audio pipeline's element id */
185 MMPLAYER_A_BIN = 0, /* NOTE : MMPLAYER_A_BIN should be zero */
190 MMPLAYER_A_CAPS_DEFAULT,
192 MMPLAYER_A_RESAMPLER,
196 /* video pipeline's element id */
199 MMPLAYER_V_BIN = 0, /* NOTE : MMPLAYER_V_BIN should be zero */
208 /* text pipeline's element id */
211 MMPLAYER_T_BIN = 0, /* NOTE : MMPLAYER_V_BIN should be zero */
212 MMPLAYER_T_TEXT_QUEUE,
213 MMPLAYER_T_VIDEO_QUEUE,
214 MMPLAYER_T_VIDEO_CONVERTER,
220 /* midi main pipeline's element id */
224 MMPLAYER_MIDI_PLAYER,
228 enum PlayerCommandState
230 MMPLAYER_COMMAND_NONE,
231 MMPLAYER_COMMAND_CREATE,
232 MMPLAYER_COMMAND_DESTROY,
233 MMPLAYER_COMMAND_UNREALIZE,
234 MMPLAYER_COMMAND_START,
235 MMPLAYER_COMMAND_REALIZE,
236 MMPLAYER_COMMAND_STOP,
237 MMPLAYER_COMMAND_PAUSE,
238 MMPLAYER_COMMAND_RESUME,
242 /* Note : StreamingSrcError is error enum for streaming source which post error message
243 * using custom message made by itself. The enum value must start with zero,
244 * because the streaming source(secrtspsrc) also does.
246 enum StreamingSrcError
248 MMPLAYER_STREAMING_ERROR_NONE = 0,
249 MMPLAYER_STREAMING_ERROR_UNSUPPORTED_AUDIO,
250 MMPLAYER_STREAMING_ERROR_UNSUPPORTED_VIDEO,
251 MMPLAYER_STREAMING_ERROR_CONNECTION_FAIL,
252 MMPLAYER_STREAMING_ERROR_DNS_FAIL,
253 MMPLAYER_STREAMING_ERROR_SERVER_DISCONNECTED,
254 MMPLAYER_STREAMING_ERROR_BAD_SERVER,
255 MMPLAYER_STREAMING_ERROR_INVALID_PROTOCOL,
256 MMPLAYER_STREAMING_ERROR_INVALID_URL,
257 MMPLAYER_STREAMING_ERROR_UNEXPECTED_MSG,
258 MMPLAYER_STREAMING_ERROR_OUT_OF_MEMORIES,
259 MMPLAYER_STREAMING_ERROR_RTSP_TIMEOUT,
260 MMPLAYER_STREAMING_ERROR_BAD_REQUEST,
261 MMPLAYER_STREAMING_ERROR_NOT_AUTHORIZED,
262 MMPLAYER_STREAMING_ERROR_PAYMENT_REQUIRED,
263 MMPLAYER_STREAMING_ERROR_FORBIDDEN,
264 MMPLAYER_STREAMING_ERROR_CONTENT_NOT_FOUND,
265 MMPLAYER_STREAMING_ERROR_METHOD_NOT_ALLOWED,
266 MMPLAYER_STREAMING_ERROR_NOT_ACCEPTABLE,
267 MMPLAYER_STREAMING_ERROR_PROXY_AUTHENTICATION_REQUIRED,
268 MMPLAYER_STREAMING_ERROR_SERVER_TIMEOUT,
269 MMPLAYER_STREAMING_ERROR_GONE,
270 MMPLAYER_STREAMING_ERROR_LENGTH_REQUIRED,
271 MMPLAYER_STREAMING_ERROR_PRECONDITION_FAILED,
272 MMPLAYER_STREAMING_ERROR_REQUEST_ENTITY_TOO_LARGE,
273 MMPLAYER_STREAMING_ERROR_REQUEST_URI_TOO_LARGE,
274 MMPLAYER_STREAMING_ERROR_UNSUPPORTED_MEDIA_TYPE,
275 MMPLAYER_STREAMING_ERROR_PARAMETER_NOT_UNDERSTOOD,
276 MMPLAYER_STREAMING_ERROR_CONFERENCE_NOT_FOUND,
277 MMPLAYER_STREAMING_ERROR_NOT_ENOUGH_BANDWIDTH,
278 MMPLAYER_STREAMING_ERROR_NO_SESSION_ID,
279 MMPLAYER_STREAMING_ERROR_METHOD_NOT_VALID_IN_THIS_STATE,
280 MMPLAYER_STREAMING_ERROR_HEADER_FIELD_NOT_VALID_FOR_SOURCE,
281 MMPLAYER_STREAMING_ERROR_INVALID_RANGE,
282 MMPLAYER_STREAMING_ERROR_PARAMETER_IS_READONLY,
283 MMPLAYER_STREAMING_ERROR_AGGREGATE_OP_NOT_ALLOWED,
284 MMPLAYER_STREAMING_ERROR_ONLY_AGGREGATE_OP_ALLOWED,
285 MMPLAYER_STREAMING_ERROR_BAD_TRANSPORT,
286 MMPLAYER_STREAMING_ERROR_DESTINATION_UNREACHABLE,
287 MMPLAYER_STREAMING_ERROR_INTERNAL_SERVER_ERROR,
288 MMPLAYER_STREAMING_ERROR_NOT_IMPLEMENTED,
289 MMPLAYER_STREAMING_ERROR_BAD_GATEWAY,
290 MMPLAYER_STREAMING_ERROR_SERVICE_UNAVAILABLE,
291 MMPLAYER_STREAMING_ERROR_GATEWAY_TIME_OUT ,
292 MMPLAYER_STREAMING_ERROR_RTSP_VERSION_NOT_SUPPORTED,
293 MMPLAYER_STREAMING_ERROR_OPTION_NOT_SUPPORTED,
297 /*---------------------------------------------------------------------------
298 | GLOBAL DATA TYPE DEFINITIONS: |
299 ---------------------------------------------------------------------------*/
305 } MMPlayerGstElement;
309 GstTagList *tag_list;
310 MMPlayerGstElement *mainbin;
311 MMPlayerGstElement *audiobin;
312 MMPlayerGstElement *videobin;
313 MMPlayerGstElement *textbin;
314 } MMPlayerGstPipelineInfo;
318 char device[MAX_SOUND_DEVICE_LEN];
321 int bluetooth; /* enable/disable */
329 } tBuffer; /* FIXIT : choose better name */
336 char uri[MM_MAX_URL_LEN];
337 char urgent[MM_MAX_FILENAME_LEN];
338 } MMPlayerParseProfile;
342 MMPlayerPosFormatType format;
344 }MMPlayerPendingSeek;
349 } MMPlayerSignalItem;
351 /* image buffer definition ***************************************************
353 +------------------------------------------+ ---
356 | +---------------------------+ --- | |
358 | |<---------- w[] ---------->| | | |
366 | +---------------------------+ --- | |
368 +------------------------------------------+ ---
370 |<----------------- s[] ------------------>|
374 /* width of each image plane */
375 int w[MM_PLAYER_IMGB_MPLANE_MAX];
376 /* height of each image plane */
377 int h[MM_PLAYER_IMGB_MPLANE_MAX];
378 /* stride of each image plane */
379 int s[MM_PLAYER_IMGB_MPLANE_MAX];
380 /* elevation of each image plane */
381 int e[MM_PLAYER_IMGB_MPLANE_MAX];
382 /* user space address of each image plane */
383 void *a[MM_PLAYER_IMGB_MPLANE_MAX];
384 /* physical address of each image plane, if needs */
385 void *p[MM_PLAYER_IMGB_MPLANE_MAX];
386 /* color space type of image */
388 /* left postion, if needs */
390 /* top position, if needs */
392 /* to align memory */
398 int fd[MM_PLAYER_IMGB_MPLANE_MAX];
400 /* flag for buffer share */
401 int buf_share_method;
403 /*y, cbcr size for bookmark */
406 } MMPlayerMPlaneImage;
410 int state; // player current state
411 int prev_state; // player previous state
412 int pending_state; // player state which is going to now
413 int target_state; // player state which user want to go to
414 guint state_change_timeout;
416 gboolean section_repeat;
417 gint section_repeat_start;
418 gint section_repeat_end;
427 /* repeat thread lock */
428 GCond* repeat_thread_cond;
429 GMutex* repeat_thread_mutex;
430 GThread* repeat_thread;
431 gboolean repeat_thread_exit;
434 GThread* capture_thread;
435 gboolean capture_thread_exit;
436 GCond* capture_thread_cond;
437 GMutex* capture_thread_mutex;
438 MMPlayerVideoCapture capture;
439 MMPlayerVideoColorspace video_cs;
440 MMPlayerMPlaneImage captured;
442 /* fakesink handling lock */
445 /* player attributes */
448 /* message callback */
449 MMMessageCallback msg_cb;
453 /* progressive download */
454 mm_player_pd_t *pd_downloader;
455 gchar *pd_file_save_path;
456 MMPlayerPDMode pd_mode;
458 /* streaming player */
459 mm_player_streaming_t *streamer;
461 /* gstreamer pipeline */
462 MMPlayerGstPipelineInfo *pipeline;
463 gboolean pipeline_is_constructed;
465 /* buffering support cbs*/
466 mm_player_buffer_need_data_callback need_data_cb;
467 mm_player_buffer_enough_data_callback enough_data_cb;
468 mm_player_buffer_seek_data_callback seek_data_cb;
470 void* buffer_cb_user_param;
472 /* video stream callback */
473 mm_player_video_stream_callback video_stream_cb;
474 void* video_stream_cb_user_param;
475 int use_video_stream;
477 /* audio stram callback */
478 mm_player_audio_stream_callback audio_stream_cb;
479 void* audio_stream_cb_user_param;
481 /* audio buffer callback */
482 mm_player_audio_stream_callback audio_buffer_cb;
483 void* audio_buffer_cb_user_param;
485 /* video capture callback*/
486 gulong video_capture_cb_probe_id;
488 /* video frame render error callback */
489 mm_player_video_frame_render_error_callback video_frame_render_error_cb;
490 void* video_frame_render_error_cb_user_param;
493 MMPlayerSoundInfo sound;
498 /* video stream caps parsed by demuxer */
499 GstCaps* v_stream_caps;
501 /* audio effect infomation */
502 MMAudioEffectInfo audio_effect_info;
503 gboolean bypass_audio_effect;
505 gulong audio_cb_probe_id;
510 /* content profile */
511 MMPlayerParseProfile profile;
513 /* streaming service type */
514 MMStreamingType streaming_type;
518 gboolean have_dynamic_pad;
519 GList* parsers; // list of linked parser name
520 gboolean no_more_pad;
521 gint num_dynamic_pad;
522 gboolean has_many_types;
524 /* progress callback timer */
525 /* FIXIT : since duplicated functionality with get_position
526 * this function will be deprecated after fixing all application
527 * which are using it.
529 guint progress_timer;
531 /* timer for sending delayed EOS */
534 /* last point (msec) that player is paused or seeking */
535 gint64 last_position;
540 /* data size of http streaming */
541 guint64 http_content_size;
544 gchar last_error_msg[1024]; /* FIXIT : should it be dynamic ? */
546 gint videodec_linked;
547 gint audiodec_linked;
548 gint videosink_linked;
549 gint audiosink_linked;
550 gint textsink_linked;
552 /* missing plugin during autoplugging */
553 MissingCodec not_supported_codec;
555 /*unlinked audio/video mime type */
556 gchar *unlinked_video_mime;
557 gchar *unlinked_audio_mime;
558 gchar *unlinked_demuxer_mime;
560 /* found codec during autoplugging */
561 FoundCodec can_support_codec;
563 gboolean not_found_demuxer;
565 /* support seek even though player is not start */
566 MMPlayerPendingSeek pending_seek;
570 /* prevent to post msg over and over */
573 /* list of sink elements */
574 GList* sink_elements;
576 /* signal notifiers */
580 /* NOTE : if sink elements receive flush start event then it's state will be lost.
581 * this can happen when doing buffering in streaming pipeline since all control operation
582 * (play/pause/resume/seek) is requiring server interaction. during 'state lost' situation
583 * _set_state will not work correctely and state transition message will not posted to our
585 * So. we need to do some special care on the situation.
589 gboolean is_sound_extraction;
591 gdouble playback_rate;
593 /* player state resumed by fast rewind */
594 gboolean resumed_by_rewind;
596 gboolean is_nv12_tiled;
600 gboolean is_subtitle_off;
602 /* contents bitrate for buffering management */
603 guint bitrate[MM_PLAYER_STREAM_COUNT_MAX];
605 guint updated_bitrate_count;
606 guint maximum_bitrate[MM_PLAYER_STREAM_COUNT_MAX];
607 guint total_maximum_bitrate;
608 guint updated_maximum_bitrate_count;
610 /* prevent it from posting duplicatly*/
613 /* timeout source for lazy pause */
614 guint lazy_pause_event_id;
616 gboolean keep_detecting_vcodec;
618 gboolean play_subtitle;
619 gboolean use_textoverlay;
621 /* PD downloader message callback and param */
622 MMMessageCallback pd_msg_cb;
623 void* pd_msg_cb_param;
626 /*===========================================================================================
628 | GLOBAL FUNCTION PROTOTYPES |
630 ========================================================================================== */
635 int _mmplayer_create_player(MMHandleType hplayer);
636 int _mmplayer_destroy(MMHandleType hplayer);
637 int _mmplayer_realize(MMHandleType hplayer);
638 int _mmplayer_unrealize(MMHandleType hplayer);
639 int _mmplayer_get_state(MMHandleType hplayer, int* pstate);
640 int _mmplayer_set_volume(MMHandleType hplayer, MMPlayerVolumeType volume);
641 int _mmplayer_get_volume(MMHandleType hplayer, MMPlayerVolumeType *volume);
642 int _mmplayer_set_mute(MMHandleType hplayer, int mute);
643 int _mmplayer_get_mute(MMHandleType hplayer, int* pmute);
644 int _mmplayer_start(MMHandleType hplayer);
645 int _mmplayer_stop(MMHandleType hplayer);
646 int _mmplayer_pause(MMHandleType hplayer);
647 int _mmplayer_resume(MMHandleType hplayer);
648 int _mmplayer_set_position(MMHandleType hplayer, int format, int pos);
649 int _mmplayer_get_position(MMHandleType hplayer, int format, unsigned long *pos);
650 int _mmplayer_adjust_subtitle_postion(MMHandleType hplayer, int format, int pos);
651 int _mmplayer_activate_section_repeat(MMHandleType hplayer, unsigned long start, unsigned long end);
652 int _mmplayer_deactivate_section_repeat(MMHandleType hplayer);
653 int _mmplayer_push_buffer(MMHandleType hplayer, unsigned char *buf, int size);
654 int _mmplayer_set_buffer_need_data_cb(MMHandleType hplayer,mm_player_buffer_need_data_callback callback, void *user_param);
655 int _mmplayer_set_buffer_enough_data_cb(MMHandleType hplayer,mm_player_buffer_enough_data_callback callback, void *user_param);
656 int _mmplayer_set_buffer_seek_data_cb(MMHandleType hplayer,mm_player_buffer_seek_data_callback callback, void *user_param);
657 int _mmplayer_set_playspeed(MMHandleType hplayer, gdouble rate);
658 int _mmplayer_set_message_callback(MMHandleType hplayer, MMMessageCallback callback, void *user_param);
659 int _mmplayer_set_videostream_cb(MMHandleType hplayer,mm_player_video_stream_callback callback, void *user_param);
660 int _mmplayer_set_audiostream_cb(MMHandleType hplayer,mm_player_audio_stream_callback callback, void *user_param);
661 int _mmplayer_set_videoframe_render_error_cb(MMHandleType hplayer, mm_player_video_frame_render_error_callback callback, void *user_param);
662 int _mmplayer_set_subtitle_silent (MMHandleType hplayer, int silent);
663 int _mmplayer_get_subtitle_silent (MMHandleType hplayer, int* silent);
664 int _mmplayer_get_track_count(MMHandleType hplayer, MMPlayerTrackType track_type, int *count);
665 int _mmplayer_get_buffer_position(MMHandleType hplayer, int format, unsigned long* start_pos, unsigned long* stop_pos);
666 /* test API for tuning audio gain. this API should be
667 * deprecated before the day of final release
669 int _mmplayer_set_volume_tune(MMHandleType hplayer, MMPlayerVolumeType volume);
670 int _mmplayer_update_video_param(mm_player_t* player);
671 int _mmplayer_set_audiobuffer_cb(MMHandleType hplayer, mm_player_audio_stream_callback callback, void *user_param);
672 int _mmplayer_audio_effect_preset_apply(mm_player_t *player, MMAudioEffectPresetType effect_type);
673 int _mmplayer_audio_effect_custom_apply(mm_player_t *player);
679 #endif /* __MM_PLAYER_PRIV_H__ */