vlc_common.h 29.1 KB
Newer Older
Sam Hocevar's avatar
 
Sam Hocevar committed
1 2 3 4
/*****************************************************************************
 * common.h: common definitions
 * Collection of useful common types and macros definitions
 *****************************************************************************
5
 * Copyright (C) 1998-2011 the VideoLAN team
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 15
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
16
 *
Sam Hocevar's avatar
 
Sam Hocevar committed
17 18 19 20 21 22 23
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
Antoine Cellerier's avatar
Antoine Cellerier committed
24
 * 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 79 80
/* 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"
#endif

81
/* Function attributes for compiler warnings */
82
#ifdef __GNUC__
83 84 85 86 87 88 89 90 91 92
# 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))
93
# define VLC_NORETURN __attribute__ ((noreturn))
94 95 96 97 98 99 100

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

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

110

111 112 113 114 115 116 117 118 119
/* 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

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

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

135
#define VLC_API VLC_EXTERN VLC_EXPORT
136 137


Sam Hocevar's avatar
 
Sam Hocevar committed
138 139 140
/*****************************************************************************
 * Basic types definitions
 *****************************************************************************/
141
#if defined( WIN32 ) || defined( UNDER_CE )
Gildas Bazin's avatar
 
Gildas Bazin committed
142
#   include <malloc.h>
143 144 145
#   ifndef PATH_MAX
#       define PATH_MAX MAX_PATH
#   endif
Gildas Bazin's avatar
 
Gildas Bazin committed
146 147
#endif

148 149 150 151
#ifdef __SYMBIAN32__
 #include <sys/syslimits.h>
#endif

Sam Hocevar's avatar
 
Sam Hocevar committed
152 153 154
/* Counter for statistics and profiling */
typedef unsigned long       count_t;

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

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

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

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

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

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

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

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

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

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


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

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

245 246
typedef struct config_category_t config_category_t;

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

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

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

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

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

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

293 294
typedef struct image_handler_t image_handler_t;

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

299
typedef struct sout_input_t sout_input_t;
300
typedef struct sout_packetizer_input_t sout_packetizer_input_t;
301

302
typedef struct sout_access_out_t sout_access_out_t;
303 304
typedef struct sout_access_out_sys_t   sout_access_out_sys_t;

305
typedef struct sout_mux_t sout_mux_t;
306 307
typedef struct sout_mux_sys_t sout_mux_sys_t;

308
typedef struct sout_stream_t    sout_stream_t;
309 310
typedef struct sout_stream_sys_t sout_stream_sys_t;

311
typedef struct config_chain_t       config_chain_t;
312
typedef struct session_descriptor_t session_descriptor_t;
313

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

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

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

327
/* Network */
328
typedef struct virtual_socket_t v_socket_t;
329
typedef struct vlc_acl_t vlc_acl_t;
330
typedef struct vlc_url_t vlc_url_t;
331

332 333 334
/* Misc */
typedef struct iso639_lang_t iso639_lang_t;

335 336 337 338
/* block */
typedef struct block_t      block_t;
typedef struct block_fifo_t block_fifo_t;

339 340 341 342 343 344 345
/* httpd */
typedef struct httpd_t          httpd_t;
typedef struct httpd_host_t     httpd_host_t;
typedef struct httpd_url_t      httpd_url_t;
typedef struct httpd_client_t   httpd_client_t;
typedef struct httpd_callback_sys_t httpd_callback_sys_t;
typedef struct httpd_message_t  httpd_message_t;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
346
typedef int    (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, const httpd_message_t *query );
347 348
typedef struct httpd_file_t     httpd_file_t;
typedef struct httpd_file_sys_t httpd_file_sys_t;
349 350 351
typedef int (*httpd_file_callback_t)( httpd_file_sys_t *, httpd_file_t *, uint8_t *psz_request, uint8_t **pp_data, int *pi_data );
typedef struct httpd_handler_t  httpd_handler_t;
typedef struct httpd_handler_sys_t httpd_handler_sys_t;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
352
typedef int (*httpd_handler_callback_t)( httpd_handler_sys_t *, httpd_handler_t *, char *psz_url, uint8_t *psz_request, int i_type, uint8_t *p_in, int i_in, char *psz_remote_addr, char *psz_remote_host, uint8_t **pp_data, int *pi_data );
353 354 355
typedef struct httpd_redirect_t httpd_redirect_t;
typedef struct httpd_stream_t httpd_stream_t;

