vlc_common.h 27.7 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 67 68 69 70 71 72 73 74
/* 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"
 #define snprintf        __mingw_snprintf
 #define vsnprintf       __mingw_vsnprintf
#endif

75 76
/* Format string sanity checks */
#ifdef __GNUC__
77
#   if defined( _WIN32 ) && (__GNUC__ > 4 || ( __GNUC__ == 4 && __GNUC_MINOR__ >= 4 ) )
78
#     define VLC_FORMAT(x,y) __attribute__ ((format(gnu_printf,x,y)))
79
#   else
80
#     define VLC_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
81
#   endif
82
#   define VLC_FORMAT_ARG(x) __attribute__ ((format_arg(x)))
83
#   if __GNUC__ > 3 || (__GNUC__ == 3 && (__GNUC_MINOR__ >= 4))
84
#     define VLC_USED __attribute__ ((warn_unused_result))
85
#   else
86
#     define VLC_USED
87
#   endif
88
#   define VLC_MALLOC __attribute__ ((malloc))
89
#else
90 91 92 93
#   define VLC_FORMAT(x,y)
#   define VLC_FORMAT_ARG(x)
#   define VLC_USED
#   define VLC_MALLOC
94 95
#endif

96 97 98 99 100 101 102 103 104
/* 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

105
#if defined(__GNUC__) && !defined __cplusplus
106
# define VLC_DEPRECATED __attribute__((deprecated))
107
#else
108
# define VLC_DEPRECATED
109 110
#endif

111 112
/* Linkage */
#ifdef __cplusplus
113
# define VLC_EXTERN extern "C"
114
#else
115
# define VLC_EXTERN
116 117
#endif

118
#if defined (WIN32) && defined (DLL_EXPORT)
119
# define VLC_EXPORT __declspec(dllexport)
120
#elif defined (__GNUC__) && (__GNUC__ >= 4)
121
# define VLC_EXPORT __attribute__((visibility("default")))
122
#else
123
# define VLC_EXPORT
124 125
#endif

126
#define VLC_API VLC_EXTERN VLC_EXPORT
127 128


Sam Hocevar's avatar
 
Sam Hocevar committed
129 130 131
/*****************************************************************************
 * Basic types definitions
 *****************************************************************************/
132
#if defined( WIN32 ) || defined( UNDER_CE )
Gildas Bazin's avatar
 
Gildas Bazin committed
133
#   include <malloc.h>
134 135 136
#   ifndef PATH_MAX
#       define PATH_MAX MAX_PATH
#   endif
Gildas Bazin's avatar
 
Gildas Bazin committed
137 138
#endif

139 140 141 142
#ifdef __SYMBIAN32__
 #include <sys/syslimits.h>
#endif

Sam Hocevar's avatar
 
Sam Hocevar committed
143 144 145
/* Counter for statistics and profiling */
typedef unsigned long       count_t;

146
/* Audio volume */
147 148
typedef uint16_t            audio_volume_t;

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

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

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

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

#define vlc_fourcc_to_char( a, b ) \
197
        vlc_fourcc_to_char( (vlc_fourcc_t)(a), (char *)(b) )
198

Sam Hocevar's avatar
 
Sam Hocevar committed
199 200 201 202
/*****************************************************************************
 * Classes declaration
 *****************************************************************************/

203
/* Internal types */
204 205
typedef struct vlc_list_t vlc_list_t;
typedef struct vlc_object_t vlc_object_t;
206
typedef struct libvlc_int_t libvlc_int_t;
207
typedef struct date_t date_t;
208

Gildas Bazin's avatar
 
Gildas Bazin committed
209
/* Playlist */
Derk-Jan Hartman's avatar
Derk-Jan Hartman committed
210 211 212 213 214 215

/* FIXME */
/**
 * Playlist commands
 */
typedef enum {
216
    PLAYLIST_PLAY,      /**< No arg.                            res=can fail*/
217 218
    PLAYLIST_VIEWPLAY,  /**< arg1= playlist_item_t*,*/
                        /**  arg2 = playlist_item_t*          , res=can fail */
219 220 221
    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
222 223 224
} playlist_command_t;


225 226
typedef struct playlist_t playlist_t;
typedef struct playlist_item_t playlist_item_t;
227
typedef struct playlist_view_t playlist_view_t;
228 229
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
230
typedef struct playlist_add_t playlist_add_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
231

