Generates beamformers/virtual microphones in arbitrary directions with several different beam patterns to choose from. More...

#include "_common.h"

Functions
void	beamformer_create (void **const phBeam)
	Creates an instance of beamformer.

void	beamformer_destroy (void **const phBeam)
	Destroys an instance of beamformer.

void	beamformer_init (void *const hBeam, int samplerate)
	Initialises an instance of beamformer with default settings.

void	beamformer_process (void const hBeam, const float const inputs, float const *outputs, int nInputs, int nOutputs, int nSamples)
	Generates beamformers/virtual microphones in the specified directions.

void	beamformer_refreshSettings (void *const hBeam)
	Sets all intialisation flags to 1; re-initialising all settings/variables as beamformer is currently configured, at next available opportunity.

void	beamformer_setBeamOrder (void *const hBeam, int newValue)
	Sets the beamforming order (see SH_ORDERS enum)

void	beamformer_setBeamAzi_deg (void *const hBeam, int index, float newAzi_deg)
	Sets a beamformer azimuth direction of a given index, in DEGREES.

void	beamformer_setBeamElev_deg (void *const hBeam, int index, float newElev_deg)
	Sets a beamformer elevation direction for a given index, in DEGREES.

void	beamformer_setNumBeams (void *const hBeam, int new_nBeams)
	Sets the number of beamformers to generate.

void	beamformer_setChOrder (void *const hBeam, int newOrder)
	Sets the Ambisonic channel ordering convention to decode with, in order to match the convention employed by the input signals (see CH_ORDER enum)

void	beamformer_setNormType (void *const hBeam, int newType)
	Sets the Ambisonic normalisation convention to decode with, in order to match with the convention employed by the input signals (see NORM_TYPES enum)

void	beamformer_setBeamType (void *const hBeam, int newID)
	Sets the beamforming approach to employ (see STATIC_BEAM_TYPES enum)

int	beamformer_getFrameSize (void)
	Returns the processing framesize (i.e., number of samples processed with every _process() call )

int	beamformer_getBeamOrder (void *const hBeam)
	Returns the beamforming order (see SH_ORDERS enum)

float	beamformer_getBeamAzi_deg (void *const hBeam, int index)
	Returns the beamformer azimuth direction of a given index h, in DEGREES.

float	beamformer_getBeamElev_deg (void *const hBeam, int index)
	Returns the beamformer elevation direction of a given index, in DEGREES.

int	beamformer_getNumBeams (void *const hBeam)
	Returns the number of beamformers being generated.

int	beamformer_getMaxNumBeams (void)
	Returns the maximum number of beamformers permitted.

int	beamformer_getNSHrequired (void *const hBeam)
	Returns the number of spherical harmonic signals required by the currently selected beamforming order: (current_order+1)^2.

int	beamformer_getChOrder (void *const hBeam)
	Returns the Ambisonic channel ordering convention currently being used to decode with, which should match the convention employed by the input signals (see CH_ORDER enum)

int	beamformer_getNormType (void *const hBeam)
	Returns the Ambisonic normalisation convention currently being usedto decode with, which should match the convention employed by the input signals (see NORM_TYPES enum)

int	beamformer_getBeamType (void *const hBeam)
	Returns the beamforming approach employed (see STATIC_BEAM_TYPES enum)

int	beamformer_getProcessingDelay (void)
	Returns the processing delay in samples (may be used for delay compensation features)

Variables
const int	beamformer_defaultNumBeams
	Default number of beams.

const float	beamformer_defaultBeamDirections [MAX_NUM_INPUTS][2]
	Default beam directions.

Detailed Description

Generates beamformers/virtual microphones in arbitrary directions with several different beam patterns to choose from.

Author: Leo McCormack

Date: 17.05.2019

License: ISC

Definition in file beamformer.h.

Function Documentation

◆ beamformer_create()

void beamformer_create ( void **const phBeam )

Creates an instance of beamformer.

Parameters

[in] phBeam (&) address of beamformer handle

Examples: beamformer.h.

