vlc_common.h 25.6 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 87 88 89 90 91 92 93 94
# define VLC_DEPRECATED __attribute__((deprecated))

# if defined( _WIN32 ) && VLC_GCC_VERSION(4,4)
#  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))
95
# define VLC_NORETURN __attribute__ ((noreturn))
96 97 98 99 100 101 102

# if VLC_GCC_VERSION(3,4)
#  define VLC_USED __attribute__ ((warn_unused_result))
# else
#  define VLC_USED
# endif

103
#else
104 105 106 107
# define VLC_DEPRECATED
# define VLC_FORMAT(x,y)
# define VLC_FORMAT_ARG(x)
# define VLC_MALLOC
108
# define VLC_NORETURN
109
# define VLC_USED
110 111
#endif

112

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

124 125
#define vlc_assert_unreachable() (assert(!"unreachable"), unreachable())

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

133
#if defined (_WIN32) && defined (DLL_EXPORT)
134
# define VLC_EXPORT __declspec(dllexport)
135
#elif VLC_GCC_VERSION(4,0)
136
# define VLC_EXPORT __attribute__((visibility("default")))
137
#else
138
# define VLC_EXPORT
139 140
#endif

141
#define VLC_API VLC_EXTERN VLC_EXPORT
142 143


Sam Hocevar's avatar
 
Sam Hocevar committed
144 145 146
/*****************************************************************************
 * Basic types definitions
 *****************************************************************************/
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
147 148 149
/**
 * High precision date or time interval
 *
150 151
 * 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
152
 * time interval is then 292271 years, which should be long enough for any
153 154
 * 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
155
 * arithmetic operators, and that no special functions are required.
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
156
 */
157
typedef int64_t mtime_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
158

Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
159
/**
160
 * The vlc_fourcc_t type.
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
161
 *
162
 * See http://www.webartz.com/fourcc/ for a very detailed list.
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
163
 */
164
typedef uint32_t vlc_fourcc_t;
165

166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
#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

182 183 184 185 186 187 188
/**
 * 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
 */
189
static inline void vlc_fourcc_to_char( vlc_fourcc_t fcc, char *psz_fourcc )
190
{
191
    memcpy( psz_fourcc, &fcc, 4 );
192 193
}

Sam Hocevar's avatar
 
Sam Hocevar committed
194 195 196 197
/*****************************************************************************
 * Classes declaration
 *****************************************************************************/

198
/* Internal types */
199 200
typedef struct vlc_list_t vlc_list_t;
typedef struct vlc_object_t vlc_object_t;
201
typedef struct libvlc_int_t libvlc_int_t;
202
typedef struct date_t date_t;
203

Gildas Bazin's avatar
 
Gildas Bazin committed
204
/* Playlist */
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
205

206 207
typedef struct playlist_t playlist_t;
typedef struct playlist_item_t playlist_item_t;
208 209
typedef struct services_discovery_t services_discovery_t;
typedef struct services_discovery_sys_t services_discovery_sys_t;
Clément Stenac's avatar
Clément Stenac committed
210
typedef struct playlist_add_t playlist_add_t;
211 212
typedef struct vlc_renderer_discovery vlc_renderer_discovery;
typedef struct vlc_renderer_item vlc_renderer_item;
Sam Hocevar's avatar
 
Sam Hocevar committed
213

214
/* Modules */
215 216
typedef struct module_t module_t;
typedef struct module_config_t module_config_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
217

218 219
typedef struct config_category_t config_category_t;

Sam Hocevar's avatar
 
Sam Hocevar committed
220
/* Input */
221
typedef struct input_thread_t input_thread_t;
222
typedef struct input_item_t input_item_t;
223
typedef struct input_item_node_t input_item_node_t;
224
typedef struct access_t access_t;
225
typedef struct access_sys_t access_sys_t;
226 227 228
typedef struct stream_t     stream_t;
typedef struct stream_sys_t stream_sys_t;
typedef struct demux_t  demux_t;
229
typedef struct demux_sys_t demux_sys_t;
230 231 232
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
233
typedef struct seekpoint_t seekpoint_t;
234 235
typedef struct info_t info_t;
typedef struct info_category_t info_category_t;
236
typedef struct input_attachment_t input_attachment_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
237

238 239 240 241
/* 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
242 243
typedef struct es_format_t es_format_t;
typedef struct video_palette_t video_palette_t;
244

Sam Hocevar's avatar
 
Sam Hocevar committed
245
/* Audio */
246
typedef struct audio_output audio_output_t;
247
typedef struct aout_sys_t aout_sys_t;
Gildas Bazin's avatar
 
