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