vlc_common.h 25.3 KB
Newer Older
Sam Hocevar's avatar
 
Sam Hocevar committed
1
/*****************************************************************************
Pere Orga's avatar
Pere Orga committed
2
 * vlc_common.h: common definitions
Sam Hocevar's avatar
 
Sam Hocevar committed
3 4
 * Collection of useful common types and macros definitions
 *****************************************************************************
5
 * Copyright (C) 1998-2011 VLC authors and VideoLAN
Sam Hocevar's avatar
 
Sam Hocevar committed
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
Sam Hocevar's avatar
 
Sam Hocevar committed
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
Sam Hocevar's avatar
 
Sam Hocevar committed
15
 * (at your option) any later version.
16
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
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.
Sam Hocevar's avatar
 
Sam Hocevar committed
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.
Sam Hocevar's avatar
 
Sam Hocevar committed
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"

Sam Hocevar's avatar
 
Sam Hocevar committed
40 41 42
/*****************************************************************************
 * Required system headers
 *****************************************************************************/
Gildas Bazin's avatar
 
Gildas Bazin committed
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>
Sam Hocevar's avatar
 
Sam Hocevar committed
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 86
# define VLC_DEPRECATED __attribute__((deprecated))

87
# if defined( _WIN32 )
88 89 90 91 92 93
#  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))
94
# define VLC_USED __attribute__ ((warn_unused_result))
95

96
#else
97 98 99 100 101
# define VLC_DEPRECATED
# define VLC_FORMAT(x,y)
# define VLC_FORMAT_ARG(x)
# define VLC_MALLOC
# define VLC_USED
102 103
#endif

104

105 106
/* Branch prediction */
#ifdef __GNUC__
107 108 109
# define likely(p)     __builtin_expect(!!(p), 1)
# define unlikely(p)   __builtin_expect(!!(p), 0)
# define unreachable() __builtin_unreachable()
110
#else
111 112 113
# define likely(p)     (!!(p))
# define unlikely(p)   (!!(p))
# define unreachable() ((void)0)
114 115
#endif

116 117
#define vlc_assert_unreachable() (assert(!"unreachable"), unreachable())

118 119
/* Linkage */
#ifdef __cplusplus
120
# define VLC_EXTERN extern "C"
121
#else
122
# define VLC_EXTERN
123 124
#endif

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

133
#define VLC_API VLC_EXTERN VLC_EXPORT
134 135


Sam Hocevar's avatar
 
Sam Hocevar committed
136 137 138
/*****************************************************************************
 * Basic types definitions
 *****************************************************************************/
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
139 140 141
/**
 * High precision date or time interval
 *
142 143
 * 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
Sam Hocevar's avatar
 
Sam Hocevar committed
144
 * time interval is then 292271 years, which should be long enough for any
145 146
 * video). Dates are stored as microseconds since a common date (usually the
 * epoch). Note that date and time intervals can be manipulated using regular
Sam Hocevar's avatar
 
Sam Hocevar committed
147
 * arithmetic operators, and that no special functions are required.
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
148
 */
149
typedef int64_t mtime_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
150

Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
151
/**
152
 * The vlc_fourcc_t type.
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
153
 *
154
 * See http://www.webartz.com/fourcc/ for a very detailed list.
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
155
 */
156
typedef uint32_t vlc_fourcc_t;
157

158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
#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

174 175 176 177 178 179 180
/**
 * 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
 */
181
static inline void vlc_fourcc_to_char( vlc_fourcc_t fcc, char *psz_fourcc )
182
{
183
    memcpy( psz_fourcc, &fcc, 4 );
184 185
}

Sam Hocevar's avatar
 
Sam Hocevar committed
186 187 188 189
/*****************************************************************************
 * Classes declaration
 *****************************************************************************/

190
/* Internal types */
191 192
typedef struct vlc_list_t vlc_list_t;
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

Gildas Bazin's avatar
 
Gildas Bazin committed
196
/* Playlist */
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
197

