Logging

Message logs. More...

Collaboration diagram for Logging:

Modules
	Logger
	Message log back-end.

Files
file	vlc_messages.h
	Logging functions.

Data Structures
struct	vlc_log_t
	Log message. More...

Macros
#define	msg_GenericVa(o, p, fmt, ap)
#define	msg_Generic(o, p, ...)
#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__)

Typedefs
typedef struct vlc_log_t	vlc_log_t
	Log message. More...

Enumerations
enum	vlc_log_type { VLC_MSG_INFO =0, VLC_MSG_ERR, VLC_MSG_WARN, VLC_MSG_DBG }
	Message types. More...

Functions
void	vlc_object_Log (vlc_object_t *obj, int prio, const char *module, const char *file, unsigned line, const char *func, const char *format,...)
	Emit a log message. More...
void	vlc_object_vaLog (vlc_object_t *obj, int prio, const char *module, const char *file, unsigned line, const char *func, const char *format, va_list ap)
	Emit a log message. More...
const char *	vlc_strerror (int)
	Formats an error message in the current locale. More...
const char *	vlc_strerror_c (int)
	Formats an error message in the POSIX/C locale (i.e. More...

Variables
const char	vlc_module_name []
void	vlc_LogSet (libvlc_int_t *, const struct vlc_logger_operations *, void *data)
	Sets the message logging callback. More...

Detailed Description

Message logs.

Functions for modules to emit log messages.

Macro Definition Documentation

msg_Dbg

#define msg_Dbg	(		p_this,
			...
	)		msg_Generic(p_this, VLC_MSG_DBG, __VA_ARGS__)

Referenced by access_New(), aout_CheckReady(), aout_DecSilence(), aout_FiltersPipelineCreate(), aout_FormatPrint(), aout_FormatsPrint(), aout_RequestRestart(), aout_RequestRetiming(), aout_volume_SetFormat(), config_ChainParse(), config_OpenConfigFile(), Control(), ControlInsertDemuxFilter(), Create(), CreateConverter(), CreateVoutIfNeeded(), DecoderThread_ChangeDelay(), DecoderThread_ChangePause(), DecoderThread_ChangeRate(), DecoderThread_ProcessInput(), DeinterlaceCallback(), DeleteDecoder(), demux_NewAdvanced(), Destroy(), download_key(), download_signature(), EsOutCreateCCChannels(), EsOutDecodersStopBuffering(), EsOutDelLocked(), EsOutFrameNext(), EsOutProgramDel(), EsOutProgramEpg(), EsOutProgramMeta(), EsOutProgramSelect(), EsOutPropsInit(), EsOutSelectEs(), EsOutSend(), EsOutVaControlLocked(), filter_chain_AppendInner(), filter_chain_DeleteFilter(), GetUpdateFile(), httpd_HostDelete(), ImageReadUrl(), ImageWrite(), Init(), input_ControlPush(), input_EsOutTimeshiftNew(), input_resource_GetAout(), input_resource_GetVoutDecoderDevice(), input_resource_PutAout(), input_resource_PutVoutLocked(), input_resource_StopFreeVout(), input_SaveArt(), input_SlaveSourceAdd(), input_SubtitleFile2Uri(), InputGetExtraFilesPattern(), InputSourceInit(), InputStreamHandleAnchor(), installOrRemoveAddon(), libvlc_InternalCleanup(), libvlc_InternalInit(), libvlc_Quit(), LoadSlaves(), MainLoop(), MainLoopDemux(), MainLoopTryRepeat(), module_InitStaticModules(), module_LoadPlugins(), module_unneed(), ModuleThread_GetDecoderDevice(), ModuleThread_PlayAudio(), ModuleThread_PlayVideo(), net_Accept(), net_Connect(), net_ConnectDgram(), net_ConnectTCP(), net_Listen(), net_ListenSingle(), net_OpenDgram(), net_SetMcastHopLimit(), RequestSout(), SelectClockSource(), services_discovery_item_added(), services_discovery_item_removed(), SlaveDemux(), SocksHandshakeTCP(), SocksNegotiate(), sout_AnnounceRegisterSDP(), sout_AnnounceUnRegister(), sout_InputDelete(), sout_InputNew(), sout_MuxAddStream(), sout_MuxNew(), sout_NewInstance(), sout_StreamDelete(), sout_StreamNew(), StartTitle(), stream_FilterAutoNew(), subtitles_Detect(), system_Configure(), system_ConfigureDbus(), ThreadChangeFilters(), ThreadDisplayPreparePicture(), update_DownloadReal(), UpdateSPU(), var_Destroy(), video_format_Print(), vlc_CPU_dump(), vlc_gl_surface_ResizeNotify(), vlc_http_auth_ParseWwwAuthenticateHeader(), vlc_LogSpam(), vlc_stream_ReadLine(), vlc_threads_setup(), vlc_tls_SocketOpenTCP(), vlc_tls_SocketOpenTLS(), vlm_New(), vout_display_window_FullscreenNotify(), vout_display_window_OutputEvent(), vout_display_window_ResizeNotify(), vout_display_window_StateNotify(), vout_display_window_WindowingNotify(), vout_InitInterlacingSupport(), vout_OpenWrapper(), vout_SetInterlacingState(), vout_UpdateWindowSizeLocked(), VoutDisplayCreateRender(), and VoutOsdSnapshot().

