vlc_common.h 27.6 KB
Newer Older
1
/*****************************************************************************
Pere Orga's avatar
Pere Orga committed
2
 * vlc_common.h: common definitions
3 4
 * Collection of useful common types and macros definitions
 *****************************************************************************
5
 * Copyright (C) 1998-2011 VLC authors and VideoLAN
6 7 8
 *
 * Authors: Samuel Hocevar <sam@via.ecp.fr>
 *          Vincent Seguin <seguin@via.ecp.fr>
9
 *          Gildas Bazin <gbazin@videolan.org>
10
 *          Rémi Denis-Courmont
11
 *
12 13 14
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
15
 * (at your option) any later version.
16
 *
17 18
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 20
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
21
 *
22 23 24
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25 26
 *****************************************************************************/

Clément Stenac's avatar
Clément Stenac committed
27
/**
Sam Hocevar's avatar
Sam Hocevar committed
28
 * \file
Clément Stenac's avatar
Clément Stenac committed
29 30 31
 * This file is a collection of common definitions and types
 */

32 33 34
#ifndef VLC_COMMON_H
# define VLC_COMMON_H 1

35
/*****************************************************************************
36
 * Required vlc headers
37
 *****************************************************************************/
38 39
#include "vlc_config.h"

40 41 42
/*****************************************************************************
 * Required system headers
 *****************************************************************************/
43
#include <stdlib.h>
44 45
#include <stdarg.h>

46
#include <string.h>
47
#include <stdio.h>
48
#include <inttypes.h>
49
#include <stddef.h>
50

51 52 53 54
#ifndef __cplusplus
# include <stdbool.h>
#endif

55 56 57
/*****************************************************************************
 * Compilers definitions
 *****************************************************************************/
58 59 60 61 62 63 64 65
/* Helper for GCC version checks */
#ifdef __GNUC__
# define VLC_GCC_VERSION(maj,min) \
    ((__GNUC__ > (maj)) || (__GNUC__ == (maj) && __GNUC_MINOR__ >= (min)))
#else
# define VLC_GCC_VERSION(maj,min) (0)
#endif

66 67 68 69 70 71 72 73 74 75 76 77
/* Try to fix format strings for all versions of mingw and mingw64 */
#if defined( _WIN32 ) && defined( __USE_MINGW_ANSI_STDIO )
 #undef PRId64
 #define PRId64 "lld"
 #undef PRIi64
 #define PRIi64 "lli"
 #undef PRIu64
 #define PRIu64 "llu"
 #undef PRIo64
 #define PRIo64 "llo"
 #undef PRIx64
 #define PRIx64 "llx"
78 79
 #define snprintf __mingw_snprintf
 #define vsnprintf __mingw_vsnprintf
80
 #define swprintf _snwprintf
81 82
#endif

83
/* Function attributes for compiler warnings */
84
#ifdef __GNUC__
85
# define VLC_DEPRECATED __attribute__((deprecated))
86 87 88 89 90
# if VLC_GCC_VERSION(6,0)
#  define VLC_DEPRECATED_ENUM __attribute__((deprecated))
# else
#  define VLC_DEPRECATED_ENUM
# endif
91

92
# if defined( _WIN32 )
93 94 95 96 97 98
#  define VLC_FORMAT(x,y) __attribute__ ((format(gnu_printf,x,y)))
# else
#  define VLC_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
# endif
# define VLC_FORMAT_ARG(x) __attribute__ ((format_arg(x)))
# 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 105 106 107
# define VLC_FORMAT(x,y)
# define VLC_FORMAT_ARG(x)
# define VLC_MALLOC
# define VLC_USED
108 109
#endif

110

111 112
/* Branch prediction */
#ifdef __GNUC__
113 114 115
# define likely(p)     __builtin_expect(!!(p), 1)
# define unlikely(p)   __builtin_expect(!!(p), 0)
# define unreachable() __builtin_unreachable()
116
#else
117 118 119
# define likely(p)     (!!(p))
# define unlikely(p)   (!!(p))
# define unreachable() ((void)0)
120 121
#endif

122 123
#define vlc_assert_unreachable() (assert(!"unreachable"), unreachable())

124 125
/* Linkage */
#ifdef __cplusplus
126
# define VLC_EXTERN extern "C"
127
#else
128
# define VLC_EXTERN
129 130
#endif

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 138
#endif

