]> git.sesse.net Git - vlc/blobdiff - include/vlc_common.h
decoder: fix data race in input_DecoderFrameNext()
[vlc] / include / vlc_common.h
index a752692375869d92bad9405fec0db85fb44322d6..98d91fcccc107438356a7b77c443b6257aa06d9c 100644 (file)
@@ -1,27 +1,27 @@
 /*****************************************************************************
- * common.h: common definitions
+ * vlc_common.h: common definitions
  * Collection of useful common types and macros definitions
  *****************************************************************************
- * Copyright (C) 1998-2011 the VideoLAN team
+ * Copyright (C) 1998-2011 VLC authors and VideoLAN
  *
  * Authors: Samuel Hocevar <sam@via.ecp.fr>
  *          Vincent Seguin <seguin@via.ecp.fr>
  *          Gildas Bazin <gbazin@videolan.org>
  *          RĂ©mi Denis-Courmont
  *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 of the License, or
  * (at your option) any later version.
  *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
  *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
 /**
 /*****************************************************************************
  * Required vlc headers
  *****************************************************************************/
-#if defined( _MSC_VER )
-#   pragma warning( disable : 4244 )
-#endif
-
 #include "vlc_config.h"
 
 /*****************************************************************************
@@ -56,6 +52,9 @@
 # include <stdbool.h>
 #endif
 
+/*****************************************************************************
+ * Compilers definitions
+ *****************************************************************************/
 /* Helper for GCC version checks */
 #ifdef __GNUC__
 # define VLC_GCC_VERSION(maj,min) \
@@ -76,6 +75,9 @@
  #define PRIo64 "llo"
  #undef PRIx64
  #define PRIx64 "llx"
+ #define snprintf __mingw_snprintf
+ #define vsnprintf __mingw_vsnprintf
+ #define swprintf _snwprintf
 #endif
 
 /* Function attributes for compiler warnings */
 
 /* Branch prediction */
 #ifdef __GNUC__
-#   define likely(p)   __builtin_expect(!!(p), 1)
-#   define unlikely(p) __builtin_expect(!!(p), 0)
+# define likely(p)     __builtin_expect(!!(p), 1)
+# define unlikely(p)   __builtin_expect(!!(p), 0)
+# define unreachable() __builtin_unreachable()
 #else
-#   define likely(p)   (!!(p))
-#   define unlikely(p) (!!(p))
+# define likely(p)     (!!(p))
+# define unlikely(p)   (!!(p))
+# define unreachable() ((void)0)
 #endif
 
+#define vlc_assert_unreachable() (assert(!"unreachable"), unreachable())
+
 /* Linkage */
 #ifdef __cplusplus
 # define VLC_EXTERN extern "C"
 # define VLC_EXTERN
 #endif
 
-#if defined (WIN32) && defined (DLL_EXPORT)
+#if defined (_WIN32) && defined (DLL_EXPORT)
 # define VLC_EXPORT __declspec(dllexport)
 #elif VLC_GCC_VERSION(4,0)
 # define VLC_EXPORT __attribute__((visibility("default")))
 /*****************************************************************************
  * Basic types definitions
  *****************************************************************************/
-#if defined( WIN32 ) || defined( UNDER_CE )
-#   include <malloc.h>
-#   ifndef PATH_MAX
-#       define PATH_MAX MAX_PATH
-#   endif
-#endif
-
-#ifdef __SYMBIAN32__
- #include <sys/syslimits.h>
-#endif
-
-/* Counter for statistics and profiling */
-typedef unsigned long       count_t;
-
-/* Audio volume */
-typedef uint16_t            audio_volume_t;
-
 /**
  * High precision date or time interval
  *
@@ -217,23 +206,8 @@ typedef struct date_t date_t;
 
 /* Playlist */
 