198 199
typedef struct playlist_t playlist_t;
typedef struct playlist_item_t playlist_item_t;
200 201
typedef struct services_discovery_t services_discovery_t;
typedef struct services_discovery_sys_t services_discovery_sys_t;
Thomas Guillem's avatar
Thomas Guillem committed
202 203
typedef struct vlc_renderer_discovery_t vlc_renderer_discovery_t;
typedef struct vlc_renderer_item_t vlc_renderer_item_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
204

205
/* Modules */
206 207
typedef struct module_t module_t;
typedef struct module_config_t module_config_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
208

209 210
typedef struct config_category_t config_category_t;

Sam Hocevar's avatar
 
Sam Hocevar committed
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 stream_t access_t;
216
typedef struct access_sys_t access_sys_t;
217 218 219
typedef struct stream_t     stream_t;
typedef struct stream_sys_t stream_sys_t;
typedef struct demux_t  demux_t;
220
typedef struct demux_sys_t demux_sys_t;
221 222 223
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
224
typedef struct seekpoint_t seekpoint_t;
225 226
typedef struct info_t info_t;
typedef struct info_category_t info_category_t;
227
typedef struct input_attachment_t input_attachment_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
228

229 230 231 232
/* 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;
Gildas Bazin's avatar
 
Gildas Bazin committed
233 234
typedef struct es_format_t es_format_t;
typedef struct video_palette_t video_palette_t;
235

Sam Hocevar's avatar
 
Sam Hocevar committed
236
/* Audio */
237
typedef struct audio_output audio_output_t;
238
typedef struct aout_sys_t aout_sys_t;
Gildas Bazin's avatar
 
Gildas Bazin committed
239
typedef audio_format_t audio_sample_format_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
240 241

/* Video */
242
typedef struct vout_thread_t vout_thread_t;
243
typedef struct vlc_viewpoint_t vlc_viewpoint_t;
244

Gildas Bazin's avatar
 
Gildas Bazin committed
245
typedef video_format_t video_frame_format_t;
246 247
typedef struct picture_t picture_t;
typedef struct picture_sys_t picture_sys_t;
248

249
/* Subpictures */
250
typedef struct spu_t spu_t;
251
typedef struct subpicture_t subpicture_t;
252
typedef struct subpicture_region_t subpicture_region_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
253

254 255
typedef struct image_handler_t image_handler_t;

256 257
/* Stream output */
typedef struct sout_instance_t sout_instance_t;
258

259
typedef struct sout_input_t sout_input_t;
260
typedef struct sout_packetizer_input_t sout_packetizer_input_t;
261

262
typedef struct sout_access_out_t sout_access_out_t;
263 264
typedef struct sout_access_out_sys_t   sout_access_out_sys_t;

265
typedef struct sout_mux_t sout_mux_t;
266 267
typedef struct sout_mux_sys_t sout_mux_sys_t;

268
typedef struct sout_stream_t    sout_stream_t;
269 270
typedef struct sout_stream_sys_t sout_stream_sys_t;

271
typedef struct config_chain_t       config_chain_t;
272
typedef struct session_descriptor_t session_descriptor_t;
273

Sam Hocevar's avatar
 
Sam Hocevar committed
274
/* Decoders */
Laurent Aimar's avatar
Laurent Aimar committed
275 276 277
typedef struct decoder_t         decoder_t;
typedef struct decoder_sys_t     decoder_sys_t;
typedef struct decoder_synchro_t decoder_synchro_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
278

Gildas Bazin's avatar
 
Gildas Bazin committed
279 280 281 282
/* Encoders */
typedef struct encoder_t      encoder_t;
typedef struct encoder_sys_t  encoder_sys_t;

283 284 285 286
/* Filters */
typedef struct filter_t filter_t;
typedef struct filter_sys_t filter_sys_t;

287
/* Network */
288
typedef struct vlc_url_t vlc_url_t;
289

290 291 292
/* Misc */
typedef struct iso639_lang_t iso639_lang_t;

293 294 295 296
/* block */
typedef struct block_t      block_t;
typedef struct block_fifo_t block_fifo_t;

297 298 299
/* Hashing */
typedef struct md5_s md5_t;

Gildas Bazin's avatar
Gildas Bazin committed
300 301 302 303 304 305
/* 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;

306 307 308
/* vod server */
typedef struct vod_t     vod_t;
typedef struct vod_sys_t vod_sys_t;
309
typedef struct vod_media_t vod_media_t;
310

