X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_messages.h;h=2da692e65ccd927807a34663a5e96fe952ffb997;hb=132f872d78a5f489908a0b108cd3f3544a9cf0f7;hp=a9f03d712a593c285574651b5419275172e8547a;hpb=682db2c855a083d981af45dda6f3c333b5fd5c3c;p=vlc diff --git a/include/vlc_messages.h b/include/vlc_messages.h index a9f03d712a..2da692e65c 100644 --- a/include/vlc_messages.h +++ b/include/vlc_messages.h @@ -1,27 +1,27 @@ /***************************************************************************** - * messages.h: messages interface + * vlc_messages.h: messages interface * This library provides basic functions for threads to interact with user * interface, such as message output. ***************************************************************************** - * Copyright (C) 1999, 2000, 2001, 2002 the VideoLAN team + * Copyright (C) 1999, 2000, 2001, 2002 VLC authors and VideoLAN * $Id$ * * Authors: Vincent Seguin * Samuel Hocevar * - * 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 VLC_MESSAGES_H_ @@ -42,178 +42,70 @@ * @{ */ -/** - * Store a single message sent to user. - */ -typedef struct -{ - int i_type; /**< message type, see below */ - uintptr_t i_object_id; - const char *psz_object_type; - char * psz_module; - char * psz_msg; /**< the message itself */ - char * psz_header; /**< Additional header */ - - mtime_t date; /**< Message date */ - gc_object_t vlc_gc_data; -} msg_item_t; - -/* Message types */ -/** standard messages */ -#define VLC_MSG_INFO 0 -/** error messages */ -#define VLC_MSG_ERR 1 -/** warning messages */ -#define VLC_MSG_WARN 2 -/** debug messages */ -#define VLC_MSG_DBG 3 - -static inline msg_item_t *msg_Hold (msg_item_t *msg) -{ - vlc_hold (&msg->vlc_gc_data); - return msg; -} - -static inline void msg_Release (msg_item_t *msg) +/** Message types */ +enum vlc_log_type { - vlc_release (&msg->vlc_gc_data); -} + VLC_MSG_INFO=0, /**< Important information */ + VLC_MSG_ERR, /**< Error */ + VLC_MSG_WARN, /**< Warning */ + VLC_MSG_DBG, /**< Debug */ +}; /** - * Used by interface plugins which subscribe to the message bank. + * Log message */ -typedef struct msg_subscription_t msg_subscription_t; - -/***************************************************************************** - * Prototypes - *****************************************************************************/ -VLC_EXPORT( void, __msg_Generic, ( vlc_object_t *, int, const char *, const char *, ... ) LIBVLC_FORMAT( 4, 5 ) ); -VLC_EXPORT( void, __msg_GenericVa, ( vlc_object_t *, int, const char *, const char *, va_list args ) ); -#define msg_GenericVa(a, b, c, d, e) __msg_GenericVa(VLC_OBJECT(a), b, c, d, e) - -#define msg_Info( p_this, ... ) \ - __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_INFO, \ - MODULE_STRING, __VA_ARGS__ ) -#define msg_Err( p_this, ... ) \ - __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_ERR, \ - MODULE_STRING, __VA_ARGS__ ) -#define msg_Warn( p_this, ... ) \ - __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_WARN, \ - MODULE_STRING, __VA_ARGS__ ) -#define msg_Dbg( p_this, ... ) \ - __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_DBG, \ - MODULE_STRING, __VA_ARGS__ ) +typedef struct vlc_log_t +{ + uintptr_t i_object_id; /**< Emitter (temporaly) unique object ID or 0 */ + const char *psz_object_type; /**< Emitter object type name */ + const char *psz_module; /**< Emitter module (source code) */ + const char *psz_header; /**< Additional header (used by VLM media) */ + const char *file; /**< Source code file name or NULL */ + int line; /**< Source code file line number or -1 */ + const char *func; /**< Source code calling function name or NULL */ +} vlc_log_t; + +VLC_API void vlc_Log(vlc_object_t *obj, int prio, const char *module, + const char *file, unsigned line, const char *func, + const char *format, ...) VLC_FORMAT(7, 8); +VLC_API void vlc_vaLog(vlc_object_t *obj, int prio, const char *module, + const char *file, unsigned line, const char *func, + const char *format, va_list ap); +#define msg_GenericVa(o, p, fmt, ap) \ + vlc_vaLog(VLC_OBJECT(o), p, MODULE_STRING, __FILE__, __LINE__, __func__, \ + fmt, ap) + +#define msg_Generic(o, p, ...) \ + vlc_Log(VLC_OBJECT(o), p, MODULE_STRING, __FILE__, __LINE__, \ + __func__, __VA_ARGS__) +#define msg_Info(p_this, ...) \ + msg_Generic(p_this, VLC_MSG_INFO, __VA_ARGS__) +#define msg_Err(p_this, ...) \ + msg_Generic(p_this, VLC_MSG_ERR, __VA_ARGS__) +#define msg_Warn(p_this, ...) \ + msg_Generic(p_this, VLC_MSG_WARN, __VA_ARGS__) +#define msg_Dbg(p_this, ...) \ + msg_Generic(p_this, VLC_MSG_DBG, __VA_ARGS__) + +#ifndef MODULE_STRING +# define MODULE_STRING __FILE__ +#endif -typedef struct msg_cb_data_t msg_cb_data_t; +VLC_API const char *vlc_strerror(int); +VLC_API const char *vlc_strerror_c(int); /** * Message logging callback signature. - * Accepts one private data pointer, the message, and an overrun counter. + * \param data data pointer as provided to vlc_msg_SetCallback(). + * \param type message type (VLC_MSG_* values from enum vlc_log_type) + * \param item meta information + * \param fmt format string + * \param args format string arguments */ -typedef void (*msg_callback_t) (msg_cb_data_t *, msg_item_t *, unsigned); - -VLC_EXPORT( msg_subscription_t*, msg_Subscribe, ( libvlc_int_t *, msg_callback_t, msg_cb_data_t * ) ); -VLC_EXPORT( void, msg_Unsubscribe, ( msg_subscription_t * ) ); - -/* Enable or disable a certain object debug messages */ -#define msg_EnableObjectPrinting(a,b) __msg_EnableObjectPrinting(VLC_OBJECT(a),b) -#define msg_DisableObjectPrinting(a,b) __msg_DisableObjectPrinting(VLC_OBJECT(a),b) -VLC_EXPORT( void, __msg_EnableObjectPrinting, ( vlc_object_t *, char * psz_object ) ); -VLC_EXPORT( void, __msg_DisableObjectPrinting, ( vlc_object_t *, char * psz_object ) ); +typedef void (*vlc_log_cb) (void *data, int type, const vlc_log_t *item, + const char *fmt, va_list args); /** * @} */ - -/** - * \defgroup statistics Statistics - * - * @{ - */ - -/**************************** - * Generic stats stuff - ****************************/ -enum -{ - STATS_LAST, - STATS_COUNTER, - STATS_MAX, - STATS_MIN, - STATS_DERIVATIVE, - STATS_TIMER -}; - -struct counter_sample_t -{ - vlc_value_t value; - mtime_t date; -}; - -struct counter_t -{ - unsigned int i_id; - char * psz_name; - int i_type; - void * p_obj; - int i_compute_type; - int i_samples; - counter_sample_t ** pp_samples; - - mtime_t update_interval; - mtime_t last_update; -}; - -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, - - STATS_TIMER_PLAYLIST_BUILD, - STATS_TIMER_ML_LOAD, - STATS_TIMER_ML_DUMP, - STATS_TIMER_INTERACTION, - STATS_TIMER_PREPARSE, - STATS_TIMER_INPUT_LAUNCHING, - STATS_TIMER_MODULE_NEED, - STATS_TIMER_VIDEO_FRAME_ENCODING, - STATS_TIMER_AUDIO_FRAME_ENCODING, - - STATS_TIMER_SKINS_PLAYTREE_IMAGE, -}; - -/********* - * Timing - ********/ -#define stats_TimerStart(a,b,c) __stats_TimerStart( VLC_OBJECT(a), b,c ) -#define stats_TimerStop(a,b) __stats_TimerStop( VLC_OBJECT(a), b ) -#define stats_TimerDump(a,b) __stats_TimerDump( VLC_OBJECT(a), b ) -#define stats_TimersDumpAll(a) __stats_TimersDumpAll( VLC_OBJECT(a) ) -VLC_EXPORT( void,__stats_TimerStart, (vlc_object_t*, const char *, unsigned int ) ); -VLC_EXPORT( void,__stats_TimerStop, (vlc_object_t*, unsigned int) ); -VLC_EXPORT( void,__stats_TimerDump, (vlc_object_t*, unsigned int) ); -VLC_EXPORT( void,__stats_TimersDumpAll, (vlc_object_t*) ); -#define stats_TimersCleanAll(a) __stats_TimersCleanAll( VLC_OBJECT(a) ) -VLC_EXPORT( void, __stats_TimersCleanAll, (vlc_object_t * ) ); - -#define stats_TimerClean(a,b) __stats_TimerClean( VLC_OBJECT(a), b ) -VLC_EXPORT( void, __stats_TimerClean, (vlc_object_t *, unsigned int ) ); - #endif