]> git.sesse.net Git - vlc/blobdiff - src/libvlc.h
Privatize vlc_object_t.i_object_type
[vlc] / src / libvlc.h
index c8eed26a91553c846bd93f9246ff9eb439c2234e..f76fd7400cfed4bd0c60110d524799746de170bd 100644 (file)
@@ -25,6 +25,8 @@
 #ifndef LIBVLC_LIBVLC_H
 # define LIBVLC_LIBVLC_H 1
 
+typedef struct variable_t variable_t;
+
 extern const char vlc_usage[];
 
 /* Hotkey stuff */
@@ -43,13 +45,22 @@ void system_End       ( libvlc_int_t * );
 /*
  * Threads subsystem
  */
-int vlc_threads_init( void );
-void vlc_threads_end( void );
-vlc_object_t *vlc_threadobj (void);
-#ifdef LIBVLC_REFCHECK
-void vlc_refcheck (vlc_object_t *obj);
+
+/* Hopefully, no need to export this. There is a new thread API instead. */
+void vlc_thread_cancel (vlc_object_t *);
+int vlc_object_waitpipe (vlc_object_t *obj);
+void __vlc_object_signal_unlocked (vlc_object_t *);
+#define vlc_object_signal_unlocked( obj ) \
+    __vlc_object_signal_unlocked( VLC_OBJECT( obj ) )
+
+void vlc_trace (const char *fn, const char *file, unsigned line);
+#define vlc_backtrace() vlc_trace(__func__, __FILE__, __LINE__)
+
+#if defined (LIBVLC_USE_PTHREAD) && !defined (NDEBUG)
+# define vlc_assert_locked( m ) \
+         assert (pthread_mutex_lock (m) == EDEADLK)
 #else
-# define vlc_refcheck( obj ) (void)0
+# define vlc_assert_locked( m ) (void)m
 #endif
 
 /*
@@ -62,16 +73,14 @@ uint32_t CPUCapabilities( void );
  * Message/logging stuff
  */
 
-typedef struct msg_queue_t
+/**
+ * Store all data required by messages interfaces.
+ */
+typedef struct msg_bank_t
 {
     /** Message queue lock */
-    vlc_mutex_t             lock;
-    bool              b_overflow;
-
-    /* Message queue */
-    msg_item_t              msg[VLC_MSG_QSIZE];           /**< message queue */
-    int i_start;
-    int i_stop;
+    vlc_mutex_t lock;
+    vlc_cond_t  wait;
 
     /* Subscribers */
     int i_sub;
@@ -81,37 +90,15 @@ typedef struct msg_queue_t
 #ifdef UNDER_CE
     FILE *logfile;
 #endif
-} msg_queue_t;
-
-/**
- * Store all data required by messages interfaces.
- */
-typedef struct msg_bank_t
-{
-    vlc_mutex_t             lock;
-    msg_queue_t             queue;
 } msg_bank_t;
 
 void msg_Create  (libvlc_int_t *);
-void msg_Flush   (libvlc_int_t *);
 void msg_Destroy (libvlc_int_t *);
 
 /** Internal message stack context */
-typedef struct
-{
-    int i_code;
-    char * psz_message;
-} msg_context_t;
-
 void msg_StackSet ( int, const char*, ... );
 void msg_StackAdd ( const char*, ... );
 const char* msg_StackMsg ( void );
-/** The global thread var for msg stack context
- *  We store this as a static global variable so we don't need a vlc_object_t
- *  everywhere.
- *  This key is created in vlc_threads_init and is therefore ready to use at
- *  the very beginning of the universe */
-extern vlc_threadvar_t msg_context_global_key;
 void msg_StackDestroy (void *);
 
 /*
@@ -138,39 +125,33 @@ char *vlc_fix_readdir (const char *);
  * @return the created object, or NULL.
  */
 extern void *
-vlc_custom_create (vlc_object_t *p_this, size_t i_size, int i_type,
-                   const char *psz_type);
+__vlc_custom_create (vlc_object_t *p_this, size_t i_size, int i_type,
+                     const char *psz_type);
+#define vlc_custom_create(o, s, t, n) \
+        __vlc_custom_create(VLC_OBJECT(o), s, t, n)
 
