vlc_common.h 25.7 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 115 116 117 118 119 120 121
/* Branch prediction */
#ifdef __GNUC__
#   define likely(p)   __builtin_expect(!!(p), 1)
#   define unlikely(p) __builtin_expect(!!(p), 0)
#else
#   define likely(p)   (!!(p))
#   define unlikely(p) (!!(p))
#endif

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

129
#if defined (_WIN32) && defined (DLL_EXPORT)
130
# define VLC_EXPORT __declspec(dllexport)
131
#elif VLC_GCC_VERSION(4,0)
132
# define VLC_EXPORT __attribute__((visibility("default")))
133
#else
134
# define VLC_EXPORT
135 136
#endif

137
#define VLC_API VLC_EXTERN VLC_EXPORT
138 139


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

Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
155
/**
156
 * The vlc_fourcc_t type.
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
157
 *
158
 * See http://www.webartz.com/fourcc/ for a very detailed list.
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
159
 */
160
typedef uint32_t vlc_fourcc_t;
161

162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
#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

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

#define vlc_fourcc_to_char( a, b ) \
191
        vlc_fourcc_to_char( (vlc_fourcc_t)(a), (char *)(b) )
192

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

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

Gildas Bazin's avatar
 
Gildas Bazin committed
203
/* Playlist */
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
204 205 206 207 208 209

/* FIXME */
/**
 * Playlist commands
 */
typedef enum {
210
    PLAYLIST_PLAY,      /**< No arg.                            res=can fail*/
211 212
    PLAYLIST_VIEWPLAY,  /**< arg1= playlist_item_t*,*/
                        /**  arg2 = playlist_item_t*          , res=can fail */
213 214 215
    PLAYLIST_PAUSE,     /**< No arg                             res=can fail*/
    PLAYLIST_STOP,      /**< No arg                             res=can fail*/
    PLAYLIST_SKIP,      /**< arg1=int,                          res=can fail*/
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
216 217 218
} playlist_command_t;


219 220
typedef struct playlist_t playlist_t;
typedef struct playlist_item_t playlist_item_t;
221 222
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
223
typedef struct playlist_add_t playlist_add_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
224

225
/* Modules */
226 227
typedef struct module_t module_t;
typedef struct module_config_t module_config_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
228

229 230
typedef struct config_category_t config_category_t;

Sam Hocevar's avatar
 
Sam Hocevar committed
231
/* Input */
232
typedef struct input_thread_t input_thread_t;
233
typedef struct input_item_t input_item_t;
234
typedef struct input_item_node_t input_item_node_t;
235
typedef struct access_t access_t;
236
typedef struct access_sys_t access_sys_t;
237 238 239
typedef struct stream_t     stream_t;
typedef struct stream_sys_t stream_sys_t;
typedef struct demux_t  demux_t;
240
typedef struct demux_sys_t demux_sys_t;
241 242 243
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
244
typedef struct seekpoint_t seekpoint_t;
245 246
typedef struct info_t info_t;
typedef struct info_category_t info_category_t;
247
typedef struct input_attachment_t input_attachment_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
248

249 250 251 252
/* 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
253 254
typedef struct es_format_t es_format_t;
typedef struct video_palette_t video_palette_t;
255

Sam Hocevar's avatar
 
Sam Hocevar committed
256
/* Audio */
257
typedef struct audio_output audio_output_t;
258
typedef struct aout_sys_t aout_sys_t;
Gildas Bazin's avatar
 
Gildas Bazin committed
259
typedef audio_format_t audio_sample_format_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
260 261

/* Video */
262
typedef struct vout_thread_t vout_thread_t;
263

Gildas Bazin's avatar
 
Gildas Bazin committed
264
typedef video_format_t video_frame_format_t;
265 266
typedef struct picture_t picture_t;
typedef struct picture_sys_t picture_sys_t;
267

268
/* Subpictures */
269
typedef struct spu_t spu_t;
270
typedef struct subpicture_t subpicture_t;
271
typedef struct subpicture_region_t subpicture_region_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
272

273 274
typedef struct image_handler_t image_handler_t;

275 276
/* Stream output */
typedef struct sout_instance_t sout_instance_t;
277

278
typedef struct sout_input_t sout_input_t;
279
typedef struct sout_packetizer_input_t sout_packetizer_input_t;
280

281
typedef struct sout_access_out_t sout_access_out_t;
282 283
typedef struct sout_access_out_sys_t   sout_access_out_sys_t;

284
typedef struct sout_mux_t sout_mux_t;
285 286
typedef struct sout_mux_sys_t sout_mux_sys_t;

