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