Definition at line 29 of file beamformer.c.

◆ beamformer_destroy()

void beamformer_destroy ( void **const phBeam )

Destroys an instance of beamformer.

Parameters

[in] phBeam (&) address of beamformer handle

Examples: beamformer.h.

Definition at line 56 of file beamformer.c.

◆ beamformer_getBeamAzi_deg()

float beamformer_getBeamAzi_deg	(	void *const	hBeam,
		int	index )

Returns the beamformer azimuth direction of a given index h, in DEGREES.

Examples: beamformer.h.

Definition at line 285 of file beamformer.c.

◆ beamformer_getBeamElev_deg()

float beamformer_getBeamElev_deg	(	void *const	hBeam,
		int	index )

Returns the beamformer elevation direction of a given index, in DEGREES.

Examples: beamformer.h.

Definition at line 291 of file beamformer.c.

◆ beamformer_getBeamOrder()

int beamformer_getBeamOrder ( void *const hBeam )

Returns the beamforming order (see SH_ORDERS enum)

Examples: beamformer.h.

Definition at line 279 of file beamformer.c.

◆ beamformer_getBeamType()

int beamformer_getBeamType ( void *const hBeam )

Returns the beamforming approach employed (see STATIC_BEAM_TYPES enum)

Examples: beamformer.h.

Definition at line 326 of file beamformer.c.

◆ beamformer_getChOrder()

int beamformer_getChOrder ( void *const hBeam )

Returns the Ambisonic channel ordering convention currently being used to decode with, which should match the convention employed by the input signals (see CH_ORDER enum)

Examples: beamformer.h.

Definition at line 314 of file beamformer.c.

◆ beamformer_getFrameSize()

int beamformer_getFrameSize ( void )

Returns the processing framesize (i.e., number of samples processed with every _process() call )

Examples: beamformer.h.

Definition at line 274 of file beamformer.c.

◆ beamformer_getMaxNumBeams()

int beamformer_getMaxNumBeams ( void )

Returns the maximum number of beamformers permitted.

Examples: beamformer.h.

Definition at line 303 of file beamformer.c.

◆ beamformer_getNormType()

int beamformer_getNormType ( void *const hBeam )

Returns the Ambisonic normalisation convention currently being usedto decode with, which should match the convention employed by the input signals (see NORM_TYPES enum)

Examples: beamformer.h.

Definition at line 320 of file beamformer.c.

◆ beamformer_getNSHrequired()

int beamformer_getNSHrequired ( void *const hBeam )

Returns the number of spherical harmonic signals required by the currently selected beamforming order: (current_order+1)^2.

Examples: beamformer.h.

Definition at line 308 of file beamformer.c.

◆ beamformer_getNumBeams()

int beamformer_getNumBeams ( void *const hBeam )

Returns the number of beamformers being generated.

Examples: beamformer.h.

Definition at line 297 of file beamformer.c.

◆ beamformer_getProcessingDelay()

int beamformer_getProcessingDelay ( void )

Returns the processing delay in samples (may be used for delay compensation features)

Examples: beamformer.h.

Definition at line 332 of file beamformer.c.

◆ beamformer_init()

void beamformer_init	(	void *const	hBeam,
		int	samplerate )

Initialises an instance of beamformer with default settings.

Parameters

[in]	hBeam	beamformer handle
[in]	samplerate	Host samplerate.

Examples: beamformer.h.

Definition at line 71 of file beamformer.c.

◆ beamformer_process()

void beamformer_process	(	void *const	hBeam,
		const float const	inputs,
		float const	outputs,
		int	nInputs,
		int	nOutputs,
		int	nSamples )

Generates beamformers/virtual microphones in the specified directions.

Parameters

[in]	hBeam	beamformer handle
[in]	inputs	Input channel buffers; 2-D array: nInputs x nSamples
[in]	outputs	Output channel buffers; 2-D array: nOutputs x nSamples
[in]	nInputs	Number of input channels
[in]	nOutputs	Number of output channels
[in]	nSamples	Number of samples in 'inputs'/'output' matrices

