]> git.sesse.net Git - vlc/blob - include/main.h
70d79203acc272168becbc3846938e23a994a85f
[vlc] / 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 VideoLAN
6  * $Id: main.h,v 1.33 2002/03/21 07:11:57 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  * main_t, p_main (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
36 typedef struct main_s
37 {
38     /* Global properties */
39     int                    i_argc;           /* command line arguments count */
40     char **                ppsz_argv;              /* command line arguments */
41     char *                 psz_arg0;         /* program name (whithout path) */
42     char *                 psz_homedir;             /* user's home directory */
43
44     u32                    i_cpu_capabilities;             /* CPU extensions */
45     int                    i_warning_level;        /* warning messages level */
46     boolean_t              b_stats;                  /* display statistics ? */
47
48     /* Generic settings */
49     boolean_t              b_audio;             /* is audio output allowed ? */
50     boolean_t              b_video;             /* is video output allowed ? */
51     boolean_t              b_stereo;
52     mtime_t                i_desync;   /* relative desync of the audio ouput */
53
54     /* Fast memcpy plugin used */
55     module_t *             p_memcpy_module;
56     void* ( *pf_memcpy ) ( void *, const void *, size_t );
57     void* ( *pf_memset ) ( void *, int, size_t );    /* FIXME: unimplemented */
58
59     /* Unique threads */
60     p_intf_thread_t        p_intf;                  /* main interface thread */
61
62     /* Shared data - these structures are accessed directly from p_main by
63      * several modules */
64     p_playlist_t           p_playlist;                           /* playlist */
65     p_intf_msg_t           p_msg;                 /* messages interface data */
66     p_input_channel_t      p_channel;                /* channel library data */
67
68     /* Locks */
69     vlc_mutex_t            config_lock;          /* lock for the config file */
70 } main_t;
71
72 #ifndef PLUGIN
73 extern main_t *p_main;
74 #else
75 #   define p_main (p_symbols->p_main)
76 #endif
77
78 /*****************************************************************************
79  * Fast memory operation module
80  *****************************************************************************/
81 #define FAST_MEMCPY p_main->pf_memcpy
82 #define FAST_MEMSET p_main->pf_memset