Merge "Move Murphy client loop to new context" into tizen
[platform/core/multimedia/libmm-player.git] / 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_GET_ATTRS(x_player) ((mm_player_t*)x_player)->attrs
56
57 /* command */
58 #define MMPLAYER_CMD_LOCK(x_player)                          g_mutex_lock(&((mm_player_t *)x_player)->cmd_lock)
59 #define MMPLAYER_CMD_TRYLOCK(x_player)                       g_mutex_trylock(&((mm_player_t *)x_player)->cmd_lock)
60 #define MMPLAYER_CMD_UNLOCK(x_player)                        g_mutex_unlock(&((mm_player_t*)x_player)->cmd_lock)
61
62 /* playback */
63 #define MMPLAYER_PLAYBACK_LOCK(x_player)                     g_mutex_lock(&((mm_player_t *)x_player)->playback_lock)
64 #define MMPLAYER_PLAYBACK_UNLOCK(x_player)                   g_mutex_unlock(&((mm_player_t*)x_player)->playback_lock)
65
66 /* capture thread */
67 #define MMPLAYER_CAPTURE_THREAD_LOCK(x_player)               g_mutex_lock(&((mm_player_t *)x_player)->capture_thread_mutex)
68 #define MMPLAYER_CAPTURE_THREAD_UNLOCK(x_player)             g_mutex_unlock(&((mm_player_t *)x_player)->capture_thread_mutex)
69 #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)
70 #define MMPLAYER_CAPTURE_THREAD_SIGNAL(x_player)             g_cond_signal(&((mm_player_t *)x_player)->capture_thread_cond);
71
72 /* next play thread */
73 #define MMPLAYER_NEXT_PLAY_THREAD_LOCK(x_player)             g_mutex_lock(&((mm_player_t *)x_player)->next_play_thread_mutex)
74 #define MMPLAYER_NEXT_PLAY_THREAD_UNLOCK(x_player)           g_mutex_unlock(&((mm_player_t *)x_player)->next_play_thread_mutex)
75 #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)
76 #define MMPLAYER_NEXT_PLAY_THREAD_SIGNAL(x_player)           g_cond_signal(&((mm_player_t *)x_player)->next_play_thread_cond);
77
78 /* repeat thread */
79 #define MMPLAYER_REPEAT_THREAD_LOCK(x_player)                g_mutex_lock(&((mm_player_t *)x_player)->repeat_thread_mutex)
80 #define MMPLAYER_REPEAT_THREAD_UNLOCK(x_player)              g_mutex_unlock(&((mm_player_t *)x_player)->repeat_thread_mutex)
81 #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)
82 #define MMPLAYER_REPEAT_THREAD_SIGNAL(x_player)              g_cond_signal(&((mm_player_t *)x_player)->repeat_thread_cond);
83
84 /* handling fakesink */
85 #define MMPLAYER_FSINK_LOCK(x_player)                        g_mutex_lock(&((mm_player_t *)x_player)->fsink_lock)
86 #define MMPLAYER_FSINK_UNLOCK(x_player)                      g_mutex_unlock(&((mm_player_t *)x_player)->fsink_lock)
87
88 /* video stream bo */
89 #define MMPLAYER_VIDEO_BO_LOCK(x_player)                     g_mutex_lock(&((mm_player_t *)x_player)->video_bo_mutex)
90 #define MMPLAYER_VIDEO_BO_UNLOCK(x_player)                   g_mutex_unlock(&((mm_player_t *)x_player)->video_bo_mutex)
91 #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)
92 #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);
93 #define MMPLAYER_VIDEO_BO_SIGNAL(x_player)                   g_cond_signal(&((mm_player_t *)x_player)->video_bo_cond);
94
95 /* media stream lock */
96 #define MMPLAYER_MEDIA_STREAM_CALLBACK_LOCK(x_player)        g_mutex_lock(&((mm_player_t *)x_player)->media_stream_cb_lock)
97 #define MMPLAYER_MEDIA_STREAM_CALLBACK_UNLOCK(x_player)      g_mutex_unlock(&((mm_player_t *)x_player)->media_stream_cb_lock)
98
99 #if 0
100 #define MMPLAYER_FENTER();                                      LOGD("<ENTER>");
101 #define MMPLAYER_FLEAVE();                                      LOGD("<LEAVE>");
102 #else
103 #define MMPLAYER_FENTER();
104 #define MMPLAYER_FLEAVE();
105 #endif
106
107 #define MAX_SOUND_DEVICE_LEN    18
108
109 /* element linking */
110 #ifdef GST_EXT_PAD_LINK_UNCHECKED
111 #define GST_ELEMENT_LINK_FILTERED       gst_element_link_filtered_unchecked
112 #define GST_ELEMENT_LINK_MANY           gst_element_link_many_unchecked
113 #define GST_ELEMENT_LINK                        gst_element_link_unchecked
114 #define GST_ELEMENT_LINK_PADS           gst_element_link_pads_unchecked
115 #define GST_PAD_LINK                            gst_pad_link_unchecked
116 #else
117 #define GST_ELEMENT_LINK_FILTERED       gst_element_link_filtered
118 #define GST_ELEMENT_LINK_MANY           gst_element_link_many
119 #define GST_ELEMENT_LINK                        gst_element_link
120 #define GST_ELEMENT_UNLINK                      gst_element_unlink
121 #define GST_ELEMENT_LINK_PADS           gst_element_link_pads
122 #define GST_PAD_LINK                            gst_pad_link
123 #endif
124
125 #define MMPLAYER_RETURN_IF_FAIL(expr) \
126 if (!(expr)) { \
127         LOGW("faild [%s]", #expr); \
128         return; \
129 }
130
131 #define MMPLAYER_RETURN_VAL_IF_FAIL(expr, var) \
132 if (!(expr)) { \
133         LOGW("faild [%s]", #expr); \
134         return (var); \
135 }
136
137 /* debug caps string */
138 #define MMPLAYER_LOG_GST_CAPS_TYPE(x_caps) \
139 do { \
140         gchar* caps_type = NULL; \
141         caps_type = gst_caps_to_string(x_caps); \
142         LOGD("caps: %s\n", caps_type); \
143         MMPLAYER_FREEIF(caps_type) \
144 } while (0)
145
146 /* message posting */
147 #define MMPLAYER_POST_MSG(x_player, x_msgtype, x_msg_param) \
148 LOGD("posting %s to application\n", #x_msgtype); \
149 __mmplayer_post_message(x_player, x_msgtype, x_msg_param);
150
151 /* setting player state */
152 #define MMPLAYER_SET_STATE(x_player, x_state) \
153 LOGD("update state machine to %d\n", x_state); \
154 __mmplayer_set_state(x_player, x_state);
155
156 #define MMPLAYER_CHECK_STATE(x_player, x_command) \
157 LOGD("checking player state before doing %s\n", #x_command); \
158 switch (__mmplayer_check_state(x_player, x_command)) { \
159 case MM_ERROR_PLAYER_INVALID_STATE: \
160         return MM_ERROR_PLAYER_INVALID_STATE; \
161         break; \
162         /* NOTE : for robustness of player. we won't treat it as an error */ \
163 case MM_ERROR_PLAYER_NO_OP: \
164         return MM_ERROR_NONE; \
165         break; \
166 case MM_ERROR_PLAYER_DOING_SEEK: \
167         return MM_ERROR_PLAYER_DOING_SEEK; \
168 default: \
169         break; \
170 }
171
172 /* setting element state */
173 #define MMPLAYER_ELEMENT_SET_STATE(x_element, x_state) \
174 LOGD("setting state [%s:%d] to [%s]\n", #x_state, x_state, GST_ELEMENT_NAME(x_element)); \
175 if (GST_STATE_CHANGE_FAILURE == gst_element_set_state(x_element, x_state)) { \
176         LOGE("failed to set state %s to %s\n", #x_state, GST_ELEMENT_NAME(x_element)); \
177         goto STATE_CHANGE_FAILED; \
178 }
179
180 #define MMPLAYER_CHECK_NULL(x_var) \
181 if (!x_var) { \
182         LOGE("[%s] is NULL\n", #x_var); \
183         goto ERROR; \
184 }
185
186 #define MMPLAYER_CHECK_CMD_IF_EXIT(x_player) \
187 if (x_player->cmd == MMPLAYER_COMMAND_UNREALIZE || x_player->cmd == MMPLAYER_COMMAND_DESTROY) { \
188         LOGD("it's exit state...\n");\
189         goto ERROR;  \
190 }
191
192 /* generating dot */
193 #define MMPLAYER_GENERATE_DOT_IF_ENABLED(x_player, x_name) \
194 if (x_player->ini.generate_dot) { \
195         GST_DEBUG_BIN_TO_DOT_FILE(GST_BIN(player->pipeline->mainbin[MMPLAYER_M_PIPE].gst), \
196         GST_DEBUG_GRAPH_SHOW_ALL, x_name); \
197 }
198
199 /* signal manipulation */
200 #define MMPLAYER_SIGNAL_CONNECT(x_player, x_object, x_type, x_signal, x_callback, x_arg) \
201 do { \
202         MMPlayerSignalItem* item = NULL; \
203         item = (MMPlayerSignalItem*) g_malloc(sizeof(MMPlayerSignalItem)); \
204         if (!item) { \
205                 LOGE("cannot connect signal [%s]\n", x_signal); \
206         } else { \
207                 item->obj = G_OBJECT(x_object); \
208                 item->sig = g_signal_connect(G_OBJECT(x_object), x_signal, \
209                                         x_callback, x_arg); \
210                 if ((x_type >= MM_PLAYER_SIGNAL_TYPE_AUTOPLUG) && (x_type < MM_PLAYER_SIGNAL_TYPE_MAX)) \
211                         x_player->signals[x_type] = g_list_append(x_player->signals[x_type], item); \
212                 else \
213                         LOGE("wrong signal type [%d]\n", x_type); \
214         } \
215 } while (0);
216
217 /* release element resource */
218 #define MMPLAYER_RELEASE_ELEMENT(x_player, x_bin, x_id) \
219 do { \
220         if (x_bin[x_id].gst) { \
221                 gst_element_set_state(x_bin[x_id].gst, GST_STATE_NULL); \
222                 gst_bin_remove(GST_BIN(x_player->pipeline->mainbin[MMPLAYER_M_PIPE].gst), x_bin[x_id].gst); \
223                 x_bin[x_id].gst = NULL; \
224                 LOGD("release done [element %d]", x_id); \
225         } \
226 } while (0)
227
228 /* state */
229 #define MMPLAYER_PREV_STATE(x_player) ((mm_player_t*)x_player)->prev_state
230 #define MMPLAYER_CURRENT_STATE(x_player) ((mm_player_t*)x_player)->state
231 #define MMPLAYER_PENDING_STATE(x_player) ((mm_player_t*)x_player)->pending_state
232 #define MMPLAYER_TARGET_STATE(x_player) ((mm_player_t*)x_player)->target_state
233 #define MMPLAYER_STATE_GET_NAME(state) __get_state_name(state)
234
235 #define MMPLAYER_PRINT_STATE(x_player) \
236 LOGD("-- prev %s, current %s, pending %s, target %s --\n", \
237         MMPLAYER_STATE_GET_NAME(MMPLAYER_PREV_STATE(x_player)), \
238         MMPLAYER_STATE_GET_NAME(MMPLAYER_CURRENT_STATE(x_player)), \
239         MMPLAYER_STATE_GET_NAME(MMPLAYER_PENDING_STATE(x_player)), \
240         MMPLAYER_STATE_GET_NAME(MMPLAYER_TARGET_STATE(x_player)));
241
242 #define MMPLAYER_STATE_CHANGE_TIMEOUT(x_player)  ((mm_player_t*)x_player)->state_change_timeout
243
244 /* streaming */
245 #define MMPLAYER_IS_STREAMING(x_player) __is_streaming(x_player)
246 #define MMPLAYER_IS_RTSP_STREAMING(x_player) __is_rtsp_streaming(x_player)
247 #define MMPLAYER_IS_WFD_STREAMING(x_player) __is_wfd_streaming(x_player)
248 #define MMPLAYER_IS_HTTP_STREAMING(x_player) __is_http_streaming(x_player)
249 #define MMPLAYER_IS_HTTP_PD(x_player) __is_http_progressive_down(x_player)
250 #define MMPLAYER_IS_HTTP_LIVE_STREAMING(x_player) __is_http_live_streaming(x_player)
251 #define MMPLAYER_IS_LIVE_STREAMING(x_player) __is_live_streaming(x_player)
252 #define MMPLAYER_IS_DASH_STREAMING(x_player) __is_dash_streaming(x_player)
253 #define MMPLAYER_IS_SMOOTH_STREAMING(x_player) __is_smooth_streaming(x_player)
254 #define MMPLAYER_IS_MS_BUFF_SRC(x_player) __is_ms_buff_src(x_player)
255
256 #define MMPLAYER_URL_HAS_DASH_SUFFIX(x_player) __has_suffix(x_player, "mpd")
257 #define MMPLAYER_URL_HAS_HLS_SUFFIX(x_player) __has_suffix(x_player, "m3u8")
258
259 /* etc */
260 #define MMF_PLAYER_FILE_BACKUP_PATH "/tmp/media_temp."
261 #define MMPLAYER_PT_IS_AUDIO(x_pt) (strstr(x_pt, "_97") || strstr(x_pt, "audio"))
262 #define MMPLAYER_PT_IS_VIDEO(x_pt) (strstr(x_pt, "_96") || strstr(x_pt, "video"))
263
264 #define MMPLAYER_VIDEO_SINK_CHECK(x_player) \
265 do { \
266         MMPLAYER_RETURN_VAL_IF_FAIL(x_player && \
267                 x_player->pipeline && \
268                 x_player->pipeline->videobin && \
269                 x_player->pipeline->videobin[MMPLAYER_V_SINK].gst, \
270                 MM_ERROR_PLAYER_NOT_INITIALIZED); \
271 } while (0)
272
273 enum {
274         MMPLAYER_DISPLAY_NULL = 0,
275         MMPLAYER_DISPLAY_HDMI_ACTIVE,
276         MMPLAYER_DISPLAY_MIRRORING_ACTIVE,
277 };
278
279 bool util_is_sdp_file(const char *path);
280 int util_get_rank_increase(const char *factory_class);
281 int util_factory_rank_compare(GstPluginFeature *f1, GstPluginFeature *f2); // @
282 int util_exist_file_path(const char *file_path);
283 bool util_write_file_backup(const char *backup_path, char *data_ptr, int data_size);
284 bool util_remove_file_backup(const char *backup_path); /* For Midi Player */
285 int util_is_midi_type_by_mem(void *mem, int size);
286 int util_is_midi_type_by_file(const char *file_path);
287 char** util_get_cookie_list(const char *cookies);
288 bool util_check_valid_url(const char *proxy);
289 const char* util_get_charset(const char *file_path);
290 int util_get_pixtype(unsigned int fourcc);
291
292 #ifdef __cplusplus
293         }
294 #endif
295
296 #endif /* __MM_PLAYER_UTILS_H__ */
297