]> git.sesse.net Git - vlc/blobdiff - src/libvlc.h
Privatize psz_configfile
[vlc] / src / libvlc.h
index d13309be390df131b543739f88bd3ca63ff5ebcc..9088550afbe9d9edac467efc2a700f4990f92ad8 100644 (file)
 
 extern const char vlc_usage[];
 
+/* 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( vlc_object_t * );
-int __vlc_threads_end( vlc_object_t * );
+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
@@ -43,6 +72,44 @@ int __vlc_threads_end( vlc_object_t * );
 extern uint32_t cpu_flags;
 uint32_t CPUCapabilities( void );
 
+/*
+ * Message/logging stuff
+ */
+
+#define NB_QUEUES 2
+
+typedef struct msg_queue_t
+{
+    int                     i_id;
+
+    /** 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;
+
+    /* Subscribers */
+    int i_sub;
+    msg_subscription_t **pp_sub;
+
+    /* Logfile for WinCE */
+#ifdef UNDER_CE
+    FILE *logfile;
+#endif
+} msg_queue_t;
+
+/**
+ * Store all data requiered by messages interfaces.
+ */
+typedef struct msg_bank_t
+{
+    vlc_mutex_t             lock;
+    msg_queue_t             queues[NB_QUEUES];
+} msg_bank_t;
+
 /*
  * Unicode stuff
  */
@@ -51,52 +118,59 @@ uint32_t CPUCapabilities( void );
  * LibVLC objects stuff
  */
 
-extern vlc_object_t *
+/**
+ * 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
+ *
+ * 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.
+ */
+typedef struct libvlc_global_data_t
 {
     VLC_COMMON_MEMBERS
 
-    vlc_bool_t             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( WIN32 )
-    vlc_bool_t             b_daemon;
-#endif
 #if defined( SYS_BEOS )
-    vlc_object_t *         p_appthread;
     char *                 psz_vlcpath;
 #elif defined( __APPLE__ )
     char *                 psz_vlcpath;
-    vlc_iconv_t            iconv_macosx; /* for HFS+ file names */
-    vlc_mutex_t            iconv_lock;
 #elif defined( WIN32 )
     char *                 psz_vlcpath;
 #endif
-};
+} libvlc_global_data_t;
 
 
 libvlc_global_data_t *vlc_global (void);
 libvlc_int_t *vlc_current_object (int i_object);
 
-/* Private LibVLC data for each objects */
+/**
+ * Private LibVLC data for each object.
+ */
 struct vlc_object_internals_t
 {
     /* Object variables */
@@ -106,75 +180,74 @@ struct vlc_object_internals_t
 
     /* Thread properties, if any */
     vlc_thread_t    thread_id;
-    vlc_bool_t      b_thread;
+    bool            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;
+    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 obj->p_internals;
+    return ((vlc_object_internals_t *)obj) - 1;
 }
 
-/*
- * Configuration stuff
+/**
+ * Private LibVLC instance data.
  */
-#if 0
-struct module_config_t
+typedef struct libvlc_priv_t
 {
-    int          i_type;                               /* Configuration type */
-    const char  *psz_type;                          /* Configuration subtype */
-    const char  *psz_name;                                    /* Option name */
-    char         i_short;                      /* Optional short option name */
-    const char  *psz_text;      /* Short comment on the configuration option */
-    const char  *psz_longtext;   /* Long comment on the configuration option */
-    module_value_t value;                                    /* Option value */
-    module_value_t orig;
-    module_value_t saved;
-    module_nvalue_t min;
-    module_nvalue_t max;
-
-    /* Function to call when commiting a change */
-    vlc_callback_t pf_callback;
-    void          *p_callback_data;
-
-    /* Values list */
-    const char **ppsz_list;       /* List of possible values for the option */
-    int         *pi_list;                              /* Idem for integers */
-    const char **ppsz_list_text;          /* Friendly names for list values */
-    int          i_list;                               /* Options list size */
-
-    /* Actions list */
-    vlc_callback_t *ppf_action;    /* List of possible actions for a config */
-    const char    **ppsz_action_text;         /* Friendly names for actions */
-    int            i_action;                           /* actions list size */
-
-    /* Misc */
-    vlc_mutex_t *p_lock;            /* Lock to use when modifying the config */
-    vlc_bool_t   b_dirty;          /* Dirty flag to indicate a config change */
-    vlc_bool_t   b_advanced;          /* Flag to indicate an advanced option */
-    vlc_bool_t   b_internal;   /* Flag to indicate option is not to be shown */
-    vlc_bool_t   b_restart;   /* Flag to indicate the option needs a restart */
-                              /* to take effect */
-
-    /* Deprecated */
-    const char    *psz_current;                         /* Good option name */
-    vlc_bool_t     b_strict;                     /* Transitionnal or strict */
-
-    /* Option values loaded from config file */
-    vlc_bool_t   b_autosave;      /* Config will be auto-saved at exit time */
-    vlc_bool_t   b_unsaveable;                    /* Config should be saved */
-};
-#endif
+    /* Configuration */
+    vlc_mutex_t        config_lock; ///< config file lock
+    char *             psz_configfile;   ///< location of config file
+
+    /* Messages */
+    msg_bank_t         msg_bank;    ///< The message bank
+    int                i_verbose;   ///< info messages
+    bool               b_color;     ///< color messages?
+
+    /* Timer stats */
+    vlc_mutex_t        timer_lock;  ///< Lock to protect timers
+    counter_t        **pp_timers;   ///< Array of all timers
+    int                i_timers;    ///< Number of timers
+    bool               b_stats;     ///< Whether to collect stats
+
+    module_t          *p_memcpy_module;  ///< Fast memcpy plugin used
+    vlm_t             *p_vlm;  ///< VLM if created from libvlc-common.c
+    vlc_object_t      *p_interaction;    ///< interface interaction object
+    httpd_t           *p_httpd; ///< HTTP daemon (src/network/httpd.c)
+} libvlc_priv_t;
+
+static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc)
+{
+    return (libvlc_priv_t *)(libvlc + 1);
+}
 
+static inline bool libvlc_stats (vlc_object_t *obj)
+{
+   return libvlc_priv (obj->p_libvlc)->b_stats;
+}
+
+/**
+ * LibVLC "main module" configuration settings array.
+ */
 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