232
/* Modules */
233 234
typedef struct module_t module_t;
typedef struct module_config_t module_config_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
235

236 237
typedef struct config_category_t config_category_t;

Sam Hocevar's avatar
 
Sam Hocevar committed
238
/* Input */
239
typedef struct input_thread_t input_thread_t;
240
typedef struct input_item_t input_item_t;
241
typedef struct input_item_node_t input_item_node_t;
242
typedef struct access_t access_t;
243
typedef struct access_sys_t access_sys_t;
244 245 246
typedef struct stream_t     stream_t;
typedef struct stream_sys_t stream_sys_t;
typedef struct demux_t  demux_t;
247
typedef struct demux_sys_t demux_sys_t;
248 249 250
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
251
typedef struct seekpoint_t seekpoint_t;
252 253
typedef struct info_t info_t;
typedef struct info_category_t info_category_t;
254
typedef struct input_attachment_t input_attachment_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
255

256 257 258 259
/* 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
260 261
typedef struct es_format_t es_format_t;
typedef struct video_palette_t video_palette_t;
262

Sam Hocevar's avatar
 
Sam Hocevar committed
263
/* Audio */
264 265
typedef struct aout_instance_t aout_instance_t;
typedef struct aout_sys_t aout_sys_t;
266
typedef struct aout_fifo_t aout_fifo_t;
267
typedef struct aout_input_t aout_input_t;
268
typedef struct block_t aout_buffer_t;
Gildas Bazin's avatar
 
Gildas Bazin committed
269
typedef audio_format_t audio_sample_format_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
270 271

/* Video */
272
typedef struct vout_thread_t vout_thread_t;
273

Gildas Bazin's avatar
 
Gildas Bazin committed
274
typedef video_format_t video_frame_format_t;
275 276
typedef struct picture_t picture_t;
typedef struct picture_sys_t picture_sys_t;
277

278
/* Subpictures */
279
typedef struct spu_t spu_t;
280 281
typedef struct subpicture_t subpicture_t;
typedef struct subpicture_sys_t subpicture_sys_t;
282
typedef struct subpicture_region_t subpicture_region_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
283

284 285
typedef struct image_handler_t image_handler_t;

286 287
/* Stream output */
typedef struct sout_instance_t sout_instance_t;
288 289
typedef struct sout_instance_sys_t sout_instance_sys_t;

290
typedef struct sout_input_t sout_input_t;
291
typedef struct sout_packetizer_input_t sout_packetizer_input_t;
292

293
typedef struct sout_access_out_t sout_access_out_t;
294 295
typedef struct sout_access_out_sys_t   sout_access_out_sys_t;

296
typedef struct sout_mux_t sout_mux_t;
297 298
typedef struct sout_mux_sys_t sout_mux_sys_t;

299
typedef struct sout_stream_t    sout_stream_t;
300 301
typedef struct sout_stream_sys_t sout_stream_sys_t;

302
typedef struct config_chain_t       config_chain_t;
303
typedef struct session_descriptor_t session_descriptor_t;
304

Sam Hocevar's avatar
 
Sam Hocevar committed
305
/* Decoders */
Laurent Aimar's avatar
Laurent Aimar committed
306 307 308
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
309

Gildas Bazin's avatar
 
Gildas Bazin committed
310 311 312 313
/* Encoders */
typedef struct encoder_t      encoder_t;
typedef struct encoder_sys_t  encoder_sys_t;

314 315 316 317
/* Filters */
typedef struct filter_t filter_t;
typedef struct filter_sys_t filter_sys_t;

318
/* Network */
319
typedef struct virtual_socket_t v_socket_t;
320
typedef struct vlc_acl_t vlc_acl_t;
321
typedef struct vlc_url_t vlc_url_t;
322

323 324 325
/* Misc */
typedef struct iso639_lang_t iso639_lang_t;

326 327 328 329
/* block */
typedef struct block_t      block_t;
typedef struct block_fifo_t block_fifo_t;

330 331 332 333 334 335 336
/* 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
337
typedef int    (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, const httpd_message_t *query );
338 339
typedef struct httpd_file_t     httpd_file_t;
typedef struct httpd_file_sys_t httpd_file_sys_t;
340 341 342
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
343
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 );
344 345 346
typedef struct httpd_redirect_t httpd_redirect_t;
typedef struct httpd_stream_t httpd_stream_t;

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
347 348 349 350
/* TLS support */
typedef struct tls_server_t tls_server_t;
typedef struct tls_session_t tls_session_t;

