d0efdf047b9e301c2c99e22861cf54bfc17035ec
[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 variable_t variable_t;
143 typedef struct date_t date_t;
144 typedef struct dict_entry_t dict_entry_t;
145 typedef struct dict_t dict_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
174 /* Modules */
175 typedef struct module_bank_t module_bank_t;
176 typedef struct module_t module_t;
177 typedef struct module_config_t module_config_t;
178 typedef struct module_symbols_t module_symbols_t;
179 typedef struct module_cache_t module_cache_t;
180
181 typedef struct config_category_t config_category_t;
182
183 /* Interface */
184 typedef struct intf_thread_t intf_thread_t;
185 typedef struct intf_sys_t intf_sys_t;
186 typedef struct intf_console_t intf_console_t;
187 typedef struct intf_msg_t intf_msg_t;
188 typedef struct interaction_t interaction_t;
189 typedef struct interaction_dialog_t interaction_dialog_t;
190 typedef struct user_widget_t user_widget_t;
191
192 /* Input */
193 typedef struct input_thread_t input_thread_t;
194 typedef struct input_thread_sys_t input_thread_sys_t;
195 typedef struct input_item_t input_item_t;
196 typedef struct access_t access_t;
197 typedef struct access_sys_t access_sys_t;
198 typedef struct stream_t     stream_t;
199 typedef struct stream_sys_t stream_sys_t;
200 typedef struct demux_t  demux_t;
201 typedef struct demux_meta_t demux_meta_t;
202 typedef struct demux_sys_t demux_sys_t;
203 typedef struct es_out_t     es_out_t;
204 typedef struct es_out_id_t  es_out_id_t;
205 typedef struct es_out_sys_t es_out_sys_t;
206 typedef struct es_descriptor_t es_descriptor_t;
207 typedef struct seekpoint_t seekpoint_t;
208 typedef struct info_t info_t;
209 typedef struct info_category_t info_category_t;
210 typedef struct input_attachment_t input_attachment_t;
211
212 /* Format */
213 typedef struct audio_format_t audio_format_t;
214 typedef struct video_format_t video_format_t;
215 typedef struct subs_format_t subs_format_t;
216 typedef struct es_format_t es_format_t;
217 typedef struct video_palette_t video_palette_t;
218
219 /* Audio */
220 typedef struct aout_instance_t aout_instance_t;
221 typedef struct aout_sys_t aout_sys_t;
222 typedef struct aout_fifo_t aout_fifo_t;
223 typedef struct aout_input_t aout_input_t;
224 typedef struct aout_buffer_t aout_buffer_t;
225 typedef audio_format_t audio_sample_format_t;
226 typedef struct audio_date_t audio_date_t;
227 typedef struct aout_filter_t aout_filter_t;
228
229 /* Video */
230 typedef struct vout_thread_t vout_thread_t;
231 typedef struct vout_sys_t vout_sys_t;
232
233 typedef video_format_t video_frame_format_t;
234 typedef struct picture_t picture_t;
235 typedef struct picture_sys_t picture_sys_t;
236 typedef struct picture_heap_t picture_heap_t;
237
238 /* Subpictures */
239 typedef struct spu_t spu_t;
240 typedef struct subpicture_t subpicture_t;
241 typedef struct subpicture_sys_t subpicture_sys_t;
242 typedef struct subpicture_region_t subpicture_region_t;
243 typedef struct text_style_t text_style_t;
244
245 typedef struct image_handler_t image_handler_t;
246
247 /* Stream output */
248 typedef struct sout_instance_t sout_instance_t;
249 typedef struct sout_instance_sys_t sout_instance_sys_t;
250
251 typedef struct sout_input_t sout_input_t;
252 typedef struct sout_packetizer_input_t sout_packetizer_input_t;
253
254 typedef struct sout_access_out_t sout_access_out_t;
255 typedef struct sout_access_out_sys_t   sout_access_out_sys_t;
256
257 typedef struct sout_mux_t sout_mux_t;
258 typedef struct sout_mux_sys_t sout_mux_sys_t;
259
260 typedef struct sout_stream_t    sout_stream_t;
261 typedef struct sout_stream_sys_t sout_stream_sys_t;
262
263 typedef struct config_chain_t       config_chain_t;
264 typedef struct session_descriptor_t session_descriptor_t;
265 typedef struct announce_method_t announce_method_t;
266
267 typedef struct sout_param_t sout_param_t;
268 typedef struct sout_pcat_t sout_pcat_t;
269 typedef struct sout_std_t sout_std_t;
270 typedef struct sout_display_t sout_display_t;
271 typedef struct sout_duplicate_t sout_duplicate_t;
272 typedef struct sout_transcode_t sout_transcode_t;
273 typedef struct sout_chain_t sout_chain_t;
274 typedef struct streaming_profile_t streaming_profile_t;
275 typedef struct sout_module_t sout_module_t;
276 typedef struct sout_gui_descr_t sout_gui_descr_t;
277 typedef struct profile_parser_t profile_parser_t;
278
279 /* Decoders */
280 typedef struct decoder_t         decoder_t;
281 typedef struct decoder_sys_t     decoder_sys_t;
282 typedef struct decoder_synchro_t decoder_synchro_t;
283
284 /* Encoders */
285 typedef struct encoder_t      encoder_t;
286 typedef struct encoder_sys_t  encoder_sys_t;
287
288 /* Filters */
289 typedef struct filter_t filter_t;
290 typedef struct filter_sys_t filter_sys_t;
291
292 /* Network */
293 typedef struct network_socket_t network_socket_t;
294 typedef struct virtual_socket_t v_socket_t;
295 typedef struct sockaddr sockaddr;
296 typedef struct addrinfo addrinfo;
297 typedef struct vlc_acl_t vlc_acl_t;
298 typedef struct vlc_url_t vlc_url_t;
299
300 /* Misc */
301 typedef struct iso639_lang_t iso639_lang_t;
302 typedef struct device_t device_t;
303 typedef struct device_probe_t device_probe_t;
304 typedef struct probe_sys_t probe_sys_t;
305
306 /* block */
307 typedef struct block_t      block_t;
308 typedef struct block_fifo_t block_fifo_t;
309
310 /* httpd */
311 typedef struct httpd_t          httpd_t;
312 typedef struct httpd_host_t     httpd_host_t;
313 typedef struct httpd_url_t      httpd_url_t;
314 typedef struct httpd_client_t   httpd_client_t;
315 typedef struct httpd_callback_sys_t httpd_callback_sys_t;
316 typedef struct httpd_message_t  httpd_message_t;
317 typedef int    (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, const httpd_message_t *query );
318 typedef struct httpd_file_t     httpd_file_t;
319 typedef struct httpd_file_sys_t httpd_file_sys_t;
320 typedef int (*httpd_file_callback_t)( httpd_file_sys_t *, httpd_file_t *, uint8_t *psz_request, uint8_t **pp_data, int *pi_data );
321 typedef struct httpd_handler_t  httpd_handler_t;
322 typedef struct httpd_handler_sys_t httpd_handler_sys_t;
323 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 );
324 typedef struct httpd_redirect_t httpd_redirect_t;
325 typedef struct httpd_stream_t httpd_stream_t;
326
327 /* TLS support */
328 typedef struct tls_server_t tls_server_t;
329 typedef struct tls_session_t tls_session_t;
330
331 /* Hashing */
332 typedef struct md5_s md5_t;
333
334 /* XML */
335 typedef struct xml_t xml_t;
336 typedef struct xml_sys_t xml_sys_t;
337 typedef struct xml_reader_t xml_reader_t;
338 typedef struct xml_reader_sys_t xml_reader_sys_t;
339
340 /* vod server */
341 typedef struct vod_t     vod_t;
342 typedef struct vod_sys_t vod_sys_t;
343 typedef struct vod_media_t vod_media_t;
344
345 /* opengl */
346 typedef struct opengl_t     opengl_t;
347 typedef struct opengl_sys_t opengl_sys_t;
348
349 /* osdmenu */
350 typedef struct osd_menu_t   osd_menu_t;
351 typedef struct osd_state_t  osd_state_t;
352 typedef struct osd_event_t  osd_event_t;
353 typedef struct osd_button_t osd_button_t;
354 typedef struct osd_menu_state_t osd_menu_state_t;
355
356 /* VLM */
357 typedef struct vlm_t         vlm_t;
358 typedef struct vlm_message_t vlm_message_t;
359
360 /* divers */
361 typedef struct vlc_meta_t    vlc_meta_t;
362 typedef struct meta_export_t meta_export_t;
363
364 /* Stats */
365 typedef struct counter_t     counter_t;
366 typedef struct counter_sample_t counter_sample_t;
367 typedef struct stats_handler_t stats_handler_t;
368 typedef struct input_stats_t input_stats_t;
369 typedef struct global_stats_t global_stats_t;
370
371 /* Update */
372 typedef struct update_t update_t;
373 typedef struct update_iterator_t update_iterator_t;
374
375 /* Meta engine */
376 typedef struct meta_engine_t meta_engine_t;
377
378 /* stat/lstat/fstat */
379 #ifdef WIN32
380 # ifdef UNDER_CE
381 # undef _STAT_DEFINED
382 # endif
383 #include <sys/stat.h>
384 # ifndef UNDER_CE
385 struct _stati64;
386 #define stat _stati64
387 #define fstat _fstati64
388 # else
389 # define stat _stat
390 # define fstat _fstat
391 # endif
392 /* You should otherwise use utf8_stat and utf8_lstat. */
393 #else
394 struct stat;
395 #endif
396
397 /**
398  * VLC value structure
399  */
400 typedef union
401 {
402     int             i_int;
403     bool            b_bool;
404     float           f_float;
405     char *          psz_string;
406     void *          p_address;
407     vlc_object_t *  p_object;
408     vlc_list_t *    p_list;
409     mtime_t         i_time;
410
411     struct { char *psz_name; int i_object_id; } var;
412
413    /* Make sure the structure is at least 64bits */
414     struct { char a, b, c, d, e, f, g, h; } padding;
415
416 } vlc_value_t;
417
418 /**
419  * VLC list structure
420  */
421 struct vlc_list_t
422 {
423     int             i_count;
424     vlc_value_t *   p_values;
425     int *           pi_types;
426
427 };
428
429 /**
430  * \defgroup var_type Variable types
431  * These are the different types a vlc variable can have.
432  * @{
433  */
434 #define VLC_VAR_VOID      0x0010
435 #define VLC_VAR_BOOL      0x0020
436 #define VLC_VAR_INTEGER   0x0030
437 #define VLC_VAR_HOTKEY    0x0031
438 #define VLC_VAR_STRING    0x0040
439 #define VLC_VAR_MODULE    0x0041
440 #define VLC_VAR_FILE      0x0042
441 #define VLC_VAR_DIRECTORY 0x0043
442 #define VLC_VAR_VARIABLE  0x0044
443 #define VLC_VAR_FLOAT     0x0050
444 #define VLC_VAR_TIME      0x0060
445 #define VLC_VAR_ADDRESS   0x0070
446 #define VLC_VAR_MUTEX     0x0080
447 #define VLC_VAR_LIST      0x0090
448 /**@}*/
449
450 /*****************************************************************************
451  * Error values (shouldn't be exposed)
452  *****************************************************************************/
453 #define VLC_SUCCESS         -0                                   /* No error */
454 #define VLC_ENOMEM          -1                          /* Not enough memory */
455 #define VLC_ETHREAD         -2                               /* Thread error */
456 #define VLC_ETIMEOUT        -3                                    /* Timeout */
457
458 #define VLC_ENOMOD         -10                           /* Module not found */
459
460 #define VLC_ENOOBJ         -20                           /* Object not found */
461
462 #define VLC_ENOVAR         -30                         /* Variable not found */
463 #define VLC_EBADVAR        -31                         /* Bad variable value */
464
465 #define VLC_ENOITEM        -40                           /**< Item not found */
466
467 #define VLC_EEXIT         -255                             /* Program exited */
468 #define VLC_EEXITSUCCESS  -999                /* Program exited successfully */
469 #define VLC_EGENERIC      -666                              /* Generic error */
470
471 /*****************************************************************************
472  * Variable callbacks
473  *****************************************************************************/
474 typedef int ( * vlc_callback_t ) ( vlc_object_t *,      /* variable's object */
475                                    char const *,            /* variable name */
476                                    vlc_value_t,                 /* old value */
477                                    vlc_value_t,                 /* new value */
478                                    void * );                /* callback data */
479
480 /*****************************************************************************
481  * Plug-in stuff
482  *****************************************************************************/
483
484 #ifdef __cplusplus
485 # define LIBVLC_EXTERN extern "C"
486 #else
487 # define LIBVLC_EXTERN extern
488 #endif
489 #if defined (WIN32) && defined (DLL_EXPORT)
490 #if defined (UNDER_CE)
491 # include <windef.h>
492 #endif
493 # define LIBVLC_EXPORT __declspec(dllexport)
494 #else
495 # define LIBVLC_EXPORT
496 #endif
497 #define VLC_EXPORT( type, name, args ) \
498                         LIBVLC_EXTERN LIBVLC_EXPORT type name args
499
500 /*****************************************************************************
501  * OS-specific headers and thread types
502  *****************************************************************************/
503 #if defined( WIN32 ) || defined( UNDER_CE )
504 #   define WIN32_LEAN_AND_MEAN
505 #   include <windows.h>
506 #   if defined( UNDER_CE )
507 #      define IS_WINNT 0
508 #   else
509 #      define IS_WINNT ( GetVersion() < 0x80000000 )
510 #   endif
511 #endif
512
513 #include "vlc_mtime.h"
514 #include "vlc_threads.h"
515
516 /*****************************************************************************
517  * Common structure members
518  *****************************************************************************/
519
520 /* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
521 #define VLC_COMMON_MEMBERS                                                  \
522 /** \name VLC_COMMON_MEMBERS                                                \
523  * these members are common for all vlc objects                             \
524  */                                                                         \
525 /**@{*/                                                                     \
526     int   i_object_id;                                                      \
527     int   i_object_type;                                                    \
528     const char *psz_object_type;                                            \
529     char *psz_object_name;                                                  \
530                                                                             \
531     /* Messages header */                                                   \
532     char *psz_header;                                                       \
533     int  i_flags;                                                           \
534                                                                             \
535     /* Object properties */                                                 \
536     volatile bool b_error;                  /**< set by the object */ \
537     volatile bool b_die;                   /**< set by the outside */ \
538     bool b_force;      /**< set by the outside (eg. module_Need()) */ \
539                                                                             \
540     /** Just a reminder so that people don't cast garbage */                \
541     bool be_sure_to_add_VLC_COMMON_MEMBERS_to_struct;                       \
542                                                                             \
543     /* Stuff related to the libvlc structure */                             \
544     libvlc_int_t *p_libvlc;                  /**< (root of all evil) - 1 */ \
545                                                                             \
546     vlc_object_t *  p_parent;                            /**< our parent */ \
547                                                                             \
548     /* Private data */                                                      \
549     void *          p_private;                                              \
550                                                                             \
551 /**@}*/                                                                     \
552
553 /* VLC_OBJECT: attempt at doing a clever cast */
554 #ifdef __GNUC__
555 # define VLC_OBJECT( x ) \
556     (((vlc_object_t *)(x))+0*(((typeof(x))0)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct))
557 #else
558 # define VLC_OBJECT( x ) ((vlc_object_t *)(x))
559 #endif
560
561 typedef struct gc_object_t
562 {
563     vlc_spinlock_t spin;
564     uintptr_t      refs;
565     void          (*pf_destructor) (struct gc_object_t *);
566 } gc_object_t;
567
568 /**
569  * These members are common to all objects that wish to be garbage-collected.
570  */
571 #define VLC_GC_MEMBERS gc_object_t vlc_gc_data;
572
573 VLC_EXPORT(void *, vlc_gc_init, (gc_object_t *, void (*)(gc_object_t *)));
574 VLC_EXPORT(void *, vlc_hold, (gc_object_t *));
575 VLC_EXPORT(void, vlc_release, (gc_object_t *));
576
577 #define vlc_gc_init( a,b ) vlc_gc_init( &(a)->vlc_gc_data, (b) )
578 #define vlc_gc_incref( a ) vlc_hold( &(a)->vlc_gc_data )
579 #define vlc_gc_decref( a ) vlc_release( &(a)->vlc_gc_data )
580 #define vlc_priv( gc, t ) ((t *)(((char *)(gc)) - offsetof(t, vlc_gc_data)))
581
582 /*****************************************************************************
583  * Macros and inline functions
584  *****************************************************************************/
585
586 /* CEIL: division with round to nearest greater integer */
587 #define CEIL(n, d)  ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
588
589 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
590 #define PAD(n, d)   ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
591
592 /* __MAX and __MIN: self explanatory */
593 #ifndef __MAX
594 #   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
595 #endif
596 #ifndef __MIN
597 #   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
598 #endif
599
600 LIBVLC_USED
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 LIBVLC_USED
614 static inline uint8_t clip_uint8_vlc( int32_t a )
615 {
616     if( a&(~255) ) return (-a)>>31;
617     else           return a;
618 }
619
620 /* Malloc with automatic error */
621 #define MALLOC_VOID( var, type ) do { var = (type*)malloc( sizeof( type) ); \
622                                    if( !var ) return; } while(0)
623 #define MALLOC_NULL( var, type ) do { var = (type*)malloc( sizeof( type) ); \
624                                    if( !var ) return NULL; } while(0)
625 #define MALLOC_ERR( var, type ) do { var = (type*)malloc( sizeof( type) ); \
626                                    if( !var ) return VLC_ENOMEM; } while(0)
627 #define MALLOC_GOTOERR( var, type ) do { var = (type*)malloc( sizeof( type) ); \
628                                       if( !var ) goto error; } while(0)
629 #define DECMALLOC_VOID( var, type ) type* var = (type*)malloc( sizeof(type) );\
630                                     if( !var ) return;
631 #define DECMALLOC_ERR( var, type )  type* var = (type*)malloc( sizeof(type) );\
632                                     if( !var ) return VLC_ENOMEM;
633 #define DECMALLOC_NULL( var, type ) type* var = (type*)malloc( sizeof(type) );\
634                                     if( !var ) return NULL;
635
636 #define FREENULL(a) do { free( a ); a = NULL; } while(0)
637
638 #define EMPTY_STR(str) (!str || !*str)
639
640 VLC_EXPORT( char const *, vlc_error, ( int ) LIBVLC_USED );
641
642 #include <vlc_arrays.h>
643
644 /* MSB (big endian)/LSB (little endian) conversions - network order is always
645  * MSB, and should be used for both network communications and files. */
646 LIBVLC_USED
647 static inline uint16_t U16_AT( const void * _p )
648 {
649     const uint8_t * p = (const uint8_t *)_p;
650     return ( ((uint16_t)p[0] << 8) | p[1] );
651 }
652
653 LIBVLC_USED
654 static inline uint32_t U32_AT( const void * _p )
655 {
656     const uint8_t * p = (const uint8_t *)_p;
657     return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
658               | ((uint32_t)p[2] << 8) | p[3] );
659 }
660
661 LIBVLC_USED
662 static inline uint64_t U64_AT( const void * _p )
663 {
664     const uint8_t * p = (const uint8_t *)_p;
665     return ( ((uint64_t)p[0] << 56) | ((uint64_t)p[1] << 48)
666               | ((uint64_t)p[2] << 40) | ((uint64_t)p[3] << 32)
667               | ((uint64_t)p[4] << 24) | ((uint64_t)p[5] << 16)
668               | ((uint64_t)p[6] << 8) | p[7] );
669 }
670
671 LIBVLC_USED
672 static inline uint16_t GetWLE( const void * _p )
673 {
674     const uint8_t * p = (const uint8_t *)_p;
675     return ( ((uint16_t)p[1] << 8) | p[0] );
676 }
677
678 LIBVLC_USED
679 static inline uint32_t GetDWLE( const void * _p )
680 {
681     const uint8_t * p = (const uint8_t *)_p;
682     return ( ((uint32_t)p[3] << 24) | ((uint32_t)p[2] << 16)
683               | ((uint32_t)p[1] << 8) | p[0] );
684 }
685
686 LIBVLC_USED
687 static inline uint64_t GetQWLE( const void * _p )
688 {
689     const uint8_t * p = (const uint8_t *)_p;
690     return ( ((uint64_t)p[7] << 56) | ((uint64_t)p[6] << 48)
691               | ((uint64_t)p[5] << 40) | ((uint64_t)p[4] << 32)
692               | ((uint64_t)p[3] << 24) | ((uint64_t)p[2] << 16)
693               | ((uint64_t)p[1] << 8) | p[0] );
694 }
695
696 #define GetWBE( p )     U16_AT( p )
697 #define GetDWBE( p )    U32_AT( p )
698 #define GetQWBE( p )    U64_AT( p )
699
700 /* Helper writer functions */
701 #define SetWLE( p, v ) _SetWLE( (uint8_t*)(p), v)
702 static inline void _SetWLE( uint8_t *p, uint16_t i_dw )
703 {
704     p[1] = ( i_dw >>  8 )&0xff;
705     p[0] = ( i_dw       )&0xff;
706 }
707
708 #define SetDWLE( p, v ) _SetDWLE( (uint8_t*)(p), v)
709 static inline void _SetDWLE( uint8_t *p, uint32_t i_dw )
710 {
711     p[3] = ( i_dw >> 24 )&0xff;
712     p[2] = ( i_dw >> 16 )&0xff;
713     p[1] = ( i_dw >>  8 )&0xff;
714     p[0] = ( i_dw       )&0xff;
715 }
716 #define SetQWLE( p, v ) _SetQWLE( (uint8_t*)(p), v)
717 static inline void _SetQWLE( uint8_t *p, uint64_t i_qw )
718 {
719     SetDWLE( p,   i_qw&0xffffffff );
720     SetDWLE( p+4, ( i_qw >> 32)&0xffffffff );
721 }
722 #define SetWBE( p, v ) _SetWBE( (uint8_t*)(p), v)
723 static inline void _SetWBE( uint8_t *p, uint16_t i_dw )
724 {
725     p[0] = ( i_dw >>  8 )&0xff;
726     p[1] = ( i_dw       )&0xff;
727 }
728
729 #define SetDWBE( p, v ) _SetDWBE( (uint8_t*)(p), v)
730 static inline void _SetDWBE( uint8_t *p, uint32_t i_dw )
731 {
732     p[0] = ( i_dw >> 24 )&0xff;
733     p[1] = ( i_dw >> 16 )&0xff;
734     p[2] = ( i_dw >>  8 )&0xff;
735     p[3] = ( i_dw       )&0xff;
736 }
737 #define SetQWBE( p, v ) _SetQWBE( (uint8_t*)(p), v)
738 static inline void _SetQWBE( uint8_t *p, uint64_t i_qw )
739 {
740     SetDWBE( p+4,   i_qw&0xffffffff );
741     SetDWBE( p, ( i_qw >> 32)&0xffffffff );
742 }
743
744 #define hton16(i) htons(i)
745 #define hton32(i) htonl(i)
746 #define ntoh16(i) ntohs(i)
747 #define ntoh32(i) ntohl(i)
748
749 LIBVLC_USED
750 static inline uint64_t ntoh64 (uint64_t ll)
751 {
752     union { uint64_t qw; uint8_t b[16]; } v = { ll };
753     return ((uint64_t)v.b[0] << 56)
754          | ((uint64_t)v.b[1] << 48)
755          | ((uint64_t)v.b[2] << 40)
756          | ((uint64_t)v.b[3] << 32)
757          | ((uint64_t)v.b[4] << 24)
758          | ((uint64_t)v.b[5] << 16)
759          | ((uint64_t)v.b[6] <<  8)
760          | ((uint64_t)v.b[7] <<  0);
761 }
762 #define hton64(i) ntoh64(i)
763
764 /* */
765 #define VLC_UNUSED(x) (void)(x)
766
767 /* Stuff defined in src/extras/libc.c */
768 VLC_EXPORT( size_t, vlc_strlcpy, ( char *, const char *, size_t ) );
769 VLC_EXPORT( long long, vlc_strtoll, ( const char *nptr, char **endptr, int base ) LIBVLC_USED );
770
771 VLC_EXPORT( char *, vlc_strcasestr, ( const char *s1, const char *s2 ) LIBVLC_USED );
772 char *vlc_strsep( char **, const char * );
773
774 #if defined(WIN32) || defined(UNDER_CE)
775 /* win32, cl and icl support */
776 #   if defined( _MSC_VER ) || !defined( __MINGW32__ )
777 #       define __attribute__(x)
778 #       define __inline__      __inline
779 #       define S_IFBLK         0x3000  /* Block */
780 #       define S_ISBLK(m)      (0)
781 #       define S_ISCHR(m)      (0)
782 #       define S_ISFIFO(m)     (((m)&_S_IFMT) == _S_IFIFO)
783 #       define S_ISREG(m)      (((m)&_S_IFMT) == _S_IFREG)
784 #   endif
785
786 /* several type definitions */
787 #   if defined( __MINGW32__ )
788 #       if !defined( _OFF_T_ )
789             typedef long long _off_t;
790             typedef _off_t off_t;
791 #           define _OFF_T_
792 #       else
793 #           ifdef off_t
794 #               undef off_t
795 #           endif
796 #           define off_t long long
797 #       endif
798 #   endif
799
800 #   if defined( _MSC_VER ) && !defined( __WXMSW__ )
801 #       if !defined( _OFF_T_DEFINED )
802             typedef __int64 off_t;
803 #           define _OFF_T_DEFINED
804 #       else
805             /* for wx compatibility typedef long off_t; */
806 #           define off_t __int64
807 #       endif
808 #   endif
809
810 #   if defined( __BORLANDC__ )
811 #       undef off_t
812 #       define off_t unsigned __int64
813 #   endif
814
815 #   ifndef O_NONBLOCK
816 #       define O_NONBLOCK 0
817 #   endif
818
819 #   ifndef alloca
820 #       define alloca _alloca
821 #   endif
822
823     /* These two are not defined in mingw32 (bug?) */
824 #   ifndef snprintf
825 #       define snprintf _snprintf
826 #   endif
827 #   ifndef vsnprintf
828 #       define vsnprintf _vsnprintf
829 #   endif
830
831 #   include <tchar.h>
832 #endif
833
834 VLC_EXPORT( bool, vlc_ureduce, ( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t ) );
835
836 /* vlc_wraptext (defined in src/extras/libc.c) */
837 #define wraptext vlc_wraptext
838 VLC_EXPORT( char *, vlc_wraptext, ( const char *, int ) LIBVLC_USED );
839
840 /* iconv wrappers (defined in src/extras/libc.c) */
841 typedef void *vlc_iconv_t;
842 VLC_EXPORT( vlc_iconv_t, vlc_iconv_open, ( const char *, const char * ) LIBVLC_USED );
843 VLC_EXPORT( size_t, vlc_iconv, ( vlc_iconv_t, const char **, size_t *, char **, size_t * ) LIBVLC_USED );
844 VLC_EXPORT( int, vlc_iconv_close, ( vlc_iconv_t ) );
845
846 /* execve wrapper (defined in src/extras/libc.c) */
847 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 );
848 #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)
849
850 /* dir wrappers (defined in src/extras/libc.c) */
851 VLC_EXPORT(int, vlc_wclosedir, ( void *_p_dir ));
852
853 /*****************************************************************************
854  * CPU capabilities
855  *****************************************************************************/
856 #define CPU_CAPABILITY_NONE    0
857 #define CPU_CAPABILITY_486     (1<<0)
858 #define CPU_CAPABILITY_586     (1<<1)
859 #define CPU_CAPABILITY_PPRO    (1<<2)
860 #define CPU_CAPABILITY_MMX     (1<<3)
861 #define CPU_CAPABILITY_3DNOW   (1<<4)
862 #define CPU_CAPABILITY_MMXEXT  (1<<5)
863 #define CPU_CAPABILITY_SSE     (1<<6)
864 #define CPU_CAPABILITY_SSE2    (1<<7)
865 #define CPU_CAPABILITY_ALTIVEC (1<<16)
866 #define CPU_CAPABILITY_FPU     (1<<31)
867 VLC_EXPORT( unsigned, vlc_CPU, ( void ) );
868
869 typedef void *(*vlc_memcpy_t) (void *tgt, const void *src, size_t n);
870 typedef void *(*vlc_memset_t) (void *tgt, int c, size_t n);
871
872 VLC_EXPORT( void, vlc_fastmem_register, (vlc_memcpy_t cpy, vlc_memset_t set) );
873 VLC_EXPORT( void *, vlc_memcpy, ( void *, const void *, size_t ) );
874 VLC_EXPORT( void *, vlc_memset, ( void *, int, size_t ) );
875
876 /*****************************************************************************
877  * I18n stuff
878  *****************************************************************************/
879 VLC_EXPORT( char *, vlc_gettext, ( const char *msgid ) LIBVLC_USED );
880
881 /*****************************************************************************
882  * libvlc features
883  *****************************************************************************/
884 VLC_EXPORT( const char *, VLC_Version, ( void ) LIBVLC_USED );
885 VLC_EXPORT( const char *, VLC_CompileBy, ( void ) LIBVLC_USED );
886 VLC_EXPORT( const char *, VLC_CompileHost, ( void ) LIBVLC_USED );
887 VLC_EXPORT( const char *, VLC_CompileDomain, ( void ) LIBVLC_USED );
888 VLC_EXPORT( const char *, VLC_Compiler, ( void ) LIBVLC_USED );
889 VLC_EXPORT( const char *, VLC_Error, ( int ) LIBVLC_USED );
890 VLC_EXPORT( const char *, VLC_Changeset, ( void ) LIBVLC_USED );
891
892 /*****************************************************************************
893  * Additional vlc stuff
894  *****************************************************************************/
895 #include "vlc_messages.h"
896 #include "vlc_variables.h"
897 #include "vlc_objects.h"
898 #include "vlc_modules.h"
899 #include "vlc_main.h"
900 #include "vlc_configuration.h"
901
902 #if defined( WIN32 ) || defined( UNDER_CE )
903 #   define DIR_SEP_CHAR '\\'
904 #   define DIR_SEP "\\"
905 #   define PATH_SEP_CHAR ';'
906 #   define PATH_SEP ";"
907 #else
908 #   define DIR_SEP_CHAR '/'
909 #   define DIR_SEP "/"
910 #   define PATH_SEP_CHAR ':'
911 #   define PATH_SEP ":"
912 #endif
913
914 #define LICENSE_MSG \
915   _("This program comes with NO WARRANTY, to the extent permitted by " \
916     "law.\nYou may redistribute it under the terms of the GNU General " \
917     "Public License;\nsee the file named COPYING for details.\n" \
918     "Written by the VideoLAN team; see the AUTHORS file.\n")
919
920 #endif /* !VLC_COMMON_H */