356 357 358
/* Hashing */
typedef struct md5_s md5_t;

Gildas Bazin's avatar
Gildas Bazin committed
359 360 361 362 363 364
/* 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;

365 366 367
/* vod server */
typedef struct vod_t     vod_t;
typedef struct vod_sys_t vod_sys_t;
368
typedef struct vod_media_t vod_media_t;
369

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

377
/* VLM */
378 379
typedef struct vlm_t         vlm_t;
typedef struct vlm_message_t vlm_message_t;
380

381
/* misc */
382
typedef struct vlc_meta_t    vlc_meta_t;
383

384
/* Stats */
385 386 387
typedef struct counter_t     counter_t;
typedef struct counter_sample_t counter_sample_t;
typedef struct stats_handler_t stats_handler_t;
Clément Stenac's avatar
Clément Stenac committed
388
typedef struct input_stats_t input_stats_t;
389

390 391 392
/* Update */
typedef struct update_t update_t;
typedef struct update_iterator_t update_iterator_t;
393

394 395 396
/* Meta engine */
typedef struct meta_engine_t meta_engine_t;

397 398
/* stat/lstat/fstat */
#ifdef WIN32
399
# include <sys/stat.h>
400

401
# ifndef UNDER_CE
402
struct _stati64;
403 404
#  define stat _stati64
#  define fstat _fstati64
405 406
#endif

407
/* You should otherwise use vlc_stat and vlc_lstat. */
408 409 410 411
#else
struct stat;
#endif

412 413 414 415 416
/**
 * VLC value structure
 */
typedef union
{
417
    int64_t         i_int;
418
    bool            b_bool;
419 420 421 422 423 424
    float           f_float;
    char *          psz_string;
    void *          p_address;
    vlc_object_t *  p_object;
    vlc_list_t *    p_list;
    mtime_t         i_time;
425
    struct { int32_t x; int32_t y; } coords;
426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459

} 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 */

460 461 462 463 464 465 466 467 468
/*****************************************************************************
 * 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 */

469 470 471
/*****************************************************************************
 * OS-specific headers and thread types
 *****************************************************************************/
472
#if defined( WIN32 ) || defined( UNDER_CE )
473 474 475 476
/* WIN32_LEAN_AND_MEAN is needed to be able to include winsock2.h because else,
 * windows.h will also include winsock.h and declarations will conflict */
# define WIN32_LEAN_AND_MEAN
# include <windows.h>
477 478
#endif

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
479
#include "vlc_mtime.h"
480 481
#include "vlc_threads.h"

482 483 484 485 486 487 488 489 490
/**
 * Memory storage space for an atom. Never access it directly.
 */
typedef union
{
    volatile uintptr_t u;
    volatile intptr_t  s;
} vlc_atomic_t;

491 492 493 494 495 496
/*****************************************************************************
 * Common structure members
 *****************************************************************************/

/* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
#define VLC_COMMON_MEMBERS                                                  \
497 498 499 500
/** \name VLC_COMMON_MEMBERS                                                \
 * these members are common for all vlc objects                             \
 */                                                                         \
/**@{*/                                                                     \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
501
    const char *psz_object_type;                                            \
502
                                                                            \
503 504
    /* Messages header */                                                   \
    char *psz_header;                                                       \
505
    int  i_flags;                                                           \
506
                                                                            \
Sam Hocevar's avatar
Sam Hocevar committed
507
    /* Object properties */                                                 \
508
    volatile bool b_die;                   /**< set by the outside */ \
509
    bool b_force;      /**< set by the outside (eg. module_need()) */ \
510
                                                                            \
Sam Hocevar's avatar
Sam Hocevar committed
511
    /* Stuff related to the libvlc structure */                             \
512
    libvlc_int_t *p_libvlc;                  /**< (root of all evil) - 1 */ \
513
                                                                            \
514
    vlc_object_t *  p_parent;                            /**< our parent */ \
515
                                                                            \
516
/**@}*/                                                                     \
517

