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 typedef struct variable_t variable_t;
  29
  30 extern const char vlc_usage[];
  31
  32 /* Hotkey stuff */
  33 extern const struct hotkey libvlc_hotkeys[];
  34 extern const size_t libvlc_hotkeys_size;
  35 extern int vlc_key_to_action (vlc_object_t *, const char *,
  36                               vlc_value_t, vlc_value_t, void *);
  37
  38 /*
  39  * OS-specific initialization
  40  */
  41 void system_Init      ( libvlc_int_t *, int *, const char *[] );
  42 void system_Configure ( libvlc_int_t *, int *, const char *[] );
  43 void system_End       ( libvlc_int_t * );
  44
  45 /*
  46  * Threads subsystem
  47  */
  48 int vlc_threads_init( void );
  49 void vlc_threads_end( void );
  50
  51 /* Hopefully, no need to export this. There is a new thread API instead. */
  52 void vlc_thread_cancel (vlc_object_t *);
  53
  54 void vlc_trace (const char *fn, const char *file, unsigned line);
  55 #define vlc_backtrace() vlc_trace(__func__, __FILE__, __LINE__)
  56
  57 #if defined (LIBVLC_USE_PTHREAD) && !defined (NDEBUG)
  58 # define vlc_assert_locked( m ) \
  59          assert (pthread_mutex_lock (m) == EDEADLK)
  60 #else
  61 # define vlc_assert_locked( m ) (void)m
  62 #endif
  63
  64 /*
  65  * CPU capabilities
  66  */
  67 extern uint32_t cpu_flags;
  68 uint32_t CPUCapabilities( void );
  69
  70 /*
  71  * Message/logging stuff
  72  */
  73
  74 typedef struct msg_queue_t
  75 {
  76     /** Message queue lock */
  77     vlc_mutex_t             lock;
  78     bool              b_overflow;
  79
  80     /* Message queue */
  81     msg_item_t              msg[VLC_MSG_QSIZE];           /**< message queue */
  82     int i_start;
  83     int i_stop;
  84
  85     /* Subscribers */
  86     int i_sub;
  87     msg_subscription_t **pp_sub;
  88
  89     /* Logfile for WinCE */
  90 #ifdef UNDER_CE
  91     FILE *logfile;
  92 #endif
  93 } msg_queue_t;
  94
  95 /**
  96  * Store all data required by messages interfaces.
  97  */
  98 typedef struct msg_bank_t
  99 {
 100     vlc_mutex_t             lock;
 101     msg_queue_t             queue;
 102 } msg_bank_t;
 103
 104 void msg_Create  (libvlc_int_t *);
 105 void msg_Flush   (libvlc_int_t *);
 106 void msg_Destroy (libvlc_int_t *);
 107
 108 /** Internal message stack context */
 109 void msg_StackSet ( int, const char*, ... );
 110 void msg_StackAdd ( const char*, ... );
 111 const char* msg_StackMsg ( void );
 112 void msg_StackDestroy (void *);
 113
 114 /*
 115  * Unicode stuff
 116  */
 117 char *vlc_fix_readdir (const char *);
 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 #define vlc_custom_create(o, s, t, n) \
 141         __vlc_custom_create(VLC_OBJECT(o), s, t, n)
 142
 143 /**
 144  * libvlc_global_data_t (global variable)
 145  *
 146  * This structure has an unique instance, statically allocated in libvlc and
 147  * never accessed from the outside. It stores process-wide VLC variables,
 148  * mostly process-wide locks, and (currently) the module bank and objects tree.
 149  */
 150 typedef struct libvlc_global_data_t
 151 {
 152     VLC_COMMON_MEMBERS
 153
 154     char *                 psz_vlcpath;
 155 } libvlc_global_data_t;
 156
 157 /**
 158  * The module bank
 159  */
 160 extern module_bank_t *p_module_bank;
 161
 162 libvlc_global_data_t *vlc_global (void);
 163
 164 /**
 165  * Private LibVLC data for each object.
 166  */
 167 typedef struct vlc_object_internals_t
 168 {
 169     /* Object variables */
 170     variable_t *    p_vars;
 171     vlc_mutex_t     var_lock;
 172     int             i_vars;
 173
 174     /* Thread properties, if any */
 175     vlc_thread_t    thread_id;
 176     bool            b_thread;
 177
 178     /* Objects thread synchronization */
 179     vlc_mutex_t     lock;
 180     vlc_cond_t      wait;
 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
 189     /* Objects tree structure */
 190     vlc_object_t    *prev, *next;
 191     vlc_object_t   **pp_children;
 192     int              i_children;
 193 } vlc_object_internals_t;
 194
 195 #define ZOOM_SECTION N_("Zoom")
 196 #define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
 197 #define ZOOM_HALF_KEY_TEXT N_("1:2 Half")
 198 #define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
 199 #define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
 200
 201 #define vlc_internals( obj ) (((vlc_object_internals_t*)(VLC_OBJECT(obj)))-1)
 202
 203 typedef struct sap_handler_t sap_handler_t;
 204
 205 /**
 206  * Private LibVLC instance data.
 207  */
 208 typedef struct libvlc_priv_t
 209 {
 210     libvlc_int_t       public_data;
 211
 212     /* Configuration */
 213     vlc_mutex_t        config_lock; ///< config file lock
 214     char *             psz_configfile;   ///< location of config file
 215
 216     int                i_last_input_id ; ///< Last id of input item
 217
 218     /* Messages */
 219     msg_bank_t         msg_bank;    ///< The message bank
 220     int                i_verbose;   ///< info messages
 221     bool               b_color;     ///< color messages?
 222     vlc_dictionary_t   msg_enabled_objects; ///< Enabled objects
 223     bool               msg_all_objects_enabled; ///< Should we print all objects?
 224
 225     /* Timer stats */
 226     vlc_mutex_t        timer_lock;  ///< Lock to protect timers
 227     counter_t        **pp_timers;   ///< Array of all timers
 228     int                i_timers;    ///< Number of timers
 229     bool               b_stats;     ///< Whether to collect stats
 230
 231     void              *p_stats_computer;  ///< Input thread computing stats
 232                                           /// (needs cleanup)
 233
 234     /* Singleton objects */
 235     module_t          *p_memcpy_module;  ///< Fast memcpy plugin used
 236     playlist_t        *p_playlist; //< the playlist singleton
 237     vlm_t             *p_vlm;  ///< the VLM singleton (or NULL)
 238     interaction_t     *p_interaction;    ///< interface interaction object
 239     httpd_t           *p_httpd; ///< HTTP daemon (src/network/httpd.c)
 240 #ifdef ENABLE_SOUT
 241     sap_handler_t     *p_sap; ///< SAP SDP advertiser
 242 #endif
 243 } libvlc_priv_t;
 244
 245 static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc)
 246 {
 247     return (libvlc_priv_t *)libvlc;
 248 }
 249
 250 void playlist_ServicesDiscoveryKillAll( playlist_t *p_playlist );
 251
 252 #define libvlc_stats( o ) (libvlc_priv((VLC_OBJECT(o))->p_libvlc)->b_stats)
 253
 254 /**
 255  * LibVLC "main module" configuration settings array.
 256  */
 257 extern module_config_t libvlc_config[];
 258 extern const size_t libvlc_config_count;
 259
 260 /*
 261  * Variables stuff
 262  */
 263 void var_OptionParse (vlc_object_t *, const char *, bool trusted);
 264
 265 /*
 266  * Replacement functions
 267  */
 268 # ifndef HAVE_DIRENT_H
 269 typedef void DIR;
 270 #  ifndef FILENAME_MAX
 271 #      define FILENAME_MAX (260)
 272 #  endif
 273 struct dirent
 274 {
 275     long            d_ino;          /* Always zero. */
 276     unsigned short  d_reclen;       /* Always zero. */
 277     unsigned short  d_namlen;       /* Length of name in d_name. */
 278     char            d_name[FILENAME_MAX]; /* File name. */
 279 };
 280 #  define opendir vlc_opendir
 281 #  define readdir vlc_readdir
 282 #  define closedir vlc_closedir
 283 #  define rewinddir vlc_rewindir
 284 void *vlc_opendir (const char *);
 285 void *vlc_readdir (void *);
 286 int   vlc_closedir(void *);
 287 void  vlc_rewinddir(void *);
 288 # endif
 289
 290 #if defined (WIN32)
 291 #   include <dirent.h>
 292 void *vlc_wopendir (const wchar_t *);
 293 /* void *vlc_wclosedir (void *); in vlc's exported symbols */
 294 struct _wdirent *vlc_wreaddir (void *);
 295 void vlc_rewinddir (void *);
 296 #   define _wopendir vlc_wopendir
 297 #   define _wreaddir vlc_wreaddir
 298 #   define _wclosedir vlc_wclosedir
 299 #   define rewinddir vlc_rewinddir
 300 #endif
 301
 302 #endif