]> git.sesse.net Git - vlc/blobdiff - include/main.h
libvlc core release test added
[vlc] / include / main.h
index d8ea417171739fa0534bed037d62dac4c8182c62..7527d9e6f98a3c44c2a6c91f99128d7a672f8017 100644 (file)
@@ -1,48 +1,80 @@
-/*******************************************************************************
+/*****************************************************************************
  * main.h: access to all program variables
- * (c)1999 VideoLAN
- *******************************************************************************
  * Declaration and extern access to global program object.
- *******************************************************************************/
-
-/*******************************************************************************
- * main_t, p_main (global variable)
- *******************************************************************************
- * This structure has an unique instance, declared in main and pointed by the
- * only global variable of the program. It should allow access to any variable
- * of the program, for user-interface purposes or more easier call of interface
- * and common functions (example: the intf_*Msg functions). Please avoid using
- * it when you can access the members you need in an other way. In fact, it
- * should only be used by interface thread.
- *******************************************************************************/
-typedef struct
+ *****************************************************************************
+ * Copyright (C) 1999, 2000, 2001, 2002 the VideoLAN team
+ * $Id$
+ *
+ * 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
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+ *****************************************************************************/
+
+#if !defined( __LIBVLC__ )
+  #error You are not libvlc or one of its plugins. You cannot include this file
+#endif
+
+/*****************************************************************************
+ * libvlc_internal_instance_t
+ *****************************************************************************
+ * This structure is a LibVLC instance, for use by libvlc core and plugins
+ *****************************************************************************/
+struct libvlc_int_t
 {
+    VLC_COMMON_MEMBERS
+
     /* Global properties */
-    int                    i_argc;             /* command line arguments count */
-    char **                ppsz_argv;                /* command line arguments */
-    char **                ppsz_env;                  /* environment variables */
-
-    /* Generic settings */
-    boolean_t              b_audio;               /* is audio output allowed ? */
-    boolean_t              b_video;               /* is video output allowed ? */
-    boolean_t              b_vlans;                   /* are vlans supported ? */
-    
-    /* Unique threads */
-    p_aout_thread_t        p_aout;                      /* audio output thread */
-    p_intf_thread_t        p_intf;                    /* main interface thread */
-
-    /* Shared data - these structures are accessed directly from p_main by
-     * several modules */
-    p_intf_msg_t           p_msg;                   /* messages interface data */
-    p_input_vlan_method_t  p_input_vlan;                  /* vlan input method */
-} main_t;
-
-extern main_t *p_main;
-
-/*******************************************************************************
- * Prototypes - these methods are used to get default values for some threads
- * and modules.
- *******************************************************************************/
-int    main_GetIntVariable( char *psz_name, int i_default );
-char * main_GetPszVariable( char *psz_name, char *psz_default );
+    char *                 psz_homedir;      ///< user's home directory
+    char *                 psz_configdir;    ///< user's configuration directory
+    char *                 psz_datadir;      ///< user's data directory
+    char *                 psz_cachedir;     ///< user's cache directory
+
+    char *                 psz_configfile;   ///< location of config file
+
+    playlist_t            *p_playlist;       ///< playlist object
+
+    /* Messages */
+    msg_bank_t             msg_bank;    ///< The message bank
+    int                    i_verbose;   ///< info messages
+    vlc_bool_t             b_color;     ///< color messages?
+
+    module_t *             p_memcpy_module;  ///< Fast memcpy plugin used
+    void* ( *pf_memcpy ) ( void *, const void *, size_t ); ///< fast memcpy
+    void* ( *pf_memset ) ( void *, int, size_t );          ///< fast memset
+
+    vlc_bool_t             b_stats;       ///< Should we collect stats ?
+    vlc_mutex_t            timer_lock;    ///< Lock to protect timers
+    int                    i_timers;      ///< Number of timers
+    counter_t            **pp_timers;     ///< Array of all timers
+
+    vlc_mutex_t            config_lock;    ///< Lock for the config file
+#ifdef __APPLE__
+    vlc_mutex_t            quicktime_lock; ///< QT is not thread safe on OSX
+#endif
+
+    /* Structure storing the action name / key associations */
+    struct hotkey
+    {
+        const char *psz_action;
+        int i_action;
+        int i_key;
+
+        /* hotkey accounting information */
+        mtime_t i_delta_date;/*< minimum delta time between two key presses */
+        mtime_t i_last_date; /*< last date key was pressed */
+        int     i_times;     /*< n times pressed within delta date*/
+    } *p_hotkeys;
+};