518
/* VLC_OBJECT: attempt at doing a clever cast */
519
#if VLC_GCC_VERSION(4,0)
520 521
# ifndef __cplusplus
#  define VLC_OBJECT( x ) \
522 523 524 525
    __builtin_choose_expr( \
        __builtin_offsetof(__typeof__(*(x)), psz_object_type), \
        (void)0 /* screw you */, \
        (vlc_object_t *)(x))
526 527 528
# else
#  define VLC_OBJECT( x ) \
    ((vlc_object_t *)(x) \
529
      + 0 * __builtin_offsetof(__typeof__(*(x)), psz_object_type))
530
# endif
531 532 533
#else
# define VLC_OBJECT( x ) ((vlc_object_t *)(x))
#endif
534

535
typedef struct gc_object_t
536
{
537
    vlc_atomic_t    refs;
538 539
    void          (*pf_destructor) (struct gc_object_t *);
} gc_object_t;
540

541 542 543 544
/**
 * These members are common to all objects that wish to be garbage-collected.
 */
#define VLC_GC_MEMBERS gc_object_t vlc_gc_data;
545

546 547 548
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 *);
549

550 551 552 553
#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)))
554

Sam Hocevar's avatar
 
Sam Hocevar committed
555 556 557 558 559 560 561 562 563 564
/*****************************************************************************
 * 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
565 566 567
/* __MAX and __MIN: self explanatory */
#ifndef __MAX
#   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
Sam Hocevar's avatar
 
Sam Hocevar committed
568
#endif
Sam Hocevar's avatar
 
Sam Hocevar committed
569 570
#ifndef __MIN
#   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
Sam Hocevar's avatar
 
Sam Hocevar committed
571 572
#endif

573
VLC_USED
574
static inline int64_t GCD ( int64_t a, int64_t b )
575
{
576 577 578 579 580 581 582
    while( b )
    {
        int64_t c = a % b;
        a = b;
        b = c;
    }
    return a;
583 584
}

585
/* function imported from libavutil/common.h */
586
VLC_USED
587 588 589 590 591 592
static inline uint8_t clip_uint8_vlc( int32_t a )
{
    if( a&(~255) ) return (-a)>>31;
    else           return a;
}

593
/** Count leading zeroes */
594
VLC_USED
595 596
static inline unsigned clz (unsigned x)
{
597
#if VLC_GCC_VERSION(3,4)
598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615
    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))

616
/** Bit weight */
617
VLC_USED
618 619
static inline unsigned popcount (unsigned x)
{
620
#if VLC_GCC_VERSION(3,4)
621 622 623 624 625 626 627 628 629 630 631 632
    return __builtin_popcount (x);
#else
    unsigned count = 0;
    while (x)
    {
        count += x & 1;
        x = x >> 1;
    }
    return count;
#endif
}

633 634 635 636 637 638
#ifdef __OS2__
#   undef bswap16
#   undef bswap32
#   undef bswap64
#endif

639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665
/** 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);
666
#elif !defined (__cplusplus)
667 668 669 670 671 672 673 674
    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);
675 676 677 678 679 680 681 682 683
#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);
684 685 686 687
#endif
}


688
/* Free and set set the variable to NULL */
689
#define FREENULL(a) do { free( a ); a = NULL; } while(0)
690

691 692
#define EMPTY_STR(str) (!str || !*str)

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

695
#include <vlc_arrays.h>
696

Sam Hocevar's avatar
 
Sam Hocevar committed
697
/* MSB (big endian)/LSB (little endian) conversions - network order is always
698
 * MSB, and should be used for both network communications and files. */
699 700 701 702