139
#define VLC_API VLC_EXTERN VLC_EXPORT
140 141


142 143 144
/*****************************************************************************
 * Basic types definitions
 *****************************************************************************/
145 146 147
/**
 * High precision date or time interval
 *
148 149
 * Store a high precision date or time interval. The maximum precision is the
 * 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 152
 * video). Dates are stored as microseconds since a common date (usually the
 * epoch). Note that date and time intervals can be manipulated using regular
153
 * arithmetic operators, and that no special functions are required.
154
 */
155
typedef int64_t mtime_t;
156

157
/**
158
 * The vlc_fourcc_t type.
159
 *
160
 * See http://www.webartz.com/fourcc/ for a very detailed list.
161
 */
162
typedef uint32_t vlc_fourcc_t;
163

164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
#ifdef WORDS_BIGENDIAN
#   define VLC_FOURCC( a, b, c, d ) \
        ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
           | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
#   define VLC_TWOCC( a, b ) \
        ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )

#else
#   define VLC_FOURCC( a, b, c, d ) \
        ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
           | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
#   define VLC_TWOCC( a, b ) \
        ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )

#endif

180 181 182 183 184 185 186
/**
 * Translate a vlc_fourcc into its string representation. This function
 * assumes there is enough room in psz_fourcc to store 4 characters in.
 *
 * \param fcc a vlc_fourcc_t
 * \param psz_fourcc string to store string representation of vlc_fourcc in
 */
187
static inline void vlc_fourcc_to_char( vlc_fourcc_t fcc, char *psz_fourcc )
188
{
189
    memcpy( psz_fourcc, &fcc, 4 );
190 191
}

192 193 194 195
/*****************************************************************************
 * Classes declaration
 *****************************************************************************/

196
/* Internal types */
197 198
typedef struct vlc_list_t vlc_list_t;
typedef struct vlc_object_t vlc_object_t;
199
typedef struct libvlc_int_t libvlc_int_t;
200
typedef struct date_t date_t;
201

202
/* Playlist */
203

204 205
typedef struct playlist_t playlist_t;
typedef struct playlist_item_t playlist_item_t;
206 207
typedef struct services_discovery_t services_discovery_t;
typedef struct services_discovery_sys_t services_discovery_sys_t;
208 209
typedef struct vlc_renderer_discovery_t vlc_renderer_discovery_t;
typedef struct vlc_renderer_item_t vlc_renderer_item_t;
210

211
/* Modules */
212 213
typedef struct module_t module_t;
typedef struct module_config_t module_config_t;
214

215 216
typedef struct config_category_t config_category_t;

217
/* Input */
218
typedef struct input_thread_t input_thread_t;
219
typedef struct input_item_t input_item_t;
220
typedef struct input_item_node_t input_item_node_t;
221
typedef struct access_sys_t access_sys_t;
222 223 224
typedef struct stream_t     stream_t;
typedef struct stream_sys_t stream_sys_t;
typedef struct demux_t  demux_t;
225
typedef struct demux_sys_t demux_sys_t;
226 227 228
typedef struct es_out_t     es_out_t;
typedef struct es_out_id_t  es_out_id_t;
typedef struct es_out_sys_t es_out_sys_t;
Gildas Bazin's avatar
Gildas Bazin committed
229
typedef struct seekpoint_t seekpoint_t;
230 231
typedef struct info_t info_t;
typedef struct info_category_t info_category_t;
232
typedef struct input_attachment_t input_attachment_t;
233

234 235 236 237
/* Format */
typedef struct audio_format_t audio_format_t;
typedef struct video_format_t video_format_t;
typedef struct subs_format_t subs_format_t;
238 239
typedef struct es_format_t es_format_t;
typedef struct video_palette_t video_palette_t;
240

241
/* Audio */
242
typedef struct audio_output audio_output_t;
243
typedef struct aout_sys_t aout_sys_t;
244
typedef audio_format_t audio_sample_format_t;
245 246

/* Video */
247
typedef struct vout_thread_t vout_thread_t;
248
typedef struct vlc_viewpoint_t vlc_viewpoint_t;
249

250
typedef video_format_t video_frame_format_t;
251 252
typedef struct picture_t picture_t;
typedef struct picture_sys_t picture_sys_t;
253

