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