bg_fa_plugin_s Struct Reference

Audio filter plugin. More...

#include <plugin.h>

Data Fields
bg_plugin_common_t	common
	Infos and functions common to all plugin types.
void(*	connect_input_port )(void *priv, bg_read_audio_func_t func, void *data, int stream, int port)
	Set input callback.
void(*	set_input_format )(void *priv, gavl_audio_format_t *format, int port)
	Set input format.
void(*	reset )(void *priv)
	Reset.
void(*	get_output_format )(void *priv, gavl_audio_format_t *format)
	Get output format.
int(*	need_restart )(void *priv)
	Report, if the plugin must be reinitialized.
bg_read_audio_func_t	read_audio
	Read audio samples from the plugin.

---

Detailed Description

Audio filter plugin.

---

Field Documentation

bg_plugin_common_t bg_fa_plugin_s::common

Infos and functions common to all plugin types.

void(* bg_fa_plugin_s::connect_input_port)(void *priv, bg_read_audio_func_t func, void *data, int stream, int port)

Set input callback.

Parameters:

priv	The handle returned by the create() method
func	The function to call
data	The private handle to pass to func
stream	The stream argument to pass to func
port	The input port of the plugin

void(* bg_fa_plugin_s::set_input_format)(void *priv, gavl_audio_format_t *format, int port)

Set input format.

Parameters:

priv	The handle returned by the create() method
format	Format
port	The input port of the plugin

The input format can be changed by the plugin. Make sure that you have a format converter before the filter.

void(* bg_fa_plugin_s::reset)(void *priv)

Reset.

Parameters:

priv	The handle returned by the create() method

Optional, resets internal state, as if no frame has been processed before.

void(* bg_fa_plugin_s::get_output_format)(void *priv, gavl_audio_format_t *format)

Get output format.

Parameters:

priv	The handle returned by the create() method
format	Returns the output format

These must be called after init().

int(* bg_fa_plugin_s::need_restart)(void *priv)

Report, if the plugin must be reinitialized.

Parameters:

priv	The handle returned by the create() method

Returns:

1 if the plugin must be reinitialized, 0 else

Optional, must be called after set_parameter() to check, if the filter must be reinitialized. Note, that the input and output formats can be changed in this case as well.

bg_read_audio_func_t bg_fa_plugin_s::read_audio

Read audio samples from the plugin.

---

The documentation for this struct was generated from the following file:

• /home/mandrake/rpm/BUILD/gmerlin-1.0.0/include/gmerlin/plugin.h