vlc_common.h 27.4 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 81 82
/* 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

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

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

157
/* Audio volume */
158 159
typedef uint16_t            audio_volume_t;

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

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

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

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

#define vlc_fourcc_to_char( a, b ) \
208
        vlc_fourcc_to_char( (vlc_fourcc_t)(a), (char *)(b) )
209

Sam Hocevar's avatar
 
Sam Hocevar committed
210 211 212 213
/*****************************************************************************
 * Classes declaration
 *****************************************************************************/

214
/* Internal types */
215 216
typedef struct vlc_list_t vlc_list_t;
typedef struct vlc_object_t vlc_object_t;
217
typedef struct libvlc_int_t libvlc_int_t;
218
typedef struct date_t date_t;
219

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

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


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

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

247 248
typedef struct config_category_t config_category_t;

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

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

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

/* Video */
283
typedef struct vout_thread_t vout_thread_t;
284

Gildas Bazin's avatar
 
Gildas Bazin committed
285
typedef video_format_t video_frame_format_t;
286 287
typedef struct picture_t picture_t;
typedef struct picture_sys_t picture_sys_t;
288

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

295 296
typedef struct image_handler_t image_handler_t;

297 298
/* Stream output */
typedef struct sout_instance_t sout_instance_t;
299 300
typedef struct sout_instance_sys_t sout_instance_sys_t;

301
typedef struct sout_input_t sout_input_t;
302
typedef struct sout_packetizer_input_t sout_packetizer_input_t;
303

304
typedef struct sout_access_out_t sout_access_out_t;
305 306
typedef struct sout_access_out_sys_t   sout_access_out_sys_t;

307
typedef struct sout_mux_t sout_mux_t;
308 309
typedef struct sout_mux_sys_t sout_mux_sys_t;

310
typedef struct sout_stream_t    sout_stream_t;
311 312
typedef struct sout_stream_sys_t sout_stream_sys_t;

313
typedef struct config_chain_t       config_chain_t;
314
typedef struct session_descriptor_t session_descriptor_t;
315

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

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

325 326 327 328
/* Filters */
typedef struct filter_t filter_t;
typedef struct filter_sys_t filter_sys_t;

329
/* Network */
330
typedef struct virtual_socket_t v_socket_t;
331
typedef struct vlc_acl_t vlc_acl_t;
332
typedef struct vlc_url_t vlc_url_t;
333

334 335 336
/* Misc */
typedef struct iso639_lang_t iso639_lang_t;

337 338 339 340
/* block */
typedef struct block_t      block_t;
typedef struct block_fifo_t block_fifo_t;

341 342 343 344 345 346 347
/* 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
348
typedef int    (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, const httpd_message_t *query );
349 350
typedef struct httpd_file_t     httpd_file_t;
typedef struct httpd_file_sys_t httpd_file_sys_t;
351 352 353
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
354
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 );
355 356 357
typedef struct httpd_redirect_t httpd_redirect_t;
typedef struct httpd_stream_t httpd_stream_t;

358 359 360
/* Hashing */
typedef struct md5_s md5_t;

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

367 368 369
/* vod server */
typedef struct vod_t     vod_t;
typedef struct vod_sys_t vod_sys_t;
370
typedef struct vod_media_t vod_media_t;
371

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

379
/* VLM */
380 381
typedef struct vlm_t         vlm_t;
typedef struct vlm_message_t vlm_message_t;
382

383
/* misc */
384
typedef struct vlc_meta_t    vlc_meta_t;
385

386
/* Stats */
387 388 389
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
390
typedef struct input_stats_t input_stats_t;
391

392 393 394
/* Update */
typedef struct update_t update_t;
typedef struct update_iterator_t update_iterator_t;
395

396 397 398
/* Meta engine */
typedef struct meta_engine_t meta_engine_t;

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

403
# ifndef UNDER_CE
404
struct _stati64;
405 406
#define stat _stati64
#define fstat _fstati64
407 408
#endif

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

414 415 416 417 418
/**
 * VLC value structure
 */
