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

source code of include/vlc/plugins/vlc_common.h