Main structure for ambi_dec. More...

#include <ambi_dec_internal.h>

Data Fields
float **	SHFrameTD
	Input spherical harmonic (SH) signals in the time-domain; MAX_NUM_SH_SIGNALS x AMBI_DEC_FRAME_SIZE.

float **	outputFrameTD
	Output loudspeaker or binaural signals in the time-domain; MAX_NUM_LOUDSPEAKERS x AMBI_DEC_FRAME_SIZE.

float_complex ***	SHframeTF
	Input spherical harmonic (SH) signals in the time-frequency domain; HYBRID_BANDS x MAX_NUM_SH_SIGNALS x TIME_SLOTS.

float_complex ***	outputframeTF
	Output loudspeaker signals in the time-frequency domain; HYBRID_BANDS x MAX_NUM_LOUDSPEAKERS x TIME_SLOTS.

float_complex ***	binframeTF
	Output binaural signals in the time-frequency domain; HYBRID_BANDS x NUM_EARS x TIME_SLOTS.

void *	hSTFT
	afSTFT handle

int	afSTFTdelay
	for host delay compensation

int	fs
	host sampling rate

float	freqVector [HYBRID_BANDS]
	frequency vector for time-frequency transform, in Hz

CODEC_STATUS	codecStatus
	see CODEC_STATUS

float	progressBar0_1
	Current (re)initialisation progress, between [0..1].

char *	progressBarText
	Current (re)initialisation step, string.

ambi_dec_codecPars *	pars
	codec parameters

int	loudpkrs_nDims
	dimensionality of the current loudspeaker set-up

int	new_nLoudpkrs
	if new_nLoudpkrs != nLoudpkrs, afSTFT is reinitialised (current value will be replaced by this after next re-init)

int	new_binauraliseLS
	if new_binauraliseLS != binauraliseLS, ambi_dec is reinitialised (current value will be replaced by this after next re-init)

int	new_masterOrder
	if new_masterOrder != masterOrder, ambi_dec is reinitialised (current value will be replaced by this after next re-init)

PROC_STATUS	procStatus
	see PROC_STATUS

int	reinit_hrtfsFLAG
	0: no init required, 1: init required

int	recalc_hrtf_interpFLAG [MAX_NUM_LOUDSPEAKERS]
	0: no init required, 1: init required

int	masterOrder
	Current maximum/master decoding order.

int	orderPerBand [HYBRID_BANDS]
	Ambisonic decoding order per frequency band 1..SH_ORDER.

AMBI_DEC_DECODING_METHODS	dec_method [NUM_DECODERS]
	decoding methods for each decoder, see AMBI_DEC_DECODING_METHODS enum

int	rE_WEIGHT [NUM_DECODERS]
	0:disabled, 1: enable max_rE weight

AMBI_DEC_DIFFUSE_FIELD_EQ_APPROACH	diffEQmode [NUM_DECODERS]
	diffuse-field EQ approach; see AMBI_DEC_DIFFUSE_FIELD_EQ_APPROACH enum

float	transitionFreq
	transition frequency for the 2 decoders, in Hz

int	nLoudpkrs
	number of loudspeakers/virtual loudspeakers

float	loudpkrs_dirs_deg [MAX_NUM_LOUDSPEAKERS][NUM_DECODERS]
	loudspeaker directions in degrees [azi, elev]

int	useDefaultHRIRsFLAG
	1: use default HRIRs in database, 0: use those from SOFA file

int	enableHRIRsPreProc
	flag to apply pre-processing to the currently loaded HRTFs

int	binauraliseLS
	1: convolve loudspeaker signals with HRTFs, 0: output loudspeaker signals

CH_ORDER	chOrdering
	Ambisonic channel order convention (see CH_ORDER)

NORM_TYPES	norm
	Ambisonic normalisation convention (see NORM_TYPES)

Detailed Description

Main structure for ambi_dec.

Contains variables for audio buffers, afSTFT, internal variables, flags, user parameters

Definition at line 127 of file ambi_dec_internal.h.

Field Documentation

◆ afSTFTdelay

int ambi_dec_data::afSTFTdelay

for host delay compensation

Definition at line 136 of file ambi_dec_internal.h.

◆ binauraliseLS

int ambi_dec_data::binauraliseLS

1: convolve loudspeaker signals with HRTFs, 0: output loudspeaker signals

Definition at line 168 of file ambi_dec_internal.h.

◆ binframeTF

float_complex*** ambi_dec_data::binframeTF

Output binaural signals in the time-frequency domain; HYBRID_BANDS x NUM_EARS x TIME_SLOTS.

Definition at line 134 of file ambi_dec_internal.h.

◆ chOrdering

CH_ORDER ambi_dec_data::chOrdering

Ambisonic channel order convention (see CH_ORDER)

Definition at line 169 of file ambi_dec_internal.h.

◆ codecStatus

CODEC_STATUS ambi_dec_data::codecStatus

see CODEC_STATUS

Definition at line 141 of file ambi_dec_internal.h.

◆ dec_method

AMBI_DEC_DECODING_METHODS ambi_dec_data::dec_method[NUM_DECODERS]

decoding methods for each decoder, see AMBI_DEC_DECODING_METHODS enum

Definition at line 160 of file ambi_dec_internal.h.

◆ diffEQmode

AMBI_DEC_DIFFUSE_FIELD_EQ_APPROACH ambi_dec_data::diffEQmode[NUM_DECODERS]

diffuse-field EQ approach; see AMBI_DEC_DIFFUSE_FIELD_EQ_APPROACH enum

Definition at line 162 of file ambi_dec_internal.h.