351 352 353
/* Hashing */
typedef struct md5_s md5_t;

Gildas Bazin's avatar
Gildas Bazin committed
354 355 356 357 358 359
/* 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;

360 361 362
/* vod server */
typedef struct vod_t     vod_t;
typedef struct vod_sys_t vod_sys_t;
363
typedef struct vod_media_t vod_media_t;
364

365 366 367 368 369 370 371
/* 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;

372
/* VLM */
373 374
typedef struct vlm_t         vlm_t;
typedef struct vlm_message_t vlm_message_t;
375

376
/* misc */
377
typedef struct vlc_meta_t    vlc_meta_t;
378

379
/* Stats */
380 381 382
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
383
typedef struct input_stats_t input_stats_t;
384

385 386 387
/* Update */
typedef struct update_t update_t;
typedef struct update_iterator_t update_iterator_t;
388

389 390 391
/* Meta engine */
typedef struct meta_engine_t meta_engine_t;

392 393
/* stat/lstat/fstat */
#ifdef WIN32
394
#include <sys/stat.h>
395

396
# ifndef UNDER_CE
397
struct _stati64;
398 399
#define stat _stati64
#define fstat _fstati64
400 401
#endif

402
/* You should otherwise use vlc_stat and vlc_lstat. */
403 404 405 406
#else
struct stat;
#endif

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

} vlc_value_t;

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

};

/**
 * \defgroup var_type Variable types
 * These are the different types a vlc variable can have.
 * @{
 */
#define VLC_VAR_VOID      0x0010
#define VLC_VAR_BOOL      0x0020
#define VLC_VAR_INTEGER   0x0030
#define VLC_VAR_HOTKEY    0x0031
#define VLC_VAR_STRING    0x0040
#define VLC_VAR_VARIABLE  0x0044
#define VLC_VAR_FLOAT     0x0050
#define VLC_VAR_TIME      0x0060
#define VLC_VAR_ADDRESS   0x0070
#define VLC_VAR_MUTEX     0x0080
450
#define VLC_VAR_COORDS    0x00A0
451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472
/**@}*/

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

473 474 475 476 477 478 479 480 481
/*****************************************************************************
 * 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 */

482 483 484
/*****************************************************************************
 * OS-specific headers and thread types
 *****************************************************************************/
485
#if defined( WIN32 ) || defined( UNDER_CE )
486 487 488 489
#   define WIN32_LEAN_AND_MEAN
#   include <windows.h>
#endif

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
490
#include "vlc_mtime.h"
491 492
#include "vlc_threads.h"

493 494 495 496 497 498 499 500 501
/**
 * Memory storage space for an atom. Never access it directly.
 */
typedef union
{
    volatile uintptr_t u;
    volatile intptr_t  s;
} vlc_atomic_t;

502 503 504 505 506 507
/*****************************************************************************
 * Common structure members
 *****************************************************************************/

/* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
#define VLC_COMMON_MEMBERS                                                  \
508 509 510 511
/** \name VLC_COMMON_MEMBERS                                                \
 * these members are common for all vlc objects                             \
 */                                                                         \
/**@{*/                                                                     \
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
512
    const char *psz_object_type;                                            \
513
                                                                            \
514 515
    /* Messages header */                                                   \
    char *psz_header;                                                       \
516
    int  i_flags;                                                           \
517
                                                                            \
Sam Hocevar's avatar
Sam Hocevar committed
518
    /* Object properties */                                                 \
519
    volatile bool b_die;                   /**< set by the outside */ \
520
    bool b_force;      /**< set by the outside (eg. module_need()) */ \
521
                                                                            \
Sam Hocevar's avatar
Sam Hocevar committed
522
    /* Stuff related to the libvlc structure */                             \
523
    libvlc_int_t *p_libvlc;                  /**< (root of all evil) - 1 */ \
524
                                                                            \
525
    vlc_object_t *  p_parent;                            /**< our parent */ \
526
                                                                            \
527
/**@}*/                                                                     \
528

529
/* VLC_OBJECT: attempt at doing a clever cast */
530
#if defined( __GNUC__ ) && __GNUC__ > 3
531 532
# ifndef __cplusplus
#  define VLC_OBJECT( x ) \
533 534 535 536
    __builtin_choose_expr( \
        __builtin_offsetof(__typeof__(*(x)), psz_object_type), \
        (void)0 /* screw you */, \
        (vlc_object_t *)(x))
