X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=src%2Flibvlc.h;h=65f0d6d985cd0660b34c6eaf1e18356b9af77d3f;hb=528905b0140e349915ca5ab8215bc537f2e1d455;hp=97e4adefa9bbbd098411fb15ba4e9db65d800c25;hpb=9d5e75a7a5643a2144dc561fc246a7a3ca7e5fb0;p=vlc diff --git a/src/libvlc.h b/src/libvlc.h index 97e4adefa9..65f0d6d985 100644 --- a/src/libvlc.h +++ b/src/libvlc.h @@ -1,118 +1,96 @@ /***************************************************************************** * 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 * - * 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 -typedef struct variable_t variable_t; +extern const char psz_vlc_changeset[]; -extern const char vlc_usage[]; +typedef struct variable_t variable_t; /* Actions (hot keys) */ -typedef struct action -{ - char name[24]; - int value; -} action_t; -extern const struct action libvlc_actions[]; -extern const size_t libvlc_actions_count; -extern int vlc_key_to_action (vlc_object_t *, const char *, - vlc_value_t, vlc_value_t, void *); +struct vlc_actions; +struct vlc_actions *vlc_InitActions (libvlc_int_t *); +extern void vlc_DeinitActions (libvlc_int_t *, struct vlc_actions *); -/* - * 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 * ); +size_t vlc_towc (const char *str, uint32_t *restrict pwc); /* - * Legacy object stuff that is still used within libvlccore (only) + * OS-specific initialization */ -#define vlc_object_signal_unlocked( obj ) - -vlc_list_t *vlc_list_find( vlc_object_t *, int, int ); +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 */ -/* Hopefully, no need to export this. There is a new thread API instead. */ -void vlc_thread_cancel (vlc_object_t *); +/* This cannot be used as is from plugins yet: */ +int vlc_clone_detach (vlc_thread_t *, void *(*)(void *), void *, int); + int vlc_object_waitpipe (vlc_object_t *obj); +void ObjectKillChildrens (vlc_object_t *); + +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 (NDEBUG) +#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 /* - * CPU capabilities + * Logging */ -extern uint32_t cpu_flags; -uint32_t CPUCapabilities( void ); +void vlc_LogInit(libvlc_int_t *); +void vlc_LogDeinit(libvlc_int_t *); /* - * Message/logging stuff - */ - -/** - * Store all data required by messages interfaces. + * LibVLC exit event handling */ -typedef struct msg_bank_t +typedef struct vlc_exit { - /** Message queue lock */ vlc_mutex_t lock; - vlc_cond_t wait; + void (*handler) (void *); + void *opaque; +} vlc_exit_t; - /* Subscribers */ - int i_sub; - msg_subscription_t **pp_sub; - - /* Logfile for WinCE */ -#ifdef UNDER_CE - FILE *logfile; -#endif -} msg_bank_t; - -void msg_Create (libvlc_int_t *); -void msg_Destroy (libvlc_int_t *); - -/** Internal message stack context */ -void msg_StackSet ( int, const char*, ... ); -void msg_StackAdd ( const char*, ... ); -const char* msg_StackMsg ( void ); -void msg_StackDestroy (void *); - -/* - * Unicode stuff - */ -char *vlc_fix_readdir (const char *); +void vlc_ExitInit( vlc_exit_t * ); +void vlc_ExitDestroy( vlc_exit_t * ); /* * LibVLC objects stuff @@ -128,58 +106,30 @@ char *vlc_fix_readdir (const char *); * * @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) - -/* - * To be cleaned-up module stuff: - */ -extern char *psz_vlcpath; - -/* Return a NULL terminated array with the names of the modules that have a - * certain capability. - * Free after uses both the string and the table. */ -char **module_GetModulesNamesForCapability (const char * psz_capability, - char ***psz_longname); -module_t *module_find_by_shortcut (const char *psz_shortcut); +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) /** - * Private LibVLC data for each object. + * Assign a name to an object for vlc_object_find_name(). */ -typedef struct vlc_object_internals_t -{ - int i_object_type; /* Object type, deprecated */ - - /* Object variables */ - variable_t * p_vars; - vlc_mutex_t var_lock; - vlc_cond_t var_wait; - int i_vars; +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) - /* Thread properties, if any */ - vlc_thread_t thread_id; - bool b_thread; +/* 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) - /* Objects thread synchronization */ - int pipes[2]; - - /* Objects management */ - vlc_spinlock_t ref_spin; - unsigned i_refcount; - vlc_destructor_t pf_destructor; - - /* Objects tree structure */ - vlc_object_t *prev, *next; - vlc_object_t **pp_children; - int i_children; -} vlc_object_internals_t; +/* + * To be cleaned-up module stuff: + */ +module_t *module_find_by_shortcut (const char *psz_shortcut); #define ZOOM_SECTION N_("Zoom") #define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter") @@ -187,8 +137,6 @@ typedef struct vlc_object_internals_t #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) - typedef struct sap_handler_t sap_handler_t; /** @@ -197,38 +145,34 @@ typedef struct sap_handler_t sap_handler_t; typedef struct libvlc_priv_t { libvlc_int_t public_data; - vlc_cond_t exiting; ///< signaled when VLC wants to exit - - 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? - vlc_dictionary_t msg_enabled_objects; ///< Enabled objects - bool msg_all_objects_enabled; ///< Should we print all objects? - - /* 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 + /* Logging */ + struct + { + void (*cb) (void *, int, const vlc_log_t *, const char *, va_list); + void *opaque; + signed char verbose; + vlc_rwlock_t lock; + } log; 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 + playlist_t *p_playlist; ///< the playlist singleton vlm_t *p_vlm; ///< the VLM singleton (or NULL) vlc_object_t *p_dialog_provider; ///< dialog provider - httpd_t *p_httpd; ///< HTTP daemon (src/network/httpd.c) #ifdef ENABLE_SOUT sap_handler_t *p_sap; ///< SAP SDP advertiser #endif + struct vlc_actions *actions; ///< Hotkeys handler /* Interfaces */ struct intf_thread_t *p_intf; ///< Interfaces linked-list /* Objects tree */ vlc_mutex_t structure_lock; + + /* Exit callback */ + vlc_exit_t exit; } libvlc_priv_t; static inline libvlc_priv_t *libvlc_priv (libvlc_int_t *libvlc) @@ -241,121 +185,63 @@ 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); - /* * Stats stuff */ -#define stats_Update(a,b,c) __stats_Update( VLC_OBJECT(a), b, c ) -int __stats_Update (vlc_object_t*, counter_t *, vlc_value_t, vlc_value_t *); -#define stats_CounterCreate(a,b,c) __stats_CounterCreate( VLC_OBJECT(a), b, c ) -counter_t * __stats_CounterCreate (vlc_object_t*, int, int); -#define stats_Get(a,b,c) __stats_Get( VLC_OBJECT(a), b, c) -int __stats_Get (vlc_object_t*, counter_t *, vlc_value_t*); - -void stats_CounterClean (counter_t * ); - -#define stats_GetInteger(a,b,c) __stats_GetInteger( VLC_OBJECT(a), b, c ) -static inline int __stats_GetInteger( vlc_object_t *p_obj, counter_t *p_counter, - int *value ) +enum { - int i_ret; - vlc_value_t val; val.i_int = 0; - if( !p_counter ) return VLC_EGENERIC; - i_ret = __stats_Get( p_obj, p_counter, &val ); - *value = val.i_int; - return i_ret; -} + STATS_COUNTER, + STATS_DERIVATIVE, +}; -#define stats_GetFloat(a,b,c) __stats_GetFloat( VLC_OBJECT(a), b, c ) -static inline int __stats_GetFloat( vlc_object_t *p_obj, counter_t *p_counter, - float *value ) +typedef struct counter_sample_t { - int i_ret; - vlc_value_t val; val.f_float = 0.0; - if( !p_counter ) return VLC_EGENERIC; - i_ret = __stats_Get( p_obj, p_counter, &val ); - *value = val.f_float; - return i_ret; -} -#define stats_UpdateInteger(a,b,c,d) __stats_UpdateInteger( VLC_OBJECT(a),b,c,d ) -static inline int __stats_UpdateInteger( vlc_object_t *p_obj,counter_t *p_co, - int i, int *pi_new ) -{ - int i_ret; - vlc_value_t val; - vlc_value_t new_val; new_val.i_int = 0; - if( !p_co ) return VLC_EGENERIC; - val.i_int = i; - i_ret = __stats_Update( p_obj, p_co, val, &new_val ); - if( pi_new ) - *pi_new = new_val.i_int; - return i_ret; -} -#define stats_UpdateFloat(a,b,c,d) __stats_UpdateFloat( VLC_OBJECT(a),b,c,d ) -static inline int __stats_UpdateFloat( vlc_object_t *p_obj, counter_t *p_co, - float f, float *pf_new ) + uint64_t value; + mtime_t date; +} counter_sample_t; + +typedef struct counter_t { - vlc_value_t val; - int i_ret; - vlc_value_t new_val;new_val.f_float = 0.0; - if( !p_co ) return VLC_EGENERIC; - val.f_float = f; - i_ret = __stats_Update( p_obj, p_co, val, &new_val ); - if( pf_new ) - *pf_new = new_val.f_float; - return i_ret; -} + int i_compute_type; + int i_samples; + counter_sample_t ** pp_samples; -VLC_EXPORT( void, stats_ComputeInputStats, (input_thread_t*, input_stats_t*) ); -VLC_EXPORT( void, stats_ReinitInputStats, (input_stats_t *) ); -VLC_EXPORT( void, stats_DumpInputStats, (input_stats_t *) ); + mtime_t last_update; +} counter_t; -/* - * Replacement functions - */ -# 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_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, }; -# 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 -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 + +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