287
typedef struct sout_stream_t    sout_stream_t;
288 289
typedef struct sout_stream_sys_t sout_stream_sys_t;

290
typedef struct config_chain_t       config_chain_t;
291
typedef struct session_descriptor_t session_descriptor_t;
292

Sam Hocevar's avatar
 
Sam Hocevar committed
293
/* Decoders */
Laurent Aimar's avatar
Laurent Aimar committed
294 295 296
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
297

Gildas Bazin's avatar
 
Gildas Bazin committed
298 299 300 301
/* Encoders */
typedef struct encoder_t      encoder_t;
typedef struct encoder_sys_t  encoder_sys_t;

302 303 304 305
/* Filters */
typedef struct filter_t filter_t;
typedef struct filter_sys_t filter_sys_t;

306
/* Network */
307
typedef struct virtual_socket_t v_socket_t;
308
typedef struct vlc_url_t vlc_url_t;
309

310 311 312
/* Misc */
typedef struct iso639_lang_t iso639_lang_t;

313 314 315 316
/* block */
typedef struct block_t      block_t;
typedef struct block_fifo_t block_fifo_t;

317 318 319
/* Hashing */
typedef struct md5_s md5_t;

Gildas Bazin's avatar
Gildas Bazin committed
320 321 322 323 324 325
/* 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;

326 327 328
/* vod server */
typedef struct vod_t     vod_t;
typedef struct vod_sys_t vod_sys_t;
329
typedef struct vod_media_t vod_media_t;
330

331
/* VLM */
332 333
typedef struct vlm_t         vlm_t;
typedef struct vlm_message_t vlm_message_t;
334

335
/* misc */
336
typedef struct vlc_meta_t    vlc_meta_t;
Clément Stenac's avatar
Clément Stenac committed
337
typedef struct input_stats_t input_stats_t;
338
typedef struct addon_entry_t addon_entry_t;
339

340 341
/* Update */
typedef struct update_t update_t;
342

343 344 345 346 347
/**
 * VLC value structure
 */
typedef union
{
348
    int64_t         i_int;
349
    bool            b_bool;
350 351 352 353 354 355
    float           f_float;
    char *          psz_string;
    void *          p_address;
    vlc_object_t *  p_object;
    vlc_list_t *    p_list;
    mtime_t         i_time;
356
    struct { int32_t x; int32_t y; } coords;
357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373

} vlc_value_t;

/**
 * VLC list structure
 */
struct vlc_list_t
{
    int             i_count;
    vlc_value_t *   p_values;
    int *           pi_types;

};

/*****************************************************************************
 * Error values (shouldn't be exposed)
 *****************************************************************************/
374 375 376 377 378 379 380 381 382
#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 */
383

384 385 386 387 388 389 390 391 392
/*****************************************************************************
 * Variable callbacks
 *****************************************************************************/
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 */

393 394 395
/*****************************************************************************
 * OS-specific headers and thread types
 *****************************************************************************/
396
#if defined( _WIN32 )
397 398 399 400 401 402 403 404 405
#   include <malloc.h>
#   ifndef PATH_MAX
#       define PATH_MAX MAX_PATH
#   endif
#   include <windows.h>
#endif

#ifdef __SYMBIAN32__
 #include <sys/syslimits.h>
406 407
#endif

408 409 410 411 412 413 414
#ifdef __OS2__
#   define OS2EMX_PLAIN_CHAR
#   define INCL_BASE
#   define INCL_PM
#   include <os2.h>
#endif

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
415
#include "vlc_mtime.h"
416 417 418 419 420 421 422 423
#include "vlc_threads.h"

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

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

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

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

479 480 481
/* clip v in [min, max] */
#define VLC_CLIP(v, min, max)    __MIN(__MAX((v), (min)), (max))

482
VLC_USED
483
static inline int64_t GCD ( int64_t a, int64_t b )
484
{
485 486 487 488 489 490 491
    while( b )
    {
        int64_t c = a % b;
        a = b;
        b = c;
    }
    return a;
492 493
}

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

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

    while (x)
    {
513
        x >>= 1;
514 515 516 517 518 519 520 521 522 523 524
        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))

525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542
/** 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
}

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

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
560 561 562 563 564 565 566 567 568 569 570 571
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
}

572 573 574 575 576 577
#ifdef __OS2__
#   undef bswap16
#   undef bswap32
#   undef bswap64
#endif

578 579 580 581 582 583 584 585 586 587 588
/** 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
589
#if VLC_GCC_VERSION(4,3) || defined(__clang__)
590 591 592 593 594 595 596 597 598 599 600 601 602
    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
603
#if VLC_GCC_VERSION(4,3) || defined(__clang__)
604
    return __builtin_bswap64 (x);
605
#elif !defined (__cplusplus)
606 607 608 609 610 611 612 613
    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);
614
#else
615 616 617 618 619 620 621 622
    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);
623 624 625 626
#endif
}


627
/* Free and set set the variable to NULL */
628
#define FREENULL(a) do { free( a ); a = NULL; } while(0)
629