311
/* VLM */
312 313
typedef struct vlm_t         vlm_t;
typedef struct vlm_message_t vlm_message_t;
314

315
/* misc */
316
typedef struct vlc_meta_t    vlc_meta_t;
Clément Stenac's avatar
Clément Stenac committed
317
typedef struct input_stats_t input_stats_t;
318
typedef struct addon_entry_t addon_entry_t;
319

320 321
/* Update */
typedef struct update_t update_t;
322

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

} vlc_value_t;

/**
 * VLC list structure
 */
struct vlc_list_t
{
343 344 345
    int          i_type;
    int          i_count;
    vlc_value_t *p_values;
346 347 348 349 350
};

/*****************************************************************************
 * Error values (shouldn't be exposed)
 *****************************************************************************/
351 352 353 354 355 356 357 358 359
#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 */
360

361
/*****************************************************************************
362
 * Variable callbacks: called when the value is modified
363 364 365 366 367 368 369
 *****************************************************************************/
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 */

370 371 372 373 374 375 376 377 378
/*****************************************************************************
 * 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 */

379 380 381
/*****************************************************************************
 * OS-specific headers and thread types
 *****************************************************************************/
382
#if defined( _WIN32 )
383 384 385 386 387 388 389
#   include <malloc.h>
#   ifndef PATH_MAX
#       define PATH_MAX MAX_PATH
#   endif
#   include <windows.h>
#endif

390 391 392 393 394
#ifdef __APPLE__
#include <sys/syslimits.h>
#include <AvailabilityMacros.h>
#endif

395 396 397 398
#ifdef __OS2__
#   define OS2EMX_PLAIN_CHAR
#   define INCL_BASE
#   define INCL_PM
KO Myung-Hun's avatar
KO Myung-Hun committed
399
#   include <os2safe.h>
400 401 402
#   include <os2.h>
#endif

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
403
#include "vlc_mtime.h"
404 405
#include "vlc_threads.h"

406
/**
407 408 409
 * Common structure members
 *****************************************************************************/

410 411 412 413 414 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
/**
 * 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.
 */
#if !defined(__cplusplus) && (__STDC_VERSION__ >= 201112L)
# define VLC_OBJECT(x) \
    _Generic((x)->obj, \
471 472
        struct vlc_common_members: (vlc_object_t *)(&(x)->obj), \
        const struct vlc_common_members: (const vlc_object_t *)(&(x)->obj) \
473
    )
474
#elif defined (__GNUC__)
475 476
# ifndef __cplusplus
#  define VLC_OBJECT( x ) \
477
    __builtin_choose_expr( \
478 479
        __builtin_types_compatible_p(__typeof__((x)->obj), struct vlc_common_members), \
        (vlc_object_t *)(x), (void)0)
480 481
# else
#  define VLC_OBJECT( x ) \
482 483
    ((vlc_object_t *)(&((x)->obj)) \
      + 0 * __builtin_offsetof(__typeof__(*(x)), obj.object_type))
484
# endif
485
#else
486
# define VLC_OBJECT( x ) ((vlc_object_t *)&(x)->obj)
487
#endif
488

Sam Hocevar's avatar
 
Sam Hocevar committed
489 490 491 492 493 494 495 496 497 498
/*****************************************************************************
 * Macros and inline functions
 *****************************************************************************/

/* CEIL: division with round to nearest greater integer */
#define CEIL(n, d)  ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )

/* PAD: PAD(n, d) = CEIL(n ,d) * d */
#define PAD(n, d)   ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )

Sam Hocevar's avatar
 
Sam Hocevar committed
499 500 501
/* __MAX and __MIN: self explanatory */
#ifndef __MAX
#   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
Sam Hocevar's avatar
 
Sam Hocevar committed
502
#endif
Sam Hocevar's avatar
 
Sam Hocevar committed
503 504
#ifndef __MIN
#   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
Sam Hocevar's avatar
 
Sam Hocevar committed
505 506
#endif

507 508 509
/* clip v in [min, max] */
#define VLC_CLIP(v, min, max)    __MIN(__MAX((v), (min)), (max))