Examples: beamformer.h.

Definition at line 94 of file beamformer.c.

◆ beamformer_refreshSettings()

void beamformer_refreshSettings ( void *const hBeam )

Sets all intialisation flags to 1; re-initialising all settings/variables as beamformer is currently configured, at next available opportunity.

Examples: beamformer.h.

Definition at line 196 of file beamformer.c.

◆ beamformer_setBeamAzi_deg()

void beamformer_setBeamAzi_deg	(	void *const	hBeam,
		int	index,
		float	newAzi_deg )

Sets a beamformer azimuth direction of a given index, in DEGREES.

Examples: beamformer.h.

Definition at line 218 of file beamformer.c.

◆ beamformer_setBeamElev_deg()

void beamformer_setBeamElev_deg	(	void *const	hBeam,
		int	index,
		float	newElev_deg )

Sets a beamformer elevation direction for a given index, in DEGREES.

Examples: beamformer.h.

Definition at line 229 of file beamformer.c.

◆ beamformer_setBeamOrder()

void beamformer_setBeamOrder	(	void *const	hBeam,
		int	newValue )

Sets the beamforming order (see SH_ORDERS enum)

If the beamforming order is higher than the input signal order, the extra required channels are filled with zeros. If the beamforming order is lower than the input signal order, the number input signals is truncated accordingly.

Examples: beamformer.h.

Definition at line 204 of file beamformer.c.

◆ beamformer_setBeamType()

void beamformer_setBeamType	(	void *const	hBeam,
		int	newID )

Sets the beamforming approach to employ (see STATIC_BEAM_TYPES enum)

Examples: beamformer.h.

Definition at line 263 of file beamformer.c.

◆ beamformer_setChOrder()

void beamformer_setChOrder	(	void *const	hBeam,
		int	newOrder )

Sets the Ambisonic channel ordering convention to decode with, in order to match the convention employed by the input signals (see CH_ORDER enum)

Examples: beamformer.h.

Definition at line 249 of file beamformer.c.

◆ beamformer_setNormType()

void beamformer_setNormType	(	void *const	hBeam,
		int	newType )

Sets the Ambisonic normalisation convention to decode with, in order to match with the convention employed by the input signals (see NORM_TYPES enum)

Examples: beamformer.h.

Definition at line 256 of file beamformer.c.

◆ beamformer_setNumBeams()

void beamformer_setNumBeams	(	void *const	hBeam,
		int	new_nBeams )

Sets the number of beamformers to generate.

Examples: beamformer.h.

Definition at line 238 of file beamformer.c.

Variable Documentation

◆ beamformer_defaultBeamDirections

const float beamformer_defaultBeamDirections[MAX_NUM_INPUTS][2]

extern

Default beam directions.

Definition at line 32 of file beamformer_internal.c.

◆ beamformer_defaultNumBeams

const int beamformer_defaultNumBeams

extern

Default number of beams.

Definition at line 29 of file beamformer_internal.c.

Functions

Variables

Detailed Description

Function Documentation

◆ beamformer_create()

◆ beamformer_destroy()

◆ beamformer_getBeamAzi_deg()

◆ beamformer_getBeamElev_deg()

◆ beamformer_getBeamOrder()

◆ beamformer_getBeamType()

◆ beamformer_getChOrder()

◆ beamformer_getFrameSize()

◆ beamformer_getMaxNumBeams()

◆ beamformer_getNormType()

◆ beamformer_getNSHrequired()

◆ beamformer_getNumBeams()

◆ beamformer_getProcessingDelay()

◆ beamformer_init()

◆ beamformer_process()

◆ beamformer_refreshSettings()

◆ beamformer_setBeamAzi_deg()

◆ beamformer_setBeamElev_deg()

◆ beamformer_setBeamOrder()

◆ beamformer_setBeamType()

◆ beamformer_setChOrder()

◆ beamformer_setNormType()

◆ beamformer_setNumBeams()

Variable Documentation

◆ beamformer_defaultBeamDirections

◆ beamformer_defaultNumBeams