d5a248b8769a4e67b82c85e0c1f4499a1643fc6d
[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 VideoLAN
6  * $Id: main.h,v 1.46 2002/10/03 13:21:54 sam Exp $
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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
23  *****************************************************************************/
24
25 /*****************************************************************************
26  * libvlc_t (global variable)
27  *****************************************************************************
28  * This structure has an unique instance, statically allocated in main and
29  * never accessed from the outside. It store once-initialized data such as
30  * the CPU capabilities or the global lock.
31  *****************************************************************************/
32 struct libvlc_t
33 {
34     VLC_COMMON_MEMBERS
35
36     /* Initialization boolean */
37     vlc_bool_t             b_ready;
38
39     /* CPU extensions */
40     u32                    i_cpu;
41
42     /* Object structure data */
43     int                    i_counter;                      /* object counter */
44     int                    i_objects;              /* Attached objects count */
45     vlc_object_t **        pp_objects;               /* Array of all objects */
46
47     /* The big, evil global lock */
48     vlc_mutex_t            global_lock;
49     void *                 p_global_data;
50
51     /* Locks */
52     vlc_mutex_t            structure_lock;        /* lock for the p_vlc tree */
53
54     /* The message bank */
55     msg_bank_t             msg_bank;
56
57     /* The module bank */
58     module_bank_t *        p_module_bank;
59
60     /* Arch-specific variables */
61 #if defined( SYS_BEOS )
62     vlc_object_t *         p_appthread;
63 #elif defined( WIN32 )
64     SIGNALOBJECTANDWAIT    SignalObjectAndWait;
65     vlc_bool_t             b_fast_mutex;
66     int                    i_win9x_cv;
67 #endif
68 };
69
70 /*****************************************************************************
71  * vlc_t, p_vlc
72  *****************************************************************************
73  * This structure is a LibVLC instance.
74  *****************************************************************************/
75 struct vlc_t
76 {
77     VLC_COMMON_MEMBERS
78
79     /* The vlc structure status */
80     int                    i_status;
81
82     /* Global properties */
83     int                    i_argc;           /* command line arguments count */
84     char **                ppsz_argv;              /* command line arguments */
85     char *                 psz_homedir;             /* user's home directory */
86
87     /* Generic settings */
88     vlc_bool_t             b_quiet;                            /* be quiet ? */
89     vlc_bool_t             b_verbose;                     /* info messages ? */
90     vlc_bool_t             b_color;                      /* color messages ? */
91     mtime_t                i_desync;   /* relative desync of the audio ouput */
92
93     /* CPU extensions (inherited from libvlc_t) */
94     u32                    i_cpu;
95
96     /* Fast memcpy plugin used */
97     module_t *             p_memcpy_module;
98     void* ( *pf_memcpy ) ( void *, const void *, size_t );
99     void* ( *pf_memset ) ( void *, int, size_t );
100
101     /* Shared data - these structures are accessed directly from p_vlc by
102      * several modules */
103     input_channel_t *      p_channel;                /* channel library data */
104
105     /* Locks */
106     vlc_mutex_t            config_lock;          /* lock for the config file */
107 };
108