630 631
#define EMPTY_STR(str) (!str || !*str)

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

634
#include <vlc_arrays.h>
635

Sam Hocevar's avatar
 
Sam Hocevar committed
636
/* MSB (big endian)/LSB (little endian) conversions - network order is always
637
 * MSB, and should be used for both network communications and files. */
638 639 640 641

#ifdef WORDS_BIGENDIAN
# define hton16(i) ((uint16_t)(i))
# define hton32(i) ((uint32_t)(i))
642
# define hton64(i) ((uint64_t)(i))
643 644 645 646 647 648 649 650 651 652
#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 */
653
VLC_USED
654
static inline uint16_t U16_AT (const void *p)
655
{
656 657 658 659
    uint16_t x;

    memcpy (&x, p, sizeof (x));
    return ntoh16 (x);
660
}
661

662
/** Reads 32 bits in network byte order */
663
VLC_USED
664
static inline uint32_t U32_AT (const void *p)
665
{
666 667 668 669
    uint32_t x;

    memcpy (&x, p, sizeof (x));
    return ntoh32 (x);
670
}
671

672
/** Reads 64 bits in network byte order */
673
VLC_USED
674
static inline uint64_t U64_AT (const void *p)
675
{
676 677 678 679
    uint64_t x;

    memcpy (&x, p, sizeof (x));
    return ntoh64 (x);
680
}
681

682 683 684 685 686
#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 */
687
VLC_USED
688
static inline uint16_t GetWLE (const void *p)
689
{
690 691 692 693 694 695 696
    uint16_t x;

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

699
/** Reads 32 bits in little-endian order */
700
VLC_USED
701
static inline uint32_t GetDWLE (const void *p)
702
{
703 704 705 706 707 708 709
    uint32_t x;

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

712
/** Reads 64 bits in little-endian order */
713
VLC_USED
714
static inline uint64_t GetQWLE (const void *p)
715
{
716
    uint64_t x;
717

718 719 720 721 722
    memcpy (&x, p, sizeof (x));
#ifdef WORDS_BIGENDIAN
    x = bswap64 (x);
#endif
    return x;
Gildas Bazin's avatar
 
Gildas Bazin committed
723 724
}

725
/** Writes 16 bits in network byte order */
726
static inline void SetWBE (void *p, uint16_t w)
Gildas Bazin's avatar
 
Gildas Bazin committed
727
{
728 729
    w = hton16 (w);
    memcpy (p, &w, sizeof (w));
Gildas Bazin's avatar
 
Gildas Bazin committed
730
}
731 732

/** Writes 32 bits in network byte order */
733
static inline void SetDWBE (void *p, uint32_t dw)
Gildas Bazin's avatar
 
Gildas Bazin committed
734
{
735 736
    dw = hton32 (dw);
    memcpy (p, &dw, sizeof (dw));
Gildas Bazin's avatar
 
Gildas Bazin committed
737
}
738 739

/** Writes 64 bits in network byte order */
740
static inline void SetQWBE (void *p, uint64_t qw)
741
{
742 743
    qw = hton64 (qw);
    memcpy (p, &qw, sizeof (qw));
744 745
}

746
/** Writes 16 bits in little endian order */
747
static inline void SetWLE (void *p, uint16_t w)
748
{
749 750 751 752
#ifdef WORDS_BIGENDIAN
    w = bswap16 (w);
#endif
    memcpy (p, &w, sizeof (w));
753
}
754 755

/** Writes 32 bits in little endian order */
756
static inline void SetDWLE (void *p, uint32_t dw)
757
{
758 759 760 761
#ifdef WORDS_BIGENDIAN
    dw = bswap32 (dw);
#endif
    memcpy (p, &dw, sizeof (dw));
762
}
763

764
/** Writes 64 bits in little endian order */
765
static inline void SetQWLE (void *p, uint64_t qw)
766
{
767
#ifdef WORDS_BIGENDIAN
768
    qw = bswap64 (qw);
769 770
#endif
    memcpy (p, &qw, sizeof (qw));
771
}
Sam Hocevar's avatar
 
Sam Hocevar committed
772

773 774 775
/* */
#define VLC_UNUSED(x) (void)(x)

776
/* Stuff defined in src/extras/libc.c */
777

778
#if defined(_WIN32)
Sam Hocevar's avatar
 
Sam Hocevar committed
779 780 781
/* several type definitions */
#   if defined( __MINGW32__ )
#       if !defined( _OFF_T_ )
782 783
            typedef long long _off_t;
            typedef _off_t off_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
784 785
#           define _OFF_T_
#       else
Gildas Bazin's avatar
 
Gildas Bazin committed
786 787 788
#           ifdef off_t
#               undef off_t
#           endif
Sam Hocevar's avatar
 
Sam Hocevar committed
789 790 791 792
#           define off_t long long
#       endif
#   endif

Gildas Bazin's avatar
 
Gildas Bazin committed
793 794
#   ifndef O_NONBLOCK
#       define O_NONBLOCK 0
Gildas Bazin's avatar
 
Gildas Bazin committed
795 796
#   endif

797
#   include <tchar.h>
798
#endif /* _WIN32 */
Sam Hocevar's avatar
 
Sam Hocevar committed
799

800
VLC_API bool vlc_ureduce( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t );
801

802
/* Aligned memory allocator */
803 804 805 806
#ifdef __APPLE__
#include <AvailabilityMacros.h>
#endif

807
#ifdef __MINGW32__
808 809
# define vlc_memalign(align, size) (__mingw_aligned_malloc(size, align))
# define vlc_free(base)            (__mingw_aligned_free(base))
810 811 812
#elif defined(_MSC_VER)
# define vlc_memalign(align, size) (_aligned_malloc(size, align))
# define vlc_free(base)            (_aligned_free(base))
813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832
#elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
static inline void *vlc_memalign(size_t align, size_t size)
{
    long diff;
    void *ptr;

    ptr = malloc(size+align);
    if(!ptr)
        return ptr;
    diff = ((-(long)ptr - 1)&(align-1)) + 1;
    ptr  = (char*)ptr + diff;
    ((char*)ptr)[-1]= diff;
    return ptr;
}

static void vlc_free(void *ptr)
{
    if (ptr)
        free((char*)ptr - ((char*)ptr)[-1]);
}
833
#else
834 835 836 837 838 839 840 841
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)
842
#endif
Laurent Aimar's avatar
Laurent Aimar committed
843

844
VLC_API void vlc_tdestroy( void *, void (*)(void *) );
845

Sam Hocevar's avatar
 
Sam Hocevar committed
846 847 848
/*****************************************************************************
 * I18n stuff
 *****************************************************************************/
849 850
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);
851

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
852 853 854
#define vlc_pgettext( ctx, id ) \
        vlc_pgettext_aux( ctx "\004" id, id )

