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 /* Hotkey stuff */
  31 extern const struct hotkey libvlc_hotkeys[];
  32 extern const size_t libvlc_hotkeys_size;
  33 extern int vlc_key_to_action (vlc_object_t *, const char *,
  34                               vlc_value_t, vlc_value_t, void *);
  35
  36 /*
  37  * OS-specific initialization
  38  */
  39 void system_Init      ( libvlc_int_t *, int *, const char *[] );
  40 void system_Configure ( libvlc_int_t *, int *, const char *[] );
  41 void system_End       ( libvlc_int_t * );
  42
  43 /*
  44  * Threads subsystem
  45  */
  46 int vlc_threads_init( void );
  47 void vlc_threads_end( void );
  48
  49 /** The global thread var for msg stack context
  50  *  We store this as a static global variable so we don't need a vlc_object_t
  51  *  everywhere.
  52  *  This key is created in vlc_threads_init and is therefore ready to use at
  53  *  the very beginning of the universe */
  54 extern vlc_threadvar_t msg_context_global_key;
  55
  56 /*
  57  * CPU capabilities
  58  */
  59 extern uint32_t cpu_flags;
  60 uint32_t CPUCapabilities( void );
  61
  62 /*
  63  * Message/logging stuff
  64  */
  65
  66 #define NB_QUEUES 2
  67
  68 typedef struct msg_queue_t
  69 {
  70     int                     i_id;
  71
  72     /** Message queue lock */
  73     vlc_mutex_t             lock;
  74     bool              b_overflow;
  75
  76     /* Message queue */
  77     msg_item_t              msg[VLC_MSG_QSIZE];           /**< message queue */
  78     int i_start;
  79     int i_stop;
  80
  81     /* Subscribers */
  82     int i_sub;
  83     msg_subscription_t **pp_sub;
  84
  85     /* Logfile for WinCE */
  86 #ifdef UNDER_CE
  87     FILE *logfile;
  88 #endif
  89 } msg_queue_t;
  90
  91 /**
  92  * Store all data required by messages interfaces.
  93  */
  94 typedef struct msg_bank_t
  95 {
  96     vlc_mutex_t             lock;
  97     msg_queue_t             queues[NB_QUEUES];
  98 } msg_bank_t;
  99
 100 void msg_Create  (libvlc_int_t *);
 101 void msg_Flush   (libvlc_int_t *);
 102 void msg_Destroy (libvlc_int_t *);
 103
 104 /** Internal message stack context */
 105 typedef struct
 106 {
 107     int i_code;
 108     char * psz_message;
 109 } msg_context_t;
 110
 111 void msg_StackSet ( int, const char*, ... );
 112 void msg_StackAdd ( const char*, ... );
 113 const char* msg_StackMsg ( void );
 114
 115 /*
 116  * Unicode stuff
 117  */
 118
 119 /*
 120  * LibVLC objects stuff
 121  */
 122
 123 /**
 124  * Creates a VLC object.
 125  *
 126  * Note that because the object name pointer must remain valid, potentially
 127  * even after the destruction of the object (through the message queues), this
 128  * function CANNOT be exported to plugins as is. In this case, the old
 129  * vlc_object_create() must be used instead.
 130  *
 131  * @param p_this an existing VLC object
 132  * @param i_size byte size of the object structure
 133  * @param i_type object type, usually VLC_OBJECT_CUSTOM
 134  * @param psz_type object type name
 135  * @return the created object, or NULL.
 136  */
 137 extern void *
 138 vlc_custom_create (vlc_object_t *p_this, size_t i_size, int i_type,
 139                    const char *psz_type);
 140
 141 /**
 142  * libvlc_global_data_t (global variable)
 143  *
 144  * This structure has an unique instance, statically allocated in libvlc and
 145  * never accessed from the outside. It stores process-wide VLC variables,
 146  * mostly process-wide locks, and (currently) the module bank and objects tree.
 147  */
 148 typedef struct libvlc_global_data_t
 149 {
 150     VLC_COMMON_MEMBERS
 151
 152    /* Object structure data */
 153     int                    i_counter;   ///< object counter
 154     int                    i_objects;   ///< Attached objects count
 155     vlc_object_t **        pp_objects;  ///< Array of all objects
 156
 157     module_bank_t *        p_module_bank; ///< The module bank
 158
 159     char *                 psz_vlcpath;
 160 } libvlc_global_data_t;
 161
 162
 163 libvlc_global_data_t *vlc_global (void);
 164 libvlc_int_t *vlc_current_object (int i_object);
 165
 166 /**
 167  * Private LibVLC data for each object.
 168  */
 169 struct vlc_object_internals_t
 170 {
 171     /* Object variables */
 172     variable_t *    p_vars;
 173     vlc_mutex_t     var_lock;
 174     int             i_vars;
 175
 176     /* Thread properties, if any */
 177     vlc_thread_t    thread_id;
 178     bool            b_thread;
 179
 180     /* Objects thread synchronization */
 181     int             pipes[2];
 182     vlc_spinlock_t  spin;
 183
 184     /* Objects management */
 185     vlc_spinlock_t   ref_spin;
 186     unsigned         i_refcount;
 187     vlc_destructor_t pf_destructor;
 188     bool             b_attached;
 189 };
 190
 191 #define ZOOM_SECTION N_("Zoom")
 192 #define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
 193 #define ZOOM_HALF_KEY_TEXT N_("1:2 Half")
 194 #define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
 195 #define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
 196
 197 static inline vlc_object_internals_t *vlc_internals( vlc_object_t *obj )
 198 {
 199     return ((vlc_object_internals_t *)obj) - 1;
 200 }
 201
 202 /**
 203  * Private LibVLC instance data.
 204  */
 205 typedef struct libvlc_priv_t
 206 {
 207     /* Configuration */
 208     vlc_mutex_t        config_lock; ///< config file lock
 209     char *             psz_configfile;   ///< location of config file
 210
 211     /* There is no real reason to keep a list of items, but not to break
 212      * everything, let's keep it */
 213     input_item_array_t input_items; ///< Array of all created input items
 214     int                i_last_input_id ; ///< Last id of input item
 215
 216     /* Messages */
 217     msg_bank_t         msg_bank;    ///< The message bank
 218     int                i_verbose;   ///< info messages
 219     bool               b_color;     ///< color messages?
 220
 221     /* Timer stats */
 222     vlc_mutex_t        timer_lock;  ///< Lock to protect timers
 223     counter_t        **pp_timers;   ///< Array of all timers
 224     int                i_timers;    ///< Number of timers
 225     bool               b_stats;     ///< Whether to collect stats
 226
 227     void              *p_stats_computer;  ///< Input thread computing stats
 228                                           /// (needs cleanup)
 229
 230     module_t          *p_memcpy_module;  ///< Fast memcpy plugin used
 231     playlist_t        *p_playlist; //< the playlist singleton
 232     vlm_t             *p_vlm;  ///< the VLM singleton (or NULL)
 233     vlc_object_t      *p_interaction;    ///< interface interaction object
 234     httpd_t           *p_httpd; ///< HTTP daemon (src/network/httpd.c)
 235 } libvlc_priv_t;
 236
 237 static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc)
 238 {
 239     return (libvlc_priv_t *)(libvlc + 1);
 240 }
 241
 242 #define libvlc_stats( o ) (libvlc_priv((VLC_OBJECT(o))->p_libvlc)->b_stats)
 243
 244 /**
 245  * LibVLC "main module" configuration settings array.
 246  */
 247 extern module_config_t libvlc_config[];
 248 extern const size_t libvlc_config_count;
 249
 250 /*
 251  * Variables stuff
 252  */
 253 void var_OptionParse (vlc_object_t *, const char *, bool trusted);
 254
 255 #endif