537 538 539
# else
#  define VLC_OBJECT( x ) \
    ((vlc_object_t *)(x) \
540
      + 0 * __builtin_offsetof(__typeof__(*(x)), psz_object_type))
541
# endif
542 543 544
#else
# define VLC_OBJECT( x ) ((vlc_object_t *)(x))
#endif
545

546
typedef struct gc_object_t
547
{
548
    vlc_atomic_t    refs;
549 550
    void          (*pf_destructor) (struct gc_object_t *);
} gc_object_t;
551

552 553 554 555
/**
 * These members are common to all objects that wish to be garbage-collected.
 */
#define VLC_GC_MEMBERS gc_object_t vlc_gc_data;
556

557 558 559
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 *);
560

561 562 563 564
#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)))
565

Sam Hocevar's avatar
 
Sam Hocevar committed
566 567 568 569 570 571 572 573 574 575
/*****************************************************************************
 * 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
576 577 578
/* __MAX and __MIN: self explanatory */
#ifndef __MAX
#   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
Sam Hocevar's avatar
 
Sam Hocevar committed
579
#endif
Sam Hocevar's avatar
 
Sam Hocevar committed
580 581
#ifndef __MIN
#   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
Sam Hocevar's avatar
 
Sam Hocevar committed
582 583
#endif

584
VLC_USED
585
static inline int64_t GCD ( int64_t a, int64_t b )
586
{
587 588 589 590 591 592 593
    while( b )
    {
        int64_t c = a % b;
        a = b;
        b = c;
    }
    return a;
594 595
}

596
/* function imported from libavutil/common.h */
597
VLC_USED
598 599 600 601 602 603
static inline uint8_t clip_uint8_vlc( int32_t a )
{
    if( a&(~255) ) return (-a)>>31;
    else           return a;
}

604
/* Count leading zeroes */
605
VLC_USED
606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626
static inline unsigned clz (unsigned x)
{
#ifdef __GNUC_
    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))

627
/* Bit weight */
628
VLC_USED
629 630 631 632 633 634 635 636 637 638 639 640 641 642 643
static inline unsigned popcount (unsigned x)
{
#ifdef __GNUC_
    return __builtin_popcount (x);
#else
    unsigned count = 0;
    while (x)
    {
        count += x & 1;
        x = x >> 1;
    }
    return count;
#endif
}

644
/* Free and set set the variable to NULL */
645
#define FREENULL(a) do { free( a ); a = NULL; } while(0)
646

647 648
#define EMPTY_STR(str) (!str || !*str)

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

651
#include <vlc_arrays.h>
652

Sam Hocevar's avatar
 
Sam Hocevar committed
653
/* MSB (big endian)/LSB (little endian) conversions - network order is always
654
 * MSB, and should be used for both network communications and files. */
655
VLC_USED
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
656
static inline uint16_t U16_AT( const void * _p )
657
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
658
    const uint8_t * p = (const uint8_t *)_p;
659
    return ( ((uint16_t)p[0] << 8) | p[1] );
660
}
661

662
VLC_USED
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
663
static inline uint32_t U32_AT( const void * _p )
664
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
665
    const uint8_t * p = (const uint8_t *)_p;
666 667
    return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
              | ((uint32_t)p[2] << 8) | p[3] );
668
}
669

670
VLC_USED
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
671
static inline uint64_t U64_AT( const void * _p )
672
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
673
    const uint8_t * p = (const uint8_t *)_p;
674 675 676 677
    return ( ((uint64_t)p[0] << 56) | ((uint64_t)p[1] << 48)
              | ((uint64_t)p[2] << 40) | ((uint64_t)p[3] << 32)
              | ((uint64_t)p[4] << 24) | ((uint64_t)p[5] << 16)
              | ((uint64_t)p[6] << 8) | p[7] );
678
}
679

680
VLC_USED
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
681
static inline uint16_t GetWLE( const void * _p )
682
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
683
    const uint8_t * p = (const uint8_t *)_p;
684 685
    return ( ((uint16_t)p[1] << 8) | p[0] );
}
686

687
VLC_USED
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
688
static inline uint32_t GetDWLE( const void * _p )
689
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
690
    const uint8_t * p = (const uint8_t *)_p;
691 692 693
    return ( ((uint32_t)p[3] << 24) | ((uint32_t)p[2] << 16)
              | ((uint32_t)p[1] << 8) | p[0] );
}
694

