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__ == 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 input_item_node_t input_item_node_t;
 216 typedef struct access_t access_t;
 217 typedef struct access_sys_t access_sys_t;
 218 typedef struct stream_t     stream_t;
 219 typedef struct stream_sys_t stream_sys_t;
 220 typedef struct demux_t  demux_t;
 221 typedef struct demux_sys_t demux_sys_t;
 222 typedef struct es_out_t     es_out_t;
 223 typedef struct es_out_id_t  es_out_id_t;
 224 typedef struct es_out_sys_t es_out_sys_t;
 225 typedef struct es_descriptor_t es_descriptor_t;
 226 typedef struct seekpoint_t seekpoint_t;
 227 typedef struct info_t info_t;
 228 typedef struct info_category_t info_category_t;
 229 typedef struct input_attachment_t input_attachment_t;
 230
 231 /* Format */
 232 typedef struct audio_format_t audio_format_t;
 233 typedef struct video_format_t video_format_t;
 234 typedef struct subs_format_t subs_format_t;
 235 typedef struct es_format_t es_format_t;
 236 typedef struct video_palette_t video_palette_t;
 237
 238 /* Audio */
 239 typedef struct aout_instance_t aout_instance_t;
 240 typedef struct aout_sys_t aout_sys_t;
 241 typedef struct aout_fifo_t aout_fifo_t;
 242 typedef struct aout_input_t aout_input_t;
 243 typedef struct block_t aout_buffer_t;
 244 typedef audio_format_t audio_sample_format_t;
 245 typedef struct audio_date_t audio_date_t;
 246 typedef struct aout_filter_t aout_filter_t;
 247
 248 /* Video */
 249 typedef struct vout_thread_t vout_thread_t;
 250 typedef struct vout_sys_t vout_sys_t;
 251
 252 typedef video_format_t video_frame_format_t;
 253 typedef struct picture_t picture_t;
 254 typedef struct picture_sys_t picture_sys_t;
 255 typedef struct picture_heap_t picture_heap_t;
 256
 257 /* Subpictures */
 258 typedef struct spu_t spu_t;
 259 typedef struct subpicture_t subpicture_t;
 260 typedef struct subpicture_sys_t subpicture_sys_t;
 261 typedef struct subpicture_region_t subpicture_region_t;
 262 typedef struct text_style_t text_style_t;
 263
 264 typedef struct image_handler_t image_handler_t;
 265
 266 /* Stream output */
 267 typedef struct sout_instance_t sout_instance_t;
 268 typedef struct sout_instance_sys_t sout_instance_sys_t;
 269
 270 typedef struct sout_input_t sout_input_t;
 271 typedef struct sout_packetizer_input_t sout_packetizer_input_t;
 272
 273 typedef struct sout_access_out_t sout_access_out_t;
 274 typedef struct sout_access_out_sys_t   sout_access_out_sys_t;
 275
 276 typedef struct sout_mux_t sout_mux_t;
 277 typedef struct sout_mux_sys_t sout_mux_sys_t;
 278
 279 typedef struct sout_stream_t    sout_stream_t;
 280 typedef struct sout_stream_sys_t sout_stream_sys_t;
 281
 282 typedef struct config_chain_t       config_chain_t;
 283 typedef struct session_descriptor_t session_descriptor_t;
 284 typedef struct announce_method_t announce_method_t;
 285
 286 typedef struct sout_param_t sout_param_t;
 287 typedef struct sout_pcat_t sout_pcat_t;
 288 typedef struct sout_std_t sout_std_t;
 289 typedef struct sout_display_t sout_display_t;
 290 typedef struct sout_duplicate_t sout_duplicate_t;
 291 typedef struct sout_transcode_t sout_transcode_t;
 292 typedef struct sout_chain_t sout_chain_t;
 293 typedef struct streaming_profile_t streaming_profile_t;
 294 typedef struct sout_module_t sout_module_t;
 295 typedef struct sout_gui_descr_t sout_gui_descr_t;
 296 typedef struct profile_parser_t profile_parser_t;
 297
 298 /* Decoders */
 299 typedef struct decoder_t         decoder_t;
 300 typedef struct decoder_sys_t     decoder_sys_t;
 301 typedef struct decoder_synchro_t decoder_synchro_t;
 302
 303 /* Encoders */
 304 typedef struct encoder_t      encoder_t;
 305 typedef struct encoder_sys_t  encoder_sys_t;
 306
 307 /* Filters */
 308 typedef struct filter_t filter_t;
 309 typedef struct filter_sys_t filter_sys_t;
 310
 311 /* Network */
 312 typedef struct network_socket_t network_socket_t;
 313 typedef struct virtual_socket_t v_socket_t;
 314 typedef struct sockaddr sockaddr;
 315 typedef struct addrinfo addrinfo;
 316 typedef struct vlc_acl_t vlc_acl_t;
 317 typedef struct vlc_url_t vlc_url_t;
 318
 319 /* Misc */
 320 typedef struct iso639_lang_t iso639_lang_t;
 321 typedef struct device_t device_t;
 322 typedef struct device_probe_t device_probe_t;
 323 typedef struct probe_sys_t probe_sys_t;
 324
 325 /* block */
 326 typedef struct block_t      block_t;
 327 typedef struct block_fifo_t block_fifo_t;
 328
 329 /* httpd */
 330 typedef struct httpd_t          httpd_t;
 331 typedef struct httpd_host_t     httpd_host_t;
 332 typedef struct httpd_url_t      httpd_url_t;
 333 typedef struct httpd_client_t   httpd_client_t;
 334 typedef struct httpd_callback_sys_t httpd_callback_sys_t;
 335 typedef struct httpd_message_t  httpd_message_t;
 336 typedef int    (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, const httpd_message_t *query );
 337 typedef struct httpd_file_t     httpd_file_t;
 338 typedef struct httpd_file_sys_t httpd_file_sys_t;
 339 typedef int (*httpd_file_callback_t)( httpd_file_sys_t *, httpd_file_t *, uint8_t *psz_request, uint8_t **pp_data, int *pi_data );
 340 typedef struct httpd_handler_t  httpd_handler_t;
 341 typedef struct httpd_handler_sys_t httpd_handler_sys_t;
 342 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 );
 343 typedef struct httpd_redirect_t httpd_redirect_t;
 344 typedef struct httpd_stream_t httpd_stream_t;
 345
 346 /* TLS support */
 347 typedef struct tls_server_t tls_server_t;
 348 typedef struct tls_session_t tls_session_t;
 349
 350 /* Hashing */
 351 typedef struct md5_s md5_t;
 352
 353 /* XML */
 354 typedef struct xml_t xml_t;
 355 typedef struct xml_sys_t xml_sys_t;
 356 typedef struct xml_reader_t xml_reader_t;
 357 typedef struct xml_reader_sys_t xml_reader_sys_t;
 358
 359 /* vod server */
 360 typedef struct vod_t     vod_t;
 361 typedef struct vod_sys_t vod_sys_t;
 362 typedef struct vod_media_t vod_media_t;
 363
 364 /* opengl */
 365 typedef struct opengl_t     opengl_t;
 366 typedef struct opengl_sys_t opengl_sys_t;
 367
 368 /* osdmenu */
 369 typedef struct osd_menu_t   osd_menu_t;
 370 typedef struct osd_state_t  osd_state_t;
 371 typedef struct osd_event_t  osd_event_t;
 372 typedef struct osd_button_t osd_button_t;
 373 typedef struct osd_menu_state_t osd_menu_state_t;
 374
 375 /* VLM */
 376 typedef struct vlm_t         vlm_t;
 377 typedef struct vlm_message_t vlm_message_t;
 378
 379 /* misc */
 380 typedef struct vlc_meta_t    vlc_meta_t;
 381
 382 /* Stats */
 383 typedef struct counter_t     counter_t;
 384 typedef struct counter_sample_t counter_sample_t;
 385 typedef struct stats_handler_t stats_handler_t;
 386 typedef struct input_stats_t input_stats_t;
 387
 388 /* Update */
 389 typedef struct update_t update_t;
 390 typedef struct update_iterator_t update_iterator_t;
 391
 392 /* Meta engine */
 393 typedef struct meta_engine_t meta_engine_t;
 394
 395 /* stat/lstat/fstat */
 396 #ifdef WIN32
 397 #include <sys/stat.h>
 398
 399 # ifndef UNDER_CE
 400 struct _stati64;
 401 #define stat _stati64
 402 #define fstat _fstati64
 403 #endif
 404
 405 /* You should otherwise use vlc_stat and utf8_lstat. */
 406 #else
 407 struct stat;
 408 #endif
 409
 410 /**
 411  * VLC value structure
 412  */
 413 typedef union
 414 {
 415     int             i_int;
 416     bool            b_bool;
 417     float           f_float;
 418     char *          psz_string;
 419     void *          p_address;
 420     vlc_object_t *  p_object;
 421     vlc_list_t *    p_list;
 422     mtime_t         i_time;
 423     struct { int32_t x; int32_t y; } coords;
 424
 425     /* Make sure the structure is at least 64bits */
 426     uint8_t padding[8];
 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 #define VLC_VAR_COORDS    0x00A0
 461 /**@}*/
 462
 463 /*****************************************************************************
 464  * Error values (shouldn't be exposed)
 465  *****************************************************************************/
 466 #define VLC_SUCCESS         -0                                   /* No error */
 467 #define VLC_ENOMEM          -1                          /* Not enough memory */
 468 #define VLC_ETIMEOUT        -3                                    /* Timeout */
 469
 470 #define VLC_ENOMOD         -10                           /* Module not found */
 471
 472 #define VLC_ENOOBJ         -20                           /* Object not found */
 473
 474 #define VLC_ENOVAR         -30                         /* Variable not found */
 475 #define VLC_EBADVAR        -31                         /* Bad variable value */
 476
 477 #define VLC_ENOITEM        -40                           /**< Item not found */
 478
 479 #define VLC_EEXIT         -255                             /* Program exited */
 480 #define VLC_EEXITSUCCESS  -999                /* Program exited successfully */
 481 #define VLC_EGENERIC      -666                              /* Generic error */
 482
 483 /*****************************************************************************
 484  * Variable callbacks
 485  *****************************************************************************/
 486 typedef int ( * vlc_callback_t ) ( vlc_object_t *,      /* variable's object */
 487                                    char const *,            /* variable name */
 488                                    vlc_value_t,                 /* old value */
 489                                    vlc_value_t,                 /* new value */
 490                                    void * );                /* callback data */
 491
 492 /*****************************************************************************
 493  * Plug-in stuff
 494  *****************************************************************************/
 495
 496 #ifdef __cplusplus
 497 # define LIBVLC_EXTERN extern "C"
 498 #else
 499 # define LIBVLC_EXTERN extern
 500 #endif
 501 #if defined (WIN32) && defined (DLL_EXPORT)
 502 #if defined (UNDER_CE)
 503 # include <windef.h>
 504 #endif
 505 # define LIBVLC_EXPORT __declspec(dllexport)
 506 #else
 507 # define LIBVLC_EXPORT
 508 #endif
 509 #define VLC_EXPORT( type, name, args ) \
 510                         LIBVLC_EXTERN LIBVLC_EXPORT type name args
 511
 512 /*****************************************************************************
 513  * OS-specific headers and thread types
 514  *****************************************************************************/
 515 #if defined( WIN32 ) || defined( UNDER_CE )
 516 #   define WIN32_LEAN_AND_MEAN
 517 #   include <windows.h>
 518 #endif
 519
 520 #include "vlc_mtime.h"
 521 #include "vlc_threads.h"
 522
 523 /*****************************************************************************
 524  * Common structure members
 525  *****************************************************************************/
 526
 527 /* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
 528 #define VLC_COMMON_MEMBERS                                                  \
 529 /** \name VLC_COMMON_MEMBERS                                                \
 530  * these members are common for all vlc objects                             \
 531  */                                                                         \
 532 /**@{*/                                                                     \
 533     const char *psz_object_type;                                            \
 534                                                                             \
 535     /* Messages header */                                                   \
 536     char *psz_header;                                                       \
 537     int  i_flags;                                                           \
 538                                                                             \
 539     /* Object properties */                                                 \
 540     volatile bool b_die;                   /**< set by the outside */ \
 541     bool b_force;      /**< set by the outside (eg. module_need()) */ \
 542                                                                             \
 543     /* Stuff related to the libvlc structure */                             \
 544     libvlc_int_t *p_libvlc;                  /**< (root of all evil) - 1 */ \
 545                                                                             \
 546     vlc_object_t *  p_parent;                            /**< our parent */ \
 547                                                                             \
 548 /**@}*/                                                                     \
 549
 550 /* VLC_OBJECT: attempt at doing a clever cast */
 551 #if defined( __GNUC__ ) && __GNUC__ > 3
 552 # ifndef __cplusplus
 553 #  define VLC_OBJECT( x ) \
 554     __builtin_choose_expr(__builtin_offsetof(__typeof__(*x), psz_object_type), \
 555                           (void)0 /* screw you */, (vlc_object_t *)(x))
 556 # else
 557 #  define VLC_OBJECT( x ) \
 558     ((vlc_object_t *)(x) \
 559       + 0 * __builtin_offsetof(__typeof__(*x), psz_object_type))
 560 # endif
 561 #else
 562 # define VLC_OBJECT( x ) ((vlc_object_t *)(x))
 563 #endif
 564
 565 typedef struct gc_object_t
 566 {
 567     vlc_spinlock_t spin;
 568     uintptr_t      refs;
 569     void          (*pf_destructor) (struct gc_object_t *);
 570 } gc_object_t;
 571
 572 /**
 573  * These members are common to all objects that wish to be garbage-collected.
 574  */
 575 #define VLC_GC_MEMBERS gc_object_t vlc_gc_data;
 576
 577 VLC_EXPORT(void *, vlc_gc_init, (gc_object_t *, void (*)(gc_object_t *)));
 578 VLC_EXPORT(void *, vlc_hold, (gc_object_t *));
 579 VLC_EXPORT(void, vlc_release, (gc_object_t *));
 580
 581 #define vlc_gc_init( a,b ) vlc_gc_init( &(a)->vlc_gc_data, (b) )
 582 #define vlc_gc_incref( a ) vlc_hold( &(a)->vlc_gc_data )
 583 #define vlc_gc_decref( a ) vlc_release( &(a)->vlc_gc_data )
 584 #define vlc_priv( gc, t ) ((t *)(((char *)(gc)) - offsetof(t, vlc_gc_data)))
 585
 586 /*****************************************************************************
 587  * Macros and inline functions
 588  *****************************************************************************/
 589
 590 /* CEIL: division with round to nearest greater integer */
 591 #define CEIL(n, d)  ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
 592
 593 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
 594 #define PAD(n, d)   ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
 595
 596 /* __MAX and __MIN: self explanatory */
 597 #ifndef __MAX
 598 #   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
 599 #endif
 600 #ifndef __MIN
 601 #   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
 602 #endif
 603
 604 LIBVLC_USED
 605 static inline int64_t GCD ( int64_t a, int64_t b )
 606 {
 607     while( b )
 608     {
 609         int64_t c = a % b;
 610         a = b;
 611         b = c;
 612     }
 613     return a;
 614 }
 615
 616 /* function imported from libavutil/common.h */
 617 LIBVLC_USED
 618 static inline uint8_t clip_uint8_vlc( int32_t a )
 619 {
 620     if( a&(~255) ) return (-a)>>31;
 621     else           return a;
 622 }
 623
 624 /* Count leading zeroes */
 625 LIBVLC_USED
 626 static inline unsigned clz (unsigned x)
 627 {
 628 #ifdef __GNUC_
 629     return __builtin_clz (x);
 630 #else
 631     unsigned i = sizeof (x) * 8;
 632
 633     while (x)
 634     {
 635         x = x >> 1;
 636         i--;
 637     }
 638     return i;
 639 #endif
 640 }
 641
 642 #define clz8( x ) (clz(x) - ((sizeof(unsigned) - sizeof (uint8_t)) * 8))
 643 #define clz16( x ) (clz(x) - ((sizeof(unsigned) - sizeof (uint16_t)) * 8))
 644 /* XXX: this assumes that int is 32-bits or more */
 645 #define clz32( x ) (clz(x) - ((sizeof(unsigned) - sizeof (uint32_t)) * 8))
 646
 647 /* Free and set set the variable to NULL */
 648 #define FREENULL(a) do { free( a ); a = NULL; } while(0)
 649
 650 #define EMPTY_STR(str) (!str || !*str)
 651
 652 VLC_EXPORT( char const *, vlc_error, ( int ) LIBVLC_USED );
 653
 654 #include <vlc_arrays.h>
 655
 656 /* MSB (big endian)/LSB (little endian) conversions - network order is always
 657  * MSB, and should be used for both network communications and files. */
 658 LIBVLC_USED
 659 static inline uint16_t U16_AT( const void * _p )
 660 {
 661     const uint8_t * p = (const uint8_t *)_p;
 662     return ( ((uint16_t)p[0] << 8) | p[1] );
 663 }
 664
 665 LIBVLC_USED
 666 static inline uint32_t U32_AT( const void * _p )
 667 {
 668     const uint8_t * p = (const uint8_t *)_p;
 669     return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
 670               | ((uint32_t)p[2] << 8) | p[3] );
 671 }
 672
 673 LIBVLC_USED
 674 static inline uint64_t U64_AT( const void * _p )
 675 {
 676     const uint8_t * p = (const uint8_t *)_p;
 677     return ( ((uint64_t)p[0] << 56) | ((uint64_t)p[1] << 48)
 678               | ((uint64_t)p[2] << 40) | ((uint64_t)p[3] << 32)
 679               | ((uint64_t)p[4] << 24) | ((uint64_t)p[5] << 16)
 680               | ((uint64_t)p[6] << 8) | p[7] );
 681 }
 682
 683 LIBVLC_USED
 684 static inline uint16_t GetWLE( const void * _p )
 685 {
 686     const uint8_t * p = (const uint8_t *)_p;
 687     return ( ((uint16_t)p[1] << 8) | p[0] );
 688 }
 689
 690 LIBVLC_USED
 691 static inline uint32_t GetDWLE( const void * _p )
 692 {
 693     const uint8_t * p = (const uint8_t *)_p;
 694     return ( ((uint32_t)p[3] << 24) | ((uint32_t)p[2] << 16)
 695               | ((uint32_t)p[1] << 8) | p[0] );
 696 }
 697
 698 LIBVLC_USED
 699 static inline uint64_t GetQWLE( const void * _p )
 700 {
 701     const uint8_t * p = (const uint8_t *)_p;
 702     return ( ((uint64_t)p[7] << 56) | ((uint64_t)p[6] << 48)
 703               | ((uint64_t)p[5] << 40) | ((uint64_t)p[4] << 32)
 704               | ((uint64_t)p[3] << 24) | ((uint64_t)p[2] << 16)
 705               | ((uint64_t)p[1] << 8) | p[0] );
 706 }
 707
 708 #define GetWBE( p )     U16_AT( p )
 709 #define GetDWBE( p )    U32_AT( p )
 710 #define GetQWBE( p )    U64_AT( p )
 711
 712 /* Helper writer functions */
 713 #define SetWLE( p, v ) _SetWLE( (uint8_t*)(p), v)
 714 static inline void _SetWLE( uint8_t *p, uint16_t i_dw )
 715 {
 716     p[1] = ( i_dw >>  8 )&0xff;
 717     p[0] = ( i_dw       )&0xff;
 718 }
 719
 720 #define SetDWLE( p, v ) _SetDWLE( (uint8_t*)(p), v)
 721 static inline void _SetDWLE( uint8_t *p, uint32_t i_dw )
 722 {
 723     p[3] = ( i_dw >> 24 )&0xff;
 724     p[2] = ( i_dw >> 16 )&0xff;
 725     p[1] = ( i_dw >>  8 )&0xff;
 726     p[0] = ( i_dw       )&0xff;
 727 }
 728 #define SetQWLE( p, v ) _SetQWLE( (uint8_t*)(p), v)
 729 static inline void _SetQWLE( uint8_t *p, uint64_t i_qw )
 730 {
 731     SetDWLE( p,   i_qw&0xffffffff );
 732     SetDWLE( p+4, ( i_qw >> 32)&0xffffffff );
 733 }
 734 #define SetWBE( p, v ) _SetWBE( (uint8_t*)(p), v)
 735 static inline void _SetWBE( uint8_t *p, uint16_t i_dw )
 736 {
 737     p[0] = ( i_dw >>  8 )&0xff;
 738     p[1] = ( i_dw       )&0xff;
 739 }
 740
 741 #define SetDWBE( p, v ) _SetDWBE( (uint8_t*)(p), v)
 742 static inline void _SetDWBE( uint8_t *p, uint32_t i_dw )
 743 {
 744     p[0] = ( i_dw >> 24 )&0xff;
 745     p[1] = ( i_dw >> 16 )&0xff;
 746     p[2] = ( i_dw >>  8 )&0xff;
 747     p[3] = ( i_dw       )&0xff;
 748 }
 749 #define SetQWBE( p, v ) _SetQWBE( (uint8_t*)(p), v)
 750 static inline void _SetQWBE( uint8_t *p, uint64_t i_qw )
 751 {
 752     SetDWBE( p+4,   i_qw&0xffffffff );
 753     SetDWBE( p, ( i_qw >> 32)&0xffffffff );
 754 }
 755
 756 #define hton16(i) htons(i)
 757 #define hton32(i) htonl(i)
 758 #define ntoh16(i) ntohs(i)
 759 #define ntoh32(i) ntohl(i)
 760
 761 LIBVLC_USED
 762 static inline uint64_t ntoh64 (uint64_t ll)
 763 {
 764     union { uint64_t qw; uint8_t b[16]; } v = { ll };
 765     return ((uint64_t)v.b[0] << 56)
 766          | ((uint64_t)v.b[1] << 48)
 767          | ((uint64_t)v.b[2] << 40)
 768          | ((uint64_t)v.b[3] << 32)
 769          | ((uint64_t)v.b[4] << 24)
 770          | ((uint64_t)v.b[5] << 16)
 771          | ((uint64_t)v.b[6] <<  8)
 772          | ((uint64_t)v.b[7] <<  0);
 773 }
 774 #define hton64(i) ntoh64(i)
 775
 776 /* */
 777 #define VLC_UNUSED(x) (void)(x)
 778
 779 /* Stuff defined in src/extras/libc.c */
 780
 781 #if defined(WIN32) || defined(UNDER_CE)
 782 /* win32, cl and icl support */
 783 #   if defined( _MSC_VER ) || !defined( __MINGW32__ )
 784 #       define __attribute__(x)
 785 #       define __inline__      __inline
 786 #       define S_IFBLK         0x3000  /* Block */
 787 #       define S_ISBLK(m)      (0)
 788 #       define S_ISCHR(m)      (0)
 789 #       define S_ISFIFO(m)     (((m)&_S_IFMT) == _S_IFIFO)
 790 #       define S_ISREG(m)      (((m)&_S_IFMT) == _S_IFREG)
 791 #   endif
 792
 793 /* several type definitions */
 794 #   if defined( __MINGW32__ )
 795 #       if !defined( _OFF_T_ )
 796             typedef long long _off_t;
 797             typedef _off_t off_t;
 798 #           define _OFF_T_
 799 #       else
 800 #           ifdef off_t
 801 #               undef off_t
 802 #           endif
 803 #           define off_t long long
 804 #       endif
 805 #   endif
 806
 807 #   if defined( _MSC_VER ) && !defined( __WXMSW__ )
 808 #       if !defined( _OFF_T_DEFINED )
 809             typedef __int64 off_t;
 810 #           define _OFF_T_DEFINED
 811 #       else
 812             /* for wx compatibility typedef long off_t; */
 813 #           define off_t __int64
 814 #       endif
 815 #   endif
 816
 817 #   if defined( __BORLANDC__ )
 818 #       undef off_t
 819 #       define off_t unsigned __int64
 820 #   endif
 821
 822 #   ifndef O_NONBLOCK
 823 #       define O_NONBLOCK 0
 824 #   endif
 825
 826 #   ifndef alloca
 827 #       define alloca _alloca
 828 #   endif
 829
 830 #   include <tchar.h>
 831 #endif
 832
 833 VLC_EXPORT( bool, vlc_ureduce, ( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t ) );
 834
 835 /* iconv wrappers (defined in src/extras/libc.c) */
 836 typedef void *vlc_iconv_t;
 837 VLC_EXPORT( vlc_iconv_t, vlc_iconv_open, ( const char *, const char * ) LIBVLC_USED );
 838 VLC_EXPORT( size_t, vlc_iconv, ( vlc_iconv_t, const char **, size_t *, char **, size_t * ) LIBVLC_USED );
 839 VLC_EXPORT( int, vlc_iconv_close, ( vlc_iconv_t ) );
 840
 841 /* execve wrapper (defined in src/extras/libc.c) */
 842 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 );
 843 #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)
 844
 845 /* dir wrappers (defined in src/extras/libc.c) */
 846 VLC_EXPORT(int, vlc_wclosedir, ( void *_p_dir ));
 847
 848 VLC_EXPORT( void, vlc_tdestroy, ( void *, void (*)(void *) ) );
 849
 850 /* Fast large memory copy and memory set */
 851 VLC_EXPORT( void *, vlc_memcpy, ( void *, const void *, size_t ) );
 852 VLC_EXPORT( void *, vlc_memset, ( void *, int, size_t ) );
 853
 854 /*****************************************************************************
 855  * I18n stuff
 856  *****************************************************************************/
 857 VLC_EXPORT( char *, vlc_gettext, ( const char *msgid ) LIBVLC_FORMAT_ARG(1) );
 858
 859 LIBVLC_FORMAT_ARG(2)
 860 static inline const char *vlc_pgettext( const char *ctx, const char *id )
 861 {
 862     const char *tr = vlc_gettext( id );
 863     return (tr == ctx) ? id : tr;
 864 }
 865
 866 /*****************************************************************************
 867  * Loosy memory allocation functions. Do not use in new code.
 868  *****************************************************************************/
 869 static inline void *xmalloc (size_t len)
 870 {
 871     void *ptr = malloc (len);
 872     if (unlikely (ptr == NULL))
 873         abort ();
 874     return ptr;
 875 }
 876
 877 static inline void *xrealloc (void *ptr, size_t len)
 878 {
 879     void *nptr = realloc (ptr, len);
 880     if (unlikely (nptr == NULL))
 881         abort ();
 882     return nptr;
 883 }
 884
 885 /*****************************************************************************
 886  * libvlc features
 887  *****************************************************************************/
 888 VLC_EXPORT( const char *, VLC_Version, ( void ) LIBVLC_USED );
 889 VLC_EXPORT( const char *, VLC_CompileBy, ( void ) LIBVLC_USED );
 890 VLC_EXPORT( const char *, VLC_CompileHost, ( void ) LIBVLC_USED );
 891 VLC_EXPORT( const char *, VLC_Compiler, ( void ) LIBVLC_USED );
 892
 893 /*****************************************************************************
 894  * Additional vlc stuff
 895  *****************************************************************************/
 896 #include "vlc_messages.h"
 897 #include "vlc_objects.h"
 898 #include "vlc_variables.h"
 899 #include "vlc_modules.h"
 900 #include "vlc_main.h"
 901 #include "vlc_configuration.h"
 902
 903 #if defined( WIN32 ) || defined( UNDER_CE )
 904 #   define DIR_SEP_CHAR '\\'
 905 #   define DIR_SEP "\\"
 906 #   define PATH_SEP_CHAR ';'
 907 #   define PATH_SEP ";"
 908 #else
 909 #   define DIR_SEP_CHAR '/'
 910 #   define DIR_SEP "/"
 911 #   define PATH_SEP_CHAR ':'
 912 #   define PATH_SEP ":"
 913 #endif
 914
 915 #define LICENSE_MSG \
 916   _("This program comes with NO WARRANTY, to the extent permitted by " \
 917     "law.\nYou may redistribute it under the terms of the GNU General " \
 918     "Public License;\nsee the file named COPYING for details.\n" \
 919     "Written by the VideoLAN team; see the AUTHORS file.\n")
 920
 921 #endif /* !VLC_COMMON_H */