SPKitVocoder Documentation

# SPKitVocoder

## Users guide

SPKitVocoder does the classic vocoder effect.

Function setInput() is used for setting the carrier-signal and setModulatorInput() function for modulator-signal.
Functions setDefaultFilters() or setFilters() must be called before using setInput() function.
setDefaultFilters() uses a set of butterworth band-pass filters to generate the filter banks and it takes the minimum and maximum frequencies and the number of filters as parameters.
setFilters() lets the user supply the filterbanks. If setFilters() is used, the SPKitVocoder takes care of setting the inputs of filter objects.
Function getFilterCount() returns number of filters in use.
Audio samples are requested from SPKitVocoder with the getSample() function.

## Programmer's Reference

Defined in vocoder.h

### Public Members

int getFilterCount() { return filterCount; }
SPKitError setInput(SPKitProcessor *input);
SPKitError setModulatorInput(SPKitProcessor *modinput);
SPKitError setFilters(SPKitFilterbank *modfb, SPKitFilterbank *carfb, SPKitJoiner *joiner);
SPKitError setAnalyzers(SPKitProcessor **mod, SPKitProcessor **car);
SPKitError setDefaultFilters(SPKitFloat lowfrq, SPKitFloat highfrq, int cnt);
SPKitError setMatrix();
int getSample(SPKitSample &outputSample, SPKitProcessor *caller);
SPKitVocoder();

### Protected Members

SPKitFilterbank *modfb, *carfb;
SPKitJoiner *joiner;
SPKitProcessor **modaz, **caraz;
SPKitMult **multipliers;
SPKitProcessor *modinput, **modout, **carout, **modout2, **carout2;
int filterCount;

Return to top level

Authors: Jarno Wuolijoki, Pilvari Pirtola