typedef union
{
419
    int64_t         i_int;
420
    bool            b_bool;
421 422 423 424 425 426
    float           f_float;
    char *          psz_string;
    void *          p_address;
    vlc_object_t *  p_object;
    vlc_list_t *    p_list;
    mtime_t         i_time;
427
    struct { int32_t x; int32_t y; } coords;
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 460 461

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

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

471 472 473
/*****************************************************************************
 * OS-specific headers and thread types
 *****************************************************************************/
474
#if defined( WIN32 ) || defined( UNDER_CE )
475 476 477 478
#   define WIN32_LEAN_AND_MEAN
#   include <windows.h>
#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
/* Free and set set the variable to NULL */
634
#define FREENULL(a) do { free( a ); a = NULL; } while(0)
635

636 637
#define EMPTY_STR(str) (!str || !*str)

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

640
#include <vlc_arrays.h>
641

Sam Hocevar's avatar
 
Sam Hocevar committed
642
/* MSB (big endian)/LSB (little endian) conversions - network order is always
643
 * MSB, and should be used for both network communications and files. */
644
VLC_USED
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
645
static inline uint16_t U16_AT( const void * _p )
646
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
647
    const uint8_t * p = (const uint8_t *)_p;
648
    return ( ((uint16_t)p[0] << 8) | p[1] );
649
}
650

651
VLC_USED
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
652
static inline uint32_t U32_AT( const void * _p )
653
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
654
    const uint8_t * p = (const uint8_t *)_p;
655 656
    return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
              | ((uint32_t)p[2] << 8) | p[3] );
657
}
658

659
VLC_USED
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
660
static inline uint64_t U64_AT( const void * _p )
661
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
662
    const uint8_t * p = (const uint8_t *)_p;
663 664 665 666
    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] );
667
}
668

669
VLC_USED
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
670
static inline uint16_t GetWLE( const void * _p )
671
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
672
    const uint8_t * p = (const uint8_t *)_p;
673 674
    return ( ((uint16_t)p[1] << 8) | p[0] );
}
675

676
VLC_USED
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
677
static inline uint32_t GetDWLE( const void * _p )
678
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
679
    const uint8_t * p = (const uint8_t *)_p;
680 681 682
    return ( ((uint32_t)p[3] << 24) | ((uint32_t)p[2] << 16)
              | ((uint32_t)p[1] << 8) | p[0] );
}
683

684
VLC_USED
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
685
static inline uint64_t GetQWLE( const void * _p )
686
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
687
    const uint8_t * p = (const uint8_t *)_p;
688 689 690 691 692 693 694 695 696 697
    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
698
/* Helper writer functions */
699
#define SetWLE( p, v ) _SetWLE( (uint8_t*)(p), v)
Gildas Bazin's avatar
 
Gildas Bazin committed
700 701 702 703 704 705
static inline void _SetWLE( uint8_t *p, uint16_t i_dw )
{
    p[1] = ( i_dw >>  8 )&0xff;
    p[0] = ( i_dw       )&0xff;
}

706
#define SetDWLE( p, v ) _SetDWLE( (uint8_t*)(p), v)
Gildas Bazin's avatar
 
Gildas Bazin committed
707 708 709 710 711 712 713
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;
}
714
#define SetQWLE( p, v ) _SetQWLE( (uint8_t*)(p), v)
Gildas Bazin's avatar
 
Gildas Bazin committed
715 716 717 718 719
static inline void _SetQWLE( uint8_t *p, uint64_t i_qw )
{
    SetDWLE( p,   i_qw&0xffffffff );
    SetDWLE( p+4, ( i_qw >> 32)&0xffffffff );
}
720
#define SetWBE( p, v ) _SetWBE( (uint8_t*)(p), v)
721 722 723 724 725 726
static inline void _SetWBE( uint8_t *p, uint16_t i_dw )
{
    p[0] = ( i_dw >>  8 )&0xff;
    p[1] = ( i_dw       )&0xff;
}

727
#define SetDWBE( p, v ) _SetDWBE( (uint8_t*)(p), v)
728 729 730 731 732 733 734
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;
}
735
#define SetQWBE( p, v ) _SetQWBE( (uint8_t*)(p), v)
736 737 738 739 740
static inline void _SetQWBE( uint8_t *p, uint64_t i_qw )
{
    SetDWBE( p+4,   i_qw&0xffffffff );
    SetDWBE( p, ( i_qw >> 32)&0xffffffff );
}
741

