clean up for 2.0 beta
[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>, YoungHwan An <younghwan_.an@samsung.com>
7  *
8  * Licensed under the Apache License, Version 2.0 (the "License");
9  * you may not use this file except in compliance with the License.
10  * You may obtain a copy of the License at
11  *
12  * http://www.apache.org/licenses/LICENSE-2.0
13  *
14  * Unless required by applicable law or agreed to in writing, software
15  * distributed under the License is distributed on an "AS IS" BASIS,
16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17  * See the License for the specific language governing permissions and
18  * limitations under the License.
19  *
20  */
21
22 #ifndef __MMF_PLAYER_UTILS_H__
23 #define __MMF_PLAYER_UTILS_H__
24
25 #include <glib.h>
26 #include <gst/gst.h>
27 #include <mm_player_ini.h>
28 #include <mm_types.h>
29 #include <mm_error.h>
30 #include <mm_message.h>
31
32 #ifdef __cplusplus
33         extern "C" {
34 #endif
35
36 /* general */
37 #ifndef ARRAY_SIZE
38 #define ARRAY_SIZE(arr)         (sizeof(arr) / sizeof((arr)[0]))
39 #endif
40
41 #define MMPLAYER_MAX_INT        (2147483647)
42
43 #define MMPLAYER_FREEIF(x) \
44 if ( x ) \
45         g_free( x ); \
46 x = NULL;
47
48 #define MMPLAYER_CMD_LOCK(x_player) \
49 do \
50 { \
51         GMutex* cmd_lock = ((mm_player_t *)x_player)->cmd_lock; \
52         if (cmd_lock) \
53                 g_mutex_lock(cmd_lock); \
54         else \
55         { \
56                 debug_log("don't get command lock"); \
57                 return MM_ERROR_PLAYER_NOT_INITIALIZED; \
58         } \
59 } while (0);
60
61 #define MMPLAYER_CMD_UNLOCK(x_player)   g_mutex_unlock( ((mm_player_t*)x_player)->cmd_lock )
62
63 #define MMPLAYER_MSG_POST_LOCK(x_player)        g_mutex_lock( ((mm_player_t*)x_player)->msg_cb_lock )
64 #define MMPLAYER_MSG_POST_UNLOCK(x_player)      g_mutex_unlock( ((mm_player_t*)x_player)->msg_cb_lock )
65
66 #define MMPLAYER_GET_ATTRS(x_player)            ((mm_player_t*)x_player)->attrs
67
68 /* sbs : for bluetooth */
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_LINK_PADS           gst_element_link_pads
83 #define GST_PAD_LINK                            gst_pad_link
84 #endif
85
86 /* debug caps string */
87 #define MMPLAYER_LOG_GST_CAPS_TYPE(x_caps) \
88 do \
89 { \
90         gchar* caps_type = NULL; \
91         caps_type = gst_caps_to_string(x_caps); \
92         debug_log ("caps: %s\n", caps_type ); \
93         MMPLAYER_FREEIF (caps_type) \
94 } while (0);
95
96 /* message posting */
97 #define MMPLAYER_POST_MSG( x_player, x_msgtype, x_msg_param ) \
98 debug_log("posting %s to application\n", #x_msgtype); \
99 __mmplayer_post_message(x_player, x_msgtype, x_msg_param);
100
101 /* setting player state */
102 #define MMPLAYER_SET_STATE( x_player, x_state ) \
103 debug_log("setting player state to %d\n", x_state); \
104 __mmplayer_set_state(x_player, x_state);
105
106
107 #define MMPLAYER_CHECK_STATE_RETURN_IF_FAIL( x_player, x_command ) \
108 debug_log("checking player state before doing %s\n", #x_command); \
109 switch ( __mmplayer_check_state(x_player, x_command) ) \
110 { \
111         case MM_ERROR_PLAYER_INVALID_STATE: \
112                 return MM_ERROR_PLAYER_INVALID_STATE; \
113         break; \
114         /* NOTE : for robustness of player. we won't treat it as an error */ \
115         case MM_ERROR_PLAYER_NO_OP: \
116                 return MM_ERROR_NONE; \
117         break; \
118         default: \
119         break; \
120 }
121
122 /* setting element state */ 
123 #define MMPLAYER_ELEMENT_SET_STATE( x_element, x_state ) \
124 debug_log("setting state [%s:%d] to [%s]\n", #x_state, x_state, GST_ELEMENT_NAME( x_element ) ); \
125 if ( GST_STATE_CHANGE_FAILURE == gst_element_set_state ( x_element, x_state) ) \
126 { \
127         debug_error("failed to set state %s to %s\n", #x_state, GST_ELEMENT_NAME( x_element )); \
128         goto STATE_CHANGE_FAILED; \
129 }
130
131 #define MMPLAYER_CHECK_NULL( x_var ) \
132 if ( ! x_var ) \
133 { \
134         debug_error("[%s] is NULL\n", #x_var ); \
135         goto ERROR; \
136 }
137
138 #define MMPLAYER_CHECK_CMD_IF_EXIT( x_player ) \
139 if ( x_player->cmd == MMPLAYER_COMMAND_UNREALIZE || x_player->cmd == MMPLAYER_COMMAND_DESTROY ) \
140 { \
141         debug_log("it's exit state...\n");\
142         goto ERROR;  \
143 }
144 /* volume */
145 /* 
146 |----|-------|-------|-------|-------|
147 |Res. | HFK(7)  |  BT(7)  |  E.J(7)  | SPK(7) |
148 |----|-------|-------|-------|-------|
149 */
150
151 /* 090424 Fix me : Currently volume is 0~9, so bt volume can be only 0.0 ~ 0.9 */
152 #define GET_VOLUME_BT(volume) (volume/10.)
153
154 #if 0
155 #define GET_VOLUME_SPK(volume) ((volume) & 0x7F)
156 #define GET_VOLUME_EARJACK(volume) ((volume >> 7)& 0x7F)
157 #define GET_VOLUME_HFK(volume) ((volume >> 21) & 0x7F)
158
159 #define SET_VOLUME_SPK(volume,input) (volume |= (input &0x7F))
160 #define SET_VOLUME_EARJACK(volume,input) (volume |= ((input & 0x7F)<<7))
161 #define SET_VOLUME_BT(volume,input) (volume |= ((input & 0x7F)<<14))
162 #define SET_VOLUME_HFK(volume,input) (volume |= ((input & 0x7F)<<21))
163 #endif
164
165
166 /* pad probe for pipeilne debugging */
167 gboolean __util_gst_pad_probe(GstPad *pad, GstBuffer *buffer, gpointer u_data);
168
169 #define MM_PROBE_DEFAULT                        (0)
170 #define MM_PROBE_TIMESTAMP                      (1)
171 #define MM_PROBE_BUFFERSIZE                     (1 << 1)
172 #define MM_PROBE_CAPS                           (1 << 2)
173 #define MM_PROBE_BUFFER_DURATION        (1 << 3)
174 #define MM_PROBE_DROP_BUFFER            (1 << 4)
175 #define MM_PROBE_CLOCK_TIME                     (1 << 5)
176 /* ... add more */
177
178 /* messages are treated as warnings bcz those code should not be checked in. 
179  * and no error handling will supported for same manner. 
180  */
181 #define MMPLAYER_ADD_PROBE(x_pad, x_flag) \
182 debug_warning("adding pad probe\n"); \
183 if ( ! gst_pad_add_buffer_probe(x_pad, \
184         G_CALLBACK(__util_gst_pad_probe), \
185         (gpointer)x_flag) ) \
186 { \
187         debug_error("failed to add pad probe\n"); \
188 }
189
190
191 /* generating dot */
192 #define MMPLAYER_GENERATE_DOT_IF_ENABLED( x_player, x_name ) \
193 if ( PLAYER_INI()->generate_dot ) \
194 { \
195         debug_log("generating dot file(%s)\n", #x_name); \
196         GST_DEBUG_BIN_TO_DOT_FILE (GST_BIN (player->pipeline->mainbin[MMPLAYER_M_PIPE].gst), \
197         GST_DEBUG_GRAPH_SHOW_ALL, x_name); \
198 }
199
200 /* signal manipulation */
201 #define MMPLAYER_SIGNAL_CONNECT( x_player, x_object, x_signal, x_callback, x_arg ) \
202 do \
203 { \
204         MMPlayerSignalItem* item = NULL; \
205         item = (MMPlayerSignalItem*) g_malloc( sizeof (MMPlayerSignalItem) ); \
206         if ( ! item ) \
207         { \
208                 debug_error("cannot connect signal [%s]\n", x_signal ); \
209         } \
210         else \
211         { \
212                 item->obj = G_OBJECT( x_object ); \
213                 item->sig = g_signal_connect( G_OBJECT(x_object), x_signal, \
214                                         x_callback, x_arg ); \
215                 x_player->signals = g_list_append(x_player->signals, item); \
216         } \
217 } while ( 0 );
218
219
220 /* state */
221 #define MMPLAYER_PREV_STATE(x_player)           ((mm_player_t*)x_player)->prev_state 
222 #define MMPLAYER_CURRENT_STATE(x_player)                ((mm_player_t*)x_player)->state 
223 #define         MMPLAYER_PENDING_STATE(x_player)                ((mm_player_t*)x_player)->pending_state 
224 #define         MMPLAYER_TARGET_STATE(x_player)         ((mm_player_t*)x_player)->target_state 
225 #define         MMPLAYER_STATE_GET_NAME(state) __get_state_name(state)
226
227 #define         MMPLAYER_PRINT_STATE(x_player) \
228 debug_log("-----------------------PLAYER STATE-------------------------\n"); \
229 debug_log(" prev %s, current %s, pending %s, target %s \n", \
230         MMPLAYER_STATE_GET_NAME(MMPLAYER_PREV_STATE(x_player)), \
231         MMPLAYER_STATE_GET_NAME(MMPLAYER_CURRENT_STATE(x_player)), \
232         MMPLAYER_STATE_GET_NAME(MMPLAYER_PENDING_STATE(x_player)), \
233         MMPLAYER_STATE_GET_NAME(MMPLAYER_TARGET_STATE(x_player))); \
234 debug_log("------------------------------------------------------------\n"); 
235
236
237 #define         MMPLAYER_STATE_CHANGE_TIMEOUT(x_player )         ((mm_player_t*)x_player)->state_change_timeout 
238
239 /* streaming */
240 #define MMPLAYER_IS_STREAMING(x_player)                         __is_streaming(x_player)
241 #define MMPLAYER_IS_RTSP_STREAMING(x_player)    __is_rtsp_streaming(x_player)
242 #define MMPLAYER_IS_HTTP_STREAMING(x_player)    __is_http_streaming(x_player)
243 #define MMPLAYER_IS_HTTP_PD(x_player)                   __is_http_progressive_down(x_player)
244 #define MMPLAYER_IS_HTTP_LIVE_STREAMING(x_player)  __is_http_live_streaming(x_player)
245 #define MMPLAYER_IS_LIVE_STREAMING(x_player)    __is_live_streaming(x_player)
246
247 /* etc */
248 #define MMF_PLAYER_FILE_BACKUP_PATH             "/tmp/media_temp."
249 #define         MMPLAYER_PT_IS_AUDIO( x_pt )            ( strstr(x_pt, "_97") || strstr(x_pt, "audio") )
250 #define         MMPLAYER_PT_IS_VIDEO( x_pt )            ( strstr(x_pt, "_96") || strstr(x_pt, "video") )
251
252 bool util_is_sdp_file ( const char *path );
253 int64_t uti_get_time ( void );
254 int util_get_rank_increase ( const char *factory_class );
255 int util_factory_rank_compare(GstPluginFeature *f1, GstPluginFeature *f2); // @
256
257
258 bool util_exist_file_path(const char *file_path);
259 bool util_write_file_backup(const char *backup_path, char *data_ptr, int data_size);
260 bool util_remove_file_backup(const char *backup_path); /* For Midi Player */
261
262 int util_is_midi_type_by_mem(void *mem, int size);
263 int util_is_midi_type_by_file(const char *file_path);
264
265 char** util_get_cookie_list ( const char *cookies );
266 bool util_check_valid_url ( const char *proxy );
267
268 #ifdef __cplusplus
269         }
270 #endif
271
272 #endif /* __MMF_PLAYER_UTILS_H__ */
273