Document vlc_custom_create.

[vlc] / src / libvlc.h

diff --git a/src/libvlc.h b/src/libvlc.h
index 3e98a79b485477afa3445687420192d663128ea4..046f0f4f82c753fa0d714fee0ddfad3caf04e0e0 100644 (file)
--- a/src/libvlc.h
+++ b/src/libvlc.h
@@ -27,13 +27,30 @@
 
 extern const char vlc_usage[];
 
-extern const module_config_t libvlc_config[];
-extern const size_t libvlc_config_count;
-
 extern const struct hotkey libvlc_hotkeys[];
 extern const size_t libvlc_hotkeys_size;
 
 
+/*
+ * OS-specific initialization
+ */
+void system_Init      ( libvlc_int_t *, int *, const char *[] );
+void system_Configure ( libvlc_int_t *, int *, const char *[] );
+void system_End       ( libvlc_int_t * );
+
+#if defined( SYS_BEOS )
+/* Nothing at the moment, create beos_specific.h when needed */
+#elif defined( __APPLE__ )
+/* Nothing at the moment, create darwin_specific.h when needed */
+#elif defined( WIN32 ) || defined( UNDER_CE )
+VLC_EXPORT( const char * , system_VLCPath, (void));
+#else
+# define system_Init( a, b, c )      (void)0
+# define system_Configure( a, b, c ) (void)0
+# define system_End( a )             (void)0
+#endif
+
+
 /*
  * Threads subsystem
  */
@@ -54,6 +71,20 @@ uint32_t CPUCapabilities( void );
  * LibVLC objects stuff
  */
 
+/**
+ * Creates a VLC object.
+ *
+ * Note that because the object name pointer must remain valid, potentially
+ * even after the destruction of the object (through the message queues), this
+ * function CANNOT be exported to plugins as is. In this case, the old
+ * vlc_object_create() must be used instead.
+ *
+ * @param p_this an existing VLC object
+ * @param i_size byte size of the object structure
+ * @param i_type object type, usually VLC_OBJECT_CUSTOM
+ * @param psz_type object type name
+ * @return the created object, or NULL.
+ */
 extern vlc_object_t *
 vlc_custom_create (vlc_object_t *p_this, size_t i_size, int i_type,
                    const char *psz_type);
@@ -111,15 +142,33 @@ struct vlc_object_internals_t
     vlc_thread_t    thread_id;
     vlc_bool_t      b_thread;
 
+    /* Objects thread synchronization */
+    int             pipes[2];
+    vlc_spinlock_t  spin;
+
     /* Objects management */
-    unsigned        i_refcount;
-    vlc_bool_t      b_attached;
+    unsigned         i_refcount;
+    vlc_destructor_t pf_destructor;
+    vlc_bool_t       b_attached;
 };
 
+#define ZOOM_SECTION N_("Zoom")
+#define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
+#define ZOOM_HALF_KEY_TEXT N_("1:2 Half")
+#define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
+#define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
 
 static inline vlc_object_internals_t *vlc_internals( vlc_object_t *obj )
 {
     return obj->p_internals;
 }
 
+extern module_config_t libvlc_config[];
+extern const size_t libvlc_config_count;
+
+/*
+ * Variables stuff
+ */
+void var_OptionParse (vlc_object_t *, const char *, bool trusted);
+
 #endif