]> git.sesse.net Git - vlc/blobdiff - include/vlc_common.h
For consistency, remove references to vlc from libvlc
[vlc] / include / vlc_common.h
index 7a9bbae3fabb451bc9fd6d27401d2d72952e556b..e50d23de48c277b0d133266299f492fe876da6ea 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
@@ -198,11 +199,13 @@ typedef uint32_t vlc_fourcc_t;
  *****************************************************************************/
 
 /* Internal types */
-typedef struct libvlc_t libvlc_t;
-typedef struct vlc_t vlc_t;
+typedef struct libvlc_global_data_t libvlc_global_data_t;
+typedef struct libvlc_int_t libvlc_int_t;
 typedef struct variable_t variable_t;
 typedef struct date_t date_t;
-typedef struct hashtable_entry_t hashtable_entry_t;
+typedef struct dict_entry_t dict_entry_t;
+typedef struct dict_t dict_t;
+typedef struct gc_object_t gc_object_t ;
 
 /* Messages */
 typedef struct msg_bank_t msg_bank_t;
@@ -218,14 +221,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;
 
 
@@ -335,6 +335,18 @@ typedef struct announce_method_t announce_method_t;
 typedef struct announce_handler_t announce_handler_t;
 typedef struct sap_handler_t sap_handler_t;
 
+typedef struct sout_param_t sout_param_t;
+typedef struct sout_pcat_t sout_pcat_t;
+typedef struct sout_std_t sout_std_t;
+typedef struct sout_display_t sout_display_t;
+typedef struct sout_duplicate_t sout_duplicate_t;
+typedef struct sout_transcode_t sout_transcode_t;
+typedef struct sout_chain_t sout_chain_t;
+typedef struct streaming_profile_t streaming_profile_t;
+typedef struct sout_module_t sout_module_t;
+typedef struct sout_gui_descr_t sout_gui_descr_t;
+typedef struct profile_parser_t profile_parser_t;
+
 /* Decoders */
 typedef struct decoder_t      decoder_t;
 typedef struct decoder_sys_t  decoder_sys_t;
@@ -356,6 +368,9 @@ typedef struct vlc_acl_t vlc_acl_t;
 
 /* Misc */
 typedef struct iso639_lang_t iso639_lang_t;
+typedef struct device_t device_t;
+typedef struct device_probe_t device_probe_t;
+typedef struct probe_sys_t probe_sys_t;
 
 /* block */
 typedef struct block_t      block_t;
@@ -478,7 +493,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 */                                                   \
@@ -506,8 +521,8 @@ typedef int ( * vlc_callback_t ) ( vlc_object_t *,      /* variable's object */
     variable_t *    p_vars;                                                 \
                                                                             \
     /* Stuff related to the libvlc structure */                             \
-    libvlc_t *      p_libvlc;                      /**< root of all evil */ \
-    vlc_t *         p_vlc;                   /**< (root of all evil) - 1 */ \
+    libvlc_global_data_t *p_libvlc_global;         /**< root of all evil */ \
+    libvlc_int_t *p_libvlc;                  /**< (root of all evil) - 1 */ \
                                                                             \
     volatile int    i_refcount;                         /**< usage count */ \
     vlc_object_t *  p_parent;                            /**< our parent */ \
@@ -525,6 +540,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
  *****************************************************************************/
@@ -556,6 +609,25 @@ static int64_t GCD( int64_t a, int64_t b )
     else return a;
 }
 
+/* Malloc with automatic error */
+#define MALLOC_VOID( var, type ) { var = (type*)malloc( sizeof( type) ); \
+                                   if( !var ) return; }
+#define MALLOC_NULL( var, type ) { var = (type*)malloc( sizeof( type) ); \
+                                   if( !var ) return NULL; }
+#define MALLOC_ERR( var, type ) { var = (type*)malloc( sizeof( type) ); \
+                                   if( !var ) return VLC_ENOMEM; }
+#define MALLOC_GOTOERR( var, type ) { var = (type*)malloc( sizeof( type) ); \
+                                      if( !var ) goto error; }
+#define DECMALLOC_VOID( var, type ) type* var = (type*)malloc( sizeof(type) );\
+                                    if( !var ) return;
+#define DECMALLOC_ERR( var, type ) type* var = (type*)malloc( sizeof(type) );\
+                                    if( !var ) return VLC_ENOMEM;
+#define DECMALLOC_NULL( var, type ) type* var = (type*)malloc( sizeof(type) );\
+                                    if( !var ) return NULL;
+
+#define FREENULL(a) if( a ) { free( a ); a = NULL; }
+#define FREE(a) if( a ) { free( a ); }
+
 /* Dynamic array handling: realloc array, move data, increment position */
 #if defined( _MSC_VER ) && _MSC_VER < 1300 && !defined( UNDER_CE )
 #   define VLCCVP (void**) /* Work-around for broken compiler */
@@ -647,19 +719,44 @@ static int64_t GCD( int64_t a, int64_t b )
         }                                       \
     }
 
-/* Hash tables handling */
-struct hashtable_entry_t
+/* Binary search in an array */
+#define BSEARCH( entries, count, elem, zetype, key, answer ) {  \
+    int low = 0, high = count - 1;   \
+    answer = -1; \
+    while( low <= high ) {\
+        int mid = (low + high ) / 2; /* Just don't care about 2^30 tables */ \
+        zetype mid_val = entries[mid] elem;\
+        if( mid_val < key ) \
+            low = mid + 1; \
+        else if ( mid_val > key ) \
+            high = mid -1;  \
+        else    \
+        {   \
+            answer = mid;  break;   \
+        }\
+    } \
+}
+
+/* Dictionnary handling */
+struct dict_entry_t
 {
-    int       i_id;
-    char     *psz_name;
+    int       i_int;
+    char     *psz_string;
     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 *) );
+struct dict_t
+{
+    dict_entry_t *p_entries;
+    int i_entries;
+};
 
+VLC_EXPORT( dict_t *, vlc_DictNew, (void) );
+VLC_EXPORT( void, vlc_DictClear, (dict_t * ) );
+VLC_EXPORT( void, vlc_DictInsert, (dict_t *, int, const char *, void * ) );
+VLC_EXPORT( void*, vlc_DictGet, (dict_t *, int, const char * ) );
+VLC_EXPORT( int, vlc_DictLookup, (dict_t *, 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
@@ -846,6 +943,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 ) );
@@ -873,6 +977,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
@@ -1069,12 +1184,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) */
@@ -1099,7 +1214,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)||\
@@ -1113,11 +1230,15 @@ VLC_EXPORT( char *, vlc_dgettext, ( const char *package, const char *msgid ) );
 #       include <libintl.h>
 #   endif
 #   undef _
-#   define _(String) vlc_dgettext (PACKAGE_NAME, String)
-#   define N_(String) ((char*)(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) (String)
 #else
-#   define _(String) ((char*)(String))
-#   define N_(String) ((char*)(String))
+#   define _(String) (String)
+#   define N_(String) (String)
 #endif
 
 /*****************************************************************************
@@ -1128,14 +1249,16 @@ 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
  *****************************************************************************/
 #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"