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

   1 /*****************************************************************************
   2  * common.h: common definitions
   3  * Collection of useful common types and macros definitions
   4  *****************************************************************************
   5  * Copyright (C) 1998-2005 the VideoLAN team
   6  * $Id$
   7  *
   8  * Authors: Samuel Hocevar <sam@via.ecp.fr>
   9  *          Vincent Seguin <seguin@via.ecp.fr>
  10  *          Gildas Bazin <gbazin@videolan.org>
  11  *
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  25  *****************************************************************************/
  26
  27 /**
  28  * \file
  29  * This file is a collection of common definitions and types
  30  */
  31
  32 #ifndef VLC_COMMON_H
  33 # define VLC_COMMON_H 1
  34
  35 /*****************************************************************************
  36  * Required vlc headers
  37  *****************************************************************************/
  38 #if defined( _MSC_VER )
  39 #   pragma warning( disable : 4244 )
  40 #endif
  41
  42 #include "vlc_config.h"
  43
  44 /*****************************************************************************
  45  * Required system headers
  46  *****************************************************************************/
  47 #include <stdlib.h>
  48 #include <stdarg.h>
  49
  50 #include <string.h>
  51 #include <stdio.h>
  52 #include <inttypes.h>
  53 #include <stddef.h>
  54
  55 #ifndef __cplusplus
  56 # include <stdbool.h>
  57 #endif
  58
  59 /* Format string sanity checks */
  60 #ifdef __GNUC__
  61 #   define LIBVLC_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
  62 #   define LIBVLC_USED __attribute__ ((warn_unused_result))
  63 #else
  64 #   define LIBVLC_FORMAT(x,y)
  65 #   define LIBVLC_USED
  66 #endif
  67
  68 /*****************************************************************************
  69  * Basic types definitions
  70  *****************************************************************************/
  71 #if defined( WIN32 ) || defined( UNDER_CE )
  72 #   include <malloc.h>
  73 #   ifndef PATH_MAX
  74 #       define PATH_MAX MAX_PATH
  75 #   endif
  76 #endif
  77
  78 /* Counter for statistics and profiling */
  79 typedef unsigned long       count_t;
  80
  81 /* Audio volume */
  82 typedef uint16_t            audio_volume_t;
  83
  84 /**
  85  * High precision date or time interval
  86  *
  87  * Store a high precision date or time interval. The maximum precision is the
  88  * microsecond, and a 64 bits integer is used to avoid overflows (maximum
  89  * time interval is then 292271 years, which should be long enough for any
  90  * video). Dates are stored as microseconds since a common date (usually the
  91  * epoch). Note that date and time intervals can be manipulated using regular
  92  * arithmetic operators, and that no special functions are required.
  93  */
  94 typedef int64_t mtime_t;
  95
  96 /**
  97  * The vlc_fourcc_t type.
  98  *
  99  * See http://www.webartz.com/fourcc/ for a very detailed list.
 100  */
 101 typedef uint32_t vlc_fourcc_t;
 102
 103 #ifdef WORDS_BIGENDIAN
 104 #   define VLC_FOURCC( a, b, c, d ) \
 105         ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
 106            | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
 107 #   define VLC_TWOCC( a, b ) \
 108         ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )
 109
 110 #else
 111 #   define VLC_FOURCC( a, b, c, d ) \
 112         ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
 113            | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
 114 #   define VLC_TWOCC( a, b ) \
 115         ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )
 116
 117 #endif
 118
 119 /**
 120  * Translate a vlc_fourcc into its string representation. This function
 121  * assumes there is enough room in psz_fourcc to store 4 characters in.
 122  *
 123  * \param fcc a vlc_fourcc_t
 124  * \param psz_fourcc string to store string representation of vlc_fourcc in
 125  */
 126 static inline void __vlc_fourcc_to_char( vlc_fourcc_t fcc, char *psz_fourcc )
 127 {
 128     memcpy( psz_fourcc, &fcc, 4 );
 129 }
 130
 131 #define vlc_fourcc_to_char( a, b ) \
 132     __vlc_fourcc_to_char( (vlc_fourcc_t)(a), (char *)(b) )
 133
 134 /*****************************************************************************
 135  * Classes declaration
 136  *****************************************************************************/
 137
 138 /* Internal types */
 139 typedef struct vlc_list_t vlc_list_t;
 140 typedef struct vlc_object_t vlc_object_t;
 141 typedef struct libvlc_int_t libvlc_int_t;
 142 typedef struct date_t date_t;
 143 typedef struct dict_entry_t dict_entry_t;
 144 typedef struct dict_t dict_t;
 145
 146 /* Playlist */
 147
 148 /* FIXME */
 149 /**
 150  * Playlist commands
 151  */
 152 typedef enum {
 153     PLAYLIST_PLAY,      /**< No arg.                            res=can fail*/
 154     PLAYLIST_VIEWPLAY,  /**< arg1= playlist_item_t*,*/
 155                         /**  arg2 = playlist_item_t*          , res=can fail */
 156     PLAYLIST_PAUSE,     /**< No arg                             res=can fail*/
 157     PLAYLIST_STOP,      /**< No arg                             res=can fail*/
 158     PLAYLIST_SKIP,      /**< arg1=int,                          res=can fail*/
 159 } playlist_command_t;
 160
 161
 162 typedef struct playlist_t playlist_t;
 163 typedef struct playlist_item_t playlist_item_t;
 164 typedef struct playlist_view_t playlist_view_t;
 165 typedef struct playlist_export_t playlist_export_t;
 166 typedef struct services_discovery_t services_discovery_t;
 167 typedef struct services_discovery_sys_t services_discovery_sys_t;
 168 typedef struct playlist_add_t playlist_add_t;
 169
 170 /* Modules */
 171 typedef struct module_bank_t module_bank_t;
 172 typedef struct module_t module_t;
 173 typedef struct module_config_t module_config_t;
 174 typedef struct module_symbols_t module_symbols_t;
 175 typedef struct module_cache_t module_cache_t;
 176
 177 typedef struct config_category_t config_category_t;
 178
 179 /* Input */
 180 typedef struct input_thread_t input_thread_t;
 181 typedef struct input_thread_sys_t input_thread_sys_t;
 182 typedef struct input_item_t input_item_t;
 183 typedef struct access_t access_t;
 184 typedef struct access_sys_t access_sys_t;
 185 typedef struct stream_t     stream_t;
 186 typedef struct stream_sys_t stream_sys_t;
 187 typedef struct demux_t  demux_t;
 188 typedef struct demux_meta_t demux_meta_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 aout_buffer_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 /* divers */
 348 typedef struct vlc_meta_t    vlc_meta_t;
 349 typedef struct meta_export_t meta_export_t;
 350
 351 /* Stats */
 352 typedef struct counter_t     counter_t;
 353 typedef struct counter_sample_t counter_sample_t;
 354 typedef struct stats_handler_t stats_handler_t;
 355 typedef struct input_stats_t input_stats_t;
 356
 357 /* Update */
 358 typedef struct update_t update_t;
 359 typedef struct update_iterator_t update_iterator_t;
 360
 361 /* Meta engine */
 362 typedef struct meta_engine_t meta_engine_t;
 363
 364 /* stat/lstat/fstat */
 365 #ifdef WIN32
 366 #include <sys/stat.h>
 367
 368 # ifndef UNDER_CE
 369 struct _stati64;
 370 #define stat _stati64
 371 #define fstat _fstati64
 372 #endif
 373
 374 /* You should otherwise use utf8_stat and utf8_lstat. */
 375 #else
 376 struct stat;
 377 #endif
 378
 379 /**
 380  * VLC value structure
 381  */
 382 typedef union
 383 {
 384     int             i_int;
 385     bool            b_bool;
 386     float           f_float;
 387     char *          psz_string;
 388     void *          p_address;
 389     vlc_object_t *  p_object;
 390     vlc_list_t *    p_list;
 391     mtime_t         i_time;
 392
 393     struct { char *psz_name; int i_object_id; } var;
 394
 395    /* Make sure the structure is at least 64bits */
 396     struct { char a, b, c, d, e, f, g, h; } padding;
 397
 398 } vlc_value_t;
 399
 400 /**
 401  * VLC list structure
 402  */
 403 struct vlc_list_t
 404 {
 405     int             i_count;
 406     vlc_value_t *   p_values;
 407     int *           pi_types;
 408
 409 };
 410
 411 /**
 412  * \defgroup var_type Variable types
 413  * These are the different types a vlc variable can have.
 414  * @{
 415  */
 416 #define VLC_VAR_VOID      0x0010
 417 #define VLC_VAR_BOOL      0x0020
 418 #define VLC_VAR_INTEGER   0x0030
 419 #define VLC_VAR_HOTKEY    0x0031
 420 #define VLC_VAR_STRING    0x0040
 421 #define VLC_VAR_MODULE    0x0041
 422 #define VLC_VAR_FILE      0x0042
 423 #define VLC_VAR_DIRECTORY 0x0043
 424 #define VLC_VAR_VARIABLE  0x0044
 425 #define VLC_VAR_FLOAT     0x0050
 426 #define VLC_VAR_TIME      0x0060
 427 #define VLC_VAR_ADDRESS   0x0070
 428 #define VLC_VAR_MUTEX     0x0080
 429 #define VLC_VAR_LIST      0x0090
 430 /**@}*/
 431
 432 /*****************************************************************************
 433  * Error values (shouldn't be exposed)
 434  *****************************************************************************/
 435 #define VLC_SUCCESS         -0                                   /* No error */
 436 #define VLC_ENOMEM          -1                          /* Not enough memory */
 437 #define VLC_ETHREAD         -2                               /* Thread error */
 438 #define VLC_ETIMEOUT        -3                                    /* Timeout */
 439
 440 #define VLC_ENOMOD         -10                           /* Module not found */
 441
 442 #define VLC_ENOOBJ         -20                           /* Object not found */
 443
 444 #define VLC_ENOVAR         -30                         /* Variable not found */
 445 #define VLC_EBADVAR        -31                         /* Bad variable value */
 446
 447 #define VLC_ENOITEM        -40                           /**< Item not found */
 448
 449 #define VLC_EEXIT         -255                             /* Program exited */
 450 #define VLC_EEXITSUCCESS  -999                /* Program exited successfully */
 451 #define VLC_EGENERIC      -666                              /* Generic error */
 452
 453 /*****************************************************************************
 454  * Variable callbacks
 455  *****************************************************************************/
 456 typedef int ( * vlc_callback_t ) ( vlc_object_t *,      /* variable's object */
 457                                    char const *,            /* variable name */
 458                                    vlc_value_t,                 /* old value */
 459                                    vlc_value_t,                 /* new value */
 460                                    void * );                /* callback data */
 461
 462 /*****************************************************************************
 463  * Plug-in stuff
 464  *****************************************************************************/
 465
 466 #ifdef __cplusplus
 467 # define LIBVLC_EXTERN extern "C"
 468 #else
 469 # define LIBVLC_EXTERN extern
 470 #endif
 471 #if defined (WIN32) && defined (DLL_EXPORT)
 472 #if defined (UNDER_CE)
 473 # include <windef.h>
 474 #endif
 475 # define LIBVLC_EXPORT __declspec(dllexport)
 476 #else
 477 # define LIBVLC_EXPORT
 478 #endif
 479 #define VLC_EXPORT( type, name, args ) \
 480                         LIBVLC_EXTERN LIBVLC_EXPORT type name args
 481
 482 /*****************************************************************************
 483  * OS-specific headers and thread types
 484  *****************************************************************************/
 485 #if defined( WIN32 ) || defined( UNDER_CE )
 486 #   define WIN32_LEAN_AND_MEAN
 487 #   include <windows.h>
 488 #endif
 489
 490 #include "vlc_mtime.h"
 491 #include "vlc_threads.h"
 492
 493 /*****************************************************************************
 494  * Common structure members
 495  *****************************************************************************/
 496
 497 /* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
 498 #define VLC_COMMON_MEMBERS                                                  \
 499 /** \name VLC_COMMON_MEMBERS                                                \
 500  * these members are common for all vlc objects                             \
 501  */                                                                         \
 502 /**@{*/                                                                     \
 503     const char *psz_object_type;                                            \
 504     char *psz_object_name;                                                  \
 505                                                                             \
 506     /* Messages header */                                                   \
 507     char *psz_header;                                                       \
 508     int  i_flags;                                                           \
 509                                                                             \
 510     /* Object properties */                                                 \
 511     volatile bool b_error;                  /**< set by the object */ \
 512     volatile bool b_die;                   /**< set by the outside */ \
 513     bool b_force;      /**< set by the outside (eg. module_need()) */ \
 514                                                                             \
 515     /** Just a reminder so that people don't cast garbage */                \
 516     bool be_sure_to_add_VLC_COMMON_MEMBERS_to_struct;                       \
 517                                                                             \
 518     /* Stuff related to the libvlc structure */                             \
 519     libvlc_int_t *p_libvlc;                  /**< (root of all evil) - 1 */ \
 520                                                                             \
 521     vlc_object_t *  p_parent;                            /**< our parent */ \
 522                                                                             \
 523     /* Private data */                                                      \
 524     void *          p_private;                                              \
 525                                                                             \
 526 /**@}*/                                                                     \
 527
 528 /* VLC_OBJECT: attempt at doing a clever cast */
 529 #ifdef __GNUC__
 530 # define VLC_OBJECT( x ) \
 531     (((vlc_object_t *)(x))+0*(((typeof(x))0)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct))
 532 #else
 533 # define VLC_OBJECT( x ) ((vlc_object_t *)(x))
 534 #endif
 535
 536 typedef struct gc_object_t
 537 {
 538     vlc_spinlock_t spin;
 539     uintptr_t      refs;
 540     void          (*pf_destructor) (struct gc_object_t *);
 541 } gc_object_t;
 542
 543 /**
 544  * These members are common to all objects that wish to be garbage-collected.
 545  */
 546 #define VLC_GC_MEMBERS gc_object_t vlc_gc_data;
 547
 548 VLC_EXPORT(void *, vlc_gc_init, (gc_object_t *, void (*)(gc_object_t *)));
 549 VLC_EXPORT(void *, vlc_hold, (gc_object_t *));
 550 VLC_EXPORT(void, vlc_release, (gc_object_t *));
 551
 552 #define vlc_gc_init( a,b ) vlc_gc_init( &(a)->vlc_gc_data, (b) )
 553 #define vlc_gc_incref( a ) vlc_hold( &(a)->vlc_gc_data )
 554 #define vlc_gc_decref( a ) vlc_release( &(a)->vlc_gc_data )
 555 #define vlc_priv( gc, t ) ((t *)(((char *)(gc)) - offsetof(t, vlc_gc_data)))
 556
 557 /*****************************************************************************
 558  * Macros and inline functions
 559  *****************************************************************************/
 560
 561 /* CEIL: division with round to nearest greater integer */
 562 #define CEIL(n, d)  ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
 563
 564 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
 565 #define PAD(n, d)   ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
 566
 567 /* __MAX and __MIN: self explanatory */
 568 #ifndef __MAX
 569 #   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
 570 #endif
 571 #ifndef __MIN
 572 #   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
 573 #endif
 574
 575 LIBVLC_USED
 576 static inline int64_t GCD ( int64_t a, int64_t b )
 577 {
 578     while( b )
 579     {
 580         int64_t c = a % b;
 581         a = b;
 582         b = c;
 583     }
 584     return a;
 585 }
 586
 587 /* function imported from libavutil/common.h */
 588 LIBVLC_USED
 589 static inline uint8_t clip_uint8_vlc( int32_t a )
 590 {
 591     if( a&(~255) ) return (-a)>>31;
 592     else           return a;
 593 }
 594
 595 /* Free and set set the variable to NULL */
 596 #define FREENULL(a) do { free( a ); a = NULL; } while(0)
 597
 598 #define EMPTY_STR(str) (!str || !*str)
 599
 600 VLC_EXPORT( char const *, vlc_error, ( int ) LIBVLC_USED );
 601
 602 #include <vlc_arrays.h>
 603
 604 /* MSB (big endian)/LSB (little endian) conversions - network order is always
 605  * MSB, and should be used for both network communications and files. */
 606 LIBVLC_USED
 607 static inline uint16_t U16_AT( const void * _p )
 608 {
 609     const uint8_t * p = (const uint8_t *)_p;
 610     return ( ((uint16_t)p[0] << 8) | p[1] );
 611 }
 612
 613 LIBVLC_USED
 614 static inline uint32_t U32_AT( const void * _p )
 615 {
 616     const uint8_t * p = (const uint8_t *)_p;
 617     return ( ((uint32_t)p[0] << 24) | ((uint32_t)p[1] << 16)
 618               | ((uint32_t)p[2] << 8) | p[3] );
 619 }
 620
 621 LIBVLC_USED
 622 static inline uint64_t U64_AT( const void * _p )
 623 {
 624     const uint8_t * p = (const uint8_t *)_p;
 625     return ( ((uint64_t)p[0] << 56) | ((uint64_t)p[1] << 48)
 626               | ((uint64_t)p[2] << 40) | ((uint64_t)p[3] << 32)
 627               | ((uint64_t)p[4] << 24) | ((uint64_t)p[5] << 16)
 628               | ((uint64_t)p[6] << 8) | p[7] );
 629 }
 630
 631 LIBVLC_USED
 632 static inline uint16_t GetWLE( const void * _p )
 633 {
 634     const uint8_t * p = (const uint8_t *)_p;
 635     return ( ((uint16_t)p[1] << 8) | p[0] );
 636 }
 637
 638 LIBVLC_USED
 639 static inline uint32_t GetDWLE( const void * _p )
 640 {
 641     const uint8_t * p = (const uint8_t *)_p;
 642     return ( ((uint32_t)p[3] << 24) | ((uint32_t)p[2] << 16)
 643               | ((uint32_t)p[1] << 8) | p[0] );
 644 }
 645
 646 LIBVLC_USED
 647 static inline uint64_t GetQWLE( const void * _p )
 648 {
 649     const uint8_t * p = (const uint8_t *)_p;
 650     return ( ((uint64_t)p[7] << 56) | ((uint64_t)p[6] << 48)
 651               | ((uint64_t)p[5] << 40) | ((uint64_t)p[4] << 32)
 652               | ((uint64_t)p[3] << 24) | ((uint64_t)p[2] << 16)
 653               | ((uint64_t)p[1] << 8) | p[0] );
 654 }
 655
 656 #define GetWBE( p )     U16_AT( p )
 657 #define GetDWBE( p )    U32_AT( p )
 658 #define GetQWBE( p )    U64_AT( p )
 659
 660 /* Helper writer functions */
 661 #define SetWLE( p, v ) _SetWLE( (uint8_t*)(p), v)
 662 static inline void _SetWLE( uint8_t *p, uint16_t i_dw )
 663 {
 664     p[1] = ( i_dw >>  8 )&0xff;
 665     p[0] = ( i_dw       )&0xff;
 666 }
 667
 668 #define SetDWLE( p, v ) _SetDWLE( (uint8_t*)(p), v)
 669 static inline void _SetDWLE( uint8_t *p, uint32_t i_dw )
 670 {
 671     p[3] = ( i_dw >> 24 )&0xff;
 672     p[2] = ( i_dw >> 16 )&0xff;
 673     p[1] = ( i_dw >>  8 )&0xff;
 674     p[0] = ( i_dw       )&0xff;
 675 }
 676 #define SetQWLE( p, v ) _SetQWLE( (uint8_t*)(p), v)
 677 static inline void _SetQWLE( uint8_t *p, uint64_t i_qw )
 678 {
 679     SetDWLE( p,   i_qw&0xffffffff );
 680     SetDWLE( p+4, ( i_qw >> 32)&0xffffffff );
 681 }
 682 #define SetWBE( p, v ) _SetWBE( (uint8_t*)(p), v)
 683 static inline void _SetWBE( uint8_t *p, uint16_t i_dw )
 684 {
 685     p[0] = ( i_dw >>  8 )&0xff;
 686     p[1] = ( i_dw       )&0xff;
 687 }
 688
 689 #define SetDWBE( p, v ) _SetDWBE( (uint8_t*)(p), v)
 690 static inline void _SetDWBE( uint8_t *p, uint32_t i_dw )
 691 {
 692     p[0] = ( i_dw >> 24 )&0xff;
 693     p[1] = ( i_dw >> 16 )&0xff;
 694     p[2] = ( i_dw >>  8 )&0xff;
 695     p[3] = ( i_dw       )&0xff;
 696 }
 697 #define SetQWBE( p, v ) _SetQWBE( (uint8_t*)(p), v)
 698 static inline void _SetQWBE( uint8_t *p, uint64_t i_qw )
 699 {
 700     SetDWBE( p+4,   i_qw&0xffffffff );
 701     SetDWBE( p, ( i_qw >> 32)&0xffffffff );
 702 }
 703
 704 #define hton16(i) htons(i)
 705 #define hton32(i) htonl(i)
 706 #define ntoh16(i) ntohs(i)
 707 #define ntoh32(i) ntohl(i)
 708
 709 LIBVLC_USED
 710 static inline uint64_t ntoh64 (uint64_t ll)
 711 {
 712     union { uint64_t qw; uint8_t b[16]; } v = { ll };
 713     return ((uint64_t)v.b[0] << 56)
 714          | ((uint64_t)v.b[1] << 48)
 715          | ((uint64_t)v.b[2] << 40)
 716          | ((uint64_t)v.b[3] << 32)
 717          | ((uint64_t)v.b[4] << 24)
 718          | ((uint64_t)v.b[5] << 16)
 719          | ((uint64_t)v.b[6] <<  8)
 720          | ((uint64_t)v.b[7] <<  0);
 721 }
 722 #define hton64(i) ntoh64(i)
 723
 724 /* */
 725 #define VLC_UNUSED(x) (void)(x)
 726
 727 /* Stuff defined in src/extras/libc.c */
 728
 729 #if defined(WIN32) || defined(UNDER_CE)
 730 /* win32, cl and icl support */
 731 #   if defined( _MSC_VER ) || !defined( __MINGW32__ )
 732 #       define __attribute__(x)
 733 #       define __inline__      __inline
 734 #       define S_IFBLK         0x3000  /* Block */
 735 #       define S_ISBLK(m)      (0)
 736 #       define S_ISCHR(m)      (0)
 737 #       define S_ISFIFO(m)     (((m)&_S_IFMT) == _S_IFIFO)
 738 #       define S_ISREG(m)      (((m)&_S_IFMT) == _S_IFREG)
 739 #   endif
 740
 741 /* several type definitions */
 742 #   if defined( __MINGW32__ )
 743 #       if !defined( _OFF_T_ )
 744             typedef long long _off_t;
 745             typedef _off_t off_t;
 746 #           define _OFF_T_
 747 #       else
 748 #           ifdef off_t
 749 #               undef off_t
 750 #           endif
 751 #           define off_t long long
 752 #       endif
 753 #   endif
 754
 755 #   if defined( _MSC_VER ) && !defined( __WXMSW__ )
 756 #       if !defined( _OFF_T_DEFINED )
 757             typedef __int64 off_t;
 758 #           define _OFF_T_DEFINED
 759 #       else
 760             /* for wx compatibility typedef long off_t; */
 761 #           define off_t __int64
 762 #       endif
 763 #   endif
 764
 765 #   if defined( __BORLANDC__ )
 766 #       undef off_t
 767 #       define off_t unsigned __int64
 768 #   endif
 769
 770 #   ifndef O_NONBLOCK
 771 #       define O_NONBLOCK 0
 772 #   endif
 773
 774 #   ifndef alloca
 775 #       define alloca _alloca
 776 #   endif
 777
 778 #   include <tchar.h>
 779 #endif
 780
 781 VLC_EXPORT( bool, vlc_ureduce, ( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t ) );
 782
 783 /* iconv wrappers (defined in src/extras/libc.c) */
 784 typedef void *vlc_iconv_t;
 785 VLC_EXPORT( vlc_iconv_t, vlc_iconv_open, ( const char *, const char * ) LIBVLC_USED );
 786 VLC_EXPORT( size_t, vlc_iconv, ( vlc_iconv_t, const char **, size_t *, char **, size_t * ) LIBVLC_USED );
 787 VLC_EXPORT( int, vlc_iconv_close, ( vlc_iconv_t ) );
 788
 789 /* execve wrapper (defined in src/extras/libc.c) */
 790 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 );
 791 #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)
 792
 793 /* dir wrappers (defined in src/extras/libc.c) */
 794 VLC_EXPORT(int, vlc_wclosedir, ( void *_p_dir ));
 795
 796 /*****************************************************************************
 797  * CPU capabilities
 798  *****************************************************************************/
 799 #define CPU_CAPABILITY_NONE    0
 800 #define CPU_CAPABILITY_486     (1<<0)
 801 #define CPU_CAPABILITY_586     (1<<1)
 802 #define CPU_CAPABILITY_PPRO    (1<<2)
 803 #define CPU_CAPABILITY_MMX     (1<<3)
 804 #define CPU_CAPABILITY_3DNOW   (1<<4)
 805 #define CPU_CAPABILITY_MMXEXT  (1<<5)
 806 #define CPU_CAPABILITY_SSE     (1<<6)
 807 #define CPU_CAPABILITY_SSE2    (1<<7)
 808 #define CPU_CAPABILITY_ALTIVEC (1<<16)
 809 #define CPU_CAPABILITY_FPU     (1<<31)
 810 VLC_EXPORT( unsigned, vlc_CPU, ( void ) );
 811
 812 typedef void *(*vlc_memcpy_t) (void *tgt, const void *src, size_t n);
 813 typedef void *(*vlc_memset_t) (void *tgt, int c, size_t n);
 814
 815 VLC_EXPORT( void, vlc_fastmem_register, (vlc_memcpy_t cpy, vlc_memset_t set) );
 816 VLC_EXPORT( void *, vlc_memcpy, ( void *, const void *, size_t ) );
 817 VLC_EXPORT( void *, vlc_memset, ( void *, int, size_t ) );
 818
 819 /*****************************************************************************
 820  * I18n stuff
 821  *****************************************************************************/
 822 VLC_EXPORT( char *, vlc_gettext, ( const char *msgid ) LIBVLC_USED );
 823
 824 static inline const char *vlc_pgettext( const char *ctx, const char *id )
 825 {
 826     const char *tr = vlc_gettext( id );
 827     return (tr == ctx) ? id : tr;
 828 }
 829
 830 /*****************************************************************************
 831  * libvlc features
 832  *****************************************************************************/
 833 VLC_EXPORT( const char *, VLC_Version, ( void ) LIBVLC_USED );
 834 VLC_EXPORT( const char *, VLC_CompileBy, ( void ) LIBVLC_USED );
 835 VLC_EXPORT( const char *, VLC_CompileHost, ( void ) LIBVLC_USED );
 836 VLC_EXPORT( const char *, VLC_CompileDomain, ( void ) LIBVLC_USED );
 837 VLC_EXPORT( const char *, VLC_Compiler, ( void ) LIBVLC_USED );
 838 VLC_EXPORT( const char *, VLC_Error, ( int ) LIBVLC_USED );
 839
 840 /*****************************************************************************
 841  * Additional vlc stuff
 842  *****************************************************************************/
 843 #include "vlc_messages.h"
 844 #include "vlc_variables.h"
 845 #include "vlc_objects.h"
 846 #include "vlc_modules.h"
 847 #include "vlc_main.h"
 848 #include "vlc_configuration.h"
 849
 850 #if defined( WIN32 ) || defined( UNDER_CE )
 851 #   define DIR_SEP_CHAR '\\'
 852 #   define DIR_SEP "\\"
 853 #   define PATH_SEP_CHAR ';'
 854 #   define PATH_SEP ";"
 855 #else
 856 #   define DIR_SEP_CHAR '/'
 857 #   define DIR_SEP "/"
 858 #   define PATH_SEP_CHAR ':'
 859 #   define PATH_SEP ":"
 860 #endif
 861
 862 #define LICENSE_MSG \
 863   _("This program comes with NO WARRANTY, to the extent permitted by " \
 864     "law.\nYou may redistribute it under the terms of the GNU General " \
 865     "Public License;\nsee the file named COPYING for details.\n" \
 866     "Written by the VideoLAN team; see the AUTHORS file.\n")
 867
 868 #endif /* !VLC_COMMON_H */