vlc_common.h 27.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
#if defined( _MSC_VER )
Gildas Bazin's avatar
 
Gildas Bazin committed
39
#   pragma warning( disable : 4244 )
40 41
#endif

42 43
#include "vlc_config.h"

Sam Hocevar's avatar
 
Sam Hocevar committed
44 45 46
/*****************************************************************************
 * Required system headers
 *****************************************************************************/
Gildas Bazin's avatar
 
Gildas Bazin committed
47
#include <stdlib.h>
48 49
#include <stdarg.h>

50
#include <string.h>
51
#include <stdio.h>
52
#include <inttypes.h>
53
#include <stddef.h>
Sam Hocevar's avatar
 
Sam Hocevar committed
54

55 56 57 58
#ifndef __cplusplus
# include <stdbool.h>
#endif

59 60 61 62 63 64 65 66
/* 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

67 68 69 70 71 72 73 74 75 76 77 78
/* 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"
79 80
 #define snprintf __mingw_snprintf
 #define vsnprintf __mingw_vsnprintf
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
 *****************************************************************************/
143
#if defined( WIN32 ) || defined( UNDER_CE )
Gildas Bazin's avatar
 
Gildas Bazin committed
144
#   include <malloc.h>
145 146 147
#   ifndef PATH_MAX
#       define PATH_MAX MAX_PATH
#   endif
Gildas Bazin's avatar
 
Gildas Bazin committed
148 149
#endif

150 151 152 153
#ifdef __SYMBIAN32__
 #include <sys/syslimits.h>
#endif

154
/* Audio volume */
155 156
typedef uint16_t            audio_volume_t;

Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
157 158 159
/**
 * High precision date or time interval
 *
160 161
 * 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
162
 * time interval is then 292271 years, which should be long enough for any
163 164
 * 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
165
 * arithmetic operators, and that no special functions are required.
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
166
 */
167
typedef int64_t mtime_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
168

Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
169
/**
170
 * The vlc_fourcc_t type.
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
171
 *
172
 * See http://www.webartz.com/fourcc/ for a very detailed list.
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
173
 */
174
typedef uint32_t vlc_fourcc_t;
175

176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
#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

192 193 194 195 196 197 198
/**
 * 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
 */
199
static inline void vlc_fourcc_to_char( vlc_fourcc_t fcc, char *psz_fourcc )
200
{
201
    memcpy( psz_fourcc, &fcc, 4 );
202 203 204
}

#define vlc_fourcc_to_char( a, b ) \
205
        vlc_fourcc_to_char( (vlc_fourcc_t)(a), (char *)(b) )
206

Sam Hocevar's avatar
 
Sam Hocevar committed
207 208 209 210
/*****************************************************************************
 * Classes declaration
 *****************************************************************************/

211
/* Internal types */
212 213
typedef struct vlc_list_t vlc_list_t;
typedef struct vlc_object_t vlc_object_t;
214
typedef struct libvlc_int_t libvlc_int_t;
215
typedef struct date_t date_t;
216

Gildas Bazin's avatar
 
Gildas Bazin committed
217
/* Playlist */
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
218 219 220 221 222 223

/* FIXME */
/**
 * Playlist commands
 */
typedef enum {
224
    PLAYLIST_PLAY,      /**< No arg.                            res=can fail*/
225 226
    PLAYLIST_VIEWPLAY,  /**< arg1= playlist_item_t*,*/
                        /**  arg2 = playlist_item_t*          , res=can fail */
227 228 229
    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
230 231 232
} playlist_command_t;


233 234
typedef struct playlist_t playlist_t;
typedef struct playlist_item_t playlist_item_t;
235
typedef struct playlist_view_t playlist_view_t;
236 237
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
238
typedef struct playlist_add_t playlist_add_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
239

240
/* Modules */
241 242
typedef struct module_t module_t;
typedef struct module_config_t module_config_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
243

244 245
typedef struct config_category_t config_category_t;

Sam Hocevar's avatar
 
Sam Hocevar committed
246
/* Input */
247
typedef struct input_thread_t input_thread_t;
248
typedef struct input_item_t input_item_t;
249
typedef struct input_item_node_t input_item_node_t;
250
typedef struct access_t access_t;
251
typedef struct access_sys_t access_sys_t;
252 253 254
typedef struct stream_t     stream_t;
typedef struct stream_sys_t stream_sys_t;
typedef struct demux_t  demux_t;
255
typedef struct demux_sys_t demux_sys_t;
256 257 258
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
259
typedef struct seekpoint_t seekpoint_t;
260 261
typedef struct info_t info_t;
typedef struct info_category_t info_category_t;
262
typedef struct input_attachment_t input_attachment_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
263

