* include/vlc_threads.h,include/main.h,src/misc/threads.c,src/misc/win32_specific.c:
[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.41 2002/07/29 19:05:47 gbazin 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  * vlc_t, p_vlc (global variable)
27  *****************************************************************************
28  * This structure has an unique instance, declared in main and pointed by the
29  * only global variable of the program. It should allow access to any variable
30  * of the program, for user-interface purposes or more easier call of interface
31  * and common functions (example: the intf_*Msg functions). Please avoid using
32  * it when you can access the members you need in an other way. In fact, it
33  * should only be used by interface thread.
34  *****************************************************************************/
35 struct vlc_t
36 {
37     VLC_COMMON_MEMBERS
38
39     /* The vlc structure status */
40     int                    i_status;
41
42     /* Global properties */
43     int                    i_argc;           /* command line arguments count */
44     char **                ppsz_argv;              /* command line arguments */
45     char *                 psz_homedir;             /* user's home directory */
46
47     u32                    i_cpu_capabilities;             /* CPU extensions */
48
49     /* Generic settings */
50     vlc_bool_t             b_quiet;                            /* be quiet ? */
51     vlc_bool_t             b_verbose;                     /* info messages ? */
52     vlc_bool_t             b_color;                      /* color messages ? */
53     mtime_t                i_desync;   /* relative desync of the audio ouput */
54
55     /* Fast memcpy plugin used */
56     module_t *             p_memcpy_module;
57     void* ( *pf_memcpy ) ( void *, const void *, size_t );
58     void* ( *pf_memset ) ( void *, int, size_t );    /* FIXME: unimplemented */
59
60     /* The module bank */
61     module_bank_t   module_bank;
62
63     /* The message bank */
64     msg_bank_t      msg_bank;
65
66     /* Shared data - these structures are accessed directly from p_vlc by
67      * several modules */
68     intf_msg_t *           p_msg;                 /* messages interface data */
69     input_channel_t *      p_channel;                /* channel library data */
70
71     /* Locks */
72     vlc_mutex_t            config_lock;          /* lock for the config file */
73     vlc_mutex_t            structure_lock;        /* lock for the p_vlc tree */
74     int                    i_unique;                    /* p_vlc occurence # */
75     int                    i_counter;                      /* object counter */
76
77     /* Pointer to the big, evil global lock */
78     vlc_mutex_t *          p_global_lock;
79     void **                pp_global_data;
80
81     /* System-specific variables */
82 #if defined( SYS_BEOS )
83     vlc_object_t *         p_appthread;
84 #elif defined( WIN32 )
85     SIGNALOBJECTANDWAIT    SignalObjectAndWait;
86     vlc_bool_t             b_fast_mutex;
87     int                    i_win9x_cv;
88 #endif
89 };
90