254
/* Subpictures */
255
typedef struct spu_t spu_t;
256
typedef struct subpicture_t subpicture_t;
257
typedef struct subpicture_region_t subpicture_region_t;
258

259 260
typedef struct image_handler_t image_handler_t;

261 262
/* Stream output */
typedef struct sout_instance_t sout_instance_t;
263

264
typedef struct sout_input_t sout_input_t;
265
typedef struct sout_packetizer_input_t sout_packetizer_input_t;
266

267
typedef struct sout_access_out_t sout_access_out_t;
268 269
typedef struct sout_access_out_sys_t   sout_access_out_sys_t;

270
typedef struct sout_mux_t sout_mux_t;
271 272
typedef struct sout_mux_sys_t sout_mux_sys_t;

273
typedef struct sout_stream_t    sout_stream_t;
274 275
typedef struct sout_stream_sys_t sout_stream_sys_t;

276
typedef struct config_chain_t       config_chain_t;
277
typedef struct session_descriptor_t session_descriptor_t;
278

279
/* Decoders */
Laurent Aimar's avatar
Laurent Aimar committed
280 281 282
typedef struct decoder_t         decoder_t;
typedef struct decoder_sys_t     decoder_sys_t;
typedef struct decoder_synchro_t decoder_synchro_t;
283

284 285 286 287
/* Encoders */
typedef struct encoder_t      encoder_t;
typedef struct encoder_sys_t  encoder_sys_t;

288 289 290 291
/* Filters */
typedef struct filter_t filter_t;
typedef struct filter_sys_t filter_sys_t;

292
/* Network */
293
typedef struct vlc_url_t vlc_url_t;
294

295 296 297
/* Misc */
typedef struct iso639_lang_t iso639_lang_t;

298 299 300 301
/* block */
typedef struct block_t      block_t;
typedef struct block_fifo_t block_fifo_t;

302 303 304
/* Hashing */
typedef struct md5_s md5_t;

305 306 307 308 309 310
/* XML */
typedef struct xml_t xml_t;
typedef struct xml_sys_t xml_sys_t;
typedef struct xml_reader_t xml_reader_t;
typedef struct xml_reader_sys_t xml_reader_sys_t;

311 312 313
/* vod server */
typedef struct vod_t     vod_t;
typedef struct vod_sys_t vod_sys_t;
314
typedef struct vod_media_t vod_media_t;
315

316
/* VLM */
317 318
typedef struct vlm_t         vlm_t;
typedef struct vlm_message_t vlm_message_t;
319

320
/* misc */
321
typedef struct vlc_meta_t    vlc_meta_t;
322
typedef struct input_stats_t input_stats_t;
323
typedef struct addon_entry_t addon_entry_t;
324

325 326
/* Update */
typedef struct update_t update_t;
327

328 329 330 331 332
/**
 * VLC value structure
 */
typedef union
{
333
    int64_t         i_int;
334
    bool            b_bool;
335 336 337 338
    float           f_float;
    char *          psz_string;
    void *          p_address;
    vlc_list_t *    p_list;
339
    struct { int32_t x; int32_t y; } coords;
340 341 342 343 344 345 346 347

} vlc_value_t;

/**
 * VLC list structure
 */
struct vlc_list_t
{
348 349 350
    int          i_type;
    int          i_count;
    vlc_value_t *p_values;
351 352 353 354 355
};

/*****************************************************************************
 * Error values (shouldn't be exposed)
 *****************************************************************************/
356 357 358 359 360 361 362 363 364
#define VLC_SUCCESS        (-0) /**< No error */
#define VLC_EGENERIC       (-1) /**< Unspecified error */
#define VLC_ENOMEM         (-2) /**< Not enough memory */
#define VLC_ETIMEOUT       (-3) /**< Timeout */
#define VLC_ENOMOD         (-4) /**< Module not found */
#define VLC_ENOOBJ         (-5) /**< Object not found */
#define VLC_ENOVAR         (-6) /**< Variable not found */
#define VLC_EBADVAR        (-7) /**< Bad variable value */
#define VLC_ENOITEM        (-8) /**< Item not found */
365

366
/*****************************************************************************
367
 * Variable callbacks: called when the value is modified
368 369 370 371 372 373 374
 *****************************************************************************/
typedef int ( * vlc_callback_t ) ( vlc_object_t *,      /* variable's object */
                                   char const *,            /* variable name */
                                   vlc_value_t,                 /* old value */
                                   vlc_value_t,                 /* new value */
                                   void * );                /* callback data */

