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 /* next play thread */
  76 #define MMPLAYER_NEXT_PLAY_THREAD_LOCK(x_player)             g_mutex_lock(&((mm_player_t *)x_player)->next_play_thread_mutex)
  77 #define MMPLAYER_NEXT_PLAY_THREAD_UNLOCK(x_player)           g_mutex_unlock(&((mm_player_t *)x_player)->next_play_thread_mutex)
  78 #define MMPLAYER_NEXT_PLAY_THREAD_WAIT(x_player)             g_cond_wait(&((mm_player_t *)x_player)->next_play_thread_cond, &((mm_player_t *)x_player)->next_play_thread_mutex)
  79 #define MMPLAYER_NEXT_PLAY_THREAD_SIGNAL(x_player)           g_cond_signal(&((mm_player_t *)x_player)->next_play_thread_cond);
  80
  81 /* repeat thread */
  82 #define MMPLAYER_REPEAT_THREAD_LOCK(x_player)                g_mutex_lock(&((mm_player_t *)x_player)->repeat_thread_mutex)
  83 #define MMPLAYER_REPEAT_THREAD_UNLOCK(x_player)              g_mutex_unlock(&((mm_player_t *)x_player)->repeat_thread_mutex)
  84 #define MMPLAYER_REPEAT_THREAD_WAIT(x_player)                g_cond_wait(&((mm_player_t *)x_player)->repeat_thread_cond, &((mm_player_t *)x_player)->repeat_thread_mutex)
  85 #define MMPLAYER_REPEAT_THREAD_SIGNAL(x_player)              g_cond_signal(&((mm_player_t *)x_player)->repeat_thread_cond);
  86
  87 /* handling fakesink */
  88 #define MMPLAYER_FSINK_LOCK(x_player)                        g_mutex_lock(&((mm_player_t *)x_player)->fsink_lock)
  89 #define MMPLAYER_FSINK_UNLOCK(x_player)                      g_mutex_unlock(&((mm_player_t *)x_player)->fsink_lock)
  90
  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 #if 0
 108 #define MMPLAYER_FENTER();                                      LOGD("<ENTER>");
 109 #define MMPLAYER_FLEAVE();                                      LOGD("<LEAVE>");
 110 #else
 111 #define MMPLAYER_FENTER();
 112 #define MMPLAYER_FLEAVE();
 113 #endif
 114
 115 #define MAX_SOUND_DEVICE_LEN    18
 116
 117 /* element linking */
 118 #ifdef GST_EXT_PAD_LINK_UNCHECKED
 119 #define GST_ELEMENT_LINK_FILTERED       gst_element_link_filtered_unchecked
 120 #define GST_ELEMENT_LINK_MANY           gst_element_link_many_unchecked
 121 #define GST_ELEMENT_LINK                        gst_element_link_unchecked
 122 #define GST_ELEMENT_LINK_PADS           gst_element_link_pads_unchecked
 123 #define GST_PAD_LINK                            gst_pad_link_unchecked
 124 #else
 125 #define GST_ELEMENT_LINK_FILTERED       gst_element_link_filtered
 126 #define GST_ELEMENT_LINK_MANY           gst_element_link_many
 127 #define GST_ELEMENT_LINK                        gst_element_link
 128 #define GST_ELEMENT_UNLINK                      gst_element_unlink
 129 #define GST_ELEMENT_LINK_PADS           gst_element_link_pads
 130 #define GST_PAD_LINK                            gst_pad_link
 131 #endif
 132
 133 #define MMPLAYER_RETURN_IF_FAIL(expr) \
 134 if (!(expr)) { \
 135         LOGW("faild [%s]", #expr); \
 136         return; \
 137 }
 138
 139 #define MMPLAYER_RETURN_VAL_IF_FAIL(expr, var) \
 140 if (!(expr)) { \
 141         LOGW("faild [%s]", #expr); \
 142         return (var); \
 143 }
 144
 145 /* debug caps string */
 146 #define MMPLAYER_LOG_GST_CAPS_TYPE(x_caps) \
 147 do { \
 148         gchar* caps_type = NULL; \
 149         caps_type = gst_caps_to_string(x_caps); \
 150         LOGD("caps: %s\n", caps_type); \
 151         MMPLAYER_FREEIF(caps_type); \
 152 } while (0)
 153
 154 /* message posting */
 155 #define MMPLAYER_POST_MSG(x_player, x_msgtype, x_msg_param) \
 156 do { \
 157         LOGD("posting %s to application\n", #x_msgtype); \
 158         __mmplayer_post_message(x_player, x_msgtype, x_msg_param); \
 159 } while (0)
 160
 161 /* setting player state */
 162 #define MMPLAYER_SET_STATE(x_player, x_state) \
 163 do { \
 164         LOGD("update state machine to %d\n", x_state); \
 165         __mmplayer_set_state(x_player, x_state); \
 166 } while (0)
 167
 168 #define MMPLAYER_CHECK_STATE(x_player, x_command) \
 169 do {    \
 170         LOGD("checking player state before doing %s\n", #x_command); \
 171         switch (__mmplayer_check_state(x_player, x_command)) { \
 172         case MM_ERROR_PLAYER_INVALID_STATE: \
 173                 return MM_ERROR_PLAYER_INVALID_STATE; \
 174                 break; \
 175                 /* NOTE : for robustness of player. we won't treat it as an error */ \
 176         case MM_ERROR_PLAYER_NO_OP: \
 177                 return MM_ERROR_NONE; \
 178                 break; \
 179         case MM_ERROR_PLAYER_DOING_SEEK: \
 180                 return MM_ERROR_PLAYER_DOING_SEEK; \
 181         default: \
 182                 break; \
 183         }       \
 184 } while (0)
 185
 186 /* setting element state */
 187 #define MMPLAYER_ELEMENT_SET_STATE(x_element, x_state) \
 188 do {    \
 189         LOGD("setting state [%s:%d] to [%s]\n", #x_state, x_state, GST_ELEMENT_NAME(x_element)); \
 190         if (GST_STATE_CHANGE_FAILURE == gst_element_set_state(x_element, x_state)) { \
 191                 LOGE("failed to set state %s to %s\n", #x_state, GST_ELEMENT_NAME(x_element)); \
 192                 goto STATE_CHANGE_FAILED; \
 193         }       \
 194 } while (0)
 195
 196 #define MMPLAYER_CHECK_NULL(x_var) \
 197 if (!x_var) { \
 198         LOGE("[%s] is NULL\n", #x_var); \
 199         goto ERROR; \
 200 }
 201
 202 /* generating dot */
 203 #define MMPLAYER_GENERATE_DOT_IF_ENABLED(x_player, x_name) \
 204 if (x_player->ini.generate_dot) { \
 205         GST_DEBUG_BIN_TO_DOT_FILE(GST_BIN(player->pipeline->mainbin[MMPLAYER_M_PIPE].gst), \
 206         GST_DEBUG_GRAPH_SHOW_ALL, x_name); \
 207 }
 208
 209 /* signal manipulation */
 210 #define MMPLAYER_SIGNAL_CONNECT(x_player, x_object, x_type, x_signal, x_callback, x_arg) \
 211 do { \
 212         MMPlayerSignalItem* item = NULL; \
 213         item = (MMPlayerSignalItem*) g_malloc(sizeof(MMPlayerSignalItem)); \
 214         if (!item) { \
 215                 LOGE("cannot connect signal [%s]\n", x_signal); \
 216         } else { \
 217                 item->obj = G_OBJECT(x_object); \
 218                 item->sig = g_signal_connect(G_OBJECT(x_object), x_signal, \
 219                                         x_callback, x_arg); \
 220                 if ((x_type >= MM_PLAYER_SIGNAL_TYPE_AUTOPLUG) && (x_type < MM_PLAYER_SIGNAL_TYPE_MAX)) \
 221                         x_player->signals[x_type] = g_list_append(x_player->signals[x_type], item); \
 222                 else \
 223                         LOGE("wrong signal type [%d]\n", x_type); \
 224         } \
 225 } while (0)
 226
 227 /* release element resource */
 228 #define MMPLAYER_RELEASE_ELEMENT(x_player, x_bin, x_id) \
 229 do { \
 230         if (x_bin[x_id].gst) { \
 231                 gst_element_set_state(x_bin[x_id].gst, GST_STATE_NULL); \
 232                 gst_bin_remove(GST_BIN(x_player->pipeline->mainbin[MMPLAYER_M_PIPE].gst), x_bin[x_id].gst); \
 233                 x_bin[x_id].gst = NULL; \
 234                 LOGD("release done [element %d]", x_id); \
 235         } \
 236 } while (0)
 237
 238 /* state */
 239 #define MMPLAYER_PREV_STATE(x_player) ((mm_player_t*)x_player)->prev_state
 240 #define MMPLAYER_CURRENT_STATE(x_player) ((mm_player_t*)x_player)->state
 241 #define MMPLAYER_PENDING_STATE(x_player) ((mm_player_t*)x_player)->pending_state
 242 #define MMPLAYER_TARGET_STATE(x_player) ((mm_player_t*)x_player)->target_state
 243 #define MMPLAYER_STATE_GET_NAME(state) __get_state_name(state)
 244
 245 #define MMPLAYER_PRINT_STATE(x_player) \
 246 LOGD("-- prev %s, current %s, pending %s, target %s --\n", \
 247         MMPLAYER_STATE_GET_NAME(MMPLAYER_PREV_STATE(x_player)), \
 248         MMPLAYER_STATE_GET_NAME(MMPLAYER_CURRENT_STATE(x_player)), \
 249         MMPLAYER_STATE_GET_NAME(MMPLAYER_PENDING_STATE(x_player)), \
 250         MMPLAYER_STATE_GET_NAME(MMPLAYER_TARGET_STATE(x_player)));
 251
 252 #define MMPLAYER_STATE_CHANGE_TIMEOUT(x_player)  ((mm_player_t*)x_player)->state_change_timeout
 253
 254 /* streaming */
 255 #define MMPLAYER_IS_STREAMING(x_player) __is_streaming(x_player)
 256 #define MMPLAYER_IS_RTSP_STREAMING(x_player) __is_rtsp_streaming(x_player)
 257 #define MMPLAYER_IS_HTTP_STREAMING(x_player) __is_http_streaming(x_player)
 258 #define MMPLAYER_IS_HTTP_PD(x_player) __is_http_progressive_down(x_player)
 259 #define MMPLAYER_IS_HTTP_LIVE_STREAMING(x_player) __is_http_live_streaming(x_player)
 260 #define MMPLAYER_IS_LIVE_STREAMING(x_player) __is_live_streaming(x_player)
 261 #define MMPLAYER_IS_DASH_STREAMING(x_player) __is_dash_streaming(x_player)
 262 #define MMPLAYER_IS_SMOOTH_STREAMING(x_player) __is_smooth_streaming(x_player)
 263 #define MMPLAYER_IS_MS_BUFF_SRC(x_player) __is_ms_buff_src(x_player)
 264
 265 #define MMPLAYER_URL_HAS_DASH_SUFFIX(x_player) __has_suffix(x_player, "mpd")
 266 #define MMPLAYER_URL_HAS_HLS_SUFFIX(x_player) __has_suffix(x_player, "m3u8")
 267
 268 bool util_is_sdp_file(const char *path);
 269 int util_get_rank_increase(const char *factory_class);
 270 int util_factory_rank_compare(GstPluginFeature *f1, GstPluginFeature *f2); // @
 271 int util_exist_file_path(const char *file_path);
 272 bool util_write_file_backup(const char *backup_path, char *data_ptr, int data_size);
 273 bool util_remove_file_backup(const char *backup_path); /* For Midi Player */
 274 int util_is_midi_type_by_mem(void *mem, int size);
 275 int util_is_midi_type_by_file(const char *file_path);
 276 char** util_get_cookie_list(const char *cookies);
 277 bool util_check_valid_url(const char *proxy);
 278 const char* util_get_charset(const char *file_path);
 279 int util_get_pixtype(unsigned int fourcc);
 280 bool util_get_storage_info(const char *path, MMPlayerStorageInfo *storage_info);
 281
 282 #ifdef __cplusplus
 283         }
 284 #endif
 285
 286 #endif /* __MM_PLAYER_UTILS_H__ */
 287