]> git.sesse.net Git - vlc/blobdiff - include/vlc_common.h
HAL probing module
[vlc] / include / vlc_common.h
index 77670e2ddb169fe5448bf91e8b20735e49782eba..ed4da001f3bc0f8e0a0e4d4136ac430375ab63ee 100644 (file)
@@ -24,6 +24,7 @@
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
+
 /**
  * \file
  * This file is a collection of common definitions and types
@@ -202,6 +203,8 @@ typedef struct libvlc_t libvlc_t;
 typedef struct vlc_t vlc_t;
 typedef struct variable_t variable_t;
 typedef struct date_t date_t;
+typedef struct hashtable_entry_t hashtable_entry_t;
+typedef struct gc_object_t gc_object_t ;
 
 /* Messages */
 typedef struct msg_bank_t msg_bank_t;
@@ -217,14 +220,11 @@ typedef struct msg_subscription_t msg_subscription_t;
 typedef enum {
     PLAYLIST_PLAY,      /**< No arg.                            res=can fail*/
     PLAYLIST_AUTOPLAY,  /**< No arg.                            res=cant fail*/
-    PLAYLIST_VIEWPLAY,  /**< arg1= int, arg2= playlist_item_t*,*/
-                        /**  arg3 = playlist_item_t*          , res=can fail */
-    PLAYLIST_ITEMPLAY,  /** <arg1 = playlist_item_t *         , 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_GOTO,      /**< arg1=int                           res=can fail */
-    PLAYLIST_VIEWGOTO   /**< arg1=int                           res=can fail */
 } playlist_command_t;
 
 
@@ -355,6 +355,7 @@ typedef struct vlc_acl_t vlc_acl_t;
 
 /* Misc */
 typedef struct iso639_lang_t iso639_lang_t;
+typedef struct device_t device_t;
 
 /* block */
 typedef struct block_t      block_t;
@@ -416,12 +417,16 @@ typedef struct vlm_schedule_t vlm_schedule_t;
 /* divers */
 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 global_stats_t global_stats_t;
 
+/* Update */
+typedef struct update_t update_t;
+typedef struct update_iterator_t update_iterator_t;
 
 /*****************************************************************************
  * Variable callbacks
@@ -435,8 +440,12 @@ typedef int ( * vlc_callback_t ) ( vlc_object_t *,      /* variable's object */
 /*****************************************************************************
  * Plug-in stuff
  *****************************************************************************/
-#ifndef __PLUGIN__
-#   define VLC_EXPORT( type, name, args ) type name args
+#if !defined (__PLUGIN__) || defined (HAVE_SHARED_LIBVLC)
+#   ifdef __cplusplus
+#      define VLC_EXPORT( type, name, args ) extern "C" type name args
+#   else
+#      define VLC_EXPORT( type, name, args ) type name args
+#   endif
 #else
 #   define VLC_EXPORT( type, name, args ) struct _u_n_u_s_e_d_
     extern module_symbols_t* p_symbols;
@@ -469,7 +478,7 @@ typedef int ( * vlc_callback_t ) ( vlc_object_t *,      /* variable's object */
 /**@{*/                                                                     \
     int   i_object_id;                                                      \
     int   i_object_type;                                                    \
-    char *psz_object_type;                                                  \
+    const char *psz_object_type;                                            \
     char *psz_object_name;                                                  \
                                                                             \
     /* Messages header */                                                   \
@@ -516,6 +525,44 @@ typedef int ( * vlc_callback_t ) ( vlc_object_t *,      /* variable's object */
 #define VLC_OBJECT( x ) \
     ((vlc_object_t *)(x))+0*(x)->be_sure_to_add_VLC_COMMON_MEMBERS_to_struct
 
+#define VLC_GC_MEMBERS                                                       \
+/** \name VLC_GC_MEMBERS                                                     \
+ * these members are common to all objects that wish to be garbage-collected \
+ */                                                                          \
+/**@{*/                                                                      \
+    int i_gc_refcount;                                                       \
+    void (*pf_destructor) ( gc_object_t * );                                 \
+    void *p_destructor_arg;                                                  \
+/**@}*/
+
+struct gc_object_t
+{
+            VLC_GC_MEMBERS
+};
+
+static inline void __vlc_gc_incref( gc_object_t * p_gc )
+{
+    p_gc->i_gc_refcount ++;
+};
+
+static inline void __vlc_gc_decref( gc_object_t *p_gc )
+{
+    p_gc->i_gc_refcount -- ;
+
+    if( p_gc->i_gc_refcount == 0 )
+    {
+        p_gc->pf_destructor( p_gc );
+        /* Do not use the p_gc pointer from now on ! */
+     }
+}
+
+#define vlc_gc_incref( a ) __vlc_gc_incref( (gc_object_t *)a )
+#define vlc_gc_decref( a ) __vlc_gc_decref( (gc_object_t *)a )
+#define vlc_gc_init( a,b,c ) {  ((gc_object_t *)a)->i_gc_refcount = 0; \
+                              ((gc_object_t *)a)->pf_destructor = b; \
+                              ((gc_object_t *)a)->p_destructor_arg = c; }
+
+
 /*****************************************************************************
  * Macros and inline functions
  *****************************************************************************/
@@ -638,6 +685,20 @@ static int64_t GCD( int64_t a, int64_t b )
         }                                       \
     }
 