-/**
- * libvlc_global_data_t (global variable)
- *
- * This structure has an unique instance, statically allocated in libvlc and
- * never accessed from the outside. It stores process-wide VLC variables,
- * mostly process-wide locks, and (currently) the module bank and objects tree.
+/*
+ * To be cleaned-up module stuff:
  */
-typedef struct libvlc_global_data_t
-{
-    VLC_COMMON_MEMBERS
-
-    /* Object structure data */
-    int                    i_counter;   ///< object counter
-
-    module_bank_t *        p_module_bank; ///< The module bank
+extern char *psz_vlcpath;
 
-    char *                 psz_vlcpath;
-} libvlc_global_data_t;
-
-
-libvlc_global_data_t *vlc_global (void);
+/* Return a NULL terminated array with the names of the modules that have a
+ * certain capability.
+ * Free after uses both the string and the table. */
+VLC_EXPORT(char **, module_GetModulesNamesForCapability,
+                    ( const char * psz_capability, char ***psz_longname ) );
 
 /**
  * Private LibVLC data for each object.
  */
-struct vlc_object_internals_t
+typedef struct vlc_object_internals_t
 {
+    int             i_object_type; /* Object type, deprecated */
+
     /* Object variables */
     variable_t *    p_vars;
     vlc_mutex_t     var_lock;
+    vlc_cond_t      var_wait;
     int             i_vars;
 
     /* Thread properties, if any */
@@ -181,21 +162,17 @@ struct vlc_object_internals_t
     vlc_mutex_t     lock;
     vlc_cond_t      wait;
     int             pipes[2];
-    vlc_spinlock_t  spin;
 
     /* Objects management */
     vlc_spinlock_t   ref_spin;
     unsigned         i_refcount;
     vlc_destructor_t pf_destructor;
-#ifndef LIBVLC_REFCHECK
-    vlc_thread_t     creator_id;
-#endif
 
     /* Objects tree structure */
     vlc_object_t    *prev, *next;
     vlc_object_t   **pp_children;
     int              i_children;
-};
+} vlc_object_internals_t;
 
 #define ZOOM_SECTION N_("Zoom")
 #define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
@@ -205,28 +182,19 @@ struct vlc_object_internals_t
 
 #define vlc_internals( obj ) (((vlc_object_internals_t*)(VLC_OBJECT(obj)))-1)
 
-/* Signal an object without checking for locking consistency. This is wrong. */
-#ifdef __GNUC__
-__attribute__((deprecated))
-#endif
-static inline void
-vlc_object_signal_maybe (vlc_object_t *p_this)
-{
-    vlc_cond_signal (&(vlc_internals(p_this)->wait));
-}
+typedef struct sap_handler_t sap_handler_t;
 
 /**
  * Private LibVLC instance data.
  */
 typedef struct libvlc_priv_t
 {
+    libvlc_int_t       public_data;
+
     /* Configuration */
     vlc_mutex_t        config_lock; ///< config file lock
     char *             psz_configfile;   ///< location of config file
 
-    /* There is no real reason to keep a list of items, but not to break
-     * everything, let's keep it */
-    input_item_array_t input_items; ///< Array of all created input items
     int                i_last_input_id ; ///< Last id of input item
 
     /* Messages */
@@ -250,20 +218,17 @@ typedef struct libvlc_priv_t
     playlist_t        *p_playlist; //< the playlist singleton
     vlm_t             *p_vlm;  ///< the VLM singleton (or NULL)
     interaction_t     *p_interaction;    ///< interface interaction object
+    intf_thread_t     *p_interaction_intf; ///< XXX interface for interaction
     httpd_t           *p_httpd; ///< HTTP daemon (src/network/httpd.c)
-
-    /* Private playlist data (FIXME - playlist_t is too public...) */
-    sout_instance_t   *p_sout; ///< kept sout instance (for playlist)
-
-    /* Thread support */
-    unsigned           threads_count;
-    vlc_mutex_t        threads_lock;
-    vlc_cond_t         threads_wait;
+#ifdef ENABLE_SOUT
+    sap_handler_t     *p_sap; ///< SAP SDP advertiser
+#endif
+    vlc_mutex_t        structure_lock;
 } libvlc_priv_t;
 
 static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc)
 {
-    return (libvlc_priv_t *)(libvlc + 1);
+    return (libvlc_priv_t *)libvlc;
 }
 
 void playlist_ServicesDiscoveryKillAll( playlist_t *p_playlist );