375 376 377 378 379 380 381 382 383
/*****************************************************************************
 * List callbacks: called when elements are added/removed from the list
 *****************************************************************************/
typedef int ( * vlc_list_callback_t ) ( vlc_object_t *,      /* variable's object */
                                        char const *,            /* variable name */
                                        int,                  /* VLC_VAR_* action */
                                        vlc_value_t *,      /* new/deleted value  */
                                        void *);                 /* callback data */

384 385 386
/*****************************************************************************
 * OS-specific headers and thread types
 *****************************************************************************/
387
#if defined( _WIN32 )
388 389 390 391 392 393 394
#   include <malloc.h>
#   ifndef PATH_MAX
#       define PATH_MAX MAX_PATH
#   endif
#   include <windows.h>
#endif

395 396 397 398 399
#ifdef __APPLE__
#include <sys/syslimits.h>
#include <AvailabilityMacros.h>
#endif

400 401 402 403
#ifdef __OS2__
#   define OS2EMX_PLAIN_CHAR
#   define INCL_BASE
#   define INCL_PM
404
#   include <os2safe.h>
405 406 407
#   include <os2.h>
#endif

408
#include "vlc_mtime.h"
409 410
#include "vlc_threads.h"

411
/**
412 413 414
 * Common structure members
 *****************************************************************************/

415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472
/**
 * VLC object common members
 *
 * Common public properties for all VLC objects.
 * Object also have private properties maintained by the core, see
 * \ref vlc_object_internals_t
 */
struct vlc_common_members
{
    /** Object type name
     *
     * A constant string identifying the type of the object (for logging)
     */
    const char *object_type;

    /** Log messages header
     *
     * Human-readable header for log messages. This is not thread-safe and
     * only used by VLM and Lua interfaces.
     */
    char *header;

    int  flags;

    /** Module probe flag
     *
     * A boolean during module probing when the probe is "forced".
     * See \ref module_need().
     */
    bool force;

    /** LibVLC instance
     *
     * Root VLC object of the objects tree that this object belongs in.
     */
    libvlc_int_t *libvlc;

    /** Parent object
     *
     * The parent VLC object in the objects tree. For the root (the LibVLC
     * instance) object, this is NULL.
     */
    vlc_object_t *parent;
};

/**
 * Backward compatibility macro
 */
#define VLC_COMMON_MEMBERS struct vlc_common_members obj;

/**
 * Type-safe vlc_object_t cast
 *
 * This macro attempts to cast a pointer to a compound type to a
 * \ref vlc_object_t pointer in a type-safe manner.
 * It checks if the compound type actually starts with an embedded
 * \ref vlc_object_t structure.
 */
473
#if !defined(__cplusplus)
474 475
# define VLC_OBJECT(x) \
    _Generic((x)->obj, \
476 477
        struct vlc_common_members: (vlc_object_t *)(&(x)->obj), \
        const struct vlc_common_members: (const vlc_object_t *)(&(x)->obj) \
478
    )
479
#else
480
# define VLC_OBJECT( x ) ((vlc_object_t *)&(x)->obj)
481
#endif
482

483 484 485 486
/*****************************************************************************
 * Macros and inline functions
 *****************************************************************************/

487 488 489
/* __MAX and __MIN: self explanatory */
#ifndef __MAX
#   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
490
#endif
491 492
#ifndef __MIN
#   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
493 494
#endif

495 496 497
/* clip v in [min, max] */
#define VLC_CLIP(v, min, max)    __MIN(__MAX((v), (min)), (max))

498
VLC_USED
499
static inline int64_t GCD ( int64_t a, int64_t b )
500
{
501 502 503 504 505 506 507
    while( b )
    {
        int64_t c = a % b;
        a = b;
        b = c;
    }
    return a;
508 509
}

510
/* function imported from libavutil/common.h */
511
VLC_USED
512 513 514 515 516 517
static inline uint8_t clip_uint8_vlc( int32_t a )
{
    if( a&(~255) ) return (-a)>>31;
    else           return a;
}

