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
  34 #ifdef __cplusplus
  35         extern "C" {
  36 #endif
  37
  38 #ifdef LOG_TAG
  39 #undef LOG_TAG
  40 #endif
  41 #define LOG_TAG "MM_PLAYER"
  42
  43 /* general */
  44 #ifndef ARRAY_SIZE
  45 #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]))
  46 #endif
  47
  48 #define MMPLAYER_MAX_INT (2147483647)
  49
  50 #define MMPLAYER_FREEIF(x) \
  51 if (x) \
  52         g_free(x); \
  53 x = NULL;
  54
  55 #define MMPLAYER_CMD_LOCK(x_player) g_mutex_lock(&((mm_player_t *)x_player)->cmd_lock)
  56 #define MMPLAYER_CMD_UNLOCK(x_player) g_mutex_unlock(&((mm_player_t*)x_player)->cmd_lock)
  57 #define MMPLAYER_PLAYBACK_LOCK(x_player) g_mutex_lock(&((mm_player_t *)x_player)->playback_lock)
  58 #define MMPLAYER_PLAYBACK_UNLOCK(x_player) g_mutex_unlock(&((mm_player_t*)x_player)->playback_lock)
  59 #define MMPLAYER_GET_ATTRS(x_player) ((mm_player_t*)x_player)->attrs
  60
  61 #if 0
  62 #define MMPLAYER_FENTER();                                      LOGD("<ENTER>");
  63 #define MMPLAYER_FLEAVE();                                      LOGD("<LEAVE>");
  64 #else
  65 #define MMPLAYER_FENTER();
  66 #define MMPLAYER_FLEAVE();
  67 #endif
  68
  69 #define MAX_SOUND_DEVICE_LEN    18
  70
  71 /* element linking */
  72 #ifdef GST_EXT_PAD_LINK_UNCHECKED
  73 #define GST_ELEMENT_LINK_FILTERED       gst_element_link_filtered_unchecked
  74 #define GST_ELEMENT_LINK_MANY           gst_element_link_many_unchecked
  75 #define GST_ELEMENT_LINK                        gst_element_link_unchecked
  76 #define GST_ELEMENT_LINK_PADS           gst_element_link_pads_unchecked
  77 #define GST_PAD_LINK                            gst_pad_link_unchecked
  78 #else
  79 #define GST_ELEMENT_LINK_FILTERED       gst_element_link_filtered
  80 #define GST_ELEMENT_LINK_MANY           gst_element_link_many
  81 #define GST_ELEMENT_LINK                        gst_element_link
  82 #define GST_ELEMENT_UNLINK                      gst_element_unlink
  83 #define GST_ELEMENT_LINK_PADS           gst_element_link_pads
  84 #define GST_PAD_LINK                            gst_pad_link
  85 #endif
  86
  87 #define MMPLAYER_RETURN_IF_FAIL(expr) \
  88 if (!(expr)) { \
  89         LOGW("faild [%s]", #expr); \
  90         return; \
  91 }
  92
  93 #define MMPLAYER_RETURN_VAL_IF_FAIL(expr, var) \
  94 if (!(expr)) { \
  95         LOGW("faild [%s]", #expr); \
  96         return (var); \
  97 }
  98
  99 /* debug caps string */
 100 #define MMPLAYER_LOG_GST_CAPS_TYPE(x_caps) \
 101 do { \
 102         gchar* caps_type = NULL; \
 103         caps_type = gst_caps_to_string(x_caps); \
 104         LOGD("caps: %s\n", caps_type); \
 105         MMPLAYER_FREEIF(caps_type) \
 106 } while (0)
 107
 108 /* message posting */
 109 #define MMPLAYER_POST_MSG(x_player, x_msgtype, x_msg_param) \
 110 LOGD("posting %s to application\n", #x_msgtype); \
 111 __mmplayer_post_message(x_player, x_msgtype, x_msg_param);
 112
 113 /* setting player state */
 114 #define MMPLAYER_SET_STATE(x_player, x_state) \
 115 LOGD("update state machine to %d\n", x_state); \
 116 __mmplayer_set_state(x_player, x_state);
 117
 118 #define MMPLAYER_CHECK_STATE(x_player, x_command) \
 119 LOGD("checking player state before doing %s\n", #x_command); \
 120 switch (__mmplayer_check_state(x_player, x_command)) { \
 121 case MM_ERROR_PLAYER_INVALID_STATE: \
 122         return MM_ERROR_PLAYER_INVALID_STATE; \
 123         break; \
 124         /* NOTE : for robustness of player. we won't treat it as an error */ \
 125 case MM_ERROR_PLAYER_NO_OP: \
 126         return MM_ERROR_NONE; \
 127         break; \
 128 case MM_ERROR_PLAYER_DOING_SEEK: \
 129         return MM_ERROR_PLAYER_DOING_SEEK; \
 130 default: \
 131         break; \
 132 }
 133
 134 /* setting element state */
 135 #define MMPLAYER_ELEMENT_SET_STATE(x_element, x_state) \
 136 LOGD("setting state [%s:%d] to [%s]\n", #x_state, x_state, GST_ELEMENT_NAME(x_element)); \
 137 if (GST_STATE_CHANGE_FAILURE == gst_element_set_state(x_element, x_state)) { \
 138         LOGE("failed to set state %s to %s\n", #x_state, GST_ELEMENT_NAME(x_element)); \
 139         goto STATE_CHANGE_FAILED; \
 140 }
 141
 142 #define MMPLAYER_CHECK_NULL(x_var) \
 143 if (!x_var) { \
 144         LOGE("[%s] is NULL\n", #x_var); \
 145         goto ERROR; \
 146 }
 147
 148 #define MMPLAYER_CHECK_CMD_IF_EXIT(x_player) \
 149 if (x_player->cmd == MMPLAYER_COMMAND_UNREALIZE || x_player->cmd == MMPLAYER_COMMAND_DESTROY) { \
 150         LOGD("it's exit state...\n");\
 151         goto ERROR;  \
 152 }
 153
 154 /* generating dot */
 155 #define MMPLAYER_GENERATE_DOT_IF_ENABLED(x_player, x_name) \
 156 if (x_player->ini.generate_dot) { \
 157         GST_DEBUG_BIN_TO_DOT_FILE(GST_BIN(player->pipeline->mainbin[MMPLAYER_M_PIPE].gst), \
 158         GST_DEBUG_GRAPH_SHOW_ALL, x_name); \
 159 }
 160
 161 /* signal manipulation */
 162 #define MMPLAYER_SIGNAL_CONNECT(x_player, x_object, x_type, x_signal, x_callback, x_arg) \
 163 do { \
 164         MMPlayerSignalItem* item = NULL; \
 165         item = (MMPlayerSignalItem*) g_malloc(sizeof(MMPlayerSignalItem)); \
 166         if (!item) { \
 167                 LOGE("cannot connect signal [%s]\n", x_signal); \
 168         } else { \
 169                 item->obj = G_OBJECT(x_object); \
 170                 item->sig = g_signal_connect(G_OBJECT(x_object), x_signal, \
 171                                         x_callback, x_arg); \
 172                 if ((x_type >= MM_PLAYER_SIGNAL_TYPE_AUTOPLUG) && (x_type < MM_PLAYER_SIGNAL_TYPE_MAX)) \
 173                         x_player->signals[x_type] = g_list_append(x_player->signals[x_type], item); \
 174                 else \
 175                         LOGE("wrong signal type [%d]\n", x_type); \
 176         } \
 177 } while (0);
 178
 179 /* release element resource */
 180 #define MMPLAYER_RELEASE_ELEMENT(x_player, x_bin, x_id) \
 181 do { \
 182         if (x_bin[x_id].gst) { \
 183                 gst_element_set_state(x_bin[x_id].gst, GST_STATE_NULL); \
 184                 gst_bin_remove(GST_BIN(x_player->pipeline->mainbin[MMPLAYER_M_PIPE].gst), x_bin[x_id].gst); \
 185                 x_bin[x_id].gst = NULL; \
 186                 LOGD("release done [element %d]", x_id); \
 187         } \
 188 } while (0)
 189
 190 /* state */
 191 #define MMPLAYER_PREV_STATE(x_player) ((mm_player_t*)x_player)->prev_state
 192 #define MMPLAYER_CURRENT_STATE(x_player) ((mm_player_t*)x_player)->state
 193 #define MMPLAYER_PENDING_STATE(x_player) ((mm_player_t*)x_player)->pending_state
 194 #define MMPLAYER_TARGET_STATE(x_player) ((mm_player_t*)x_player)->target_state
 195 #define MMPLAYER_STATE_GET_NAME(state) __get_state_name(state)
 196
 197 #define MMPLAYER_PRINT_STATE(x_player) \
 198 LOGD("-- prev %s, current %s, pending %s, target %s --\n", \
 199         MMPLAYER_STATE_GET_NAME(MMPLAYER_PREV_STATE(x_player)), \
 200         MMPLAYER_STATE_GET_NAME(MMPLAYER_CURRENT_STATE(x_player)), \
 201         MMPLAYER_STATE_GET_NAME(MMPLAYER_PENDING_STATE(x_player)), \
 202         MMPLAYER_STATE_GET_NAME(MMPLAYER_TARGET_STATE(x_player)));
 203
 204 #define MMPLAYER_STATE_CHANGE_TIMEOUT(x_player)  ((mm_player_t*)x_player)->state_change_timeout
 205
 206 /* streaming */
 207 #define MMPLAYER_IS_STREAMING(x_player) __is_streaming(x_player)
 208 #define MMPLAYER_IS_RTSP_STREAMING(x_player) __is_rtsp_streaming(x_player)
 209 #define MMPLAYER_IS_WFD_STREAMING(x_player) __is_wfd_streaming(x_player)
 210 #define MMPLAYER_IS_HTTP_STREAMING(x_player) __is_http_streaming(x_player)
 211 #define MMPLAYER_IS_HTTP_PD(x_player) __is_http_progressive_down(x_player)
 212 #define MMPLAYER_IS_HTTP_LIVE_STREAMING(x_player) __is_http_live_streaming(x_player)
 213 #define MMPLAYER_IS_LIVE_STREAMING(x_player) __is_live_streaming(x_player)
 214 #define MMPLAYER_IS_DASH_STREAMING(x_player) __is_dash_streaming(x_player)
 215 #define MMPLAYER_IS_SMOOTH_STREAMING(x_player) __is_smooth_streaming(x_player)
 216 #define MMPLAYER_IS_MS_BUFF_SRC(x_player) __is_ms_buff_src(x_player)
 217
 218 #define MMPLAYER_URL_HAS_DASH_SUFFIX(x_player) __has_suffix(x_player, "mpd")
 219 #define MMPLAYER_URL_HAS_HLS_SUFFIX(x_player) __has_suffix(x_player, "m3u8")
 220
 221 /* etc */
 222 #define MMF_PLAYER_FILE_BACKUP_PATH "/tmp/media_temp."
 223 #define MMPLAYER_PT_IS_AUDIO(x_pt) (strstr(x_pt, "_97") || strstr(x_pt, "audio"))
 224 #define MMPLAYER_PT_IS_VIDEO(x_pt) (strstr(x_pt, "_96") || strstr(x_pt, "video"))
 225
 226 #define MMPLAYER_VIDEO_SINK_CHECK(x_player) \
 227 do { \
 228         MMPLAYER_RETURN_VAL_IF_FAIL(x_player && \
 229                 x_player->pipeline && \
 230                 x_player->pipeline->videobin && \
 231                 x_player->pipeline->videobin[MMPLAYER_V_SINK].gst, \
 232                 MM_ERROR_PLAYER_NOT_INITIALIZED); \
 233 } while (0)
 234
 235 enum {
 236         MMPLAYER_DISPLAY_NULL = 0,
 237         MMPLAYER_DISPLAY_HDMI_ACTIVE,
 238         MMPLAYER_DISPLAY_MIRRORING_ACTIVE,
 239 };
 240
 241 bool util_is_sdp_file(const char *path);
 242 int util_get_rank_increase(const char *factory_class);
 243 int util_factory_rank_compare(GstPluginFeature *f1, GstPluginFeature *f2); // @
 244 int util_exist_file_path(const char *file_path);
 245 bool util_write_file_backup(const char *backup_path, char *data_ptr, int data_size);
 246 bool util_remove_file_backup(const char *backup_path); /* For Midi Player */
 247 int util_is_midi_type_by_mem(void *mem, int size);
 248 int util_is_midi_type_by_file(const char *file_path);
 249 char** util_get_cookie_list(const char *cookies);
 250 bool util_check_valid_url(const char *proxy);
 251 const char* util_get_charset(const char *file_path);
 252 int util_get_pixtype(unsigned int fourcc);
 253
 254 #ifdef __cplusplus
 255         }
 256 #endif
 257
 258 #endif /* __MM_PLAYER_UTILS_H__ */
 259