742 743 744 745 746
#define hton16(i) htons(i)
#define hton32(i) htonl(i)
#define ntoh16(i) ntohs(i)
#define ntoh32(i) ntohl(i)

747
VLC_USED
748 749 750 751 752 753 754 755 756 757 758 759 760
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
761

762 763 764
/* */
#define VLC_UNUSED(x) (void)(x)

765
/* Stuff defined in src/extras/libc.c */
766

767
#if defined(WIN32) || defined(UNDER_CE)
Sam Hocevar's avatar
 
Sam Hocevar committed
768
/* win32, cl and icl support */
Sam Hocevar's avatar
 
Sam Hocevar committed
769
#   if defined( _MSC_VER ) || !defined( __MINGW32__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
770
#       define __attribute__(x)
Gildas Bazin's avatar
 
Gildas Bazin committed
771
#       define S_IFBLK         0x3000  /* Block */
Sam Hocevar's avatar
 
Sam Hocevar committed
772 773 774 775 776 777 778 779 780
#       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_ )
781 782
            typedef long long _off_t;
            typedef _off_t off_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
783 784
#           define _OFF_T_
#       else
Gildas Bazin's avatar
 
Gildas Bazin committed
785 786 787
#           ifdef off_t
#               undef off_t
#           endif
Sam Hocevar's avatar
 
Sam Hocevar committed
788 789 790 791
#           define off_t long long
#       endif
#   endif

792
#   if defined( _MSC_VER ) && !defined( __WXMSW__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
793
#       if !defined( _OFF_T_DEFINED )
794
            typedef __int64 off_t;
Sam Hocevar's avatar
 
Sam Hocevar committed
795 796
#           define _OFF_T_DEFINED
#       else
797
            /* for wx compatibility typedef long off_t; */
Sam Hocevar's avatar
 
Sam Hocevar committed
798 799 800 801
#           define off_t __int64
#       endif
#   endif

Olivier Teulière's avatar
 
Olivier Teulière committed
802
#   if defined( __BORLANDC__ )
Sam Hocevar's avatar
 
Sam Hocevar committed
803
#       undef off_t
Olivier Teulière's avatar
 
Olivier Teulière committed
804
#       define off_t unsigned __int64
Sam Hocevar's avatar
 
Sam Hocevar committed
805 806
#   endif

Gildas Bazin's avatar
 
Gildas Bazin committed
807 808
#   ifndef O_NONBLOCK
#       define O_NONBLOCK 0
Gildas Bazin's avatar
 
Gildas Bazin committed
809 810 811 812
#   endif

#   ifndef alloca
#       define alloca _alloca
Sam Hocevar's avatar
 
Sam Hocevar committed
813 814
#   endif

815
#   include <tchar.h>
Sam Hocevar's avatar
 
Sam Hocevar committed
816 817
#endif

818
VLC_API bool vlc_ureduce( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t );
819

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

822
VLC_API void vlc_tdestroy( void *, void (*)(void *) );
823

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
824
/* Fast large memory copy and memory set */
825
VLC_API void * vlc_memcpy( void *, const void *, size_t );
826
#define vlc_memset memset
Sam Hocevar's avatar
 
Sam Hocevar committed
827 828 829 830

/*****************************************************************************
 * I18n stuff
 *****************************************************************************/
831
VLC_API char * vlc_gettext( const char *msgid ) VLC_FORMAT_ARG(1);
832

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
833 834 835
#define vlc_pgettext( ctx, id ) \
        vlc_pgettext_aux( ctx "\004" id, id )

836
VLC_FORMAT_ARG(2)
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
837
static inline const char *vlc_pgettext_aux( const char *ctx, const char *id )
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
838
{
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
839
    const char *tr = vlc_gettext( ctx );
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
840 841 842
    return (tr == ctx) ? id : tr;
}

843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861
/*****************************************************************************
 * 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;
}

862 863 864 865 866 867 868 869
static inline void *xcalloc (size_t n, size_t size)
{
    void *ptr = calloc (n, size);
    if (unlikely (ptr == NULL))
        abort ();
    return ptr;
}

870 871 872
/*****************************************************************************
 * libvlc features
 *****************************************************************************/
873 874 875
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;
876

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

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

898 899 900 901 902 903
#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")

904
#endif /* !VLC_COMMON_H */