518
/** Count leading zeroes */
519
VLC_USED
520
static inline unsigned (clz)(unsigned x)
521
{
522
#ifdef __GNUC__
523 524 525 526 527 528
    return __builtin_clz (x);
#else
    unsigned i = sizeof (x) * 8;

    while (x)
    {
529
        x >>= 1;
530 531 532 533 534 535 536 537 538 539 540
        i--;
    }
    return i;
#endif
}

#define clz8( x ) (clz(x) - ((sizeof(unsigned) - sizeof (uint8_t)) * 8))
#define clz16( x ) (clz(x) - ((sizeof(unsigned) - sizeof (uint16_t)) * 8))
/* XXX: this assumes that int is 32-bits or more */
#define clz32( x ) (clz(x) - ((sizeof(unsigned) - sizeof (uint32_t)) * 8))

541 542
/** Count trailing zeroes */
VLC_USED
543
static inline unsigned (ctz)(unsigned x)
544
{
545
#ifdef __GNUC__
546 547 548 549 550 551 552 553 554 555 556 557 558
    return __builtin_ctz (x);
#else
    unsigned i = sizeof (x) * 8;

    while (x)
    {
        x <<= 1;
        i--;
    }
    return i;
#endif
}

559
/** Bit weight */
560
VLC_USED
561
static inline unsigned (popcount)(unsigned x)
562
{
563
#ifdef __GNUC__
564 565 566 567 568 569 570 571 572 573 574 575
    return __builtin_popcount (x);
#else
    unsigned count = 0;
    while (x)
    {
        count += x & 1;
        x = x >> 1;
    }
    return count;
#endif
}

576 577
/** Bit weight of long long */
VLC_USED
578
static inline int (popcountll)(unsigned long long x)
579
{
580
#ifdef __GNUC__
581 582 583 584 585 586 587 588 589 590 591 592
    return __builtin_popcountll(x);
#else
    int count = 0;
    while (x)
    {
        count += x & 1;
        x = x >> 1;
    }
    return count;
#endif
}

593
VLC_USED
594
static inline unsigned (parity)(unsigned x)
595
{
596
#ifdef __GNUC__
597 598 599 600 601 602 603 604
    return __builtin_parity (x);
#else
    for (unsigned i = 4 * sizeof (x); i > 0; i /= 2)
        x ^= x >> i;
    return x & 1;
#endif
}

605 606
/** Byte swap (16 bits) */
VLC_USED
607
static inline uint16_t (bswap16)(uint16_t x)
608 609 610 611 612 613
{
    return (x << 8) | (x >> 8);
}

/** Byte swap (32 bits) */
VLC_USED
614
static inline uint32_t (bswap32)(uint32_t x)
615
{
616
#if defined (__GNUC__) || defined(__clang__)
617 618 619 620 621 622 623 624 625 626 627
    return __builtin_bswap32 (x);
#else
    return ((x & 0x000000FF) << 24)
         | ((x & 0x0000FF00) <<  8)
         | ((x & 0x00FF0000) >>  8)
         | ((x & 0xFF000000) >> 24);
#endif
}

/** Byte swap (64 bits) */
VLC_USED
628
static inline uint64_t (bswap64)(uint64_t x)
629
{
630
#if defined (__GNUC__) || defined(__clang__)
631
    return __builtin_bswap64 (x);
632
#elif !defined (__cplusplus)
633 634 635 636 637 638 639 640
    return ((x & 0x00000000000000FF) << 56)
         | ((x & 0x000000000000FF00) << 40)
         | ((x & 0x0000000000FF0000) << 24)
         | ((x & 0x00000000FF000000) <<  8)
         | ((x & 0x000000FF00000000) >>  8)
         | ((x & 0x0000FF0000000000) >> 24)
         | ((x & 0x00FF000000000000) >> 40)
         | ((x & 0xFF00000000000000) >> 56);
641
#else
642 643 644 645 646 647 648 649
    return ((x & 0x00000000000000FFULL) << 56)
         | ((x & 0x000000000000FF00ULL) << 40)
         | ((x & 0x0000000000FF0000ULL) << 24)
         | ((x & 0x00000000FF000000ULL) <<  8)
         | ((x & 0x000000FF00000000ULL) >>  8)
         | ((x & 0x0000FF0000000000ULL) >> 24)
         | ((x & 0x00FF000000000000ULL) >> 40)
         | ((x & 0xFF00000000000000ULL) >> 56);
650 651 652
#endif
}

