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