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