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 vlc_object_t *vlc_threadobj (void);
  49 #ifdef LIBVLC_REFCHECK
  50 void vlc_refcheck (vlc_object_t *obj);
  51 #else
  52 # define vlc_refcheck( obj ) (void)0
  53 #endif
  54
  55 /*
  56  * CPU capabilities
  57  */
  58 extern uint32_t cpu_flags;
  59 uint32_t CPUCapabilities( void );
  60
  61 /*
  62  * Message/logging stuff
  63  */
  64
  65 typedef struct msg_queue_t
  66 {
  67     /** Message queue lock */
  68     vlc_mutex_t             lock;
  69     bool              b_overflow;
  70
  71     /* Message queue */
  72     msg_item_t              msg[VLC_MSG_QSIZE];           /**< message queue */
  73     int i_start;
  74     int i_stop;
  75
  76     /* Subscribers */
  77     int i_sub;
  78     msg_subscription_t **pp_sub;
  79
  80     /* Logfile for WinCE */
  81 #ifdef UNDER_CE
  82     FILE *logfile;
  83 #endif
  84 } msg_queue_t;
  85
  86 /**
  87  * Store all data required by messages interfaces.
  88  */
  89 typedef struct msg_bank_t
  90 {
  91     vlc_mutex_t             lock;
  92     msg_queue_t             queue;
  93 } msg_bank_t;
  94
  95 void msg_Create  (libvlc_int_t *);
  96 void msg_Flush   (libvlc_int_t *);
  97 void msg_Destroy (libvlc_int_t *);
  98
  99 /** Internal message stack context */
 100 typedef struct
 101 {
 102     int i_code;
 103     char * psz_message;
 104 } msg_context_t;
 105
 106 void msg_StackSet ( int, const char*, ... );
 107 void msg_StackAdd ( const char*, ... );
 108 const char* msg_StackMsg ( void );
 109 /** The global thread var for msg stack context
 110  *  We store this as a static global variable so we don't need a vlc_object_t
 111  *  everywhere.
 112  *  This key is created in vlc_threads_init and is therefore ready to use at
 113  *  the very beginning of the universe */
 114 extern vlc_threadvar_t msg_context_global_key;
 115 void msg_StackDestroy (void *);
 116
 117 /*
 118  * Unicode stuff
 119  */
 120 char *vlc_fix_readdir (const char *);
 121
 122 /*
 123  * LibVLC objects stuff
 124  */
 125
 126 /**
 127  * Creates a VLC object.
 128  *
 129  * Note that because the object name pointer must remain valid, potentially
 130  * even after the destruction of the object (through the message queues), this
 131  * function CANNOT be exported to plugins as is. In this case, the old
 132  * vlc_object_create() must be used instead.
 133  *
 134  * @param p_this an existing VLC object
 135  * @param i_size byte size of the object structure
 136  * @param i_type object type, usually VLC_OBJECT_CUSTOM
 137  * @param psz_type object type name
 138  * @return the created object, or NULL.
 139  */
 140 extern void *
 141 __vlc_custom_create (vlc_object_t *p_this, size_t i_size, int i_type,
 142                      const char *psz_type);
 143 #define vlc_custom_create(o, s, t, n) \
 144         __vlc_custom_create(VLC_OBJECT(o), s, t, n)
 145
 146 /**
 147  * libvlc_global_data_t (global variable)
 148  *
 149  * This structure has an unique instance, statically allocated in libvlc and
 150  * never accessed from the outside. It stores process-wide VLC variables,
 151  * mostly process-wide locks, and (currently) the module bank and objects tree.
 152  */
 153 typedef struct libvlc_global_data_t
 154 {
 155     VLC_COMMON_MEMBERS
 156
 157     /* Object structure data */
 158     int                    i_counter;   ///< object counter
 159
 160     module_bank_t *        p_module_bank; ///< The module bank
 161
 162     char *                 psz_vlcpath;
 163 } libvlc_global_data_t;
 164
 165
 166 libvlc_global_data_t *vlc_global (void);
 167
 168 /**
 169  * Private LibVLC data for each object.
 170  */
 171 struct vlc_object_internals_t
 172 {
 173     /* Object variables */
 174     variable_t *    p_vars;
 175     vlc_mutex_t     var_lock;
 176     int             i_vars;
 177
 178     /* Thread properties, if any */
 179     vlc_thread_t    thread_id;
 180     bool            b_thread;
 181
 182     /* Objects thread synchronization */
 183     vlc_mutex_t     lock;
 184     vlc_cond_t      wait;
 185     int             pipes[2];
 186     vlc_spinlock_t  spin;
 187
 188     /* Objects management */
 189     vlc_spinlock_t   ref_spin;
 190     unsigned         i_refcount;
 191     vlc_destructor_t pf_destructor;
 192 #ifndef LIBVLC_REFCHECK
 193     vlc_thread_t     creator_id;
 194 #endif
 195
 196     /* Objects tree structure */
 197     vlc_object_t    *prev, *next;
 198     vlc_object_t   **pp_children;
 199     int              i_children;
 200 };
 201
 202 #define ZOOM_SECTION N_("Zoom")
 203 #define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
 204 #define ZOOM_HALF_KEY_TEXT N_("1:2 Half")
 205 #define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
 206 #define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
 207
 208 #define vlc_internals( obj ) (((vlc_object_internals_t*)(VLC_OBJECT(obj)))-1)
 209
 210 /* Signal an object without checking for locking consistency. This is wrong. */
 211 #ifdef __GNUC__
 212 __attribute__((deprecated))
 213 #endif
 214 static inline void
 215 vlc_object_signal_maybe (vlc_object_t *p_this)
 216 {
 217     vlc_cond_signal (&(vlc_internals(p_this)->wait));
 218 }
 219
 220 /**
 221  * Private LibVLC instance data.
 222  */
 223 typedef struct libvlc_priv_t
 224 {
 225     /* Configuration */
 226     vlc_mutex_t        config_lock; ///< config file lock
 227     char *             psz_configfile;   ///< location of config file
 228
 229     /* There is no real reason to keep a list of items, but not to break
 230      * everything, let's keep it */
 231     input_item_array_t input_items; ///< Array of all created input items
 232     int                i_last_input_id ; ///< Last id of input item
 233
 234     /* Messages */
 235     msg_bank_t         msg_bank;    ///< The message bank
 236     int                i_verbose;   ///< info messages
 237     bool               b_color;     ///< color messages?
 238
 239     /* Timer stats */
 240     vlc_mutex_t        timer_lock;  ///< Lock to protect timers
 241     counter_t        **pp_timers;   ///< Array of all timers
 242     int                i_timers;    ///< Number of timers
 243     bool               b_stats;     ///< Whether to collect stats
 244
 245     void              *p_stats_computer;  ///< Input thread computing stats
 246                                           /// (needs cleanup)
 247
 248     /* Singleton objects */
 249     module_t          *p_memcpy_module;  ///< Fast memcpy plugin used
 250     playlist_t        *p_playlist; //< the playlist singleton
 251     vlm_t             *p_vlm;  ///< the VLM singleton (or NULL)
 252     interaction_t     *p_interaction;    ///< interface interaction object
 253     httpd_t           *p_httpd; ///< HTTP daemon (src/network/httpd.c)
 254
 255     /* Private playlist data (FIXME - playlist_t is too public...) */
 256     sout_instance_t   *p_sout; ///< kept sout instance (for playlist)
 257
 258     /* Thread support */
 259     unsigned           threads_count;
 260     vlc_mutex_t        threads_lock;
 261     vlc_cond_t         threads_wait;
 262
 263 #ifdef WIN32
 264     vlc_object_t       *ipc_helper;
 265 #endif
 266 } libvlc_priv_t;
 267
 268 static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc)
 269 {
 270     return (libvlc_priv_t *)(libvlc + 1);
 271 }
 272
 273 void playlist_ServicesDiscoveryKillAll( playlist_t *p_playlist );
 274
 275 #define libvlc_stats( o ) (libvlc_priv((VLC_OBJECT(o))->p_libvlc)->b_stats)
 276
 277 /**
 278  * LibVLC "main module" configuration settings array.
 279  */
 280 extern module_config_t libvlc_config[];
 281 extern const size_t libvlc_config_count;
 282
 283 /*
 284  * Variables stuff
 285  */
 286 void var_OptionParse (vlc_object_t *, const char *, bool trusted);
 287
 288 /*
 289  * Replacement functions
 290  */
 291 # ifndef HAVE_DIRENT_H
 292 typedef void DIR;
 293 #  ifndef FILENAME_MAX
 294 #      define FILENAME_MAX (260)
 295 #  endif
 296 struct dirent
 297 {
 298     long            d_ino;          /* Always zero. */
 299     unsigned short  d_reclen;       /* Always zero. */
 300     unsigned short  d_namlen;       /* Length of name in d_name. */
 301     char            d_name[FILENAME_MAX]; /* File name. */
 302 };
 303 #  define opendir vlc_opendir
 304 #  define readdir vlc_readdir
 305 #  define closedir vlc_closedir
 306 #  define rewinddir vlc_rewindir
 307 void *vlc_opendir (const char *);
 308 void *vlc_readdir (void *);
 309 int   vlc_closedir(void *);
 310 void  vlc_rewinddir(void *);
 311 # endif
 312
 313 #if defined (WIN32)
 314 #   include <dirent.h>
 315 void *vlc_wopendir (const wchar_t *);
 316 /* void *vlc_wclosedir (void *); in vlc's exported symbols */
 317 struct _wdirent *vlc_wreaddir (void *);
 318 void vlc_rewinddir (void *);
 319 #   define _wopendir vlc_wopendir
 320 #   define _wreaddir vlc_wreaddir
 321 #   define _wclosedir vlc_wclosedir
 322 #   define rewinddir vlc_rewinddir
 323 #endif
 324
 325 #endif