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
  49 /* Hopefully, no need to export this. There is a new thread API instead. */
  50 void vlc_thread_cancel (vlc_object_t *);
  51 int vlc_object_waitpipe (vlc_object_t *obj);
  52
  53 void vlc_trace (const char *fn, const char *file, unsigned line);
  54 #define vlc_backtrace() vlc_trace(__func__, __FILE__, __LINE__)
  55
  56 #if defined (LIBVLC_USE_PTHREAD) && !defined (NDEBUG)
  57 # define vlc_assert_locked( m ) \
  58          assert (pthread_mutex_lock (m) == EDEADLK)
  59 #else
  60 # define vlc_assert_locked( m ) (void)m
  61 #endif
  62
  63 /*
  64  * CPU capabilities
  65  */
  66 extern uint32_t cpu_flags;
  67 uint32_t CPUCapabilities( void );
  68
  69 /*
  70  * Message/logging stuff
  71  */
  72
  73 /**
  74  * Store all data required by messages interfaces.
  75  */
  76 typedef struct msg_bank_t
  77 {
  78     /** Message queue lock */
  79     vlc_mutex_t lock;
  80     vlc_cond_t  wait;
  81
  82     /* Subscribers */
  83     int i_sub;
  84     msg_subscription_t **pp_sub;
  85
  86     /* Logfile for WinCE */
  87 #ifdef UNDER_CE
  88     FILE *logfile;
  89 #endif
  90 } msg_bank_t;
  91
  92 void msg_Create  (libvlc_int_t *);
  93 void msg_Destroy (libvlc_int_t *);
  94
  95 /** Internal message stack context */
  96 void msg_StackSet ( int, const char*, ... );
  97 void msg_StackAdd ( const char*, ... );
  98 const char* msg_StackMsg ( void );
  99 void msg_StackDestroy (void *);
 100
 101 /*
 102  * Unicode stuff
 103  */
 104 char *vlc_fix_readdir (const char *);
 105
 106 /*
 107  * LibVLC objects stuff
 108  */
 109
 110 /**
 111  * Creates a VLC object.
 112  *
 113  * Note that because the object name pointer must remain valid, potentially
 114  * even after the destruction of the object (through the message queues), this
 115  * function CANNOT be exported to plugins as is. In this case, the old
 116  * vlc_object_create() must be used instead.
 117  *
 118  * @param p_this an existing VLC object
 119  * @param i_size byte size of the object structure
 120  * @param i_type object type, usually VLC_OBJECT_CUSTOM
 121  * @param psz_type object type name
 122  * @return the created object, or NULL.
 123  */
 124 extern void *
 125 __vlc_custom_create (vlc_object_t *p_this, size_t i_size, int i_type,
 126                      const char *psz_type);
 127 #define vlc_custom_create(o, s, t, n) \
 128         __vlc_custom_create(VLC_OBJECT(o), s, t, n)
 129
 130 /*
 131  * To be cleaned-up module stuff:
 132  */
 133 extern char *psz_vlcpath;
 134
 135 /* Return a NULL terminated array with the names of the modules that have a
 136  * certain capability.
 137  * Free after uses both the string and the table. */
 138 VLC_EXPORT(char **, module_GetModulesNamesForCapability,
 139                     ( const char * psz_capability, char ***psz_longname ) );
 140
 141 #ifdef LIBVLC_USE_PTHREAD
 142 # include <semaphore.h> /* TODO: get rid of vlc_thread_ready and this */
 143 #endif
 144
 145 /**
 146  * Private LibVLC data for each object.
 147  */
 148 typedef struct vlc_object_internals_t
 149 {
 150     /* Object variables */
 151     variable_t *    p_vars;
 152     vlc_mutex_t     var_lock;
 153     int             i_vars;
 154
 155     /* Thread properties, if any */
 156     vlc_thread_t    thread_id;
 157     bool            b_thread;
 158 #ifdef LIBVLC_USE_PTHREAD
 159     sem_t           thread_ready;
 160 #elif defined (WIN32)
 161     HANDLE          thread_ready;
 162 #endif
 163
 164     /* Objects thread synchronization */
 165     vlc_mutex_t     lock;
 166     vlc_cond_t      wait;
 167     int             pipes[2];
 168     vlc_spinlock_t  spin;
 169
 170     /* Objects management */
 171     vlc_spinlock_t   ref_spin;
 172     unsigned         i_refcount;
 173     vlc_destructor_t pf_destructor;
 174
 175     /* Objects tree structure */
 176     vlc_object_t    *prev, *next;
 177     vlc_object_t   **pp_children;
 178     int              i_children;
 179 } vlc_object_internals_t;
 180
 181 #define ZOOM_SECTION N_("Zoom")
 182 #define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
 183 #define ZOOM_HALF_KEY_TEXT N_("1:2 Half")
 184 #define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
 185 #define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
 186
 187 #define vlc_internals( obj ) (((vlc_object_internals_t*)(VLC_OBJECT(obj)))-1)
 188
 189 typedef struct sap_handler_t sap_handler_t;
 190
 191 /**
 192  * Private LibVLC instance data.
 193  */
 194 typedef struct libvlc_priv_t
 195 {
 196     libvlc_int_t       public_data;
 197
 198     /* Configuration */
 199     vlc_mutex_t        config_lock; ///< config file lock
 200     char *             psz_configfile;   ///< location of config file
 201
 202     int                i_last_input_id ; ///< Last id of input item
 203
 204     /* Messages */
 205     msg_bank_t         msg_bank;    ///< The message bank
 206     int                i_verbose;   ///< info messages
 207     bool               b_color;     ///< color messages?
 208     vlc_dictionary_t   msg_enabled_objects; ///< Enabled objects
 209     bool               msg_all_objects_enabled; ///< Should we print all objects?
 210
 211     /* Timer stats */
 212     vlc_mutex_t        timer_lock;  ///< Lock to protect timers
 213     counter_t        **pp_timers;   ///< Array of all timers
 214     int                i_timers;    ///< Number of timers
 215     bool               b_stats;     ///< Whether to collect stats
 216
 217     void              *p_stats_computer;  ///< Input thread computing stats
 218                                           /// (needs cleanup)
 219
 220     /* Singleton objects */
 221     module_t          *p_memcpy_module;  ///< Fast memcpy plugin used
 222     playlist_t        *p_playlist; //< the playlist singleton
 223     vlm_t             *p_vlm;  ///< the VLM singleton (or NULL)
 224     interaction_t     *p_interaction;    ///< interface interaction object
 225     httpd_t           *p_httpd; ///< HTTP daemon (src/network/httpd.c)
 226 #ifdef ENABLE_SOUT
 227     sap_handler_t     *p_sap; ///< SAP SDP advertiser
 228 #endif
 229     vlc_mutex_t        structure_lock;
 230 } libvlc_priv_t;
 231
 232 static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc)
 233 {
 234     return (libvlc_priv_t *)libvlc;
 235 }
 236
 237 void playlist_ServicesDiscoveryKillAll( playlist_t *p_playlist );
 238
 239 #define libvlc_stats( o ) (libvlc_priv((VLC_OBJECT(o))->p_libvlc)->b_stats)
 240
 241 /**
 242  * LibVLC "main module" configuration settings array.
 243  */
 244 extern module_config_t libvlc_config[];
 245 extern const size_t libvlc_config_count;
 246
 247 /*
 248  * Variables stuff
 249  */
 250 void var_OptionParse (vlc_object_t *, const char *, bool trusted);
 251
 252 /*
 253  * Replacement functions
 254  */
 255 # ifndef HAVE_DIRENT_H
 256 typedef void DIR;
 257 #  ifndef FILENAME_MAX
 258 #      define FILENAME_MAX (260)
 259 #  endif
 260 struct dirent
 261 {
 262     long            d_ino;          /* Always zero. */
 263     unsigned short  d_reclen;       /* Always zero. */
 264     unsigned short  d_namlen;       /* Length of name in d_name. */
 265     char            d_name[FILENAME_MAX]; /* File name. */
 266 };
 267 #  define opendir vlc_opendir
 268 #  define readdir vlc_readdir
 269 #  define closedir vlc_closedir
 270 #  define rewinddir vlc_rewindir
 271 void *vlc_opendir (const char *);
 272 void *vlc_readdir (void *);
 273 int   vlc_closedir(void *);
 274 void  vlc_rewinddir(void *);
 275 # endif
 276
 277 #if defined (WIN32)
 278 #   include <dirent.h>
 279 void *vlc_wopendir (const wchar_t *);
 280 /* void *vlc_wclosedir (void *); in vlc's exported symbols */
 281 struct _wdirent *vlc_wreaddir (void *);
 282 void vlc_rewinddir (void *);
 283 #   define _wopendir vlc_wopendir
 284 #   define _wreaddir vlc_wreaddir
 285 #   define _wclosedir vlc_wclosedir
 286 #   define rewinddir vlc_rewinddir
 287 #endif
 288
 289 #endif