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