510
VLC_USED
511
static inline int64_t GCD ( int64_t a, int64_t b )
512
{
513 514 515 516 517 518 519
    while( b )
    {
        int64_t c = a % b;
        a = b;
        b = c;
    }
    return a;
520 521
}

522
/* function imported from libavutil/common.h */
523
VLC_USED
524 525 526 527 528 529
static inline uint8_t clip_uint8_vlc( int32_t a )
{
    if( a&(~255) ) return (-a)>>31;
    else           return a;
}

530
/** Count leading zeroes */
531
VLC_USED
532
static inline unsigned (clz)(unsigned x)
533
{
534
#ifdef __GNUC__
535 536 537 538 539 540
    return __builtin_clz (x);
#else
    unsigned i = sizeof (x) * 8;

    while (x)
    {
541
        x >>= 1;
542 543 544 545 546 547 548 549 550 551 552
        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))

553 554
/** Count trailing zeroes */
VLC_USED
555
static inline unsigned (ctz)(unsigned x)
556
{
557
#ifdef __GNUC__
558 559 560 561 562 563 564 565 566 567 568 569 570
    return __builtin_ctz (x);
#else
    unsigned i = sizeof (x) * 8;

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

571
/** Bit weight */
572
VLC_USED
573
static inline unsigned (popcount)(unsigned x)
574
{
575
#ifdef __GNUC__
576 577 578 579 580 581 582 583 584 585 586 587
    return __builtin_popcount (x);
#else
    unsigned count = 0;
    while (x)
    {
        count += x & 1;
        x = x >> 1;
    }
    return count;
#endif
}

588 589
/** Bit weight of long long */
VLC_USED
590
static inline int (popcountll)(unsigned long long x)
591
{
592
#ifdef __GNUC__
593 594 595 596 597 598 599 600 601 602 603 604
    return __builtin_popcountll(x);
#else
    int count = 0;
    while (x)
    {
        count += x & 1;
        x = x >> 1;
    }
    return count;
#endif
}

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
605
VLC_USED
606
static inline unsigned (parity)(unsigned x)
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
607
{
608
#ifdef __GNUC__
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
609 610 611 612 613 614 615 616
    return __builtin_parity (x);
#else
    for (unsigned i = 4 * sizeof (x); i > 0; i /= 2)
        x ^= x >> i;
    return x & 1;
#endif
}

617 618
/** Byte swap (16 bits) */
VLC_USED
619
static inline uint16_t (bswap16)(uint16_t x)
620 621 622 623 624 625
{
    return (x << 8) | (x >> 8);
}

/** Byte swap (32 bits) */
VLC_USED
626
static inline uint32_t (bswap32)(uint32_t x)
627
{
628
#if defined (__GNUC__) || defined(__clang__)
629 630 631 632 633 634 635 636 637 638 639
    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
640
static inline uint64_t (bswap64)(uint64_t x)
641
{
642
#if defined (__GNUC__) || defined(__clang__)
643
    return __builtin_bswap64 (x);
644
#elif !defined (__cplusplus)
645 646 647 648 649 650 651 652
    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);
653
#else
654 655 656 657 658 659 660 661
    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);
662 663 664 665
#endif
}


666
/* Free and set set the variable to NULL */
667
#define FREENULL(a) do { free( a ); a = NULL; } while(0)
668

669 670
#define EMPTY_STR(str) (!str || !*str)

671
VLC_API char const * vlc_error( int ) VLC_USED;
Clément Stenac's avatar
Clément Stenac committed
672

673
#include <vlc_arrays.h>
674

Sam Hocevar's avatar
 
Sam Hocevar committed
675
/* MSB (big endian)/LSB (little endian) conversions - network order is always
676
 * MSB, and should be used for both network communications and files. */
677 678 679 680

#ifdef WORDS_BIGENDIAN
# define hton16(i) ((uint16_t)(i))
# define hton32(i) ((uint32_t)(i))
681
# define hton64(i) ((uint64_t)(i))
682 683 684 685 686 687 688 689 690 691
#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 */
692
VLC_USED
693
static inline uint16_t U16_AT (const void *p)
694
{
695 696 697 698
    uint16_t x;

    memcpy (&x, p, sizeof (x));
    return ntoh16 (x);
699
}
700

