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-2011 the VideoLAN team
   6  *
   7  * Authors: Samuel Hocevar <sam@via.ecp.fr>
   8  *          Vincent Seguin <seguin@via.ecp.fr>
   9  *          Gildas Bazin <gbazin@videolan.org>
  10  *          Rémi Denis-Courmont
  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 /* Helper for GCC version checks */
  60 #ifdef __GNUC__
  61 # define VLC_GCC_VERSION(maj,min) \
  62     ((__GNUC__ > (maj)) || (__GNUC__ == (maj) && __GNUC_MINOR__ >= (min)))
  63 #else
  64 # define VLC_GCC_VERSION(maj,min) (0)
  65 #endif
  66
  67 /* Try to fix format strings for all versions of mingw and mingw64 */
  68 #if defined( _WIN32 ) && defined( __USE_MINGW_ANSI_STDIO )
  69  #undef PRId64
  70  #define PRId64 "lld"
  71  #undef PRIi64
  72  #define PRIi64 "lli"
  73  #undef PRIu64
  74  #define PRIu64 "llu"
  75  #undef PRIo64
  76  #define PRIo64 "llo"
  77  #undef PRIx64
  78  #define PRIx64 "llx"
  79 #endif
  80
  81 /* Function attributes for compiler warnings */
  82 #ifdef __GNUC__
  83 # define VLC_DEPRECATED __attribute__((deprecated))
  84
  85 # if defined( _WIN32 ) && VLC_GCC_VERSION(4,4)
  86 #  define VLC_FORMAT(x,y) __attribute__ ((format(gnu_printf,x,y)))
  87 # else
  88 #  define VLC_FORMAT(x,y) __attribute__ ((format(printf,x,y)))
  89 # endif
  90 # define VLC_FORMAT_ARG(x) __attribute__ ((format_arg(x)))
  91
  92 # define VLC_MALLOC __attribute__ ((malloc))
  93 # define VLC_NORETURN __attribute__ ((noreturn))
  94
  95 # if VLC_GCC_VERSION(3,4)
  96 #  define VLC_USED __attribute__ ((warn_unused_result))
  97 # else
  98 #  define VLC_USED
  99 # endif
 100
 101 #else
 102 # define VLC_DEPRECATED
 103 # define VLC_FORMAT(x,y)
 104 # define VLC_FORMAT_ARG(x)
 105 # define VLC_MALLOC
 106 # define VLC_NORETURN
 107 # define VLC_USED
 108 #endif
 109
 110
 111 /* Branch prediction */
 112 #ifdef __GNUC__
 113 #   define likely(p)   __builtin_expect(!!(p), 1)
 114 #   define unlikely(p) __builtin_expect(!!(p), 0)
 115 #else
 116 #   define likely(p)   (!!(p))
 117 #   define unlikely(p) (!!(p))
 118 #endif
 119
 120 /* Linkage */
 121 #ifdef __cplusplus
 122 # define VLC_EXTERN extern "C"
 123 #else
 124 # define VLC_EXTERN
 125 #endif
 126
 127 #if defined (WIN32) && defined (DLL_EXPORT)
 128 # define VLC_EXPORT __declspec(dllexport)
 129 #elif VLC_GCC_VERSION(4,0)
 130 # define VLC_EXPORT __attribute__((visibility("default")))
 131 #else
 132 # define VLC_EXPORT
 133 #endif
 134
 135 #define VLC_API VLC_EXTERN VLC_EXPORT
 136
 137
 138 /*****************************************************************************
 139  * Basic types definitions
 140  *****************************************************************************/
 141 #if defined( WIN32 ) || defined( UNDER_CE )
 142 #   include <malloc.h>
 143 #   ifndef PATH_MAX
 144 #       define PATH_MAX MAX_PATH
 145 #   endif
 146 #endif
 147
 148 #ifdef __SYMBIAN32__
 149  #include <sys/syslimits.h>
 150 #endif
 151
 152 /* Counter for statistics and profiling */
 153 typedef unsigned long       count_t;
 154
 155 /* Audio volume */
 156 typedef uint16_t            audio_volume_t;
 157
 158 /**
 159  * High precision date or time interval
 160  *
 161  * Store a high precision date or time interval. The maximum precision is the
 162  * microsecond, and a 64 bits integer is used to avoid overflows (maximum
 163  * time interval is then 292271 years, which should be long enough for any
 164  * video). Dates are stored as microseconds since a common date (usually the
 165  * epoch). Note that date and time intervals can be manipulated using regular
 166  * arithmetic operators, and that no special functions are required.
 167  */
 168 typedef int64_t mtime_t;
 169
 170 /**
 171  * The vlc_fourcc_t type.
 172  *
 173  * See http://www.webartz.com/fourcc/ for a very detailed list.
 174  */
 175 typedef uint32_t vlc_fourcc_t;
 176
 177 #ifdef WORDS_BIGENDIAN
 178 #   define VLC_FOURCC( a, b, c, d ) \
 179         ( ((uint32_t)d) | ( ((uint32_t)c) << 8 ) \
 180            | ( ((uint32_t)b) << 16 ) | ( ((uint32_t)a) << 24 ) )
 181 #   define VLC_TWOCC( a, b ) \
 182         ( (uint16_t)(b) | ( (uint16_t)(a) << 8 ) )
 183
 184 #else
 185 #   define VLC_FOURCC( a, b, c, d ) \
 186         ( ((uint32_t)a) | ( ((uint32_t)b) << 8 ) \
 187            | ( ((uint32_t)c) << 16 ) | ( ((uint32_t)d) << 24 ) )
 188 #   define VLC_TWOCC( a, b ) \
 189         ( (uint16_t)(a) | ( (uint16_t)(b) << 8 ) )
 190
 191 #endif
 192
 193 /**
 194  * Translate a vlc_fourcc into its string representation. This function
 195  * assumes there is enough room in psz_fourcc to store 4 characters in.
 196  *
 197  * \param fcc a vlc_fourcc_t
 198  * \param psz_fourcc string to store string representation of vlc_fourcc in
 199  */
 200 static inline void vlc_fourcc_to_char( vlc_fourcc_t fcc, char *psz_fourcc )
 201 {
 202     memcpy( psz_fourcc, &fcc, 4 );
 203 }
 204
 205 #define vlc_fourcc_to_char( a, b ) \
 206         vlc_fourcc_to_char( (vlc_fourcc_t)(a), (char *)(b) )
 207
 208 /*****************************************************************************
 209  * Classes declaration
 210  *****************************************************************************/
 211
 212 /* Internal types */
 213 typedef struct vlc_list_t vlc_list_t;
 214 typedef struct vlc_object_t vlc_object_t;
 215 typedef struct libvlc_int_t libvlc_int_t;
 216 typedef struct date_t date_t;
 217
 218 /* Playlist */
 219
 220 /* FIXME */
 221 /**
 222  * Playlist commands
 223  */
 224 typedef enum {
 225     PLAYLIST_PLAY,      /**< No arg.                            res=can fail*/
 226     PLAYLIST_VIEWPLAY,  /**< arg1= playlist_item_t*,*/
 227                         /**  arg2 = playlist_item_t*          , res=can fail */
 228     PLAYLIST_PAUSE,     /**< No arg                             res=can fail*/
 229     PLAYLIST_STOP,      /**< No arg                             res=can fail*/
 230     PLAYLIST_SKIP,      /**< arg1=int,                          res=can fail*/
 231 } playlist_command_t;
 232
 233
 234 typedef struct playlist_t playlist_t;
 235 typedef struct playlist_item_t playlist_item_t;
 236 typedef struct playlist_view_t playlist_view_t;
 237 typedef struct services_discovery_t services_discovery_t;
 238 typedef struct services_discovery_sys_t services_discovery_sys_t;
 239 typedef struct playlist_add_t playlist_add_t;
 240
 241 /* Modules */
 242 typedef struct module_t module_t;
 243 typedef struct module_config_t module_config_t;
 244
 245 typedef struct config_category_t config_category_t;
 246
 247 /* Input */
 248 typedef struct input_thread_t input_thread_t;
 249 typedef struct input_item_t input_item_t;
 250 typedef struct input_item_node_t input_item_node_t;
 251 typedef struct access_t access_t;
 252 typedef struct access_sys_t access_sys_t;
 253 typedef struct stream_t     stream_t;
 254 typedef struct stream_sys_t stream_sys_t;
 255 typedef struct demux_t  demux_t;
 256 typedef struct demux_sys_t demux_sys_t;
 257 typedef struct es_out_t     es_out_t;
 258 typedef struct es_out_id_t  es_out_id_t;
 259 typedef struct es_out_sys_t es_out_sys_t;
 260 typedef struct seekpoint_t seekpoint_t;
 261 typedef struct info_t info_t;
 262 typedef struct info_category_t info_category_t;
 263 typedef struct input_attachment_t input_attachment_t;
 264
 265 /* Format */
 266 typedef struct audio_format_t audio_format_t;
 267 typedef struct video_format_t video_format_t;
 268 typedef struct subs_format_t subs_format_t;
 269 typedef struct es_format_t es_format_t;
 270 typedef struct video_palette_t video_palette_t;
 271
 272 /* Audio */
 273 typedef struct audio_output audio_output_t;
 274 typedef struct aout_sys_t aout_sys_t;
 275 typedef struct aout_fifo_t aout_fifo_t;
 276 typedef struct aout_input_t aout_input_t;
 277 typedef struct block_t aout_buffer_t;
 278 typedef audio_format_t audio_sample_format_t;
 279
 280 /* Video */
 281 typedef struct vout_thread_t vout_thread_t;
 282
 283 typedef video_format_t video_frame_format_t;
 284 typedef struct picture_t picture_t;
 285 typedef struct picture_sys_t picture_sys_t;
 286
 287 /* Subpictures */
 288 typedef struct spu_t spu_t;
 289 typedef struct subpicture_t subpicture_t;
 290 typedef struct subpicture_sys_t subpicture_sys_t;
 291 typedef struct subpicture_region_t subpicture_region_t;
 292
 293 typedef struct image_handler_t image_handler_t;
 294
 295 /* Stream output */
 296 typedef struct sout_instance_t sout_instance_t;
 297 typedef struct sout_instance_sys_t sout_instance_sys_t;
 298
 299 typedef struct sout_input_t sout_input_t;
 300 typedef struct sout_packetizer_input_t sout_packetizer_input_t;
 301
 302 typedef struct sout_access_out_t sout_access_out_t;
 303 typedef struct sout_access_out_sys_t   sout_access_out_sys_t;
 304
 305 typedef struct sout_mux_t sout_mux_t;
 306 typedef struct sout_mux_sys_t sout_mux_sys_t;
 307
 308 typedef struct sout_stream_t    sout_stream_t;
 309 typedef struct sout_stream_sys_t sout_stream_sys_t;
 310
 311 typedef struct config_chain_t       config_chain_t;
 312 typedef struct session_descriptor_t session_descriptor_t;
 313
 314 /* Decoders */
 315 typedef struct decoder_t         decoder_t;
 316 typedef struct decoder_sys_t     decoder_sys_t;
 317 typedef struct decoder_synchro_t decoder_synchro_t;
 318
 319 /* Encoders */
 320 typedef struct encoder_t      encoder_t;
 321 typedef struct encoder_sys_t  encoder_sys_t;
 322
 323 /* Filters */
 324 typedef struct filter_t filter_t;
 325 typedef struct filter_sys_t filter_sys_t;
 326
 327 /* Network */
 328 typedef struct virtual_socket_t v_socket_t;
 329 typedef struct vlc_acl_t vlc_acl_t;
 330 typedef struct vlc_url_t vlc_url_t;
 331
 332 /* Misc */
 333 typedef struct iso639_lang_t iso639_lang_t;
 334
 335 /* block */
 336 typedef struct block_t      block_t;
 337 typedef struct block_fifo_t block_fifo_t;
 338
 339 /* httpd */
 340 typedef struct httpd_t          httpd_t;
 341 typedef struct httpd_host_t     httpd_host_t;
 342 typedef struct httpd_url_t      httpd_url_t;
 343 typedef struct httpd_client_t   httpd_client_t;
 344 typedef struct httpd_callback_sys_t httpd_callback_sys_t;
 345 typedef struct httpd_message_t  httpd_message_t;
 346 typedef int    (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, const httpd_message_t *query );
 347 typedef struct httpd_file_t     httpd_file_t;
 348 typedef struct httpd_file_sys_t httpd_file_sys_t;
 349 typedef int (*httpd_file_callback_t)( httpd_file_sys_t *, httpd_file_t *, uint8_t *psz_request, uint8_t **pp_data, int *pi_data );
 350 typedef struct httpd_handler_t  httpd_handler_t;
 351 typedef struct httpd_handler_sys_t httpd_handler_sys_t;
 352 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 );
 353 typedef struct httpd_redirect_t httpd_redirect_t;
 354 typedef struct httpd_stream_t httpd_stream_t;
 355
 356 /* Hashing */
 357 typedef struct md5_s md5_t;
 358
 359 /* XML */
 360 typedef struct xml_t xml_t;
 361 typedef struct xml_sys_t xml_sys_t;
 362 typedef struct xml_reader_t xml_reader_t;
 363 typedef struct xml_reader_sys_t xml_reader_sys_t;
 364
 365 /* vod server */
 366 typedef struct vod_t     vod_t;
 367 typedef struct vod_sys_t vod_sys_t;
 368 typedef struct vod_media_t vod_media_t;
 369
 370 /* osdmenu */
 371 typedef struct osd_menu_t   osd_menu_t;
 372 typedef struct osd_state_t  osd_state_t;
 373 typedef struct osd_event_t  osd_event_t;
 374 typedef struct osd_button_t osd_button_t;
 375 typedef struct osd_menu_state_t osd_menu_state_t;
 376
 377 /* VLM */
 378 typedef struct vlm_t         vlm_t;
 379 typedef struct vlm_message_t vlm_message_t;
 380
 381 /* misc */
 382 typedef struct vlc_meta_t    vlc_meta_t;
 383
 384 /* Stats */
 385 typedef struct counter_t     counter_t;
 386 typedef struct counter_sample_t counter_sample_t;
 387 typedef struct stats_handler_t stats_handler_t;
 388 typedef struct input_stats_t input_stats_t;
 389
 390 /* Update */
 391 typedef struct update_t update_t;
 392 typedef struct update_iterator_t update_iterator_t;
 393
 394 /* Meta engine */
 395 typedef struct meta_engine_t meta_engine_t;
 396
 397 /* stat/lstat/fstat */
 398 #ifdef WIN32
 399 # include <sys/stat.h>
 400
 401 # ifndef UNDER_CE
 402 struct _stati64;
 403 #  define stat _stati64
 404 #  define fstat _fstati64
 405 #endif
 406
 407 /* You should otherwise use vlc_stat and vlc_lstat. */
 408 #else
 409 struct stat;
 410 #endif
 411
 412 /**
 413  * VLC value structure
 414  */
 415 typedef union
 416 {
 417     int64_t         i_int;
 418     bool            b_bool;
 419     float           f_float;
 420     char *          psz_string;
 421     void *          p_address;
 422     vlc_object_t *  p_object;
 423     vlc_list_t *    p_list;
 424     mtime_t         i_time;
 425     struct { int32_t x; int32_t y; } coords;
 426
 427 } vlc_value_t;
 428
 429 /**
 430  * VLC list structure
 431  */
 432 struct vlc_list_t
 433 {
 434     int             i_count;
 435     vlc_value_t *   p_values;
 436     int *           pi_types;
 437
 438 };
 439
 440 /*****************************************************************************
 441  * Error values (shouldn't be exposed)
 442  *****************************************************************************/
 443 #define VLC_SUCCESS         -0                                   /* No error */
 444 #define VLC_ENOMEM          -1                          /* Not enough memory */
 445 #define VLC_ETIMEOUT        -3                                    /* Timeout */
 446
 447 #define VLC_ENOMOD         -10                           /* Module not found */
 448
 449 #define VLC_ENOOBJ         -20                           /* Object not found */
 450
 451 #define VLC_ENOVAR         -30                         /* Variable not found */
 452 #define VLC_EBADVAR        -31                         /* Bad variable value */
 453
 454 #define VLC_ENOITEM        -40                           /**< Item not found */
 455
 456 #define VLC_EEXIT         -255                             /* Program exited */
 457 #define VLC_EEXITSUCCESS  -999                /* Program exited successfully */
 458 #define VLC_EGENERIC      -666                              /* Generic error */
 459
 460 /*****************************************************************************
 461  * Variable callbacks
 462  *****************************************************************************/
 463 typedef int ( * vlc_callback_t ) ( vlc_object_t *,      /* variable's object */
 464                                    char const *,            /* variable name */
 465                                    vlc_value_t,                 /* old value */
 466                                    vlc_value_t,                 /* new value */
 467                                    void * );                /* callback data */
 468
 469 /*****************************************************************************
 470  * OS-specific headers and thread types
 471  *****************************************************************************/
 472 #if defined( WIN32 ) || defined( UNDER_CE )
 473 /* WIN32_LEAN_AND_MEAN is needed to be able to include winsock2.h because else,
 474  * windows.h will also include winsock.h and declarations will conflict */
 475 # define WIN32_LEAN_AND_MEAN
 476 # include <windows.h>
 477 #endif
 478
 479 #include "vlc_mtime.h"
 480 #include "vlc_threads.h"
 481
 482 /**
 483  * Memory storage space for an atom. Never access it directly.
 484  */
 485 typedef union
 486 {
 487     volatile uintptr_t u;
 488     volatile intptr_t  s;
 489 } vlc_atomic_t;
 490
 491 /*****************************************************************************
 492  * Common structure members
 493  *****************************************************************************/
 494
 495 /* VLC_COMMON_MEMBERS : members common to all basic vlc objects */
 496 #define VLC_COMMON_MEMBERS                                                  \
 497 /** \name VLC_COMMON_MEMBERS                                                \
 498  * these members are common for all vlc objects                             \
 499  */                                                                         \
 500 /**@{*/                                                                     \
 501     const char *psz_object_type;                                            \
 502                                                                             \
 503     /* Messages header */                                                   \
 504     char *psz_header;                                                       \
 505     int  i_flags;                                                           \
 506                                                                             \
 507     /* Object properties */                                                 \
 508     volatile bool b_die;                   /**< set by the outside */ \
 509     bool b_force;      /**< set by the outside (eg. module_need()) */ \
 510                                                                             \
 511     /* Stuff related to the libvlc structure */                             \
 512     libvlc_int_t *p_libvlc;                  /**< (root of all evil) - 1 */ \
 513                                                                             \
 514     vlc_object_t *  p_parent;                            /**< our parent */ \
 515                                                                             \
 516 /**@}*/                                                                     \
 517
 518 /* VLC_OBJECT: attempt at doing a clever cast */
 519 #if VLC_GCC_VERSION(4,0)
 520 # ifndef __cplusplus
 521 #  define VLC_OBJECT( x ) \
 522     __builtin_choose_expr( \
 523         __builtin_offsetof(__typeof__(*(x)), psz_object_type), \
 524         (void)0 /* screw you */, \
 525         (vlc_object_t *)(x))
 526 # else
 527 #  define VLC_OBJECT( x ) \
 528     ((vlc_object_t *)(x) \
 529       + 0 * __builtin_offsetof(__typeof__(*(x)), psz_object_type))
 530 # endif
 531 #else
 532 # define VLC_OBJECT( x ) ((vlc_object_t *)(x))
 533 #endif
 534
 535 typedef struct gc_object_t
 536 {
 537     vlc_atomic_t    refs;
 538     void          (*pf_destructor) (struct gc_object_t *);
 539 } gc_object_t;
 540
 541 /**
 542  * These members are common to all objects that wish to be garbage-collected.
 543  */
 544 #define VLC_GC_MEMBERS gc_object_t vlc_gc_data;
 545
 546 VLC_API void * vlc_gc_init(gc_object_t *, void (*)(gc_object_t *));
 547 VLC_API void * vlc_hold(gc_object_t *);
 548 VLC_API void vlc_release(gc_object_t *);
 549
 550 #define vlc_gc_init( a,b ) vlc_gc_init( &(a)->vlc_gc_data, (b) )
 551 #define vlc_gc_incref( a ) vlc_hold( &(a)->vlc_gc_data )
 552 #define vlc_gc_decref( a ) vlc_release( &(a)->vlc_gc_data )
 553 #define vlc_priv( gc, t ) ((t *)(((char *)(gc)) - offsetof(t, vlc_gc_data)))
 554
 555 /*****************************************************************************
 556  * Macros and inline functions
 557  *****************************************************************************/
 558
 559 /* CEIL: division with round to nearest greater integer */
 560 #define CEIL(n, d)  ( ((n) / (d)) + ( ((n) % (d)) ? 1 : 0) )
 561
 562 /* PAD: PAD(n, d) = CEIL(n ,d) * d */
 563 #define PAD(n, d)   ( ((n) % (d)) ? ((((n) / (d)) + 1) * (d)) : (n) )
 564
 565 /* __MAX and __MIN: self explanatory */
 566 #ifndef __MAX
 567 #   define __MAX(a, b)   ( ((a) > (b)) ? (a) : (b) )
 568 #endif
 569 #ifndef __MIN
 570 #   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
 571 #endif
 572
 573 VLC_USED
 574 static inline int64_t GCD ( int64_t a, int64_t b )
 575 {
 576     while( b )
 577     {
 578         int64_t c = a % b;
 579         a = b;
 580         b = c;
 581     }
 582     return a;
 583 }
 584
 585 /* function imported from libavutil/common.h */
 586 VLC_USED
 587 static inline uint8_t clip_uint8_vlc( int32_t a )
 588 {
 589     if( a&(~255) ) return (-a)>>31;
 590     else           return a;
 591 }
 592
 593 /** Count leading zeroes */
 594 VLC_USED
 595 static inline unsigned clz (unsigned x)
 596 {
 597 #if VLC_GCC_VERSION(3,4)
 598     return __builtin_clz (x);
 599 #else
 600     unsigned i = sizeof (x) * 8;
 601
 602     while (x)
 603     {
 604         x = x >> 1;
 605         i--;
 606     }
 607     return i;
 608 #endif
 609 }
 610
 611 #define clz8( x ) (clz(x) - ((sizeof(unsigned) - sizeof (uint8_t)) * 8))
 612 #define clz16( x ) (clz(x) - ((sizeof(unsigned) - sizeof (uint16_t)) * 8))
 613 /* XXX: this assumes that int is 32-bits or more */
 614 #define clz32( x ) (clz(x) - ((sizeof(unsigned) - sizeof (uint32_t)) * 8))
 615
 616 /** Bit weight */
 617 VLC_USED
 618 static inline unsigned popcount (unsigned x)
 619 {
 620 #if VLC_GCC_VERSION(3,4)
 621     return __builtin_popcount (x);
 622 #else
 623     unsigned count = 0;
 624     while (x)
 625     {
 626         count += x & 1;
 627         x = x >> 1;
 628     }
 629     return count;
 630 #endif
 631 }
 632
 633 /** Byte swap (16 bits) */
 634 VLC_USED
 635 static inline uint16_t bswap16 (uint16_t x)
 636 {
 637     return (x << 8) | (x >> 8);
 638 }
 639
 640 /** Byte swap (32 bits) */
 641 VLC_USED
 642 static inline uint32_t bswap32 (uint32_t x)
 643 {
 644 #if VLC_GCC_VERSION(4,3)
 645     return __builtin_bswap32 (x);
 646 #else
 647     return ((x & 0x000000FF) << 24)
 648          | ((x & 0x0000FF00) <<  8)
 649          | ((x & 0x00FF0000) >>  8)
 650          | ((x & 0xFF000000) >> 24);
 651 #endif
 652 }
 653
 654 /** Byte swap (64 bits) */
 655 VLC_USED
 656 static inline uint64_t bswap64 (uint64_t x)
 657 {
 658 #if VLC_GCC_VERSION(4,3)
 659     return __builtin_bswap64 (x);
 660 #elif !defined (__cplusplus)
 661     return ((x & 0x00000000000000FF) << 56)
 662          | ((x & 0x000000000000FF00) << 40)
 663          | ((x & 0x0000000000FF0000) << 24)
 664          | ((x & 0x00000000FF000000) <<  8)
 665          | ((x & 0x000000FF00000000) >>  8)
 666          | ((x & 0x0000FF0000000000) >> 24)
 667          | ((x & 0x00FF000000000000) >> 40)
 668          | ((x & 0xFF00000000000000) >> 56);
 669 #else
 670     return ((x & 0x00000000000000FFLLU) << 56)
 671          | ((x & 0x000000000000FF00LLU) << 40)
 672          | ((x & 0x0000000000FF0000LLU) << 24)
 673          | ((x & 0x00000000FF000000LLU) <<  8)
 674          | ((x & 0x000000FF00000000LLU) >>  8)
 675          | ((x & 0x0000FF0000000000LLU) >> 24)
 676          | ((x & 0x00FF000000000000LLU) >> 40)
 677          | ((x & 0xFF00000000000000LLU) >> 56);
 678 #endif
 679 }
 680
 681
 682 /* Free and set set the variable to NULL */
 683 #define FREENULL(a) do { free( a ); a = NULL; } while(0)
 684
 685 #define EMPTY_STR(str) (!str || !*str)
 686
 687 VLC_API char const * vlc_error( int ) VLC_USED;
 688
 689 #include <vlc_arrays.h>
 690
 691 /* MSB (big endian)/LSB (little endian) conversions - network order is always
 692  * MSB, and should be used for both network communications and files. */
 693
 694 #ifdef WORDS_BIGENDIAN
 695 # define hton16(i) ((uint16_t)(i))
 696 # define hton32(i) ((uint32_t)(i))
 697 # define hton64(i) ((uint64_t)(i))
 698 #else
 699 # define hton16(i) bswap16(i)
 700 # define hton32(i) bswap32(i)
 701 # define hton64(i) bswap64(i)
 702 #endif
 703 #define ntoh16(i) hton16(i)
 704 #define ntoh32(i) hton32(i)
 705 #define ntoh64(i) hton64(i)
 706
 707 /** Reads 16 bits in network byte order */
 708 VLC_USED
 709 static inline uint16_t U16_AT (const void *p)
 710 {
 711     uint16_t x;
 712
 713     memcpy (&x, p, sizeof (x));
 714     return ntoh16 (x);
 715 }
 716
 717 /** Reads 32 bits in network byte order */
 718 VLC_USED
 719 static inline uint32_t U32_AT (const void *p)
 720 {
 721     uint32_t x;
 722
 723     memcpy (&x, p, sizeof (x));
 724     return ntoh32 (x);
 725 }
 726
 727 /** Reads 64 bits in network byte order */
 728 VLC_USED
 729 static inline uint64_t U64_AT (const void *p)
 730 {
 731     uint64_t x;
 732
 733     memcpy (&x, p, sizeof (x));
 734     return ntoh64 (x);
 735 }
 736
 737 #define GetWBE(p)  U16_AT(p)
 738 #define GetDWBE(p) U32_AT(p)
 739 #define GetQWBE(p) U64_AT(p)
 740
 741 /** Reads 16 bits in little-endian order */
 742 VLC_USED
 743 static inline uint16_t GetWLE (const void *p)
 744 {
 745     uint16_t x;
 746
 747     memcpy (&x, p, sizeof (x));
 748 #ifdef WORDS_BIGENDIAN
 749     x = bswap16 (x);
 750 #endif
 751     return x;
 752 }
 753
 754 /** Reads 32 bits in little-endian order */
 755 VLC_USED
 756 static inline uint32_t GetDWLE (const void *p)
 757 {
 758     uint32_t x;
 759
 760     memcpy (&x, p, sizeof (x));
 761 #ifdef WORDS_BIGENDIAN
 762     x = bswap32 (x);
 763 #endif
 764     return x;
 765 }
 766
 767 /** Reads 64 bits in little-endian order */
 768 VLC_USED
 769 static inline uint64_t GetQWLE (const void *p)
 770 {
 771     uint64_t x;
 772
 773     memcpy (&x, p, sizeof (x));
 774 #ifdef WORDS_BIGENDIAN
 775     x = bswap64 (x);
 776 #endif
 777     return x;
 778 }
 779
 780 /** Writes 16 bits in network byte order */
 781 static inline void SetWBE (void *p, uint16_t w)
 782 {
 783     w = hton16 (w);
 784     memcpy (p, &w, sizeof (w));
 785 }
 786
 787 /** Writes 32 bits in network byte order */
 788 static inline void SetDWBE (void *p, uint32_t dw)
 789 {
 790     dw = hton32 (dw);
 791     memcpy (p, &dw, sizeof (dw));
 792 }
 793
 794 /** Writes 64 bits in network byte order */
 795 static inline void SetQWBE (void *p, uint64_t qw)
 796 {
 797     qw = hton64 (qw);
 798     memcpy (p, &qw, sizeof (qw));
 799 }
 800
 801 /** Writes 16 bits in little endian order */
 802 static inline void SetWLE (void *p, uint16_t w)
 803 {
 804 #ifdef WORDS_BIGENDIAN
 805     w = bswap16 (w);
 806 #endif
 807     memcpy (p, &w, sizeof (w));
 808 }
 809
 810 /** Writes 32 bits in little endian order */
 811 static inline void SetDWLE (void *p, uint32_t dw)
 812 {
 813 #ifdef WORDS_BIGENDIAN
 814     dw = bswap32 (dw);
 815 #endif
 816     memcpy (p, &dw, sizeof (dw));
 817 }
 818
 819 /** Writes 64 bits in little endian order */
 820 static inline void SetQWLE (void *p, uint64_t qw)
 821 {
 822 #ifdef WORDS_BIGENDIAN
 823     qw = bswap64 (qw);
 824 #endif
 825     memcpy (p, &qw, sizeof (qw));
 826 }
 827
 828 /* */
 829 #define VLC_UNUSED(x) (void)(x)
 830
 831 /* Stuff defined in src/extras/libc.c */
 832
 833 #if defined(WIN32) || defined(UNDER_CE)
 834 /* win32, cl and icl support */
 835 #   if defined( _MSC_VER ) || !defined( __MINGW32__ )
 836 #       define __attribute__(x)
 837 #       define S_IFBLK         0x3000  /* Block */
 838 #       define S_ISBLK(m)      (0)
 839 #       define S_ISCHR(m)      (0)
 840 #       define S_ISFIFO(m)     (((m)&_S_IFMT) == _S_IFIFO)
 841 #       define S_ISREG(m)      (((m)&_S_IFMT) == _S_IFREG)
 842 #   endif
 843
 844 /* several type definitions */
 845 #   if defined( __MINGW32__ )
 846 #       if !defined( _OFF_T_ )
 847             typedef long long _off_t;
 848             typedef _off_t off_t;
 849 #           define _OFF_T_
 850 #       else
 851 #           ifdef off_t
 852 #               undef off_t
 853 #           endif
 854 #           define off_t long long
 855 #       endif
 856 #   endif
 857
 858 #   if defined( _MSC_VER )
 859 #       if !defined( _OFF_T_DEFINED )
 860             typedef __int64 off_t;
 861 #           define _OFF_T_DEFINED
 862 #       else
 863             /* for wx compatibility typedef long off_t; */
 864 #           define off_t __int64
 865 #       endif
 866 #   endif
 867
 868 #   if defined( __BORLANDC__ )
 869 #       undef off_t
 870 #       define off_t unsigned __int64
 871 #   endif
 872
 873 #   ifndef O_NONBLOCK
 874 #       define O_NONBLOCK 0
 875 #   endif
 876
 877 #   ifndef alloca
 878 #       define alloca _alloca
 879 #   endif
 880
 881 #   include <tchar.h>
 882 #endif
 883
 884 VLC_API bool vlc_ureduce( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t );
 885
 886 /* Aligned memory allocator */
 887 #ifdef __APPLE__
 888 #include <AvailabilityMacros.h>
 889 #endif
 890
 891 #ifdef WIN32
 892 # include <malloc.h>
 893 # define vlc_memalign(align, size) (__mingw_aligned_malloc(size, align))
 894 # define vlc_free(base)            (__mingw_aligned_free(base))
 895 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
 896 static inline void *vlc_memalign(size_t align, size_t size)
 897 {
 898     long diff;
 899     void *ptr;
 900
 901     ptr = malloc(size+align);
 902     if(!ptr)
 903         return ptr;
 904     diff = ((-(long)ptr - 1)&(align-1)) + 1;
 905     ptr  = (char*)ptr + diff;
 906     ((char*)ptr)[-1]= diff;
 907     return ptr;
 908 }
 909
 910 static void vlc_free(void *ptr)
 911 {
 912     if (ptr)
 913         free((char*)ptr - ((char*)ptr)[-1]);
 914 }
 915 #elif defined(__ANDROID__)
 916 # define vlc_memalign(align, size) memalign(align, size)
 917 # define vlc_free(base) free(base)
 918 #else
 919 static inline void *vlc_memalign(size_t align, size_t size)
 920 {
 921     void *base;
 922     if (unlikely(posix_memalign(&base, align, size)))
 923         base = NULL;
 924     return base;
 925 }
 926 # define vlc_free(base) free(base)
 927 #endif
 928
 929 VLC_API void vlc_tdestroy( void *, void (*)(void *) );
 930
 931 /* Fast large memory copy and memory set */
 932 VLC_API void * vlc_memcpy( void *, const void *, size_t );
 933 #define vlc_memset memset
 934
 935 /*****************************************************************************
 936  * I18n stuff
 937  *****************************************************************************/
 938 VLC_API char * vlc_gettext( const char *msgid ) VLC_FORMAT_ARG(1);
 939
 940 #define vlc_pgettext( ctx, id ) \
 941         vlc_pgettext_aux( ctx "\004" id, id )
 942
 943 VLC_FORMAT_ARG(2)
 944 static inline const char *vlc_pgettext_aux( const char *ctx, const char *id )
 945 {
 946     const char *tr = vlc_gettext( ctx );
 947     return (tr == ctx) ? id : tr;
 948 }
 949
 950 /*****************************************************************************
 951  * Loosy memory allocation functions. Do not use in new code.
 952  *****************************************************************************/
 953 static inline void *xmalloc (size_t len)
 954 {
 955     void *ptr = malloc (len);
 956     if (unlikely (ptr == NULL))
 957         abort ();
 958     return ptr;
 959 }
 960
 961 static inline void *xrealloc (void *ptr, size_t len)
 962 {
 963     void *nptr = realloc (ptr, len);
 964     if (unlikely (nptr == NULL))
 965         abort ();
 966     return nptr;
 967 }
 968
 969 static inline void *xcalloc (size_t n, size_t size)
 970 {
 971     void *ptr = calloc (n, size);
 972     if (unlikely (ptr == NULL))
 973         abort ();
 974     return ptr;
 975 }
 976
 977 /*****************************************************************************
 978  * libvlc features
 979  *****************************************************************************/
 980 VLC_API const char * VLC_CompileBy( void ) VLC_USED;
 981 VLC_API const char * VLC_CompileHost( void ) VLC_USED;
 982 VLC_API const char * VLC_Compiler( void ) VLC_USED;
 983
 984 /*****************************************************************************
 985  * Additional vlc stuff
 986  *****************************************************************************/
 987 #include "vlc_messages.h"
 988 #include "vlc_objects.h"
 989 #include "vlc_variables.h"
 990 #include "vlc_main.h"
 991 #include "vlc_configuration.h"
 992
 993 #if defined( WIN32 ) || defined( UNDER_CE ) || defined( __SYMBIAN32__ ) || defined( __OS2__ )
 994 #   define DIR_SEP_CHAR '\\'
 995 #   define DIR_SEP "\\"
 996 #   define PATH_SEP_CHAR ';'
 997 #   define PATH_SEP ";"
 998 #else
 999 #   define DIR_SEP_CHAR '/'
1000 #   define DIR_SEP "/"
1001 #   define PATH_SEP_CHAR ':'
1002 #   define PATH_SEP ":"
1003 #endif
1004
1005 #define LICENSE_MSG \
1006   _("This program comes with NO WARRANTY, to the extent permitted by " \
1007     "law.\nYou may redistribute it under the terms of the GNU General " \
1008     "Public License;\nsee the file named COPYING for details.\n" \
1009     "Written by the VideoLAN team; see the AUTHORS file.\n")
1010
1011 #endif /* !VLC_COMMON_H */