src/include/mm_player_utils.h

   1 /*
   2  * libmm-player
   3  *
   4  * Copyright (c) 2000 - 2011 Samsung Electronics Co., Ltd. All rights reserved.
   5  *
   6  * Contact: JongHyuk Choi <jhchoi.choi@samsung.com>, YeJin Cho <cho.yejin@samsung.com>,
   7  * Seungbae Shin <seungbae.shin@samsung.com>, YoungHwan An <younghwan_.an@samsung.com>
   8  *
   9  * Licensed under the Apache License, Version 2.0 (the "License");
  10  * you may not use this file except in compliance with the License.
  11  * You may obtain a copy of the License at
  12  *
  13  * http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  * Unless required by applicable law or agreed to in writing, software
  16  * distributed under the License is distributed on an "AS IS" BASIS,
  17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  * See the License for the specific language governing permissions and
  19  * limitations under the License.
  20  *
  21  */
  22
  23 #ifndef __MM_PLAYER_UTILS_H__
  24 #define __MM_PLAYER_UTILS_H__
  25 #include <limits.h>
  26 #include <glib.h>
  27 #include <gst/gst.h>
  28 #include <dlog.h>
  29 #include <mm_player_ini.h>
  30 #include <mm_types.h>
  31 #include <mm_error.h>
  32 #include <mm_message.h>
  33 #include "mm_player_priv.h"
  34
  35 #ifdef __cplusplus
  36         extern "C" {
  37 #endif
  38
  39 #ifdef LOG_TAG
  40 #undef LOG_TAG
  41 #endif
  42 #define LOG_TAG "MM_PLAYER"
  43
  44 /* general */
  45 #ifndef ARRAY_SIZE
  46 #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]))
  47 #endif
  48
  49 #define MMPLAYER_MIN_INT (INT_MIN)
  50 #define MMPLAYER_MAX_INT (INT_MAX)
  51
  52 #define MMPLAYER_FREEIF(x) \
  53         do {    \
  54                 g_clear_pointer(&x, g_free); \
  55         } while (0)
  56
  57 #define MMPLAYER_GET_ATTRS(x_player) ((mmplayer_t *)x_player)->attrs
  58
  59 /* command */
  60 #define MMPLAYER_CMD_LOCK_INIT(x_player)                     _mmplayer_cmd_lock_init((mmplayer_t *)x_player)
  61 #define MMPLAYER_CMD_LOCK(x_player)                          _mmplayer_cmd_lock((mmplayer_t *)x_player)
  62 #define MMPLAYER_CMD_TRYLOCK(x_player)                       _mmplayer_cmd_trylock((mmplayer_t *)x_player)
  63 #define MMPLAYER_CMD_UNLOCK(x_player)                        _mmplayer_cmd_unlock((mmplayer_t *)x_player)
  64 #define MMPLAYER_CMD_LOCK_DEINIT(x_player)                   _mmplayer_cmd_lock_deinit((mmplayer_t *)x_player)
  65
  66 /* pipeline reconfigure */
  67 #define MMPLAYER_RECONFIGURE_LOCK(x_player)                  g_mutex_lock(&((mmplayer_t *)x_player)->reconfigure_lock)
  68 #define MMPLAYER_RECONFIGURE_UNLOCK(x_player)                g_mutex_unlock(&((mmplayer_t *)x_player)->reconfigure_lock)
  69 #define MMPLAYER_RECONFIGURE_WAIT(x_player)                  g_cond_wait(&((mmplayer_t *)x_player)->reconfigure_cond, &((mmplayer_t *)x_player)->reconfigure_lock)
  70 #define MMPLAYER_RECONFIGURE_SIGNAL(x_player)                g_cond_signal(&((mmplayer_t *)x_player)->reconfigure_cond);
  71
  72 /* capture thread */
  73 #define MMPLAYER_CAPTURE_THREAD_LOCK(x_player)               g_mutex_lock(&((mmplayer_t *)x_player)->capture_thread_mutex)
  74 #define MMPLAYER_CAPTURE_THREAD_UNLOCK(x_player)             g_mutex_unlock(&((mmplayer_t *)x_player)->capture_thread_mutex)
  75 #define MMPLAYER_CAPTURE_THREAD_WAIT(x_player)               g_cond_wait(&((mmplayer_t *)x_player)->capture_thread_cond, &((mmplayer_t *)x_player)->capture_thread_mutex)
  76 #define MMPLAYER_CAPTURE_THREAD_SIGNAL(x_player)             g_cond_signal(&((mmplayer_t *)x_player)->capture_thread_cond);
  77
  78 /* gapless play thread */
  79 #define MMPLAYER_GAPLESS_PLAY_THREAD_LOCK(x_player)             g_mutex_lock(&((mmplayer_t *)x_player)->gapless_play_thread_mutex)
  80 #define MMPLAYER_GAPLESS_PLAY_THREAD_UNLOCK(x_player)           g_mutex_unlock(&((mmplayer_t *)x_player)->gapless_play_thread_mutex)
  81 #define MMPLAYER_GAPLESS_PLAY_THREAD_WAIT(x_player)             g_cond_wait(&((mmplayer_t *)x_player)->gapless_play_thread_cond, &((mmplayer_t *)x_player)->gapless_play_thread_mutex)
  82 #define MMPLAYER_GAPLESS_PLAY_THREAD_SIGNAL(x_player)           g_cond_signal(&((mmplayer_t *)x_player)->gapless_play_thread_cond);
  83
  84 /* gst bus msg thread */
  85 #define MMPLAYER_BUS_MSG_THREAD_LOCK(x_player)                   g_mutex_lock(&((mmplayer_t *)x_player)->bus_msg_thread_mutex)
  86 #define MMPLAYER_BUS_MSG_THREAD_UNLOCK(x_player)                 g_mutex_unlock(&((mmplayer_t *)x_player)->bus_msg_thread_mutex)
  87 #define MMPLAYER_BUS_MSG_THREAD_WAIT(x_player)                   g_cond_wait(&((mmplayer_t *)x_player)->bus_msg_thread_cond, &((mmplayer_t *)x_player)->bus_msg_thread_mutex)
  88 #define MMPLAYER_BUS_MSG_THREAD_WAIT_UNTIL(x_player, end_time)   g_cond_wait_until(&((mmplayer_t *)x_player)->bus_msg_thread_cond, &((mmplayer_t *)x_player)->bus_msg_thread_mutex, end_time)
  89 #define MMPLAYER_BUS_MSG_THREAD_SIGNAL(x_player)                 g_cond_signal(&((mmplayer_t *)x_player)->bus_msg_thread_cond);
  90
  91 /* gst bus watcher thread */
  92 #define MMPLAYER_BUS_WATCHER_LOCK(x_player)                   g_mutex_lock(&((mmplayer_t *)x_player)->bus_watcher_mutex)
  93 #define MMPLAYER_BUS_WATCHER_UNLOCK(x_player)                 g_mutex_unlock(&((mmplayer_t *)x_player)->bus_watcher_mutex)
  94 #define MMPLAYER_BUS_WATCHER_WAIT_UNTIL(x_player, end_time)   g_cond_wait_until(&((mmplayer_t *)x_player)->bus_watcher_cond, &((mmplayer_t *)x_player)->bus_watcher_mutex, end_time)
  95 #define MMPLAYER_BUS_WATCHER_SIGNAL(x_player)                 g_cond_signal(&((mmplayer_t *)x_player)->bus_watcher_cond);
  96
  97 /* handling fakesink */
  98 #define MMPLAYER_FSINK_LOCK(x_player)                        g_mutex_lock(&((mmplayer_t *)x_player)->fsink_lock)
  99 #define MMPLAYER_FSINK_UNLOCK(x_player)                      g_mutex_unlock(&((mmplayer_t *)x_player)->fsink_lock)
 100
 101 /* handling update tag */
 102 #define MMPLAYER_UPDATE_TAG_LOCK(x_player)                   g_mutex_lock(&((mmplayer_t *)x_player)->update_tag_lock)
 103 #define MMPLAYER_UPDATE_TAG_UNLOCK(x_player)                 g_mutex_unlock(&((mmplayer_t *)x_player)->update_tag_lock)
 104
 105 /* video stream bo */
 106 #define MMPLAYER_VIDEO_BO_LOCK(x_player)                     g_mutex_lock(&((mmplayer_t *)x_player)->video_bo_mutex)
 107 #define MMPLAYER_VIDEO_BO_UNLOCK(x_player)                   g_mutex_unlock(&((mmplayer_t *)x_player)->video_bo_mutex)
 108 #define MMPLAYER_VIDEO_BO_WAIT(x_player)                     g_cond_wait(&((mmplayer_t *)x_player)->video_bo_cond, &((mmplayer_t *)x_player)->video_bo_mutex)
 109 #define MMPLAYER_VIDEO_BO_WAIT_UNTIL(x_player, end_time)     g_cond_wait_until(&((mmplayer_t *)x_player)->video_bo_cond, &((mmplayer_t *)x_player)->video_bo_mutex, end_time)
 110 #define MMPLAYER_VIDEO_BO_SIGNAL(x_player)                   g_cond_signal(&((mmplayer_t *)x_player)->video_bo_cond);
 111
 112 /* subtitle info */
 113 #define MMPLAYER_SUBTITLE_INFO_LOCK(x_player)                     g_mutex_lock(&((mmplayer_t *)x_player)->subtitle_info_mutex)
 114 #define MMPLAYER_SUBTITLE_INFO_UNLOCK(x_player)                   g_mutex_unlock(&((mmplayer_t *)x_player)->subtitle_info_mutex)
 115 #define MMPLAYER_SUBTITLE_INFO_WAIT(x_player)                     g_cond_wait(&((mmplayer_t *)x_player)->subtitle_info_cond, &((mmplayer_t *)x_player)->subtitle_info_mutex)
 116 #define MMPLAYER_SUBTITLE_INFO_WAIT_UNTIL(x_player, end_time)     g_cond_wait_until(&((mmplayer_t *)x_player)->subtitle_info_cond, &((mmplayer_t *)x_player)->subtitle_info_mutex, end_time)
 117 #define MMPLAYER_SUBTITLE_INFO_SIGNAL(x_player)                   g_cond_signal(&((mmplayer_t *)x_player)->subtitle_info_cond);
 118
 119 #if 0
 120 #define MMPLAYER_FENTER();                                      LOGD("<ENTER>");
 121 #define MMPLAYER_FLEAVE();                                      LOGD("<LEAVE>");
 122 #else
 123 #define MMPLAYER_FENTER();
 124 #define MMPLAYER_FLEAVE();
 125 #endif
 126
 127 #define MMPLAYER_RETURN_IF_FAIL(expr) \
 128         do { \
 129                 if (!(expr)) { \
 130                         LOGW("failed [%s]", #expr); \
 131                         return; \
 132                 } \
 133         } while (0)
 134
 135 #define MMPLAYER_RETURN_VAL_IF_FAIL(expr, var) \
 136         do { \
 137                 if (!(expr)) { \
 138                         LOGW("failed [%s]", #expr); \
 139                         return (var); \
 140                 } \
 141         } while (0)
 142
 143 /* debug caps string */
 144 #define MMPLAYER_LOG_GST_CAPS_TYPE(x_caps) \
 145         do { \
 146                 gchar *caps_type = NULL; \
 147                 if (x_caps) { \
 148                         caps_type = gst_caps_to_string(x_caps); \
 149                         LOGD("caps: %s", caps_type); \
 150                         MMPLAYER_FREEIF(caps_type); \
 151                 } else {\
 152                         LOGW("caps is null"); \
 153                 } \
 154         } while (0)
 155
 156 /* message posting */
 157 #define MMPLAYER_POST_MSG(x_player, x_msgtype, x_msg_param) \
 158         do { \
 159                 LOGD("[handle: %p] posting %s to application", x_player, #x_msgtype); \
 160                 _mmplayer_post_message(x_player, x_msgtype, x_msg_param); \
 161         } while (0)
 162
 163 /* setting player state */
 164 #define MMPLAYER_SET_STATE(x_player, x_state) \
 165         do { \
 166                 LOGD("[handle: %p] update state machine to %d", x_player, x_state); \
 167                 _mmplayer_set_state(x_player, x_state); \
 168         } while (0)
 169
 170 #define MMPLAYER_CHECK_STATE(x_player, x_command) \
 171         do {    \
 172                 LOGD("[handle: %p] checking player state before doing %s", x_player, #x_command); \
 173                 switch (_mmplayer_check_state(x_player, x_command)) { \
 174                 case MM_ERROR_PLAYER_INVALID_STATE: \
 175                         return MM_ERROR_PLAYER_INVALID_STATE; \
 176                         break; \
 177                         /* NOTE : for robustness of player. we won't treat it as an error */ \
 178                 case MM_ERROR_PLAYER_NO_OP: \
 179                         return MM_ERROR_NONE; \
 180                         break; \
 181                 case MM_ERROR_PLAYER_DOING_SEEK: \
 182                         return MM_ERROR_PLAYER_DOING_SEEK; \
 183                 default: \
 184                         break; \
 185                 }       \
 186         } while (0)
 187
 188 /* setting element state */
 189 #define MMPLAYER_ELEMENT_SET_STATE(x_element, x_state) \
 190         do {    \
 191                 LOGD("setting state [%s:%d] to [%s]", #x_state, x_state, GST_ELEMENT_NAME(x_element)); \
 192                 if (GST_STATE_CHANGE_FAILURE == gst_element_set_state(x_element, x_state)) { \
 193                         LOGE("failed to set state %s to %s", #x_state, GST_ELEMENT_NAME(x_element)); \
 194                         goto STATE_CHANGE_FAILED; \
 195                 }       \
 196         } while (0)
 197
 198 #define MMPLAYER_CHECK_NULL(x_var) \
 199         do { \
 200                 if (!x_var) { \
 201                         LOGE("[%s] is NULL", #x_var); \
 202                         goto ERROR; \
 203                 } \
 204         } while (0)
 205
 206 /* generating dot */
 207 #define MMPLAYER_GENERATE_DOT_IF_ENABLED(x_player, x_name) \
 208         do { \
 209                 if (x_player->ini.generate_dot) { \
 210                         GST_DEBUG_BIN_TO_DOT_FILE_WITH_TS(GST_BIN(player->pipeline->mainbin[MMPLAYER_M_PIPE].gst), \
 211                         GST_DEBUG_GRAPH_SHOW_ALL, x_name); \
 212                 } \
 213         } while (0)
 214
 215 /* signal manipulation */
 216 #define MMPLAYER_SIGNAL_CONNECT(x_player, x_object, x_type, x_signal, x_callback, x_arg) \
 217         do { \
 218                 mmplayer_signal_item_t *item = NULL; \
 219                 item = (mmplayer_signal_item_t *)g_malloc(sizeof(mmplayer_signal_item_t)); \
 220                 if (!item) { \
 221                         LOGE("cannot connect signal [%s]", x_signal); \
 222                 } else { \
 223                         item->obj = G_OBJECT(x_object); \
 224                         item->sig = g_signal_connect(G_OBJECT(x_object), x_signal, \
 225                                                 x_callback, x_arg); \
 226                         if ((x_type >= MM_PLAYER_SIGNAL_TYPE_AUTOPLUG) && (x_type < MM_PLAYER_SIGNAL_TYPE_MAX)) \
 227                                 x_player->signals[x_type] = g_list_append(x_player->signals[x_type], item); \
 228                         else \
 229                                 LOGE("wrong signal type [%d]", x_type); \
 230                 } \
 231         } while (0)
 232
 233 /* create element */
 234 #define MMPLAYER_CREATE_ELEMENT(x_bin, x_id, x_factory, x_name, x_bucket, x_player) \
 235         do {\
 236                 x_bin[x_id].id = x_id;\
 237                 x_bin[x_id].gst = gst_element_factory_make(x_factory, x_name);\
 238                 if (!x_bin[x_id].gst) {\
 239                         LOGE("failed to create %s", x_factory);\
 240                         goto ERROR;\
 241                 } else {\
 242                         if (x_player->ini.set_dump_element_flag)\
 243                                 __mmplayer_add_dump_buffer_probe(x_player, x_bin[x_id].gst);\
 244                 } \
 245                 x_bucket = g_list_append(x_bucket, &x_bin[x_id]);\
 246         } while (0);
 247
 248 /* release element resource */
 249 #define MMPLAYER_RELEASE_ELEMENT(x_player, x_bin, x_id) \
 250         do { \
 251                 if (x_bin[x_id].gst) { \
 252                         gst_element_set_state(x_bin[x_id].gst, GST_STATE_NULL); \
 253                         gst_bin_remove(GST_BIN(x_player->pipeline->mainbin[MMPLAYER_M_PIPE].gst), x_bin[x_id].gst); \
 254                         x_bin[x_id].gst = NULL; \
 255                         LOGD("release done [element %d]", x_id); \
 256                 } \
 257         } while (0)
 258
 259 /* state */
 260 #define MMPLAYER_PREV_STATE(x_player) ((mmplayer_t *)x_player)->prev_state
 261 #define MMPLAYER_CURRENT_STATE(x_player) ((mmplayer_t *)x_player)->state
 262 #define MMPLAYER_PENDING_STATE(x_player) ((mmplayer_t *)x_player)->pending_state
 263 #define MMPLAYER_TARGET_STATE(x_player) ((mmplayer_t *)x_player)->target_state
 264 #define MMPLAYER_STATE_GET_NAME(state) _mmplayer_get_state_name(state)
 265
 266 #define MMPLAYER_PRINT_STATE(x_player) \
 267         do { \
 268                 LOGD("-- prev %s, current %s, pending %s, target %s --", \
 269                         MMPLAYER_STATE_GET_NAME(MMPLAYER_PREV_STATE(x_player)), \
 270                         MMPLAYER_STATE_GET_NAME(MMPLAYER_CURRENT_STATE(x_player)), \
 271                         MMPLAYER_STATE_GET_NAME(MMPLAYER_PENDING_STATE(x_player)), \
 272                         MMPLAYER_STATE_GET_NAME(MMPLAYER_TARGET_STATE(x_player))); \
 273         } while (0)
 274
 275 #define MMPLAYER_STATE_CHANGE_TIMEOUT(x_player) ((mmplayer_t *)x_player)->state_change_timeout
 276
 277 /* streaming */
 278 #define MMPLAYER_IS_STREAMING(x_player) _mmplayer_is_streaming(x_player)
 279 #define MMPLAYER_IS_RTSP_STREAMING(x_player) _mmplayer_is_rtsp_streaming(x_player)
 280 #define MMPLAYER_IS_HTTP_STREAMING(x_player) _mmplayer_is_http_streaming(x_player)
 281 #define MMPLAYER_IS_HTTP_LIVE_STREAMING(x_player) _mmplayer_is_http_live_streaming(x_player)
 282 #define MMPLAYER_IS_LIVE_STREAMING(x_player) _mmplayer_is_live_streaming(x_player)
 283 #define MMPLAYER_IS_DASH_STREAMING(x_player) _mmplayer_is_dash_streaming(x_player)
 284 #define MMPLAYER_IS_SMOOTH_STREAMING(x_player) _mmplayer_is_smooth_streaming(x_player)
 285 #define MMPLAYER_IS_MS_BUFF_SRC(x_player) _mmplayer_is_ms_buff_src(x_player)
 286
 287 #define MMPLAYER_URL_HAS_DASH_SUFFIX(x_player) _mmplayer_has_suffix(x_player, ".mpd")
 288 #define MMPLAYER_URL_HAS_HLS_SUFFIX(x_player) _mmplayer_has_suffix(x_player, ".m3u8")
 289
 290 #define MMPLAYER_STREAM_TYPE_GET_NAME(type) _mmplayer_get_stream_type_name(type)
 291
 292 #define MMPLAYER_USE_DECODEBIN(x_player) _mmplayer_use_decodebin(x_player)
 293
 294 /*===========================================================================================
 295 |                                                                                                                                                                                       |
 296 |  GLOBAL FUNCTION PROTOTYPES                                                                                                                           |
 297 |                                                                                                                                                                                       |
 298 ========================================================================================== */
 299
 300 const gchar *_mmplayer_get_state_name(int state);
 301 const gchar *_mmplayer_get_stream_type_name(int type);
 302
 303 gboolean _mmplayer_is_streaming(mmplayer_t *player);
 304 gboolean _mmplayer_is_rtsp_streaming(mmplayer_t *player);
 305 gboolean _mmplayer_is_live_streaming(mmplayer_t *player);
 306 gboolean _mmplayer_is_http_streaming(mmplayer_t *player);
 307 gboolean _mmplayer_is_http_live_streaming(mmplayer_t *player);
 308 gboolean _mmplayer_is_dash_streaming(mmplayer_t *player);
 309 gboolean _mmplayer_is_smooth_streaming(mmplayer_t *player);
 310 gboolean _mmplayer_is_ms_buff_src(mmplayer_t *player);
 311 gboolean _mmplayer_has_suffix(mmplayer_t *player, const gchar *suffix);
 312 gboolean _mmplayer_is_videosink_ready(mmplayer_t *player, int surface_type);
 313 gboolean _mmplayer_use_decodebin(mmplayer_t *player);
 314
 315 gboolean _mmplayer_post_message(mmplayer_t *player, enum MMMessageType msgtype, MMMessageParamType *param);
 316 gboolean _mmplayer_dump_pipeline_state(mmplayer_t *player);
 317
 318 bool _mmplayer_is_sdp_file(const char *path);
 319 int _mmplayer_exist_file_path(const char *file_path);
 320 char **_mmplayer_get_cookie_list(const char *cookies);
 321 const char *_mmplayer_get_charset(const char *file_path);
 322 int _mmplayer_get_pixtype(unsigned int fourcc);
 323 bool _mmplayer_get_storage_info(const char *path, mmplayer_storage_info_t *storage_info);
 324
 325 /* for command lock */
 326 void _mmplayer_cmd_lock_init(mmplayer_t *player);
 327 void _mmplayer_cmd_lock_deinit(mmplayer_t *player);
 328 void _mmplayer_cmd_lock(mmplayer_t *player);
 329 gboolean _mmplayer_cmd_trylock(mmplayer_t *player);
 330 void _mmplayer_cmd_unlock(mmplayer_t *player);
 331 media_format_mimetype_e _mmplayer_convert_audio_pcm_str_to_media_format_mime(const gchar *audio_pcm_str);
 332
 333 #ifdef __cplusplus
 334         }
 335 #endif
 336
 337 #endif /* __MM_PLAYER_UTILS_H__ */