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