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 #ifdef HAVE_SYS_TYPES_H
  52 #   include <sys/types.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 libvlc_int_t libvlc_int_t;
 126 typedef struct variable_t variable_t;
 127 typedef struct date_t date_t;
 128 typedef struct dict_entry_t dict_entry_t;
 129 typedef struct dict_t dict_t;
 130 typedef struct gc_object_t gc_object_t ;
 131
 132 /* Messages */
 133 typedef struct msg_bank_t msg_bank_t;
 134 typedef struct msg_queue_t msg_queue_t;
 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  * Variable callbacks
 385  *****************************************************************************/
 386 typedef int ( * vlc_callback_t ) ( vlc_object_t *,      /* variable's object */
 387                                    char const *,            /* variable name */
 388                                    vlc_value_t,                 /* old value */
 389                                    vlc_value_t,                 /* new value */
 390                                    void * );                /* callback data */
 391
 392 /*****************************************************************************
 393  * Plug-in stuff
 394  *****************************************************************************/
 395
 396 #include "vlc_modules_macros.h"
 397
 398 #if defined (WIN32) && defined (DLL_EXPORT)
 399 #  ifdef __cplusplus
 400 #    define VLC_PUBLIC_API extern "C" __declspec(dllexport)
 401 #    define VLC_PRIVATE_API extern "C" __declspec(dllexport)
 402 #    define   VLC_EXPORT( type, name, args ) extern "C" __declspec(dllexport) type name args
 403 #    define VLC_INTERNAL( type, name, args ) extern "C" type name args
 404 #  else
 405 #    define VLC_PUBLIC_API extern __declspec(dllexport)
 406 #    define VLC_PRIVATE_API extern __declspec(dllexport)
 407 #    define   VLC_EXPORT( type, name, args ) __declspec(dllexport) type name args
 408 #    define VLC_INTERNAL( type, name, args ) type name args
 409 #  endif
 410 #else
 411 #  ifdef __cplusplus
 412 #    ifdef HAVE_ATTRIBUTE_VISIBILITY
 413 #      define VLC_PUBLIC_API extern "C" __attribute__((visibility("default")))
 414 #      define VLC_PRIVATE_API extern "C" __attribute__((visibility("default")))
 415 #      define   VLC_EXPORT( type, name, args ) extern "C" __attribute__((visibility("default"))) type name args
 416 #      define VLC_INTERNAL( type, name, args ) extern "C" __attribute__((visibility("hidden"))) type name args
 417 #    else
 418 #      define VLC_PUBLIC_API extern "C"
 419 #      define   VLC_EXPORT( type, name, args ) extern "C" type name args
 420 #      define VLC_INTERNAL( type, name, args ) extern "C" type name args
 421 #    endif
 422 #  else
 423 #    ifdef HAVE_ATTRIBUTE_VISIBILITY
 424 #      define VLC_PUBLIC_API extern __attribute__((visibility("default")))
 425 #      define VLC_PRIVATE_API extern __attribute__((visibility("default")))
 426 #      define   VLC_EXPORT( type, name, args ) __attribute__((visibility("default"))) type name args
 427 #      define VLC_INTERNAL( type, name, args ) __attribute__((visibility("hidden"))) type name args
 428 #    else
 429 #      define VLC_PUBLIC_API extern
 430 #      define VLC_PRIVATE_API extern
 431 #      define   VLC_EXPORT( type, name, args ) extern type name args
 432 #      define VLC_INTERNAL( type, name, args ) type name args
 433 #    endif
 434 #  endif
 435 #endif
 436
 437 /*****************************************************************************
 438  * OS-specific headers and thread types
 439  *****************************************************************************/
 440 #if defined( WIN32 ) || defined( UNDER_CE )
 441 #   define WIN32_LEAN_AND_MEAN
 442 #   include <windows.h>
 443 #   if defined( UNDER_CE )
 444 #      define IS_WINNT 0
 445 #   else
 446 #      define IS_WINNT ( GetVersion() < 0x80000000 )
 447 #   endif
 448 #endif
 449
 450 #include "vlc_threads.h"
 451
 452 typedef struct vlc_object_internals_t vlc_object_internals_t;
 453
 454 /*****************************************************************************
 455  * Common structure members
 456  *****************************************************************************/
 457
 458 /* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
 459 #define VLC_COMMON_MEMBERS                                                  \
 460 /** \name VLC_COMMON_MEMBERS                                                \
 461  * these members are common for all vlc objects                             \
 462  */                                                                         \
 463 /**@{*/                                                                     \
 464     int   i_object_id;                                                      \
 465     int   i_object_type;                                                    \
 466     const char *psz_object_type;                                            \
 467     char *psz_object_name;                                                  \
 468                                                                             \
 469     /* Messages header */                                                   \
 470     char *psz_header;                                                       \
 471     int  i_flags;                                                           \
 472                                                                             \
 473     /* Object access lock */                                                \
 474     vlc_mutex_t  object_lock;                                               \
 475     vlc_cond_t   object_wait;                                               \
 476                                                                             \
 477     /* Object properties */                                                 \
 478     volatile bool b_error;                  /**< set by the object */ \
 479     volatile bool b_die;                   /**< set by the outside */ \
 480     volatile bool b_dead;                   /**< set by the object */ \
 481     bool b_force;      /**< set by the outside (eg. module_Need()) */ \
 482                                                                             \
 483     /* Stuff related to the libvlc structure */                             \
 484     libvlc_int_t *p_libvlc;                  /**< (root of all evil) - 1 */ \
 485                                                                             \
 486     vlc_object_t *  p_parent;                            /**< our parent */ \
 487     vlc_object_t ** pp_children;                       /**< our children */ \
 488     volatile int    i_children;                                             \
 489                                                                             \
 490     /* Private data */                                                      \
 491     void *          p_private;                                              \
 492                                                                             \
 493     /** Just a reminder so that people don't cast garbage */                \
 494     int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct;                        \
 495 /**@}*/                                                                     \
 496
 497 /* VLC_OBJECT: attempt at doing a clever cast */
 498 #define VLC_OBJECT( x ) \
 499     ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
 500
 501 #define VLC_GC_MEMBERS                                                       \
 502 /** \name VLC_GC_MEMBERS                                                     \
 503  * these members are common to all objects that wish to be garbage-collected \
 504  */                                                                          \
 505 /**@{*/                                                                      \
 506     int i_gc_refcount;                                                       \
 507     void (*pf_destructor) ( gc_object_t * );                                 \
 508     void *p_destructor_arg;                                                  \
 509 /**@}*/
 510
 511 struct gc_object_t
 512 {
 513             VLC_GC_MEMBERS
 514 };
 515
 516 static inline void __vlc_gc_incref( gc_object_t * p_gc )
 517 {
 518     p_gc->i_gc_refcount ++;
 519 };
 520
 521 static inline void __vlc_gc_decref( gc_object_t *p_gc )
 522 {
 523     if( !p_gc ) return;
 524
 525     p_gc->i_gc_refcount -- ;
 526
 527     if( p_gc->i_gc_refcount == 0 )
 528     {
 529         p_gc->pf_destructor( p_gc );
 530         /* Do not use the p_gc pointer from now on ! */
 531     }
 532 }
 533
 534 static inline void
 535 __vlc_gc_init( gc_object_t * p_gc, void (*pf_destructor)( gc_object_t * ),
 536                void * arg)
 537 {
 538     p_gc->i_gc_refcount = 1;
 539     p_gc->pf_destructor = pf_destructor;
 540     p_gc->p_destructor_arg = arg;
 541 }
 542
 543 #define vlc_gc_incref( a ) __vlc_gc_incref( (gc_object_t *)a )
 544 #define vlc_gc_decref( a ) __vlc_gc_decref( (gc_object_t *)a )
 545 #define vlc_gc_init( a,b,c ) __vlc_gc_init( (gc_object_t *)a,b,c )
 546
 547
 548 /*****************************************************************************
 549  * Macros and inline functions
 550  *****************************************************************************/
 551 #ifdef NTOHL_IN_SYS_PARAM_H
 552 #   include <sys/param.h>
 553
 554 #elif !defined(WIN32) && !defined( UNDER_CE )
 555 #   include <netinet/in.h>
 556
 557 #endif /* NTOHL_IN_SYS_PARAM_H || WIN32 */
 558
 559 /* CEIL: division with round to nearest greater integer */
 560 #define CEIL(n, d)  ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
 561
 562 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
 563 #define PAD(n, d)   ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
 564
 565 /* __MAX and __MIN: self explanatory */
 566 #ifndef __MAX
 567 #   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
 568 #endif
 569 #ifndef __MIN
 570 #   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
 571 #endif
 572
 573 static inline int64_t GCD( int64_t a, int64_t b )
 574 {
 575     while( b )
 576     {
 577         int64_t c = a % b;
 578         a = b;
 579         b = c;
 580     }
 581     return a;
 582 }
 583
 584 /* function imported from libavutil/common.h */
 585 static inline uint8_t clip_uint8_vlc( int32_t a )
 586 {
 587     if( a&(~255) ) return (-a)>>31;
 588     else           return a;
 589 }
 590
 591 /* Malloc with automatic error */
 592 #define MALLOC_VOID( var, type ) do { var = (type*)malloc( sizeof( type) ); \
 593                                    if( !var ) return; } while(0)
 594 #define MALLOC_NULL( var, type ) do { var = (type*)malloc( sizeof( type) ); \
 595                                    if( !var ) return NULL; } while(0)
 596 #define MALLOC_ERR( var, type ) do { var = (type*)malloc( sizeof( type) ); \
 597                                    if( !var ) return VLC_ENOMEM; } while(0)
 598 #define MALLOC_GOTOERR( var, type ) do { var = (type*)malloc( sizeof( type) ); \
 599                                       if( !var ) goto error; } while(0)
 600 #define DECMALLOC_VOID( var, type ) type* var = (type*)malloc( sizeof(type) );\
 601                                     if( !var ) return;
 602 #define DECMALLOC_ERR( var, type )  type* var = (type*)malloc( sizeof(type) );\
 603                                     if( !var ) return VLC_ENOMEM;
 604 #define DECMALLOC_NULL( var, type ) type* var = (type*)malloc( sizeof(type) );\
 605                                     if( !var ) return NULL;
 606
 607 #define FREENULL(a) do { free( a ); a = NULL; } while(0)
 608
 609 #define EMPTY_STR(str) (!str || !*str)
 610
 611 VLC_EXPORT( char const *, vlc_error, ( int ) );
 612
 613 #include <vlc_arrays.h>
 614
 615 /* MSB (big endian)/LSB (little endian) conversions - network order is always
 616  * MSB, and should be used for both network communications and files. Note that
 617  * byte orders other than little and big endians are not supported, but only
 618  * the VAX seems to have such exotic properties. */
 619 static inline uint16_t U16_AT( const void * _p )
 620 {
 621     const uint8_t * p = (const uint8_t *)_p;
 622     return ( ((uint16_t)p[0] << 8) | p[1] );
 623 }
 624 static inline uint32_t U32_AT( const void * _p )
 625 {
 626     const uint8_t * p = (const uint8_t *)_p;
 627     return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
 628               | ((uint32_t)p[2] << 8) | p[3] );
 629 }
 630 static inline uint64_t U64_AT( const void * _p )
 631 {
 632     const uint8_t * p = (const uint8_t *)_p;
 633     return ( ((uint64_t)p[0] << 56) | ((uint64_t)p[1] << 48)
 634               | ((uint64_t)p[2] << 40) | ((uint64_t)p[3] << 32)
 635               | ((uint64_t)p[4] << 24) | ((uint64_t)p[5] << 16)
 636               | ((uint64_t)p[6] << 8) | p[7] );
 637 }
 638
 639 static inline uint16_t GetWLE( const void * _p )
 640 {
 641     const uint8_t * p = (const uint8_t *)_p;
 642     return ( ((uint16_t)p[1] << 8) | p[0] );
 643 }
 644 static inline uint32_t GetDWLE( const void * _p )
 645 {
 646     const uint8_t * p = (const uint8_t *)_p;
 647     return ( ((uint32_t)p[3] << 24) | ((uint32_t)p[2] << 16)
 648               | ((uint32_t)p[1] << 8) | p[0] );
 649 }
 650 static inline uint64_t GetQWLE( const void * _p )
 651 {
 652     const uint8_t * p = (const uint8_t *)_p;
 653     return ( ((uint64_t)p[7] << 56) | ((uint64_t)p[6] << 48)
 654               | ((uint64_t)p[5] << 40) | ((uint64_t)p[4] << 32)
 655               | ((uint64_t)p[3] << 24) | ((uint64_t)p[2] << 16)
 656               | ((uint64_t)p[1] << 8) | p[0] );
 657 }
 658
 659 #define GetWBE( p )     U16_AT( p )
 660 #define GetDWBE( p )    U32_AT( p )
 661 #define GetQWBE( p )    U64_AT( p )
 662
 663 /* Helper writer functions */
 664 #define SetWLE( p, v ) _SetWLE( (uint8_t*)(p), v)
 665 static inline void _SetWLE( uint8_t *p, uint16_t i_dw )
 666 {
 667     p[1] = ( i_dw >>  8 )&0xff;
 668     p[0] = ( i_dw       )&0xff;
 669 }
 670
 671 #define SetDWLE( p, v ) _SetDWLE( (uint8_t*)(p), v)
 672 static inline void _SetDWLE( uint8_t *p, uint32_t i_dw )
 673 {
 674     p[3] = ( i_dw >> 24 )&0xff;
 675     p[2] = ( i_dw >> 16 )&0xff;
 676     p[1] = ( i_dw >>  8 )&0xff;
 677     p[0] = ( i_dw       )&0xff;
 678 }
 679 #define SetQWLE( p, v ) _SetQWLE( (uint8_t*)(p), v)
 680 static inline void _SetQWLE( uint8_t *p, uint64_t i_qw )
 681 {
 682     SetDWLE( p,   i_qw&0xffffffff );
 683     SetDWLE( p+4, ( i_qw >> 32)&0xffffffff );
 684 }
 685 #define SetWBE( p, v ) _SetWBE( (uint8_t*)(p), v)
 686 static inline void _SetWBE( uint8_t *p, uint16_t i_dw )
 687 {
 688     p[0] = ( i_dw >>  8 )&0xff;
 689     p[1] = ( i_dw       )&0xff;
 690 }
 691
 692 #define SetDWBE( p, v ) _SetDWBE( (uint8_t*)(p), v)
 693 static inline void _SetDWBE( uint8_t *p, uint32_t i_dw )
 694 {
 695     p[0] = ( i_dw >> 24 )&0xff;
 696     p[1] = ( i_dw >> 16 )&0xff;
 697     p[2] = ( i_dw >>  8 )&0xff;
 698     p[3] = ( i_dw       )&0xff;
 699 }
 700 #define SetQWBE( p, v ) _SetQWBE( (uint8_t*)(p), v)
 701 static inline void _SetQWBE( uint8_t *p, uint64_t i_qw )
 702 {
 703     SetDWBE( p+4,   i_qw&0xffffffff );
 704     SetDWBE( p, ( i_qw >> 32)&0xffffffff );
 705 }
 706
 707 #ifdef WORDS_BIGENDIAN
 708 #   define hton16(i)   ( i )
 709 #   define hton32(i)   ( i )
 710 #   define hton64(i)   ( i )
 711 #   define ntoh16(i)   ( i )
 712 #   define ntoh32(i)   ( i )
 713 #   define ntoh64(i)   ( i )
 714 #else
 715 #   define hton16(i)   U16_AT(&i)
 716 #   define hton32(i)   U32_AT(&i)
 717 #   define hton64(i)   U64_AT(&i)
 718 #   define ntoh16(i)   U16_AT(&i)
 719 #   define ntoh32(i)   U32_AT(&i)
 720 #   define ntoh64(i)   U64_AT(&i)
 721 #endif
 722
 723 /* Format string sanity checks */
 724 #ifdef HAVE_ATTRIBUTE_FORMAT
 725 #   define ATTRIBUTE_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
 726 #else
 727 #   define ATTRIBUTE_FORMAT(x,y)
 728 #endif
 729
 730 /* Alignment of critical static data structures */
 731 #ifdef ATTRIBUTE_ALIGNED_MAX
 732 #   define ATTR_ALIGN(align) __attribute__ ((__aligned__ ((ATTRIBUTE_ALIGNED_MAX < align) ? ATTRIBUTE_ALIGNED_MAX : align)))
 733 #else
 734 #   define ATTR_ALIGN(align)
 735 #endif
 736
 737 #ifdef HAVE_ATTRIBUTE_PACKED
 738 #   define ATTR_PACKED __attribute__((__packed__))
 739 #endif
 740
 741 /* */
 742 #define VLC_UNUSED(x) (void)(x)
 743
 744 /* Stuff defined in src/extras/libc.c */
 745 VLC_EXPORT( char *, vlc_strdup, ( const char *s ) );
 746 VLC_EXPORT( int, vlc_vasprintf, (char **, const char *, va_list ) );
 747 VLC_EXPORT( int, vlc_asprintf, (char **, const char *, ... ) ATTRIBUTE_FORMAT( 2, 3 ) );
 748 VLC_EXPORT( char *, vlc_strndup, ( const char *s, size_t n ) );
 749 VLC_EXPORT( size_t, vlc_strlcpy, ( char *, const char *, size_t ) );
 750 VLC_EXPORT( double, vlc_atof, ( const char *nptr ) );
 751 VLC_EXPORT( int64_t, vlc_atoll, ( const char *nptr ) );
 752 VLC_EXPORT( int64_t, vlc_strtoll, ( const char *nptr, char **endptr, int base ) );
 753 VLC_EXPORT( size_t, vlc_strnlen, ( const char *, size_t ) );
 754
 755 #if defined(SYS_BEOS) \
 756  || (defined (__FreeBSD__) && (__FreeBSD__ < 5))
 757     typedef struct {
 758         long long quot; /* Quotient. */
 759         long long rem;  /* Remainder. */
 760     } lldiv_t;
 761 #endif
 762 VLC_EXPORT( lldiv_t, vlc_lldiv, ( long long numer, long long denom ) );
 763
 764 struct dirent;
 765 VLC_EXPORT( int, vlc_scandir, ( const char *name, struct dirent ***namelist, int (*filter) ( const struct dirent * ), int (*compar) ( const struct dirent **, const struct dirent ** ) ) );
 766 VLC_EXPORT( int, vlc_alphasort, ( const struct dirent **a, const struct dirent **b ) );
 767
 768 VLC_EXPORT( char *, vlc_getenv, ( const char *name ) );
 769
 770 VLC_EXPORT( int, vlc_strcasecmp, ( const char *s1, const char *s2 ) );
 771 VLC_EXPORT( int, vlc_strncasecmp, ( const char *s1, const char *s2, size_t n ) );
 772 VLC_EXPORT( char *, vlc_strcasestr, ( const char *s1, const char *s2 ) );
 773
 774 #if defined (WIN32)
 775 #   include <dirent.h>
 776  VLC_INTERNAL( void *, vlc_wopendir, ( const wchar_t * ) );
 777  VLC_INTERNAL( struct _wdirent *, vlc_wreaddir, ( void * ) );
 778  VLC_EXPORT( int, vlc_wclosedir, ( void * ) );
 779  VLC_INTERNAL( void, vlc_rewinddir, ( void * ) );
 780  VLC_INTERNAL( void, vlc_seekdir, ( void *, long ) );
 781  VLC_INTERNAL( long, vlc_telldir, ( void * ) );
 782 #   define opendir Use_utf8_opendir_or_vlc_wopendir_instead!
 783 #   define readdir Use_utf8_readdir_or_vlc_wreaddir_instead!
 784 #   define closedir vlc_wclosedir
 785 #   define _wopendir vlc_wopendir
 786 #   define _wreaddir vlc_wreaddir
 787 #   define _wclosedir vlc_wclosedir
 788 #   define rewinddir vlc_rewinddir
 789 #   define seekdir vlc_seekdir
 790 #   define telldir vlc_telldir
 791 #endif
 792
 793 #if defined(WIN32) || defined(UNDER_CE)
 794 /* win32, cl and icl support */
 795 #   if defined( _MSC_VER ) || !defined( __MINGW32__ )
 796 #       define __attribute__(x)
 797 #       define __inline__      __inline
 798 #       define S_IFBLK         0x3000  /* Block */
 799 #       define S_ISBLK(m)      (0)
 800 #       define S_ISCHR(m)      (0)
 801 #       define S_ISFIFO(m)     (((m)&_S_IFMT) == _S_IFIFO)
 802 #       define S_ISREG(m)      (((m)&_S_IFMT) == _S_IFREG)
 803 #   endif
 804
 805 /* several type definitions */
 806 #   if defined( __MINGW32__ )
 807 #       if !defined( _OFF_T_ )
 808             typedef long long _off_t;
 809             typedef _off_t off_t;
 810 #           define _OFF_T_
 811 #       else
 812 #           ifdef off_t
 813 #               undef off_t
 814 #           endif
 815 #           define off_t long long
 816 #       endif
 817 #   endif
 818
 819 #   if defined( _MSC_VER ) && !defined( __WXMSW__ )
 820 #       if !defined( _OFF_T_DEFINED )
 821             typedef __int64 off_t;
 822 #           define _OFF_T_DEFINED
 823 #       else
 824             /* for wx compatibility typedef long off_t; */
 825 #           define off_t __int64
 826 #       endif
 827 #   endif
 828
 829 #   if defined( __BORLANDC__ )
 830 #       undef off_t
 831 #       define off_t unsigned __int64
 832 #   endif
 833
 834 #   ifndef O_NONBLOCK
 835 #       define O_NONBLOCK 0
 836 #   endif
 837
 838 #   ifndef alloca
 839 #       define alloca _alloca
 840 #   endif
 841
 842     /* These two are not defined in mingw32 (bug?) */
 843 #   ifndef snprintf
 844 #       define snprintf _snprintf
 845 #   endif
 846 #   ifndef vsnprintf
 847 #       define vsnprintf _vsnprintf
 848 #   endif
 849
 850 #   include <tchar.h>
 851 #endif
 852
 853 VLC_EXPORT( bool, vlc_ureduce, ( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t ) );
 854 VLC_EXPORT( char **, vlc_parse_cmdline, ( const char *, int * ) );
 855
 856 /* vlc_wraptext (defined in src/extras/libc.c) */
 857 #define wraptext vlc_wraptext
 858 VLC_EXPORT( char *, vlc_wraptext, ( const char *, int ) );
 859
 860 /* iconv wrappers (defined in src/extras/libc.c) */
 861 typedef void *vlc_iconv_t;
 862 VLC_EXPORT( vlc_iconv_t, vlc_iconv_open, ( const char *, const char * ) );
 863 VLC_EXPORT( size_t, vlc_iconv, ( vlc_iconv_t, const char **, size_t *, char **, size_t * ) );
 864 VLC_EXPORT( int, vlc_iconv_close, ( vlc_iconv_t ) );
 865
 866 /* execve wrapper (defined in src/extras/libc.c) */
 867 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 ) );
 868 #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)
 869
 870 /*****************************************************************************
 871  * CPU capabilities
 872  *****************************************************************************/
 873 #define CPU_CAPABILITY_NONE    0
 874 #define CPU_CAPABILITY_486     (1<<0)
 875 #define CPU_CAPABILITY_586     (1<<1)
 876 #define CPU_CAPABILITY_PPRO    (1<<2)
 877 #define CPU_CAPABILITY_MMX     (1<<3)
 878 #define CPU_CAPABILITY_3DNOW   (1<<4)
 879 #define CPU_CAPABILITY_MMXEXT  (1<<5)
 880 #define CPU_CAPABILITY_SSE     (1<<6)
 881 #define CPU_CAPABILITY_SSE2    (1<<7)
 882 #define CPU_CAPABILITY_ALTIVEC (1<<16)
 883 #define CPU_CAPABILITY_FPU     (1<<31)
 884 VLC_EXPORT( unsigned, vlc_CPU, ( void ) );
 885
 886 typedef void *(*vlc_memcpy_t) (void *tgt, const void *src, size_t n);
 887 typedef void *(*vlc_memset_t) (void *tgt, int c, size_t n);
 888
 889 VLC_EXPORT( void, vlc_fastmem_register, (vlc_memcpy_t cpy, vlc_memset_t set) );
 890 VLC_EXPORT( void *, vlc_memcpy, ( void *, const void *, size_t ) );
 891 VLC_EXPORT( void *, vlc_memset, ( void *, int, size_t ) );
 892
 893 /*****************************************************************************
 894  * I18n stuff
 895  *****************************************************************************/
 896 #ifdef WIN32
 897     VLC_EXPORT( char *, vlc_dgettext, ( const char *package, const char *msgid ) );
 898 #endif
 899
 900 #if defined( ENABLE_NLS ) && \
 901      (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
 902       defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main)||\
 903       defined(MODULE_NAME_IS_pda))
 904     /* Declare nothing: gnome.h will do it for us */
 905 #elif defined( ENABLE_NLS )
 906 #   include <libintl.h>
 907 #   undef _
 908 #   ifdef WIN32
 909 #       define _(String) vlc_dgettext (PACKAGE_NAME, String)
 910 #   else
 911 #       define _(String) dgettext(PACKAGE_NAME, String)
 912 #   endif
 913 #   define N_(String) (String)
 914 #else
 915 #   define _(String) (String)
 916 #   define N_(String) (String)
 917 #endif
 918
 919 /*****************************************************************************
 920  * libvlc features
 921  *****************************************************************************/
 922 VLC_EXPORT( const char *, VLC_Version, ( void ) );
 923 VLC_EXPORT( const char *, VLC_CompileBy, ( void ) );
 924 VLC_EXPORT( const char *, VLC_CompileHost, ( void ) );
 925 VLC_EXPORT( const char *, VLC_CompileDomain, ( void ) );
 926 VLC_EXPORT( const char *, VLC_Compiler, ( void ) );
 927 VLC_EXPORT( const char *, VLC_Error, ( int ) );
 928 VLC_EXPORT( const char *, VLC_Changeset, ( void ) );
 929
 930 /*****************************************************************************
 931  * Additional vlc stuff
 932  *****************************************************************************/
 933 #include "vlc_messages.h"
 934 #include "vlc_variables.h"
 935 #include "vlc_objects.h"
 936 #include "vlc_mtime.h"
 937 #include "vlc_threads_funcs.h"
 938 #include "vlc_modules.h"
 939 #include "vlc_main.h"
 940 #include "vlc_configuration.h"
 941
 942 #if defined( WIN32 ) || defined( UNDER_CE )
 943 #   define DIR_SEP_CHAR '\\'
 944 #   define DIR_SEP "\\"
 945 #   define PATH_SEP_CHAR ';'
 946 #   define PATH_SEP ";"
 947 #else
 948 #   define DIR_SEP_CHAR '/'
 949 #   define DIR_SEP "/"
 950 #   define PATH_SEP_CHAR ':'
 951 #   define PATH_SEP ":"
 952 #endif