LIBVLC_USED: tag for function whose result must be used
[vlc.git] / include / vlc_common.h
1 /*****************************************************************************
2  * common.h: common definitions
3  * Collection of useful common types and macros definitions
4  *****************************************************************************
5  * Copyright (C) 1998-2005 the VideoLAN team
6  * $Id$
7  *
8  * Authors: Samuel Hocevar <sam@via.ecp.fr>
9  *          Vincent Seguin <seguin@via.ecp.fr>
10  *          Gildas Bazin <gbazin@videolan.org>
11  *
12  * This program is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation; either version 2 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25  *****************************************************************************/
26
27 /**
28  * \file
29  * This file is a collection of common definitions and types
30  */
31
32 #ifndef VLC_COMMON_H
33 # define VLC_COMMON_H 1
34
35 /*****************************************************************************
36  * Required vlc headers
37  *****************************************************************************/
38 #if defined( _MSC_VER )
39 #   pragma warning( disable : 4244 )
40 #endif
41
42 #include "vlc_config.h"
43
44 /*****************************************************************************
45  * Required system headers
46  *****************************************************************************/
47 #include <stdlib.h>
48 #include <stdarg.h>
49
50 #include <string.h>
51 #include <stdio.h>
52 #include <inttypes.h>
53
54 #ifndef __cplusplus
55 # include <stdbool.h>
56 #endif
57
58 /* Format string sanity checks */
59 #ifdef __GNUC__
60 #   define LIBVLC_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
61 #   define LIBVLC_USED __attribute__ ((warn_unused_result))
62 #else
63 #   define LIBVLC_FORMAT(x,y)
64 #   define LIBVLC_USED
65 #endif
66
67 /*****************************************************************************
68  * Basic types definitions
69  *****************************************************************************/
70 #if defined( WIN32 ) || defined( UNDER_CE )
71 #   include <malloc.h>
72 #   ifndef PATH_MAX
73 #       define PATH_MAX MAX_PATH
74 #   endif
75 #endif
76
77 /* Counter for statistics and profiling */
78 typedef unsigned long       count_t;
79
80 /* Audio volume */
81 typedef uint16_t            audio_volume_t;
82
83 /**
84  * High precision date or time interval
85  *
86  * Store a high precision date or time interval. The maximum precision is the
87  * microsecond, and a 64 bits integer is used to avoid overflows (maximum
88  * time interval is then 292271 years, which should be long enough for any
89  * video). Dates are stored as microseconds since a common date (usually the
90  * epoch). Note that date and time intervals can be manipulated using regular
91  * arithmetic operators, and that no special functions are required.
92  */
93 typedef int64_t mtime_t;
94
95 /**
96  * The vlc_fourcc_t type.
97  *
98  * See http://www.webartz.com/fourcc/ for a very detailed list.
99  */
100 typedef uint32_t vlc_fourcc_t;
101
102 #ifdef WORDS_BIGENDIAN
103 #   define VLC_FOURCC( a, b, c, d ) \
104         ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
105            | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
106 #   define VLC_TWOCC( a, b ) \
107         ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )
108
109 #else
110 #   define VLC_FOURCC( a, b, c, d ) \
111         ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
112            | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
113 #   define VLC_TWOCC( a, b ) \
114         ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )
115
116 #endif
117
118 /**
119  * Translate a vlc_fourcc into its string representation. This function
120  * assumes there is enough room in psz_fourcc to store 4 characters in.
121  *
122  * \param fcc a vlc_fourcc_t
123  * \param psz_fourcc string to store string representation of vlc_fourcc in
124  */
125 static inline void __vlc_fourcc_to_char( vlc_fourcc_t fcc, char *psz_fourcc )
126 {
127     memcpy( psz_fourcc, &fcc, 4 );
128 }
129
130 #define vlc_fourcc_to_char( a, b ) \
131     __vlc_fourcc_to_char( (vlc_fourcc_t)(a), (char *)(b) )
132
133 /*****************************************************************************
134  * Classes declaration
135  *****************************************************************************/
136
137 /* Internal types */
138 typedef struct vlc_list_t vlc_list_t;
139 typedef struct vlc_object_t vlc_object_t;
140 typedef struct libvlc_int_t libvlc_int_t;
141 typedef struct variable_t variable_t;
142 typedef struct date_t date_t;
143 typedef struct dict_entry_t dict_entry_t;
144 typedef struct dict_t dict_t;
145 typedef struct gc_object_t gc_object_t ;
146
147 /* Messages */
148 typedef struct msg_subscription_t msg_subscription_t;
149
150 /* Playlist */
151
152 /* FIXME */
153 /**
154  * Playlist commands
155  */
156 typedef enum {
157     PLAYLIST_PLAY,      /**< No arg.                            res=can fail*/
158     PLAYLIST_VIEWPLAY,  /**< arg1= playlist_item_t*,*/
159                         /**  arg2 = playlist_item_t*          , res=can fail */
160     PLAYLIST_PAUSE,     /**< No arg                             res=can fail*/
161     PLAYLIST_STOP,      /**< No arg                             res=can fail*/
162     PLAYLIST_SKIP,      /**< arg1=int,                          res=can fail*/
163 } playlist_command_t;
164
165
166 typedef struct playlist_t playlist_t;
167 typedef struct playlist_item_t playlist_item_t;
168 typedef struct playlist_view_t playlist_view_t;
169 typedef struct playlist_export_t playlist_export_t;
170 typedef struct services_discovery_t services_discovery_t;
171 typedef struct services_discovery_sys_t services_discovery_sys_t;
172 typedef struct playlist_add_t playlist_add_t;
173 typedef struct playlist_preparse_t playlist_preparse_t;
174 typedef struct playlist_fetcher_t playlist_fetcher_t;
175
176 /* Modules */
177 typedef struct module_bank_t module_bank_t;
178 typedef struct module_t module_t;
179 typedef struct module_config_t module_config_t;
180 typedef struct module_symbols_t module_symbols_t;
181 typedef struct module_cache_t module_cache_t;
182
183 typedef struct config_category_t config_category_t;
184
185 /* Interface */
186 typedef struct intf_thread_t intf_thread_t;
187 typedef struct intf_sys_t intf_sys_t;
188 typedef struct intf_console_t intf_console_t;
189 typedef struct intf_msg_t intf_msg_t;
190 typedef struct interaction_t interaction_t;
191 typedef struct interaction_dialog_t interaction_dialog_t;
192 typedef struct user_widget_t user_widget_t;
193
194 /* Input */
195 typedef struct input_thread_t input_thread_t;
196 typedef struct input_thread_sys_t input_thread_sys_t;
197 typedef struct input_item_t input_item_t;
198 typedef struct access_t access_t;
199 typedef struct access_sys_t access_sys_t;
200 typedef struct stream_t     stream_t;
201 typedef struct stream_sys_t stream_sys_t;
202 typedef struct demux_t  demux_t;
203 typedef struct demux_meta_t demux_meta_t;
204 typedef struct demux_sys_t demux_sys_t;
205 typedef struct es_out_t     es_out_t;
206 typedef struct es_out_id_t  es_out_id_t;
207 typedef struct es_out_sys_t es_out_sys_t;
208 typedef struct es_descriptor_t es_descriptor_t;
209 typedef struct seekpoint_t seekpoint_t;
210 typedef struct info_t info_t;
211 typedef struct info_category_t info_category_t;
212 typedef struct input_attachment_t input_attachment_t;
213
214 /* Format */
215 typedef struct audio_format_t audio_format_t;
216 typedef struct video_format_t video_format_t;
217 typedef struct subs_format_t subs_format_t;
218 typedef struct es_format_t es_format_t;
219 typedef struct video_palette_t video_palette_t;
220
221 /* Audio */
222 typedef struct aout_instance_t aout_instance_t;
223 typedef struct aout_sys_t aout_sys_t;
224 typedef struct aout_fifo_t aout_fifo_t;
225 typedef struct aout_input_t aout_input_t;
226 typedef struct aout_buffer_t aout_buffer_t;
227 typedef audio_format_t audio_sample_format_t;
228 typedef struct audio_date_t audio_date_t;
229 typedef struct aout_filter_t aout_filter_t;
230
231 /* Video */
232 typedef struct vout_thread_t vout_thread_t;
233 typedef struct vout_sys_t vout_sys_t;
234
235 typedef video_format_t video_frame_format_t;
236 typedef struct picture_t picture_t;
237 typedef struct picture_sys_t picture_sys_t;
238 typedef struct picture_heap_t picture_heap_t;
239
240 /* Subpictures */
241 typedef struct spu_t spu_t;
242 typedef struct subpicture_t subpicture_t;
243 typedef struct subpicture_sys_t subpicture_sys_t;
244 typedef struct subpicture_region_t subpicture_region_t;
245 typedef struct text_style_t text_style_t;
246
247 typedef struct image_handler_t image_handler_t;
248
249 /* Stream output */
250 typedef struct sout_instance_t sout_instance_t;
251 typedef struct sout_instance_sys_t sout_instance_sys_t;
252
253 typedef struct sout_input_t sout_input_t;
254 typedef struct sout_packetizer_input_t sout_packetizer_input_t;
255
256 typedef struct sout_access_out_t sout_access_out_t;
257 typedef struct sout_access_out_sys_t   sout_access_out_sys_t;
258
259 typedef struct sout_mux_t sout_mux_t;
260 typedef struct sout_mux_sys_t sout_mux_sys_t;
261
262 typedef struct sout_stream_t    sout_stream_t;
263 typedef struct sout_stream_sys_t sout_stream_sys_t;
264
265 typedef struct config_chain_t       config_chain_t;
266 typedef struct sap_session_t    sap_session_t;
267 typedef struct sap_address_t sap_address_t;
268 typedef struct session_descriptor_t session_descriptor_t;
269 typedef struct announce_method_t announce_method_t;
270 typedef struct announce_handler_t announce_handler_t;
271 typedef struct sap_handler_t sap_handler_t;
272
273 typedef struct sout_param_t sout_param_t;
274 typedef struct sout_pcat_t sout_pcat_t;
275 typedef struct sout_std_t sout_std_t;
276 typedef struct sout_display_t sout_display_t;
277 typedef struct sout_duplicate_t sout_duplicate_t;
278 typedef struct sout_transcode_t sout_transcode_t;
279 typedef struct sout_chain_t sout_chain_t;
280 typedef struct streaming_profile_t streaming_profile_t;
281 typedef struct sout_module_t sout_module_t;
282 typedef struct sout_gui_descr_t sout_gui_descr_t;
283 typedef struct profile_parser_t profile_parser_t;
284
285 /* Decoders */
286 typedef struct decoder_t         decoder_t;
287 typedef struct decoder_sys_t     decoder_sys_t;
288 typedef struct decoder_synchro_t decoder_synchro_t;
289
290 /* Encoders */
291 typedef struct encoder_t      encoder_t;
292 typedef struct encoder_sys_t  encoder_sys_t;
293
294 /* Filters */
295 typedef struct filter_t filter_t;
296 typedef struct filter_sys_t filter_sys_t;
297
298 /* Network */
299 typedef struct network_socket_t network_socket_t;
300 typedef struct virtual_socket_t v_socket_t;
301 typedef struct sockaddr sockaddr;
302 typedef struct addrinfo addrinfo;
303 typedef struct vlc_acl_t vlc_acl_t;
304 typedef struct vlc_url_t vlc_url_t;
305
306 /* Misc */
307 typedef struct iso639_lang_t iso639_lang_t;
308 typedef struct device_t device_t;
309 typedef struct device_probe_t device_probe_t;
310 typedef struct probe_sys_t probe_sys_t;
311
312 /* block */
313 typedef struct block_t      block_t;
314 typedef struct block_fifo_t block_fifo_t;
315
316 /* httpd */
317 typedef struct httpd_t          httpd_t;
318 typedef struct httpd_host_t     httpd_host_t;
319 typedef struct httpd_url_t      httpd_url_t;
320 typedef struct httpd_client_t   httpd_client_t;
321 typedef struct httpd_callback_sys_t httpd_callback_sys_t;
322 typedef struct httpd_message_t  httpd_message_t;
323 typedef int    (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, const httpd_message_t *query );
324 typedef struct httpd_file_t     httpd_file_t;
325 typedef struct httpd_file_sys_t httpd_file_sys_t;
326 typedef int (*httpd_file_callback_t)( httpd_file_sys_t *, httpd_file_t *, uint8_t *psz_request, uint8_t **pp_data, int *pi_data );
327 typedef struct httpd_handler_t  httpd_handler_t;
328 typedef struct httpd_handler_sys_t httpd_handler_sys_t;
329 typedef int (*httpd_handler_callback_t)( httpd_handler_sys_t *, httpd_handler_t *, char *psz_url, uint8_t *psz_request, int i_type, uint8_t *p_in, int i_in, char *psz_remote_addr, char *psz_remote_host, uint8_t **pp_data, int *pi_data );
330 typedef struct httpd_redirect_t httpd_redirect_t;
331 typedef struct httpd_stream_t httpd_stream_t;
332
333 /* TLS support */
334 typedef struct tls_server_t tls_server_t;
335 typedef struct tls_session_t tls_session_t;
336
337 /* Hashing */
338 typedef struct md5_s md5_t;
339
340 /* XML */
341 typedef struct xml_t xml_t;
342 typedef struct xml_sys_t xml_sys_t;
343 typedef struct xml_reader_t xml_reader_t;
344 typedef struct xml_reader_sys_t xml_reader_sys_t;
345
346 /* vod server */
347 typedef struct vod_t     vod_t;
348 typedef struct vod_sys_t vod_sys_t;
349 typedef struct vod_media_t vod_media_t;
350
351 /* opengl */
352 typedef struct opengl_t     opengl_t;
353 typedef struct opengl_sys_t opengl_sys_t;
354
355 /* osdmenu */
356 typedef struct osd_menu_t   osd_menu_t;
357 typedef struct osd_state_t  osd_state_t;
358 typedef struct osd_event_t  osd_event_t;
359 typedef struct osd_button_t osd_button_t;
360 typedef struct osd_menu_state_t osd_menu_state_t;
361
362 /* VLM */
363 typedef struct vlm_t         vlm_t;
364 typedef struct vlm_message_t vlm_message_t;
365
366 /* divers */
367 typedef struct vlc_meta_t    vlc_meta_t;
368 typedef struct meta_export_t meta_export_t;
369
370 /* Stats */
371 typedef struct counter_t     counter_t;
372 typedef struct counter_sample_t counter_sample_t;
373 typedef struct stats_handler_t stats_handler_t;
374 typedef struct input_stats_t input_stats_t;
375 typedef struct global_stats_t global_stats_t;
376
377 /* Update */
378 typedef struct update_t update_t;
379 typedef struct update_iterator_t update_iterator_t;
380
381 /* Meta engine */
382 typedef struct meta_engine_t meta_engine_t;
383
384 /* stat/lstat/fstat */
385 #ifdef WIN32
386 #include <sys/stat.h>
387 struct _stati64;
388 #define stat _stati64
389 #define fstat _fstati64
390 /* You should otherwise use utf8_stat and utf8_lstat. */
391 #else
392 struct stat;
393 #endif
394
395 /**
396  * VLC value structure
397  */
398 typedef union
399 {
400     int             i_int;
401     bool            b_bool;
402     float           f_float;
403     char *          psz_string;
404     void *          p_address;
405     vlc_object_t *  p_object;
406     vlc_list_t *    p_list;
407     mtime_t         i_time;
408
409     struct { char *psz_name; int i_object_id; } var;
410
411    /* Make sure the structure is at least 64bits */
412     struct { char a, b, c, d, e, f, g, h; } padding;
413
414 } vlc_value_t;
415
416 /**
417  * VLC list structure
418  */
419 struct vlc_list_t
420 {
421     int             i_count;
422     vlc_value_t *   p_values;
423     int *           pi_types;
424
425 };
426
427 /**
428  * \defgroup var_type Variable types
429  * These are the different types a vlc variable can have.
430  * @{
431  */
432 #define VLC_VAR_VOID      0x0010
433 #define VLC_VAR_BOOL      0x0020
434 #define VLC_VAR_INTEGER   0x0030
435 #define VLC_VAR_HOTKEY    0x0031
436 #define VLC_VAR_STRING    0x0040
437 #define VLC_VAR_MODULE    0x0041
438 #define VLC_VAR_FILE      0x0042
439 #define VLC_VAR_DIRECTORY 0x0043
440 #define VLC_VAR_VARIABLE  0x0044
441 #define VLC_VAR_FLOAT     0x0050
442 #define VLC_VAR_TIME      0x0060
443 #define VLC_VAR_ADDRESS   0x0070
444 #define VLC_VAR_MUTEX     0x0080
445 #define VLC_VAR_LIST      0x0090
446 /**@}*/
447
448 /*****************************************************************************
449  * Error values (shouldn't be exposed)
450  *****************************************************************************/
451 #define VLC_SUCCESS         -0                                   /* No error */
452 #define VLC_ENOMEM          -1                          /* Not enough memory */
453 #define VLC_ETHREAD         -2                               /* Thread error */
454 #define VLC_ETIMEOUT        -3                                    /* Timeout */
455
456 #define VLC_ENOMOD         -10                           /* Module not found */
457
458 #define VLC_ENOOBJ         -20                           /* Object not found */
459
460 #define VLC_ENOVAR         -30                         /* Variable not found */
461 #define VLC_EBADVAR        -31                         /* Bad variable value */
462
463 #define VLC_ENOITEM        -40                           /**< Item not found */
464
465 #define VLC_EEXIT         -255                             /* Program exited */
466 #define VLC_EEXITSUCCESS  -999                /* Program exited successfully */
467 #define VLC_EGENERIC      -666                              /* Generic error */
468
469 /*****************************************************************************
470  * Variable callbacks
471  *****************************************************************************/
472 typedef int ( * vlc_callback_t ) ( vlc_object_t *,      /* variable's object */
473                                    char const *,            /* variable name */
474                                    vlc_value_t,                 /* old value */
475                                    vlc_value_t,                 /* new value */
476                                    void * );                /* callback data */
477
478 /*****************************************************************************
479  * Plug-in stuff
480  *****************************************************************************/
481
482 #ifdef __cplusplus
483 # define LIBVLC_EXTERN extern "C"
484 #else
485 # define LIBVLC_EXTERN extern
486 #endif
487 #if defined (WIN32) && defined (DLL_EXPORT)
488 # define LIBVLC_EXPORT __declspec(dllexport)
489 #else
490 # define LIBVLC_EXPORT
491 #endif
492 #define VLC_EXPORT( type, name, args ) \
493                         LIBVLC_EXTERN LIBVLC_EXPORT type name args
494
495 /*****************************************************************************
496  * OS-specific headers and thread types
497  *****************************************************************************/
498 #if defined( WIN32 ) || defined( UNDER_CE )
499 #   define WIN32_LEAN_AND_MEAN
500 #   include <windows.h>
501 #   if defined( UNDER_CE )
502 #      define IS_WINNT 0
503 #   else
504 #      define IS_WINNT ( GetVersion() < 0x80000000 )
505 #   endif
506 #endif
507
508 #include "vlc_mtime.h"
509 #include "vlc_threads.h"
510
511 typedef struct vlc_object_internals_t vlc_object_internals_t;
512
513 /*****************************************************************************
514  * Common structure members
515  *****************************************************************************/
516
517 /* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
518 #define VLC_COMMON_MEMBERS                                                  \
519 /** \name VLC_COMMON_MEMBERS                                                \
520  * these members are common for all vlc objects                             \
521  */                                                                         \
522 /**@{*/                                                                     \
523     int   i_object_id;                                                      \
524     int   i_object_type;                                                    \
525     const char *psz_object_type;                                            \
526     char *psz_object_name;                                                  \
527                                                                             \
528     /* Messages header */                                                   \
529     char *psz_header;                                                       \
530     int  i_flags;                                                           \
531                                                                             \
532     /* Object properties */                                                 \
533     volatile bool b_error;                  /**< set by the object */ \
534     volatile bool b_die;                   /**< set by the outside */ \
535     volatile bool b_dead;                   /**< set by the object */ \
536     bool b_force;      /**< set by the outside (eg. module_Need()) */ \
537                                                                             \
538     /* Stuff related to the libvlc structure */                             \
539     libvlc_int_t *p_libvlc;                  /**< (root of all evil) - 1 */ \
540                                                                             \
541     vlc_object_t *  p_parent;                            /**< our parent */ \
542                                                                             \
543     /* Private data */                                                      \
544     void *          p_private;                                              \
545                                                                             \
546     /** Just a reminder so that people don't cast garbage */                \
547     int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct;                        \
548 /**@}*/                                                                     \
549
550 /* VLC_OBJECT: attempt at doing a clever cast */
551 #ifdef __GNUC__
552 # define VLC_OBJECT( x ) \
553     (((vlc_object_t *)(x))+0*(((typeof(x))0)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct))
554 #else
555 # define VLC_OBJECT( x ) ((vlc_object_t *)(x))
556 #endif
557
558 #define VLC_GC_MEMBERS                                                       \
559 /** \name VLC_GC_MEMBERS                                                     \
560  * these members are common to all objects that wish to be garbage-collected \
561  */                                                                          \
562 /**@{*/                                                                      \
563     int i_gc_refcount;                                                       \
564     void (*pf_destructor) ( gc_object_t * );                                 \
565     void *p_destructor_arg;                                                  \
566 /**@}*/
567
568 struct gc_object_t
569 {
570     VLC_GC_MEMBERS
571 };
572
573 VLC_EXPORT(void, __vlc_gc_incref, ( gc_object_t * p_gc ));
574 VLC_EXPORT(void, __vlc_gc_decref, ( gc_object_t * p_gc ));
575 VLC_EXPORT(void, __vlc_gc_init, ( gc_object_t * p_gc,
576     void (*pf_destructor)( gc_object_t * ), void * arg));
577
578 #define vlc_gc_incref( a ) __vlc_gc_incref( (gc_object_t *)a )
579 #define vlc_gc_decref( a ) __vlc_gc_decref( (gc_object_t *)a )
580 #define vlc_gc_init( a,b,c ) __vlc_gc_init( (gc_object_t *)a,b,c )
581
582
583 /*****************************************************************************
584  * Macros and inline functions
585  *****************************************************************************/
586
587 /* CEIL: division with round to nearest greater integer */
588 #define CEIL(n, d)  ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
589
590 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
591 #define PAD(n, d)   ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
592
593 /* __MAX and __MIN: self explanatory */
594 #ifndef __MAX
595 #   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
596 #endif
597 #ifndef __MIN
598 #   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
599 #endif
600
601 static inline int64_t GCD( int64_t a, int64_t b )
602 {
603     while( b )
604     {
605         int64_t c = a % b;
606         a = b;
607         b = c;
608     }
609     return a;
610 }
611
612 /* function imported from libavutil/common.h */
613 static inline uint8_t clip_uint8_vlc( int32_t a )
614 {
615     if( a&(~255) ) return (-a)>>31;
616     else           return a;
617 }
618
619 /* Malloc with automatic error */
620 #define MALLOC_VOID( var, type ) do { var = (type*)malloc( sizeof( type) ); \
621                                    if( !var ) return; } while(0)
622 #define MALLOC_NULL( var, type ) do { var = (type*)malloc( sizeof( type) ); \
623                                    if( !var ) return NULL; } while(0)
624 #define MALLOC_ERR( var, type ) do { var = (type*)malloc( sizeof( type) ); \
625                                    if( !var ) return VLC_ENOMEM; } while(0)
626 #define MALLOC_GOTOERR( var, type ) do { var = (type*)malloc( sizeof( type) ); \
627                                       if( !var ) goto error; } while(0)
628 #define DECMALLOC_VOID( var, type ) type* var = (type*)malloc( sizeof(type) );\
629                                     if( !var ) return;
630 #define DECMALLOC_ERR( var, type )  type* var = (type*)malloc( sizeof(type) );\
631                                     if( !var ) return VLC_ENOMEM;
632 #define DECMALLOC_NULL( var, type ) type* var = (type*)malloc( sizeof(type) );\
633                                     if( !var ) return NULL;
634
635 #define FREENULL(a) do { free( a ); a = NULL; } while(0)
636
637 #define EMPTY_STR(str) (!str || !*str)
638
639 VLC_EXPORT( char const *, vlc_error, ( int ) );
640
641 #include <vlc_arrays.h>
642
643 /* MSB (big endian)/LSB (little endian) conversions - network order is always
644  * MSB, and should be used for both network communications and files. */
645 static inline uint16_t U16_AT( const void * _p )
646 {
647     const uint8_t * p = (const uint8_t *)_p;
648     return ( ((uint16_t)p[0] << 8) | p[1] );
649 }
650 static inline uint32_t U32_AT( const void * _p )
651 {
652     const uint8_t * p = (const uint8_t *)_p;
653     return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
654               | ((uint32_t)p[2] << 8) | p[3] );
655 }
656 static inline uint64_t U64_AT( const void * _p )
657 {
658     const uint8_t * p = (const uint8_t *)_p;
659     return ( ((uint64_t)p[0] << 56) | ((uint64_t)p[1] << 48)
660               | ((uint64_t)p[2] << 40) | ((uint64_t)p[3] << 32)
661               | ((uint64_t)p[4] << 24) | ((uint64_t)p[5] << 16)
662               | ((uint64_t)p[6] << 8) | p[7] );
663 }
664
665 static inline uint16_t GetWLE( const void * _p )
666 {
667     const uint8_t * p = (const uint8_t *)_p;
668     return ( ((uint16_t)p[1] << 8) | p[0] );
669 }
670 static inline uint32_t GetDWLE( const void * _p )
671 {
672     const uint8_t * p = (const uint8_t *)_p;
673     return ( ((uint32_t)p[3] << 24) | ((uint32_t)p[2] << 16)
674               | ((uint32_t)p[1] << 8) | p[0] );
675 }
676 static inline uint64_t GetQWLE( const void * _p )
677 {
678     const uint8_t * p = (const uint8_t *)_p;
679     return ( ((uint64_t)p[7] << 56) | ((uint64_t)p[6] << 48)
680               | ((uint64_t)p[5] << 40) | ((uint64_t)p[4] << 32)
681               | ((uint64_t)p[3] << 24) | ((uint64_t)p[2] << 16)
682               | ((uint64_t)p[1] << 8) | p[0] );
683 }
684
685 #define GetWBE( p )     U16_AT( p )
686 #define GetDWBE( p )    U32_AT( p )
687 #define GetQWBE( p )    U64_AT( p )
688
689 /* Helper writer functions */
690 #define SetWLE( p, v ) _SetWLE( (uint8_t*)(p), v)
691 static inline void _SetWLE( uint8_t *p, uint16_t i_dw )
692 {
693     p[1] = ( i_dw >>  8 )&0xff;
694     p[0] = ( i_dw       )&0xff;
695 }
696
697 #define SetDWLE( p, v ) _SetDWLE( (uint8_t*)(p), v)
698 static inline void _SetDWLE( uint8_t *p, uint32_t i_dw )
699 {
700     p[3] = ( i_dw >> 24 )&0xff;
701     p[2] = ( i_dw >> 16 )&0xff;
702     p[1] = ( i_dw >>  8 )&0xff;
703     p[0] = ( i_dw       )&0xff;
704 }
705 #define SetQWLE( p, v ) _SetQWLE( (uint8_t*)(p), v)
706 static inline void _SetQWLE( uint8_t *p, uint64_t i_qw )
707 {
708     SetDWLE( p,   i_qw&0xffffffff );
709     SetDWLE( p+4, ( i_qw >> 32)&0xffffffff );
710 }
711 #define SetWBE( p, v ) _SetWBE( (uint8_t*)(p), v)
712 static inline void _SetWBE( uint8_t *p, uint16_t i_dw )
713 {
714     p[0] = ( i_dw >>  8 )&0xff;
715     p[1] = ( i_dw       )&0xff;
716 }
717
718 #define SetDWBE( p, v ) _SetDWBE( (uint8_t*)(p), v)
719 static inline void _SetDWBE( uint8_t *p, uint32_t i_dw )
720 {
721     p[0] = ( i_dw >> 24 )&0xff;
722     p[1] = ( i_dw >> 16 )&0xff;
723     p[2] = ( i_dw >>  8 )&0xff;
724     p[3] = ( i_dw       )&0xff;
725 }
726 #define SetQWBE( p, v ) _SetQWBE( (uint8_t*)(p), v)
727 static inline void _SetQWBE( uint8_t *p, uint64_t i_qw )
728 {
729     SetDWBE( p+4,   i_qw&0xffffffff );
730     SetDWBE( p, ( i_qw >> 32)&0xffffffff );
731 }
732
733 #define hton16(i) htons(i)
734 #define hton32(i) htonl(i)
735 #define ntoh16(i) ntohs(i)
736 #define ntoh32(i) ntohl(i)
737
738 static inline uint64_t ntoh64 (uint64_t ll)
739 {
740     union { uint64_t qw; uint8_t b[16]; } v = { ll };
741     return ((uint64_t)v.b[0] << 56)
742          | ((uint64_t)v.b[1] << 48)
743          | ((uint64_t)v.b[2] << 40)
744          | ((uint64_t)v.b[3] << 32)
745          | ((uint64_t)v.b[4] << 24)
746          | ((uint64_t)v.b[5] << 16)
747          | ((uint64_t)v.b[6] <<  8)
748          | ((uint64_t)v.b[7] <<  0);
749 }
750 #define hton64(i) ntoh64(i)
751
752 /* */
753 #define VLC_UNUSED(x) (void)(x)
754
755 /* Stuff defined in src/extras/libc.c */
756 VLC_EXPORT( size_t, vlc_strlcpy, ( char *, const char *, size_t ) );
757 VLC_EXPORT( long long, vlc_strtoll, ( const char *nptr, char **endptr, int base ) );
758
759 VLC_EXPORT( char *, vlc_strcasestr, ( const char *s1, const char *s2 ) );
760 char *vlc_strsep( char **, const char * );
761
762 #if defined(WIN32) || defined(UNDER_CE)
763 /* win32, cl and icl support */
764 #   if defined( _MSC_VER ) || !defined( __MINGW32__ )
765 #       define __attribute__(x)
766 #       define __inline__      __inline
767 #       define S_IFBLK         0x3000  /* Block */
768 #       define S_ISBLK(m)      (0)
769 #       define S_ISCHR(m)      (0)
770 #       define S_ISFIFO(m)     (((m)&_S_IFMT) == _S_IFIFO)
771 #       define S_ISREG(m)      (((m)&_S_IFMT) == _S_IFREG)
772 #   endif
773
774 /* several type definitions */
775 #   if defined( __MINGW32__ )
776 #       if !defined( _OFF_T_ )
777             typedef long long _off_t;
778             typedef _off_t off_t;
779 #           define _OFF_T_
780 #       else
781 #           ifdef off_t
782 #               undef off_t
783 #           endif
784 #           define off_t long long
785 #       endif
786 #   endif
787
788 #   if defined( _MSC_VER ) && !defined( __WXMSW__ )
789 #       if !defined( _OFF_T_DEFINED )
790             typedef __int64 off_t;
791 #           define _OFF_T_DEFINED
792 #       else
793             /* for wx compatibility typedef long off_t; */
794 #           define off_t __int64
795 #       endif
796 #   endif
797
798 #   if defined( __BORLANDC__ )
799 #       undef off_t
800 #       define off_t unsigned __int64
801 #   endif
802
803 #   ifndef O_NONBLOCK
804 #       define O_NONBLOCK 0
805 #   endif
806
807 #   ifndef alloca
808 #       define alloca _alloca
809 #   endif
810
811     /* These two are not defined in mingw32 (bug?) */
812 #   ifndef snprintf
813 #       define snprintf _snprintf
814 #   endif
815 #   ifndef vsnprintf
816 #       define vsnprintf _vsnprintf
817 #   endif
818
819 #   include <tchar.h>
820 #endif
821
822 VLC_EXPORT( bool, vlc_ureduce, ( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t ) );
823
824 /* vlc_wraptext (defined in src/extras/libc.c) */
825 #define wraptext vlc_wraptext
826 VLC_EXPORT( char *, vlc_wraptext, ( const char *, int ) );
827
828 /* iconv wrappers (defined in src/extras/libc.c) */
829 typedef void *vlc_iconv_t;
830 VLC_EXPORT( vlc_iconv_t, vlc_iconv_open, ( const char *, const char * ) );
831 VLC_EXPORT( size_t, vlc_iconv, ( vlc_iconv_t, const char **, size_t *, char **, size_t * ) );
832 VLC_EXPORT( int, vlc_iconv_close, ( vlc_iconv_t ) );
833
834 /* execve wrapper (defined in src/extras/libc.c) */
835 VLC_EXPORT( int, __vlc_execve, ( vlc_object_t *p_object, int i_argc, char *const *pp_argv, char *const *pp_env, const char *psz_cwd, const char *p_in, size_t i_in, char **pp_data, size_t *pi_data ) );
836 #define vlc_execve(a,b,c,d,e,f,g,h,i) __vlc_execve(VLC_OBJECT(a),b,c,d,e,f,g,h,i)
837
838 /* dir wrappers (defined in src/extras/libc.c) */
839 VLC_EXPORT(int, vlc_wclosedir, ( void *_p_dir ));
840
841 /*****************************************************************************
842  * CPU capabilities
843  *****************************************************************************/
844 #define CPU_CAPABILITY_NONE    0
845 #define CPU_CAPABILITY_486     (1<<0)
846 #define CPU_CAPABILITY_586     (1<<1)
847 #define CPU_CAPABILITY_PPRO    (1<<2)
848 #define CPU_CAPABILITY_MMX     (1<<3)
849 #define CPU_CAPABILITY_3DNOW   (1<<4)
850 #define CPU_CAPABILITY_MMXEXT  (1<<5)
851 #define CPU_CAPABILITY_SSE     (1<<6)
852 #define CPU_CAPABILITY_SSE2    (1<<7)
853 #define CPU_CAPABILITY_ALTIVEC (1<<16)
854 #define CPU_CAPABILITY_FPU     (1<<31)
855 VLC_EXPORT( unsigned, vlc_CPU, ( void ) );
856
857 typedef void *(*vlc_memcpy_t) (void *tgt, const void *src, size_t n);
858 typedef void *(*vlc_memset_t) (void *tgt, int c, size_t n);
859
860 VLC_EXPORT( void, vlc_fastmem_register, (vlc_memcpy_t cpy, vlc_memset_t set) );
861 VLC_EXPORT( void *, vlc_memcpy, ( void *, const void *, size_t ) );
862 VLC_EXPORT( void *, vlc_memset, ( void *, int, size_t ) );
863
864 /*****************************************************************************
865  * I18n stuff
866  *****************************************************************************/
867 VLC_EXPORT( char *, vlc_gettext, ( const char *msgid ) );
868
869 /*****************************************************************************
870  * libvlc features
871  *****************************************************************************/
872 VLC_EXPORT( const char *, VLC_Version, ( void ) );
873 VLC_EXPORT( const char *, VLC_CompileBy, ( void ) );
874 VLC_EXPORT( const char *, VLC_CompileHost, ( void ) );
875 VLC_EXPORT( const char *, VLC_CompileDomain, ( void ) );
876 VLC_EXPORT( const char *, VLC_Compiler, ( void ) );
877 VLC_EXPORT( const char *, VLC_Error, ( int ) );
878 VLC_EXPORT( const char *, VLC_Changeset, ( void ) );
879
880 /*****************************************************************************
881  * Additional vlc stuff
882  *****************************************************************************/
883 #include "vlc_messages.h"
884 #include "vlc_variables.h"
885 #include "vlc_objects.h"
886 #include "vlc_modules.h"
887 #include "vlc_main.h"
888 #include "vlc_configuration.h"
889
890 #if defined( WIN32 ) || defined( UNDER_CE )
891 #   define DIR_SEP_CHAR '\\'
892 #   define DIR_SEP "\\"
893 #   define PATH_SEP_CHAR ';'
894 #   define PATH_SEP ";"
895 #else
896 #   define DIR_SEP_CHAR '/'
897 #   define DIR_SEP "/"
898 #   define PATH_SEP_CHAR ':'
899 #   define PATH_SEP ":"
900 #endif
901
902 #define LICENSE_MSG \
903   _("This program comes with NO WARRANTY, to the extent permitted by " \
904     "law.\nYou may redistribute it under the terms of the GNU General " \
905     "Public License;\nsee the file named COPYING for details.\n" \
906     "Written by the VideoLAN team; see the AUTHORS file.\n")
907
908 #endif /* !VLC_COMMON_H */