#ifdef WORDS_BIGENDIAN
# define hton16(i) ((uint16_t)(i))
# define hton32(i) ((uint32_t)(i))
703
# define hton64(i) ((uint64_t)(i))
704 705 706 707 708 709 710 711 712 713
#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 */
714
VLC_USED
715
static inline uint16_t U16_AT (const void *p)
716
{
717 718 719 720
    uint16_t x;

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

723
/** Reads 32 bits in network byte order */
724
VLC_USED
725
static inline uint32_t U32_AT (const void *p)
726
{
727 728 729 730
    uint32_t x;

    memcpy (&x, p, sizeof (x));
    return ntoh32 (x);
731
}
732

733
/** Reads 64 bits in network byte order */
734
VLC_USED
735
static inline uint64_t U64_AT (const void *p)
736
{
737 738 739 740
    uint64_t x;

    memcpy (&x, p, sizeof (x));
    return ntoh64 (x);
741
}
742

743 744 745 746 747
#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 */
748
VLC_USED
749
static inline uint16_t GetWLE (const void *p)
750
{
751 752 753 754 755 756 757
    uint16_t x;

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

760
/** Reads 32 bits in little-endian order */
761
VLC_USED
762
static inline uint32_t GetDWLE (const void *p)
763
{
764 765 766 767 768 769 770
    uint32_t x;

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

773
/** Reads 64 bits in little-endian order */
774
VLC_USED
775
static inline uint64_t GetQWLE (const void *p)
776
{
777
    uint64_t x;
778

779 780 781 782 783
    memcpy (&x, p, sizeof (x));
#ifdef WORDS_BIGENDIAN
    x = bswap64 (x);
#endif
    return x;
Gildas Bazin's avatar
 
Gildas Bazin committed
784 785
}

786
/** Writes 16 bits in network byte order */
787
static inline void SetWBE (void *p, uint16_t w)
Gildas Bazin's avatar
 
Gildas Bazin committed
788
{
789 790
    w = hton16 (w);
    memcpy (p, &w, sizeof (w));
Gildas Bazin's avatar
 
Gildas Bazin committed
791
}
792 793

/** Writes 32 bits in network byte order */
794
static inline void SetDWBE (void *p, uint32_t dw)
Gildas Bazin's avatar
 
Gildas Bazin committed
795
{
796 797
    dw = hton32 (dw);
    memcpy (p, &dw, sizeof (dw));
Gildas Bazin's avatar
 
Gildas Bazin committed
798
}
799 800

/** Writes 64 bits in network byte order */
801
static inline void SetQWBE (void *p, uint64_t qw)
802
{
803 804
    qw = hton64 (qw);
    memcpy (p, &qw, sizeof (qw));
805 806
}

807
/** Writes 16 bits in little endian order */
808
static inline void SetWLE (void *p, uint16_t w)
809
{
810 811 812 813
#ifdef WORDS_BIGENDIAN
    w = bswap16 (w);
#endif
    memcpy (p, &w, sizeof (w));
814
}
815 816

/** Writes 32 bits in little endian order */
817
static inline void SetDWLE (void *p, uint32_t dw)
818
{
819 820 821 822
#ifdef WORDS_BIGENDIAN
    dw = bswap32 (dw);
#endif
    memcpy (p, &dw, sizeof (dw));
823
}
824

825
/** Writes 64 bits in little endian order */
826
static inline void SetQWLE (void *p, uint64_t qw)
827
{
828
#ifdef WORDS_BIGENDIAN
829
    qw = bswap64 (qw);
830 831
#endif
    memcpy (p, &qw, sizeof (qw));
832
}
Sam Hocevar's avatar
 
Sam Hocevar committed
833

834 835 836
/* */
#define VLC_UNUSED(x) (void)(x)

837
/* Stuff defined in src/extras/libc.c */
838

839
#if defined(WIN32) || defined(UNDER_CE)
Sam Hocevar's avatar
 
Sam Hocevar committed
840
/* win32, cl and icl support */
Sam Hocevar's avatar
 
Sam Hocevar committed
841
#   if defined( _MSC_VER ) || !defined( __MINGW32__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
842
#       define __attribute__(x)
Gildas Bazin's avatar
 
Gildas Bazin committed
843
#       define S_IFBLK         0x3000  /* Block */
Sam Hocevar's avatar
 
Sam Hocevar committed
844 845 846 847 848 849 850 851 852
#       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_ )
853 854
            typedef long long _off_t;
            typedef _off_t off_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
855 856
#           define _OFF_T_
#       else
Gildas Bazin's avatar
 
Gildas Bazin committed
857 858 859
#           ifdef off_t
#               undef off_t
#           endif
Sam Hocevar's avatar
 
Sam Hocevar committed
860 861 862 863
#           define off_t long long
#       endif
#   endif

864
#   if defined( _MSC_VER )
Sam Hocevar's avatar
 
Sam Hocevar committed
865
#       if !defined( _OFF_T_DEFINED )
866
            typedef __int64 off_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
867 868
#           define _OFF_T_DEFINED
#       else
869
            /* for wx compatibility typedef long off_t; */
Sam Hocevar's avatar
 
Sam Hocevar committed
870 871 872 873
#           define off_t __int64
#       endif
#   endif

Olivier Teulière's avatar
 
Olivier Teulière committed
874
#   if defined( __BORLANDC__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
875
#       undef off_t
Olivier Teulière's avatar
 
Olivier Teulière committed
876
#       define off_t unsigned __int64
Sam Hocevar's avatar
 
Sam Hocevar committed
877 878
#   endif

Gildas Bazin's avatar
 
Gildas Bazin committed
879 880
#   ifndef O_NONBLOCK
#       define O_NONBLOCK 0
Gildas Bazin's avatar
 
Gildas Bazin committed
881 882 883 884
#   endif

#   ifndef alloca
#       define alloca _alloca
Sam Hocevar's avatar
 
Sam Hocevar committed
885 886
#   endif

887
#   include <tchar.h>
Sam Hocevar's avatar
 
Sam Hocevar committed
888 889
#endif

890
VLC_API bool vlc_ureduce( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t );
891

892
/* Aligned memory allocator */
893 894 895 896
#ifdef __APPLE__
#include <AvailabilityMacros.h>
#endif

897
#ifdef WIN32
898 899 900
# include <malloc.h>
# define vlc_memalign(align, size) (__mingw_aligned_malloc(size, align))
# define vlc_free(base)            (__mingw_aligned_free(base))
901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920
#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]);
}
921 922 923
#elif defined(__ANDROID__)
# define vlc_memalign(align, size) memalign(align, size)
# define vlc_free(base) free(base)
924
#else
925 926 927 928 929 930 931 932
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)
933
#endif
Laurent Aimar's avatar
Laurent Aimar committed
934

935
VLC_API void vlc_tdestroy( void *, void (*)(void *) );
936

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
937
/* Fast large memory copy and memory set */
938
VLC_API void * vlc_memcpy( void *, const void *, size_t );
939
#define vlc_memset memset
Sam Hocevar's avatar
 
Sam Hocevar committed
940 941 942 943

/*****************************************************************************
 * I18n stuff
 *****************************************************************************/
944
VLC_API char * vlc_gettext( const char *msgid ) VLC_FORMAT_ARG(1);
945

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
946 947 948
#define vlc_pgettext( ctx, id ) \
        vlc_pgettext_aux( ctx "\004" id, id )

949
VLC_FORMAT_ARG(2)
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
950
static inline const char *vlc_pgettext_aux( const char *ctx, const char *id )
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
951
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
952
    const char *tr = vlc_gettext( ctx );
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
953 954 955
    return (tr == ctx) ? id : tr;
}