653 654 655
/* Integer overflow */
static inline bool uadd_overflow(unsigned a, unsigned b, unsigned *res)
{
656
#if defined(__GNUC__) || defined(__clang__)
657 658 659 660 661 662 663 664 665 666
     return __builtin_uadd_overflow(a, b, res);
#else
     *res = a + b;
     return (a + b) < a;
#endif
}

static inline bool uaddl_overflow(unsigned long a, unsigned long b,
                                  unsigned long *res)
{
667
#if defined(__GNUC__) || defined(__clang__)
668 669 670 671 672 673 674 675 676 677
     return __builtin_uaddl_overflow(a, b, res);
#else
     *res = a + b;
     return (a + b) < a;
#endif
}

static inline bool uaddll_overflow(unsigned long long a, unsigned long long b,
                                   unsigned long long *res)
{
678
#if defined(__GNUC__) || defined(__clang__)
679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712
     return __builtin_uaddll_overflow(a, b, res);
#else
     *res = a + b;
     return (a + b) < a;
#endif
}

#ifndef __cplusplus
# define add_overflow(a,b,r) \
    _Generic(*(r), \
        unsigned: uadd_overflow(a, b, (unsigned *)(r)), \
        unsigned long: uaddl_overflow(a, b, (unsigned long *)(r)), \
        unsigned long long: uaddll_overflow(a, b, (unsigned long long *)(r)))
#else
static inline bool add_overflow(unsigned a, unsigned b, unsigned *res)
{
    return uadd_overflow(a, b, res);
}

static inline bool add_overflow(unsigned long a, unsigned long b,
                                unsigned long *res)
{
    return uaddl_overflow(a, b, res);
}

static inline bool add_overflow(unsigned long long a, unsigned long long b,
                                unsigned long long *res)
{
    return uaddll_overflow(a, b, res);
}
#endif

static inline bool umul_overflow(unsigned a, unsigned b, unsigned *res)
{
713
#if defined(__GNUC__) || defined(__clang__)
714 715 716 717 718 719 720 721 722 723
     return __builtin_umul_overflow(a, b, res);
#else
     *res = a * b;
     return b > 0 && a > (UINT_MAX / b);
#endif
}

static inline bool umull_overflow(unsigned long a, unsigned long b,
                                  unsigned long *res)
{
724
#if defined(__GNUC__) || defined(__clang__)
725 726 727 728 729 730 731 732 733 734
     return __builtin_umull_overflow(a, b, res);
#else
     *res = a * b;
     return b > 0 && a > (ULONG_MAX / b);
#endif
}

static inline bool umulll_overflow(unsigned long long a, unsigned long long b,
                                   unsigned long long *res)
{
735
#if defined(__GNUC__) || defined(__clang__)
736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766
     return __builtin_umulll_overflow(a, b, res);
#else
     *res = a * b;
     return b > 0 && a > (ULLONG_MAX / b);
#endif
}

#ifndef __cplusplus
#define mul_overflow(a,b,r) \
    _Generic(*(r), \
        unsigned: umul_overflow(a, b, (unsigned *)(r)), \
        unsigned long: umull_overflow(a, b, (unsigned long *)(r)), \
        unsigned long long: umulll_overflow(a, b, (unsigned long long *)(r)))
#else
static inline bool mul_overflow(unsigned a, unsigned b, unsigned *res)
{
    return umul_overflow(a, b, res);
}

static inline bool mul_overflow(unsigned long a, unsigned long b,
                                unsigned long *res)
{
    return umull_overflow(a, b, res);
}

static inline bool mul_overflow(unsigned long long a, unsigned long long b,
                                unsigned long long *res)
{
    return umulll_overflow(a, b, res);
}
#endif
767

768
/* Free and set set the variable to NULL */
769
#define FREENULL(a) do { free( a ); a = NULL; } while(0)
770

771 772
#define EMPTY_STR(str) (!str || !*str)

773
VLC_API char const * vlc_error( int ) VLC_USED;
774

775
#include <vlc_arrays.h>
776

777
/* MSB (big endian)/LSB (little endian) conversions - network order is always
778
 * MSB, and should be used for both network communications and files. */
779 780 781 782

