include/vlc_common.h

   1 /*****************************************************************************
   2  * common.h: common definitions
   3  * Collection of useful common types and macros definitions
   4  *****************************************************************************
   5  * Copyright (C) 1998-2005 the VideoLAN team
   6  * $Id$
   7  *
   8  * Authors: Samuel Hocevar <sam@via.ecp.fr>
   9  *          Vincent Seguin <seguin@via.ecp.fr>
  10  *          Gildas Bazin <gbazin@videolan.org>
  11  *
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  25  *****************************************************************************/
  26
  27 /**
  28  * \file
  29  * This file is a collection of common definitions and types
  30  */
  31
  32 #ifndef VLC_COMMON_H
  33 # define VLC_COMMON_H 1
  34
  35 /*****************************************************************************
  36  * Required vlc headers
  37  *****************************************************************************/
  38 #if defined( _MSC_VER )
  39 #   pragma warning( disable : 4244 )
  40 #endif
  41
  42 #include "vlc_config.h"
  43
  44 /*****************************************************************************
  45  * Required system headers
  46  *****************************************************************************/
  47 #include <stdlib.h>
  48 #include <stdarg.h>
  49
  50 #include <string.h>
  51 #include <stdio.h>
  52 #include <inttypes.h>
  53 #include <stddef.h>
  54
  55 #ifndef __cplusplus
  56 # include <stdbool.h>
  57 #endif
  58
  59 /* Try to fix format strings for all versions of mingw and mingw64 */
  60 #if defined( _WIN32 ) && defined( __USE_MINGW_ANSI_STDIO )
  61  #undef PRId64
  62  #define PRId64 "lld"
  63  #undef PRIi64
  64  #define PRIi64 "lli"
  65  #undef PRIu64
  66  #define PRIu64 "llu"
  67  #undef PRIo64
  68  #define PRIo64 "llo"
  69  #undef PRIx64
  70  #define PRIx64 "llx"
  71  #define snprintf        __mingw_snprintf
  72  #define vsnprintf       __mingw_vsnprintf
  73 #endif
  74
  75 /* Format string sanity checks */
  76 #ifdef __GNUC__
  77 #   if defined( _WIN32 ) && __GNUC__ >= 4 && __GNUC_MINOR__ >= 4
  78 #     define LIBVLC_FORMAT(x,y) __attribute__ ((format(gnu_printf,x,y)))
  79 #   else
  80 #     define LIBVLC_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
  81 #   endif
  82 #   define LIBVLC_FORMAT_ARG(x) __attribute__ ((format_arg(x)))
  83 #   define LIBVLC_USED __attribute__ ((warn_unused_result))
  84 #   define LIBVLC_MALLOC __attribute__ ((malloc))
  85 #else
  86 #   define LIBVLC_FORMAT(x,y)
  87 #   define LIBVLC_FORMAT_ARG(x)
  88 #   define LIBVLC_USED
  89 #   define LIBVLC_MALLOC
  90 #endif
  91
  92 /* Branch prediction */
  93 #ifdef __GNUC__
  94 #   define likely(p)   __builtin_expect(!!(p), 1)
  95 #   define unlikely(p) __builtin_expect(!!(p), 0)
  96 #else
  97 #   define likely(p)   (!!(p))
  98 #   define unlikely(p) (!!(p))
  99 #endif
 100
 101 /*****************************************************************************
 102  * Basic types definitions
 103  *****************************************************************************/
 104 #if defined( WIN32 ) || defined( UNDER_CE )
 105 #   include <malloc.h>
 106 #   ifndef PATH_MAX
 107 #       define PATH_MAX MAX_PATH
 108 #   endif
 109 #endif
 110
 111 /* Counter for statistics and profiling */
 112 typedef unsigned long       count_t;
 113
 114 /* Audio volume */
 115 typedef uint16_t            audio_volume_t;
 116
 117 /**
 118  * High precision date or time interval
 119  *
 120  * Store a high precision date or time interval. The maximum precision is the
 121  * microsecond, and a 64 bits integer is used to avoid overflows (maximum
 122  * time interval is then 292271 years, which should be long enough for any
 123  * video). Dates are stored as microseconds since a common date (usually the
 124  * epoch). Note that date and time intervals can be manipulated using regular
 125  * arithmetic operators, and that no special functions are required.
 126  */
 127 typedef int64_t mtime_t;
 128
 129 /**
 130  * The vlc_fourcc_t type.
 131  *
 132  * See http://www.webartz.com/fourcc/ for a very detailed list.
 133  */
 134 typedef uint32_t vlc_fourcc_t;
 135
 136 #ifdef WORDS_BIGENDIAN
 137 #   define VLC_FOURCC( a, b, c, d ) \
 138         ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
 139            | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
 140 #   define VLC_TWOCC( a, b ) \
 141         ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )
 142
 143 #else
 144 #   define VLC_FOURCC( a, b, c, d ) \
 145         ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
 146            | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
 147 #   define VLC_TWOCC( a, b ) \
 148         ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )
 149
 150 #endif
 151
 152 /**
 153  * Translate a vlc_fourcc into its string representation. This function
 154  * assumes there is enough room in psz_fourcc to store 4 characters in.
 155  *
 156  * \param fcc a vlc_fourcc_t
 157  * \param psz_fourcc string to store string representation of vlc_fourcc in
 158  */
 159 static inline void __vlc_fourcc_to_char( vlc_fourcc_t fcc, char *psz_fourcc )
 160 {
 161     memcpy( psz_fourcc, &fcc, 4 );
 162 }
 163
 164 #define vlc_fourcc_to_char( a, b ) \
 165     __vlc_fourcc_to_char( (vlc_fourcc_t)(a), (char *)(b) )
 166
 167 /*****************************************************************************
 168  * Classes declaration
 169  *****************************************************************************/
 170
 171 /* Internal types */
 172 typedef struct vlc_list_t vlc_list_t;
 173 typedef struct vlc_object_t vlc_object_t;
 174 typedef struct libvlc_int_t libvlc_int_t;
 175 typedef struct date_t date_t;
 176 typedef struct dict_entry_t dict_entry_t;
 177 typedef struct dict_t dict_t;
 178
 179 /* Playlist */
 180
 181 /* FIXME */
 182 /**
 183  * Playlist commands
 184  */
 185 typedef enum {
 186     PLAYLIST_PLAY,      /**< No arg.                            res=can fail*/
 187     PLAYLIST_VIEWPLAY,  /**< arg1= playlist_item_t*,*/
 188                         /**  arg2 = playlist_item_t*          , res=can fail */
 189     PLAYLIST_PAUSE,     /**< No arg                             res=can fail*/
 190     PLAYLIST_STOP,      /**< No arg                             res=can fail*/
 191     PLAYLIST_SKIP,      /**< arg1=int,                          res=can fail*/
 192 } playlist_command_t;
 193
 194
 195 typedef struct playlist_t playlist_t;
 196 typedef struct playlist_item_t playlist_item_t;
 197 typedef struct playlist_view_t playlist_view_t;
 198 typedef struct services_discovery_t services_discovery_t;
 199 typedef struct services_discovery_sys_t services_discovery_sys_t;
 200 typedef struct playlist_add_t playlist_add_t;
 201
 202 /* Modules */
 203 typedef struct module_bank_t module_bank_t;
 204 typedef struct module_t module_t;
 205 typedef struct module_config_t module_config_t;
 206 typedef struct module_symbols_t module_symbols_t;
 207 typedef struct module_cache_t module_cache_t;
 208
 209 typedef struct config_category_t config_category_t;
 210
 211 /* Input */
 212 typedef struct input_thread_t input_thread_t;
 213 typedef struct input_thread_sys_t input_thread_sys_t;
 214 typedef struct input_item_t input_item_t;
 215 typedef struct access_t access_t;
 216 typedef struct access_sys_t access_sys_t;
 217 typedef struct stream_t     stream_t;
 218 typedef struct stream_sys_t stream_sys_t;
 219 typedef struct demux_t  demux_t;
 220 typedef struct demux_sys_t demux_sys_t;
 221 typedef struct es_out_t     es_out_t;
 222 typedef struct es_out_id_t  es_out_id_t;
 223 typedef struct es_out_sys_t es_out_sys_t;
 224 typedef struct es_descriptor_t es_descriptor_t;
 225 typedef struct seekpoint_t seekpoint_t;
 226 typedef struct info_t info_t;
 227 typedef struct info_category_t info_category_t;
 228 typedef struct input_attachment_t input_attachment_t;
 229
 230 /* Format */
 231 typedef struct audio_format_t audio_format_t;
 232 typedef struct video_format_t video_format_t;
 233 typedef struct subs_format_t subs_format_t;
 234 typedef struct es_format_t es_format_t;
 235 typedef struct video_palette_t video_palette_t;
 236
 237 /* Audio */
 238 typedef struct aout_instance_t aout_instance_t;
 239 typedef struct aout_sys_t aout_sys_t;
 240 typedef struct aout_fifo_t aout_fifo_t;
 241 typedef struct aout_input_t aout_input_t;
 242 typedef struct block_t aout_buffer_t;
 243 typedef audio_format_t audio_sample_format_t;
 244 typedef struct audio_date_t audio_date_t;
 245 typedef struct aout_filter_t aout_filter_t;
 246
 247 /* Video */
 248 typedef struct vout_thread_t vout_thread_t;
 249 typedef struct vout_sys_t vout_sys_t;
 250
 251 typedef video_format_t video_frame_format_t;
 252 typedef struct picture_t picture_t;
 253 typedef struct picture_sys_t picture_sys_t;
 254 typedef struct picture_heap_t picture_heap_t;
 255
 256 /* Subpictures */
 257 typedef struct spu_t spu_t;
 258 typedef struct subpicture_t subpicture_t;
 259 typedef struct subpicture_sys_t subpicture_sys_t;
 260 typedef struct subpicture_region_t subpicture_region_t;
 261 typedef struct text_style_t text_style_t;
 262
 263 typedef struct image_handler_t image_handler_t;
 264
 265 /* Stream output */
 266 typedef struct sout_instance_t sout_instance_t;
 267 typedef struct sout_instance_sys_t sout_instance_sys_t;
 268
 269 typedef struct sout_input_t sout_input_t;
 270 typedef struct sout_packetizer_input_t sout_packetizer_input_t;
 271
 272 typedef struct sout_access_out_t sout_access_out_t;
 273 typedef struct sout_access_out_sys_t   sout_access_out_sys_t;
 274
 275 typedef struct sout_mux_t sout_mux_t;
 276 typedef struct sout_mux_sys_t sout_mux_sys_t;
 277
 278 typedef struct sout_stream_t    sout_stream_t;
 279 typedef struct sout_stream_sys_t sout_stream_sys_t;
 280
 281 typedef struct config_chain_t       config_chain_t;
 282 typedef struct session_descriptor_t session_descriptor_t;
 283 typedef struct announce_method_t announce_method_t;
 284
 285 typedef struct sout_param_t sout_param_t;
 286 typedef struct sout_pcat_t sout_pcat_t;
 287 typedef struct sout_std_t sout_std_t;
 288 typedef struct sout_display_t sout_display_t;
 289 typedef struct sout_duplicate_t sout_duplicate_t;
 290 typedef struct sout_transcode_t sout_transcode_t;
 291 typedef struct sout_chain_t sout_chain_t;
 292 typedef struct streaming_profile_t streaming_profile_t;
 293 typedef struct sout_module_t sout_module_t;
 294 typedef struct sout_gui_descr_t sout_gui_descr_t;
 295 typedef struct profile_parser_t profile_parser_t;
 296
 297 /* Decoders */
 298 typedef struct decoder_t         decoder_t;
 299 typedef struct decoder_sys_t     decoder_sys_t;
 300 typedef struct decoder_synchro_t decoder_synchro_t;
 301
 302 /* Encoders */
 303 typedef struct encoder_t      encoder_t;
 304 typedef struct encoder_sys_t  encoder_sys_t;
 305
 306 /* Filters */
 307 typedef struct filter_t filter_t;
 308 typedef struct filter_sys_t filter_sys_t;
 309
 310 /* Network */
 311 typedef struct network_socket_t network_socket_t;
 312 typedef struct virtual_socket_t v_socket_t;
 313 typedef struct sockaddr sockaddr;
 314 typedef struct addrinfo addrinfo;
 315 typedef struct vlc_acl_t vlc_acl_t;
 316 typedef struct vlc_url_t vlc_url_t;
 317
 318 /* Misc */
 319 typedef struct iso639_lang_t iso639_lang_t;
 320 typedef struct device_t device_t;
 321 typedef struct device_probe_t device_probe_t;
 322 typedef struct probe_sys_t probe_sys_t;
 323
 324 /* block */
 325 typedef struct block_t      block_t;
 326 typedef struct block_fifo_t block_fifo_t;
 327
 328 /* httpd */
 329 typedef struct httpd_t          httpd_t;
 330 typedef struct httpd_host_t     httpd_host_t;
 331 typedef struct httpd_url_t      httpd_url_t;
 332 typedef struct httpd_client_t   httpd_client_t;
 333 typedef struct httpd_callback_sys_t httpd_callback_sys_t;
 334 typedef struct httpd_message_t  httpd_message_t;
 335 typedef int    (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, const httpd_message_t *query );
 336 typedef struct httpd_file_t     httpd_file_t;
 337 typedef struct httpd_file_sys_t httpd_file_sys_t;
 338 typedef int (*httpd_file_callback_t)( httpd_file_sys_t *, httpd_file_t *, uint8_t *psz_request, uint8_t **pp_data, int *pi_data );
 339 typedef struct httpd_handler_t  httpd_handler_t;
 340 typedef struct httpd_handler_sys_t httpd_handler_sys_t;
 341 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 );
 342 typedef struct httpd_redirect_t httpd_redirect_t;
 343 typedef struct httpd_stream_t httpd_stream_t;
 344
 345 /* TLS support */
 346 typedef struct tls_server_t tls_server_t;
 347 typedef struct tls_session_t tls_session_t;
 348
 349 /* Hashing */
 350 typedef struct md5_s md5_t;
 351
 352 /* XML */
 353 typedef struct xml_t xml_t;
 354 typedef struct xml_sys_t xml_sys_t;
 355 typedef struct xml_reader_t xml_reader_t;
 356 typedef struct xml_reader_sys_t xml_reader_sys_t;
 357
 358 /* vod server */
 359 typedef struct vod_t     vod_t;
 360 typedef struct vod_sys_t vod_sys_t;
 361 typedef struct vod_media_t vod_media_t;
 362
 363 /* opengl */
 364 typedef struct opengl_t     opengl_t;
 365 typedef struct opengl_sys_t opengl_sys_t;
 366
 367 /* osdmenu */
 368 typedef struct osd_menu_t   osd_menu_t;
 369 typedef struct osd_state_t  osd_state_t;
 370 typedef struct osd_event_t  osd_event_t;
 371 typedef struct osd_button_t osd_button_t;
 372 typedef struct osd_menu_state_t osd_menu_state_t;
 373
 374 /* VLM */
 375 typedef struct vlm_t         vlm_t;
 376 typedef struct vlm_message_t vlm_message_t;
 377
 378 /* misc */
 379 typedef struct vlc_meta_t    vlc_meta_t;
 380
 381 /* Stats */
 382 typedef struct counter_t     counter_t;
 383 typedef struct counter_sample_t counter_sample_t;
 384 typedef struct stats_handler_t stats_handler_t;
 385 typedef struct input_stats_t input_stats_t;
 386
 387 /* Update */
 388 typedef struct update_t update_t;
 389 typedef struct update_iterator_t update_iterator_t;
 390
 391 /* Meta engine */
 392 typedef struct meta_engine_t meta_engine_t;
 393
 394 /* stat/lstat/fstat */
 395 #ifdef WIN32
 396 #include <sys/stat.h>
 397
 398 # ifndef UNDER_CE
 399 struct _stati64;
 400 #define stat _stati64
 401 #define fstat _fstati64
 402 #endif
 403
 404 /* You should otherwise use utf8_stat and utf8_lstat. */
 405 #else
 406 struct stat;
 407 #endif
 408
 409 /**
 410  * VLC value structure
 411  */
 412 typedef union
 413 {
 414     int             i_int;
 415     bool            b_bool;
 416     float           f_float;
 417     char *          psz_string;
 418     void *          p_address;
 419     vlc_object_t *  p_object;
 420     vlc_list_t *    p_list;
 421     mtime_t         i_time;
 422
 423     struct { char *psz_name; int i_object_id; } var;
 424
 425    /* Make sure the structure is at least 64bits */
 426     struct { char a, b, c, d, e, f, g, h; } padding;
 427
 428 } vlc_value_t;
 429
 430 /**
 431  * VLC list structure
 432  */
 433 struct vlc_list_t
 434 {
 435     int             i_count;
 436     vlc_value_t *   p_values;
 437     int *           pi_types;
 438
 439 };
 440
 441 /**
 442  * \defgroup var_type Variable types
 443  * These are the different types a vlc variable can have.
 444  * @{
 445  */
 446 #define VLC_VAR_VOID      0x0010
 447 #define VLC_VAR_BOOL      0x0020
 448 #define VLC_VAR_INTEGER   0x0030
 449 #define VLC_VAR_HOTKEY    0x0031
 450 #define VLC_VAR_STRING    0x0040
 451 #define VLC_VAR_MODULE    0x0041
 452 #define VLC_VAR_FILE      0x0042
 453 #define VLC_VAR_DIRECTORY 0x0043
 454 #define VLC_VAR_VARIABLE  0x0044
 455 #define VLC_VAR_FLOAT     0x0050
 456 #define VLC_VAR_TIME      0x0060
 457 #define VLC_VAR_ADDRESS   0x0070
 458 #define VLC_VAR_MUTEX     0x0080
 459 #define VLC_VAR_LIST      0x0090
 460 /**@}*/
 461
 462 /*****************************************************************************
 463  * Error values (shouldn't be exposed)
 464  *****************************************************************************/
 465 #define VLC_SUCCESS         -0                                   /* No error */
 466 #define VLC_ENOMEM          -1                          /* Not enough memory */
 467 #define VLC_ETIMEOUT        -3                                    /* Timeout */
 468
 469 #define VLC_ENOMOD         -10                           /* Module not found */
 470
 471 #define VLC_ENOOBJ         -20                           /* Object not found */
 472
 473 #define VLC_ENOVAR         -30                         /* Variable not found */
 474 #define VLC_EBADVAR        -31                         /* Bad variable value */
 475
 476 #define VLC_ENOITEM        -40                           /**< Item not found */
 477
 478 #define VLC_EEXIT         -255                             /* Program exited */
 479 #define VLC_EEXITSUCCESS  -999                /* Program exited successfully */
 480 #define VLC_EGENERIC      -666                              /* Generic error */
 481
 482 /*****************************************************************************
 483  * Variable callbacks
 484  *****************************************************************************/
 485 typedef int ( * vlc_callback_t ) ( vlc_object_t *,      /* variable's object */
 486                                    char const *,            /* variable name */
 487                                    vlc_value_t,                 /* old value */
 488                                    vlc_value_t,                 /* new value */
 489                                    void * );                /* callback data */
 490
 491 /*****************************************************************************
 492  * Plug-in stuff
 493  *****************************************************************************/
 494
 495 #ifdef __cplusplus
 496 # define LIBVLC_EXTERN extern "C"
 497 #else
 498 # define LIBVLC_EXTERN extern
 499 #endif
 500 #if defined (WIN32) && defined (DLL_EXPORT)
 501 #if defined (UNDER_CE)
 502 # include <windef.h>
 503 #endif
 504 # define LIBVLC_EXPORT __declspec(dllexport)
 505 #else
 506 # define LIBVLC_EXPORT
 507 #endif
 508 #define VLC_EXPORT( type, name, args ) \
 509                         LIBVLC_EXTERN LIBVLC_EXPORT type name args
 510
 511 /*****************************************************************************
 512  * OS-specific headers and thread types
 513  *****************************************************************************/
 514 #if defined( WIN32 ) || defined( UNDER_CE )
 515 #   define WIN32_LEAN_AND_MEAN
 516 #   include <windows.h>
 517 #endif
 518
 519 #include "vlc_mtime.h"
 520 #include "vlc_threads.h"
 521
 522 /*****************************************************************************
 523  * Common structure members
 524  *****************************************************************************/
 525
 526 /* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
 527 #define VLC_COMMON_MEMBERS                                                  \
 528 /** \name VLC_COMMON_MEMBERS                                                \
 529  * these members are common for all vlc objects                             \
 530  */                                                                         \
 531 /**@{*/                                                                     \
 532     const char *psz_object_type;                                            \
 533                                                                             \
 534     /* Messages header */                                                   \
 535     char *psz_header;                                                       \
 536     int  i_flags;                                                           \
 537                                                                             \
 538     /* Object properties */                                                 \
 539     volatile bool b_error;                  /**< set by the object */ \
 540     volatile bool b_die;                   /**< set by the outside */ \
 541     bool b_force;      /**< set by the outside (eg. module_need()) */ \
 542                                                                             \
 543     /** Just a reminder so that people don't cast garbage */                \
 544     bool be_sure_to_add_VLC_COMMON_MEMBERS_to_struct;                       \
 545                                                                             \
 546     /* Stuff related to the libvlc structure */                             \
 547     libvlc_int_t *p_libvlc;                  /**< (root of all evil) - 1 */ \
 548                                                                             \
 549     vlc_object_t *  p_parent;                            /**< our parent */ \
 550                                                                             \
 551 /**@}*/                                                                     \
 552
 553 /* VLC_OBJECT: attempt at doing a clever cast */
 554 #ifdef __GNUC__
 555 # define VLC_OBJECT( x ) \
 556     (((vlc_object_t *)(x))+0*(((__typeof__(x))0)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct))
 557 #else
 558 # define VLC_OBJECT( x ) ((vlc_object_t *)(x))
 559 #endif
 560
 561 typedef struct gc_object_t
 562 {
 563     vlc_spinlock_t spin;
 564     uintptr_t      refs;
 565     void          (*pf_destructor) (struct gc_object_t *);
 566 } gc_object_t;
 567
 568 /**
 569  * These members are common to all objects that wish to be garbage-collected.
 570  */
 571 #define VLC_GC_MEMBERS gc_object_t vlc_gc_data;
 572
 573 VLC_EXPORT(void *, vlc_gc_init, (gc_object_t *, void (*)(gc_object_t *)));
 574 VLC_EXPORT(void *, vlc_hold, (gc_object_t *));
 575 VLC_EXPORT(void, vlc_release, (gc_object_t *));
 576
 577 #define vlc_gc_init( a,b ) vlc_gc_init( &(a)->vlc_gc_data, (b) )
 578 #define vlc_gc_incref( a ) vlc_hold( &(a)->vlc_gc_data )
 579 #define vlc_gc_decref( a ) vlc_release( &(a)->vlc_gc_data )
 580 #define vlc_priv( gc, t ) ((t *)(((char *)(gc)) - offsetof(t, vlc_gc_data)))
 581
 582 /*****************************************************************************
 583  * Macros and inline functions
 584  *****************************************************************************/
 585
 586 /* CEIL: division with round to nearest greater integer */
 587 #define CEIL(n, d)  ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
 588
 589 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
 590 #define PAD(n, d)   ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
 591
 592 /* __MAX and __MIN: self explanatory */
 593 #ifndef __MAX
 594 #   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
 595 #endif
 596 #ifndef __MIN
 597 #   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
 598 #endif
 599
 600 LIBVLC_USED
 601 static inline int64_t GCD ( int64_t a, int64_t b )
 602 {
 603     while( b )
 604     {
 605         int64_t c = a % b;
 606         a = b;
 607         b = c;
 608     }
 609     return a;
 610 }
 611
 612 /* function imported from libavutil/common.h */
 613 LIBVLC_USED
 614 static inline uint8_t clip_uint8_vlc( int32_t a )
 615 {
 616     if( a&(~255) ) return (-a)>>31;
 617     else           return a;
 618 }
 619
 620 /* Free and set set the variable to NULL */
 621 #define FREENULL(a) do { free( a ); a = NULL; } while(0)
 622
 623 #define EMPTY_STR(str) (!str || !*str)
 624
 625 VLC_EXPORT( char const *, vlc_error, ( int ) LIBVLC_USED );
 626
 627 #include <vlc_arrays.h>
 628
 629 /* MSB (big endian)/LSB (little endian) conversions - network order is always
 630  * MSB, and should be used for both network communications and files. */
 631 LIBVLC_USED
 632 static inline uint16_t U16_AT( const void * _p )
 633 {
 634     const uint8_t * p = (const uint8_t *)_p;
 635     return ( ((uint16_t)p[0] << 8) | p[1] );
 636 }
 637
 638 LIBVLC_USED
 639 static inline uint32_t U32_AT( const void * _p )
 640 {
 641     const uint8_t * p = (const uint8_t *)_p;
 642     return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
 643               | ((uint32_t)p[2] << 8) | p[3] );
 644 }
 645
 646 LIBVLC_USED
 647 static inline uint64_t U64_AT( const void * _p )
 648 {
 649     const uint8_t * p = (const uint8_t *)_p;
 650     return ( ((uint64_t)p[0] << 56) | ((uint64_t)p[1] << 48)
 651               | ((uint64_t)p[2] << 40) | ((uint64_t)p[3] << 32)
 652               | ((uint64_t)p[4] << 24) | ((uint64_t)p[5] << 16)
 653               | ((uint64_t)p[6] << 8) | p[7] );
 654 }
 655
 656 LIBVLC_USED
 657 static inline uint16_t GetWLE( const void * _p )
 658 {
 659     const uint8_t * p = (const uint8_t *)_p;
 660     return ( ((uint16_t)p[1] << 8) | p[0] );
 661 }
 662
 663 LIBVLC_USED
 664 static inline uint32_t GetDWLE( const void * _p )
 665 {
 666     const uint8_t * p = (const uint8_t *)_p;
 667     return ( ((uint32_t)p[3] << 24) | ((uint32_t)p[2] << 16)
 668               | ((uint32_t)p[1] << 8) | p[0] );
 669 }
 670
 671 LIBVLC_USED
 672 static inline uint64_t GetQWLE( const void * _p )
 673 {
 674     const uint8_t * p = (const uint8_t *)_p;
 675     return ( ((uint64_t)p[7] << 56) | ((uint64_t)p[6] << 48)
 676               | ((uint64_t)p[5] << 40) | ((uint64_t)p[4] << 32)
 677               | ((uint64_t)p[3] << 24) | ((uint64_t)p[2] << 16)
 678               | ((uint64_t)p[1] << 8) | p[0] );
 679 }
 680
 681 #define GetWBE( p )     U16_AT( p )
 682 #define GetDWBE( p )    U32_AT( p )
 683 #define GetQWBE( p )    U64_AT( p )
 684
 685 /* Helper writer functions */
 686 #define SetWLE( p, v ) _SetWLE( (uint8_t*)(p), v)
 687 static inline void _SetWLE( uint8_t *p, uint16_t i_dw )
 688 {
 689     p[1] = ( i_dw >>  8 )&0xff;
 690     p[0] = ( i_dw       )&0xff;
 691 }
 692
 693 #define SetDWLE( p, v ) _SetDWLE( (uint8_t*)(p), v)
 694 static inline void _SetDWLE( uint8_t *p, uint32_t i_dw )
 695 {
 696     p[3] = ( i_dw >> 24 )&0xff;
 697     p[2] = ( i_dw >> 16 )&0xff;
 698     p[1] = ( i_dw >>  8 )&0xff;
 699     p[0] = ( i_dw       )&0xff;
 700 }
 701 #define SetQWLE( p, v ) _SetQWLE( (uint8_t*)(p), v)
 702 static inline void _SetQWLE( uint8_t *p, uint64_t i_qw )
 703 {
 704     SetDWLE( p,   i_qw&0xffffffff );
 705     SetDWLE( p+4, ( i_qw >> 32)&0xffffffff );
 706 }
 707 #define SetWBE( p, v ) _SetWBE( (uint8_t*)(p), v)
 708 static inline void _SetWBE( uint8_t *p, uint16_t i_dw )
 709 {
 710     p[0] = ( i_dw >>  8 )&0xff;
 711     p[1] = ( i_dw       )&0xff;
 712 }
 713
 714 #define SetDWBE( p, v ) _SetDWBE( (uint8_t*)(p), v)
 715 static inline void _SetDWBE( uint8_t *p, uint32_t i_dw )
 716 {
 717     p[0] = ( i_dw >> 24 )&0xff;
 718     p[1] = ( i_dw >> 16 )&0xff;
 719     p[2] = ( i_dw >>  8 )&0xff;
 720     p[3] = ( i_dw       )&0xff;
 721 }
 722 #define SetQWBE( p, v ) _SetQWBE( (uint8_t*)(p), v)
 723 static inline void _SetQWBE( uint8_t *p, uint64_t i_qw )
 724 {
 725     SetDWBE( p+4,   i_qw&0xffffffff );
 726     SetDWBE( p, ( i_qw >> 32)&0xffffffff );
 727 }
 728
 729 #define hton16(i) htons(i)
 730 #define hton32(i) htonl(i)
 731 #define ntoh16(i) ntohs(i)
 732 #define ntoh32(i) ntohl(i)
 733
 734 LIBVLC_USED
 735 static inline uint64_t ntoh64 (uint64_t ll)
 736 {
 737     union { uint64_t qw; uint8_t b[16]; } v = { ll };
 738     return ((uint64_t)v.b[0] << 56)
 739          | ((uint64_t)v.b[1] << 48)
 740          | ((uint64_t)v.b[2] << 40)
 741          | ((uint64_t)v.b[3] << 32)
 742          | ((uint64_t)v.b[4] << 24)
 743          | ((uint64_t)v.b[5] << 16)
 744          | ((uint64_t)v.b[6] <<  8)
 745          | ((uint64_t)v.b[7] <<  0);
 746 }
 747 #define hton64(i) ntoh64(i)
 748
 749 /* */
 750 #define VLC_UNUSED(x) (void)(x)
 751
 752 /* Stuff defined in src/extras/libc.c */
 753
 754 #if defined(WIN32) || defined(UNDER_CE)
 755 /* win32, cl and icl support */
 756 #   if defined( _MSC_VER ) || !defined( __MINGW32__ )
 757 #       define __attribute__(x)
 758 #       define __inline__      __inline
 759 #       define S_IFBLK         0x3000  /* Block */
 760 #       define S_ISBLK(m)      (0)
 761 #       define S_ISCHR(m)      (0)
 762 #       define S_ISFIFO(m)     (((m)&_S_IFMT) == _S_IFIFO)
 763 #       define S_ISREG(m)      (((m)&_S_IFMT) == _S_IFREG)
 764 #   endif
 765
 766 /* several type definitions */
 767 #   if defined( __MINGW32__ )
 768 #       if !defined( _OFF_T_ )
 769             typedef long long _off_t;
 770             typedef _off_t off_t;
 771 #           define _OFF_T_
 772 #       else
 773 #           ifdef off_t
 774 #               undef off_t
 775 #           endif
 776 #           define off_t long long
 777 #       endif
 778 #   endif
 779
 780 #   if defined( _MSC_VER ) && !defined( __WXMSW__ )
 781 #       if !defined( _OFF_T_DEFINED )
 782             typedef __int64 off_t;
 783 #           define _OFF_T_DEFINED
 784 #       else
 785             /* for wx compatibility typedef long off_t; */
 786 #           define off_t __int64
 787 #       endif
 788 #   endif
 789
 790 #   if defined( __BORLANDC__ )
 791 #       undef off_t
 792 #       define off_t unsigned __int64
 793 #   endif
 794
 795 #   ifndef O_NONBLOCK
 796 #       define O_NONBLOCK 0
 797 #   endif
 798
 799 #   ifndef alloca
 800 #       define alloca _alloca
 801 #   endif
 802
 803 #   include <tchar.h>
 804 #endif
 805
 806 VLC_EXPORT( bool, vlc_ureduce, ( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t ) );
 807
 808 /* iconv wrappers (defined in src/extras/libc.c) */
 809 typedef void *vlc_iconv_t;
 810 VLC_EXPORT( vlc_iconv_t, vlc_iconv_open, ( const char *, const char * ) LIBVLC_USED );
 811 VLC_EXPORT( size_t, vlc_iconv, ( vlc_iconv_t, const char **, size_t *, char **, size_t * ) LIBVLC_USED );
 812 VLC_EXPORT( int, vlc_iconv_close, ( vlc_iconv_t ) );
 813
 814 /* execve wrapper (defined in src/extras/libc.c) */
 815 VLC_EXPORT( int, __vlc_execve, ( vlc_object_t *p_object, int i_argc, char *const *pp_argv, char *const *pp_env, const char *psz_cwd, const char *p_in, size_t i_in, char **pp_data, size_t *pi_data ) LIBVLC_USED );
 816 #define vlc_execve(a,b,c,d,e,f,g,h,i) __vlc_execve(VLC_OBJECT(a),b,c,d,e,f,g,h,i)
 817
 818 /* dir wrappers (defined in src/extras/libc.c) */
 819 VLC_EXPORT(int, vlc_wclosedir, ( void *_p_dir ));
 820
 821 /* Fast large memory copy and memory set */
 822 VLC_EXPORT( void *, vlc_memcpy, ( void *, const void *, size_t ) );
 823 VLC_EXPORT( void *, vlc_memset, ( void *, int, size_t ) );
 824
 825 /*****************************************************************************
 826  * I18n stuff
 827  *****************************************************************************/
 828 VLC_EXPORT( char *, vlc_gettext, ( const char *msgid ) LIBVLC_FORMAT_ARG(1) );
 829
 830 LIBVLC_FORMAT_ARG(2)
 831 static inline const char *vlc_pgettext( const char *ctx, const char *id )
 832 {
 833     const char *tr = vlc_gettext( id );
 834     return (tr == ctx) ? id : tr;
 835 }
 836
 837 /*****************************************************************************
 838  * Loosy memory allocation functions. Do not use in new code.
 839  *****************************************************************************/
 840 static inline void *xmalloc (size_t len)
 841 {
 842     void *ptr = malloc (len);
 843     if (unlikely (ptr == NULL))
 844         abort ();
 845     return ptr;
 846 }
 847
 848 static inline void *xrealloc (void *ptr, size_t len)
 849 {
 850     void *nptr = realloc (ptr, len);
 851     if (unlikely (nptr == NULL))
 852         abort ();
 853     return nptr;
 854 }
 855
 856 /*****************************************************************************
 857  * libvlc features
 858  *****************************************************************************/
 859 VLC_EXPORT( const char *, VLC_Version, ( void ) LIBVLC_USED );
 860 VLC_EXPORT( const char *, VLC_CompileBy, ( void ) LIBVLC_USED );
 861 VLC_EXPORT( const char *, VLC_CompileHost, ( void ) LIBVLC_USED );
 862 VLC_EXPORT( const char *, VLC_CompileDomain, ( void ) LIBVLC_USED );
 863 VLC_EXPORT( const char *, VLC_Compiler, ( void ) LIBVLC_USED );
 864
 865 /*****************************************************************************
 866  * Additional vlc stuff
 867  *****************************************************************************/
 868 #include "vlc_messages.h"
 869 #include "vlc_variables.h"
 870 #include "vlc_objects.h"
 871 #include "vlc_modules.h"
 872 #include "vlc_main.h"
 873 #include "vlc_configuration.h"
 874
 875 #if defined( WIN32 ) || defined( UNDER_CE )
 876 #   define DIR_SEP_CHAR '\\'
 877 #   define DIR_SEP "\\"
 878 #   define PATH_SEP_CHAR ';'
 879 #   define PATH_SEP ";"
 880 #else
 881 #   define DIR_SEP_CHAR '/'
 882 #   define DIR_SEP "/"
 883 #   define PATH_SEP_CHAR ':'
 884 #   define PATH_SEP ":"
 885 #endif
 886
 887 #define LICENSE_MSG \
 888   _("This program comes with NO WARRANTY, to the extent permitted by " \
 889     "law.\nYou may redistribute it under the terms of the GNU General " \
 890     "Public License;\nsee the file named COPYING for details.\n" \
 891     "Written by the VideoLAN team; see the AUTHORS file.\n")
 892
 893 #endif /* !VLC_COMMON_H */