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 #if !defined( __LIBVLC__ )
  26   #error You are not libvlc or one of its plugins. You cannot include this file
  27 #endif
  28
  29 TYPEDEF_ARRAY(input_item_t*, input_item_array_t);
  30
  31 /*****************************************************************************
  32  * libvlc_internal_instance_t
  33  *****************************************************************************
  34  * This structure is a LibVLC instance, for use by libvlc core and plugins
  35  *****************************************************************************/
  36 struct libvlc_int_t
  37 {
  38     VLC_COMMON_MEMBERS
  39
  40     /* Global properties */
  41     char *                 psz_homedir;      ///< user's home directory
  42     char *                 psz_configdir;    ///< user's configuration directory
  43     char *                 psz_datadir;      ///< user's data directory
  44     char *                 psz_cachedir;     ///< user's cache directory
  45
  46     char *                 psz_configfile;   ///< location of config file
  47
  48     playlist_t            *p_playlist;       ///< playlist object
  49
  50     vlc_object_t          *p_interaction;    ///< interface interaction object
  51
  52     vlm_t                 *p_vlm;            ///< vlm if created from libvlc-common.
  53                                              /// (this is clearly private and
  54                                              //  shouldn't be used)
  55
  56     void                 *p_stats_computer;  ///< Input thread computing stats (needs cleanup)
  57     global_stats_t       *p_stats;           ///< Global statistics
  58
  59     /* There is no real reason to keep a list of items, but not to break
  60      * everything, let's keep it */
  61     input_item_array_t    input_items;       ///< Array of all created input items
  62     int                   i_last_input_id ;  ///< Last id of input item
  63
  64     /* Messages */
  65     msg_bank_t             msg_bank;    ///< The message bank
  66     int                    i_verbose;   ///< info messages
  67     bool             b_color;     ///< color messages?
  68
  69     module_t *             p_memcpy_module;  ///< Fast memcpy plugin used
  70     void* ( *pf_memcpy ) ( void *, const void *, size_t ); ///< fast memcpy
  71     void* ( *pf_memset ) ( void *, int, size_t );          ///< fast memset
  72
  73     bool             b_stats;       ///< Should we collect stats ?
  74     vlc_mutex_t            timer_lock;    ///< Lock to protect timers
  75     int                    i_timers;      ///< Number of timers
  76     counter_t            **pp_timers;     ///< Array of all timers
  77
  78     vlc_mutex_t            config_lock;    ///< Lock for the config file
  79 #ifdef __APPLE__
  80     vlc_mutex_t            quicktime_lock; ///< QT is not thread safe on OSX
  81 #endif
  82
  83     /* Structure storing the action name / key associations */
  84     struct hotkey
  85     {
  86         const char *psz_action;
  87         int i_action;
  88         int i_key;
  89     } *p_hotkeys;
  90 };
  91