araw: handle error
[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 #include "vlc_config.h"
39
40 /*****************************************************************************
41  * Required system headers
42  *****************************************************************************/
43 #include <stdlib.h>
44 #include <stdarg.h>
45
46 #include <string.h>
47 #include <stdio.h>
48 #include <inttypes.h>
49 #include <stddef.h>
50
51 #ifndef __cplusplus
52 # include <stdbool.h>
53 #endif
54
55 /*****************************************************************************
56  * Compilers definitions
57  *****************************************************************************/
58 /* Helper for GCC version checks */
59 #ifdef __GNUC__
60 # define VLC_GCC_VERSION(maj,min) \
61     ((__GNUC__ > (maj)) || (__GNUC__ == (maj) && __GNUC_MINOR__ >= (min)))
62 #else
63 # define VLC_GCC_VERSION(maj,min) (0)
64 #endif
65
66 /* Try to fix format strings for all versions of mingw and mingw64 */
67 #if defined( _WIN32 ) && defined( __USE_MINGW_ANSI_STDIO )
68  #undef PRId64
69  #define PRId64 "lld"
70  #undef PRIi64
71  #define PRIi64 "lli"
72  #undef PRIu64
73  #define PRIu64 "llu"
74  #undef PRIo64
75  #define PRIo64 "llo"
76  #undef PRIx64
77  #define PRIx64 "llx"
78  #define snprintf __mingw_snprintf
79  #define vsnprintf __mingw_vsnprintf
80  #define swprintf _snwprintf
81 #endif
82
83 /* Function attributes for compiler warnings */
84 #ifdef __GNUC__
85 # define VLC_DEPRECATED __attribute__((deprecated))
86
87 # if defined( _WIN32 )
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 # define VLC_MALLOC __attribute__ ((malloc))
94 # define VLC_USED __attribute__ ((warn_unused_result))
95
96 #else
97 # define VLC_DEPRECATED
98 # define VLC_FORMAT(x,y)
99 # define VLC_FORMAT_ARG(x)
100 # define VLC_MALLOC
101 # define VLC_USED
102 #endif
103
104
105 /* Branch prediction */
106 #ifdef __GNUC__
107 # define likely(p)     __builtin_expect(!!(p), 1)
108 # define unlikely(p)   __builtin_expect(!!(p), 0)
109 # define unreachable() __builtin_unreachable()
110 #else
111 # define likely(p)     (!!(p))
112 # define unlikely(p)   (!!(p))
113 # define unreachable() ((void)0)
114 #endif
115
116 #define vlc_assert_unreachable() (assert(!"unreachable"), unreachable())
117
118 /* Linkage */
119 #ifdef __cplusplus
120 # define VLC_EXTERN extern "C"
121 #else
122 # define VLC_EXTERN
123 #endif
124
125 #if defined (_WIN32) && defined (DLL_EXPORT)
126 # define VLC_EXPORT __declspec(dllexport)
127 #elif defined (__GNUC__)
128 # define VLC_EXPORT __attribute__((visibility("default")))
129 #else
130 # define VLC_EXPORT
131 #endif
132
133 #define VLC_API VLC_EXTERN VLC_EXPORT
134
135
136 /*****************************************************************************
137  * Basic types definitions
138  *****************************************************************************/
139 /**
140  * High precision date or time interval
141  *
142  * Store a high precision date or time interval. The maximum precision is the
143  * microsecond, and a 64 bits integer is used to avoid overflows (maximum
144  * time interval is then 292271 years, which should be long enough for any
145  * video). Dates are stored as microseconds since a common date (usually the
146  * epoch). Note that date and time intervals can be manipulated using regular
147  * arithmetic operators, and that no special functions are required.
148  */
149 typedef int64_t mtime_t;
150
151 /**
152  * The vlc_fourcc_t type.
153  *
154  * See http://www.webartz.com/fourcc/ for a very detailed list.
155  */
156 typedef uint32_t vlc_fourcc_t;
157
158 #ifdef WORDS_BIGENDIAN
159 #   define VLC_FOURCC( a, b, c, d ) \
160         ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
161            | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
162 #   define VLC_TWOCC( a, b ) \
163         ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )
164
165 #else
166 #   define VLC_FOURCC( a, b, c, d ) \
167         ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
168            | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
169 #   define VLC_TWOCC( a, b ) \
170         ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )
171
172 #endif
173
174 /**
175  * Translate a vlc_fourcc into its string representation. This function
176  * assumes there is enough room in psz_fourcc to store 4 characters in.
177  *
178  * \param fcc a vlc_fourcc_t
179  * \param psz_fourcc string to store string representation of vlc_fourcc in
180  */
181 static inline void vlc_fourcc_to_char( vlc_fourcc_t fcc, char *psz_fourcc )
182 {
183     memcpy( psz_fourcc, &fcc, 4 );
184 }
185
186 /*****************************************************************************
187  * Classes declaration
188  *****************************************************************************/
189
190 /* Internal types */
191 typedef struct vlc_list_t vlc_list_t;
192 typedef struct vlc_object_t vlc_object_t;
193 typedef struct libvlc_int_t libvlc_int_t;
194 typedef struct date_t date_t;
195
196 /* Playlist */
197
198 typedef struct playlist_t playlist_t;
199 typedef struct playlist_item_t playlist_item_t;
200 typedef struct services_discovery_t services_discovery_t;
201 typedef struct services_discovery_sys_t services_discovery_sys_t;
202 typedef struct vlc_renderer_discovery_t vlc_renderer_discovery_t;
203 typedef struct vlc_renderer_item_t vlc_renderer_item_t;
204
205 /* Modules */
206 typedef struct module_t module_t;
207 typedef struct module_config_t module_config_t;
208
209 typedef struct config_category_t config_category_t;
210
211 /* Input */
212 typedef struct input_thread_t input_thread_t;
213 typedef struct input_item_t input_item_t;
214 typedef struct input_item_node_t input_item_node_t;
215 typedef struct access_sys_t access_sys_t;
216 typedef struct stream_t     stream_t;
217 typedef struct stream_sys_t stream_sys_t;
218 typedef struct demux_t  demux_t;
219 typedef struct demux_sys_t demux_sys_t;
220 typedef struct es_out_t     es_out_t;
221 typedef struct es_out_id_t  es_out_id_t;
222 typedef struct es_out_sys_t es_out_sys_t;
223 typedef struct seekpoint_t seekpoint_t;
224 typedef struct info_t info_t;
225 typedef struct info_category_t info_category_t;
226 typedef struct input_attachment_t input_attachment_t;
227
228 /* Format */
229 typedef struct audio_format_t audio_format_t;
230 typedef struct video_format_t video_format_t;
231 typedef struct subs_format_t subs_format_t;
232 typedef struct es_format_t es_format_t;
233 typedef struct video_palette_t video_palette_t;
234
235 /* Audio */
236 typedef struct audio_output audio_output_t;
237 typedef struct aout_sys_t aout_sys_t;
238 typedef audio_format_t audio_sample_format_t;
239
240 /* Video */
241 typedef struct vout_thread_t vout_thread_t;
242 typedef struct vlc_viewpoint_t vlc_viewpoint_t;
243
244 typedef video_format_t video_frame_format_t;
245 typedef struct picture_t picture_t;
246 typedef struct picture_sys_t picture_sys_t;
247
248 /* Subpictures */
249 typedef struct spu_t spu_t;
250 typedef struct subpicture_t subpicture_t;
251 typedef struct subpicture_region_t subpicture_region_t;
252
253 typedef struct image_handler_t image_handler_t;
254
255 /* Stream output */
256 typedef struct sout_instance_t sout_instance_t;
257
258 typedef struct sout_input_t sout_input_t;
259 typedef struct sout_packetizer_input_t sout_packetizer_input_t;
260
261 typedef struct sout_access_out_t sout_access_out_t;
262 typedef struct sout_access_out_sys_t   sout_access_out_sys_t;
263
264 typedef struct sout_mux_t sout_mux_t;
265 typedef struct sout_mux_sys_t sout_mux_sys_t;
266
267 typedef struct sout_stream_t    sout_stream_t;
268 typedef struct sout_stream_sys_t sout_stream_sys_t;
269
270 typedef struct config_chain_t       config_chain_t;
271 typedef struct session_descriptor_t session_descriptor_t;
272
273 /* Decoders */
274 typedef struct decoder_t         decoder_t;
275 typedef struct decoder_sys_t     decoder_sys_t;
276 typedef struct decoder_synchro_t decoder_synchro_t;
277
278 /* Encoders */
279 typedef struct encoder_t      encoder_t;
280 typedef struct encoder_sys_t  encoder_sys_t;
281
282 /* Filters */
283 typedef struct filter_t filter_t;
284 typedef struct filter_sys_t filter_sys_t;
285
286 /* Network */
287 typedef struct vlc_url_t vlc_url_t;
288
289 /* Misc */
290 typedef struct iso639_lang_t iso639_lang_t;
291
292 /* block */
293 typedef struct block_t      block_t;
294 typedef struct block_fifo_t block_fifo_t;
295
296 /* Hashing */
297 typedef struct md5_s md5_t;
298
299 /* XML */
300 typedef struct xml_t xml_t;
301 typedef struct xml_sys_t xml_sys_t;
302 typedef struct xml_reader_t xml_reader_t;
303 typedef struct xml_reader_sys_t xml_reader_sys_t;
304
305 /* vod server */
306 typedef struct vod_t     vod_t;
307 typedef struct vod_sys_t vod_sys_t;
308 typedef struct vod_media_t vod_media_t;
309
310 /* VLM */
311 typedef struct vlm_t         vlm_t;
312 typedef struct vlm_message_t vlm_message_t;
313
314 /* misc */
315 typedef struct vlc_meta_t    vlc_meta_t;
316 typedef struct input_stats_t input_stats_t;
317 typedef struct addon_entry_t addon_entry_t;
318
319 /* Update */
320 typedef struct update_t update_t;
321
322 /**
323  * VLC value structure
324  */
325 typedef union
326 {
327     int64_t         i_int;
328     bool            b_bool;
329     float           f_float;
330     char *          psz_string;
331     void *          p_address;
332     vlc_list_t *    p_list;
333     struct { int32_t x; int32_t y; } coords;
334
335 } vlc_value_t;
336
337 /**
338  * VLC list structure
339  */
340 struct vlc_list_t
341 {
342     int          i_type;
343     int          i_count;
344     vlc_value_t *p_values;
345 };
346
347 /*****************************************************************************
348  * Error values (shouldn't be exposed)
349  *****************************************************************************/
350 #define VLC_SUCCESS        (-0) /**< No error */
351 #define VLC_EGENERIC       (-1) /**< Unspecified error */
352 #define VLC_ENOMEM         (-2) /**< Not enough memory */
353 #define VLC_ETIMEOUT       (-3) /**< Timeout */
354 #define VLC_ENOMOD         (-4) /**< Module not found */
355 #define VLC_ENOOBJ         (-5) /**< Object not found */
356 #define VLC_ENOVAR         (-6) /**< Variable not found */
357 #define VLC_EBADVAR        (-7) /**< Bad variable value */
358 #define VLC_ENOITEM        (-8) /**< Item not found */
359
360 /*****************************************************************************
361  * Variable callbacks: called when the value is modified
362  *****************************************************************************/
363 typedef int ( * vlc_callback_t ) ( vlc_object_t *,      /* variable's object */
364                                    char const *,            /* variable name */
365                                    vlc_value_t,                 /* old value */
366                                    vlc_value_t,                 /* new value */
367                                    void * );                /* callback data */
368
369 /*****************************************************************************
370  * List callbacks: called when elements are added/removed from the list
371  *****************************************************************************/
372 typedef int ( * vlc_list_callback_t ) ( vlc_object_t *,      /* variable's object */
373                                         char const *,            /* variable name */
374                                         int,                  /* VLC_VAR_* action */
375                                         vlc_value_t *,      /* new/deleted value  */
376                                         void *);                 /* callback data */
377
378 /*****************************************************************************
379  * OS-specific headers and thread types
380  *****************************************************************************/
381 #if defined( _WIN32 )
382 #   include <malloc.h>
383 #   ifndef PATH_MAX
384 #       define PATH_MAX MAX_PATH
385 #   endif
386 #   include <windows.h>
387 #endif
388
389 #ifdef __APPLE__
390 #include <sys/syslimits.h>
391 #include <AvailabilityMacros.h>
392 #endif
393
394 #ifdef __OS2__
395 #   define OS2EMX_PLAIN_CHAR
396 #   define INCL_BASE
397 #   define INCL_PM
398 #   include <os2safe.h>
399 #   include <os2.h>
400 #endif
401
402 #include "vlc_mtime.h"
403 #include "vlc_threads.h"
404
405 /**
406  * Common structure members
407  *****************************************************************************/
408
409 /**
410  * VLC object common members
411  *
412  * Common public properties for all VLC objects.
413  * Object also have private properties maintained by the core, see
414  * \ref vlc_object_internals_t
415  */
416 struct vlc_common_members
417 {
418     /** Object type name
419      *
420      * A constant string identifying the type of the object (for logging)
421      */
422     const char *object_type;
423
424     /** Log messages header
425      *
426      * Human-readable header for log messages. This is not thread-safe and
427      * only used by VLM and Lua interfaces.
428      */
429     char *header;
430
431     int  flags;
432
433     /** Module probe flag
434      *
435      * A boolean during module probing when the probe is "forced".
436      * See \ref module_need().
437      */
438     bool force;
439
440     /** LibVLC instance
441      *
442      * Root VLC object of the objects tree that this object belongs in.
443      */
444     libvlc_int_t *libvlc;
445
446     /** Parent object
447      *
448      * The parent VLC object in the objects tree. For the root (the LibVLC
449      * instance) object, this is NULL.
450      */
451     vlc_object_t *parent;
452 };
453
454 /**
455  * Backward compatibility macro
456  */
457 #define VLC_COMMON_MEMBERS struct vlc_common_members obj;
458
459 /**
460  * Type-safe vlc_object_t cast
461  *
462  * This macro attempts to cast a pointer to a compound type to a
463  * \ref vlc_object_t pointer in a type-safe manner.
464  * It checks if the compound type actually starts with an embedded
465  * \ref vlc_object_t structure.
466  */
467 #if !defined(__cplusplus) && (__STDC_VERSION__ >= 201112L)
468 # define VLC_OBJECT(x) \
469     _Generic((x)->obj, \
470         struct vlc_common_members: (vlc_object_t *)(&(x)->obj), \
471         const struct vlc_common_members: (const vlc_object_t *)(&(x)->obj) \
472     )
473 #elif defined (__GNUC__)
474 # ifndef __cplusplus
475 #  define VLC_OBJECT( x ) \
476     __builtin_choose_expr( \
477         __builtin_types_compatible_p(__typeof__((x)->obj), struct vlc_common_members), \
478         (vlc_object_t *)(x), (void)0)
479 # else
480 #  define VLC_OBJECT( x ) \
481     ((vlc_object_t *)(&((x)->obj)) \
482       + 0 * __builtin_offsetof(__typeof__(*(x)), obj.object_type))
483 # endif
484 #else
485 # define VLC_OBJECT( x ) ((vlc_object_t *)&(x)->obj)
486 #endif
487
488 /*****************************************************************************
489  * Macros and inline functions
490  *****************************************************************************/
491
492 /* CEIL: division with round to nearest greater integer */
493 #define CEIL(n, d)  ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
494
495 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
496 #define PAD(n, d)   ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
497
498 /* __MAX and __MIN: self explanatory */
499 #ifndef __MAX
500 #   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
501 #endif
502 #ifndef __MIN
503 #   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
504 #endif
505
506 /* clip v in [min, max] */
507 #define VLC_CLIP(v, min, max)    __MIN(__MAX((v), (min)), (max))
508
509 VLC_USED
510 static inline int64_t GCD ( int64_t a, int64_t b )
511 {
512     while( b )
513     {
514         int64_t c = a % b;
515         a = b;
516         b = c;
517     }
518     return a;
519 }
520
521 /* function imported from libavutil/common.h */
522 VLC_USED
523 static inline uint8_t clip_uint8_vlc( int32_t a )
524 {
525     if( a&(~255) ) return (-a)>>31;
526     else           return a;
527 }
528
529 /** Count leading zeroes */
530 VLC_USED
531 static inline unsigned (clz)(unsigned x)
532 {
533 #ifdef __GNUC__
534     return __builtin_clz (x);
535 #else
536     unsigned i = sizeof (x) * 8;
537
538     while (x)
539     {
540         x >>= 1;
541         i--;
542     }
543     return i;
544 #endif
545 }
546
547 #define clz8( x ) (clz(x) - ((sizeof(unsigned) - sizeof (uint8_t)) * 8))
548 #define clz16( x ) (clz(x) - ((sizeof(unsigned) - sizeof (uint16_t)) * 8))
549 /* XXX: this assumes that int is 32-bits or more */
550 #define clz32( x ) (clz(x) - ((sizeof(unsigned) - sizeof (uint32_t)) * 8))
551
552 /** Count trailing zeroes */
553 VLC_USED
554 static inline unsigned (ctz)(unsigned x)
555 {
556 #ifdef __GNUC__
557     return __builtin_ctz (x);
558 #else
559     unsigned i = sizeof (x) * 8;
560
561     while (x)
562     {
563         x <<= 1;
564         i--;
565     }
566     return i;
567 #endif
568 }
569
570 /** Bit weight */
571 VLC_USED
572 static inline unsigned (popcount)(unsigned x)
573 {
574 #ifdef __GNUC__
575     return __builtin_popcount (x);
576 #else
577     unsigned count = 0;
578     while (x)
579     {
580         count += x & 1;
581         x = x >> 1;
582     }
583     return count;
584 #endif
585 }
586
587 /** Bit weight of long long */
588 VLC_USED
589 static inline int (popcountll)(unsigned long long x)
590 {
591 #ifdef __GNUC__
592     return __builtin_popcountll(x);
593 #else
594     int count = 0;
595     while (x)
596     {
597         count += x & 1;
598         x = x >> 1;
599     }
600     return count;
601 #endif
602 }
603
604 VLC_USED
605 static inline unsigned (parity)(unsigned x)
606 {
607 #ifdef __GNUC__
608     return __builtin_parity (x);
609 #else
610     for (unsigned i = 4 * sizeof (x); i > 0; i /= 2)
611         x ^= x >> i;
612     return x & 1;
613 #endif
614 }
615
616 /** Byte swap (16 bits) */
617 VLC_USED
618 static inline uint16_t (bswap16)(uint16_t x)
619 {
620     return (x << 8) | (x >> 8);
621 }
622
623 /** Byte swap (32 bits) */
624 VLC_USED
625 static inline uint32_t (bswap32)(uint32_t x)
626 {
627 #if defined (__GNUC__) || defined(__clang__)
628     return __builtin_bswap32 (x);
629 #else
630     return ((x & 0x000000FF) << 24)
631          | ((x & 0x0000FF00) <<  8)
632          | ((x & 0x00FF0000) >>  8)
633          | ((x & 0xFF000000) >> 24);
634 #endif
635 }
636
637 /** Byte swap (64 bits) */
638 VLC_USED
639 static inline uint64_t (bswap64)(uint64_t x)
640 {
641 #if defined (__GNUC__) || defined(__clang__)
642     return __builtin_bswap64 (x);
643 #elif !defined (__cplusplus)
644     return ((x & 0x00000000000000FF) << 56)
645          | ((x & 0x000000000000FF00) << 40)
646          | ((x & 0x0000000000FF0000) << 24)
647          | ((x & 0x00000000FF000000) <<  8)
648          | ((x & 0x000000FF00000000) >>  8)
649          | ((x & 0x0000FF0000000000) >> 24)
650          | ((x & 0x00FF000000000000) >> 40)
651          | ((x & 0xFF00000000000000) >> 56);
652 #else
653     return ((x & 0x00000000000000FFULL) << 56)
654          | ((x & 0x000000000000FF00ULL) << 40)
655          | ((x & 0x0000000000FF0000ULL) << 24)
656          | ((x & 0x00000000FF000000ULL) <<  8)
657          | ((x & 0x000000FF00000000ULL) >>  8)
658          | ((x & 0x0000FF0000000000ULL) >> 24)
659          | ((x & 0x00FF000000000000ULL) >> 40)
660          | ((x & 0xFF00000000000000ULL) >> 56);
661 #endif
662 }
663
664
665 /* Free and set set the variable to NULL */
666 #define FREENULL(a) do { free( a ); a = NULL; } while(0)
667
668 #define EMPTY_STR(str) (!str || !*str)
669
670 VLC_API char const * vlc_error( int ) VLC_USED;
671
672 #include <vlc_arrays.h>
673
674 /* MSB (big endian)/LSB (little endian) conversions - network order is always
675  * MSB, and should be used for both network communications and files. */
676
677 #ifdef WORDS_BIGENDIAN
678 # define hton16(i) ((uint16_t)(i))
679 # define hton32(i) ((uint32_t)(i))
680 # define hton64(i) ((uint64_t)(i))
681 #else
682 # define hton16(i) bswap16(i)
683 # define hton32(i) bswap32(i)
684 # define hton64(i) bswap64(i)
685 #endif
686 #define ntoh16(i) hton16(i)
687 #define ntoh32(i) hton32(i)
688 #define ntoh64(i) hton64(i)
689
690 /** Reads 16 bits in network byte order */
691 VLC_USED
692 static inline uint16_t U16_AT (const void *p)
693 {
694     uint16_t x;
695
696     memcpy (&x, p, sizeof (x));
697     return ntoh16 (x);
698 }
699
700 /** Reads 32 bits in network byte order */
701 VLC_USED
702 static inline uint32_t U32_AT (const void *p)
703 {
704     uint32_t x;
705
706     memcpy (&x, p, sizeof (x));
707     return ntoh32 (x);
708 }
709
710 /** Reads 64 bits in network byte order */
711 VLC_USED
712 static inline uint64_t U64_AT (const void *p)
713 {
714     uint64_t x;
715
716     memcpy (&x, p, sizeof (x));
717     return ntoh64 (x);
718 }
719
720 #define GetWBE(p)  U16_AT(p)
721 #define GetDWBE(p) U32_AT(p)
722 #define GetQWBE(p) U64_AT(p)
723
724 /** Reads 16 bits in little-endian order */
725 VLC_USED
726 static inline uint16_t GetWLE (const void *p)
727 {
728     uint16_t x;
729
730     memcpy (&x, p, sizeof (x));
731 #ifdef WORDS_BIGENDIAN
732     x = bswap16 (x);
733 #endif
734     return x;
735 }
736
737 /** Reads 32 bits in little-endian order */
738 VLC_USED
739 static inline uint32_t GetDWLE (const void *p)
740 {
741     uint32_t x;
742
743     memcpy (&x, p, sizeof (x));
744 #ifdef WORDS_BIGENDIAN
745     x = bswap32 (x);
746 #endif
747     return x;
748 }
749
750 /** Reads 64 bits in little-endian order */
751 VLC_USED
752 static inline uint64_t GetQWLE (const void *p)
753 {
754     uint64_t x;
755
756     memcpy (&x, p, sizeof (x));
757 #ifdef WORDS_BIGENDIAN
758     x = bswap64 (x);
759 #endif
760     return x;
761 }
762
763 /** Writes 16 bits in network byte order */
764 static inline void SetWBE (void *p, uint16_t w)
765 {
766     w = hton16 (w);
767     memcpy (p, &w, sizeof (w));
768 }
769
770 /** Writes 32 bits in network byte order */
771 static inline void SetDWBE (void *p, uint32_t dw)
772 {
773     dw = hton32 (dw);
774     memcpy (p, &dw, sizeof (dw));
775 }
776
777 /** Writes 64 bits in network byte order */
778 static inline void SetQWBE (void *p, uint64_t qw)
779 {
780     qw = hton64 (qw);
781     memcpy (p, &qw, sizeof (qw));
782 }
783
784 /** Writes 16 bits in little endian order */
785 static inline void SetWLE (void *p, uint16_t w)
786 {
787 #ifdef WORDS_BIGENDIAN
788     w = bswap16 (w);
789 #endif
790     memcpy (p, &w, sizeof (w));
791 }
792
793 /** Writes 32 bits in little endian order */
794 static inline void SetDWLE (void *p, uint32_t dw)
795 {
796 #ifdef WORDS_BIGENDIAN
797     dw = bswap32 (dw);
798 #endif
799     memcpy (p, &dw, sizeof (dw));
800 }
801
802 /** Writes 64 bits in little endian order */
803 static inline void SetQWLE (void *p, uint64_t qw)
804 {
805 #ifdef WORDS_BIGENDIAN
806     qw = bswap64 (qw);
807 #endif
808     memcpy (p, &qw, sizeof (qw));
809 }
810
811 /* */
812 #define VLC_UNUSED(x) (void)(x)
813
814 /* Stuff defined in src/extras/libc.c */
815
816 #if defined(_WIN32)
817 /* several type definitions */
818 #   if defined( __MINGW32__ )
819 #       if !defined( _OFF_T_ )
820             typedef long long _off_t;
821             typedef _off_t off_t;
822 #           define _OFF_T_
823 #       else
824 #           ifdef off_t
825 #               undef off_t
826 #           endif
827 #           define off_t long long
828 #       endif
829 #   endif
830
831 #   ifndef O_NONBLOCK
832 #       define O_NONBLOCK 0
833 #   endif
834
835 #   include <tchar.h>
836 #endif /* _WIN32 */
837
838 typedef struct {
839     unsigned num, den;
840 } vlc_rational_t;
841
842 VLC_API bool vlc_ureduce( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t );
843
844 #define container_of(ptr, type, member) \
845     ((type *)(((char *)(ptr)) - offsetof(type, member)))
846
847 /*****************************************************************************
848  * I18n stuff
849  *****************************************************************************/
850 VLC_API char *vlc_gettext( const char *msgid ) VLC_FORMAT_ARG(1);
851 VLC_API char *vlc_ngettext( const char *s, const char *p, unsigned long n ) VLC_FORMAT_ARG(1) VLC_FORMAT_ARG(2);
852
853 #define vlc_pgettext( ctx, id ) \
854         vlc_pgettext_aux( ctx "\004" id, id )
855
856 VLC_FORMAT_ARG(2)
857 static inline const char *vlc_pgettext_aux( const char *ctx, const char *id )
858 {
859     const char *tr = vlc_gettext( ctx );
860     return (tr == ctx) ? id : tr;
861 }
862
863 /*****************************************************************************
864  * Loosy memory allocation functions. Do not use in new code.
865  *****************************************************************************/
866 static inline void *xmalloc (size_t len)
867 {
868     void *ptr = malloc (len);
869     if (unlikely (ptr == NULL))
870         abort ();
871     return ptr;
872 }
873
874 static inline void *xrealloc (void *ptr, size_t len)
875 {
876     void *nptr = realloc (ptr, len);
877     if (unlikely (nptr == NULL))
878         abort ();
879     return nptr;
880 }
881
882 static inline void *xcalloc (size_t n, size_t size)
883 {
884     void *ptr = calloc (n, size);
885     if (unlikely (ptr == NULL))
886         abort ();
887     return ptr;
888 }
889
890 static inline char *xstrdup (const char *str)
891 {
892     char *ptr = strdup (str);
893     if (unlikely(ptr == NULL))
894         abort ();
895     return ptr;
896 }
897
898 /*****************************************************************************
899  * libvlc features
900  *****************************************************************************/
901 VLC_API const char * VLC_CompileBy( void ) VLC_USED;
902 VLC_API const char * VLC_CompileHost( void ) VLC_USED;
903 VLC_API const char * VLC_Compiler( void ) VLC_USED;
904
905 /*****************************************************************************
906  * Additional vlc stuff
907  *****************************************************************************/
908 #include "vlc_messages.h"
909 #include "vlc_objects.h"
910 #include "vlc_variables.h"
911 #include "vlc_main.h"
912 #include "vlc_configuration.h"
913
914 #if defined( _WIN32 ) || defined( __OS2__ )
915 #   define DIR_SEP_CHAR '\\'
916 #   define DIR_SEP "\\"
917 #   define PATH_SEP_CHAR ';'
918 #   define PATH_SEP ";"
919 #else
920 #   define DIR_SEP_CHAR '/'
921 #   define DIR_SEP "/"
922 #   define PATH_SEP_CHAR ':'
923 #   define PATH_SEP ":"
924 #endif
925
926 #define LICENSE_MSG \
927   _("This program comes with NO WARRANTY, to the extent permitted by " \
928     "law.\nYou may redistribute it under the terms of the GNU General " \
929     "Public License;\nsee the file named COPYING for details.\n" \
930     "Written by the VideoLAN team; see the AUTHORS file.\n")
931
932 #endif /* !VLC_COMMON_H */