On OSes other than Windows, Mac OS X and BeOS (so it's Linux) comply with the XDG...
[vlc.git] / include / main.h
1 /*****************************************************************************
2  * main.h: access to all program variables
3  * Declaration and extern access to global program object.
4  *****************************************************************************
5  * Copyright (C) 1999, 2000, 2001, 2002 the VideoLAN team
6  * $Id$
7  *
8  * Authors: Vincent Seguin <seguin@via.ecp.fr>
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23  *****************************************************************************/
24
25 #if !defined( __LIBVLC__ )
26   #error You are not libvlc or one of its plugins. You cannot include this file
27 #endif
28
29 /*****************************************************************************
30  * libvlc_internal_instance_t
31  *****************************************************************************
32  * This structure is a LibVLC instance, for use by libvlc core and plugins
33  *****************************************************************************/
34 struct libvlc_int_t
35 {
36     VLC_COMMON_MEMBERS
37
38     /* Global properties */
39     int                    i_argc;           ///< command line arguments count
40     char **                ppsz_argv;        ///< command line arguments
41
42     char *                 psz_homedir;      ///< user's home directory
43     char *                 psz_configdir;    ///< user's configuration directory
44     char *                 psz_datadir;      ///< user's data/cache directory
45
46     char *                 psz_configfile;   ///< location of config file
47
48     playlist_t            *p_playlist;       ///< playlist object
49
50     /* Messages */
51     msg_bank_t             msg_bank;    ///< The message bank
52     int                    i_verbose;   ///< info messages
53     vlc_bool_t             b_color;     ///< color messages?
54
55     module_t *             p_memcpy_module;  ///< Fast memcpy plugin used
56     void* ( *pf_memcpy ) ( void *, const void *, size_t ); ///< fast memcpy
57     void* ( *pf_memset ) ( void *, int, size_t );          ///< fast memset
58
59     vlc_bool_t             b_stats;       ///< Should we collect stats ?
60     vlc_mutex_t            timer_lock;    ///< Lock to protect timers
61     int                    i_timers;      ///< Number of timers
62     counter_t            **pp_timers;     ///< Array of all timers
63
64     vlc_mutex_t            config_lock;    ///< Lock for the config file
65 #ifdef __APPLE__
66     vlc_mutex_t            quicktime_lock; ///< QT is not thread safe on OSX
67 #endif
68
69     /* Structure storing the action name / key associations */
70     struct hotkey
71     {
72         const char *psz_action;
73         int i_action;
74         int i_key;
75
76         /* hotkey accounting information */
77         mtime_t i_delta_date;/*< minimum delta time between two key presses */
78         mtime_t i_last_date; /*< last date key was pressed */
79         int     i_times;     /*< n times pressed within delta date*/
80     } *p_hotkeys;
81 };
82