695
VLC_USED
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
696
static inline uint64_t GetQWLE( const void * _p )
697
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
698
    const uint8_t * p = (const uint8_t *)_p;
699 700 701 702 703 704 705 706 707 708
    return ( ((uint64_t)p[7] << 56) | ((uint64_t)p[6] << 48)
              | ((uint64_t)p[5] << 40) | ((uint64_t)p[4] << 32)
              | ((uint64_t)p[3] << 24) | ((uint64_t)p[2] << 16)
              | ((uint64_t)p[1] << 8) | p[0] );
}

#define GetWBE( p )     U16_AT( p )
#define GetDWBE( p )    U32_AT( p )
#define GetQWBE( p )    U64_AT( p )

Gildas Bazin's avatar
 
Gildas Bazin committed
709
/* Helper writer functions */
710
#define SetWLE( p, v ) _SetWLE( (uint8_t*)(p), v)
Gildas Bazin's avatar
 
Gildas Bazin committed
711 712 713 714 715 716
static inline void _SetWLE( uint8_t *p, uint16_t i_dw )
{
    p[1] = ( i_dw >>  8 )&0xff;
    p[0] = ( i_dw       )&0xff;
}

717
#define SetDWLE( p, v ) _SetDWLE( (uint8_t*)(p), v)
Gildas Bazin's avatar
 
Gildas Bazin committed
718 719 720 721 722 723 724
static inline void _SetDWLE( uint8_t *p, uint32_t i_dw )
{
    p[3] = ( i_dw >> 24 )&0xff;
    p[2] = ( i_dw >> 16 )&0xff;
    p[1] = ( i_dw >>  8 )&0xff;
    p[0] = ( i_dw       )&0xff;
}
725
#define SetQWLE( p, v ) _SetQWLE( (uint8_t*)(p), v)
Gildas Bazin's avatar
 
Gildas Bazin committed
726 727 728 729 730
static inline void _SetQWLE( uint8_t *p, uint64_t i_qw )
{
    SetDWLE( p,   i_qw&0xffffffff );
    SetDWLE( p+4, ( i_qw >> 32)&0xffffffff );
}
731
#define SetWBE( p, v ) _SetWBE( (uint8_t*)(p), v)
732 733 734 735 736 737
static inline void _SetWBE( uint8_t *p, uint16_t i_dw )
{
    p[0] = ( i_dw >>  8 )&0xff;
    p[1] = ( i_dw       )&0xff;
}

738
#define SetDWBE( p, v ) _SetDWBE( (uint8_t*)(p), v)
739 740 741 742 743 744 745
static inline void _SetDWBE( uint8_t *p, uint32_t i_dw )
{
    p[0] = ( i_dw >> 24 )&0xff;
    p[1] = ( i_dw >> 16 )&0xff;
    p[2] = ( i_dw >>  8 )&0xff;
    p[3] = ( i_dw       )&0xff;
}
746
#define SetQWBE( p, v ) _SetQWBE( (uint8_t*)(p), v)
747 748 749 750 751
static inline void _SetQWBE( uint8_t *p, uint64_t i_qw )
{
    SetDWBE( p+4,   i_qw&0xffffffff );
    SetDWBE( p, ( i_qw >> 32)&0xffffffff );
}
752

753 754 755 756 757
#define hton16(i) htons(i)
#define hton32(i) htonl(i)
#define ntoh16(i) ntohs(i)
#define ntoh32(i) ntohl(i)

758
VLC_USED
759 760 761 762 763 764 765 766 767 768 769 770 771
static inline uint64_t ntoh64 (uint64_t ll)
{
    union { uint64_t qw; uint8_t b[16]; } v = { ll };
    return ((uint64_t)v.b[0] << 56)
         | ((uint64_t)v.b[1] << 48)
         | ((uint64_t)v.b[2] << 40)
         | ((uint64_t)v.b[3] << 32)
         | ((uint64_t)v.b[4] << 24)
         | ((uint64_t)v.b[5] << 16)
         | ((uint64_t)v.b[6] <<  8)
         | ((uint64_t)v.b[7] <<  0);
}
#define hton64(i) ntoh64(i)
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) || defined(UNDER_CE)
Sam Hocevar's avatar
 
Sam Hocevar committed
779
/* win32, cl and icl support */
Sam Hocevar's avatar
 
