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 #   if __GNUC__ > 3 || (__GNUC__ == 3 && (__GNUC_MINOR__ >= 4))
  84 #     define LIBVLC_USED __attribute__ ((warn_unused_result))
  85 #   else
  86 #     define LIBVLC_USED
  87 #   endif
  88 #   define LIBVLC_MALLOC __attribute__ ((malloc))
  89 #else
  90 #   define LIBVLC_FORMAT(x,y)
  91 #   define LIBVLC_FORMAT_ARG(x)
  92 #   define LIBVLC_USED
  93 #   define LIBVLC_MALLOC
  94 #endif
  95
  96 /* Branch prediction */
  97 #ifdef __GNUC__
  98 #   define likely(p)   __builtin_expect(!!(p), 1)
  99 #   define unlikely(p) __builtin_expect(!!(p), 0)
 100 #else
 101 #   define likely(p)   (!!(p))
 102 #   define unlikely(p) (!!(p))
 103 #endif
 104
 105 /*****************************************************************************
 106  * Basic types definitions
 107  *****************************************************************************/
 108 #if defined( WIN32 ) || defined( UNDER_CE )
 109 #   include <malloc.h>
 110 #   ifndef PATH_MAX
 111 #       define PATH_MAX MAX_PATH
 112 #   endif
 113 #endif
 114
 115 /* Counter for statistics and profiling */
 116 typedef unsigned long       count_t;
 117
 118 /* Audio volume */
 119 typedef uint16_t            audio_volume_t;
 120
 121 /**
 122  * High precision date or time interval
 123  *
 124  * Store a high precision date or time interval. The maximum precision is the
 125  * microsecond, and a 64 bits integer is used to avoid overflows (maximum
 126  * time interval is then 292271 years, which should be long enough for any
 127  * video). Dates are stored as microseconds since a common date (usually the
 128  * epoch). Note that date and time intervals can be manipulated using regular
 129  * arithmetic operators, and that no special functions are required.
 130  */
 131 typedef int64_t mtime_t;
 132
 133 /**
 134  * The vlc_fourcc_t type.
 135  *
 136  * See http://www.webartz.com/fourcc/ for a very detailed list.
 137  */
 138 typedef uint32_t vlc_fourcc_t;
 139
 140 #ifdef WORDS_BIGENDIAN
 141 #   define VLC_FOURCC( a, b, c, d ) \
 142         ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
 143            | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
 144 #   define VLC_TWOCC( a, b ) \
 145         ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )
 146
 147 #else
 148 #   define VLC_FOURCC( a, b, c, d ) \
 149         ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
 150            | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
 151 #   define VLC_TWOCC( a, b ) \
 152         ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )
 153
 154 #endif
 155
 156 /**
 157  * Translate a vlc_fourcc into its string representation. This function
 158  * assumes there is enough room in psz_fourcc to store 4 characters in.
 159  *
 160  * \param fcc a vlc_fourcc_t
 161  * \param psz_fourcc string to store string representation of vlc_fourcc in
 162  */
 163 static inline void vlc_fourcc_to_char( vlc_fourcc_t fcc, char *psz_fourcc )
 164 {
 165     memcpy( psz_fourcc, &fcc, 4 );
 166 }
 167
 168 #define vlc_fourcc_to_char( a, b ) \
 169         vlc_fourcc_to_char( (vlc_fourcc_t)(a), (char *)(b) )
 170
 171 /*****************************************************************************
 172  * Classes declaration
 173  *****************************************************************************/
 174
 175 /* Internal types */
 176 typedef struct vlc_list_t vlc_list_t;
 177 typedef struct vlc_object_t vlc_object_t;
 178 typedef struct libvlc_int_t libvlc_int_t;
 179 typedef struct date_t date_t;
 180 typedef struct dict_entry_t dict_entry_t;
 181 typedef struct dict_t dict_t;
 182
 183 /* Playlist */
 184
 185 /* FIXME */
 186 /**
 187  * Playlist commands
 188  */
 189 typedef enum {
 190     PLAYLIST_PLAY,      /**< No arg.                            res=can fail*/
 191     PLAYLIST_VIEWPLAY,  /**< arg1= playlist_item_t*,*/
 192                         /**  arg2 = playlist_item_t*          , res=can fail */
 193     PLAYLIST_PAUSE,     /**< No arg                             res=can fail*/
 194     PLAYLIST_STOP,      /**< No arg                             res=can fail*/
 195     PLAYLIST_SKIP,      /**< arg1=int,                          res=can fail*/
 196 } playlist_command_t;
 197
 198
 199 typedef struct playlist_t playlist_t;
 200 typedef struct playlist_item_t playlist_item_t;
 201 typedef struct playlist_view_t playlist_view_t;
 202 typedef struct services_discovery_t services_discovery_t;
 203 typedef struct services_discovery_sys_t services_discovery_sys_t;
 204 typedef struct playlist_add_t playlist_add_t;
 205
 206 /* Modules */
 207 typedef struct module_bank_t module_bank_t;
 208 typedef struct module_t module_t;
 209 typedef struct module_config_t module_config_t;
 210 typedef struct module_symbols_t module_symbols_t;
 211 typedef struct module_cache_t module_cache_t;
 212
 213 typedef struct config_category_t config_category_t;
 214
 215 /* Input */
 216 typedef struct input_thread_t input_thread_t;
 217 typedef struct input_thread_sys_t input_thread_sys_t;
 218 typedef struct input_item_t input_item_t;
 219 typedef struct input_item_node_t input_item_node_t;
 220 typedef struct access_t access_t;
 221 typedef struct access_sys_t access_sys_t;
 222 typedef struct stream_t     stream_t;
 223 typedef struct stream_sys_t stream_sys_t;
 224 typedef struct demux_t  demux_t;
 225 typedef struct demux_sys_t demux_sys_t;
 226 typedef struct es_out_t     es_out_t;
 227 typedef struct es_out_id_t  es_out_id_t;
 228 typedef struct es_out_sys_t es_out_sys_t;
 229 typedef struct es_descriptor_t es_descriptor_t;
 230 typedef struct seekpoint_t seekpoint_t;
 231 typedef struct info_t info_t;
 232 typedef struct info_category_t info_category_t;
 233 typedef struct input_attachment_t input_attachment_t;
 234
 235 /* Format */
 236 typedef struct audio_format_t audio_format_t;
 237 typedef struct video_format_t video_format_t;
 238 typedef struct subs_format_t subs_format_t;
 239 typedef struct es_format_t es_format_t;
 240 typedef struct video_palette_t video_palette_t;
 241
 242 /* Audio */
 243 typedef struct aout_instance_t aout_instance_t;
 244 typedef struct aout_sys_t aout_sys_t;
 245 typedef struct aout_fifo_t aout_fifo_t;
 246 typedef struct aout_input_t aout_input_t;
 247 typedef struct block_t aout_buffer_t;
 248 typedef audio_format_t audio_sample_format_t;
 249 typedef struct audio_date_t audio_date_t;
 250 typedef struct aout_filter_t aout_filter_t;
 251
 252 /* Video */
 253 typedef struct vout_thread_t vout_thread_t;
 254
 255 typedef video_format_t video_frame_format_t;
 256 typedef struct picture_t picture_t;
 257 typedef struct picture_sys_t picture_sys_t;
 258
 259 /* Subpictures */
 260 typedef struct spu_t spu_t;
 261 typedef struct subpicture_t subpicture_t;
 262 typedef struct subpicture_sys_t subpicture_sys_t;
 263 typedef struct subpicture_region_t subpicture_region_t;
 264
 265 typedef struct image_handler_t image_handler_t;
 266
 267 /* Stream output */
 268 typedef struct sout_instance_t sout_instance_t;
 269 typedef struct sout_instance_sys_t sout_instance_sys_t;
 270
 271 typedef struct sout_input_t sout_input_t;
 272 typedef struct sout_packetizer_input_t sout_packetizer_input_t;
 273
 274 typedef struct sout_access_out_t sout_access_out_t;
 275 typedef struct sout_access_out_sys_t   sout_access_out_sys_t;
 276
 277 typedef struct sout_mux_t sout_mux_t;
 278 typedef struct sout_mux_sys_t sout_mux_sys_t;
 279
 280 typedef struct sout_stream_t    sout_stream_t;
 281 typedef struct sout_stream_sys_t sout_stream_sys_t;
 282
 283 typedef struct config_chain_t       config_chain_t;
 284 typedef struct session_descriptor_t session_descriptor_t;
 285 typedef struct announce_method_t announce_method_t;
 286
 287 typedef struct sout_param_t sout_param_t;
 288 typedef struct sout_pcat_t sout_pcat_t;
 289 typedef struct sout_std_t sout_std_t;
 290 typedef struct sout_display_t sout_display_t;
 291 typedef struct sout_duplicate_t sout_duplicate_t;
 292 typedef struct sout_transcode_t sout_transcode_t;
 293 typedef struct sout_chain_t sout_chain_t;
 294 typedef struct streaming_profile_t streaming_profile_t;
 295 typedef struct sout_module_t sout_module_t;
 296 typedef struct sout_gui_descr_t sout_gui_descr_t;
 297 typedef struct profile_parser_t profile_parser_t;
 298
 299 /* Decoders */
 300 typedef struct decoder_t         decoder_t;
 301 typedef struct decoder_sys_t     decoder_sys_t;
 302 typedef struct decoder_synchro_t decoder_synchro_t;
 303
 304 /* Encoders */
 305 typedef struct encoder_t      encoder_t;
 306 typedef struct encoder_sys_t  encoder_sys_t;
 307
 308 /* Filters */
 309 typedef struct filter_t filter_t;
 310 typedef struct filter_sys_t filter_sys_t;
 311
 312 /* Network */
 313 typedef struct network_socket_t network_socket_t;
 314 typedef struct virtual_socket_t v_socket_t;
 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 vlc_stat and vlc_lstat. */
 405 #else
 406 struct stat;
 407 #endif
 408
 409 /**
 410  * VLC value structure
 411  */
 412 typedef union
 413 {
 414     int64_t         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     struct { int32_t x; int32_t y; } coords;
 423
 424 } vlc_value_t;
 425
 426 /**
 427  * VLC list structure
 428  */
 429 struct vlc_list_t
 430 {
 431     int             i_count;
 432     vlc_value_t *   p_values;
 433     int *           pi_types;
 434
 435 };
 436
 437 /**
 438  * \defgroup var_type Variable types
 439  * These are the different types a vlc variable can have.
 440  * @{
 441  */
 442 #define VLC_VAR_VOID      0x0010
 443 #define VLC_VAR_BOOL      0x0020
 444 #define VLC_VAR_INTEGER   0x0030
 445 #define VLC_VAR_HOTKEY    0x0031
 446 #define VLC_VAR_STRING    0x0040
 447 #define VLC_VAR_MODULE    0x0041
 448 #define VLC_VAR_FILE      0x0042
 449 #define VLC_VAR_DIRECTORY 0x0043
 450 #define VLC_VAR_VARIABLE  0x0044
 451 #define VLC_VAR_FLOAT     0x0050
 452 #define VLC_VAR_TIME      0x0060
 453 #define VLC_VAR_ADDRESS   0x0070
 454 #define VLC_VAR_MUTEX     0x0080
 455 #define VLC_VAR_COORDS    0x00A0
 456 /**@}*/
 457
 458 /*****************************************************************************
 459  * Error values (shouldn't be exposed)
 460  *****************************************************************************/
 461 #define VLC_SUCCESS         -0                                   /* No error */
 462 #define VLC_ENOMEM          -1                          /* Not enough memory */
 463 #define VLC_ETIMEOUT        -3                                    /* Timeout */
 464
 465 #define VLC_ENOMOD         -10                           /* Module not found */
 466
 467 #define VLC_ENOOBJ         -20                           /* Object not found */
 468
 469 #define VLC_ENOVAR         -30                         /* Variable not found */
 470 #define VLC_EBADVAR        -31                         /* Bad variable value */
 471
 472 #define VLC_ENOITEM        -40                           /**< Item not found */
 473
 474 #define VLC_EEXIT         -255                             /* Program exited */
 475 #define VLC_EEXITSUCCESS  -999                /* Program exited successfully */
 476 #define VLC_EGENERIC      -666                              /* Generic error */
 477
 478 /*****************************************************************************
 479  * Variable callbacks
 480  *****************************************************************************/
 481 typedef int ( * vlc_callback_t ) ( vlc_object_t *,      /* variable's object */
 482                                    char const *,            /* variable name */
 483                                    vlc_value_t,                 /* old value */
 484                                    vlc_value_t,                 /* new value */
 485                                    void * );                /* callback data */
 486
 487 /*****************************************************************************
 488  * Plug-in stuff
 489  *****************************************************************************/
 490
 491 #ifdef __cplusplus
 492 # define LIBVLC_EXTERN extern "C"
 493 #else
 494 # define LIBVLC_EXTERN extern
 495 #endif
 496 #if defined (WIN32) && defined (DLL_EXPORT)
 497 #if defined (UNDER_CE)
 498 # include <windef.h>
 499 #endif
 500 # define LIBVLC_EXPORT __declspec(dllexport)
 501 #else
 502 # define LIBVLC_EXPORT
 503 #endif
 504 #define VLC_EXPORT( type, name, args ) \
 505                         LIBVLC_EXTERN LIBVLC_EXPORT type name args
 506
 507 /*****************************************************************************
 508  * OS-specific headers and thread types
 509  *****************************************************************************/
 510 #if defined( WIN32 ) || defined( UNDER_CE )
 511 #   define WIN32_LEAN_AND_MEAN
 512 #   include <windows.h>
 513 #endif
 514
 515 #include "vlc_mtime.h"
 516 #include "vlc_threads.h"
 517
 518 /**
 519  * Memory storage space for an atom. Never access it directly.
 520  */
 521 typedef union
 522 {
 523     volatile uintptr_t u;
 524     volatile intptr_t  s;
 525 } vlc_atomic_t;
 526
 527 /*****************************************************************************
 528  * Common structure members
 529  *****************************************************************************/
 530
 531 /* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
 532 #define VLC_COMMON_MEMBERS                                                  \
 533 /** \name VLC_COMMON_MEMBERS                                                \
 534  * these members are common for all vlc objects                             \
 535  */                                                                         \
 536 /**@{*/                                                                     \
 537     const char *psz_object_type;                                            \
 538                                                                             \
 539     /* Messages header */                                                   \
 540     char *psz_header;                                                       \
 541     int  i_flags;                                                           \
 542                                                                             \
 543     /* Object properties */                                                 \
 544     volatile bool b_die;                   /**< set by the outside */ \
 545     bool b_force;      /**< set by the outside (eg. module_need()) */ \
 546                                                                             \
 547     /* Stuff related to the libvlc structure */                             \
 548     libvlc_int_t *p_libvlc;                  /**< (root of all evil) - 1 */ \
 549                                                                             \
 550     vlc_object_t *  p_parent;                            /**< our parent */ \
 551                                                                             \
 552 /**@}*/                                                                     \
 553
 554 /* VLC_OBJECT: attempt at doing a clever cast */
 555 #if defined( __GNUC__ ) && __GNUC__ > 3
 556 # ifndef __cplusplus
 557 #  define VLC_OBJECT( x ) \
 558     __builtin_choose_expr(__builtin_offsetof(__typeof__(*x), psz_object_type), \
 559                           (void)0 /* screw you */, (vlc_object_t *)(x))
 560 # else
 561 #  define VLC_OBJECT( x ) \
 562     ((vlc_object_t *)(x) \
 563       + 0 * __builtin_offsetof(__typeof__(*x), psz_object_type))
 564 # endif
 565 #else
 566 # define VLC_OBJECT( x ) ((vlc_object_t *)(x))
 567 #endif
 568
 569 typedef struct gc_object_t
 570 {
 571     vlc_atomic_t    refs;
 572     void          (*pf_destructor) (struct gc_object_t *);
 573 } gc_object_t;
 574
 575 /**
 576  * These members are common to all objects that wish to be garbage-collected.
 577  */
 578 #define VLC_GC_MEMBERS gc_object_t vlc_gc_data;
 579
 580 VLC_EXPORT(void *, vlc_gc_init, (gc_object_t *, void (*)(gc_object_t *)));
 581 VLC_EXPORT(void *, vlc_hold, (gc_object_t *));
 582 VLC_EXPORT(void, vlc_release, (gc_object_t *));
 583
 584 #define vlc_gc_init( a,b ) vlc_gc_init( &(a)->vlc_gc_data, (b) )
 585 #define vlc_gc_incref( a ) vlc_hold( &(a)->vlc_gc_data )
 586 #define vlc_gc_decref( a ) vlc_release( &(a)->vlc_gc_data )
 587 #define vlc_priv( gc, t ) ((t *)(((char *)(gc)) - offsetof(t, vlc_gc_data)))
 588
 589 /*****************************************************************************
 590  * Macros and inline functions
 591  *****************************************************************************/
 592
 593 /* CEIL: division with round to nearest greater integer */
 594 #define CEIL(n, d)  ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
 595
 596 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
 597 #define PAD(n, d)   ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
 598
 599 /* __MAX and __MIN: self explanatory */
 600 #ifndef __MAX
 601 #   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
 602 #endif
 603 #ifndef __MIN
 604 #   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
 605 #endif
 606
 607 LIBVLC_USED
 608 static inline int64_t GCD ( int64_t a, int64_t b )
 609 {
 610     while( b )
 611     {
 612         int64_t c = a % b;
 613         a = b;
 614         b = c;
 615     }
 616     return a;
 617 }
 618
 619 /* function imported from libavutil/common.h */
 620 LIBVLC_USED
 621 static inline uint8_t clip_uint8_vlc( int32_t a )
 622 {
 623     if( a&(~255) ) return (-a)>>31;
 624     else           return a;
 625 }
 626
 627 /* Count leading zeroes */
 628 LIBVLC_USED
 629 static inline unsigned clz (unsigned x)
 630 {
 631 #ifdef __GNUC_
 632     return __builtin_clz (x);
 633 #else
 634     unsigned i = sizeof (x) * 8;
 635
 636     while (x)
 637     {
 638         x = x >> 1;
 639         i--;
 640     }
 641     return i;
 642 #endif
 643 }
 644
 645 #define clz8( x ) (clz(x) - ((sizeof(unsigned) - sizeof (uint8_t)) * 8))
 646 #define clz16( x ) (clz(x) - ((sizeof(unsigned) - sizeof (uint16_t)) * 8))
 647 /* XXX: this assumes that int is 32-bits or more */
 648 #define clz32( x ) (clz(x) - ((sizeof(unsigned) - sizeof (uint32_t)) * 8))
 649
 650 /* Free and set set the variable to NULL */
 651 #define FREENULL(a) do { free( a ); a = NULL; } while(0)
 652
 653 #define EMPTY_STR(str) (!str || !*str)
 654
 655 VLC_EXPORT( char const *, vlc_error, ( int ) LIBVLC_USED );
 656
 657 #include <vlc_arrays.h>
 658
 659 /* MSB (big endian)/LSB (little endian) conversions - network order is always
 660  * MSB, and should be used for both network communications and files. */
 661 LIBVLC_USED
 662 static inline uint16_t U16_AT( const void * _p )
 663 {
 664     const uint8_t * p = (const uint8_t *)_p;
 665     return ( ((uint16_t)p[0] << 8) | p[1] );
 666 }
 667
 668 LIBVLC_USED
 669 static inline uint32_t U32_AT( const void * _p )
 670 {
 671     const uint8_t * p = (const uint8_t *)_p;
 672     return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
 673               | ((uint32_t)p[2] << 8) | p[3] );
 674 }
 675
 676 LIBVLC_USED
 677 static inline uint64_t U64_AT( const void * _p )
 678 {
 679     const uint8_t * p = (const uint8_t *)_p;
 680     return ( ((uint64_t)p[0] << 56) | ((uint64_t)p[1] << 48)
 681               | ((uint64_t)p[2] << 40) | ((uint64_t)p[3] << 32)
 682               | ((uint64_t)p[4] << 24) | ((uint64_t)p[5] << 16)
 683               | ((uint64_t)p[6] << 8) | p[7] );
 684 }
 685
 686 LIBVLC_USED
 687 static inline uint16_t GetWLE( const void * _p )
 688 {
 689     const uint8_t * p = (const uint8_t *)_p;
 690     return ( ((uint16_t)p[1] << 8) | p[0] );
 691 }
 692
 693 LIBVLC_USED
 694 static inline uint32_t GetDWLE( const void * _p )
 695 {
 696     const uint8_t * p = (const uint8_t *)_p;
 697     return ( ((uint32_t)p[3] << 24) | ((uint32_t)p[2] << 16)
 698               | ((uint32_t)p[1] << 8) | p[0] );
 699 }
 700
 701 LIBVLC_USED
 702 static inline uint64_t GetQWLE( const void * _p )
 703 {
 704     const uint8_t * p = (const uint8_t *)_p;
 705     return ( ((uint64_t)p[7] << 56) | ((uint64_t)p[6] << 48)
 706               | ((uint64_t)p[5] << 40) | ((uint64_t)p[4] << 32)
 707               | ((uint64_t)p[3] << 24) | ((uint64_t)p[2] << 16)
 708               | ((uint64_t)p[1] << 8) | p[0] );
 709 }
 710
 711 #define GetWBE( p )     U16_AT( p )
 712 #define GetDWBE( p )    U32_AT( p )
 713 #define GetQWBE( p )    U64_AT( p )
 714
 715 /* Helper writer functions */
 716 #define SetWLE( p, v ) _SetWLE( (uint8_t*)(p), v)
 717 static inline void _SetWLE( uint8_t *p, uint16_t i_dw )
 718 {
 719     p[1] = ( i_dw >>  8 )&0xff;
 720     p[0] = ( i_dw       )&0xff;
 721 }
 722
 723 #define SetDWLE( p, v ) _SetDWLE( (uint8_t*)(p), v)
 724 static inline void _SetDWLE( uint8_t *p, uint32_t i_dw )
 725 {
 726     p[3] = ( i_dw >> 24 )&0xff;
 727     p[2] = ( i_dw >> 16 )&0xff;
 728     p[1] = ( i_dw >>  8 )&0xff;
 729     p[0] = ( i_dw       )&0xff;
 730 }
 731 #define SetQWLE( p, v ) _SetQWLE( (uint8_t*)(p), v)
 732 static inline void _SetQWLE( uint8_t *p, uint64_t i_qw )
 733 {
 734     SetDWLE( p,   i_qw&0xffffffff );
 735     SetDWLE( p+4, ( i_qw >> 32)&0xffffffff );
 736 }
 737 #define SetWBE( p, v ) _SetWBE( (uint8_t*)(p), v)
 738 static inline void _SetWBE( uint8_t *p, uint16_t i_dw )
 739 {
 740     p[0] = ( i_dw >>  8 )&0xff;
 741     p[1] = ( i_dw       )&0xff;
 742 }
 743
 744 #define SetDWBE( p, v ) _SetDWBE( (uint8_t*)(p), v)
 745 static inline void _SetDWBE( uint8_t *p, uint32_t i_dw )
 746 {
 747     p[0] = ( i_dw >> 24 )&0xff;
 748     p[1] = ( i_dw >> 16 )&0xff;
 749     p[2] = ( i_dw >>  8 )&0xff;
 750     p[3] = ( i_dw       )&0xff;
 751 }
 752 #define SetQWBE( p, v ) _SetQWBE( (uint8_t*)(p), v)
 753 static inline void _SetQWBE( uint8_t *p, uint64_t i_qw )
 754 {
 755     SetDWBE( p+4,   i_qw&0xffffffff );
 756     SetDWBE( p, ( i_qw >> 32)&0xffffffff );
 757 }
 758
 759 #define hton16(i) htons(i)
 760 #define hton32(i) htonl(i)
 761 #define ntoh16(i) ntohs(i)
 762 #define ntoh32(i) ntohl(i)
 763
 764 LIBVLC_USED
 765 static inline uint64_t ntoh64 (uint64_t ll)
 766 {
 767     union { uint64_t qw; uint8_t b[16]; } v = { ll };
 768     return ((uint64_t)v.b[0] << 56)
 769          | ((uint64_t)v.b[1] << 48)
 770          | ((uint64_t)v.b[2] << 40)
 771          | ((uint64_t)v.b[3] << 32)
 772          | ((uint64_t)v.b[4] << 24)
 773          | ((uint64_t)v.b[5] << 16)
 774          | ((uint64_t)v.b[6] <<  8)
 775          | ((uint64_t)v.b[7] <<  0);
 776 }
 777 #define hton64(i) ntoh64(i)
 778
 779 /* */
 780 #define VLC_UNUSED(x) (void)(x)
 781
 782 /* Stuff defined in src/extras/libc.c */
 783
 784 #if defined(WIN32) || defined(UNDER_CE)
 785 /* win32, cl and icl support */
 786 #   if defined( _MSC_VER ) || !defined( __MINGW32__ )
 787 #       define __attribute__(x)
 788 #       define __inline__      __inline
 789 #       define S_IFBLK         0x3000  /* Block */
 790 #       define S_ISBLK(m)      (0)
 791 #       define S_ISCHR(m)      (0)
 792 #       define S_ISFIFO(m)     (((m)&_S_IFMT) == _S_IFIFO)
 793 #       define S_ISREG(m)      (((m)&_S_IFMT) == _S_IFREG)
 794 #   endif
 795
 796 /* several type definitions */
 797 #   if defined( __MINGW32__ )
 798 #       if !defined( _OFF_T_ )
 799             typedef long long _off_t;
 800             typedef _off_t off_t;
 801 #           define _OFF_T_
 802 #       else
 803 #           ifdef off_t
 804 #               undef off_t
 805 #           endif
 806 #           define off_t long long
 807 #       endif
 808 #   endif
 809
 810 #   if defined( _MSC_VER ) && !defined( __WXMSW__ )
 811 #       if !defined( _OFF_T_DEFINED )
 812             typedef __int64 off_t;
 813 #           define _OFF_T_DEFINED
 814 #       else
 815             /* for wx compatibility typedef long off_t; */
 816 #           define off_t __int64
 817 #       endif
 818 #   endif
 819
 820 #   if defined( __BORLANDC__ )
 821 #       undef off_t
 822 #       define off_t unsigned __int64
 823 #   endif
 824
 825 #   ifndef O_NONBLOCK
 826 #       define O_NONBLOCK 0
 827 #   endif
 828
 829 #   ifndef alloca
 830 #       define alloca _alloca
 831 #   endif
 832
 833 #   include <tchar.h>
 834 #endif
 835
 836 VLC_EXPORT( bool, vlc_ureduce, ( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t ) );
 837
 838 VLC_EXPORT( void *, vlc_memalign, ( void **base, size_t alignment, size_t size ) LIBVLC_USED );
 839
 840 /* execve wrapper (defined in src/extras/libc.c) */
 841 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 );
 842 #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)
 843
 844 VLC_EXPORT( void, vlc_tdestroy, ( void *, void (*)(void *) ) );
 845
 846 /* Fast large memory copy and memory set */
 847 VLC_EXPORT( void *, vlc_memcpy, ( void *, const void *, size_t ) );
 848 VLC_EXPORT( void *, vlc_memset, ( void *, int, size_t ) );
 849
 850 /*****************************************************************************
 851  * I18n stuff
 852  *****************************************************************************/
 853 VLC_EXPORT( char *, vlc_gettext, ( const char *msgid ) LIBVLC_FORMAT_ARG(1) );
 854
 855 #define vlc_pgettext( ctx, id ) \
 856         vlc_pgettext_aux( ctx "\004" id, id )
 857
 858 LIBVLC_FORMAT_ARG(2)
 859 static inline const char *vlc_pgettext_aux( const char *ctx, const char *id )
 860 {
 861     const char *tr = vlc_gettext( ctx );
 862     return (tr == ctx) ? id : tr;
 863 }
 864
 865 /*****************************************************************************
 866  * Loosy memory allocation functions. Do not use in new code.
 867  *****************************************************************************/
 868 static inline void *xmalloc (size_t len)
 869 {
 870     void *ptr = malloc (len);
 871     if (unlikely (ptr == NULL))
 872         abort ();
 873     return ptr;
 874 }
 875
 876 static inline void *xrealloc (void *ptr, size_t len)
 877 {
 878     void *nptr = realloc (ptr, len);
 879     if (unlikely (nptr == NULL))
 880         abort ();
 881     return nptr;
 882 }
 883
 884 /*****************************************************************************
 885  * libvlc features
 886  *****************************************************************************/
 887 VLC_EXPORT( const char *, VLC_Version, ( void ) LIBVLC_USED );
 888 VLC_EXPORT( const char *, VLC_CompileBy, ( void ) LIBVLC_USED );
 889 VLC_EXPORT( const char *, VLC_CompileHost, ( void ) LIBVLC_USED );
 890 VLC_EXPORT( const char *, VLC_Compiler, ( void ) LIBVLC_USED );
 891
 892 /*****************************************************************************
 893  * Additional vlc stuff
 894  *****************************************************************************/
 895 #include "vlc_messages.h"
 896 #include "vlc_objects.h"
 897 #include "vlc_variables.h"
 898 #include "vlc_main.h"
 899 #include "vlc_configuration.h"
 900
 901 #if defined( WIN32 ) || defined( UNDER_CE )
 902 #   define DIR_SEP_CHAR '\\'
 903 #   define DIR_SEP "\\"
 904 #   define PATH_SEP_CHAR ';'
 905 #   define PATH_SEP ";"
 906 #else
 907 #   define DIR_SEP_CHAR '/'
 908 #   define DIR_SEP "/"
 909 #   define PATH_SEP_CHAR ':'
 910 #   define PATH_SEP ":"
 911 #endif
 912
 913 #define LICENSE_MSG \
 914   _("This program comes with NO WARRANTY, to the extent permitted by " \
 915     "law.\nYou may redistribute it under the terms of the GNU General " \
 916     "Public License;\nsee the file named COPYING for details.\n" \
 917     "Written by the VideoLAN team; see the AUTHORS file.\n")
 918
 919 #endif /* !VLC_COMMON_H */