-/* FIXME */
-/**
- * Playlist commands
- */
-typedef enum {
-    PLAYLIST_PLAY,      /**< No arg.                            res=can fail*/
-    PLAYLIST_VIEWPLAY,  /**< arg1= playlist_item_t*,*/
-                        /**  arg2 = playlist_item_t*          , res=can fail */
-    PLAYLIST_PAUSE,     /**< No arg                             res=can fail*/
-    PLAYLIST_STOP,      /**< No arg                             res=can fail*/
-    PLAYLIST_SKIP,      /**< arg1=int,                          res=can fail*/
-} playlist_command_t;
-
-
 typedef struct playlist_t playlist_t;
 typedef struct playlist_item_t playlist_item_t;
-typedef struct playlist_view_t playlist_view_t;
 typedef struct services_discovery_t services_discovery_t;
 typedef struct services_discovery_sys_t services_discovery_sys_t;
 typedef struct playlist_add_t playlist_add_t;
@@ -272,9 +246,6 @@ typedef struct video_palette_t video_palette_t;
 /* Audio */
 typedef struct audio_output audio_output_t;
 typedef struct aout_sys_t aout_sys_t;
-typedef struct aout_fifo_t aout_fifo_t;
-typedef struct aout_input_t aout_input_t;
-typedef struct block_t aout_buffer_t;
 typedef audio_format_t audio_sample_format_t;
 
 /* Video */
@@ -287,14 +258,12 @@ typedef struct picture_sys_t picture_sys_t;
 /* Subpictures */
 typedef struct spu_t spu_t;
 typedef struct subpicture_t subpicture_t;
-typedef struct subpicture_sys_t subpicture_sys_t;
 typedef struct subpicture_region_t subpicture_region_t;
 
 typedef struct image_handler_t image_handler_t;
 
 /* Stream output */
 typedef struct sout_instance_t sout_instance_t;
-typedef struct sout_instance_sys_t sout_instance_sys_t;
 
 typedef struct sout_input_t sout_input_t;
 typedef struct sout_packetizer_input_t sout_packetizer_input_t;
@@ -326,7 +295,6 @@ typedef struct filter_sys_t filter_sys_t;
 
 /* Network */
 typedef struct virtual_socket_t v_socket_t;
-typedef struct vlc_acl_t vlc_acl_t;
 typedef struct vlc_url_t vlc_url_t;
 
 /* Misc */
@@ -336,23 +304,6 @@ typedef struct iso639_lang_t iso639_lang_t;
 typedef struct block_t      block_t;
 typedef struct block_fifo_t block_fifo_t;
 
-/* httpd */
-typedef struct httpd_t          httpd_t;
-typedef struct httpd_host_t     httpd_host_t;
-typedef struct httpd_url_t      httpd_url_t;
-typedef struct httpd_client_t   httpd_client_t;
-typedef struct httpd_callback_sys_t httpd_callback_sys_t;
-typedef struct httpd_message_t  httpd_message_t;
-typedef int    (*httpd_callback_t)( httpd_callback_sys_t *, httpd_client_t *, httpd_message_t *answer, const httpd_message_t *query );
-typedef struct httpd_file_t     httpd_file_t;
-typedef struct httpd_file_sys_t httpd_file_sys_t;
-typedef int (*httpd_file_callback_t)( httpd_file_sys_t *, httpd_file_t *, uint8_t *psz_request, uint8_t **pp_data, int *pi_data );
-typedef struct httpd_handler_t  httpd_handler_t;
-typedef struct httpd_handler_sys_t httpd_handler_sys_t;
-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 );
-typedef struct httpd_redirect_t httpd_redirect_t;
-typedef struct httpd_stream_t httpd_stream_t;
-
 /* Hashing */
 typedef struct md5_s md5_t;
 
@@ -367,47 +318,17 @@ typedef struct vod_t     vod_t;
 typedef struct vod_sys_t vod_sys_t;
 typedef struct vod_media_t vod_media_t;
 
-/* osdmenu */
-typedef struct osd_menu_t   osd_menu_t;
-typedef struct osd_state_t  osd_state_t;
-typedef struct osd_event_t  osd_event_t;
-typedef struct osd_button_t osd_button_t;
-typedef struct osd_menu_state_t osd_menu_state_t;
-
 /* VLM */
 typedef struct vlm_t         vlm_t;
 typedef struct vlm_message_t vlm_message_t;
 
 /* misc */
 typedef struct vlc_meta_t    vlc_meta_t;
