git.sesse.net Git - vlc/blob - include/vlc_common.h

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