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