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