/*****************************************************************************
* libvlc.h: Internal libvlc generic/misc declaration
*****************************************************************************
- * Copyright (C) 1999, 2000, 2001, 2002 the VideoLAN team
+ * Copyright (C) 1999, 2000, 2001, 2002 VLC authors and VideoLAN
* Copyright © 2006-2007 Rémi Denis-Courmont
* $Id$
*
* Authors: Vincent Seguin <seguin@via.ecp.fr>
*
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
*
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
#ifndef LIBVLC_LIBVLC_H
# define LIBVLC_LIBVLC_H 1
-extern const char vlc_usage[];
+extern const char psz_vlc_changeset[];
-/* Hotkey stuff */
-extern const struct hotkey libvlc_hotkeys[];
-extern const size_t libvlc_hotkeys_size;
-extern int vlc_key_to_action (vlc_object_t *, const char *,
- vlc_value_t, vlc_value_t, void *);
+typedef struct variable_t variable_t;
+
+/* Actions (hot keys) */
+struct vlc_actions;
+struct vlc_actions *vlc_InitActions (libvlc_int_t *);
+extern void vlc_DeinitActions (libvlc_int_t *, struct vlc_actions *);
+
+size_t vlc_towc (const char *str, uint32_t *restrict pwc);
/*
* OS-specific initialization
*/
-void system_Init ( libvlc_int_t *, int *, const char *[] );
-void system_Configure ( libvlc_int_t *, int *, const char *[] );
-void system_End ( libvlc_int_t * );
+void system_Init ( void );
+void system_Configure ( libvlc_int_t *, int, const char *const [] );
+#if defined(_WIN32) || defined(__OS2__)
+void system_End(void);
+#ifndef __OS2__
+size_t EnumClockSource( vlc_object_t *, const char *, char ***, char *** );
+#endif
+#endif
+void vlc_CPU_init(void);
+void vlc_CPU_dump(vlc_object_t *);
/*
* Threads subsystem
*/
-int vlc_threads_init( void );
-void vlc_threads_end( void );
-vlc_object_t *vlc_threadobj (void);
-#ifdef LIBVLC_REFCHECK
-void vlc_refcheck (vlc_object_t *obj);
-#else
-# define vlc_refcheck( obj ) (void)0
-#endif
-/*
- * CPU capabilities
- */
-extern uint32_t cpu_flags;
-uint32_t CPUCapabilities( void );
+/* This cannot be used as is from plugins yet: */
+int vlc_clone_detach (vlc_thread_t *, void *(*)(void *), void *, int);
-/*
- * Message/logging stuff
- */
+int vlc_object_waitpipe (vlc_object_t *obj);
+void ObjectKillChildrens (vlc_object_t *);
-typedef struct msg_queue_t
-{
- /** Message queue lock */
- vlc_mutex_t lock;
- bool b_overflow;
-
- /* Message queue */
- msg_item_t msg[VLC_MSG_QSIZE]; /**< message queue */
- int i_start;
- int i_stop;
-
- /* Subscribers */
- int i_sub;
- msg_subscription_t **pp_sub;
-
- /* Logfile for WinCE */
-#ifdef UNDER_CE
- FILE *logfile;
+int vlc_set_priority( vlc_thread_t, int );
+
+void vlc_threads_setup (libvlc_int_t *);
+
+void vlc_trace (const char *fn, const char *file, unsigned line);
+#define vlc_backtrace() vlc_trace(__func__, __FILE__, __LINE__)
+
+#if (defined (LIBVLC_USE_PTHREAD) || defined(__ANDROID__)) && !defined (NDEBUG)
+void vlc_assert_locked (vlc_mutex_t *);
+#else
+# define vlc_assert_locked( m ) (void)m
#endif
-} msg_queue_t;
-/**
- * Store all data required by messages interfaces.
+/*
+ * Logging
*/
-typedef struct msg_bank_t
-{
- vlc_mutex_t lock;
- msg_queue_t queue;
-} msg_bank_t;
+typedef struct vlc_logger_t vlc_logger_t;
-void msg_Create (libvlc_int_t *);
-void msg_Flush (libvlc_int_t *);
-void msg_Destroy (libvlc_int_t *);
-
-/** Internal message stack context */
-typedef struct
-{
- int i_code;
- char * psz_message;
-} msg_context_t;
-
-void msg_StackSet ( int, const char*, ... );
-void msg_StackAdd ( const char*, ... );
-const char* msg_StackMsg ( void );
-/** The global thread var for msg stack context
- * We store this as a static global variable so we don't need a vlc_object_t
- * everywhere.
- * This key is created in vlc_threads_init and is therefore ready to use at
- * the very beginning of the universe */
-extern vlc_threadvar_t msg_context_global_key;
-void msg_StackDestroy (void *);
+int vlc_LogPreinit(libvlc_int_t *);
+int vlc_LogInit(libvlc_int_t *);
+void vlc_LogDeinit(libvlc_int_t *);
/*
- * Unicode stuff
+ * LibVLC exit event handling
*/
-char *vlc_fix_readdir (const char *);
+typedef struct vlc_exit
+{
+ vlc_mutex_t lock;
+ void (*handler) (void *);
+ void *opaque;
+} vlc_exit_t;
+
+void vlc_ExitInit( vlc_exit_t * );
+void vlc_ExitDestroy( vlc_exit_t * );
/*
* LibVLC objects stuff
*
* @param p_this an existing VLC object
* @param i_size byte size of the object structure
- * @param i_type object type, usually VLC_OBJECT_CUSTOM
* @param psz_type object type name
* @return the created object, or NULL.
*/
extern void *
-__vlc_custom_create (vlc_object_t *p_this, size_t i_size, int i_type,
- const char *psz_type);
-#define vlc_custom_create(o, s, t, n) \
- __vlc_custom_create(VLC_OBJECT(o), s, t, n)
+vlc_custom_create (vlc_object_t *p_this, size_t i_size, const char *psz_type);
+#define vlc_custom_create(o, s, n) \
+ vlc_custom_create(VLC_OBJECT(o), s, n)
/**
- * libvlc_global_data_t (global variable)
- *
- * This structure has an unique instance, statically allocated in libvlc and
- * never accessed from the outside. It stores process-wide VLC variables,
- * mostly process-wide locks, and (currently) the module bank and objects tree.
+ * Assign a name to an object for vlc_object_find_name().
*/
-typedef struct libvlc_global_data_t
-{
- VLC_COMMON_MEMBERS
-
- /* Object structure data */
- int i_counter; ///< object counter
-
- module_bank_t * p_module_bank; ///< The module bank
+extern int vlc_object_set_name(vlc_object_t *, const char *);
+#define vlc_object_set_name(o, n) vlc_object_set_name(VLC_OBJECT(o), n)
- char * psz_vlcpath;
-} libvlc_global_data_t;
+/* Types */
+typedef void (*vlc_destructor_t) (struct vlc_object_t *);
+void vlc_object_set_destructor (vlc_object_t *, vlc_destructor_t);
+#define vlc_object_set_destructor(a,b) \
+ vlc_object_set_destructor (VLC_OBJECT(a), b)
-
-libvlc_global_data_t *vlc_global (void);
-
-/**
- * Private LibVLC data for each object.
+/*
+ * To be cleaned-up module stuff:
*/
-struct vlc_object_internals_t
-{
- /* Object variables */
- variable_t * p_vars;
- vlc_mutex_t var_lock;
- int i_vars;
-
- /* Thread properties, if any */
- vlc_thread_t thread_id;
- bool b_thread;
-
- /* Objects thread synchronization */
- vlc_mutex_t lock;
- vlc_cond_t wait;
- int pipes[2];
- vlc_spinlock_t spin;
-
- /* Objects management */
- vlc_spinlock_t ref_spin;
- unsigned i_refcount;
- vlc_destructor_t pf_destructor;
-#ifndef LIBVLC_REFCHECK
- vlc_thread_t creator_id;
-#endif
-
- /* Objects tree structure */
- vlc_object_t *prev, *next;
- vlc_object_t **pp_children;
- int i_children;
-};
+module_t *module_find_by_shortcut (const char *psz_shortcut);
#define ZOOM_SECTION N_("Zoom")
#define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter")
#define ZOOM_ORIGINAL_KEY_TEXT N_("1:1 Original")
#define ZOOM_DOUBLE_KEY_TEXT N_("2:1 Double")
-#define vlc_internals( obj ) (((vlc_object_internals_t*)(VLC_OBJECT(obj)))-1)
-
-/* Signal an object without checking for locking consistency. This is wrong. */
-#ifdef __GNUC__
-__attribute__((deprecated))
-#endif
-static inline void
-vlc_object_signal_maybe (vlc_object_t *p_this)
-{
- vlc_cond_signal (&(vlc_internals(p_this)->wait));
-}
-
/**
* Private LibVLC instance data.
*/
typedef struct libvlc_priv_t
{
- /* Configuration */
- vlc_mutex_t config_lock; ///< config file lock
- char * psz_configfile; ///< location of config file
-
- /* There is no real reason to keep a list of items, but not to break
- * everything, let's keep it */
- input_item_array_t input_items; ///< Array of all created input items
- int i_last_input_id ; ///< Last id of input item
-
- /* Messages */
- msg_bank_t msg_bank; ///< The message bank
- int i_verbose; ///< info messages
- bool b_color; ///< color messages?
-
- /* Timer stats */
- vlc_mutex_t timer_lock; ///< Lock to protect timers
- counter_t **pp_timers; ///< Array of all timers
- int i_timers; ///< Number of timers
- bool b_stats; ///< Whether to collect stats
+ libvlc_int_t public_data;
- void *p_stats_computer; ///< Input thread computing stats
- /// (needs cleanup)
+ /* Logging */
+ bool b_stats; ///< Whether to collect stats
/* Singleton objects */
- module_t *p_memcpy_module; ///< Fast memcpy plugin used
- playlist_t *p_playlist; //< the playlist singleton
+ vlc_logger_t *logger;
vlm_t *p_vlm; ///< the VLM singleton (or NULL)
- interaction_t *p_interaction; ///< interface interaction object
- httpd_t *p_httpd; ///< HTTP daemon (src/network/httpd.c)
-
- /* Private playlist data (FIXME - playlist_t is too public...) */
- sout_instance_t *p_sout; ///< kept sout instance (for playlist)
+ vlc_object_t *p_dialog_provider; ///< dialog provider
+ struct playlist_t *playlist; ///< Playlist for interfaces
+ struct playlist_preparser_t *parser; ///< Input item meta data handler
+ struct vlc_actions *actions; ///< Hotkeys handler
- /* Thread support */
- unsigned threads_count;
- vlc_mutex_t threads_lock;
- vlc_cond_t threads_wait;
+ /* Objects tree */
+ vlc_mutex_t structure_lock;
-#ifdef WIN32
- vlc_object_t *ipc_helper;
-#endif
+ /* Exit callback */
+ vlc_exit_t exit;
} libvlc_priv_t;
static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc)
{
- return (libvlc_priv_t *)(libvlc + 1);
+ return (libvlc_priv_t *)libvlc;
}
-void playlist_ServicesDiscoveryKillAll( playlist_t *p_playlist );
+void intf_InsertItem(libvlc_int_t *, const char *mrl, unsigned optc,
+ const char * const *optv, unsigned flags);
+void intf_DestroyAll( libvlc_int_t * );
#define libvlc_stats( o ) (libvlc_priv((VLC_OBJECT(o))->p_libvlc)->b_stats)
-/**
- * LibVLC "main module" configuration settings array.
- */
-extern module_config_t libvlc_config[];
-extern const size_t libvlc_config_count;
-
/*
* Variables stuff
*/
void var_OptionParse (vlc_object_t *, const char *, bool trusted);
/*
- * Replacement functions
+ * Stats stuff
*/
-# ifndef HAVE_DIRENT_H
-typedef void DIR;
-# ifndef FILENAME_MAX
-# define FILENAME_MAX (260)
-# endif
-struct dirent
+enum
{
- long d_ino; /* Always zero. */
- unsigned short d_reclen; /* Always zero. */
- unsigned short d_namlen; /* Length of name in d_name. */
- char d_name[FILENAME_MAX]; /* File name. */
+ STATS_COUNTER,
+ STATS_DERIVATIVE,
};
-# define opendir vlc_opendir
-# define readdir vlc_readdir
-# define closedir vlc_closedir
-# define rewinddir vlc_rewindir
-void *vlc_opendir (const char *);
-void *vlc_readdir (void *);
-int vlc_closedir(void *);
-void vlc_rewinddir(void *);
-# endif
-
-#if defined (WIN32)
-# include <dirent.h>
-void *vlc_wopendir (const wchar_t *);
-/* void *vlc_wclosedir (void *); in vlc's exported symbols */
-struct _wdirent *vlc_wreaddir (void *);
-void vlc_rewinddir (void *);
-# define _wopendir vlc_wopendir
-# define _wreaddir vlc_wreaddir
-# define _wclosedir vlc_wclosedir
-# define rewinddir vlc_rewinddir
-#endif
+
+typedef struct counter_sample_t
+{
+ uint64_t value;
+ mtime_t date;
+} counter_sample_t;
+
+typedef struct counter_t
+{
+ int i_compute_type;
+ int i_samples;
+ counter_sample_t ** pp_samples;
+
+ mtime_t last_update;
+} counter_t;
+
+enum
+{
+ STATS_INPUT_BITRATE,
+ STATS_READ_BYTES,
+ STATS_READ_PACKETS,
+ STATS_DEMUX_READ,
+ STATS_DEMUX_BITRATE,
+ STATS_DEMUX_CORRUPTED,
+ STATS_DEMUX_DISCONTINUITY,
+ STATS_PLAYED_ABUFFERS,
+ STATS_LOST_ABUFFERS,
+ STATS_DECODED_AUDIO,
+ STATS_DECODED_VIDEO,
+ STATS_DECODED_SUB,
+ STATS_CLIENT_CONNECTIONS,
+ STATS_ACTIVE_CONNECTIONS,
+ STATS_SOUT_SENT_PACKETS,
+ STATS_SOUT_SENT_BYTES,
+ STATS_SOUT_SEND_BITRATE,
+ STATS_DISPLAYED_PICTURES,
+ STATS_LOST_PICTURES,
+};
+
+counter_t * stats_CounterCreate (int);
+void stats_Update (counter_t *, uint64_t, uint64_t *);
+void stats_CounterClean (counter_t * );
+
+void stats_ComputeInputStats(input_thread_t*, input_stats_t*);
+void stats_ReinitInputStats(input_stats_t *);
#endif
projects / vlc / blobdiff