]> git.sesse.net Git - vlc/blobdiff - include/main.h
Changing the order of parameters may be needed, but changing the parameters themselve...
[vlc] / include / main.h
index 64caf128f4136fd68e7d04cc884dc9abc9bed1fa..29e90605d60bce7bbea3e5ed61948ab8c04ef905 100644 (file)
@@ -2,8 +2,8 @@
  * main.h: access to all program variables
  * Declaration and extern access to global program object.
  *****************************************************************************
- * Copyright (C) 1999, 2000, 2001, 2002 VideoLAN
- * $Id: main.h,v 1.55 2003/09/24 21:31:54 gbazin Exp $
+ * Copyright (C) 1999, 2000, 2001, 2002 the VideoLAN team
+ * $Id$
  *
  * Authors: Vincent Seguin <seguin@via.ecp.fr>
  *
@@ -11,7 +11,7 @@
  * 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
  *
  * 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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+ * 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_t (global variable)
+ * libvlc_internal_instance_t
  *****************************************************************************
- * This structure has an unique instance, statically allocated in main and
- * never accessed from the outside. It store once-initialized data such as
- * the CPU capabilities or the global lock.
+ * This structure is a LibVLC instance, for use by libvlc core and plugins
  *****************************************************************************/
-struct libvlc_t
+struct libvlc_int_t
 {
     VLC_COMMON_MEMBERS
 
-    /* Initialization boolean */
-    vlc_bool_t             b_ready;
-
-    /* CPU extensions */
-    uint32_t               i_cpu;
-
-    /* Generic settings */
-    int                    i_verbose;                       /* info messages */
-    vlc_bool_t             b_color;                       /* color messages? */
-
-    /* Object structure data */
-    int                    i_counter;                      /* object counter */
-    int                    i_objects;              /* Attached objects count */
-    vlc_object_t **        pp_objects;               /* Array of all objects */
+    /* Global properties */
+    int                    i_argc;           ///< command line arguments count
+    const char **          ppsz_argv;        ///< command line arguments
 
-    /* The message bank */
-    msg_bank_t             msg_bank;
+    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
 
-    /* The module bank */
-    module_bank_t *        p_module_bank;
+    char *                 psz_configfile;   ///< location of config file
 
-    /* Arch-specific variables */
-#if defined( SYS_BEOS )
-    vlc_object_t *         p_appthread;
-    char *                 psz_vlcpath;
-#elif defined( SYS_DARWIN )
-    char *                 psz_vlcpath;
-#elif defined( WIN32 ) && !defined( UNDER_CE )
-    SIGNALOBJECTANDWAIT    SignalObjectAndWait;
-    vlc_bool_t             b_fast_mutex;
-    int                    i_win9x_cv;
-    char *                 psz_vlcpath;
-#endif
-};
+    playlist_t            *p_playlist;       ///< playlist object
 
-/*****************************************************************************
- * vlc_t, p_vlc
- *****************************************************************************
- * This structure is a LibVLC instance.
- *****************************************************************************/
-struct vlc_t
-{
-    VLC_COMMON_MEMBERS
+    /* Messages */
+    msg_bank_t             msg_bank;    ///< The message bank
+    int                    i_verbose;   ///< info messages
+    vlc_bool_t             b_color;     ///< color messages?
 
-    /* Global properties */
-    int                    i_argc;           /* command line arguments count */
-    char **                ppsz_argv;              /* command line arguments */
-    char *                 psz_homedir;             /* user's home directory */
-    char *                 psz_configfile;        /* location of config file */
+    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
 
-    /* Generic settings */
-    mtime_t                i_desync;   /* relative desync of the audio ouput */
+    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
 
-    /* Fast memcpy plugin used */
-    module_t *             p_memcpy_module;
-#if defined( UNDER_CE )
-    void* ( __cdecl *pf_memcpy ) ( void *, const void *, size_t );
-    void* ( __cdecl *pf_memset ) ( void *, int, size_t );
-#else
-    void* ( *pf_memcpy ) ( void *, const void *, size_t );
-    void* ( *pf_memset ) ( void *, int, size_t );
+    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
 
-    /* Shared data - these structures are accessed directly from p_vlc by
-     * several modules */
-    input_channel_t *      p_channel;                /* channel library data */
+    /* Structure storing the action name / key associations */
+    struct hotkey
+    {
+        const char *psz_action;
+        int i_action;
+        int i_key;
 
-    /* Locks */
-    vlc_mutex_t            config_lock;          /* lock for the config file */
-#ifdef SYS_DARWIN
-    vlc_mutex_t            quicktime_lock;          /* QT is not thread safe on OSX */
-#endif
+        /* 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;
 };