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