956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974
/*****************************************************************************
 * 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;
}

975 976 977 978 979 980 981 982
static inline void *xcalloc (size_t n, size_t size)
{
    void *ptr = calloc (n, size);
    if (unlikely (ptr == NULL))
        abort ();
    return ptr;
}

983 984 985
/*****************************************************************************
 * libvlc features
 *****************************************************************************/
986 987 988
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;
989

990
/*****************************************************************************
991
 * Additional vlc stuff
992
 *****************************************************************************/
993
#include "vlc_messages.h"
Sam Hocevar's avatar
Sam Hocevar committed
994
#include "vlc_objects.h"
995
#include "vlc_variables.h"
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
996
#include "vlc_main.h"
Clément Stenac's avatar
Clément Stenac committed
997
#include "vlc_configuration.h"
998

999
#if defined( WIN32 ) || defined( UNDER_CE ) || defined( __SYMBIAN32__ ) || defined( __OS2__ )
1000
#   define DIR_SEP_CHAR '\\'
Antoine Cellerier's avatar
Antoine Cellerier committed
1001
#   define DIR_SEP "\\"
1002 1003
#   define PATH_SEP_CHAR ';'
#   define PATH_SEP ";"
Antoine Cellerier's avatar
Antoine Cellerier committed
1004
#else
1005
#   define DIR_SEP_CHAR '/'
Antoine Cellerier's avatar
Antoine Cellerier committed
1006
#   define DIR_SEP "/"
1007 1008
#   define PATH_SEP_CHAR ':'
#   define PATH_SEP ":"
Antoine Cellerier's avatar
Antoine Cellerier committed
1009
#endif
1010

1011 1012 1013 1014 1015 1016
#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")

1017
#endif /* !VLC_COMMON_H */