Gildas Bazin committed
248
typedef audio_format_t audio_sample_format_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
249 250

/* Video */
251
typedef struct vout_thread_t vout_thread_t;
252

Gildas Bazin's avatar
 
Gildas Bazin committed
253
typedef video_format_t video_frame_format_t;
254 255
typedef struct picture_t picture_t;
typedef struct picture_sys_t picture_sys_t;
256

257
/* Subpictures */
258
typedef struct spu_t spu_t;
259
typedef struct subpicture_t subpicture_t;
260
typedef struct subpicture_region_t subpicture_region_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
261

262 263
typedef struct image_handler_t image_handler_t;

264 265
/* Stream output */
typedef struct sout_instance_t sout_instance_t;
266

267
typedef struct sout_input_t sout_input_t;
268
typedef struct sout_packetizer_input_t sout_packetizer_input_t;
269

270
typedef struct sout_access_out_t sout_access_out_t;
271 272
typedef struct sout_access_out_sys_t   sout_access_out_sys_t;

273
typedef struct sout_mux_t sout_mux_t;
274 275
typedef struct sout_mux_sys_t sout_mux_sys_t;

276
typedef struct sout_stream_t    sout_stream_t;
277 278
typedef struct sout_stream_sys_t sout_stream_sys_t;

279
typedef struct config_chain_t       config_chain_t;
280
typedef struct session_descriptor_t session_descriptor_t;
281

Sam Hocevar's avatar
 
Sam Hocevar committed
282
/* Decoders */
Laurent Aimar's avatar
Laurent Aimar committed
283 284 285
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
286

Gildas Bazin's avatar
 
Gildas Bazin committed
287 288 289 290
/* Encoders */
typedef struct encoder_t      encoder_t;
typedef struct encoder_sys_t  encoder_sys_t;

291 292 293 294
/* Filters */
typedef struct filter_t filter_t;
typedef struct filter_sys_t filter_sys_t;

295
/* Network */
296
typedef struct vlc_url_t vlc_url_t;
297

298 299 300
/* Misc */
typedef struct iso639_lang_t iso639_lang_t;

301 302 303 304
/* block */
typedef struct block_t      block_t;
typedef struct block_fifo_t block_fifo_t;

305 306 307
/* Hashing */
typedef struct md5_s md5_t;

Gildas Bazin's avatar
Gildas Bazin committed
308 309 310 311 312 313
/* 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;

314 315 316
/* vod server */
typedef struct vod_t     vod_t;
typedef struct vod_sys_t vod_sys_t;
317
typedef struct vod_media_t vod_media_t;
318

319
/* VLM */
320 321
typedef struct vlm_t         vlm_t;
typedef struct vlm_message_t vlm_message_t;
322

323
/* misc */
324
typedef struct vlc_meta_t    vlc_meta_t;
Clément Stenac's avatar
Clément Stenac committed
325
typedef struct input_stats_t input_stats_t;
326
typedef struct addon_entry_t addon_entry_t;
327

328 329
/* Update */
typedef struct update_t update_t;
330

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

} vlc_value_t;

/**
 * VLC list structure
 */
struct vlc_list_t
{
351 352 353
    int          i_type;
    int          i_count;
    vlc_value_t *p_values;
354 355 356 357 358
};

/*****************************************************************************
 * Error values (shouldn't be exposed)
 *****************************************************************************/
359 360 361 362 363 364 365 366 367
#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 */
368

369
/*****************************************************************************
370
 * Variable callbacks: called when the value is modified
371 372 373 374 375 376 377
 *****************************************************************************/
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 */

378 379 380 381 382 383 384 385 386
/*****************************************************************************
 * 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 */

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

398 399 400 401 402
#ifdef __APPLE__
#include <sys/syslimits.h>
#include <AvailabilityMacros.h>
#endif

403 404 405 406
#ifdef __OS2__
#   define OS2EMX_PLAIN_CHAR
#   define INCL_BASE
#   define INCL_PM
KO Myung-Hun's avatar
KO Myung-Hun committed
407
#   include <os2safe.h>
408 409 410
#   include <os2.h>
#endif

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
411
#include "vlc_mtime.h"
412 413 414 415 416 417 418 419
#include "vlc_threads.h"

/*****************************************************************************
 * Common structure members
 *****************************************************************************/

/* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
#define VLC_COMMON_MEMBERS                                                  \
420 421 422 423
/** \name VLC_COMMON_MEMBERS                                                \
 * these members are common for all vlc objects                             \
 */                                                                         \
/**@{*/                                                                     \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
424
    const char *psz_object_type;                                            \