msg_Err

#define msg_Err	(		p_this,
			...
	)		msg_Generic(p_this, VLC_MSG_ERR, __VA_ARGS__)

Referenced by access_New(), AddCallback(), AddIntfCallback(), addons_manager_Gather(), aout_DecNew(), aout_FiltersNewWithClock(), aout_FiltersPipelineCreate(), aout_New(), aout_OutputNew(), AppendFilter(), config_ChainParse(), config_LoadConfigFile(), config_OpenConfigFile(), config_SaveConfigFile(), Control(), ControlLockedSetPauseState(), ControlLockedSetRate(), ControlNav(), ControlUnpause(), CreateDecoder(), CreateEncoder(), CreateVoutIfNeeded(), CropCallback(), decoder_New(), DecoderUnsupportedCodec(), DecoderUpdatePreroll(), DelCallback(), demux_PacketizerNew(), demux_Probe(), demux_vaControlHelper(), EnableWindowLocked(), EsOutAddLocked(), EsOutVaControlLocked(), filter_chain_AppendFromString(), filter_chain_AppendInner(), filter_chain_VideoBufferNew(), fingerprinter_Create(), GetUpdateFile(), httpd_HostCreate(), httpdLoop(), ImageWriteUrl(), input_clock_ConvertTS(), input_ControlPush(), input_item_WriteMeta(), input_SaveArt(), input_SlaveSourceAdd(), input_Start(), InputSourceInit(), InputStreamHandleAnchor(), InstallEntry(), intf_Create(), libvlc_InternalActionsInit(), libvlc_InternalAddIntf(), libvlc_InternalInit(), MainLoop(), module_InitStaticModules(), ModuleThread_UpdateAudioFormat(), ModuleThread_UpdateVideoFormat(), net_Accept(), net_Connect(), net_ConnectDgram(), net_ConnectTCP(), net_Listen(), net_ListenSingle(), net_OpenDgram(), net_Read(), net_SetMcastHopLimit(), net_SetMcastOut(), net_SetupDgramSocket(), net_Socket(), net_SourceSubscribe(), net_Subscribe(), net_Write(), Open(), picture_BlendSubpicture(), SelectClockSource(), services_discovery_item_added(), services_discovery_item_removed(), SlaveDemux(), SlaveSeek(), SocksHandshakeTCP(), SocksNegotiate(), sout_AccessOutNew(), sout_AnnounceRegisterSDP(), sout_EncoderCreate(), sout_MuxAddStream(), sout_NewInstance(), spu_PrerenderText(), spu_PutSubpicture(), SpuRenderRegion(), SpuRenderSubpictures(), system_Configure(), system_ConfigureDbus(), ThreadChangeFilters(), ThreadDisplayRenderPicture(), TsStart(), update_DownloadReal(), var_OptionParse(), vlc_credential_get(), vlc_dialog_display_error_va(), vlc_http_auth_FormatAuthorizationHeader(), vlc_http_auth_ParseAuthenticationInfoHeader(), vlc_https_HostNew(), vlc_input_decoder_SetCcState(), vlc_input_decoder_Wait(), vlc_keystore_store(), vlc_playlist_Export(), vlc_rd_new(), vlc_sd_Create(), vlc_stream_NewMRL(), vlc_stream_NewURL(), vlc_stream_ReadLine(), vlc_tls_ClientCreate(), vlc_tls_ClientSessionCreate(), vlc_tls_ServerCreate(), vlc_tls_SocketOpenTCP(), vlc_tls_SocketOpenTLS(), vlc_xlib_init(), vlm_ControlMediaAdd(), vlm_New(), vlm_vaControlInternal(), vout_display_Reset(), vout_display_SendEventPicturesInvalid(), vout_display_window_CloseNotify(), vout_GetSnapshot(), vout_Request(), vout_SetDisplayViewpoint(), vout_snapshot_SaveImage(), VoutDisplayCreateRender(), VoutSaveSnapshot(), xml_Create(), and xml_ReaderCreate().

