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