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