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