◆ enableHRIRsPreProc

int ambi_dec_data::enableHRIRsPreProc

flag to apply pre-processing to the currently loaded HRTFs

Definition at line 167 of file ambi_dec_internal.h.

◆ freqVector

float ambi_dec_data::freqVector[HYBRID_BANDS]

frequency vector for time-frequency transform, in Hz

Definition at line 138 of file ambi_dec_internal.h.

◆ fs

int ambi_dec_data::fs

host sampling rate

Definition at line 137 of file ambi_dec_internal.h.

◆ hSTFT

void* ambi_dec_data::hSTFT

afSTFT handle

Definition at line 135 of file ambi_dec_internal.h.

◆ loudpkrs_dirs_deg

float ambi_dec_data::loudpkrs_dirs_deg[MAX_NUM_LOUDSPEAKERS][NUM_DECODERS]

loudspeaker directions in degrees [azi, elev]

Definition at line 165 of file ambi_dec_internal.h.

◆ loudpkrs_nDims

int ambi_dec_data::loudpkrs_nDims

dimensionality of the current loudspeaker set-up

Definition at line 147 of file ambi_dec_internal.h.

◆ masterOrder

int ambi_dec_data::masterOrder

Current maximum/master decoding order.

Definition at line 158 of file ambi_dec_internal.h.

◆ new_binauraliseLS

int ambi_dec_data::new_binauraliseLS

if new_binauraliseLS != binauraliseLS, ambi_dec is reinitialised (current value will be replaced by this after next re-init)

Definition at line 149 of file ambi_dec_internal.h.

◆ new_masterOrder

int ambi_dec_data::new_masterOrder

if new_masterOrder != masterOrder, ambi_dec is reinitialised (current value will be replaced by this after next re-init)

Definition at line 150 of file ambi_dec_internal.h.

◆ new_nLoudpkrs

int ambi_dec_data::new_nLoudpkrs

if new_nLoudpkrs != nLoudpkrs, afSTFT is reinitialised (current value will be replaced by this after next re-init)

Definition at line 148 of file ambi_dec_internal.h.

◆ nLoudpkrs

int ambi_dec_data::nLoudpkrs

number of loudspeakers/virtual loudspeakers

Definition at line 164 of file ambi_dec_internal.h.

◆ norm

NORM_TYPES ambi_dec_data::norm

Ambisonic normalisation convention (see NORM_TYPES)

Definition at line 170 of file ambi_dec_internal.h.

◆ orderPerBand

int ambi_dec_data::orderPerBand[HYBRID_BANDS]

Ambisonic decoding order per frequency band 1..SH_ORDER.

Definition at line 159 of file ambi_dec_internal.h.

◆ outputFrameTD

float** ambi_dec_data::outputFrameTD

Output loudspeaker or binaural signals in the time-domain; MAX_NUM_LOUDSPEAKERS x AMBI_DEC_FRAME_SIZE.

Definition at line 131 of file ambi_dec_internal.h.

◆ outputframeTF

float_complex*** ambi_dec_data::outputframeTF

Output loudspeaker signals in the time-frequency domain; HYBRID_BANDS x MAX_NUM_LOUDSPEAKERS x TIME_SLOTS.

Definition at line 133 of file ambi_dec_internal.h.

◆ pars

ambi_dec_codecPars* ambi_dec_data::pars

codec parameters

Definition at line 144 of file ambi_dec_internal.h.

◆ procStatus

PROC_STATUS ambi_dec_data::procStatus

see PROC_STATUS

Definition at line 153 of file ambi_dec_internal.h.

◆ progressBar0_1

float ambi_dec_data::progressBar0_1

Current (re)initialisation progress, between [0..1].

Definition at line 142 of file ambi_dec_internal.h.

◆ progressBarText

char* ambi_dec_data::progressBarText

Current (re)initialisation step, string.

Definition at line 143 of file ambi_dec_internal.h.

◆ rE_WEIGHT

int ambi_dec_data::rE_WEIGHT[NUM_DECODERS]

0:disabled, 1: enable max_rE weight

Definition at line 161 of file ambi_dec_internal.h.

◆ recalc_hrtf_interpFLAG

int ambi_dec_data::recalc_hrtf_interpFLAG[MAX_NUM_LOUDSPEAKERS]

0: no init required, 1: init required

Definition at line 155 of file ambi_dec_internal.h.

◆ reinit_hrtfsFLAG

int ambi_dec_data::reinit_hrtfsFLAG

0: no init required, 1: init required

Definition at line 154 of file ambi_dec_internal.h.

◆ SHFrameTD

float** ambi_dec_data::SHFrameTD

Input spherical harmonic (SH) signals in the time-domain; MAX_NUM_SH_SIGNALS x AMBI_DEC_FRAME_SIZE.

Definition at line 130 of file ambi_dec_internal.h.

◆ SHframeTF

float_complex*** ambi_dec_data::SHframeTF

Input spherical harmonic (SH) signals in the time-frequency domain; HYBRID_BANDS x MAX_NUM_SH_SIGNALS x TIME_SLOTS.

Definition at line 132 of file ambi_dec_internal.h.

◆ transitionFreq

float ambi_dec_data::transitionFreq

transition frequency for the 2 decoders, in Hz

Definition at line 163 of file ambi_dec_internal.h.

◆ useDefaultHRIRsFLAG

int ambi_dec_data::useDefaultHRIRsFLAG

1: use default HRIRs in database, 0: use those from SOFA file

Definition at line 166 of file ambi_dec_internal.h.

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

examples/src/ambi_dec/ambi_dec_internal.h

Data Fields