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

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