701
/** Reads 32 bits in network byte order */
702
VLC_USED
703
static inline uint32_t U32_AT (const void *p)
704
{
705 706 707 708
    uint32_t x;

    memcpy (&x, p, sizeof (x));
    return ntoh32 (x);
709
}
710

711
/** Reads 64 bits in network byte order */
712
VLC_USED
713
static inline uint64_t U64_AT (const void *p)
714
{
715 716 717 718
    uint64_t x;

    memcpy (&x, p, sizeof (x));
    return ntoh64 (x);
719
}
720

721 722 723 724 725
#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 */
726
VLC_USED
727
static inline uint16_t GetWLE (const void *p)
728
{
729 730 731 732 733 734 735
    uint16_t x;

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

738
/** Reads 32 bits in little-endian order */
739
VLC_USED
740
static inline uint32_t GetDWLE (const void *p)
741
{
742 743 744 745 746 747 748
    uint32_t x;

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

751
/** Reads 64 bits in little-endian order */
752
VLC_USED
753
static inline uint64_t GetQWLE (const void *p)
754
{
755
    uint64_t x;
756

757 758 759 760 761
    memcpy (&x, p, sizeof (x));
#ifdef WORDS_BIGENDIAN
    x = bswap64 (x);
#endif
    return x;
Gildas Bazin's avatar
 
Gildas Bazin committed
762 763
}

764
/** Writes 16 bits in network byte order */
765
static inline void SetWBE (void *p, uint16_t w)
Gildas Bazin's avatar
 
Gildas Bazin committed
766
{
767 768
    w = hton16 (w);
    memcpy (p, &w, sizeof (w));
Gildas Bazin's avatar
 
Gildas Bazin committed
769
}
770 771

/** Writes 32 bits in network byte order */
772
static inline void SetDWBE (void *p, uint32_t dw)
Gildas Bazin's avatar
 
Gildas Bazin committed
773
{
774 775
    dw = hton32 (dw);
    memcpy (p, &dw, sizeof (dw));
Gildas Bazin's avatar
 
Gildas Bazin committed
776
}
777 778

/** Writes 64 bits in network byte order */
779
static inline void SetQWBE (void *p, uint64_t qw)
780
{
781 782
    qw = hton64 (qw);
    memcpy (p, &qw, sizeof (qw));
783 784
}

785
/** Writes 16 bits in little endian order */
786
static inline void SetWLE (void *p, uint16_t w)
787
{
788 789 790 791
#ifdef WORDS_BIGENDIAN
    w = bswap16 (w);
#endif
    memcpy (p, &w, sizeof (w));
792
}
793 794

/** Writes 32 bits in little endian order */
795
static inline void SetDWLE (void *p, uint32_t dw)
796
{
797 798 799 800
#ifdef WORDS_BIGENDIAN
    dw = bswap32 (dw);
#endif
    memcpy (p, &dw, sizeof (dw));
801
}
802

803
/** Writes 64 bits in little endian order */
804
static inline void SetQWLE (void *p, uint64_t qw)
805
{
806
#ifdef WORDS_BIGENDIAN
807
    qw = bswap64 (qw);
808 809
#endif
    memcpy (p, &qw, sizeof (qw));
810
}
Sam Hocevar's avatar
 
Sam Hocevar committed
811

812 813 814
/* */
#define VLC_UNUSED(x) (void)(x)

815
/* Stuff defined in src/extras/libc.c */
816

817
#if defined(_WIN32)
Sam Hocevar's avatar
 
Sam Hocevar committed
818 819 820
/* several type definitions */
#   if defined( __MINGW32__ )
#       if !defined( _OFF_T_ )
821 822
            typedef long long _off_t;
            typedef _off_t off_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
823 824
#           define _OFF_T_
#       else
Gildas Bazin's avatar
 
Gildas Bazin committed
825 826 827
#           ifdef off_t
#               undef off_t
#           endif
Sam Hocevar's avatar
 
Sam Hocevar committed
828 829 830 831
#           define off_t long long
#       endif
#   endif

Gildas Bazin's avatar
 
Gildas Bazin committed
832 833
#   ifndef O_NONBLOCK
#       define O_NONBLOCK 0
Gildas Bazin's avatar
 
Gildas Bazin committed
834 835
#   endif

836
#   include <tchar.h>
837
#endif /* _WIN32 */
Sam Hocevar's avatar
 
Sam Hocevar committed
838

839 840 841 842
typedef struct {
    unsigned num, den;
} vlc_rational_t;

843
VLC_API bool vlc_ureduce( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t );
844

845 846 847
#define container_of(ptr, type, member) \
    ((type *)(((char *)(ptr)) - offsetof(type, member)))

848
/* Aligned memory allocator */
849

850
#ifdef __MINGW32__
851 852
# define vlc_memalign(align, size) (__mingw_aligned_malloc(size, align))
# define vlc_free(base)            (__mingw_aligned_free(base))
853 854 855
#elif defined(_MSC_VER)
# define vlc_memalign(align, size) (_aligned_malloc(size, align))
# define vlc_free(base)            (_aligned_free(base))
856
#else
857
# define vlc_memalign(align, size) aligned_alloc(align, size)
858
# define vlc_free(base) free(base)
859
#endif
Laurent Aimar's avatar
Laurent Aimar committed
860

Sam Hocevar's avatar
 
Sam Hocevar committed
861 862 863
/*****************************************************************************
 * I18n stuff
 *****************************************************************************/
864 865
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);
866

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
867 868 869
#define vlc_pgettext( ctx, id ) \
        vlc_pgettext_aux( ctx "\004" id, id )

870
VLC_FORMAT_ARG(2)
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
871
static inline const char *vlc_pgettext_aux( const char *ctx, const char *id )
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
872
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
873
    const char *tr = vlc_gettext( ctx );
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
874 875 876
    return (tr == ctx) ? id : tr;
}

