Logging

Logging functions of PipeWire. More...

Macros
#define	pw_log_level_enabled(lev)   (pw_log_level >= (lev))
	Check if a loglevel is enabled. More...
#define	pw_log(lev, ...)
#define	pw_log_error(...)   pw_log(SPA_LOG_LEVEL_ERROR,__VA_ARGS__)
#define	pw_log_warn(...)   pw_log(SPA_LOG_LEVEL_WARN,__VA_ARGS__)
#define	pw_log_info(...)   pw_log(SPA_LOG_LEVEL_INFO,__VA_ARGS__)
#define	pw_log_debug(...)   pw_log(SPA_LOG_LEVEL_DEBUG,__VA_ARGS__)
#define	pw_log_trace(...)   pw_log(SPA_LOG_LEVEL_TRACE,__VA_ARGS__)
#define	pw_log_trace_fp(...)   pw_log(SPA_LOG_LEVEL_TRACE,__VA_ARGS__)

Functions
void	pw_log_set (struct spa_log *log)
	Configure a logging module. More...
struct spa_log *	pw_log_get (void)
	Get the log interface. More...
void	pw_log_set_level (enum spa_log_level level)
	Configure the logging level. More...
void	pw_log_log (enum spa_log_level level, const char *file, int line, const char *func, const char *fmt,...) 1(5
	Log a message. More...
void void	pw_log_logv (enum spa_log_level level, const char *file, int line, const char *func, const char *fmt, va_list args) 1(5
	Log a message. More...

Variables
enum spa_log_level	pw_log_level
	The global log level. More...

Detailed Description

Logging functions of PipeWire.

Logging is performed to stdout and stderr. Trace logging is performed in a lockfree ringbuffer and written out from the main thread as to not block the realtime threads.

Macro Definition Documentation

pw_log

#define pw_log	(		lev,
			...
	)

Value:

({                                                                      \
        if (SPA_UNLIKELY(pw_log_level_enabled (lev)))                   \
                pw_log_log(lev,__FILE__,__LINE__,__func__,__VA_ARGS__); \
})

Referenced by pw_impl_port_update_state().

pw_log_debug

#define pw_log_debug

(

...

)

pw_log(SPA_LOG_LEVEL_DEBUG,__VA_ARGS__)

Referenced by pipewire__module_init(), pw_buffers_clear(), pw_conf_load_conf(), pw_conf_load_state(), pw_context_create_client(), pw_context_create_core(), pw_context_create_device(), pw_context_create_factory(), pw_context_create_node(), pw_context_create_port(), pw_context_destroy(), pw_context_find_format(), pw_context_find_port(), pw_context_load_module(), pw_context_load_spa_handle(), pw_context_new(), pw_context_register_export_type(), pw_context_update_properties(), pw_control_add_link(), pw_control_destroy(), pw_control_new(), pw_control_remove_link(), pw_core_disconnect(), pw_core_export(), pw_core_set_paused(), pw_core_steal_fd(), pw_core_update_properties(), pw_data_loop_destroy(), pw_data_loop_stop(), pw_filter_connect(), pw_filter_destroy(), pw_filter_disconnect(), pw_filter_set_active(), pw_filter_update_params(), pw_global_add_resource(), pw_global_destroy(), pw_global_register(), pw_global_update_permissions(), pw_impl_client_destroy(), pw_impl_client_register(), pw_impl_client_set_busy(), pw_impl_client_update_permissions(), pw_impl_core_destroy(), pw_impl_core_update_properties(), pw_impl_device_destroy(), pw_impl_device_set_implementation(), pw_impl_factory_destroy(), pw_impl_factory_update_properties(), pw_impl_link_activate(), pw_impl_link_add_listener(), pw_impl_link_deactivate(), pw_impl_link_destroy(), pw_impl_link_prepare(), pw_impl_metadata_destroy(), pw_impl_module_destroy(), pw_impl_module_update_properties(), pw_impl_node_destroy(), pw_impl_node_get_free_port_id(), pw_impl_node_initialized(), pw_impl_node_register(), pw_impl_node_set_active(), pw_impl_node_set_implementation(), pw_impl_node_set_param(), pw_impl_node_set_state(), pw_impl_port_destroy(), pw_impl_port_recalc_latency(), pw_impl_port_set_mix(), pw_impl_port_set_param(), pw_impl_port_use_buffers(), pw_main_loop_destroy(), pw_main_loop_quit(), pw_main_loop_run(), pw_memblock_free(), pw_memmap_free(), pw_mempool_clear(), pw_mempool_destroy(), pw_mempool_find_ptr(), pw_mempool_find_tag(), pw_mempool_import_block(), pw_mempool_new(), pw_protocol_add_marshal(), pw_protocol_destroy(), pw_protocol_get_marshal(), pw_protocol_new(), pw_proxy_destroy(), pw_proxy_new(), pw_proxy_remove(), pw_proxy_set_bound_id(), pw_proxy_sync(), pw_proxy_unref(), pw_resource_destroy(), pw_resource_ping(), pw_resource_set_bound_id(), pw_stream_connect(), pw_stream_destroy(), pw_stream_disconnect(), pw_stream_set_active(), pw_stream_set_control(), pw_stream_update_params(), pw_thread_loop_stop(), pw_work_queue_add(), pw_work_queue_cancel(), pw_work_queue_complete(), pw_work_queue_destroy(), pw_work_queue_new(), sm_media_session_create_node(), sm_media_session_export(), sm_media_session_export_device(), sm_media_session_export_node(), and sm_object_sync_update().

pw_log_error

#define pw_log_error

(

...

)

pw_log(SPA_LOG_LEVEL_ERROR,__VA_ARGS__)

Referenced by pipewire__module_init(), pw_context_debug_port_params(), pw_core_export(), pw_global_bind(), pw_impl_device_set_implementation(), pw_impl_node_set_implementation(), pw_loop_new(), pw_rtkit_bus_get_system(), sm_libcamera_monitor_start(), and sm_v4l2_monitor_start().

pw_log_info

#define pw_log_info

(

...

)

pw_log(SPA_LOG_LEVEL_INFO,__VA_ARGS__)

Referenced by pw_context_recalc_graph(), pw_impl_link_destroy(), pw_impl_node_destroy(), sm_alsa_monitor_start(), sm_bluez5_autoswitch_start(), sm_bluez5_monitor_start(), sm_default_nodes_start(), sm_default_routes_start(), and sm_v4l2_monitor_start().

pw_log_level_enabled

#define pw_log_level_enabled

(

lev

)

(pw_log_level >= (lev))

Check if a loglevel is enabled.

Referenced by pw_log_log(), and pw_log_logv().

pw_log_trace

#define pw_log_trace

(

...

)

pw_log(SPA_LOG_LEVEL_TRACE,__VA_ARGS__)

Referenced by pw_filter_get_time(), pw_filter_queue_buffer(), pw_stream_get_time(), pw_stream_queue_buffer(), pw_stream_trigger_process(), pw_thread_loop_lock(), pw_thread_loop_signal(), pw_thread_loop_unlock(), pw_thread_loop_wait(), and pw_work_queue_complete().

pw_log_trace_fp

#define pw_log_trace_fp

(

...

)

pw_log(SPA_LOG_LEVEL_TRACE,__VA_ARGS__)

pw_log_warn

#define pw_log_warn

(

...

)

pw_log(SPA_LOG_LEVEL_WARN,__VA_ARGS__)

Referenced by pw_context_load_spa_handle(), pw_context_register_export_type(), pw_impl_client_update_permissions(), pw_impl_module_destroy(), and pw_main_loop_run().

Function Documentation

pw_log_get()

struct spa_log* pw_log_get

(

void

)

Get the log interface.

Get the log interface.

Returns

the global log

pw_log_log()

void pw_log_log	(	enum spa_log_level	level,
		const char *	file,
		int	line,
		const char *	func,
		const char *	fmt,
			...
	)

Log a message.

pw_log_logv()

void void pw_log_logv	(	enum spa_log_level	level,
		const char *	file,
		int	line,
		const char *	func,
		const char *	fmt,
		va_list	args
	)

Log a message.

pw_log_set()

void pw_log_set

(

struct spa_log *

log

)

Configure a logging module.

This is usually done automatically in pw_init() but you can install a custom logger before calling pw_init().

Configure a logging module.

Parameters

log	the global log to set

pw_log_set_level()

void pw_log_set_level

(

enum spa_log_level

level

)

Configure the logging level.

Configure the logging level.

Parameters

level

the new log level

References spa_log::level, and pw_log_level.

Variable Documentation

pw_log_level

enum spa_log_level pw_log_level

The global log level.

Referenced by pw_log_set_level().