425
                                                                            \
426 427
    /* Messages header */                                                   \
    char *psz_header;                                                       \
428
    int  i_flags;                                                           \
429
                                                                            \
Sam Hocevar's avatar
Sam Hocevar committed
430
    /* Object properties */                                                 \
431
    bool b_force;      /**< set by the outside (eg. module_need()) */ \
432
                                                                            \
Sam Hocevar's avatar
Sam Hocevar committed
433
    /* Stuff related to the libvlc structure */                             \
434
    libvlc_int_t *p_libvlc;                  /**< (root of all evil) - 1 */ \
435
                                                                            \
436
    vlc_object_t *  p_parent;                            /**< our parent */ \
437
                                                                            \
438
/**@}*/                                                                     \
439

440
/* VLC_OBJECT: attempt at doing a clever cast */
441
#if VLC_GCC_VERSION(4,0)
442 443
# ifndef __cplusplus
#  define VLC_OBJECT( x ) \
444 445 446 447
    __builtin_choose_expr( \
        __builtin_offsetof(__typeof__(*(x)), psz_object_type), \
        (void)0 /* screw you */, \
        (vlc_object_t *)(x))
448 449 450
# else
#  define VLC_OBJECT( x ) \
    ((vlc_object_t *)(x) \
451
      + 0 * __builtin_offsetof(__typeof__(*(x)), psz_object_type))
452
# endif
453 454 455
#else
# define VLC_OBJECT( x ) ((vlc_object_t *)(x))
#endif
456

Sam Hocevar's avatar
 
Sam Hocevar committed
457 458 459 460 461 462 463 464 465 466
/*****************************************************************************
 * 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
467 468 469
/* __MAX and __MIN: self explanatory */
#ifndef __MAX
#   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
Sam Hocevar's avatar
 
Sam Hocevar committed
470
#endif
Sam Hocevar's avatar
 
Sam Hocevar committed
471 472
#ifndef __MIN
#   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
Sam Hocevar's avatar
 
Sam Hocevar committed
473 474
#endif

475 476 477
/* clip v in [min, max] */
#define VLC_CLIP(v, min, max)    __MIN(__MAX((v), (min)), (max))

478
VLC_USED
479
static inline int64_t GCD ( int64_t a, int64_t b )
480
{
481 482 483 484 485 486 487
    while( b )
    {
        int64_t c = a % b;
        a = b;
        b = c;
    }
    return a;
488 489
}

490
/* function imported from libavutil/common.h */
491
VLC_USED
492 493 494 495 496 497
static inline uint8_t clip_uint8_vlc( int32_t a )
{
    if( a&(~255) ) return (-a)>>31;
    else           return a;
}

498
/** Count leading zeroes */
499
VLC_USED
500 501
static inline unsigned clz (unsigned x)
{
502
#if VLC_GCC_VERSION(3,4)
503 504 505 506 507 508
    return __builtin_clz (x);
#else
    unsigned i = sizeof (x) * 8;

    while (x)
    {
509
        x >>= 1;
510 511 512 513 514 515 516 517 518 519 520
        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))

