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