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