855
VLC_FORMAT_ARG(2)
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
856
static inline const char *vlc_pgettext_aux( const char *ctx, const char *id )
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
857
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
858
    const char *tr = vlc_gettext( ctx );
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
859 860 861
    return (tr == ctx) ? id : tr;
}

862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880
/*****************************************************************************
 * 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;
}

881 882 883 884 885 886 887 888
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
889 890 891 892 893 894 895 896
static inline char *xstrdup (const char *str)
{
    char *ptr = strdup (str);
    if (unlikely(ptr == NULL))
        abort ();
    return ptr;
}

897 898 899
/*****************************************************************************
 * libvlc features
 *****************************************************************************/
900 901 902
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;
903

904
/*****************************************************************************
905
 * Additional vlc stuff
906
 *****************************************************************************/
907
#include "vlc_messages.h"
Sam Hocevar's avatar
Sam Hocevar committed
908
#include "vlc_objects.h"
909
#include "vlc_variables.h"
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
910
#include "vlc_main.h"
Clément Stenac's avatar
Clément Stenac committed
911
#include "vlc_configuration.h"
912

913
#if defined( _WIN32 ) || defined( __SYMBIAN32__ ) || defined( __OS2__ )
914
#   define DIR_SEP_CHAR '\\'
Antoine Cellerier's avatar
Antoine Cellerier committed
915
#   define DIR_SEP "\\"
916 917
#   define PATH_SEP_CHAR ';'
#   define PATH_SEP ";"
Antoine Cellerier's avatar
Antoine Cellerier committed
918
#else
919
#   define DIR_SEP_CHAR '/'
Antoine Cellerier's avatar
Antoine Cellerier committed
920
#   define DIR_SEP "/"
921 922
#   define PATH_SEP_CHAR ':'
#   define PATH_SEP ":"
Antoine Cellerier's avatar
Antoine Cellerier committed
923
#endif
924

925 926 927 928 929 930
#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")

931
#endif /* !VLC_COMMON_H */