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