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