msg_Generic

#define msg_Generic	(		o,
			p,
			...
	)

Value:

vlc_object_Log(VLC_OBJECT(o), p, vlc_module_name, __FILE__, __LINE__, \
                   __func__, __VA_ARGS__)

msg_GenericVa

#define msg_GenericVa	(		o,
			p,
			fmt,
			ap
	)

Value:

vlc_object_vaLog(VLC_OBJECT(o), p, vlc_module_name, __FILE__, __LINE__, \
                     __func__, fmt, ap)

Referenced by vlc_dialog_display_error_va().

msg_Info

#define msg_Info	(		p_this,
			...
	)		msg_Generic(p_this, VLC_MSG_INFO, __VA_ARGS__)

Referenced by aout_FiltersNewWithClock(), config_OpenConfigFile(), Control(), GetUpdateFile(), libvlc_InternalAddIntf(), system_Configure(), ThreadDisplayRenderPicture(), and update_DownloadReal().

msg_Warn

#define msg_Warn	(		p_this,
			...
	)		msg_Generic(p_this, VLC_MSG_WARN, __VA_ARGS__)

Referenced by aout_FiltersNewWithClock(), aout_RequestRetiming(), AuthDigest(), config_ChainParse(), config_CreateDir(), config_LoadConfigFile(), Control(), ControlPause(), decoder_NewSubpicture(), decoder_UpdateVideoOutput(), DecoderThread_ProcessInput(), EsOutFrameNext(), EsOutSelectEs(), EsOutUnselectEs(), filter_NewPicture(), filter_NewSubpicture(), FilterChainVideoFilter(), GetFilenames(), GetUpdateFile(), httpd_HostDelete(), httpd_UrlDelete(), httpd_UrlNew(), ImageRead(), init_action(), input_clock_Update(), input_ExtractAttachmentAndCacheArt(), input_preparser_New(), input_SlaveSourceAdd(), libvlc_InternalCleanup(), libvlc_InternalInit(), module_InitStaticModules(), ModuleThread_NewSpuBuffer(), ModuleThread_PlayAudio(), ModuleThread_PlaySpu(), ModuleThread_PlayVideo(), net_Connect(), net_ConnectDgram(), net_Read(), net_SetMcastHopLimit(), net_SourceSubscribe(), SocksHandshakeTCP(), sout_InputNew(), sout_MuxDeleteStream(), spu_PrerenderText(), SpuRenderRegion(), SpuRenderSubpictures(), StartTitle(), stream_FilterChainNew(), system_ConfigureDbus(), ThreadDisplayPreparePicture(), ThreadDisplayRenderPicture(), TsAutoStop(), TsRun(), video_splitter_NewPicture(), vlc_credential_get(), vlc_http_auth_ParseAuthenticationInfoHeader(), vlc_http_auth_ParseWwwAuthenticateHeader(), vlc_input_decoder_Decode(), vlc_player_input_HandleTeletextMenu(), vlc_probe(), vlc_stream_NewMRL(), vlc_stream_ReadLine(), vlm_New(), vout_OpenWrapper(), and VoutOsdSnapshot().

