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 /*
  58  * CPU capabilities
  59  */
  60 extern uint32_t cpu_flags;
  61 uint32_t CPUCapabilities( void );
  62
  63 /*
  64  * Message/logging stuff
  65  */
  66
  67 typedef struct msg_queue_t
  68 {
  69     /** Message queue lock */
  70     vlc_mutex_t             lock;
  71     bool              b_overflow;
  72
  73     /* Message queue */
  74     msg_item_t              msg[VLC_MSG_QSIZE];           /**< message queue */
  75     int i_start;
  76     int i_stop;
  77
  78     /* Subscribers */
  79     int i_sub;
  80     msg_subscription_t **pp_sub;
  81
  82     /* Logfile for WinCE */
  83 #ifdef UNDER_CE
  84     FILE *logfile;
  85 #endif
  86 } msg_queue_t;
  87
  88 /**
  89  * Store all data required by messages interfaces.
  90  */
  91 typedef struct msg_bank_t
  92 {
  93     vlc_mutex_t             lock;
  94     msg_queue_t             queue;
  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  * libvlc_global_data_t (global variable)
 138  *
 139  * This structure has an unique instance, statically allocated in libvlc and
 140  * never accessed from the outside. It stores process-wide VLC variables,
 141  * mostly process-wide locks, and (currently) the module bank and objects tree.
 142  */
 143 typedef struct libvlc_global_data_t
 144 {
 145     VLC_COMMON_MEMBERS
 146
 147     char *                 psz_vlcpath;
 148 } libvlc_global_data_t;
 149
 150 /**
 151  * The module bank
 152  */
 153 extern module_bank_t *p_module_bank;
 154
 155 libvlc_global_data_t *vlc_global (void);
 156
 157 /**
 158  * Private LibVLC data for each object.
 159  */
 160 typedef struct vlc_object_internals_t
 161 {
 162     /* Object variables */
 163     variable_t *    p_vars;
 164     vlc_mutex_t     var_lock;
 165     int             i_vars;
 166
 167     /* Thread properties, if any */
 168     vlc_thread_t    thread_id;
 169     bool            b_thread;
 170
 171     /* Objects thread synchronization */
 172     vlc_mutex_t     lock;
 173     vlc_cond_t      wait;
 174     int             pipes[2];
 175     vlc_spinlock_t  spin;
 176
 177     /* Objects management */
 178     vlc_spinlock_t   ref_spin;
 179     unsigned         i_refcount;
 180     vlc_destructor_t pf_destructor;
 181
 182     /* Objects tree structure */
 183     vlc_object_t    *prev, *next;
 184     vlc_object_t   **pp_children;
 185     int              i_children;
 186 } vlc_object_internals_t;
 187
 188 #define ZOOM_SECTION N_("Zoom")
 189 #define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
 190 #define ZOOM_HALF_KEY_TEXT N_("1:2 Half")
 191 #define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
 192 #define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
 193
 194 #define vlc_internals( obj ) (((vlc_object_internals_t*)(VLC_OBJECT(obj)))-1)
 195
 196 typedef struct sap_handler_t sap_handler_t;
 197
 198 /**
 199  * Private LibVLC instance data.
 200  */
 201 typedef struct libvlc_priv_t
 202 {
 203     libvlc_int_t       public_data;
 204
 205     /* Configuration */
 206     vlc_mutex_t        config_lock; ///< config file lock
 207     char *             psz_configfile;   ///< location of config file
 208
 209     int                i_last_input_id ; ///< Last id of input item
 210
 211     /* Messages */
 212     msg_bank_t         msg_bank;    ///< The message bank
 213     int                i_verbose;   ///< info messages
 214     bool               b_color;     ///< color messages?
 215     vlc_dictionary_t   msg_enabled_objects; ///< Enabled objects
 216     bool               msg_all_objects_enabled; ///< Should we print all objects?
 217
 218     /* Timer stats */
 219     vlc_mutex_t        timer_lock;  ///< Lock to protect timers
 220     counter_t        **pp_timers;   ///< Array of all timers
 221     int                i_timers;    ///< Number of timers
 222     bool               b_stats;     ///< Whether to collect stats
 223
 224     void              *p_stats_computer;  ///< Input thread computing stats
 225                                           /// (needs cleanup)
 226
 227     /* Singleton objects */
 228     module_t          *p_memcpy_module;  ///< Fast memcpy plugin used
 229     playlist_t        *p_playlist; //< the playlist singleton
 230     vlm_t             *p_vlm;  ///< the VLM singleton (or NULL)
 231     interaction_t     *p_interaction;    ///< interface interaction object
 232     httpd_t           *p_httpd; ///< HTTP daemon (src/network/httpd.c)
 233 #ifdef ENABLE_SOUT
 234     sap_handler_t     *p_sap; ///< SAP SDP advertiser
 235 #endif
 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