CatmullRomInterpolator Class Reference

Interpolator for resampling a stream of floats using Catmull-Rom interpolation. More...

Public Member Functions

 CatmullRomInterpolator () noexcept
 
 ~CatmullRomInterpolator () noexcept
 
void reset () noexcept
 Resets the state of the interpolator. More...
 
int process (double speedRatio, const float *inputSamples, float *outputSamples, int numOutputSamplesToProduce) noexcept
 Resamples a stream of samples. More...
 
int processAdding (double speedRatio, const float *inputSamples, float *outputSamples, int numOutputSamplesToProduce, float gain) noexcept
 Resamples a stream of samples, adding the results to the output data with a gain. More...
 

Detailed Description

Interpolator for resampling a stream of floats using Catmull-Rom interpolation.

Note that the resampler is stateful, so when there's a break in the continuity of the input stream you're feeding it, you should call reset() before feeding it any new data. And like with any other stateful filter, if you're resampling multiple channels, make sure each one uses its own CatmullRomInterpolator object.

See also
LagrangeInterpolator

Constructor & Destructor Documentation

◆ CatmullRomInterpolator()

CatmullRomInterpolator::CatmullRomInterpolator ( )
noexcept

◆ ~CatmullRomInterpolator()

CatmullRomInterpolator::~CatmullRomInterpolator ( )
noexcept

Member Function Documentation

◆ reset()

void CatmullRomInterpolator::reset ( )
noexcept

Resets the state of the interpolator.

Call this when there's a break in the continuity of the input data stream.

◆ process()

int CatmullRomInterpolator::process ( double  speedRatio,
const float *  inputSamples,
float *  outputSamples,
int  numOutputSamplesToProduce 
)
noexcept

Resamples a stream of samples.

Parameters
speedRatiothe number of input samples to use for each output sample
inputSamplesthe source data to read from. This must contain at least (speedRatio * numOutputSamplesToProduce) samples.
outputSamplesthe buffer to write the results into
numOutputSamplesToProducethe number of output samples that should be created
Returns
the actual number of input samples that were used

◆ processAdding()

int CatmullRomInterpolator::processAdding ( double  speedRatio,
const float *  inputSamples,
float *  outputSamples,
int  numOutputSamplesToProduce,
float  gain 
)
noexcept

Resamples a stream of samples, adding the results to the output data with a gain.

Parameters
speedRatiothe number of input samples to use for each output sample
inputSamplesthe source data to read from. This must contain at least (speedRatio * numOutputSamplesToProduce) samples.
outputSamplesthe buffer to write the results to - the result values will be added to any pre-existing data in this buffer after being multiplied by the gain factor
numOutputSamplesToProducethe number of output samples that should be created
gaina gain factor to multiply the resulting samples by before adding them to the destination buffer
Returns
the actual number of input samples that were used

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