264 265 266 267
/* 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
268 269
typedef struct es_format_t es_format_t;
typedef struct video_palette_t video_palette_t;
270

Sam Hocevar's avatar
 
Sam Hocevar committed
271
/* Audio */
272
typedef struct audio_output audio_output_t;
273
typedef struct aout_sys_t aout_sys_t;
274
typedef struct aout_fifo_t aout_fifo_t;
275
typedef struct aout_input_t aout_input_t;
276
typedef struct block_t aout_buffer_t;
Gildas Bazin's avatar
 
Gildas Bazin committed
277
typedef audio_format_t audio_sample_format_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
278 279

/* Video */
280
typedef struct vout_thread_t vout_thread_t;
281

Gildas Bazin's avatar
 
Gildas Bazin committed
282
typedef video_format_t video_frame_format_t;
283 284
typedef struct picture_t picture_t;
typedef struct picture_sys_t picture_sys_t;
285

286
/* Subpictures */
287
typedef struct spu_t spu_t;
288 289
typedef struct subpicture_t subpicture_t;
typedef struct subpicture_sys_t subpicture_sys_t;
290
typedef struct subpicture_region_t subpicture_region_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
291

292 293
typedef struct image_handler_t image_handler_t;

294 295
/* Stream output */
typedef struct sout_instance_t sout_instance_t;
296 297
typedef struct sout_instance_sys_t sout_instance_sys_t;

298
typedef struct sout_input_t sout_input_t;
299
typedef struct sout_packetizer_input_t sout_packetizer_input_t;
300

301
typedef struct sout_access_out_t sout_access_out_t;
302 303
typedef struct sout_access_out_sys_t   sout_access_out_sys_t;

304
typedef struct sout_mux_t sout_mux_t;
305 306
typedef struct sout_mux_sys_t sout_mux_sys_t;

307
typedef struct sout_stream_t    sout_stream_t;
308 309
typedef struct sout_stream_sys_t sout_stream_sys_t;

310
typedef struct config_chain_t       config_chain_t;
311
typedef struct session_descriptor_t session_descriptor_t;
312

Sam Hocevar's avatar
 
Sam Hocevar committed
313
/* Decoders */
Laurent Aimar's avatar
Laurent Aimar committed
314 315 316
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
317

Gildas Bazin's avatar
 
Gildas Bazin committed
318 319 320 321
/* Encoders */
typedef struct encoder_t      encoder_t;
typedef struct encoder_sys_t  encoder_sys_t;

322 323 324 325
/* Filters */
typedef struct filter_t filter_t;
typedef struct filter_sys_t filter_sys_t;

326
/* Network */
327
typedef struct virtual_socket_t v_socket_t;
328
typedef struct vlc_url_t vlc_url_t;
329

330 331 332
/* Misc */
typedef struct iso639_lang_t iso639_lang_t;

333 334 335 336
/* block */
typedef struct block_t      block_t;
typedef struct block_fifo_t block_fifo_t;

337 338 339
/* Hashing */
typedef struct md5_s md5_t;

Gildas Bazin's avatar
Gildas Bazin committed
340 341 342 343 344 345
/* 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;

346 347 348
/* vod server */
typedef struct vod_t     vod_t;
typedef struct vod_sys_t vod_sys_t;
349
typedef struct vod_media_t vod_media_t;
350

351 352 353 354 355 356 357
/* osdmenu */
typedef struct osd_menu_t   osd_menu_t;
typedef struct osd_state_t  osd_state_t;
typedef struct osd_event_t  osd_event_t;
typedef struct osd_button_t osd_button_t;
typedef struct osd_menu_state_t osd_menu_state_t;

358
/* VLM */
359 360
typedef struct vlm_t         vlm_t;
typedef struct vlm_message_t vlm_message_t;
361

362
/* misc */
363
typedef struct vlc_meta_t    vlc_meta_t;
Clément Stenac's avatar
Clément Stenac committed
364
typedef struct input_stats_t input_stats_t;
365

366 367 368
/* Update */
typedef struct update_t update_t;
typedef struct update_iterator_t update_iterator_t;
369

370 371 372
/* Meta engine */
typedef struct meta_engine_t meta_engine_t;

373 374 375 376 377
/**
 * VLC value structure
 */
typedef union
{
378
    int64_t         i_int;
379
    bool            b_bool;
380 381 382 383 384 385
    float           f_float;
    char *          psz_string;
    void *          p_address;
    vlc_object_t *  p_object;
    vlc_list_t *    p_list;
    mtime_t         i_time;
386
    struct { int32_t x; int32_t y; } coords;
387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420

} 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)
 *****************************************************************************/
#define VLC_SUCCESS         -0                                   /* No error */
#define VLC_ENOMEM          -1                          /* Not enough memory */
#define VLC_ETIMEOUT        -3                                    /* Timeout */

#define VLC_ENOMOD         -10                           /* Module not found */

#define VLC_ENOOBJ         -20                           /* Object not found */

#define VLC_ENOVAR         -30                         /* Variable not found */
#define VLC_EBADVAR        -31                         /* Bad variable value */

#define VLC_ENOITEM        -40                           /**< Item not found */

#define VLC_EEXIT         -255                             /* Program exited */
#define VLC_EEXITSUCCESS  -999                /* Program exited successfully */
#define VLC_EGENERIC      -666                              /* Generic error */

421 422 423 424 425 426 427 428 429
/*****************************************************************************
 * 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 */

430 431 432
/*****************************************************************************
 * OS-specific headers and thread types
 *****************************************************************************/
433
#if defined( WIN32 ) || defined( UNDER_CE )
434
# include <windows.h>
435 436
#endif

437 438 439 440 441 442 443
#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
444
#include "vlc_mtime.h"
445 446
#include "vlc_threads.h"

447 448 449 450 451 452 453 454 455
/**
 * Memory storage space for an atom. Never access it directly.
 */
typedef union
{
    volatile uintptr_t u;
    volatile intptr_t  s;
} vlc_atomic_t;

456 457 458 459 460 461
/*****************************************************************************
 * Common structure members
 *****************************************************************************/

/* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
#define VLC_COMMON_MEMBERS                                                  \
462 463 464 465
/** \name VLC_COMMON_MEMBERS                                                \
 * these members are common for all vlc objects                             \
 */                                                                         \
/**@{*/                                                                     \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
466
    const char *psz_object_type;                                            \
467
                                                                            \
468 469
    /* Messages header */                                                   \
    char *psz_header;                                                       \
470
    int  i_flags;                                                           \
471
                                                                            \
Sam Hocevar's avatar
Sam Hocevar committed
472
    /* Object properties */                                                 \
473
    volatile bool b_die;                   /**< set by the outside */ \
474
    bool b_force;      /**< set by the outside (eg. module_need()) */ \
475
                                                                            \
Sam Hocevar's avatar
Sam Hocevar committed
476
    /* Stuff related to the libvlc structure */                             \
477
    libvlc_int_t *p_libvlc;                  /**< (root of all evil) - 1 */ \
478
                                                                            \
479
    vlc_object_t *  p_parent;                            /**< our parent */ \
480
                                                                            \
481
/**@}*/                                                                     \
482

483
/* VLC_OBJECT: attempt at doing a clever cast */
484
#if VLC_GCC_VERSION(4,0)
485 486
# ifndef __cplusplus
#  define VLC_OBJECT( x ) \
487 488 489 490
    __builtin_choose_expr( \
        __builtin_offsetof(__typeof__(*(x)), psz_object_type), \
        (void)0 /* screw you */, \
        (vlc_object_t *)(x))
491 492 493
# else
#  define VLC_OBJECT( x ) \
    ((vlc_object_t *)(x) \
494
      + 0 * __builtin_offsetof(__typeof__(*(x)), psz_object_type))
495
# endif
496 497 498
#else
# define VLC_OBJECT( x ) ((vlc_object_t *)(x))
#endif
499

500
typedef struct gc_object_t
501
{
502
    vlc_atomic_t    refs;
503 504
    void          (*pf_destructor) (struct gc_object_t *);
} gc_object_t;
505

506 507 508 509
/**
 * These members are common to all objects that wish to be garbage-collected.
 */
#define VLC_GC_MEMBERS gc_object_t vlc_gc_data;
510

511 512 513
VLC_API void * vlc_gc_init(gc_object_t *, void (*)(gc_object_t *));
VLC_API void * vlc_hold(gc_object_t *);
VLC_API void vlc_release(gc_object_t *);
514

515 516 517 518
#define vlc_gc_init( a,b ) vlc_gc_init( &(a)->vlc_gc_data, (b) )
#define vlc_gc_incref( a ) vlc_hold( &(a)->vlc_gc_data )
#define vlc_gc_decref( a ) vlc_release( &(a)->vlc_gc_data )
#define vlc_priv( gc, t ) ((t *)(((char *)(gc)) - offsetof(t, vlc_gc_data)))
519

Sam Hocevar's avatar
 
Sam Hocevar committed
520 521 522 523 524 525 526 527 528 529
/*****************************************************************************
 * 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
530 531 532
/* __MAX and __MIN: self explanatory */
#ifndef __MAX
#   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
Sam Hocevar's avatar
 
Sam Hocevar committed
533
#endif
Sam Hocevar's avatar
 
Sam Hocevar committed
534 535
#ifndef __MIN
#   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
Sam Hocevar's avatar
 
Sam Hocevar committed
536 537
#endif

538 539 540
/* clip v in [min, max] */
#define VLC_CLIP(v, min, max)    __MIN(__MAX((v), (min)), (max))

541
VLC_USED
542
static inline int64_t GCD ( int64_t a, int64_t b )
543
{
544 545 546 547 548 549 550
    while( b )
    {
        int64_t c = a % b;
        a = b;
        b = c;
    }
    return a;
551 552
}

553
/* function imported from libavutil/common.h */
554
VLC_USED
555 556 557 558 559 560
static inline uint8_t clip_uint8_vlc( int32_t a )
{
    if( a&(~255) ) return (-a)>>31;
    else           return a;
}

561
/** Count leading zeroes */
562
VLC_USED
563 564
static inline unsigned clz (unsigned x)
{
565
#if VLC_GCC_VERSION(3,4)
566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583
    return __builtin_clz (x);
#else
    unsigned i = sizeof (x) * 8;

    while (x)
    {
        x = x >> 1;
        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))

584
/** Bit weight */
585
VLC_USED
586 587
static inline unsigned popcount (unsigned x)
{
588
#if VLC_GCC_VERSION(3,4)
589 590 591 592 593 594 595 596 597 598 599 600
    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
601 602 603 604 605 606 607 608 609 610 611 612
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
}

613 614 615 616 617 618
#ifdef __OS2__
#   undef bswap16
#   undef bswap32
#   undef bswap64
#endif

619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645
/** 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)
{
#if VLC_GCC_VERSION(4,3)
    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)
{
#if VLC_GCC_VERSION(4,3)
    return __builtin_bswap64 (x);
646
#elif !defined (__cplusplus)
647 648 649 650 651 652 653 654
    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);
655 656 657 658 659 660 661 662 663
#else
    return ((x & 0x00000000000000FFLLU) << 56)
         | ((x & 0x000000000000FF00LLU) << 40)
         | ((x & 0x0000000000FF0000LLU) << 24)
         | ((x & 0x00000000FF000000LLU) <<  8)
         | ((x & 0x000000FF00000000LLU) >>  8)
         | ((x & 0x0000FF0000000000LLU) >> 24)
         | ((x & 0x00FF000000000000LLU) >> 40)
         | ((x & 0xFF00000000000000LLU) >> 56);
664 665 666 667
#endif
}


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

671 672
#define EMPTY_STR(str) (!str || !*str)

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

675
#include <vlc_arrays.h>
676

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

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

    memcpy (&x, p, sizeof (x));
    return ntoh16 (x);
701
}
702

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

    memcpy (&x, p, sizeof (x));
    return ntoh32 (x);
711
}
712

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

    memcpy (&x, p, sizeof (x));
    return ntoh64 (x);
721
}
722

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

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

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

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

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

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

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

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

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

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

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

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

814 815 816
/* */
#define VLC_UNUSED(x) (void)(x)

817
/* Stuff defined in src/extras/libc.c */
818

819
#if defined(WIN32) || defined(UNDER_CE)
Sam Hocevar's avatar
 
Sam Hocevar committed
820
/* win32, cl and icl support */
Sam Hocevar's avatar
 
Sam Hocevar committed
821
#   if defined( _MSC_VER ) || !defined( __MINGW32__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
822
#       define __attribute__(x)
Gildas Bazin's avatar
 
Gildas Bazin committed
823
#       define S_IFBLK         0x3000  /* Block */
Sam Hocevar's avatar
 
Sam Hocevar committed
824 825 826 827 828 829 830 831 832
#       define S_ISBLK(m)      (0)
#       define S_ISCHR(m)      (0)
#       define S_ISFIFO(m)     (((m)&_S_IFMT) == _S_IFIFO)
#       define S_ISREG(m)      (((m)&_S_IFMT) == _S_IFREG)
#   endif

/* several type definitions */
#   if defined( __MINGW32__ )
#       if !defined( _OFF_T_ )
833 834
            typedef long long _off_t;
            typedef _off_t off_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
835 836
#           define _OFF_T_
#       else
Gildas Bazin's avatar
 
Gildas Bazin committed
837 838 839
#           ifdef off_t
#               undef off_t
#           endif
Sam Hocevar's avatar
 
Sam Hocevar committed
840 841 842 843
#           define off_t long long
#       endif
#   endif

844
#   if defined( _MSC_VER )
Sam Hocevar's avatar
 
Sam Hocevar committed
845
#       if !defined( _OFF_T_DEFINED )
846
            typedef __int64 off_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
847 848
#           define _OFF_T_DEFINED
#       else
849
            /* for wx compatibility typedef long off_t; */
Sam Hocevar's avatar
 
Sam Hocevar committed
850 851 852 853
#           define off_t __int64
#       endif
#   endif

Olivier Teulière's avatar
 
Olivier Teulière committed
854
#   if defined( __BORLANDC__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
855
#       undef off_t
Olivier Teulière's avatar
 
Olivier Teulière committed
856
#       define off_t unsigned __int64
Sam Hocevar's avatar
 
Sam Hocevar committed
857 858
#   endif

Gildas Bazin's avatar
 
Gildas Bazin committed
859 860
#   ifndef O_NONBLOCK
#       define O_NONBLOCK 0
Gildas Bazin's avatar
 
Gildas Bazin committed
861 862 863 864
#   endif

#   ifndef alloca
#       define alloca _alloca
Sam Hocevar's avatar
 
Sam Hocevar committed
865 866
#   endif

867
#   include <tchar.h>
Sam Hocevar's avatar
 
Sam Hocevar committed
868 869
#endif

870
VLC_API bool vlc_ureduce( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t );
871

872
/* Aligned memory allocator */
873 874 875 876
#ifdef __APPLE__
#include <AvailabilityMacros.h>
#endif

877
#ifdef WIN32
878 879 880
# include <malloc.h>
# define vlc_memalign(align, size) (__mingw_aligned_malloc(size, align))
# define vlc_free(base)            (__mingw_aligned_free(base))
881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900
#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]);
}
901
#else
902 903 904 905 906 907 908 909
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)
910
#endif
Laurent Aimar's avatar
Laurent Aimar committed
911

912
VLC_API void vlc_tdestroy( void *, void (*)(void *) );
913

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
914
/* Fast large memory copy and memory set */
915
VLC_API void * vlc_memcpy( void *, const void *, size_t );
916
#define vlc_memset memset
Sam Hocevar's avatar
 
Sam Hocevar committed
917 918 919 920

/*****************************************************************************
 * I18n stuff
 *****************************************************************************/
921
VLC_API char * vlc_gettext( const char *msgid ) VLC_FORMAT_ARG(1);
922

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
923 924 925
#define vlc_pgettext( ctx, id ) \
        vlc_pgettext_aux( ctx "\004" id, id )

926
VLC_FORMAT_ARG(2)
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
927
static inline const char *vlc_pgettext_aux( const char *ctx, const char *id )
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
928
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
929
    const char *tr = vlc_gettext( ctx );
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
930 931 932
    return (tr == ctx) ? id : tr;
}

933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951
/*****************************************************************************
 * 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;
}

952 953 954 955 956 957 958 959
static inline void *xcalloc (size_t n, size_t size)
{
    void *ptr = calloc (n, size);
    if (unlikely (ptr == NULL))
        abort ();
    return ptr;
}

960 961 962
/*****************************************************************************
 * libvlc features
 *****************************************************************************/
963 964 965
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;
966

967
/*****************************************************************************
968
 * Additional vlc stuff
969
 *****************************************************************************/
970
#include "vlc_messages.h"
Sam Hocevar's avatar
Sam Hocevar committed
971
#include "vlc_objects.h"
972
#include "vlc_variables.h"
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
973
#include "vlc_main.h"
Clément Stenac's avatar
Clément Stenac committed
974
#include "vlc_configuration.h"
975

976
#if defined( WIN32 ) || defined( UNDER_CE ) || defined( __SYMBIAN32__ ) || defined( __OS2__ )
977
#   define DIR_SEP_CHAR '\\'
Antoine Cellerier's avatar
Antoine Cellerier committed
978
#   define DIR_SEP "\\"
979 980
#   define PATH_SEP_CHAR ';'
#   define PATH_SEP ";"
Antoine Cellerier's avatar
Antoine Cellerier committed
981
#else
982
#   define DIR_SEP_CHAR '/'
Antoine Cellerier's avatar
Antoine Cellerier committed
983
#   define DIR_SEP "/"
984 985
#   define PATH_SEP_CHAR ':'
#   define PATH_SEP ":"
Antoine Cellerier's avatar
Antoine Cellerier committed
986
#endif
987

988 989 990 991 992 993
#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")

994
#endif /* !VLC_COMMON_H */