* 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>
*
* 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
+
/*****************************************************************************
- * vlc_t, p_vlc (global variable)
+ * libvlc_internal_instance_t
*****************************************************************************
- * 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 is a LibVLC instance, for use by libvlc core and plugins
*****************************************************************************/
-struct vlc_t
+struct libvlc_int_t
{
VLC_COMMON_MEMBERS
- /* The vlc structure status */
- int i_status;
-
/* Global properties */
- int i_argc; /* command line arguments count */
- char ** ppsz_argv; /* command line arguments */
- char * psz_homedir; /* user's home directory */
+ 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
- u32 i_cpu_capabilities; /* CPU extensions */
+ char * psz_configfile; ///< location of config file
- /* 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 */
+ playlist_t *p_playlist; ///< playlist object
- /* 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 */
+ /* Messages */
+ msg_bank_t msg_bank; ///< The message bank
+ int i_verbose; ///< info messages
+ vlc_bool_t b_color; ///< color messages?
- /* The module bank */
- module_bank_t module_bank;
+ 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
- /* The message bank */
- msg_bank_t msg_bank;
+ 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
- /* 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 */
+ 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
- /* 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;
};