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