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