log.h File Reference

Logging interface. More...

Typedefs
typedef void(*	fluid_log_function_t )(int level, char *message, void *data)
	Log function handler callback type used by fluid_set_log_function().
Enumerations
enum	fluid_log_level {   FLUID_PANIC, FLUID_ERR, FLUID_WARN, FLUID_INFO,   FLUID_DBG }
	FluidSynth log levels. More...
Functions
FLUIDSYNTH_API fluid_log_function_t	fluid_set_log_function (int level, fluid_log_function_t fun, void *data)
	Installs a new log function for a specified log level.
FLUIDSYNTH_API void	fluid_default_log_function (int level, char *message, void *data)
	Default log function which prints to the stderr.
FLUIDSYNTH_API int	fluid_log (int level, const char *fmt,...)
	Print a message to the log.

---

Detailed Description

Logging interface.

The default logging function of the fluidsynth prints its messages to the stderr. The synthesizer uses five level of messages: FLUID_PANIC, FLUID_ERR, FLUID_WARN, FLUID_INFO, and FLUID_DBG.

A client application can install a new log function to handle the messages differently. In the following example, the application sets a callback function to display FLUID_PANIC messages in a dialog, and ignores all other messages by setting the log function to NULL:

   fluid_set_log_function(FLUID_PANIC, show_dialog, (void*) root_window);
   fluid_set_log_function(FLUID_ERR, NULL, NULL);
   fluid_set_log_function(FLUID_WARN, NULL, NULL);
   fluid_set_log_function(FLUID_DBG, NULL, NULL);

---

Typedef Documentation

typedef void(* fluid_log_function_t)(int level, char *message, void *data)

Log function handler callback type used by fluid_set_log_function().

Parameters:

	level	Log level (fluid_log_level)
	message	Log message text
	data	User data pointer supplied to fluid_set_log_function().

---

Enumeration Type Documentation

enum fluid_log_level

FluidSynth log levels.

Enumerator:

FLUID_PANIC	The synth can't function correctly any more.
FLUID_ERR	Serious error occurred.
FLUID_WARN	Warning.
FLUID_INFO	Verbose informational messages.
FLUID_DBG	Debugging messages.

---

Function Documentation

FLUIDSYNTH_API fluid_log_function_t fluid_set_log_function	(	int	level,
		fluid_log_function_t	fun,
		void *	data
	)

Installs a new log function for a specified log level.

Parameters:

	level	Log level to install handler for.
	fun	Callback function handler to call for logged messages
	data	User supplied data pointer to pass to log function

Returns:

The previously installed function.

References fluid_set_log_function().

Referenced by fluid_set_log_function().

FLUIDSYNTH_API void fluid_default_log_function	(	int	level,
		char *	message,
		void *	data
	)

Default log function which prints to the stderr.

Parameters:

	level	Log level
	message	Log message
	data	User supplied data (not used)

References FLUID_DBG, fluid_default_log_function(), FLUID_ERR, FLUID_INFO, FLUID_PANIC, and FLUID_WARN.

Referenced by fluid_default_log_function().

FLUIDSYNTH_API int fluid_log	(	int	level,
		const char *	fmt,
			...
	)

Print a message to the log.

Parameters:

	level	Log level (fluid_log_level).
	fmt	Printf style format string for log message
	...	Arguments for printf 'fmt' message string

Returns:

Always returns FLUID_FAILED

References FLUID_FAILED, and fluid_log().

Referenced by fluid_log(), fluid_sequencer_register_client(), fluid_sequencer_register_fluidsynth(), fluid_sequencer_set_time_scale(), new_fluid_event(), and new_fluid_sequencer2().