-
-/* Stats */
-typedef struct counter_t     counter_t;
-typedef struct counter_sample_t counter_sample_t;
-typedef struct stats_handler_t stats_handler_t;
 typedef struct input_stats_t input_stats_t;
+typedef struct addon_entry_t addon_entry_t;
 
 /* Update */
 typedef struct update_t update_t;
-typedef struct update_iterator_t update_iterator_t;
-
-/* Meta engine */
-typedef struct meta_engine_t meta_engine_t;
-
-/* stat/lstat/fstat */
-#ifdef WIN32
-# include <sys/stat.h>
-
-# ifndef UNDER_CE
-struct _stati64;
-#  define stat _stati64
-#  define fstat _fstati64
-#endif
-
-/* You should otherwise use vlc_stat and vlc_lstat. */
-#else
-struct stat;
-#endif
 
 /**
  * VLC value structure
@@ -419,7 +340,6 @@ typedef union
     float           f_float;
     char *          psz_string;
     void *          p_address;
-    vlc_object_t *  p_object;
     vlc_list_t *    p_list;
     mtime_t         i_time;
     struct { int32_t x; int32_t y; } coords;
@@ -431,34 +351,26 @@ typedef union
  */
 struct vlc_list_t
 {
-    int             i_count;
-    vlc_value_t *   p_values;
-    int *           pi_types;
-
+    int          i_type;
+    int          i_count;
+    vlc_value_t *p_values;
 };
 
 /*****************************************************************************
  * Error values (shouldn't be exposed)
  *****************************************************************************/
