]> git.sesse.net Git - vlc/blobdiff - src/libvlc.h
BeOS app thread: only used in one file
[vlc] / src / libvlc.h
index 442d9f378eeaafa47eeda365ce433fcce2844a2e..3b25abb5727ebcd63fa139fae440fe4e723be65b 100644 (file)
@@ -1,10 +1,11 @@
 /*****************************************************************************
  * libvlc.h: Internal libvlc generic/misc declaration
  *****************************************************************************
- * Copyright © 2006 Rémi Denis-Courmont
+ * Copyright (C) 1999, 2000, 2001, 2002 the VideoLAN team
+ * Copyright © 2006-2007 Rémi Denis-Courmont
  * $Id$
  *
- * Authors: Rémi Denis-Courmont <rem # videolan , org>
+ * Authors: Vincent Seguin <seguin@via.ecp.fr>
  *
  * 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
 
 extern const char vlc_usage[];
 
-extern const module_config_t libvlc_config[];
-extern const size_t libvlc_config_count;
-
+/* Hotkey stuff */
 extern const struct hotkey libvlc_hotkeys[];
 extern const size_t libvlc_hotkeys_size;
+extern int vlc_key_to_action (vlc_object_t *, const char *,
+                              vlc_value_t, vlc_value_t, void *);
+
+/*
+ * 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
+ */
+int vlc_threads_init( void );
+void vlc_threads_end( 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;
+
+/*
+ * CPU capabilities
+ */
+extern uint32_t cpu_flags;
+uint32_t CPUCapabilities( void );
+
+/*
+ * Unicode stuff
+ */
+
+/*
+ * 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 void *
+vlc_custom_create (vlc_object_t *p_this, size_t i_size, int i_type,
+                   const char *psz_type);
+
+/*****************************************************************************
+ * libvlc_global_data_t (global variable)
+ *****************************************************************************
+ * This structure has an unique instance, statically allocated in main and
+ * never accessed from the outside. It stores once-initialized data such as
+ * the CPU capabilities or the global lock.
+ *****************************************************************************/
+struct libvlc_global_data_t
+{
+    VLC_COMMON_MEMBERS
+
+    bool             b_ready;     ///< Initialization boolean
+
+   /* Object structure data */
+    int                    i_counter;   ///< object counter
+    int                    i_objects;   ///< Attached objects count
+    vlc_object_t **        pp_objects;  ///< Array of all objects
+
+    module_bank_t *        p_module_bank; ///< The module bank
+    intf_thread_t         *p_probe;       ///< Devices prober
+
+    /* Arch-specific variables */
+#if defined( SYS_BEOS )
+    char *                 psz_vlcpath;
+#elif defined( __APPLE__ )
+    char *                 psz_vlcpath;
+#elif defined( WIN32 )
+    char *                 psz_vlcpath;
+#endif
+};
+
+
+libvlc_global_data_t *vlc_global (void);
+libvlc_int_t *vlc_current_object (int i_object);
+
+/* Private LibVLC data for each objects */
+struct vlc_object_internals_t
+{
+    /* Object variables */
+    variable_t *    p_vars;
+    vlc_mutex_t     var_lock;
+    int             i_vars;
+
+    /* Thread properties, if any */
+    vlc_thread_t    thread_id;
+    bool            b_thread;
+
+    /* Objects thread synchronization */
+    int             pipes[2];
+    vlc_spinlock_t  spin;
+
+    /* Objects management */
+    unsigned         i_refcount;
+    vlc_destructor_t pf_destructor;
+    bool             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 ((vlc_object_internals_t *)obj) - 1;
+}
+
+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