Implement vlc_ngettext() to deal with plurals
[vlc.git] / include / vlc_common.h
1 /*****************************************************************************
2  * vlc_common.h: common definitions
3  * Collection of useful common types and macros definitions
4  *****************************************************************************
5  * Copyright (C) 1998-2011 VLC authors and VideoLAN
6  *
7  * Authors: Samuel Hocevar <sam@via.ecp.fr>
8  *          Vincent Seguin <seguin@via.ecp.fr>
9  *          Gildas Bazin <gbazin@videolan.org>
10  *          RĂ©mi Denis-Courmont
11  *
12  * This program is free software; you can redistribute it and/or modify it
13  * under the terms of the GNU Lesser General Public License as published by
14  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
21  *
22  * You should have received a copy of the GNU Lesser General Public License
23  * along with this program; if not, write to the Free Software Foundation,
24  * 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 /* Helper for GCC version checks */
60 #ifdef __GNUC__
61 # define VLC_GCC_VERSION(maj,min) \
62     ((__GNUC__ > (maj)) || (__GNUC__ == (maj) && __GNUC_MINOR__ >= (min)))
63 #else
64 # define VLC_GCC_VERSION(maj,min) (0)
65 #endif
66
67 /* Try to fix format strings for all versions of mingw and mingw64 */
68 #if defined( _WIN32 ) && defined( __USE_MINGW_ANSI_STDIO )
69  #undef PRId64
70  #define PRId64 "lld"
71  #undef PRIi64
72  #define PRIi64 "lli"
73  #undef PRIu64
74  #define PRIu64 "llu"
75  #undef PRIo64
76  #define PRIo64 "llo"
77  #undef PRIx64
78  #define PRIx64 "llx"
79  #define snprintf __mingw_snprintf
80  #define vsnprintf __mingw_vsnprintf
81 #endif
82
83 /* Function attributes for compiler warnings */
84 #ifdef __GNUC__
85 # define VLC_DEPRECATED __attribute__((deprecated))
86
87 # if defined( _WIN32 ) && VLC_GCC_VERSION(4,4)
88 #  define VLC_FORMAT(x,y) __attribute__ ((format(gnu_printf,x,y)))
89 # else
90 #  define VLC_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
91 # endif
92 # define VLC_FORMAT_ARG(x) __attribute__ ((format_arg(x)))
93
94 # define VLC_MALLOC __attribute__ ((malloc))
95 # define VLC_NORETURN __attribute__ ((noreturn))
96
97 # if VLC_GCC_VERSION(3,4)
98 #  define VLC_USED __attribute__ ((warn_unused_result))
99 # else
100 #  define VLC_USED
101 # endif
102
103 #else
104 # define VLC_DEPRECATED
105 # define VLC_FORMAT(x,y)
106 # define VLC_FORMAT_ARG(x)
107 # define VLC_MALLOC
108 # define VLC_NORETURN
109 # define VLC_USED
110 #endif
111
112
113 /* Branch prediction */
114 #ifdef __GNUC__
115 #   define likely(p)   __builtin_expect(!!(p), 1)
116 #   define unlikely(p) __builtin_expect(!!(p), 0)
117 #else
118 #   define likely(p)   (!!(p))
119 #   define unlikely(p) (!!(p))
120 #endif
121
122 /* Linkage */
123 #ifdef __cplusplus
124 # define VLC_EXTERN extern "C"
125 #else
126 # define VLC_EXTERN
127 #endif
128
129 #if defined (WIN32) && defined (DLL_EXPORT)
130 # define VLC_EXPORT __declspec(dllexport)
131 #elif VLC_GCC_VERSION(4,0)
132 # define VLC_EXPORT __attribute__((visibility("default")))
133 #else
134 # define VLC_EXPORT
135 #endif
136
137 #define VLC_API VLC_EXTERN VLC_EXPORT
138
139
140 /*****************************************************************************
141  * Basic types definitions
142  *****************************************************************************/
143 #if defined( WIN32 ) || defined( UNDER_CE )
144 #   include <malloc.h>
145 #   ifndef PATH_MAX
146 #       define PATH_MAX MAX_PATH
147 #   endif
148 #endif
149
150 #ifdef __SYMBIAN32__
151  #include <sys/syslimits.h>
152 #endif
153
154 /* Audio volume */
155 typedef uint16_t            audio_volume_t;
156
157 /**
158  * High precision date or time interval
159  *
160  * Store a high precision date or time interval. The maximum precision is the
161  * microsecond, and a 64 bits integer is used to avoid overflows (maximum
162  * time interval is then 292271 years, which should be long enough for any
163  * video). Dates are stored as microseconds since a common date (usually the
164  * epoch). Note that date and time intervals can be manipulated using regular
165  * arithmetic operators, and that no special functions are required.
166  */
167 typedef int64_t mtime_t;
168
169 /**
170  * The vlc_fourcc_t type.
171  *
172  * See http://www.webartz.com/fourcc/ for a very detailed list.
173  */
174 typedef uint32_t vlc_fourcc_t;
175
176 #ifdef WORDS_BIGENDIAN
177 #   define VLC_FOURCC( a, b, c, d ) \
178         ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
179            | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
180 #   define VLC_TWOCC( a, b ) \
181         ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )
182
183 #else
184 #   define VLC_FOURCC( a, b, c, d ) \
185         ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
186            | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
187 #   define VLC_TWOCC( a, b ) \
188         ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )
189
190 #endif
191
192 /**
193  * Translate a vlc_fourcc into its string representation. This function
194  * assumes there is enough room in psz_fourcc to store 4 characters in.
195  *
196  * \param fcc a vlc_fourcc_t
197  * \param psz_fourcc string to store string representation of vlc_fourcc in
198  */
199 static inline void vlc_fourcc_to_char( vlc_fourcc_t fcc, char *psz_fourcc )
200 {
201     memcpy( psz_fourcc, &fcc, 4 );
202 }
203
204 #define vlc_fourcc_to_char( a, b ) \
205         vlc_fourcc_to_char( (vlc_fourcc_t)(a), (char *)(b) )
206
207 /*****************************************************************************
208  * Classes declaration
209  *****************************************************************************/
210
211 /* Internal types */
212 typedef struct vlc_list_t vlc_list_t;
213 typedef struct vlc_object_t vlc_object_t;
214 typedef struct libvlc_int_t libvlc_int_t;
215 typedef struct date_t date_t;
216
217 /* Playlist */
218
219 /* FIXME */
220 /**
221  * Playlist commands
222  */
223 typedef enum {
224     PLAYLIST_PLAY,      /**< No arg.                            res=can fail*/
225     PLAYLIST_VIEWPLAY,  /**< arg1= playlist_item_t*,*/
226                         /**  arg2 = playlist_item_t*          , res=can fail */
227     PLAYLIST_PAUSE,     /**< No arg                             res=can fail*/
228     PLAYLIST_STOP,      /**< No arg                             res=can fail*/
229     PLAYLIST_SKIP,      /**< arg1=int,                          res=can fail*/
230 } playlist_command_t;
231
232
233 typedef struct playlist_t playlist_t;
234 typedef struct playlist_item_t playlist_item_t;
235 typedef struct playlist_view_t playlist_view_t;
236 typedef struct services_discovery_t services_discovery_t;
237 typedef struct services_discovery_sys_t services_discovery_sys_t;
238 typedef struct playlist_add_t playlist_add_t;
239
240 /* Modules */
241 typedef struct module_t module_t;
242 typedef struct module_config_t module_config_t;
243
244 typedef struct config_category_t config_category_t;
245
246 /* Input */
247 typedef struct input_thread_t input_thread_t;
248 typedef struct input_item_t input_item_t;
249 typedef struct input_item_node_t input_item_node_t;
250 typedef struct access_t access_t;
251 typedef struct access_sys_t access_sys_t;
252 typedef struct stream_t     stream_t;
253 typedef struct stream_sys_t stream_sys_t;
254 typedef struct demux_t  demux_t;
255 typedef struct demux_sys_t demux_sys_t;
256 typedef struct es_out_t     es_out_t;
257 typedef struct es_out_id_t  es_out_id_t;
258 typedef struct es_out_sys_t es_out_sys_t;
259 typedef struct seekpoint_t seekpoint_t;
260 typedef struct info_t info_t;
261 typedef struct info_category_t info_category_t;
262 typedef struct input_attachment_t input_attachment_t;
263
264 /* Format */
265 typedef struct audio_format_t audio_format_t;
266 typedef struct video_format_t video_format_t;
267 typedef struct subs_format_t subs_format_t;
268 typedef struct es_format_t es_format_t;
269 typedef struct video_palette_t video_palette_t;
270
271 /* Audio */
272 typedef struct audio_output audio_output_t;
273 typedef struct aout_sys_t aout_sys_t;
274 typedef struct aout_fifo_t aout_fifo_t;
275 typedef struct aout_input_t aout_input_t;
276 typedef struct block_t aout_buffer_t;
277 typedef audio_format_t audio_sample_format_t;
278
279 /* Video */
280 typedef struct vout_thread_t vout_thread_t;
281
282 typedef video_format_t video_frame_format_t;
283 typedef struct picture_t picture_t;
284 typedef struct picture_sys_t picture_sys_t;
285
286 /* Subpictures */
287 typedef struct spu_t spu_t;
288 typedef struct subpicture_t subpicture_t;
289 typedef struct subpicture_sys_t subpicture_sys_t;
290 typedef struct subpicture_region_t subpicture_region_t;
291
292 typedef struct image_handler_t image_handler_t;
293
294 /* Stream output */
295 typedef struct sout_instance_t sout_instance_t;
296 typedef struct sout_instance_sys_t sout_instance_sys_t;
297
298 typedef struct sout_input_t sout_input_t;
299 typedef struct sout_packetizer_input_t sout_packetizer_input_t;
300
301 typedef struct sout_access_out_t sout_access_out_t;
302 typedef struct sout_access_out_sys_t   sout_access_out_sys_t;
303
304 typedef struct sout_mux_t sout_mux_t;
305 typedef struct sout_mux_sys_t sout_mux_sys_t;
306
307 typedef struct sout_stream_t    sout_stream_t;
308 typedef struct sout_stream_sys_t sout_stream_sys_t;
309
310 typedef struct config_chain_t       config_chain_t;
311 typedef struct session_descriptor_t session_descriptor_t;
312
313 /* Decoders */
314 typedef struct decoder_t         decoder_t;
315 typedef struct decoder_sys_t     decoder_sys_t;
316 typedef struct decoder_synchro_t decoder_synchro_t;
317
318 /* Encoders */
319 typedef struct encoder_t      encoder_t;
320 typedef struct encoder_sys_t  encoder_sys_t;
321
322 /* Filters */
323 typedef struct filter_t filter_t;
324 typedef struct filter_sys_t filter_sys_t;
325
326 /* Network */
327 typedef struct virtual_socket_t v_socket_t;
328 typedef struct vlc_url_t vlc_url_t;
329
330 /* Misc */
331 typedef struct iso639_lang_t iso639_lang_t;
332
333 /* block */
334 typedef struct block_t      block_t;
335 typedef struct block_fifo_t block_fifo_t;
336
337 /* Hashing */
338 typedef struct md5_s md5_t;
339
340 /* XML */
341 typedef struct xml_t xml_t;
342 typedef struct xml_sys_t xml_sys_t;
343 typedef struct xml_reader_t xml_reader_t;
344 typedef struct xml_reader_sys_t xml_reader_sys_t;
345
346 /* vod server */
347 typedef struct vod_t     vod_t;
348 typedef struct vod_sys_t vod_sys_t;
349 typedef struct vod_media_t vod_media_t;
350
351 /* osdmenu */
352 typedef struct osd_menu_t   osd_menu_t;
353 typedef struct osd_state_t  osd_state_t;
354 typedef struct osd_event_t  osd_event_t;
355 typedef struct osd_button_t osd_button_t;
356 typedef struct osd_menu_state_t osd_menu_state_t;
357
358 /* VLM */
359 typedef struct vlm_t         vlm_t;
360 typedef struct vlm_message_t vlm_message_t;
361
362 /* misc */
363 typedef struct vlc_meta_t    vlc_meta_t;
364 typedef struct input_stats_t input_stats_t;
365
366 /* Update */
367 typedef struct update_t update_t;
368 typedef struct update_iterator_t update_iterator_t;
369
370 /* Meta engine */
371 typedef struct meta_engine_t meta_engine_t;
372
373 /**
374  * VLC value structure
375  */
376 typedef union
377 {
378     int64_t         i_int;
379     bool            b_bool;
380     float           f_float;
381     char *          psz_string;
382     void *          p_address;
383     vlc_object_t *  p_object;
384     vlc_list_t *    p_list;
385     mtime_t         i_time;
386     struct { int32_t x; int32_t y; } coords;
387
388 } vlc_value_t;
389
390 /**
391  * VLC list structure
392  */
393 struct vlc_list_t
394 {
395     int             i_count;
396     vlc_value_t *   p_values;
397     int *           pi_types;
398
399 };
400
401 /*****************************************************************************
402  * Error values (shouldn't be exposed)
403  *****************************************************************************/
404 #define VLC_SUCCESS         -0                                   /* No error */
405 #define VLC_ENOMEM          -1                          /* Not enough memory */
406 #define VLC_ETIMEOUT        -3                                    /* Timeout */
407
408 #define VLC_ENOMOD         -10                           /* Module not found */
409
410 #define VLC_ENOOBJ         -20                           /* Object not found */
411
412 #define VLC_ENOVAR         -30                         /* Variable not found */
413 #define VLC_EBADVAR        -31                         /* Bad variable value */
414
415 #define VLC_ENOITEM        -40                           /**< Item not found */
416
417 #define VLC_EEXIT         -255                             /* Program exited */
418 #define VLC_EEXITSUCCESS  -999                /* Program exited successfully */
419 #define VLC_EGENERIC      -666                              /* Generic error */
420
421 /*****************************************************************************
422  * Variable callbacks
423  *****************************************************************************/
424 typedef int ( * vlc_callback_t ) ( vlc_object_t *,      /* variable's object */
425                                    char const *,            /* variable name */
426                                    vlc_value_t,                 /* old value */
427                                    vlc_value_t,                 /* new value */
428                                    void * );                /* callback data */
429
430 /*****************************************************************************
431  * OS-specific headers and thread types
432  *****************************************************************************/
433 #if defined( WIN32 ) || defined( UNDER_CE )
434 # include <windows.h>
435 #endif
436
437 #ifdef __OS2__
438 #   define OS2EMX_PLAIN_CHAR
439 #   define INCL_BASE
440 #   define INCL_PM
441 #   include <os2.h>
442 #endif
443
444 #include "vlc_mtime.h"
445 #include "vlc_threads.h"
446
447 /**
448  * Memory storage space for an atom. Never access it directly.
449  */
450 typedef union
451 {
452     volatile uintptr_t u;
453     volatile intptr_t  s;
454 } vlc_atomic_t;
455
456 /*****************************************************************************
457  * Common structure members
458  *****************************************************************************/
459
460 /* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
461 #define VLC_COMMON_MEMBERS                                                  \
462 /** \name VLC_COMMON_MEMBERS                                                \
463  * these members are common for all vlc objects                             \
464  */                                                                         \
465 /**@{*/                                                                     \
466     const char *psz_object_type;                                            \
467                                                                             \
468     /* Messages header */                                                   \
469     char *psz_header;                                                       \
470     int  i_flags;                                                           \
471                                                                             \
472     /* Object properties */                                                 \
473     volatile bool b_die;                   /**< set by the outside */ \
474     bool b_force;      /**< set by the outside (eg. module_need()) */ \
475                                                                             \
476     /* Stuff related to the libvlc structure */                             \
477     libvlc_int_t *p_libvlc;                  /**< (root of all evil) - 1 */ \
478                                                                             \
479     vlc_object_t *  p_parent;                            /**< our parent */ \
480                                                                             \
481 /**@}*/                                                                     \
482
483 /* VLC_OBJECT: attempt at doing a clever cast */
484 #if VLC_GCC_VERSION(4,0)
485 # ifndef __cplusplus
486 #  define VLC_OBJECT( x ) \
487     __builtin_choose_expr( \
488         __builtin_offsetof(__typeof__(*(x)), psz_object_type), \
489         (void)0 /* screw you */, \
490         (vlc_object_t *)(x))
491 # else
492 #  define VLC_OBJECT( x ) \
493     ((vlc_object_t *)(x) \
494       + 0 * __builtin_offsetof(__typeof__(*(x)), psz_object_type))
495 # endif
496 #else
497 # define VLC_OBJECT( x ) ((vlc_object_t *)(x))
498 #endif
499
500 typedef struct gc_object_t
501 {
502     vlc_atomic_t    refs;
503     void          (*pf_destructor) (struct gc_object_t *);
504 } gc_object_t;
505
506 /**
507  * These members are common to all objects that wish to be garbage-collected.
508  */
509 #define VLC_GC_MEMBERS gc_object_t vlc_gc_data;
510
511 VLC_API void * vlc_gc_init(gc_object_t *, void (*)(gc_object_t *));
512 VLC_API void * vlc_hold(gc_object_t *);
513 VLC_API void vlc_release(gc_object_t *);
514
515 #define vlc_gc_init( a,b ) vlc_gc_init( &(a)->vlc_gc_data, (b) )
516 #define vlc_gc_incref( a ) vlc_hold( &(a)->vlc_gc_data )
517 #define vlc_gc_decref( a ) vlc_release( &(a)->vlc_gc_data )
518 #define vlc_priv( gc, t ) ((t *)(((char *)(gc)) - offsetof(t, vlc_gc_data)))
519
520 /*****************************************************************************
521  * Macros and inline functions
522  *****************************************************************************/
523
524 /* CEIL: division with round to nearest greater integer */
525 #define CEIL(n, d)  ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
526
527 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
528 #define PAD(n, d)   ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
529
530 /* __MAX and __MIN: self explanatory */
531 #ifndef __MAX
532 #   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
533 #endif
534 #ifndef __MIN
535 #   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
536 #endif
537
538 /* clip v in [min, max] */
539 #define VLC_CLIP(v, min, max)    __MIN(__MAX((v), (min)), (max))
540
541 VLC_USED
542 static inline int64_t GCD ( int64_t a, int64_t b )
543 {
544     while( b )
545     {
546         int64_t c = a % b;
547         a = b;
548         b = c;
549     }
550     return a;
551 }
552
553 /* function imported from libavutil/common.h */
554 VLC_USED
555 static inline uint8_t clip_uint8_vlc( int32_t a )
556 {
557     if( a&(~255) ) return (-a)>>31;
558     else           return a;
559 }
560
561 /** Count leading zeroes */
562 VLC_USED
563 static inline unsigned clz (unsigned x)
564 {
565 #if VLC_GCC_VERSION(3,4)
566     return __builtin_clz (x);
567 #else
568     unsigned i = sizeof (x) * 8;
569
570     while (x)
571     {
572         x = x >> 1;
573         i--;
574     }
575     return i;
576 #endif
577 }
578
579 #define clz8( x ) (clz(x) - ((sizeof(unsigned) - sizeof (uint8_t)) * 8))
580 #define clz16( x ) (clz(x) - ((sizeof(unsigned) - sizeof (uint16_t)) * 8))
581 /* XXX: this assumes that int is 32-bits or more */
582 #define clz32( x ) (clz(x) - ((sizeof(unsigned) - sizeof (uint32_t)) * 8))
583
584 /** Bit weight */
585 VLC_USED
586 static inline unsigned popcount (unsigned x)
587 {
588 #if VLC_GCC_VERSION(3,4)
589     return __builtin_popcount (x);
590 #else
591     unsigned count = 0;
592     while (x)
593     {
594         count += x & 1;
595         x = x >> 1;
596     }
597     return count;
598 #endif
599 }
600
601 VLC_USED
602 static inline unsigned parity (unsigned x)
603 {
604 #if VLC_GCC_VERSION(3,4)
605     return __builtin_parity (x);
606 #else
607     for (unsigned i = 4 * sizeof (x); i > 0; i /= 2)
608         x ^= x >> i;
609     return x & 1;
610 #endif
611 }
612
613 #ifdef __OS2__
614 #   undef bswap16
615 #   undef bswap32
616 #   undef bswap64
617 #endif
618
619 /** Byte swap (16 bits) */
620 VLC_USED
621 static inline uint16_t bswap16 (uint16_t x)
622 {
623     return (x << 8) | (x >> 8);
624 }
625
626 /** Byte swap (32 bits) */
627 VLC_USED
628 static inline uint32_t bswap32 (uint32_t x)
629 {
630 #if VLC_GCC_VERSION(4,3)
631     return __builtin_bswap32 (x);
632 #else
633     return ((x & 0x000000FF) << 24)
634          | ((x & 0x0000FF00) <<  8)
635          | ((x & 0x00FF0000) >>  8)
636          | ((x & 0xFF000000) >> 24);
637 #endif
638 }
639
640 /** Byte swap (64 bits) */
641 VLC_USED
642 static inline uint64_t bswap64 (uint64_t x)
643 {
644 #if VLC_GCC_VERSION(4,3)
645     return __builtin_bswap64 (x);
646 #elif !defined (__cplusplus)
647     return ((x & 0x00000000000000FF) << 56)
648          | ((x & 0x000000000000FF00) << 40)
649          | ((x & 0x0000000000FF0000) << 24)
650          | ((x & 0x00000000FF000000) <<  8)
651          | ((x & 0x000000FF00000000) >>  8)
652          | ((x & 0x0000FF0000000000) >> 24)
653          | ((x & 0x00FF000000000000) >> 40)
654          | ((x & 0xFF00000000000000) >> 56);
655 #else
656     return ((x & 0x00000000000000FFLLU) << 56)
657          | ((x & 0x000000000000FF00LLU) << 40)
658          | ((x & 0x0000000000FF0000LLU) << 24)
659          | ((x & 0x00000000FF000000LLU) <<  8)
660          | ((x & 0x000000FF00000000LLU) >>  8)
661          | ((x & 0x0000FF0000000000LLU) >> 24)
662          | ((x & 0x00FF000000000000LLU) >> 40)
663          | ((x & 0xFF00000000000000LLU) >> 56);
664 #endif
665 }
666
667
668 /* Free and set set the variable to NULL */
669 #define FREENULL(a) do { free( a ); a = NULL; } while(0)
670
671 #define EMPTY_STR(str) (!str || !*str)
672
673 VLC_API char const * vlc_error( int ) VLC_USED;
674
675 #include <vlc_arrays.h>
676
677 /* MSB (big endian)/LSB (little endian) conversions - network order is always
678  * MSB, and should be used for both network communications and files. */
679
680 #ifdef WORDS_BIGENDIAN
681 # define hton16(i) ((uint16_t)(i))
682 # define hton32(i) ((uint32_t)(i))
683 # define hton64(i) ((uint64_t)(i))
684 #else
685 # define hton16(i) bswap16(i)
686 # define hton32(i) bswap32(i)
687 # define hton64(i) bswap64(i)
688 #endif
689 #define ntoh16(i) hton16(i)
690 #define ntoh32(i) hton32(i)
691 #define ntoh64(i) hton64(i)
692
693 /** Reads 16 bits in network byte order */
694 VLC_USED
695 static inline uint16_t U16_AT (const void *p)
696 {
697     uint16_t x;
698
699     memcpy (&x, p, sizeof (x));
700     return ntoh16 (x);
701 }
702
703 /** Reads 32 bits in network byte order */
704 VLC_USED
705 static inline uint32_t U32_AT (const void *p)
706 {
707     uint32_t x;
708
709     memcpy (&x, p, sizeof (x));
710     return ntoh32 (x);
711 }
712
713 /** Reads 64 bits in network byte order */
714 VLC_USED
715 static inline uint64_t U64_AT (const void *p)
716 {
717     uint64_t x;
718
719     memcpy (&x, p, sizeof (x));
720     return ntoh64 (x);
721 }
722
723 #define GetWBE(p)  U16_AT(p)
724 #define GetDWBE(p) U32_AT(p)
725 #define GetQWBE(p) U64_AT(p)
726
727 /** Reads 16 bits in little-endian order */
728 VLC_USED
729 static inline uint16_t GetWLE (const void *p)
730 {
731     uint16_t x;
732
733     memcpy (&x, p, sizeof (x));
734 #ifdef WORDS_BIGENDIAN
735     x = bswap16 (x);
736 #endif
737     return x;
738 }
739
740 /** Reads 32 bits in little-endian order */
741 VLC_USED
742 static inline uint32_t GetDWLE (const void *p)
743 {
744     uint32_t x;
745
746     memcpy (&x, p, sizeof (x));
747 #ifdef WORDS_BIGENDIAN
748     x = bswap32 (x);
749 #endif
750     return x;
751 }
752
753 /** Reads 64 bits in little-endian order */
754 VLC_USED
755 static inline uint64_t GetQWLE (const void *p)
756 {
757     uint64_t x;
758
759     memcpy (&x, p, sizeof (x));
760 #ifdef WORDS_BIGENDIAN
761     x = bswap64 (x);
762 #endif
763     return x;
764 }
765
766 /** Writes 16 bits in network byte order */
767 static inline void SetWBE (void *p, uint16_t w)
768 {
769     w = hton16 (w);
770     memcpy (p, &w, sizeof (w));
771 }
772
773 /** Writes 32 bits in network byte order */
774 static inline void SetDWBE (void *p, uint32_t dw)
775 {
776     dw = hton32 (dw);
777     memcpy (p, &dw, sizeof (dw));
778 }
779
780 /** Writes 64 bits in network byte order */
781 static inline void SetQWBE (void *p, uint64_t qw)
782 {
783     qw = hton64 (qw);
784     memcpy (p, &qw, sizeof (qw));
785 }
786
787 /** Writes 16 bits in little endian order */
788 static inline void SetWLE (void *p, uint16_t w)
789 {
790 #ifdef WORDS_BIGENDIAN
791     w = bswap16 (w);
792 #endif
793     memcpy (p, &w, sizeof (w));
794 }
795
796 /** Writes 32 bits in little endian order */
797 static inline void SetDWLE (void *p, uint32_t dw)
798 {
799 #ifdef WORDS_BIGENDIAN
800     dw = bswap32 (dw);
801 #endif
802     memcpy (p, &dw, sizeof (dw));
803 }
804
805 /** Writes 64 bits in little endian order */
806 static inline void SetQWLE (void *p, uint64_t qw)
807 {
808 #ifdef WORDS_BIGENDIAN
809     qw = bswap64 (qw);
810 #endif
811     memcpy (p, &qw, sizeof (qw));
812 }
813
814 /* */
815 #define VLC_UNUSED(x) (void)(x)
816
817 /* Stuff defined in src/extras/libc.c */
818
819 #if defined(WIN32) || defined(UNDER_CE)
820 /* win32, cl and icl support */
821 #   if defined( _MSC_VER ) || !defined( __MINGW32__ )
822 #       define __attribute__(x)
823 #       define S_IFBLK         0x3000  /* Block */
824 #       define S_ISBLK(m)      (0)
825 #       define S_ISCHR(m)      (0)
826 #       define S_ISFIFO(m)     (((m)&_S_IFMT) == _S_IFIFO)
827 #       define S_ISREG(m)      (((m)&_S_IFMT) == _S_IFREG)
828 #   endif
829
830 /* several type definitions */
831 #   if defined( __MINGW32__ )
832 #       if !defined( _OFF_T_ )
833             typedef long long _off_t;
834             typedef _off_t off_t;
835 #           define _OFF_T_
836 #       else
837 #           ifdef off_t
838 #               undef off_t
839 #           endif
840 #           define off_t long long
841 #       endif
842 #   endif
843
844 #   if defined( _MSC_VER )
845 #       if !defined( _OFF_T_DEFINED )
846             typedef __int64 off_t;
847 #           define _OFF_T_DEFINED
848 #       else
849             /* for wx compatibility typedef long off_t; */
850 #           define off_t __int64
851 #       endif
852 #   endif
853
854 #   if defined( __BORLANDC__ )
855 #       undef off_t
856 #       define off_t unsigned __int64
857 #   endif
858
859 #   ifndef O_NONBLOCK
860 #       define O_NONBLOCK 0
861 #   endif
862
863 #   ifndef alloca
864 #       define alloca _alloca
865 #   endif
866
867 #   include <tchar.h>
868 #endif
869
870 VLC_API bool vlc_ureduce( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t );
871
872 /* Aligned memory allocator */
873 #ifdef __APPLE__
874 #include <AvailabilityMacros.h>
875 #endif
876
877 #ifdef WIN32
878 # include <malloc.h>
879 # define vlc_memalign(align, size) (__mingw_aligned_malloc(size, align))
880 # define vlc_free(base)            (__mingw_aligned_free(base))
881 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
882 static inline void *vlc_memalign(size_t align, size_t size)
883 {
884     long diff;
885     void *ptr;
886
887     ptr = malloc(size+align);
888     if(!ptr)
889         return ptr;
890     diff = ((-(long)ptr - 1)&(align-1)) + 1;
891     ptr  = (char*)ptr + diff;
892     ((char*)ptr)[-1]= diff;
893     return ptr;
894 }
895
896 static void vlc_free(void *ptr)
897 {
898     if (ptr)
899         free((char*)ptr - ((char*)ptr)[-1]);
900 }
901 #else
902 static inline void *vlc_memalign(size_t align, size_t size)
903 {
904     void *base;
905     if (unlikely(posix_memalign(&base, align, size)))
906         base = NULL;
907     return base;
908 }
909 # define vlc_free(base) free(base)
910 #endif
911
912 VLC_API void vlc_tdestroy( void *, void (*)(void *) );
913
914 /* Fast large memory copy and memory set */
915 VLC_API void * vlc_memcpy( void *, const void *, size_t );
916 #define vlc_memset memset
917
918 /*****************************************************************************
919  * I18n stuff
920  *****************************************************************************/
921 VLC_API char *vlc_gettext( const char *msgid ) VLC_FORMAT_ARG(1);
922 VLC_API char *vlc_ngettext( const char *s, const char *p, unsigned long n ) VLC_FORMAT_ARG(1) VLC_FORMAT_ARG(2);
923
924 #define vlc_pgettext( ctx, id ) \
925         vlc_pgettext_aux( ctx "\004" id, id )
926
927 VLC_FORMAT_ARG(2)
928 static inline const char *vlc_pgettext_aux( const char *ctx, const char *id )
929 {
930     const char *tr = vlc_gettext( ctx );
931     return (tr == ctx) ? id : tr;
932 }
933
934 /*****************************************************************************
935  * Loosy memory allocation functions. Do not use in new code.
936  *****************************************************************************/
937 static inline void *xmalloc (size_t len)
938 {
939     void *ptr = malloc (len);
940     if (unlikely (ptr == NULL))
941         abort ();
942     return ptr;
943 }
944
945 static inline void *xrealloc (void *ptr, size_t len)
946 {
947     void *nptr = realloc (ptr, len);
948     if (unlikely (nptr == NULL))
949         abort ();
950     return nptr;
951 }
952
953 static inline void *xcalloc (size_t n, size_t size)
954 {
955     void *ptr = calloc (n, size);
956     if (unlikely (ptr == NULL))
957         abort ();
958     return ptr;
959 }
960
961 /*****************************************************************************
962  * libvlc features
963  *****************************************************************************/
964 VLC_API const char * VLC_CompileBy( void ) VLC_USED;
965 VLC_API const char * VLC_CompileHost( void ) VLC_USED;
966 VLC_API const char * VLC_Compiler( void ) VLC_USED;
967
968 /*****************************************************************************
969  * Additional vlc stuff
970  *****************************************************************************/
971 #include "vlc_messages.h"
972 #include "vlc_objects.h"
973 #include "vlc_variables.h"
974 #include "vlc_main.h"
975 #include "vlc_configuration.h"
976
977 #if defined( WIN32 ) || defined( UNDER_CE ) || defined( __SYMBIAN32__ ) || defined( __OS2__ )
978 #   define DIR_SEP_CHAR '\\'
979 #   define DIR_SEP "\\"
980 #   define PATH_SEP_CHAR ';'
981 #   define PATH_SEP ";"
982 #else
983 #   define DIR_SEP_CHAR '/'
984 #   define DIR_SEP "/"
985 #   define PATH_SEP_CHAR ':'
986 #   define PATH_SEP ":"
987 #endif
988
989 #define LICENSE_MSG \
990   _("This program comes with NO WARRANTY, to the extent permitted by " \
991     "law.\nYou may redistribute it under the terms of the GNU General " \
992     "Public License;\nsee the file named COPYING for details.\n" \
993     "Written by the VideoLAN team; see the AUTHORS file.\n")
994
995 #endif /* !VLC_COMMON_H */