Typedef Documentation

vlc_log_t

typedef struct vlc_log_t vlc_log_t

Log message.

Enumeration Type Documentation

vlc_log_type

enum vlc_log_type

Message types.

Enumerator
VLC_MSG_INFO	Important information.
VLC_MSG_ERR	Error.
VLC_MSG_WARN	Warning.
VLC_MSG_DBG	Debug.

Function Documentation

vlc_LogSet()

void vlc_LogSet	(	libvlc_int_t *	vlc,
		const struct vlc_logger_operations *	ops,
		void *	opaque
	)

Sets the message logging callback.

Parameters

ops	message callback, or NULL to clear
data	data pointer for the message callback

References discard_log, vlc_object_t::logger, libvlc_int_t::obj, vlc_LogExternalCreate(), vlc_LogSpam(), vlc_LogSwitch(), and VLC_OBJECT.

vlc_object_Log()

void vlc_object_Log	(	vlc_object_t *	obj,
		int	prio,
		const char *	module,
		const char *	file,
		unsigned	line,
		const char *	func,
		const char *	format,
			...
	)

Emit a log message.

Parameters

obj	VLC object emitting the message or NULL
type	VLC_MSG_* message type (info, error, warning or debug)
module	name of module from which the message come (normally vlc_module_name)
file	source module file name (normally FILE) or NULL
line	function call source line number (normally LINE) or 0
func	calling function name (normally func) or NULL
format	printf-like message format

References vlc_object_vaLog().

vlc_object_vaLog()

void vlc_object_vaLog	(	vlc_object_t *	obj,
		int	prio,
		const char *	module,
		const char *	file,
		unsigned	line,
		const char *	func,
		const char *	format,
		va_list	ap
	)

Emit a log message.

This function is the variable argument list equivalent to vlc_object_Log().

References vlc_object_t::logger, vlc_object_typename(), and vlc_vaLog().

Referenced by vlc_object_Log().

vlc_strerror()

const char* vlc_strerror

(

int

errnum

)

Formats an error message in the current locale.

Parameters

errnum

error number (as in errno.h)

Returns

A string pointer, valid until the next call to a function of the strerror() family in the same thread. This function cannot fail.

References vlc_strerror_c(), and vlc_strerror_l().

vlc_strerror_c()

const char* vlc_strerror_c

(

int

errnum

)

Formats an error message in the POSIX/C locale (i.e.

American English).

Parameters

errnum

error number (as in errno.h)

Returns

A string pointer, valid until the next call to a function of the strerror() family in the same thread. This function cannot fail.

References _, wsaerrmsg_t::msg, and vlc_strerror_l().

Referenced by config_CreateDir(), config_LoadConfigFile(), config_OpenConfigFile(), config_SaveConfigFile(), httpdLoop(), ImageWriteUrl(), input_SaveArt(), libvlc_InternalCleanup(), net_Accept(), net_Connect(), net_ConnectDgram(), net_Listen(), net_ListenSingle(), net_OpenDgram(), net_Read(), net_SetMcastHopLimit(), net_SetMcastOut(), net_SetupDgramSocket(), net_Socket(), net_SourceSubscribe(), net_Subscribe(), net_Write(), vlc_h1_request(), vlc_playlist_Export(), vlc_stream_ReadLine(), vlc_strerror(), vlc_thread_fatal_print(), vlc_tls_SocketOpenTCP(), and vlc_tls_SocketOpenTLS().

Variable Documentation

vlc_module_name

const char vlc_module_name[]