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, 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 /*****************************************************************************
  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     uint32_t               i_cpu;
  41
  42     /* Generic settings */
  43     int                    i_verbose;                       /* info messages */
  44     vlc_bool_t             b_color;                       /* color messages? */
  45
  46     /* Object structure data */
  47     int                    i_counter;                      /* object counter */
  48     int                    i_objects;              /* Attached objects count */
  49     vlc_object_t **        pp_objects;               /* Array of all objects */
  50
  51     /* The message bank */
  52     msg_bank_t             msg_bank;
  53
  54     /* UTF-8 conversion */
  55     vlc_mutex_t            from_locale_lock;
  56     vlc_mutex_t            to_locale_lock;
  57     vlc_iconv_t            from_locale;
  58     vlc_iconv_t            to_locale;
  59
  60     /* The module bank */
  61     module_bank_t *        p_module_bank;
  62
  63     /* Do stats ? - We keep this boolean to avoid unneeded lookups */
  64     vlc_bool_t             b_stats;
  65     stats_handler_t       *p_stats;
  66
  67     /* Arch-specific variables */
  68 #if !defined( WIN32 )
  69     vlc_bool_t             b_daemon;
  70 #endif
  71 #if defined( SYS_BEOS )
  72     vlc_object_t *         p_appthread;
  73     char *                 psz_vlcpath;
  74 #elif defined( __APPLE__ )
  75     char *                 psz_vlcpath;
  76     vlc_iconv_t            iconv_macosx; /* for HFS+ file names */
  77     vlc_mutex_t            iconv_lock;
  78 #elif defined( WIN32 ) && !defined( UNDER_CE )
  79     SIGNALOBJECTANDWAIT    SignalObjectAndWait;
  80     vlc_bool_t             b_fast_mutex;
  81     int                    i_win9x_cv;
  82     char *                 psz_vlcpath;
  83 #elif defined( UNDER_CE )
  84     char *                 psz_vlcpath;
  85 #endif
  86 };
  87
  88 /*****************************************************************************
  89  * vlc_t, p_vlc
  90  *****************************************************************************
  91  * This structure is a LibVLC instance.
  92  *****************************************************************************/
  93 struct vlc_t
  94 {
  95     VLC_COMMON_MEMBERS
  96
  97     /* Global properties */
  98     int                    i_argc;           /* command line arguments count */
  99     char **                ppsz_argv;              /* command line arguments */
 100     char *                 psz_homedir;           /* configuration directory */
 101     char *                 psz_userdir;             /* user's home directory */
 102     char *                 psz_configfile;        /* location of config file */
 103
 104     /* Fast memcpy plugin used */
 105     module_t *             p_memcpy_module;
 106     void* ( *pf_memcpy ) ( void *, const void *, size_t );
 107     void* ( *pf_memset ) ( void *, int, size_t );
 108
 109     /* Shared data - these structures are accessed directly from p_vlc by
 110      * several modules */
 111
 112     /* Locks */
 113     vlc_mutex_t            config_lock;          /* lock for the config file */
 114 #ifdef __APPLE__
 115     vlc_mutex_t            quicktime_lock;          /* QT is not thread safe on OSX */
 116 #endif
 117
 118     /* Structure storing the action name / key associations */
 119     struct hotkey
 120     {
 121         const char *psz_action;
 122         int i_action;
 123         int i_key;
 124
 125         /* hotkey accounting information */
 126         mtime_t i_delta_date;/*< minimum delta time between two key presses */
 127         mtime_t i_last_date; /*< last date key was pressed */
 128         int     i_times;     /*< n times pressed within delta date*/
 129     } *p_hotkeys;
 130 };
 131