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