-#define VLC_SUCCESS         -0                                   /* No error */
-#define VLC_ENOMEM          -1                          /* Not enough memory */
-#define VLC_ETIMEOUT        -3                                    /* Timeout */
-
-#define VLC_ENOMOD         -10                           /* Module not found */
-
-#define VLC_ENOOBJ         -20                           /* Object not found */
-
-#define VLC_ENOVAR         -30                         /* Variable not found */
-#define VLC_EBADVAR        -31                         /* Bad variable value */
-
-#define VLC_ENOITEM        -40                           /**< Item not found */
-
-#define VLC_EEXIT         -255                             /* Program exited */
-#define VLC_EEXITSUCCESS  -999                /* Program exited successfully */
-#define VLC_EGENERIC      -666                              /* Generic error */
+#define VLC_SUCCESS        (-0) /**< No error */
+#define VLC_EGENERIC       (-1) /**< Unspecified error */
+#define VLC_ENOMEM         (-2) /**< Not enough memory */
+#define VLC_ETIMEOUT       (-3) /**< Timeout */
+#define VLC_ENOMOD         (-4) /**< Module not found */
+#define VLC_ENOOBJ         (-5) /**< Object not found */
+#define VLC_ENOVAR         (-6) /**< Variable not found */
+#define VLC_EBADVAR        (-7) /**< Bad variable value */
+#define VLC_ENOITEM        (-8) /**< Item not found */
 
 /*****************************************************************************
- * Variable callbacks
+ * Variable callbacks: called when the value is modified
  *****************************************************************************/
 typedef int ( * vlc_callback_t ) ( vlc_object_t *,      /* variable's object */
                                    char const *,            /* variable name */
@@ -466,35 +378,47 @@ typedef int ( * vlc_callback_t ) ( vlc_object_t *,      /* variable's object */
                                    vlc_value_t,                 /* new value */
                                    void * );                /* callback data */
 
+/*****************************************************************************
+ * List callbacks: called when elements are added/removed from the list
+ *****************************************************************************/
+typedef int ( * vlc_list_callback_t ) ( vlc_object_t *,      /* variable's object */
+                                        char const *,            /* variable name */
+                                        int,                  /* VLC_VAR_* action */
+                                        vlc_value_t *,      /* new/deleted value  */
+                                        void *);                 /* callback data */
+
+typedef enum
+{
+    vlc_value_callback,
+    vlc_list_callback
+} vlc_callback_type_t;
+
 /*****************************************************************************
  * OS-specific headers and thread types
  *****************************************************************************/
-#if defined( WIN32 ) || defined( UNDER_CE )
-/* WIN32_LEAN_AND_MEAN is needed to be able to include winsock2.h because else,
- * windows.h will also include winsock.h and declarations will conflict */
-# define WIN32_LEAN_AND_MEAN
-# include <windows.h>
+#if defined( _WIN32 )
+#   include <malloc.h>
+#   ifndef PATH_MAX
+#       define PATH_MAX MAX_PATH
+#   endif
+#   include <windows.h>
+#endif
+
+#ifdef __SYMBIAN32__
+ #include <sys/syslimits.h>
 #endif
 
 #ifdef __OS2__
 #   define OS2EMX_PLAIN_CHAR
 #   define INCL_BASE
 #   define INCL_PM
+#   include <os2safe.h>
 #   include <os2.h>
 #endif
 
 #include "vlc_mtime.h"
 #include "vlc_threads.h"
 
-/**
- * Memory storage space for an atom. Never access it directly.
- */
-typedef union
-{
-    volatile uintptr_t u;
-    volatile intptr_t  s;
-} vlc_atomic_t;
-
 /*****************************************************************************
  * Common structure members
  *****************************************************************************/
@@ -512,7 +436,6 @@ typedef union
     int  i_flags;                                                           \
                                                                             \
     /* Object properties */                                                 \
-    volatile bool b_die;                   /**< set by the outside */ \
     bool b_force;      /**< set by the outside (eg. module_need()) */ \
                                                                             \
     /* Stuff related to the libvlc structure */                             \
@@ -539,26 +462,6 @@ typedef union
 # define VLC_OBJECT( x ) ((vlc_object_t *)(x))
 #endif
 
-typedef struct gc_object_t
-{
-    vlc_atomic_t    refs;
-    void          (*pf_destructor) (struct gc_object_t *);
-} gc_object_t;
-
-/**
- * These members are common to all objects that wish to be garbage-collected.
- */
-#define VLC_GC_MEMBERS gc_object_t vlc_gc_data;
-
-VLC_API void * vlc_gc_init(gc_object_t *, void (*)(gc_object_t *));
-VLC_API void * vlc_hold(gc_object_t *);
-VLC_API void vlc_release(gc_object_t *);
-
-#define vlc_gc_init( a,b ) vlc_gc_init( &(a)->vlc_gc_data, (b) )
-#define vlc_gc_incref( a ) vlc_hold( &(a)->vlc_gc_data )
-#define vlc_gc_decref( a ) vlc_release( &(a)->vlc_gc_data )
-#define vlc_priv( gc, t ) ((t *)(((char *)(gc)) - offsetof(t, vlc_gc_data)))
-
 /*****************************************************************************
  * Macros and inline functions
  *****************************************************************************/
@@ -577,6 +480,9 @@ VLC_API void vlc_release(gc_object_t *);
 #   define __MIN(a, b)   ( ((a) < (b)) ? (a) : (b) )
 #endif
 
+/* clip v in [min, max] */
+#define VLC_CLIP(v, min, max)    __MIN(__MAX((v), (min)), (max))
+
 VLC_USED
 static inline int64_t GCD ( int64_t a, int64_t b )
 {
@@ -608,7 +514,7 @@ static inline unsigned clz (unsigned x)
 
     while (x)
     {
-        x = x >> 1;
+        x >>= 1;
         i--;
     }
     return i;
@@ -620,6 +526,24 @@ static inline unsigned clz (unsigned x)
 /* XXX: this assumes that int is 32-bits or more */
 #define clz32( x ) (clz(x) - ((sizeof(unsigned) - sizeof (uint32_t)) * 8))
 
+/** Count trailing zeroes */
+VLC_USED
+static inline unsigned ctz (unsigned x)
+{
+#if VLC_GCC_VERSION(3,4)
+    return __builtin_ctz (x);
+#else
+    unsigned i = sizeof (x) * 8;
+
+    while (x)
+    {
+        x <<= 1;
+        i--;
+    }
+    return i;
+#endif
+}
+
 /** Bit weight */
 VLC_USED
 static inline unsigned popcount (unsigned x)
@@ -637,6 +561,18 @@ static inline unsigned popcount (unsigned x)
 #endif
 }
 
+VLC_USED
+static inline unsigned parity (unsigned x)
+{
+#if VLC_GCC_VERSION(3,4)
+    return __builtin_parity (x);
+#else
+    for (unsigned i = 4 * sizeof (x); i > 0; i /= 2)
+        x ^= x >> i;
+    return x & 1;
+#endif
+}
+
 #ifdef __OS2__
 #   undef bswap16
 #   undef bswap32
@@ -654,7 +590,7 @@ static inline uint16_t bswap16 (uint16_t x)
 VLC_USED
 static inline uint32_t bswap32 (uint32_t x)
 {
-#if VLC_GCC_VERSION(4,3)
+#if VLC_GCC_VERSION(4,3) || defined(__clang__)
     return __builtin_bswap32 (x);
 #else
     return ((x & 0x000000FF) << 24)
@@ -668,7 +604,7 @@ static inline uint32_t bswap32 (uint32_t x)
 VLC_USED
 static inline uint64_t bswap64 (uint64_t x)
 {
-#if VLC_GCC_VERSION(4,3)
+#if VLC_GCC_VERSION(4,3) || defined(__clang__)
     return __builtin_bswap64 (x);
 #elif !defined (__cplusplus)
     return ((x & 0x00000000000000FF) << 56)
@@ -680,14 +616,14 @@ static inline uint64_t bswap64 (uint64_t x)
          | ((x & 0x00FF000000000000) >> 40)
          | ((x & 0xFF00000000000000) >> 56);
 #else
-    return ((x & 0x00000000000000FFLLU) << 56)
-         | ((x & 0x000000000000FF00LLU) << 40)
-         | ((x & 0x0000000000FF0000LLU) << 24)
-         | ((x & 0x00000000FF000000LLU) <<  8)
-         | ((x & 0x000000FF00000000LLU) >>  8)
-         | ((x & 0x0000FF0000000000LLU) >> 24)
-         | ((x & 0x00FF000000000000LLU) >> 40)
-         | ((x & 0xFF00000000000000LLU) >> 56);
+    return ((x & 0x00000000000000FFULL) << 56)
+         | ((x & 0x000000000000FF00ULL) << 40)
+         | ((x & 0x0000000000FF0000ULL) << 24)
+         | ((x & 0x00000000FF000000ULL) <<  8)
+         | ((x & 0x000000FF00000000ULL) >>  8)
+         | ((x & 0x0000FF0000000000ULL) >> 24)
+         | ((x & 0x00FF000000000000ULL) >> 40)
+         | ((x & 0xFF00000000000000ULL) >> 56);
 #endif
 }
 
@@ -843,17 +779,7 @@ static inline void SetQWLE (void *p, uint64_t qw)
 
 /* Stuff defined in src/extras/libc.c */
 
-#if defined(WIN32) || defined(UNDER_CE)
-/* win32, cl and icl support */
-#   if defined( _MSC_VER ) || !defined( __MINGW32__ )
-#       define __attribute__(x)
-#       define S_IFBLK         0x3000  /* Block */
-#       define S_ISBLK(m)      (0)
-#       define S_ISCHR(m)      (0)
-#       define S_ISFIFO(m)     (((m)&_S_IFMT) == _S_IFIFO)
-#       define S_ISREG(m)      (((m)&_S_IFMT) == _S_IFREG)
-#   endif
-
+#if defined(_WIN32)
 /* several type definitions */
 #   if defined( __MINGW32__ )
 #       if !defined( _OFF_T_ )
@@ -868,31 +794,12 @@ static inline void SetQWLE (void *p, uint64_t qw)
 #       endif
 #   endif
 
-#   if defined( _MSC_VER )
-#       if !defined( _OFF_T_DEFINED )
-            typedef __int64 off_t;
-#           define _OFF_T_DEFINED
-#       else
-            /* for wx compatibility typedef long off_t; */
-#           define off_t __int64
-#       endif
-#   endif
-
-#   if defined( __BORLANDC__ )
-#       undef off_t
-#       define off_t unsigned __int64
-#   endif
-
 #   ifndef O_NONBLOCK
 #       define O_NONBLOCK 0
 #   endif
 
-#   ifndef alloca
-#       define alloca _alloca
-#   endif
-
 #   include <tchar.h>
-#endif
+#endif /* _WIN32 */
 
 VLC_API bool vlc_ureduce( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t );
 
@@ -901,10 +808,12 @@ VLC_API bool vlc_ureduce( unsigned *, unsigned *, uint64_t, uint64_t, uint64_t )
 #include <AvailabilityMacros.h>
 #endif
 
-#ifdef WIN32
-# include <malloc.h>
+#ifdef __MINGW32__
 # define vlc_memalign(align, size) (__mingw_aligned_malloc(size, align))
 # define vlc_free(base)            (__mingw_aligned_free(base))
+#elif defined(_MSC_VER)
+# define vlc_memalign(align, size) (_aligned_malloc(size, align))
+# define vlc_free(base)            (_aligned_free(base))
 #elif defined(__APPLE__) && !defined(MAC_OS_X_VERSION_10_6)
 static inline void *vlc_memalign(size_t align, size_t size)
 {
@@ -925,9 +834,6 @@ static void vlc_free(void *ptr)
     if (ptr)
         free((char*)ptr - ((char*)ptr)[-1]);
 }
-#elif defined(__ANDROID__)
-# define vlc_memalign(align, size) memalign(align, size)
-# define vlc_free(base) free(base)
 #else
 static inline void *vlc_memalign(size_t align, size_t size)
 {
@@ -941,14 +847,11 @@ static inline void *vlc_memalign(size_t align, size_t size)
 
 VLC_API void vlc_tdestroy( void *, void (*)(void *) );
 
-/* Fast large memory copy and memory set */
-VLC_API void * vlc_memcpy( void *, const void *, size_t );
-#define vlc_memset memset
-
 /*****************************************************************************
  * I18n stuff
  *****************************************************************************/
-VLC_API char * vlc_gettext( const char *msgid ) VLC_FORMAT_ARG(1);
+VLC_API char *vlc_gettext( const char *msgid ) VLC_FORMAT_ARG(1);
+VLC_API char *vlc_ngettext( const char *s, const char *p, unsigned long n ) VLC_FORMAT_ARG(1) VLC_FORMAT_ARG(2);
 
 #define vlc_pgettext( ctx, id ) \
         vlc_pgettext_aux( ctx "\004" id, id )
@@ -987,6 +890,14 @@ static inline void *xcalloc (size_t n, size_t size)
     return ptr;
 }
 
+static inline char *xstrdup (const char *str)
+{
+    char *ptr = strdup (str);
+    if (unlikely(ptr == NULL))
+        abort ();
+    return ptr;
+}
+
 /*****************************************************************************
  * libvlc features
  *****************************************************************************/
@@ -1003,7 +914,7 @@ VLC_API const char * VLC_Compiler( void ) VLC_USED;
 #include "vlc_main.h"
 #include "vlc_configuration.h"
 
-#if defined( WIN32 ) || defined( UNDER_CE ) || defined( __SYMBIAN32__ ) || defined( __OS2__ )
+#if defined( _WIN32 ) || defined( __SYMBIAN32__ ) || defined( __OS2__ )
 #   define DIR_SEP_CHAR '\\'
 #   define DIR_SEP "\\"
 #   define PATH_SEP_CHAR ';'