Sam Hocevar committed
780
#   if defined( _MSC_VER ) || !defined( __MINGW32__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
781
#       define __attribute__(x)
Gildas Bazin's avatar
 
Gildas Bazin committed
782
#       define S_IFBLK         0x3000  /* Block */
Sam Hocevar's avatar
 
Sam Hocevar committed
783 784 785 786 787 788 789 790 791
#       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_ )
792 793
            typedef long long _off_t;
            typedef _off_t off_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
794 795
#           define _OFF_T_
#       else
Gildas Bazin's avatar
 
Gildas Bazin committed
796 797 798
#           ifdef off_t
#               undef off_t
#           endif
Sam Hocevar's avatar
 
Sam Hocevar committed
799 800 801 802
#           define off_t long long
#       endif
#   endif

803
#   if defined( _MSC_VER ) && !defined( __WXMSW__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
804
#       if !defined( _OFF_T_DEFINED )
805
            typedef __int64 off_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
806 807
#           define _OFF_T_DEFINED
#       else
808
            /* for wx compatibility typedef long off_t; */
Sam Hocevar's avatar
 
Sam Hocevar committed
809 810 811 812
#           define off_t __int64
#       endif
#   endif

Olivier Teulière's avatar
 
Olivier Teulière committed
813
#   if defined( __BORLANDC__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
814
#       undef off_t
Olivier Teulière's avatar
 
Olivier Teulière committed
815
#       define off_t unsigned __int64
Sam Hocevar's avatar
 
Sam Hocevar committed
816 817
#   endif

Gildas Bazin's avatar
 
Gildas Bazin committed
818 819
#   ifndef O_NONBLOCK
#       define O_NONBLOCK 0
Gildas Bazin's avatar
 
Gildas Bazin committed
820 821 822 823
#   endif

#   ifndef alloca
#       define alloca _alloca
Sam Hocevar's avatar
 
Sam Hocevar committed
824 825
#   endif

826
#   include <tchar.h>
Sam Hocevar's avatar
 
Sam Hocevar committed
827 828
#endif

829
VLC_API bool vlc_ureduce( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t );
830

831
VLC_API void * vlc_memalign( void **base, size_t alignment, size_t size ) VLC_USED;
Laurent Aimar's avatar
Laurent Aimar committed
832

833
VLC_API void vlc_tdestroy( void *, void (*)(void *) );
834

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
835
/* Fast large memory copy and memory set */
836
VLC_API void * vlc_memcpy( void *, const void *, size_t );
837
#define vlc_memset memset
Sam Hocevar's avatar
 
Sam Hocevar committed
838 839 840 841

/*****************************************************************************
 * I18n stuff
 *****************************************************************************/
842
VLC_API char * vlc_gettext( const char *msgid ) VLC_FORMAT_ARG(1);
843

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
844 845 846
#define vlc_pgettext( ctx, id ) \
        vlc_pgettext_aux( ctx "\004" id, id )

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

854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872
/*****************************************************************************
 * 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;
}

873 874 875
/*****************************************************************************
 * libvlc features
 *****************************************************************************/
876 877 878
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;
879

880
/*****************************************************************************
881
 * Additional vlc stuff
882
 *****************************************************************************/
883
#include "vlc_messages.h"
Sam Hocevar's avatar
Sam Hocevar committed
884
#include "vlc_objects.h"
885
#include "vlc_variables.h"
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
886
#include "vlc_main.h"
Clément Stenac's avatar
Clément Stenac committed
887
#include "vlc_configuration.h"
888

889
#if defined( WIN32 ) || defined( UNDER_CE ) || defined( __SYMBIAN32__ ) || defined( __OS2__ )
890
#   define DIR_SEP_CHAR '\\'
Antoine Cellerier's avatar
Antoine Cellerier committed
891
#   define DIR_SEP "\\"
892 893
#   define PATH_SEP_CHAR ';'
#   define PATH_SEP ";"
Antoine Cellerier's avatar
Antoine Cellerier committed
894
#else
895
#   define DIR_SEP_CHAR '/'
Antoine Cellerier's avatar
Antoine Cellerier committed
896
#   define DIR_SEP "/"
897 898
#   define PATH_SEP_CHAR ':'
#   define PATH_SEP ":"
Antoine Cellerier's avatar
Antoine Cellerier committed
899
#endif
900

901 902 903 904 905 906
#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")

907
#endif /* !VLC_COMMON_H */