X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=src%2Flibvlc.h;h=02bdfaaddbd6eb80de2d72d920015bbd18715ff1;hb=12ade3e3bc975d5426ba4af155b7372c31093b31;hp=9fe15565c98d756f524413624f536e94f240d3b6;hpb=b5390911cbc2a5f1f791f386d459d7dc5a55fc4b;p=vlc diff --git a/src/libvlc.h b/src/libvlc.h index 9fe15565c9..02bdfaaddb 100644 --- a/src/libvlc.h +++ b/src/libvlc.h @@ -1,9 +1,12 @@ /***************************************************************************** * libvlc.h: Internal libvlc generic/misc declaration ***************************************************************************** + * Copyright (C) 1999, 2000, 2001, 2002 the VideoLAN team * 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 @@ -22,58 +25,318 @@ #ifndef LIBVLC_LIBVLC_H # define LIBVLC_LIBVLC_H 1 -extern const char vlc_usage[]; +#include -extern const module_config_t libvlc_config[]; -extern const size_t libvlc_config_count; +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_InitActions (libvlc_int_t *); +extern void vlc_DeinitActions (libvlc_int_t *); + +/* + * OS-specific initialization + */ +void system_Init ( libvlc_int_t *, int *, const char *[] ); +void system_Configure ( libvlc_int_t *, int, const char *const [] ); +void system_End ( libvlc_int_t * ); + +/* + * Threads subsystem + */ + +/* This cannot be used as is from plugins: */ +void vlc_detach (vlc_thread_t); + +/* Hopefully, no need to export this. There is a new thread API instead. */ +void vlc_thread_cancel (vlc_object_t *); +int vlc_object_waitpipe (vlc_object_t *obj); + +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) +void vlc_assert_locked (vlc_mutex_t *); +#else +# define vlc_assert_locked( m ) (void)m +#endif + +/* + * CPU capabilities + */ +extern uint32_t cpu_flags; +uint32_t CPUCapabilities( void ); +bool vlc_CPU_CheckPluginDir (const char *name); + +/* + * Message/logging stuff + */ + +typedef struct msg_bank_t msg_bank_t; + +msg_bank_t *msg_Create (void); +void msg_Destroy (msg_bank_t *); -extern const struct hotkey libvlc_hotkeys[]; -extern const size_t libvlc_hotkeys_size; +/** Internal message stack context */ +void msg_StackSet ( int, const char*, ... ); +void msg_StackAdd ( const char*, ... ); +const char* msg_StackMsg ( void ); -extern vlc_object_t * +/* + * Unicode stuff + */ +char *vlc_fix_readdir (const char *); + +/* + * LibVLC exit event handling + */ +typedef struct vlc_exit +{ + vlc_mutex_t lock; + void (*handler) (void *); + void *opaque; + bool killed; +} vlc_exit_t; + +void vlc_ExitInit( vlc_exit_t * ); +void vlc_ExitDestroy( vlc_exit_t * ); + +/* + * LibVLC objects stuff + */ + +/** + * Creates a VLC object. + * + * Note that because the object name pointer must remain valid, potentially + * even after the destruction of the object (through the message queues), this + * function CANNOT be exported to plugins as is. In this case, the old + * vlc_object_create() must be used instead. + * + * @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); + const char *psz_type); +#define vlc_custom_create(o, s, t, n) \ + vlc_custom_create(VLC_OBJECT(o), s, t, n) -#if 1 -/***************************************************************************** - * libvlc_global_data_t (global variable) - ***************************************************************************** - * This structure has an unique instance, statically allocated in main and - * never accessed from the outside. It stores once-initialized data such as - * the CPU capabilities or the global lock. - *****************************************************************************/ -struct libvlc_global_data_t +/** + * Assign a name to an object for vlc_object_find_name(). + */ +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) + +/* + * To be cleaned-up module stuff: + */ +extern char *psz_vlcpath; + +module_t *module_find_by_shortcut (const char *psz_shortcut); + +/** + * Private LibVLC data for each object. + */ +typedef struct vlc_object_internals vlc_object_internals_t; + +struct vlc_object_internals { - VLC_COMMON_MEMBERS + int i_object_type; /* Object type, deprecated */ + char *psz_name; /* given name */ - vlc_bool_t b_ready; ///< Initialization boolean + /* Object variables */ + void *var_root; + vlc_mutex_t var_lock; + vlc_cond_t var_wait; - /* Object structure data */ - int i_counter; ///< object counter - int i_objects; ///< Attached objects count - vlc_object_t ** pp_objects; ///< Array of all objects + /* Thread properties, if any */ + vlc_thread_t thread_id; + bool b_thread; - module_bank_t * p_module_bank; ///< The module bank - intf_thread_t *p_probe; ///< Devices prober + /* Objects thread synchronization */ + int pipes[2]; - /* Arch-specific variables */ -#if !defined( WIN32 ) - vlc_bool_t b_daemon; -#endif -#if defined( SYS_BEOS ) - vlc_object_t * p_appthread; - char * psz_vlcpath; -#elif defined( __APPLE__ ) - char * psz_vlcpath; - vlc_iconv_t iconv_macosx; /* for HFS+ file names */ - vlc_mutex_t iconv_lock; -#elif defined( WIN32 ) - char * psz_vlcpath; -#endif + /* Objects management */ + vlc_spinlock_t ref_spin; + unsigned i_refcount; + vlc_destructor_t pf_destructor; + + /* Objects tree structure */ + vlc_object_internals_t *next; /* next sibling */ + vlc_object_internals_t *prev; /* previous sibling */ + vlc_object_internals_t *first; /* first child */ }; + +#define ZOOM_SECTION N_("Zoom") +#define ZOOM_QUARTER_KEY_TEXT N_("1:4 Quarter") +#define ZOOM_HALF_KEY_TEXT N_("1:2 Half") +#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) +#define vlc_externals( priv ) ((vlc_object_t *)((priv) + 1)) + +typedef struct sap_handler_t sap_handler_t; + +/** + * Private LibVLC instance data. + */ +typedef struct libvlc_priv_t +{ + libvlc_int_t public_data; + + int i_last_input_id ; ///< Last id of input item + bool playlist_active; + + /* Messages */ + msg_bank_t *msg_bank; ///< The message bank + int i_verbose; ///< info messages + bool b_color; ///< color messages? + + /* Timer stats */ + bool b_stats; ///< Whether to collect stats + vlc_mutex_t timer_lock; ///< Lock to protect timers + counter_t **pp_timers; ///< Array of all timers + int i_timers; ///< Number of timers + + /* Singleton objects */ + module_t *p_memcpy_module; ///< Fast memcpy plugin used + playlist_t *p_playlist; ///< the playlist singleton + media_library_t *p_ml; ///< the ML singleton + vlc_mutex_t ml_lock; ///< Mutex for ML creation + 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 + /* Interfaces */ + struct intf_thread_t *p_intf; ///< Interfaces linked-list -extern uint32_t cpu_flags; + /* 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) +{ + return (libvlc_priv_t *)libvlc; +} + +void playlist_ServicesDiscoveryKillAll( playlist_t *p_playlist ); +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 + */ +int stats_Update (vlc_object_t*, counter_t *, vlc_value_t, vlc_value_t *); +counter_t * stats_CounterCreate (vlc_object_t*, int, int); +#define stats_CounterCreate(a,b,c) stats_CounterCreate( VLC_OBJECT(a), b, c ) +int stats_Get (vlc_object_t*, counter_t *, vlc_value_t*); +#define stats_Get(a,b,c) stats_Get( VLC_OBJECT(a), b, c) + +void stats_CounterClean (counter_t * ); + +static inline int stats_GetInteger( vlc_object_t *p_obj, counter_t *p_counter, + int64_t *value ) +{ + 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; +} +#define stats_GetInteger(a,b,c) stats_GetInteger( VLC_OBJECT(a), b, c ) + +static inline int stats_GetFloat( vlc_object_t *p_obj, counter_t *p_counter, + float *value ) +{ + 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_GetFloat(a,b,c) stats_GetFloat( VLC_OBJECT(a), b, c ) + +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_UpdateInteger(a,b,c,d) stats_UpdateInteger( 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 ) +{ + 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; +} +#define stats_UpdateFloat(a,b,c,d) stats_UpdateFloat( VLC_OBJECT(a),b,c,d ) + +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 *) ); + +/* + * Replacement functions + */ +#if defined (WIN32) +# include +void *vlc_wopendir (const wchar_t *); +void *vlc_wclosedir (void *); +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 #endif