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