#ifdef WORDS_BIGENDIAN
# define hton16(i) ((uint16_t)(i))
# define hton32(i) ((uint32_t)(i))
783
# define hton64(i) ((uint64_t)(i))
784 785 786 787 788 789 790 791 792 793
#else
# define hton16(i) bswap16(i)
# define hton32(i) bswap32(i)
# define hton64(i) bswap64(i)
#endif
#define ntoh16(i) hton16(i)
#define ntoh32(i) hton32(i)
#define ntoh64(i) hton64(i)

/** Reads 16 bits in network byte order */
794
VLC_USED
795
static inline uint16_t U16_AT (const void *p)
796
{
797 798 799 800
    uint16_t x;

    memcpy (&x, p, sizeof (x));
    return ntoh16 (x);
801
}
802

803
/** Reads 32 bits in network byte order */
804
VLC_USED
805
static inline uint32_t U32_AT (const void *p)
806
{
807 808 809 810
    uint32_t x;

    memcpy (&x, p, sizeof (x));
    return ntoh32 (x);
811
}
812

813
/** Reads 64 bits in network byte order */
814
VLC_USED
815
static inline uint64_t U64_AT (const void *p)
816
{
817 818 819 820
    uint64_t x;

    memcpy (&x, p, sizeof (x));
    return ntoh64 (x);
821
}
822

823 824 825 826 827
#define GetWBE(p)  U16_AT(p)
#define GetDWBE(p) U32_AT(p)
#define GetQWBE(p) U64_AT(p)

/** Reads 16 bits in little-endian order */
828
VLC_USED
829
static inline uint16_t GetWLE (const void *p)
830
{
831 832 833 834 835 836 837
    uint16_t x;

    memcpy (&x, p, sizeof (x));
#ifdef WORDS_BIGENDIAN
    x = bswap16 (x);
#endif
    return x;
838
}
839

840
/** Reads 32 bits in little-endian order */
841
VLC_USED
842
static inline uint32_t GetDWLE (const void *p)
843
{
844 845 846 847 848 849 850
    uint32_t x;

    memcpy (&x, p, sizeof (x));
#ifdef WORDS_BIGENDIAN
    x = bswap32 (x);
#endif
    return x;
851
}
852

853
/** Reads 64 bits in little-endian order */
854
VLC_USED
855
static inline uint64_t GetQWLE (const void *p)
856
{
857
    uint64_t x;
858

859 860 861 862 863
    memcpy (&x, p, sizeof (x));
#ifdef WORDS_BIGENDIAN
    x = bswap64 (x);
#endif
    return x;
864 865
}

866
/** Writes 16 bits in network byte order */
867
static inline void SetWBE (void *p, uint16_t w)
868
{
869 870
    w = hton16 (w);
    memcpy (p, &w, sizeof (w));
871
}
872 873

/** Writes 32 bits in network byte order */
874
static inline void SetDWBE (void *p, uint32_t dw)
875
{
876 877
    dw = hton32 (dw);
    memcpy (p, &dw, sizeof (dw));
878
}
879 880

/** Writes 64 bits in network byte order */
881
static inline void SetQWBE (void *p, uint64_t qw)
882
{
883 884
    qw = hton64 (qw);
    memcpy (p, &qw, sizeof (qw));
885 886
}

887
/** Writes 16 bits in little endian order */
888
static inline void SetWLE (void *p, uint16_t w)
889
{
890 891 892 893
#ifdef WORDS_BIGENDIAN
    w = bswap16 (w);
#endif
    memcpy (p, &w, sizeof (w));
894
}
895 896

/** Writes 32 bits in little endian order */
897
static inline void SetDWLE (void *p, uint32_t dw)
898
{
899 900 901 902
#ifdef WORDS_BIGENDIAN
    dw = bswap32 (dw);
#endif
    memcpy (p, &dw, sizeof (dw));
903
}
904

905
/** Writes 64 bits in little endian order */
906
static inline void SetQWLE (void *p, uint64_t qw)
907
{
908
#ifdef WORDS_BIGENDIAN
909
    qw = bswap64 (qw);
910 911
#endif
    memcpy (p, &qw, sizeof (qw));
912
}
913

914 915 916
/* */
#define VLC_UNUSED(x) (void)(x)

917
/* Stuff defined in src/extras/libc.c */
918

919
#if defined(_WIN32)
920 921 922
/* several type definitions */
#   if defined( __MINGW32__ )
#       if !defined( _OFF_T_ )
923 924
            typedef long long _off_t;
            typedef _off_t off_t;
