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