877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895
/*****************************************************************************
 * Loosy memory allocation functions. Do not use in new code.
 *****************************************************************************/
static inline void *xmalloc (size_t len)
{
    void *ptr = malloc (len);
    if (unlikely (ptr == NULL))
        abort ();
    return ptr;
}

static inline void *xrealloc (void *ptr, size_t len)
{
    void *nptr = realloc (ptr, len);
    if (unlikely (nptr == NULL))
        abort ();
    return nptr;
}

896 897 898 899 900 901 902 903
static inline void *xcalloc (size_t n, size_t size)
{
    void *ptr = calloc (n, size);
    if (unlikely (ptr == NULL))
        abort ();
    return ptr;
}

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
904 905 906 907 908 909 910 911
static inline char *xstrdup (const char *str)
{
    char *ptr = strdup (str);
    if (unlikely(ptr == NULL))
        abort ();
    return ptr;
}

912 913 914
/*****************************************************************************
 * libvlc features
 *****************************************************************************/
915 916 917
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;
918

919
/*****************************************************************************
920
 * Additional vlc stuff
921
 *****************************************************************************/
922
#include "vlc_messages.h"
Sam Hocevar's avatar
Sam Hocevar committed
923
#include "vlc_objects.h"
924
#include "vlc_variables.h"
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
925
#include "vlc_main.h"
Clément Stenac's avatar
Clément Stenac committed
926
#include "vlc_configuration.h"
927

928
#if defined( _WIN32 ) || defined( __OS2__ )
929
#   define DIR_SEP_CHAR '\\'
Antoine Cellerier's avatar
Antoine Cellerier committed
930
#   define DIR_SEP "\\"
931 932
#   define PATH_SEP_CHAR ';'
#   define PATH_SEP ";"
Antoine Cellerier's avatar
Antoine Cellerier committed
933
#else
934
#   define DIR_SEP_CHAR '/'
Antoine Cellerier's avatar
Antoine Cellerier committed
935
#   define DIR_SEP "/"
936 937
#   define PATH_SEP_CHAR ':'
#   define PATH_SEP ":"
Antoine Cellerier's avatar
Antoine Cellerier committed
938
#endif
939

940 941 942 943 944 945
#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")

946
#endif /* !VLC_COMMON_H */