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                 if (x) { \
  55                         g_free(x); \
  56                         x = NULL;       \
  57                 } \
  58         } while (0)
  59
  60 #define MMPLAYER_GET_ATTRS(x_player) ((mmplayer_t *)x_player)->attrs
  61
  62 /* command */
  63 #define MMPLAYER_CMD_LOCK(x_player)                          g_mutex_lock(&((mmplayer_t *)x_player)->cmd_lock)
  64 #define MMPLAYER_CMD_TRYLOCK(x_player)                       g_mutex_trylock(&((mmplayer_t *)x_player)->cmd_lock)
  65 #define MMPLAYER_CMD_UNLOCK(x_player)                        g_mutex_unlock(&((mmplayer_t *)x_player)->cmd_lock)
  66
  67 /* pipeline reconfigure */
  68 #define MMPLAYER_RECONFIGURE_LOCK(x_player)                  g_mutex_lock(&((mmplayer_t *)x_player)->reconfigure_lock)
  69 #define MMPLAYER_RECONFIGURE_UNLOCK(x_player)                g_mutex_unlock(&((mmplayer_t *)x_player)->reconfigure_lock)
  70 #define MMPLAYER_RECONFIGURE_WAIT(x_player)                  g_cond_wait(&((mmplayer_t *)x_player)->reconfigure_cond, &((mmplayer_t *)x_player)->reconfigure_lock)
  71 #define MMPLAYER_RECONFIGURE_SIGNAL(x_player)                g_cond_signal(&((mmplayer_t *)x_player)->reconfigure_cond);
  72
  73 /* capture thread */
  74 #define MMPLAYER_CAPTURE_THREAD_LOCK(x_player)               g_mutex_lock(&((mmplayer_t *)x_player)->capture_thread_mutex)
  75 #define MMPLAYER_CAPTURE_THREAD_UNLOCK(x_player)             g_mutex_unlock(&((mmplayer_t *)x_player)->capture_thread_mutex)
  76 #define MMPLAYER_CAPTURE_THREAD_WAIT(x_player)               g_cond_wait(&((mmplayer_t *)x_player)->capture_thread_cond, &((mmplayer_t *)x_player)->capture_thread_mutex)
  77 #define MMPLAYER_CAPTURE_THREAD_SIGNAL(x_player)             g_cond_signal(&((mmplayer_t *)x_player)->capture_thread_cond);
  78
  79 /* gapless play thread */
  80 #define MMPLAYER_GAPLESS_PLAY_THREAD_LOCK(x_player)             g_mutex_lock(&((mmplayer_t *)x_player)->gapless_play_thread_mutex)
  81 #define MMPLAYER_GAPLESS_PLAY_THREAD_UNLOCK(x_player)           g_mutex_unlock(&((mmplayer_t *)x_player)->gapless_play_thread_mutex)
  82 #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)
  83 #define MMPLAYER_GAPLESS_PLAY_THREAD_SIGNAL(x_player)           g_cond_signal(&((mmplayer_t *)x_player)->gapless_play_thread_cond);
  84
  85 /* gst bus msg thread */
  86 #define MMPLAYER_BUS_MSG_THREAD_LOCK(x_player)                   g_mutex_lock(&((mmplayer_t *)x_player)->bus_msg_thread_mutex)
  87 #define MMPLAYER_BUS_MSG_THREAD_UNLOCK(x_player)                 g_mutex_unlock(&((mmplayer_t *)x_player)->bus_msg_thread_mutex)
  88 #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)
  89 #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)
  90 #define MMPLAYER_BUS_MSG_THREAD_SIGNAL(x_player)                 g_cond_signal(&((mmplayer_t *)x_player)->bus_msg_thread_cond);
  91
  92 /* gst bus watcher thread */
  93 #define MMPLAYER_BUS_WATCHER_LOCK(x_player)                   g_mutex_lock(&((mmplayer_t *)x_player)->bus_watcher_mutex)
  94 #define MMPLAYER_BUS_WATCHER_UNLOCK(x_player)                 g_mutex_unlock(&((mmplayer_t *)x_player)->bus_watcher_mutex)
  95 #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)
  96 #define MMPLAYER_BUS_WATCHER_SIGNAL(x_player)                 g_cond_signal(&((mmplayer_t *)x_player)->bus_watcher_cond);
  97
  98 /* handling fakesink */
  99 #define MMPLAYER_FSINK_LOCK(x_player)                        g_mutex_lock(&((mmplayer_t *)x_player)->fsink_lock)
 100 #define MMPLAYER_FSINK_UNLOCK(x_player)                      g_mutex_unlock(&((mmplayer_t *)x_player)->fsink_lock)
 101
 102 /* handling update tag */
 103 #define MMPLAYER_UPDATE_TAG_LOCK(x_player)                   g_mutex_lock(&((mmplayer_t *)x_player)->update_tag_lock)
 104 #define MMPLAYER_UPDATE_TAG_UNLOCK(x_player)                 g_mutex_unlock(&((mmplayer_t *)x_player)->update_tag_lock)
 105
 106 /* video stream bo */
 107 #define MMPLAYER_VIDEO_BO_LOCK(x_player)                     g_mutex_lock(&((mmplayer_t *)x_player)->video_bo_mutex)
 108 #define MMPLAYER_VIDEO_BO_UNLOCK(x_player)                   g_mutex_unlock(&((mmplayer_t *)x_player)->video_bo_mutex)
 109 #define MMPLAYER_VIDEO_BO_WAIT(x_player)                     g_cond_wait(&((mmplayer_t *)x_player)->video_bo_cond, &((mmplayer_t *)x_player)->video_bo_mutex)
 110 #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)
 111 #define MMPLAYER_VIDEO_BO_SIGNAL(x_player)                   g_cond_signal(&((mmplayer_t *)x_player)->video_bo_cond);
 112
 113 /* subtitle info */
 114 #define MMPLAYER_SUBTITLE_INFO_LOCK(x_player)                     g_mutex_lock(&((mmplayer_t *)x_player)->subtitle_info_mutex)
 115 #define MMPLAYER_SUBTITLE_INFO_UNLOCK(x_player)                   g_mutex_unlock(&((mmplayer_t *)x_player)->subtitle_info_mutex)
 116 #define MMPLAYER_SUBTITLE_INFO_WAIT(x_player)                     g_cond_wait(&((mmplayer_t *)x_player)->subtitle_info_cond, &((mmplayer_t *)x_player)->subtitle_info_mutex)
 117 #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)
 118 #define MMPLAYER_SUBTITLE_INFO_SIGNAL(x_player)                   g_cond_signal(&((mmplayer_t *)x_player)->subtitle_info_cond);
 119
 120 #if 0
 121 #define MMPLAYER_FENTER();                                      LOGD("<ENTER>");
 122 #define MMPLAYER_FLEAVE();                                      LOGD("<LEAVE>");
 123 #else
 124 #define MMPLAYER_FENTER();
 125 #define MMPLAYER_FLEAVE();
 126 #endif
 127
 128 #define MMPLAYER_RETURN_IF_FAIL(expr) \
 129         do { \
 130                 if (!(expr)) { \
 131                         LOGW("failed [%s]", #expr); \
 132                         return; \
 133                 } \
 134         } while (0)
 135
 136 #define MMPLAYER_RETURN_VAL_IF_FAIL(expr, var) \
 137         do { \
 138                 if (!(expr)) { \
 139                         LOGW("failed [%s]", #expr); \
 140                         return (var); \
 141                 } \
 142         } while (0)
 143
 144 /* debug caps string */
 145 #define MMPLAYER_LOG_GST_CAPS_TYPE(x_caps) \
 146         do { \
 147                 gchar *caps_type = NULL; \
 148                 if (x_caps) { \
 149                         caps_type = gst_caps_to_string(x_caps); \
 150                         LOGD("caps: %s", caps_type); \
 151                         MMPLAYER_FREEIF(caps_type); \
 152                 } else {\
 153                         LOGW("caps is null"); \
 154                 } \
 155         } while (0)
 156
 157 /* message posting */
 158 #define MMPLAYER_POST_MSG(x_player, x_msgtype, x_msg_param) \
 159         do { \
 160                 LOGD("[handle: %p] posting %s to application", x_player, #x_msgtype); \
 161                 _mmplayer_post_message(x_player, x_msgtype, x_msg_param); \
 162         } while (0)
 163
 164 /* setting player state */
 165 #define MMPLAYER_SET_STATE(x_player, x_state) \
 166         do { \
 167                 LOGD("[handle: %p] update state machine to %d", x_player, x_state); \
 168                 _mmplayer_set_state(x_player, x_state); \
 169         } while (0)
 170
 171 #define MMPLAYER_CHECK_STATE(x_player, x_command) \
 172         do {    \
 173                 LOGD("[handle: %p] checking player state before doing %s", x_player, #x_command); \
 174                 switch (_mmplayer_check_state(x_player, x_command)) { \
 175                 case MM_ERROR_PLAYER_INVALID_STATE: \
 176                         return MM_ERROR_PLAYER_INVALID_STATE; \
 177                         break; \
 178                         /* NOTE : for robustness of player. we won't treat it as an error */ \
 179                 case MM_ERROR_PLAYER_NO_OP: \
 180                         return MM_ERROR_NONE; \
 181                         break; \
 182                 case MM_ERROR_PLAYER_DOING_SEEK: \
 183                         return MM_ERROR_PLAYER_DOING_SEEK; \
 184                 default: \
 185                         break; \
 186                 }       \
 187         } while (0)
 188
 189 /* setting element state */
 190 #define MMPLAYER_ELEMENT_SET_STATE(x_element, x_state) \
 191         do {    \
 192                 LOGD("setting state [%s:%d] to [%s]", #x_state, x_state, GST_ELEMENT_NAME(x_element)); \
 193                 if (GST_STATE_CHANGE_FAILURE == gst_element_set_state(x_element, x_state)) { \
 194                         LOGE("failed to set state %s to %s", #x_state, GST_ELEMENT_NAME(x_element)); \
 195                         goto STATE_CHANGE_FAILED; \
 196                 }       \
 197         } while (0)
 198
 199 #define MMPLAYER_CHECK_NULL(x_var) \
 200         do { \
 201                 if (!x_var) { \
 202                         LOGE("[%s] is NULL", #x_var); \
 203                         goto ERROR; \
 204                 } \
 205         } while (0)
 206
 207 /* generating dot */
 208 #define MMPLAYER_GENERATE_DOT_IF_ENABLED(x_player, x_name) \
 209         do { \
 210                 if (x_player->ini.generate_dot) { \
 211                         GST_DEBUG_BIN_TO_DOT_FILE(GST_BIN(player->pipeline->mainbin[MMPLAYER_M_PIPE].gst), \
 212                         GST_DEBUG_GRAPH_SHOW_ALL, x_name); \
 213                 } \
 214         } while (0)
 215
 216 /* signal manipulation */
 217 #define MMPLAYER_SIGNAL_CONNECT(x_player, x_object, x_type, x_signal, x_callback, x_arg) \
 218         do { \
 219                 mmplayer_signal_item_t *item = NULL; \
 220                 item = (mmplayer_signal_item_t *)g_malloc(sizeof(mmplayer_signal_item_t)); \
 221                 if (!item) { \
 222                         LOGE("cannot connect signal [%s]", x_signal); \
 223                 } else { \
 224                         item->obj = G_OBJECT(x_object); \
 225                         item->sig = g_signal_connect(G_OBJECT(x_object), x_signal, \
 226                                                 x_callback, x_arg); \
 227                         if ((x_type >= MM_PLAYER_SIGNAL_TYPE_AUTOPLUG) && (x_type < MM_PLAYER_SIGNAL_TYPE_MAX)) \
 228                                 x_player->signals[x_type] = g_list_append(x_player->signals[x_type], item); \
 229                         else \
 230                                 LOGE("wrong signal type [%d]", x_type); \
 231                 } \
 232         } while (0)
 233
 234 /* create element */
 235 #define MMPLAYER_CREATE_ELEMENT(x_bin, x_id, x_factory, x_name, x_bucket, x_player) \
 236         do {\
 237                 x_bin[x_id].id = x_id;\
 238                 x_bin[x_id].gst = gst_element_factory_make(x_factory, x_name);\
 239                 if (!x_bin[x_id].gst) {\
 240                         LOGE("failed to create %s", x_factory);\
 241                         goto ERROR;\
 242                 } else {\
 243                         if (x_player->ini.set_dump_element_flag)\
 244                                 __mmplayer_add_dump_buffer_probe(x_player, x_bin[x_id].gst);\
 245                 } \
 246                 x_bucket = g_list_append(x_bucket, &x_bin[x_id]);\
 247         } while (0);
 248
 249 /* release element resource */
 250 #define MMPLAYER_RELEASE_ELEMENT(x_player, x_bin, x_id) \
 251         do { \
 252                 if (x_bin[x_id].gst) { \
 253                         gst_element_set_state(x_bin[x_id].gst, GST_STATE_NULL); \
 254                         gst_bin_remove(GST_BIN(x_player->pipeline->mainbin[MMPLAYER_M_PIPE].gst), x_bin[x_id].gst); \
 255                         x_bin[x_id].gst = NULL; \
 256                         LOGD("release done [element %d]", x_id); \
 257                 } \
 258         } while (0)
 259
 260 /* state */
 261 #define MMPLAYER_PREV_STATE(x_player) ((mmplayer_t *)x_player)->prev_state
 262 #define MMPLAYER_CURRENT_STATE(x_player) ((mmplayer_t *)x_player)->state
 263 #define MMPLAYER_PENDING_STATE(x_player) ((mmplayer_t *)x_player)->pending_state
 264 #define MMPLAYER_TARGET_STATE(x_player) ((mmplayer_t *)x_player)->target_state
 265 #define MMPLAYER_STATE_GET_NAME(state) _mmplayer_get_state_name(state)
 266
 267 #define MMPLAYER_PRINT_STATE(x_player) \
 268         do { \
 269                 LOGD("-- prev %s, current %s, pending %s, target %s --", \
 270                         MMPLAYER_STATE_GET_NAME(MMPLAYER_PREV_STATE(x_player)), \
 271                         MMPLAYER_STATE_GET_NAME(MMPLAYER_CURRENT_STATE(x_player)), \
 272                         MMPLAYER_STATE_GET_NAME(MMPLAYER_PENDING_STATE(x_player)), \
 273                         MMPLAYER_STATE_GET_NAME(MMPLAYER_TARGET_STATE(x_player))); \
 274         } while (0)
 275
 276 #define MMPLAYER_STATE_CHANGE_TIMEOUT(x_player) ((mmplayer_t *)x_player)->state_change_timeout
 277
 278 /* streaming */
 279 #define MMPLAYER_IS_STREAMING(x_player) _mmplayer_is_streaming(x_player)
 280 #define MMPLAYER_IS_RTSP_STREAMING(x_player) _mmplayer_is_rtsp_streaming(x_player)
 281 #define MMPLAYER_IS_HTTP_STREAMING(x_player) _mmplayer_is_http_streaming(x_player)
 282 #define MMPLAYER_IS_HTTP_LIVE_STREAMING(x_player) _mmplayer_is_http_live_streaming(x_player)
 283 #define MMPLAYER_IS_LIVE_STREAMING(x_player) _mmplayer_is_live_streaming(x_player)
 284 #define MMPLAYER_IS_DASH_STREAMING(x_player) _mmplayer_is_dash_streaming(x_player)
 285 #define MMPLAYER_IS_SMOOTH_STREAMING(x_player) _mmplayer_is_smooth_streaming(x_player)
 286 #define MMPLAYER_IS_MS_BUFF_SRC(x_player) _mmplayer_is_ms_buff_src(x_player)
 287
 288 #define MMPLAYER_URL_HAS_DASH_SUFFIX(x_player) _mmplayer_has_suffix(x_player, ".mpd")
 289 #define MMPLAYER_URL_HAS_HLS_SUFFIX(x_player) _mmplayer_has_suffix(x_player, ".m3u8")
 290
 291 #define MMPLAYER_STREAM_TYPE_GET_NAME(type) _mmplayer_get_stream_type_name(type)
 292
 293 #define MMPLAYER_USE_DECODEBIN(x_player) _mmplayer_use_decodebin(x_player)
 294
 295 /*===========================================================================================
 296 |                                                                                                                                                                                       |
 297 |  GLOBAL FUNCTION PROTOTYPES                                                                                                                           |
 298 |                                                                                                                                                                                       |
 299 ========================================================================================== */
 300
 301 const gchar *_mmplayer_get_state_name(int state);
 302 const gchar *_mmplayer_get_stream_type_name(int type);
 303
 304 gboolean _mmplayer_is_streaming(mmplayer_t *player);
 305 gboolean _mmplayer_is_rtsp_streaming(mmplayer_t *player);
 306 gboolean _mmplayer_is_live_streaming(mmplayer_t *player);
 307 gboolean _mmplayer_is_http_streaming(mmplayer_t *player);
 308 gboolean _mmplayer_is_http_live_streaming(mmplayer_t *player);
 309 gboolean _mmplayer_is_dash_streaming(mmplayer_t *player);
 310 gboolean _mmplayer_is_smooth_streaming(mmplayer_t *player);
 311 gboolean _mmplayer_is_ms_buff_src(mmplayer_t *player);
 312 gboolean _mmplayer_has_suffix(mmplayer_t *player, const gchar *suffix);
 313 gboolean _mmplayer_is_videosink_ready(mmplayer_t *player, int surface_type);
 314 gboolean _mmplayer_use_decodebin(mmplayer_t *player);
 315
 316 gboolean _mmplayer_post_message(mmplayer_t *player, enum MMMessageType msgtype, MMMessageParamType *param);
 317 gboolean _mmplayer_dump_pipeline_state(mmplayer_t *player);
 318
 319 bool _mmplayer_is_sdp_file(const char *path);
 320 int _mmplayer_exist_file_path(const char *file_path);
 321 char **_mmplayer_get_cookie_list(const char *cookies);
 322 const char *_mmplayer_get_charset(const char *file_path);
 323 int _mmplayer_get_pixtype(unsigned int fourcc);
 324 bool _mmplayer_get_storage_info(const char *path, mmplayer_storage_info_t *storage_info);
 325
 326 media_format_mimetype_e _mmplayer_convert_audio_pcm_str_to_media_format_mime(const gchar *audio_pcm_str);
 327
 328 #ifdef __cplusplus
 329         }
 330 #endif
 331
 332 #endif /* __MM_PLAYER_UTILS_H__ */