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-2004 VideoLAN
   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., 59 Temple Place - Suite 330, Boston, MA  02111, 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( __BORLANDC__ )
  36 #   undef PACKAGE
  37 #endif
  38
  39 #include "config.h"
  40
  41 #if defined(PACKAGE)
  42 #   undef PACKAGE_NAME
  43 #   define PACKAGE_NAME PACKAGE
  44 #endif
  45 #if defined(VERSION)
  46 #   undef PACKAGE_VERSION
  47 #   define PACKAGE_VERSION VERSION
  48 #endif
  49
  50 #if defined( __BORLANDC__ )
  51 #   undef HAVE_VARIADIC_MACROS
  52 #   undef HAVE_STDINT_H
  53 #   undef HAVE_INTTYPES_H
  54 #   undef off_t
  55 #elif defined( _MSC_VER )
  56 #   pragma warning( disable : 4244 )
  57 #endif
  58
  59 #include "vlc_config.h"
  60 #include "modules_inner.h"
  61
  62 /*****************************************************************************
  63  * Required system headers
  64  *****************************************************************************/
  65 #include <stdlib.h>
  66 #include <stdarg.h>
  67
  68 #ifdef HAVE_STRING_H
  69 #   include <string.h>                                         /* strerror() */
  70 #endif
  71
  72 #ifdef HAVE_SYS_TYPES_H
  73 #   include <sys/types.h>
  74 #endif
  75
  76 /*****************************************************************************
  77  * Basic types definitions
  78  *****************************************************************************/
  79 #if defined( HAVE_STDINT_H )
  80 #   include <stdint.h>
  81 #elif defined( HAVE_INTTYPES_H )
  82 #   include <inttypes.h>
  83 #elif defined( SYS_CYGWIN )
  84 #   include <sys/types.h>
  85     /* Cygwin only defines half of these... */
  86     typedef u_int8_t            uint8_t;
  87     typedef u_int16_t           uint16_t;
  88     typedef u_int32_t           uint32_t;
  89     typedef u_int64_t           uint64_t;
  90 #else
  91     /* Fallback types (very x86-centric, sorry) */
  92     typedef unsigned char       uint8_t;
  93     typedef signed char         int8_t;
  94     typedef unsigned short      uint16_t;
  95     typedef signed short        int16_t;
  96     typedef unsigned int        uint32_t;
  97     typedef signed int          int32_t;
  98 #   if defined( _MSC_VER ) \
  99       || defined( UNDER_CE ) \
 100       || ( defined( WIN32 ) && !defined( __MINGW32__ ) )
 101     typedef unsigned __int64    uint64_t;
 102     typedef signed __int64      int64_t;
 103 #   else
 104     typedef unsigned long long  uint64_t;
 105     typedef signed long long    int64_t;
 106 #   endif
 107     typedef uint32_t            uintptr_t;
 108     typedef int32_t             intptr_t;
 109 #endif
 110
 111 typedef uint8_t                 byte_t;
 112
 113 /* ptrdiff_t definition */
 114 #ifdef HAVE_STDDEF_H
 115 #   include <stddef.h>
 116 #else
 117 #   include <malloc.h>
 118 #   ifndef _PTRDIFF_T
 119 #       define _PTRDIFF_T
 120 /* Not portable in a 64-bit environment. */
 121 typedef int                 ptrdiff_t;
 122 #   endif
 123 #endif
 124
 125 #if defined( WIN32 ) || defined( UNDER_CE )
 126 #   include <malloc.h>
 127 #   ifndef PATH_MAX
 128 #       define PATH_MAX MAX_PATH
 129 #   endif
 130 #endif
 131
 132 #if (defined( WIN32 ) || defined( UNDER_CE )) && !defined( _SSIZE_T_ )
 133 typedef int                 ssize_t;
 134 #endif
 135
 136 /* Counter for statistics and profiling */
 137 typedef unsigned long       count_t;
 138
 139 /* DCT elements types */
 140 typedef int16_t             dctelem_t;
 141
 142 /* Video buffer types */
 143 typedef uint8_t             yuv_data_t;
 144
 145 /* Audio volume */
 146 typedef uint16_t            audio_volume_t;
 147
 148 #ifndef HAVE_SOCKLEN_T
 149 typedef int                 socklen_t;
 150 #endif
 151
 152 /**
 153  * High precision date or time interval
 154  *
 155  * Store a high precision date or time interval. The maximum precision is the
 156  * microsecond, and a 64 bits integer is used to avoid overflows (maximum
 157  * time interval is then 292271 years, which should be long enough for any
 158  * video). Dates are stored as microseconds since a common date (usually the
 159  * epoch). Note that date and time intervals can be manipulated using regular
 160  * arithmetic operators, and that no special functions are required.
 161  */
 162 typedef int64_t mtime_t;
 163
 164 /**
 165  * The vlc_fourcc_t type.
 166  *
 167  * See http://www.webartz.com/fourcc/ for a very detailed list.
 168  */
 169 typedef uint32_t vlc_fourcc_t;
 170
 171 #ifdef WORDS_BIGENDIAN
 172 #   define VLC_FOURCC( a, b, c, d ) \
 173         ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
 174            | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
 175 #   define VLC_TWOCC( a, b ) \
 176         ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )
 177
 178 #else
 179 #   define VLC_FOURCC( a, b, c, d ) \
 180         ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
 181            | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
 182 #   define VLC_TWOCC( a, b ) \
 183         ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )
 184
 185 #endif
 186
 187 /*****************************************************************************
 188  * Classes declaration
 189  *****************************************************************************/
 190
 191 /* Internal types */
 192 typedef struct libvlc_t libvlc_t;
 193 typedef struct vlc_t vlc_t;
 194 typedef struct variable_t variable_t;
 195 typedef struct date_t date_t;
 196
 197 /* Messages */
 198 typedef struct msg_bank_t msg_bank_t;
 199 typedef struct msg_subscription_t msg_subscription_t;
 200
 201 /* Playlist */
 202
 203 /* FIXME */
 204 /**
 205  * Playlist commands
 206  */
 207 typedef enum {
 208     PLAYLIST_PLAY,                              /**< Starts playing. No arg. */
 209     PLAYLIST_PAUSE,                     /**< Toggles playlist pause. No arg. */
 210     PLAYLIST_STOP,                               /**< Stops playing. No arg. */
 211     PLAYLIST_SKIP,                               /**< Skip X items and play. */
 212     PLAYLIST_GOTO,                                       /**< Goto Xth item. */
 213 } playlist_command_t;
 214
 215
 216 typedef struct playlist_t playlist_t;
 217 typedef struct playlist_item_t playlist_item_t;
 218 typedef struct playlist_group_t playlist_group_t;
 219 typedef struct playlist_export_t playlist_export_t;
 220
 221 /* Modules */
 222 typedef struct module_bank_t module_bank_t;
 223 typedef struct module_t module_t;
 224 typedef struct module_config_t module_config_t;
 225 typedef struct module_symbols_t module_symbols_t;
 226 typedef struct module_cache_t module_cache_t;
 227
 228 /* Interface */
 229 typedef struct intf_thread_t intf_thread_t;
 230 typedef struct intf_sys_t intf_sys_t;
 231 typedef struct intf_console_t intf_console_t;
 232 typedef struct intf_msg_t intf_msg_t;
 233 typedef struct intf_channel_t intf_channel_t;
 234
 235 /* Input */
 236 typedef struct input_thread_t input_thread_t;
 237 typedef struct input_thread_sys_t input_thread_sys_t;
 238 typedef struct input_item_t input_item_t;
 239 typedef struct input_area_t input_area_t;
 240 typedef struct input_buffers_t input_buffers_t;
 241 typedef struct input_socket_t input_socket_t;
 242 typedef struct access_sys_t access_sys_t;
 243 typedef struct demux_sys_t demux_sys_t;
 244 typedef struct es_descriptor_t es_descriptor_t;
 245 typedef struct es_sys_t es_sys_t;
 246 typedef struct pgrm_descriptor_t pgrm_descriptor_t;
 247 typedef struct pgrm_sys_t pgrm_sys_t;
 248 typedef struct stream_descriptor_t stream_descriptor_t;
 249 typedef struct seekpoint_t seekpoint_t;
 250 typedef struct info_t info_t;
 251 typedef struct info_category_t info_category_t;
 252
 253 /* Format */
 254 typedef struct audio_format_t audio_format_t;
 255 typedef struct video_format_t video_format_t;
 256 typedef struct subs_format_t subs_format_t;
 257 typedef struct es_format_t es_format_t;
 258 typedef struct video_palette_t video_palette_t;
 259
 260 /* NInput */
 261 typedef struct stream_sys_t stream_sys_t;
 262 typedef struct stream_t     stream_t;
 263 typedef struct es_out_t     es_out_t;
 264 typedef struct es_out_id_t  es_out_id_t;
 265 typedef struct es_out_sys_t es_out_sys_t;
 266 typedef struct demux_t  demux_t;
 267 typedef struct access_t access_t;
 268
 269 /* Audio */
 270 typedef struct aout_instance_t aout_instance_t;
 271 typedef struct aout_sys_t aout_sys_t;
 272 typedef struct aout_fifo_t aout_fifo_t;
 273 typedef struct aout_input_t aout_input_t;
 274 typedef struct aout_buffer_t aout_buffer_t;
 275 typedef audio_format_t audio_sample_format_t;
 276 typedef struct audio_date_t audio_date_t;
 277 typedef struct aout_filter_t aout_filter_t;
 278
 279 /* Video */
 280 typedef struct vout_thread_t vout_thread_t;
 281 typedef struct vout_sys_t vout_sys_t;
 282 typedef struct vout_synchro_t vout_synchro_t;
 283 typedef struct chroma_sys_t chroma_sys_t;
 284
 285 typedef video_format_t video_frame_format_t;
 286 typedef struct picture_t picture_t;
 287 typedef struct picture_sys_t picture_sys_t;
 288 typedef struct picture_heap_t picture_heap_t;
 289
 290 typedef struct spu_t spu_t;
 291 typedef struct subpicture_t subpicture_t;
 292 typedef struct subpicture_sys_t subpicture_sys_t;
 293 typedef struct subpicture_region_t subpicture_region_t;
 294 typedef struct text_style_t text_style_t;
 295
 296 /* Stream output */
 297 typedef struct sout_instance_t sout_instance_t;
 298 typedef struct sout_instance_sys_t sout_instance_sys_t;
 299
 300 typedef struct sout_input_t sout_input_t;
 301 typedef struct sout_packetizer_input_t sout_packetizer_input_t;
 302
 303 typedef struct sout_access_out_t sout_access_out_t;
 304 typedef struct sout_access_out_sys_t   sout_access_out_sys_t;
 305
 306 typedef struct sout_mux_t sout_mux_t;
 307 typedef struct sout_mux_sys_t sout_mux_sys_t;
 308
 309 typedef struct sout_stream_t    sout_stream_t;
 310 typedef struct sout_stream_sys_t sout_stream_sys_t;
 311
 312 typedef struct sout_cfg_t       sout_cfg_t;
 313 typedef struct sap_session_t    sap_session_t;
 314 typedef struct sap_address_t sap_address_t;
 315 typedef struct session_descriptor_t session_descriptor_t;
 316 typedef struct announce_method_t announce_method_t;
 317 typedef struct announce_handler_t announce_handler_t;
 318 typedef struct sap_handler_t sap_handler_t;
 319 //typedef struct slp_session_t    slp_session_t;
 320
 321 /* Decoders */
 322 typedef struct decoder_t      decoder_t;
 323 typedef struct decoder_sys_t  decoder_sys_t;
 324
 325 /* Encoders */
 326 typedef struct encoder_t      encoder_t;
 327 typedef struct encoder_sys_t  encoder_sys_t;
 328
 329 /* Filters */
 330 typedef struct filter_t filter_t;
 331 typedef struct filter_sys_t filter_sys_t;
 332
 333 /* Misc */
 334 typedef struct data_packet_t data_packet_t;
 335 typedef struct data_buffer_t data_buffer_t;
 336 typedef struct stream_ctrl_t stream_ctrl_t;
 337 typedef struct pes_packet_t pes_packet_t;
 338 typedef struct network_socket_t network_socket_t;
 339 typedef struct tls_server_t tls_server_t;
 340 typedef struct tls_session_t tls_session_t;
 341 typedef struct iso639_lang_t iso639_lang_t;
 342
 343 /* block */
 344 typedef struct block_t      block_t;
 345 typedef struct block_fifo_t block_fifo_t;
 346
 347 /* httpd */
 348 typedef struct httpd_t          httpd_t;
 349 typedef struct httpd_host_t     httpd_host_t;
 350 typedef struct httpd_url_t      httpd_url_t;
 351 typedef struct httpd_client_t   httpd_client_t;
 352 typedef struct httpd_callback_sys_t httpd_callback_sys_t;
 353 typedef struct httpd_message_t  httpd_message_t;
 354 typedef int    (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, httpd_message_t *query );
 355 typedef struct httpd_file_t     httpd_file_t;
 356 typedef struct httpd_file_sys_t httpd_file_sys_t;
 357 typedef int (*httpd_file_callback_t)( httpd_file_sys_t*, httpd_file_t *, uint8_t *psz_request, uint8_t **pp_data, int *pi_data );
 358 typedef struct httpd_redirect_t httpd_redirect_t;
 359 typedef struct httpd_stream_t httpd_stream_t;
 360
 361 /* vod server */
 362 typedef struct vod_t     vod_t;
 363 typedef struct vod_sys_t vod_sys_t;
 364 typedef struct vod_media_t vod_media_t;
 365
 366 /* opengl */
 367 typedef struct opengl_t     opengl_t;
 368 typedef struct opengl_sys_t opengl_sys_t;
 369
 370 /* divers */
 371 typedef struct vlc_meta_t    vlc_meta_t;
 372
 373 typedef struct vlm_t         vlm_t;
 374 typedef struct vlm_message_t vlm_message_t;
 375
 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 #ifndef __PLUGIN__
 390 #   define VLC_EXPORT( type, name, args ) type name args
 391 #else
 392 #   define VLC_EXPORT( type, name, args ) struct _u_n_u_s_e_d_
 393     extern module_symbols_t* p_symbols;
 394 #endif
 395
 396 /*****************************************************************************
 397  * OS-specific headers and thread types
 398  *****************************************************************************/
 399 #if defined( WIN32 ) || defined( UNDER_CE )
 400 #   define WIN32_LEAN_AND_MEAN
 401 #   include <windows.h>
 402 #   if defined( UNDER_CE )
 403 #      define IS_WINNT 0
 404 #   else
 405 #      define IS_WINNT ( GetVersion() < 0x80000000 )
 406 #   endif
 407 #endif
 408
 409 #include "vlc_threads.h"
 410
 411 /*****************************************************************************
 412  * Common structure members
 413  *****************************************************************************/
 414
 415 /* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
 416 #define VLC_COMMON_MEMBERS                                                  \
 417 /** \name VLC_COMMON_MEMBERS                                                \
 418  * these members are common for all vlc objects                             \
 419  */                                                                         \
 420 /**@{*/                                                                     \
 421     int   i_object_id;                                                      \
 422     int   i_object_type;                                                    \
 423     char *psz_object_type;                                                  \
 424     char *psz_object_name;                                                  \
 425                                                                             \
 426     /* Thread properties, if any */                                         \
 427     vlc_bool_t   b_thread;                                                  \
 428     vlc_thread_t thread_id;                                                 \
 429                                                                             \
 430     /* Object access lock */                                                \
 431     vlc_mutex_t  object_lock;                                               \
 432     vlc_cond_t   object_wait;                                               \
 433                                                                             \
 434     /* Object properties */                                                 \
 435     volatile vlc_bool_t b_error;                  /**< set by the object */ \
 436     volatile vlc_bool_t b_die;                   /**< set by the outside */ \
 437     volatile vlc_bool_t b_dead;                   /**< set by the object */ \
 438     volatile vlc_bool_t b_attached;               /**< set by the object */ \
 439     vlc_bool_t b_force;      /**< set by the outside (eg. module_Need()) */ \
 440                                                                             \
 441     /* Object variables */                                                  \
 442     vlc_mutex_t     var_lock;                                               \
 443     int             i_vars;                                                 \
 444     variable_t *    p_vars;                                                 \
 445                                                                             \
 446     /* Stuff related to the libvlc structure */                             \
 447     libvlc_t *      p_libvlc;                      /**< root of all evil */ \
 448     vlc_t *         p_vlc;                   /**< (root of all evil) - 1 */ \
 449                                                                             \
 450     volatile int    i_refcount;                         /**< usage count */ \
 451     vlc_object_t *  p_parent;                            /**< our parent */ \
 452     vlc_object_t ** pp_children;                       /**< our children */ \
 453     volatile int    i_children;                                             \
 454                                                                             \
 455     /* Private data */                                                      \
 456     void *          p_private;                                              \
 457                                                                             \
 458     /** Just a reminder so that people don't cast garbage */                \
 459     int be_sure_to_add_VLC_COMMON_MEMBERS_to_struct;                        \
 460 /**@}*/                                                                     \
 461
 462 /* VLC_OBJECT: attempt at doing a clever cast */
 463 #define VLC_OBJECT( x ) \
 464     ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
 465
 466 /*****************************************************************************
 467  * Macros and inline functions
 468  *****************************************************************************/
 469 #ifdef NTOHL_IN_SYS_PARAM_H
 470 #   include <sys/param.h>
 471
 472 #elif !defined(WIN32) && !defined( UNDER_CE )
 473 #   include <netinet/in.h>
 474
 475 #endif /* NTOHL_IN_SYS_PARAM_H || WIN32 */
 476
 477 /* CEIL: division with round to nearest greater integer */
 478 #define CEIL(n, d)  ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
 479
 480 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
 481 #define PAD(n, d)   ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
 482
 483 /* __MAX and __MIN: self explanatory */
 484 #ifndef __MAX
 485 #   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
 486 #endif
 487 #ifndef __MIN
 488 #   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
 489 #endif
 490
 491 static int64_t GCD( int64_t a, int64_t b )
 492 {
 493     if( b ) return GCD( b, a % b );
 494     else return a;
 495 }
 496
 497 /* Dynamic array handling: realloc array, move data, increment position */
 498 #define INSERT_ELEM( p_ar, i_oldsize, i_pos, elem )                           \
 499     do                                                                        \
 500     {                                                                         \
 501         if( i_oldsize )                                                       \
 502         {                                                                     \
 503             (p_ar) = realloc( p_ar, ((i_oldsize) + 1) * sizeof( *(p_ar) ) );  \
 504         }                                                                     \
 505         else                                                                  \
 506         {                                                                     \
 507             (p_ar) = malloc( ((i_oldsize) + 1) * sizeof( *(p_ar) ) );         \
 508         }                                                                     \
 509         if( (i_oldsize) - (i_pos) )                                           \
 510         {                                                                     \
 511             memmove( (p_ar) + (i_pos) + 1,                                    \
 512                      (p_ar) + (i_pos),                                        \
 513                      ((i_oldsize) - (i_pos)) * sizeof( *(p_ar) ) );           \
 514         }                                                                     \
 515         (p_ar)[i_pos] = elem;                                                 \
 516         (i_oldsize)++;                                                        \
 517     }                                                                         \
 518     while( 0 )
 519
 520 #define REMOVE_ELEM( p_ar, i_oldsize, i_pos )                                 \
 521     do                                                                        \
 522     {                                                                         \
 523         if( (i_oldsize) - (i_pos) - 1 )                                       \
 524         {                                                                     \
 525             memmove( (p_ar) + (i_pos),                                        \
 526                      (p_ar) + (i_pos) + 1,                                    \
 527                      ((i_oldsize) - (i_pos) - 1) * sizeof( *(p_ar) ) );       \
 528         }                                                                     \
 529         if( i_oldsize > 1 )                                                   \
 530         {                                                                     \
 531             (p_ar) = realloc( p_ar, ((i_oldsize) - 1) * sizeof( *(p_ar) ) );  \
 532         }                                                                     \
 533         else                                                                  \
 534         {                                                                     \
 535             free( p_ar );                                                     \
 536             (p_ar) = NULL;                                                    \
 537         }                                                                     \
 538         (i_oldsize)--;                                                        \
 539     }                                                                         \
 540     while( 0 )
 541
 542
 543 #define TAB_APPEND( count, tab, p )             \
 544     if( (count) > 0 )                           \
 545     {                                           \
 546         (tab) = realloc( tab, sizeof( void ** ) * ( (count) + 1 ) ); \
 547     }                                           \
 548     else                                        \
 549     {                                           \
 550         (tab) = malloc( sizeof( void ** ) );    \
 551     }                                           \
 552     (tab)[count] = (p);        \
 553     (count)++
 554
 555 #define TAB_FIND( count, tab, p, index )        \
 556     {                                           \
 557         int _i_;                                \
 558         (index) = -1;                           \
 559         for( _i_ = 0; _i_ < (count); _i_++ )    \
 560         {                                       \
 561             if( (tab)[_i_] == (p) )  \
 562             {                                   \
 563                 (index) = _i_;                  \
 564                 break;                          \
 565             }                                   \
 566         }                                       \
 567     }
 568
 569 #define TAB_REMOVE( count, tab, p )             \
 570     {                                           \
 571         int _i_index_;                          \
 572         TAB_FIND( count, tab, p, _i_index_ );   \
 573         if( _i_index_ >= 0 )                    \
 574         {                                       \
 575             if( (count) > 1 )                     \
 576             {                                   \
 577                 memmove( ((void**)(tab) + _i_index_),    \
 578                          ((void**)(tab) + _i_index_+1),  \
 579                          ( (count) - _i_index_ - 1 ) * sizeof( void* ) );\
 580             }                                   \
 581             (count)--;                          \
 582             if( (count) == 0 )                  \
 583             {                                   \
 584                 free( tab );                    \
 585                 (tab) = NULL;                   \
 586             }                                   \
 587         }                                       \
 588     }
 589
 590 /* MSB (big endian)/LSB (little endian) conversions - network order is always
 591  * MSB, and should be used for both network communications and files. Note that
 592  * byte orders other than little and big endians are not supported, but only
 593  * the VAX seems to have such exotic properties. */
 594 static inline uint16_t U16_AT( void const * _p )
 595 {
 596     uint8_t * p = (uint8_t *)_p;
 597     return ( ((uint16_t)p[0] << 8) | p[1] );
 598 }
 599 static inline uint32_t U32_AT( void const * _p )
 600 {
 601     uint8_t * p = (uint8_t *)_p;
 602     return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
 603               | ((uint32_t)p[2] << 8) | p[3] );
 604 }
 605 static inline uint64_t U64_AT( void const * _p )
 606 {
 607     uint8_t * p = (uint8_t *)_p;
 608     return ( ((uint64_t)p[0] << 56) | ((uint64_t)p[1] << 48)
 609               | ((uint64_t)p[2] << 40) | ((uint64_t)p[3] << 32)
 610               | ((uint64_t)p[4] << 24) | ((uint64_t)p[5] << 16)
 611               | ((uint64_t)p[6] << 8) | p[7] );
 612 }
 613
 614 static inline uint16_t GetWLE( void const * _p )
 615 {
 616     uint8_t * p = (uint8_t *)_p;
 617     return ( ((uint16_t)p[1] << 8) | p[0] );
 618 }
 619 static inline uint32_t GetDWLE( void const * _p )
 620 {
 621     uint8_t * p = (uint8_t *)_p;
 622     return ( ((uint32_t)p[3] << 24) | ((uint32_t)p[2] << 16)
 623               | ((uint32_t)p[1] << 8) | p[0] );
 624 }
 625 static inline uint64_t GetQWLE( void const * _p )
 626 {
 627     uint8_t * p = (uint8_t *)_p;
 628     return ( ((uint64_t)p[7] << 56) | ((uint64_t)p[6] << 48)
 629               | ((uint64_t)p[5] << 40) | ((uint64_t)p[4] << 32)
 630               | ((uint64_t)p[3] << 24) | ((uint64_t)p[2] << 16)
 631               | ((uint64_t)p[1] << 8) | p[0] );
 632 }
 633
 634 #define GetWBE( p )     U16_AT( p )
 635 #define GetDWBE( p )    U32_AT( p )
 636 #define GetQWBE( p )    U64_AT( p )
 637
 638 /* Helper writer functions */
 639 #define SetWLE( p, v ) _SetWLE( (uint8_t*)p, v)
 640 static inline void _SetWLE( uint8_t *p, uint16_t i_dw )
 641 {
 642     p[1] = ( i_dw >>  8 )&0xff;
 643     p[0] = ( i_dw       )&0xff;
 644 }
 645
 646 #define SetDWLE( p, v ) _SetDWLE( (uint8_t*)p, v)
 647 static inline void _SetDWLE( uint8_t *p, uint32_t i_dw )
 648 {
 649     p[3] = ( i_dw >> 24 )&0xff;
 650     p[2] = ( i_dw >> 16 )&0xff;
 651     p[1] = ( i_dw >>  8 )&0xff;
 652     p[0] = ( i_dw       )&0xff;
 653 }
 654 #define SetQWLE( p, v ) _SetQWLE( (uint8_t*)p, v)
 655 static inline void _SetQWLE( uint8_t *p, uint64_t i_qw )
 656 {
 657     SetDWLE( p,   i_qw&0xffffffff );
 658     SetDWLE( p+4, ( i_qw >> 32)&0xffffffff );
 659 }
 660 #define SetWBE( p, v ) _SetWBE( (uint8_t*)p, v)
 661 static inline void _SetWBE( uint8_t *p, uint16_t i_dw )
 662 {
 663     p[0] = ( i_dw >>  8 )&0xff;
 664     p[1] = ( i_dw       )&0xff;
 665 }
 666
 667 #define SetDWBE( p, v ) _SetDWBE( (uint8_t*)p, v)
 668 static inline void _SetDWBE( uint8_t *p, uint32_t i_dw )
 669 {
 670     p[0] = ( i_dw >> 24 )&0xff;
 671     p[1] = ( i_dw >> 16 )&0xff;
 672     p[2] = ( i_dw >>  8 )&0xff;
 673     p[3] = ( i_dw       )&0xff;
 674 }
 675 #define SetQWBE( p, v ) _SetQWBE( (uint8_t*)p, v)
 676 static inline void _SetQWBE( uint8_t *p, uint64_t i_qw )
 677 {
 678     SetDWBE( p+4,   i_qw&0xffffffff );
 679     SetDWBE( p, ( i_qw >> 32)&0xffffffff );
 680 }
 681
 682 #if WORDS_BIGENDIAN
 683 #   define hton16(i)   ( i )
 684 #   define hton32(i)   ( i )
 685 #   define hton64(i)   ( i )
 686 #   define ntoh16(i)   ( i )
 687 #   define ntoh32(i)   ( i )
 688 #   define ntoh64(i)   ( i )
 689 #else
 690 #   define hton16(i)   U16_AT(&i)
 691 #   define hton32(i)   U32_AT(&i)
 692 #   define hton64(i)   U64_AT(&i)
 693 #   define ntoh16(i)   U16_AT(&i)
 694 #   define ntoh32(i)   U32_AT(&i)
 695 #   define ntoh64(i)   U64_AT(&i)
 696 #endif
 697
 698 /* Format string sanity checks */
 699 #ifdef HAVE_ATTRIBUTE_FORMAT
 700 #   define ATTRIBUTE_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
 701 #else
 702 #   define ATTRIBUTE_FORMAT(x,y)
 703 #endif
 704
 705 /* Alignment of critical static data structures */
 706 #ifdef ATTRIBUTE_ALIGNED_MAX
 707 #   define ATTR_ALIGN(align) __attribute__ ((__aligned__ ((ATTRIBUTE_ALIGNED_MAX < align) ? ATTRIBUTE_ALIGNED_MAX : align)))
 708 #else
 709 #   define ATTR_ALIGN(align)
 710 #endif
 711
 712 /* Alignment of critical dynamic data structure
 713  *
 714  * Not all platforms support memalign so we provide a vlc_memalign wrapper
 715  * void *vlc_memalign( size_t align, size_t size, void **pp_orig )
 716  * *pp_orig is the pointer that has to be freed afterwards.
 717  */
 718 #if 0
 719 #ifdef HAVE_POSIX_MEMALIGN
 720 #   define vlc_memalign(align,size,pp_orig) \
 721     ( !posix_memalign( pp_orig, align, size ) ? *(pp_orig) : NULL )
 722 #endif
 723 #endif
 724 #ifdef HAVE_MEMALIGN
 725     /* Some systems have memalign() but no declaration for it */
 726     void * memalign( size_t align, size_t size );
 727
 728 #   define vlc_memalign(pp_orig,align,size) \
 729     ( *(pp_orig) = memalign( align, size ) )
 730
 731 #else /* We don't have any choice but to align manually */
 732 #   define vlc_memalign(pp_orig,align,size) \
 733     (( *(pp_orig) = malloc( size + align - 1 )) \
 734         ? (void *)( (((unsigned long)*(pp_orig)) + (unsigned long)(align-1) ) \
 735                        & (~(unsigned long)(align-1)) ) \
 736         : NULL )
 737
 738 #endif
 739
 740 /* Stuff defined in src/extras/libc.c */
 741 #ifndef HAVE_STRDUP
 742 #   define strdup vlc_strdup
 743     VLC_EXPORT( char *, vlc_strdup, ( const char *s ) );
 744 #elif !defined(__PLUGIN__)
 745 #   define vlc_strdup NULL
 746 #endif
 747
 748 #if !defined(HAVE_VASPRINTF) || defined(SYS_DARWIN) || defined(SYS_BEOS)
 749 #   define vasprintf vlc_vasprintf
 750     VLC_EXPORT( int, vlc_vasprintf, (char **, const char *, va_list ) );
 751 #elif !defined(__PLUGIN__)
 752 #   define vlc_vasprintf NULL
 753 #endif
 754
 755 #if !defined(HAVE_ASPRINTF) || defined(SYS_DARWIN) || defined(SYS_BEOS)
 756 #   define asprintf vlc_asprintf
 757     VLC_EXPORT( int, vlc_asprintf, (char **, const char *, ... ) );
 758 #elif !defined(__PLUGIN__)
 759 #   define vlc_asprintf NULL
 760 #endif
 761
 762 #ifndef HAVE_STRNDUP
 763 #   if defined(STRNDUP_IN_GNOME_H) && \
 764         (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
 765          defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main))
 766         /* Do nothing: gnome.h defines strndup for us */
 767 #   else
 768 #       define strndup vlc_strndup
 769         VLC_EXPORT( char *, vlc_strndup, ( const char *s, size_t n ) );
 770 #   endif
 771 #elif !defined(__PLUGIN__)
 772 #   define vlc_strndup NULL
 773 #endif
 774
 775 #ifndef HAVE_ATOF
 776 #   define atof vlc_atof
 777     VLC_EXPORT( double, vlc_atof, ( const char *nptr ) );
 778 #elif !defined(__PLUGIN__)
 779 #   define vlc_atof NULL
 780 #endif
 781
 782 #ifndef HAVE_STRTOF
 783 #   ifdef HAVE_STRTOD
 784 #       define strtof strtod
 785 #   endif
 786 #endif
 787
 788 #ifndef HAVE_ATOLL
 789 #   define atoll vlc_atoll
 790     VLC_EXPORT( int64_t, vlc_atoll, ( const char *nptr ) );
 791 #elif !defined(__PLUGIN__)
 792 #   define vlc_atoll NULL
 793 #endif
 794
 795 #ifndef HAVE_STRTOLL
 796 #   define strtoll vlc_strtoll
 797     VLC_EXPORT( int64_t, vlc_strtoll, ( const char *nptr, char **endptr, int base ) );
 798 #elif !defined(__PLUGIN__)
 799 #   define vlc_strtoll NULL
 800 #endif
 801
 802 #ifndef HAVE_GETENV
 803 #   define getenv vlc_getenv
 804     VLC_EXPORT( char *, vlc_getenv, ( const char *name ) );
 805 #elif !defined(__PLUGIN__)
 806 #   define vlc_getenv NULL
 807 #endif
 808
 809 #ifndef HAVE_STRCASECMP
 810 #   ifndef HAVE_STRICMP
 811 #       define strcasecmp vlc_strcasecmp
 812         VLC_EXPORT( int, vlc_strcasecmp, ( const char *s1, const char *s2 ) );
 813 #   else
 814 #       define strcasecmp stricmp
 815 #       if !defined(__PLUGIN__)
 816 #           define vlc_strcasecmp NULL
 817 #       endif
 818 #   endif
 819 #elif !defined(__PLUGIN__)
 820 #   define vlc_strcasecmp NULL
 821 #endif
 822
 823 #ifndef HAVE_STRNCASECMP
 824 #   ifndef HAVE_STRNICMP
 825 #       define strncasecmp vlc_strncasecmp
 826         VLC_EXPORT( int, vlc_strncasecmp, ( const char *s1, const char *s2, size_t n ) );
 827 #   else
 828 #       define strncasecmp strnicmp
 829 #       if !defined(__PLUGIN__)
 830 #           define vlc_strncasecmp NULL
 831 #       endif
 832 #   endif
 833 #elif !defined(__PLUGIN__)
 834 #   define vlc_strncasecmp NULL
 835 #endif
 836
 837 #ifndef HAVE_STRCASESTR
 838 #   ifndef HAVE_STRISTR
 839 #       define strcasestr vlc_strcasestr
 840         VLC_EXPORT( char *, vlc_strcasestr, ( const char *s1, const char *s2 ) );
 841 #   else
 842 #       define strcasestr stristr
 843 #       if !defined(__PLUGIN__)
 844 #           define vlc_strcasestr NULL
 845 #       endif
 846 #   endif
 847 #elif !defined(__PLUGIN__)
 848 #   define vlc_strcasestr NULL
 849 #endif
 850
 851 /* Format type specifiers for 64 bits numbers */
 852 #if !defined(WIN32) && !defined(UNDER_CE)
 853 #   define I64Fd "%lld"
 854 #   define I64Fi "%lli"
 855 #   define I64Fo "%llo"
 856 #   define I64Fu "%llu"
 857 #   define I64Fx "%llx"
 858 #   define I64FX "%llX"
 859 #else
 860 #   define I64Fd "%I64d"
 861 #   define I64Fi "%I64i"
 862 #   define I64Fo "%I64o"
 863 #   define I64Fu "%I64u"
 864 #   define I64Fx "%I64x"
 865 #   define I64FX "%I64X"
 866 #endif /* defined(WIN32)||defined(UNDER_CE) */
 867
 868 /* 64 bits integer constant suffix */
 869 #if defined( __MINGW32__ ) || (!defined(WIN32) && !defined(UNDER_CE))
 870 #   define I64C(x)         x##LL
 871 #   define UI64C(x)        x##ULL
 872 #else
 873 #   define I64C(x)         x##i64
 874 #   define UI64C(x)        x##ui64
 875 #endif /* defined(WIN32)||defined(UNDER_CE) */
 876
 877 #if defined(WIN32) || defined(UNDER_CE)
 878 /* win32, cl and icl support */
 879 #   if defined( _MSC_VER ) || !defined( __MINGW32__ )
 880 #       define __attribute__(x)
 881 #       define __inline__      __inline
 882 #       define S_IFBLK         0x3000  /* Block */
 883 #       define S_ISBLK(m)      (0)
 884 #       define S_ISCHR(m)      (0)
 885 #       define S_ISFIFO(m)     (((m)&_S_IFMT) == _S_IFIFO)
 886 #       define S_ISREG(m)      (((m)&_S_IFMT) == _S_IFREG)
 887 #   endif
 888
 889 /* several type definitions */
 890 #   if defined( __MINGW32__ )
 891 #       if !defined( _OFF_T_ )
 892 typedef long long _off_t;
 893 typedef _off_t off_t;
 894 #           define _OFF_T_
 895 #       else
 896 #           ifdef off_t
 897 #               undef off_t
 898 #           endif
 899 #           define off_t long long
 900 #       endif
 901 #   endif
 902
 903 #   if defined( _MSC_VER )
 904 #       if !defined( _OFF_T_DEFINED )
 905 typedef __int64 off_t;
 906 #           define _OFF_T_DEFINED
 907 #       else
 908 #           define off_t __int64
 909 #       endif
 910 #   endif
 911
 912 #   if defined( __BORLANDC__ )
 913 #       undef off_t
 914 #       define off_t unsigned __int64
 915 #   endif
 916
 917 #   ifndef O_NONBLOCK
 918 #       define O_NONBLOCK 0
 919 #   endif
 920
 921 #   ifndef alloca
 922 #       define alloca _alloca
 923 #   endif
 924
 925     /* These two are not defined in mingw32 (bug?) */
 926 #   ifndef snprintf
 927 #       define snprintf _snprintf
 928 #   endif
 929 #   ifndef vsnprintf
 930 #       define vsnprintf _vsnprintf
 931 #   endif
 932
 933 #endif
 934
 935 /* lseek (defined in src/extras/libc.c) */
 936 #ifndef HAVE_LSEEK
 937 #   define lseek vlc_lseek
 938     VLC_EXPORT( off_t, vlc_lseek, ( int fildes, off_t offset, int whence ) );
 939 #elif !defined(__PLUGIN__)
 940 #   define vlc_lseek NULL
 941 #endif
 942
 943 VLC_EXPORT( vlc_bool_t, vlc_reduce, ( int *, int *, int64_t, int64_t, int64_t ) );
 944
 945 /* vlc_wraptext (defined in src/extras/libc.c) */
 946 #define wraptext vlc_wraptext
 947 VLC_EXPORT( char *, vlc_wraptext, ( const char *, int, vlc_bool_t ) );
 948
 949 /* iconv wrappers (defined in src/extras/libc.c) */
 950 typedef void *vlc_iconv_t;
 951 VLC_EXPORT( vlc_iconv_t, vlc_iconv_open, ( const char *, const char * ) );
 952 VLC_EXPORT( size_t, vlc_iconv, ( vlc_iconv_t, char **, size_t *, char **, size_t * ) );
 953 VLC_EXPORT( int, vlc_iconv_close, ( vlc_iconv_t ) );
 954
 955 /*****************************************************************************
 956  * CPU capabilities
 957  *****************************************************************************/
 958 #define CPU_CAPABILITY_NONE    0
 959 #define CPU_CAPABILITY_486     (1<<0)
 960 #define CPU_CAPABILITY_586     (1<<1)
 961 #define CPU_CAPABILITY_PPRO    (1<<2)
 962 #define CPU_CAPABILITY_MMX     (1<<3)
 963 #define CPU_CAPABILITY_3DNOW   (1<<4)
 964 #define CPU_CAPABILITY_MMXEXT  (1<<5)
 965 #define CPU_CAPABILITY_SSE     (1<<6)
 966 #define CPU_CAPABILITY_SSE2    (1<<7)
 967 #define CPU_CAPABILITY_ALTIVEC (1<<16)
 968 #define CPU_CAPABILITY_FPU     (1<<31)
 969
 970 /*****************************************************************************
 971  * I18n stuff
 972  *****************************************************************************/
 973 VLC_EXPORT( char *, vlc_dgettext, ( const char *package, const char *msgid ) );
 974
 975 #if defined( ENABLE_NLS ) && \
 976      (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
 977       defined(MODULE_NAME_IS_gnome2)||defined(MODULE_NAME_IS_gnome2_main)||\
 978       defined(MODULE_NAME_IS_pda))
 979     /* Declare nothing: gnome.h will do it for us */
 980 #elif defined( ENABLE_NLS )
 981 #   if defined( HAVE_INCLUDED_GETTEXT )
 982 #       include "libintl.h"
 983 #   else
 984 #       include <libintl.h>
 985 #   endif
 986 #   undef _
 987 #   define _(String) vlc_dgettext (PACKAGE_NAME, String)
 988 #   define N_(String) ((char*)(String))
 989 #else
 990 #   define _(String) ((char*)(String))
 991 #   define N_(String) ((char*)(String))
 992 #endif
 993
 994 /*****************************************************************************
 995  * Additional vlc stuff
 996  *****************************************************************************/
 997 #include "vlc_symbols.h"
 998 #include "os_specific.h"
 999 #include "vlc_messages.h"
1000 #include "variables.h"
1001 #include "vlc_objects.h"
1002 #include "vlc_threads_funcs.h"
1003 #include "mtime.h"
1004 #include "modules.h"
1005 #include "main.h"
1006 #include "configuration.h"
1007
1008 #if defined( __BORLANDC__ )
1009 #   undef PACKAGE
1010 #   define PACKAGE
1011 #endif
1012