521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538
/** Count trailing zeroes */
VLC_USED
static inline unsigned ctz (unsigned x)
{
#if VLC_GCC_VERSION(3,4)
    return __builtin_ctz (x);
#else
    unsigned i = sizeof (x) * 8;

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

539
/** Bit weight */
540
VLC_USED
541 542
static inline unsigned popcount (unsigned x)
{
543
#if VLC_GCC_VERSION(3,4)
544 545 546 547 548 549 550 551 552 553 554 555
    return __builtin_popcount (x);
#else
    unsigned count = 0;
    while (x)
    {
        count += x & 1;
        x = x >> 1;
    }
    return count;
#endif
}

556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572
/** Bit weight of long long */
VLC_USED
static inline int popcountll(unsigned long long x)
{
#if VLC_GCC_VERSION(3,4)
    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
573 574 575 576 577 578 579 580 581 582 583 584
VLC_USED
static inline unsigned parity (unsigned x)
{
#if VLC_GCC_VERSION(3,4)
    return __builtin_parity (x);
#else
    for (unsigned i = 4 * sizeof (x); i > 0; i /= 2)
        x ^= x >> i;
    return x & 1;
#endif
}

585 586 587 588 589 590
#ifdef __OS2__
#   undef bswap16
#   undef bswap32
#   undef bswap64
#endif

591 592 593 594 595 596 597 598 599 600 601
/** Byte swap (16 bits) */
VLC_USED
static inline uint16_t bswap16 (uint16_t x)
{
    return (x << 8) | (x >> 8);
}

/** Byte swap (32 bits) */
VLC_USED
static inline uint32_t bswap32 (uint32_t x)
{
Brad Smith's avatar
Brad Smith committed
602
#if VLC_GCC_VERSION(4,3) || defined(__clang__)
603 604 605 606 607 608 609 610 611 612 613 614 615
    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
static inline uint64_t bswap64 (uint64_t x)
{
Brad Smith's avatar
Brad Smith committed
616
#if VLC_GCC_VERSION(4,3) || defined(__clang__)
617
    return __builtin_bswap64 (x);
618
#elif !defined (__cplusplus)
619 620 621 622 623 624 625 626
    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);
627
#else
628 629 630 631 632 633 634 635
    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);
636 637 638 639
#endif
}


640
/* Free and set set the variable to NULL */
641
#define FREENULL(a) do { free( a ); a = NULL; } while(0)
642

643 644
#define EMPTY_STR(str) (!str || !*str)

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

647
#include <vlc_arrays.h>
648

Sam Hocevar's avatar
 
Sam Hocevar committed
649
/* MSB (big endian)/LSB (little endian) conversions - network order is always
650
 * MSB, and should be used for both network communications and files. */
651 652 653 654

#ifdef WORDS_BIGENDIAN
# define hton16(i) ((uint16_t)(i))
# define hton32(i) ((uint32_t)(i))
655
# define hton64(i) ((uint64_t)(i))
656 657 658 659 660 661 662 663 664 665
#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 */
666
VLC_USED
667
static inline uint16_t U16_AT (const void *p)
668
{
669 670 671 672
    uint16_t x;

    memcpy (&x, p, sizeof (x));
    return ntoh16 (x);
673
}
674

675
/** Reads 32 bits in network byte order */
676
VLC_USED
677
static inline uint32_t U32_AT (const void *p)
678
{
679 680 681 682
    uint32_t x;

    memcpy (&x, p, sizeof (x));
    return ntoh32 (x);
683
}
684

685
/** Reads 64 bits in network byte order */
686
VLC_USED
687
static inline uint64_t U64_AT (const void *p)
688
{
689 690 691 692
    uint64_t x;

    memcpy (&x, p, sizeof (x));
    return ntoh64 (x);
693
}
694

695 696 697 698 699
#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 */
700
VLC_USED
701
static inline uint16_t GetWLE (const void *p)
702
{
703 704 705 706 707 708 709
    uint16_t x;

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

712
/** Reads 32 bits in little-endian order */
713
VLC_USED
714
static inline uint32_t GetDWLE (const void *p)
715
{
716 717 718 719 720 721 722
    uint32_t x;

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

725
/** Reads 64 bits in little-endian order */
726
VLC_USED
727
static inline uint64_t GetQWLE (const void *p)
728
{
729
    uint64_t x;
730

731 732 733 734 735
    memcpy (&x, p, sizeof (x));
#ifdef WORDS_BIGENDIAN
    x = bswap64 (x);
#endif
    return x;
Gildas Bazin's avatar
 
Gildas Bazin committed
736 737
}

738
/** Writes 16 bits in network byte order */
739
static inline void SetWBE (void *p, uint16_t w)
Gildas Bazin's avatar
 
Gildas Bazin committed
740
{
741 742
    w = hton16 (w);
    memcpy (p, &w, sizeof (w));
Gildas Bazin's avatar
 
Gildas Bazin committed
743
}
744 745

/** Writes 32 bits in network byte order */
746
static inline void SetDWBE (void *p, uint32_t dw)
Gildas Bazin's avatar
 
Gildas Bazin committed
747
{
748 749
    dw = hton32 (dw);
    memcpy (p, &dw, sizeof (dw));
Gildas Bazin's avatar
 
Gildas Bazin committed
750
}
751 752

/** Writes 64 bits in network byte order */
753
static inline void SetQWBE (void *p, uint64_t qw)
754
{
755 756
    qw = hton64 (qw);
    memcpy (p, &qw, sizeof (qw));
757 758
}

759
/** Writes 16 bits in little endian order */
760
static inline void SetWLE (void *p, uint16_t w)
761
{
762 763 764 765
#ifdef WORDS_BIGENDIAN
    w = bswap16 (w);
#endif
    memcpy (p, &w, sizeof (w));
766
}
767 768

/** Writes 32 bits in little endian order */
769
static inline void SetDWLE (void *p, uint32_t dw)
770
{
771 772 773 774
#ifdef WORDS_BIGENDIAN
    dw = bswap32 (dw);
#endif
    memcpy (p, &dw, sizeof (dw));
775
}
776

777
/** Writes 64 bits in little endian order */
778
static inline void SetQWLE (void *p, uint64_t qw)
779
{
780
#ifdef WORDS_BIGENDIAN
781
    qw = bswap64 (qw);
782 783
#endif
    memcpy (p, &qw, sizeof (qw));
784
}
Sam Hocevar's avatar
 
Sam Hocevar committed
785

786 787 788
/* */
#define VLC_UNUSED(x) (void)(x)

789
/* Stuff defined in src/extras/libc.c */
790

791
#if defined(_WIN32)
Sam Hocevar's avatar
 
Sam Hocevar committed
792 793 794
/* several type definitions */
#   if defined( __MINGW32__ )
#       if !defined( _OFF_T_ )
795 796
            typedef long long _off_t;
            typedef _off_t off_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
797 798
#           define _OFF_T_
#       else
Gildas Bazin's avatar
 
Gildas Bazin committed
799 800 801
#           ifdef off_t
#               undef off_t
#           endif
Sam Hocevar's avatar
 
Sam Hocevar committed
802 803 804 805
#           define off_t long long
#       endif
#   endif

Gildas Bazin's avatar
 
Gildas Bazin committed
806 807
#   ifndef O_NONBLOCK
#       define O_NONBLOCK 0
Gildas Bazin's avatar
 
Gildas Bazin committed
808 809
#   endif

810
#   include <tchar.h>
811
#endif /* _WIN32 */
Sam Hocevar's avatar
 
Sam Hocevar committed
812

813
VLC_API bool vlc_ureduce( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t );
814

815
/* Aligned memory allocator */
816

817
#ifdef __MINGW32__
818 819
# define vlc_memalign(align, size) (__mingw_aligned_malloc(size, align))
# define vlc_free(base)            (__mingw_aligned_free(base))
820 821 822
#elif defined(_MSC_VER)
# define vlc_memalign(align, size) (_aligned_malloc(size, align))
# define vlc_free(base)            (_aligned_free(base))
823
#else
824 825 826 827 828 829 830 831
static inline void *vlc_memalign(size_t align, size_t size)
{
    void *base;
    if (unlikely(posix_memalign(&base, align, size)))
        base = NULL;
    return base;
}
# define vlc_free(base) free(base)
832
#endif
Laurent Aimar's avatar
Laurent Aimar committed
833

Sam Hocevar's avatar
 
Sam Hocevar committed
834 835 836
/*****************************************************************************
 * I18n stuff
 *****************************************************************************/
837 838
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);
839

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
840 841 842
#define vlc_pgettext( ctx, id ) \
        vlc_pgettext_aux( ctx "\004" id, id )

843
VLC_FORMAT_ARG(2)
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
844
static inline const char *vlc_pgettext_aux( const char *ctx, const char *id )
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
845
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
846
    const char *tr = vlc_gettext( ctx );
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
847 848 849
    return (tr == ctx) ? id : tr;
}

850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868
/*****************************************************************************
 * 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;
}

869 870 871 872 873 874 875 876
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
877 878 879 880 881 882 883 884
static inline char *xstrdup (const char *str)
{
    char *ptr = strdup (str);
    if (unlikely(ptr == NULL))
        abort ();
    return ptr;
}

885 886 887
/*****************************************************************************
 * libvlc features
 *****************************************************************************/
888 889 890
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;
891

892
/*****************************************************************************
893
 * Additional vlc stuff
894
 *****************************************************************************/
895
#include "vlc_messages.h"
Sam Hocevar's avatar
Sam Hocevar committed
896
#include "vlc_objects.h"
897
#include "vlc_variables.h"
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
898
#include "vlc_main.h"
Clément Stenac's avatar
Clément Stenac committed
899
#include "vlc_configuration.h"
900

901
#if defined( _WIN32 ) || defined( __OS2__ )
902
#   define DIR_SEP_CHAR '\\'
Antoine Cellerier's avatar
Antoine Cellerier committed
903
#   define DIR_SEP "\\"
904 905
#   define PATH_SEP_CHAR ';'
#   define PATH_SEP ";"
Antoine Cellerier's avatar
Antoine Cellerier committed
906
#else
907
#   define DIR_SEP_CHAR '/'
Antoine Cellerier's avatar
Antoine Cellerier committed
908
#   define DIR_SEP "/"
909 910
#   define PATH_SEP_CHAR ':'
#   define PATH_SEP ":"
Antoine Cellerier's avatar
Antoine Cellerier committed
911
#endif
912

913 914 915 916 917 918
#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")

919
#endif /* !VLC_COMMON_H */