925 926
#           define _OFF_T_
#       else
927 928 929
#           ifdef off_t
#               undef off_t
#           endif
930 931 932 933
#           define off_t long long
#       endif
#   endif

934 935
#   ifndef O_NONBLOCK
#       define O_NONBLOCK 0
936 937
#   endif

938
#   include <tchar.h>
939
#endif /* _WIN32 */
940

941 942 943 944
typedef struct {
    unsigned num, den;
} vlc_rational_t;

945
VLC_API bool vlc_ureduce( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t );
946

947 948 949
#define container_of(ptr, type, member) \
    ((type *)(((char *)(ptr)) - offsetof(type, member)))

950 951 952
VLC_USED VLC_MALLOC
static inline void *vlc_alloc(size_t count, size_t size)
{
953
    return mul_overflow(count, size, &size) ? NULL : malloc(size);
954 955
}

956 957 958
/*****************************************************************************
 * I18n stuff
 *****************************************************************************/
959 960
VLC_API char *vlc_gettext( const char *msgid ) VLC_FORMAT_ARG(1);
VLC_API char *vlc_ngettext( const char *s, const char *p, unsigned long n ) VLC_FORMAT_ARG(1) VLC_FORMAT_ARG(2);
961

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
962 963 964
#define vlc_pgettext( ctx, id ) \
        vlc_pgettext_aux( ctx "\004" id, id )

965
VLC_FORMAT_ARG(2)
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
966
static inline const char *vlc_pgettext_aux( const char *ctx, const char *id )
967
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
968
    const char *tr = vlc_gettext( ctx );
969 970 971
    return (tr == ctx) ? id : tr;
}

972 973 974
/*****************************************************************************
 * Loosy memory allocation functions. Do not use in new code.
 *****************************************************************************/
975
static inline void *xmalloc(size_t len)
976
{
977 978 979
    void *ptr = malloc(len);
    if (unlikely(ptr == NULL && len > 0))
        abort();
980 981 982
    return ptr;
}

983
static inline void *xrealloc(void *ptr, size_t len)
984
{
985 986 987
    void *nptr = realloc(ptr, len);
    if (unlikely(nptr == NULL && len > 0))
        abort();
988 989 990
    return nptr;
}

991
static inline void *xcalloc(size_t n, size_t size)
992
{
993 994
    void *ptr = calloc(n, size);
    if (unlikely(ptr == NULL && (n > 0 || size > 0)))
995 996 997 998
        abort ();
    return ptr;
}

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
999 1000 1001 1002 1003 1004 1005 1006
static inline char *xstrdup (const char *str)
{
    char *ptr = strdup (str);
    if (unlikely(ptr == NULL))
        abort ();
    return ptr;
}

1007 1008 1009
/*****************************************************************************
 * libvlc features
 *****************************************************************************/
1010 1011 1012
VLC_API const char * VLC_CompileBy( void ) VLC_USED;
VLC_API const char * VLC_CompileHost( void ) VLC_USED;
VLC_API const char * VLC_Compiler( void ) VLC_USED;
1013

1014
/*****************************************************************************
1015
 * Additional vlc stuff
1016
 *****************************************************************************/
1017
#include "vlc_messages.h"
Sam Hocevar's avatar
Sam Hocevar committed
1018
#include "vlc_objects.h"
1019
#include "vlc_variables.h"
1020
#include "vlc_main.h"
1021
#include "vlc_configuration.h"
1022

1023
#if defined( _WIN32 ) || defined( __OS2__ )
1024
#   define DIR_SEP_CHAR '\\'
1025
#   define DIR_SEP "\\"
1026 1027
#   define PATH_SEP_CHAR ';'
#   define PATH_SEP ";"
1028
#else
1029
#   define DIR_SEP_CHAR '/'
1030
#   define DIR_SEP "/"
1031 1032
#   define PATH_SEP_CHAR ':'
#   define PATH_SEP ":"
1033
#endif
1034

1035 1036 1037 1038 1039 1040
#define LICENSE_MSG \
  _("This program comes with NO WARRANTY, to the extent permitted by " \
    "law.\nYou may redistribute it under the terms of the GNU General " \
    "Public License;\nsee the file named COPYING for details.\n" \
    "Written by the VideoLAN team; see the AUTHORS file.\n")

1041
#endif /* !VLC_COMMON_H */