git.sesse.net Git - vlc/blob - src/libvlc.h

   1 /*****************************************************************************
   2  * libvlc.h: Internal libvlc generic/misc declaration
   3  *****************************************************************************
   4  * Copyright (C) 1999, 2000, 2001, 2002 the VideoLAN team
   5  * Copyright © 2006-2007 Rémi Denis-Courmont
   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 #ifndef LIBVLC_LIBVLC_H
  26 # define LIBVLC_LIBVLC_H 1
  27
  28 extern const char vlc_usage[];
  29
  30 extern const struct hotkey libvlc_hotkeys[];
  31 extern const size_t libvlc_hotkeys_size;
  32
  33
  34 /*
  35  * OS-specific initialization
  36  */
  37 void system_Init      ( libvlc_int_t *, int *, const char *[] );
  38 void system_Configure ( libvlc_int_t *, int *, const char *[] );
  39 void system_End       ( libvlc_int_t * );
  40
  41 #if defined( SYS_BEOS )
  42 /* Nothing at the moment, create beos_specific.h when needed */
  43 #elif defined( __APPLE__ )
  44 /* Nothing at the moment, create darwin_specific.h when needed */
  45 #elif defined( WIN32 ) || defined( UNDER_CE )
  46 VLC_EXPORT( const char * , system_VLCPath, (void));
  47 #else
  48 # define system_Init( a, b, c )      (void)0
  49 # define system_Configure( a, b, c ) (void)0
  50 # define system_End( a )             (void)0
  51 #endif
  52
  53
  54 /*
  55  * Threads subsystem
  56  */
  57 int __vlc_threads_init( vlc_object_t * );
  58 int __vlc_threads_end( vlc_object_t * );
  59
  60 /*
  61  * CPU capabilities
  62  */
  63 extern uint32_t cpu_flags;
  64 uint32_t CPUCapabilities( void );
  65
  66 /*
  67  * Unicode stuff
  68  */
  69
  70 /*
  71  * LibVLC objects stuff
  72  */
  73
  74 extern vlc_object_t *
  75 vlc_custom_create (vlc_object_t *p_this, size_t i_size, int i_type,
  76                    const char *psz_type);
  77
  78 /*****************************************************************************
  79  * libvlc_global_data_t (global variable)
  80  *****************************************************************************
  81  * This structure has an unique instance, statically allocated in main and
  82  * never accessed from the outside. It stores once-initialized data such as
  83  * the CPU capabilities or the global lock.
  84  *****************************************************************************/
  85 struct libvlc_global_data_t
  86 {
  87     VLC_COMMON_MEMBERS
  88
  89     vlc_bool_t             b_ready;     ///< Initialization boolean
  90
  91    /* Object structure data */
  92     int                    i_counter;   ///< object counter
  93     int                    i_objects;   ///< Attached objects count
  94     vlc_object_t **        pp_objects;  ///< Array of all objects
  95
  96     module_bank_t *        p_module_bank; ///< The module bank
  97     intf_thread_t         *p_probe;       ///< Devices prober
  98
  99     /* Arch-specific variables */
 100 #if !defined( WIN32 )
 101     vlc_bool_t             b_daemon;
 102 #endif
 103 #if defined( SYS_BEOS )
 104     vlc_object_t *         p_appthread;
 105     char *                 psz_vlcpath;
 106 #elif defined( __APPLE__ )
 107     char *                 psz_vlcpath;
 108     vlc_iconv_t            iconv_macosx; /* for HFS+ file names */
 109     vlc_mutex_t            iconv_lock;
 110 #elif defined( WIN32 )
 111     char *                 psz_vlcpath;
 112 #endif
 113 };
 114
 115
 116 libvlc_global_data_t *vlc_global (void);
 117 libvlc_int_t *vlc_current_object (int i_object);
 118
 119 /* Private LibVLC data for each objects */
 120 struct vlc_object_internals_t
 121 {
 122     /* Object variables */
 123     variable_t *    p_vars;
 124     vlc_mutex_t     var_lock;
 125     int             i_vars;
 126
 127     /* Thread properties, if any */
 128     vlc_thread_t    thread_id;
 129     vlc_bool_t      b_thread;
 130
 131     /* Objects thread synchronization */
 132     int             pipes[2];
 133     vlc_spinlock_t  spin;
 134
 135     /* Objects management */
 136     unsigned        i_refcount;
 137     vlc_bool_t      b_attached;
 138 };
 139
 140
 141 static inline vlc_object_internals_t *vlc_internals( vlc_object_t *obj )
 142 {
 143     return obj->p_internals;
 144 }
 145
 146 /*
 147  * Configuration stuff
 148  */
 149 #if 0
 150 struct module_config_t
 151 {
 152     int          i_type;                               /* Configuration type */
 153     const char  *psz_type;                          /* Configuration subtype */
 154     const char  *psz_name;                                    /* Option name */
 155     char         i_short;                      /* Optional short option name */
 156     const char  *psz_text;      /* Short comment on the configuration option */
 157     const char  *psz_longtext;   /* Long comment on the configuration option */
 158     module_value_t value;                                    /* Option value */
 159     module_value_t orig;
 160     module_value_t saved;
 161     module_nvalue_t min;
 162     module_nvalue_t max;
 163
 164     /* Function to call when commiting a change */
 165     vlc_callback_t pf_callback;
 166     void          *p_callback_data;
 167
 168     /* Values list */
 169     const char **ppsz_list;       /* List of possible values for the option */
 170     int         *pi_list;                              /* Idem for integers */
 171     const char **ppsz_list_text;          /* Friendly names for list values */
 172     int          i_list;                               /* Options list size */
 173
 174     /* Actions list */
 175     vlc_callback_t *ppf_action;    /* List of possible actions for a config */
 176     const char    **ppsz_action_text;         /* Friendly names for actions */
 177     int            i_action;                           /* actions list size */
 178
 179     /* Misc */
 180     vlc_mutex_t *p_lock;            /* Lock to use when modifying the config */
 181     vlc_bool_t   b_dirty;          /* Dirty flag to indicate a config change */
 182     vlc_bool_t   b_advanced;          /* Flag to indicate an advanced option */
 183     vlc_bool_t   b_internal;   /* Flag to indicate option is not to be shown */
 184     vlc_bool_t   b_restart;   /* Flag to indicate the option needs a restart */
 185                               /* to take effect */
 186
 187     /* Deprecated */
 188     const char    *psz_current;                         /* Good option name */
 189     vlc_bool_t     b_strict;                     /* Transitionnal or strict */
 190
 191     /* Option values loaded from config file */
 192     vlc_bool_t   b_autosave;      /* Config will be auto-saved at exit time */
 193     vlc_bool_t   b_unsaveable;                    /* Config should be saved */
 194 };
 195 #endif
 196
 197 extern module_config_t libvlc_config[];
 198 extern const size_t libvlc_config_count;
 199
 200 /*
 201  * Variables stuff
 202  */
 203 void var_OptionParse (vlc_object_t *, const char *);
 204
 205 #endif