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