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