+/* Hash tables handling */
+struct hashtable_entry_t
+{
+    int       i_id;
+    char     *psz_name;
+    uint64_t  i_hash;
+    void     *p_data;
+};
+
+VLC_EXPORT( void, vlc_HashInsert, (hashtable_entry_t **, int *, int, const char *, void *));
+VLC_EXPORT( void*, vlc_HashRetrieve, (hashtable_entry_t*, int, int, const char *) );
+VLC_EXPORT( int, vlc_HashLookup, (hashtable_entry_t *, int, int, const char *) );
+
+
 /* MSB (big endian)/LSB (little endian) conversions - network order is always
  * MSB, and should be used for both network communications and files. Note that
  * byte orders other than little and big endians are not supported, but only
@@ -823,6 +884,13 @@ static inline void _SetQWBE( uint8_t *p, uint64_t i_qw )
 #   define vlc_strndup NULL
 #endif
 
+#ifndef HAVE_STRLCPY
+#   define strlcpy vlc_strlcpy
+    VLC_EXPORT( size_t, vlc_strlcpy, ( char *, const char *, size_t ) );
+#elif !defined(__PLUGIN__)
+#   define vlc_strlcpy NULL
+#endif
+
 #ifndef HAVE_ATOF
 #   define atof vlc_atof
     VLC_EXPORT( double, vlc_atof, ( const char *nptr ) );
@@ -850,6 +918,17 @@ static inline void _SetQWBE( uint8_t *p, uint64_t i_qw )
 #   define vlc_strtoll NULL
 #endif
 
+#if defined(SYS_BEOS)
+    typedef struct {
+        long long quot; /* Quotient. */
+        long long rem;  /* Remainder. */
+    } lldiv_t;
+#   define lldiv vlc_lldiv
+    VLC_EXPORT( lldiv_t, vlc_lldiv, ( long long numer, long long denom ) );
+#elif !defined(__PLUGIN__)
+#   define vlc_lldiv NULL
+#endif
+
 #ifndef HAVE_SCANDIR
 #   define scandir vlc_scandir
 #   define alphasort vlc_alphasort
@@ -1046,12 +1125,12 @@ VLC_EXPORT( char **, vlc_parse_cmdline, ( const char *, int * ) );
 
 /* vlc_wraptext (defined in src/extras/libc.c) */
 #define wraptext vlc_wraptext
-VLC_EXPORT( char *, vlc_wraptext, ( const char *, int, vlc_bool_t ) );
+VLC_EXPORT( char *, vlc_wraptext, ( const char *, int ) );
 
 /* iconv wrappers (defined in src/extras/libc.c) */
 typedef void *vlc_iconv_t;
 VLC_EXPORT( vlc_iconv_t, vlc_iconv_open, ( const char *, const char * ) );
-VLC_EXPORT( size_t, vlc_iconv, ( vlc_iconv_t, char **, size_t *, char **, size_t * ) );
+VLC_EXPORT( size_t, vlc_iconv, ( vlc_iconv_t, const char **, size_t *, char **, size_t * ) );
 VLC_EXPORT( int, vlc_iconv_close, ( vlc_iconv_t ) );
 
 /* execve wrapper (defined in src/extras/libc.c) */
@@ -1076,7 +1155,9 @@ VLC_EXPORT( int, __vlc_execve, ( vlc_object_t *p_object, int i_argc, char **pp_a
 /*****************************************************************************
  * I18n stuff
  *****************************************************************************/
+#if defined (WIN32) || !defined (HAVE_SHARED_LIBVLC)
 VLC_EXPORT( char *, vlc_dgettext, ( const char *package, const char *msgid ) );
+#endif
 
 #if defined( ENABLE_NLS ) && \
      (defined(MODULE_NAME_IS_gnome)||defined(MODULE_NAME_IS_gnome_main)||\
@@ -1090,7 +1171,11 @@ VLC_EXPORT( char *, vlc_dgettext, ( const char *package, const char *msgid ) );
 #       include <libintl.h>
 #   endif
 #   undef _
-#   define _(String) vlc_dgettext (PACKAGE_NAME, String)
+#   if defined (WIN32) || !defined (HAVE_SHARED_LIBVLC)
+#       define _(String) vlc_dgettext (PACKAGE_NAME, String)
+#   else
+#       define _(String) dgettext(PACKAGE_NAME, String)
+#   endif
 #   define N_(String) ((char*)(String))
 #else
 #   define _(String) ((char*)(String))
@@ -1105,13 +1190,17 @@ VLC_EXPORT( const char *, VLC_CompileBy, ( void ) );
 VLC_EXPORT( const char *, VLC_CompileHost, ( void ) );
 VLC_EXPORT( const char *, VLC_CompileDomain, ( void ) );
 VLC_EXPORT( const char *, VLC_Compiler, ( void ) );
-VLC_EXPORT( const char *, VLC_Changeset, ( void ) );
 VLC_EXPORT( const char *, VLC_Error, ( int ) );
 
 /*****************************************************************************
  * Additional vlc stuff
  *****************************************************************************/
-#include "vlc_symbols.h"
+#ifndef HAVE_SHARED_LIBVLC
+VLC_EXPORT( const char *, VLC_Changeset, ( void ) );
+#   include "vlc_symbols.h"
+#else
+#   define VLC_Changeset( ) ("exported")
+#endif
 #include "os_specific.h"
 #include "vlc_messages.h"
 #include "variables.h"