]> git.sesse.net Git - vlc/blobdiff - include/main.h
For consistency, remove references to vlc from libvlc
[vlc] / include / main.h
index a6a108759e65ceff1182b08e8e1d17c7bfb5c652..aa3919c52dd34646e3717da204f62e5d6e3a5238 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.40 2002/07/20 18:01:41 sam 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.
  *****************************************************************************/
 
 /*****************************************************************************
- * vlc_t, p_vlc (global variable)
+ * libvlc_global_data_t (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.
+ * 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 vlc_t
+struct libvlc_global_data_t
 {
     VLC_COMMON_MEMBERS
 
-    /* The vlc structure status */
-    int                    i_status;
+    vlc_bool_t             b_ready;     ///< Initialization boolean
+    uint32_t               i_cpu;       ///< CPU extensions
+    
+    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 
+
+    msg_bank_t             msg_bank;    ///< The message bank
+
+    module_bank_t *        p_module_bank; ///< The module bank
+
+    vlc_bool_t             b_stats;       ///< Should we collect stats
+    /* Timers handling */
+    vlc_mutex_t            timer_lock;    ///< Lock to protect timers
+    int                    i_timers;      ///< Number of timers
+    counter_t            **pp_timers;     ///< Array of all timers
+
+    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 ) && !defined( UNDER_CE )
+    SIGNALOBJECTANDWAIT    SignalObjectAndWait;
+    vlc_bool_t             b_fast_mutex;
+    int                    i_win9x_cv;
+    char *                 psz_vlcpath;
+#elif defined( UNDER_CE )
+    char *                 psz_vlcpath;
+#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 *                 psz_homedir;             /* user's home directory */
-
-    u32                    i_cpu_capabilities;             /* CPU extensions */
-
-    /* Generic settings */
-    vlc_bool_t             b_quiet;                            /* be quiet ? */
-    vlc_bool_t             b_verbose;                     /* info messages ? */
-    vlc_bool_t             b_color;                      /* color messages ? */
-    mtime_t                i_desync;   /* relative desync of the audio ouput */
+    char *                 psz_homedir;           /* configuration directory */
+    char *                 psz_userdir;             /* user's home directory */
+    char *                 psz_configfile;        /* location of config file */
 
     /* Fast memcpy plugin used */
     module_t *             p_memcpy_module;
     void* ( *pf_memcpy ) ( void *, const void *, size_t );
-    void* ( *pf_memset ) ( void *, int, size_t );    /* FIXME: unimplemented */
-
-    /* The module bank */
-    module_bank_t   module_bank;
-
-    /* The message bank */
-    msg_bank_t      msg_bank;
+    void* ( *pf_memset ) ( void *, int, size_t );
 
     /* Shared data - these structures are accessed directly from p_vlc by
      * several modules */
-    intf_msg_t *           p_msg;                 /* messages interface data */
-    input_channel_t *      p_channel;                /* channel library data */
 
     /* Locks */
     vlc_mutex_t            config_lock;          /* lock for the config file */
-    vlc_mutex_t            structure_lock;        /* lock for the p_vlc tree */
-    int                    i_unique;                    /* p_vlc occurence # */
-    int                    i_counter;                      /* object counter */
+#ifdef __APPLE__
+    vlc_mutex_t            quicktime_lock;          /* QT is not thread safe on OSX */
+#endif
 
-    /* Pointer to the big, evil global lock */
-    vlc_mutex_t *          p_global_lock;
-    void **                pp_global_data;
+    /* Structure storing the action name / key associations */
+    struct hotkey
+    {
+        const char *psz_action;
+        int i_action;
+        int i_key;
 
-    /* System-specific variables */
-#if defined( SYS_BEOS )
-    vlc_object_t *         p_appthread;
-#elif defined( WIN32 )
-    SIGNALOBJECTANDWAIT    SignalObjectAndWait;
-    vlc_bool_t             b_fast_pthread;
-#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;
 };