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 VLC authors and VideoLAN
   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 it
  11  * under the terms of the GNU Lesser General Public License as published by
  12  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public License
  21  * along with this program; if not, write to the Free Software Foundation,
  22  * 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 extern const char psz_vlc_changeset[];
  29
  30 typedef struct variable_t variable_t;
  31
  32 /* Actions (hot keys) */
  33 struct vlc_actions;
  34 struct vlc_actions *vlc_InitActions (libvlc_int_t *);
  35 extern void vlc_DeinitActions (libvlc_int_t *, struct vlc_actions *);
  36
  37 size_t vlc_towc (const char *str, uint32_t *restrict pwc);
  38
  39 /*
  40  * OS-specific initialization
  41  */
  42 void system_Init      ( void );
  43 void system_Configure ( libvlc_int_t *, int, const char *const [] );
  44 #ifdef WIN32
  45 void system_End(void);
  46 void SelectClockSource( vlc_object_t * );
  47 size_t EnumClockSource( vlc_object_t *, char ***, char *** );
  48 #endif
  49 void vlc_CPU_init(void);
  50 void vlc_CPU_dump(vlc_object_t *);
  51
  52 /*
  53  * Threads subsystem
  54  */
  55
  56 /* This cannot be used as is from plugins yet: */
  57 int vlc_clone_detach (vlc_thread_t *, void *(*)(void *), void *, int);
  58
  59 int vlc_object_waitpipe (vlc_object_t *obj);
  60 void vlc_object_kill (vlc_object_t *) VLC_DEPRECATED;
  61 #define vlc_object_kill(o) vlc_object_kill(VLC_OBJECT(o))
  62
  63 int vlc_set_priority( vlc_thread_t, int );
  64
  65 void vlc_threads_setup (libvlc_int_t *);
  66
  67 void vlc_trace (const char *fn, const char *file, unsigned line);
  68 #define vlc_backtrace() vlc_trace(__func__, __FILE__, __LINE__)
  69
  70 #if defined (LIBVLC_USE_PTHREAD) && !defined (NDEBUG)
  71 void vlc_assert_locked (vlc_mutex_t *);
  72 #else
  73 # define vlc_assert_locked( m ) (void)m
  74 #endif
  75
  76 /*
  77  * LibVLC exit event handling
  78  */
  79 typedef struct vlc_exit
  80 {
  81     vlc_mutex_t lock;
  82     void (*handler) (void *);
  83     void *opaque;
  84 } vlc_exit_t;
  85
  86 void vlc_ExitInit( vlc_exit_t * );
  87 void vlc_ExitDestroy( vlc_exit_t * );
  88
  89 /*
  90  * LibVLC objects stuff
  91  */
  92
  93 /**
  94  * Creates a VLC object.
  95  *
  96  * Note that because the object name pointer must remain valid, potentially
  97  * even after the destruction of the object (through the message queues), this
  98  * function CANNOT be exported to plugins as is. In this case, the old
  99  * vlc_object_create() must be used instead.
 100  *
 101  * @param p_this an existing VLC object
 102  * @param i_size byte size of the object structure
 103  * @param psz_type object type name
 104  * @return the created object, or NULL.
 105  */
 106 extern void *
 107 vlc_custom_create (vlc_object_t *p_this, size_t i_size, const char *psz_type);
 108 #define vlc_custom_create(o, s, n) \
 109         vlc_custom_create(VLC_OBJECT(o), s, n)
 110
 111 /**
 112  * Assign a name to an object for vlc_object_find_name().
 113  */
 114 extern int vlc_object_set_name(vlc_object_t *, const char *);
 115 #define vlc_object_set_name(o, n) vlc_object_set_name(VLC_OBJECT(o), n)
 116
 117 /* Types */
 118 typedef void (*vlc_destructor_t) (struct vlc_object_t *);
 119 void vlc_object_set_destructor (vlc_object_t *, vlc_destructor_t);
 120 #define vlc_object_set_destructor(a,b) \
 121         vlc_object_set_destructor (VLC_OBJECT(a), b)
 122
 123 /*
 124  * To be cleaned-up module stuff:
 125  */
 126 module_t *module_find_by_shortcut (const char *psz_shortcut);
 127
 128 /**
 129  * Private LibVLC data for each object.
 130  */
 131 typedef struct vlc_object_internals vlc_object_internals_t;
 132
 133 struct vlc_object_internals
 134 {
 135     char           *psz_name; /* given name */
 136
 137     /* Object variables */
 138     void           *var_root;
 139     vlc_mutex_t     var_lock;
 140     vlc_cond_t      var_wait;
 141
 142     /* Objects thread synchronization */
 143     int             pipes[2];
 144
 145     /* Objects management */
 146     vlc_spinlock_t   ref_spin;
 147     unsigned         i_refcount;
 148     vlc_destructor_t pf_destructor;
 149
 150     /* Objects tree structure */
 151     vlc_object_internals_t *next;  /* next sibling */
 152     vlc_object_internals_t *prev;  /* previous sibling */
 153     vlc_object_internals_t *first; /* first child */
 154 };
 155
 156 #define ZOOM_SECTION N_("Zoom")
 157 #define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
 158 #define ZOOM_HALF_KEY_TEXT N_("1:2 Half")
 159 #define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
 160 #define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
 161
 162 #define vlc_internals( obj ) (((vlc_object_internals_t*)(VLC_OBJECT(obj)))-1)
 163 #define vlc_externals( priv ) ((vlc_object_t *)((priv) + 1))
 164
 165 typedef struct sap_handler_t sap_handler_t;
 166
 167 /**
 168  * Private LibVLC instance data.
 169  */
 170 typedef struct libvlc_priv_t
 171 {
 172     libvlc_int_t       public_data;
 173
 174     bool               playlist_active;
 175
 176     /* Messages */
 177     signed char        i_verbose;   ///< info messages
 178     bool               b_color;     ///< color messages?
 179     bool               b_stats;     ///< Whether to collect stats
 180
 181     /* Singleton objects */
 182     playlist_t        *p_playlist; ///< the playlist singleton
 183     struct media_library_t *p_ml;    ///< the ML singleton
 184     vlc_mutex_t       ml_lock; ///< Mutex for ML creation
 185     vlm_t             *p_vlm;  ///< the VLM singleton (or NULL)
 186     vlc_object_t      *p_dialog_provider; ///< dialog provider
 187 #ifdef ENABLE_SOUT
 188     sap_handler_t     *p_sap; ///< SAP SDP advertiser
 189 #endif
 190     struct vlc_actions *actions; ///< Hotkeys handler
 191
 192     /* Interfaces */
 193     struct intf_thread_t *p_intf; ///< Interfaces linked-list
 194
 195     /* Objects tree */
 196     vlc_mutex_t        structure_lock;
 197
 198     /* Exit callback */
 199     vlc_exit_t       exit;
 200 } libvlc_priv_t;
 201
 202 static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc)
 203 {
 204     return (libvlc_priv_t *)libvlc;
 205 }
 206
 207 void playlist_ServicesDiscoveryKillAll( playlist_t *p_playlist );
 208 void intf_DestroyAll( libvlc_int_t * );
 209
 210 #define libvlc_stats( o ) (libvlc_priv((VLC_OBJECT(o))->p_libvlc)->b_stats)
 211
 212 /*
 213  * Variables stuff
 214  */
 215 void var_OptionParse (vlc_object_t *, const char *, bool trusted);
 216
 217 /*
 218  * Stats stuff
 219  */
 220 enum
 221 {
 222     STATS_COUNTER,
 223     STATS_DERIVATIVE,
 224 };
 225
 226 typedef struct counter_sample_t
 227 {
 228     uint64_t value;
 229     mtime_t  date;
 230 } counter_sample_t;
 231
 232 typedef struct counter_t
 233 {
 234     int                 i_compute_type;
 235     int                 i_samples;
 236     counter_sample_t ** pp_samples;
 237
 238     mtime_t             last_update;
 239 } counter_t;
 240
 241 enum
 242 {
 243     STATS_INPUT_BITRATE,
 244     STATS_READ_BYTES,
 245     STATS_READ_PACKETS,
 246     STATS_DEMUX_READ,
 247     STATS_DEMUX_BITRATE,
 248     STATS_DEMUX_CORRUPTED,
 249     STATS_DEMUX_DISCONTINUITY,
 250     STATS_PLAYED_ABUFFERS,
 251     STATS_LOST_ABUFFERS,
 252     STATS_DECODED_AUDIO,
 253     STATS_DECODED_VIDEO,
 254     STATS_DECODED_SUB,
 255     STATS_CLIENT_CONNECTIONS,
 256     STATS_ACTIVE_CONNECTIONS,
 257     STATS_SOUT_SENT_PACKETS,
 258     STATS_SOUT_SENT_BYTES,
 259     STATS_SOUT_SEND_BITRATE,
 260     STATS_DISPLAYED_PICTURES,
 261     STATS_LOST_PICTURES,
 262 };
 263
 264 counter_t * stats_CounterCreate (int);
 265 void stats_Update (counter_t *, uint64_t, uint64_t *);
 266 void stats_CounterClean (counter_t * );
 267
 268 void stats_ComputeInputStats(input_thread_t*, input_stats_t*);
 269 void stats_ReinitInputStats(input_stats_t *);
 270
 271 #endif