VVSDK  1.0
The VVAmbisonic Library
Public Member Functions | List of all members
VVAmbisonic::VVTetra Class Reference

#include <VVAmbisonic.h>

Inheritance diagram for VVAmbisonic::VVTetra:
VVAmbisonic::VVPlugin

Public Member Functions

 VVTetra (long sampleRate, const char *calibrationFilePath)
 
 ~VVTetra ()
 
int setProgram (int program)
 
int setProgram (const char *programName)
 
void getCurProgramName (char *programName)
 
void setAmbiFormat (int fmt)
 
void setAddressMode (int mode)
 
bool canProcess ()
 
void process (float **inBufs, float **outBufs, long numSamples)
 
void generateImpulses (int blockSize, float **output)
 
- Public Member Functions inherited from VVAmbisonic::VVPlugin
 VVPlugin (long sampleRate)
 
virtual ~VVPlugin ()
 

Detailed Description

Ambisonic Encoder. Converts the output of a tetrahedral microphone into B-Format using calibrations specific to each mic.

Constructor & Destructor Documentation

VVAmbisonic::VVTetra::VVTetra ( long  sampleRate,
const char *  calibrationFilePath 
)

Constructor

Parameters
sampleRatesamples per second
calibrationFilePathWill use default locations if NULL or empty.
VVAmbisonic::VVTetra::~VVTetra ( )

Destructor

Member Function Documentation

bool VVAmbisonic::VVTetra::canProcess ( )
virtual

Checks that the selected calibration has filters for the current sampling rate.

Returns
true if filters are correct

Implements VVAmbisonic::VVPlugin.

void VVAmbisonic::VVTetra::generateImpulses ( int  blockSize,
float **  output 
)

generate impulses for a matrix style calibration for the current sampling rate

Parameters
blockSizesize of FFT to use
**outputpointer to list of pointers to output buffers
void VVAmbisonic::VVTetra::getCurProgramName ( char *  programName)

Returns the name of the currently selected program.

Parameters
programNamechar array to return name into
void VVAmbisonic::VVTetra::process ( float **  inBufs,
float **  outBufs,
long  numSamples 
)
virtual

Processes blocks of audio.

Parameters
**inBufspointer to a list of pointers to the input buffers
**outBufspointer to a list of pointers to the output buffers. Can be the same as the input buffers
numSamplesthe number of sampleFrames to process

Implements VVAmbisonic::VVPlugin.

void VVAmbisonic::VVTetra::setAddressMode ( int  mode)

Sets the address mode.

Parameters
mode0 - normal, 1 - endfire, 2 - inverted, 3 - inverted endfire
void VVAmbisonic::VVTetra::setAmbiFormat ( int  fmt)
virtual

Sets the ambisonic format.

Parameters
fmt0 for FuMa, 1 for ACNSN3D

Implements VVAmbisonic::VVPlugin.

int VVAmbisonic::VVTetra::setProgram ( int  program)

Selects one of the available programs by number.

Returns
-1 if not valid.
Parameters
programprogram number to select
int VVAmbisonic::VVTetra::setProgram ( const char *  programName)

Selects one of the available programs by name. Usually a TetraMic serial number like 2003.

Returns
-1 if not found
Parameters
programNameprogram to select

The documentation for this class was generated from the following files: