#include <TResamplerSpeex.hpp>

Inheritance diagram for tklb::ResamplerSpeexTpl< T, Buffer >:

Collaboration diagram for tklb::ResamplerSpeexTpl< T, Buffer >:

Public Member Functions
	ResamplerSpeexTpl (uint rateIn, uint rateOut, uint maxBlock=512, uchar quality=5)

	ResamplerSpeexTpl ()=default

	~ResamplerSpeexTpl ()

bool	init (uint rateIn, uint rateOut, uint maxBlock=512, uchar maxChannels=2, uchar quality=5)
	setup the resampler More...

Size	process (const Buffer &in, Buffer &out)
	Resample function Make sure the out buffer has enough space. More...

int	getLatency () const
	Get the latency in samples. More...

Size	estimateNeed (const Size out) const
	Estimate how many samples need to be put in to get n samples out. More...

Size	estimateOut (const Size in) const
	Estimate how many sample will be emitted in the next step. More...

bool	isInitialized () const

Size	calculateBufferSize (Size initialSize)
	Calculate a buffersize fit for the resampled result. More...

Static Public Member Functions
static void	resample (Buffer &buffer, const uint rateOut, const uchar quality=5)
	Resamples the provided buffer from its sampleRate to the target rate. More...

Private Types
using	uchar = unsigned char

using	uint = unsigned int

using	Size = typename Buffer::Size

Private Attributes
uint	mRateIn

uint	mRateOut

AudioBufferFloat	mConvertOut

AudioBufferFloat	mConvertIn

SpeexResamplerState *	mState = nullptr

Detailed Description

template<typename T, class Buffer = AudioBufferTpl<T>>
class tklb::ResamplerSpeexTpl< T, Buffer >

Definition at line 45 of file TResamplerSpeex.hpp.

Member Typedef Documentation

◆ Size

template<typename T , class Buffer = AudioBufferTpl<T>>

using tklb::ResamplerSpeexTpl< T, Buffer >::Size = typename Buffer::Size

private

Definition at line 48 of file TResamplerSpeex.hpp.

◆ uchar

template<typename T , class Buffer = AudioBufferTpl<T>>

using tklb::ResamplerSpeexTpl< T, Buffer >::uchar = unsigned char

private

Definition at line 46 of file TResamplerSpeex.hpp.

◆ uint

template<typename T , class Buffer = AudioBufferTpl<T>>

using tklb::ResamplerSpeexTpl< T, Buffer >::uint = unsigned int

private

Definition at line 47 of file TResamplerSpeex.hpp.

Constructor & Destructor Documentation

◆ ResamplerSpeexTpl() [1/2]

template<typename T , class Buffer = AudioBufferTpl<T>>

tklb::ResamplerSpeexTpl< T, Buffer >::ResamplerSpeexTpl	(	uint	rateIn,
		uint	rateOut,
		uint	maxBlock = `512`,
		uchar	quality = `5`
	)

inline

Definition at line 55 of file TResamplerSpeex.hpp.

                                                                                             {
            init(rateIn, rateOut, maxBlock, quality);
        }

Here is the call graph for this function:

◆ ResamplerSpeexTpl() [2/2]

template<typename T , class Buffer = AudioBufferTpl<T>>

tklb::ResamplerSpeexTpl< T, Buffer >::ResamplerSpeexTpl ( )

default

◆ ~ResamplerSpeexTpl()

template<typename T , class Buffer = AudioBufferTpl<T>>

tklb::ResamplerSpeexTpl< T, Buffer >::~ResamplerSpeexTpl ( )

inline

Definition at line 61 of file TResamplerSpeex.hpp.

                             {
            if (mState == nullptr) { return; }
            speex_resampler_destroy(mState);
        }

Member Function Documentation

◆ calculateBufferSize()

template<typename T , class Buffer = AudioBufferTpl<T>>

Size tklb::ResamplerSpeexTpl< T, Buffer >::calculateBufferSize ( Size initialSize )

inline

Calculate a buffersize fit for the resampled result.

Also adds a bit of padding.

Definition at line 174 of file TResamplerSpeex.hpp.

                                                   {
            return estimateOut(initialSize) + 10;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ estimateNeed()

template<typename T , class Buffer = AudioBufferTpl<T>>

Size tklb::ResamplerSpeexTpl< T, Buffer >::estimateNeed ( const Size out ) const

inline

Estimate how many samples need to be put in to get n samples out.

Definition at line 156 of file TResamplerSpeex.hpp.

                                                {
            return Size(std::floor(out * (double(mRateIn) / double(mRateOut))));
        }

Here is the caller graph for this function:

◆ estimateOut()

template<typename T , class Buffer = AudioBufferTpl<T>>

Size tklb::ResamplerSpeexTpl< T, Buffer >::estimateOut ( const Size in ) const

inline

Estimate how many sample will be emitted in the next step.

Definition at line 163 of file TResamplerSpeex.hpp.

                                              {
            TKLB_ASSERT(0 < mRateOut && 0 < mRateIn)
            return (Size) std::round(in * (double(mRateOut) / double(mRateIn)));
        }

Here is the caller graph for this function:

◆ getLatency()

template<typename T , class Buffer = AudioBufferTpl<T>>

int tklb::ResamplerSpeexTpl< T, Buffer >::getLatency ( ) const

inline

Get the latency in samples.

Definition at line 149 of file TResamplerSpeex.hpp.

                               {
            return speex_resampler_get_input_latency(mState);
        }

◆ init()

template<typename T , class Buffer = AudioBufferTpl<T>>

bool tklb::ResamplerSpeexTpl< T, Buffer >::init	(	uint	rateIn,
		uint	rateOut,
		uint	maxBlock = `512`,
		uchar	maxChannels = `2`,
		uchar	quality = `5`
	)

inline

setup the resampler

Parameters

rateIn	Input sample rate
rateOut	Desired output samplerate
maxBlock	The maximum blocksize beeing passed into process(). Only relevant when doing non float resampling to allocate space for the conversion buffers
quality	Quality factor from 1-10. Higher results in better quality and higher CPU usage. Depending on implementataion may not do anything.

Returns: True on success

Definition at line 76 of file TResamplerSpeex.hpp.

                                                                                                            {
            int err;
            if (rateIn == mRateIn && mRateOut == rateOut && mState != nullptr) {
                // only clears out old data
                speex_resampler_reset_mem(mState);
            } else {
                if (mState != nullptr) {
                    speex_resampler_destroy(mState);
                }
                mState = speex_resampler_init(maxChannels, rateIn, rateOut, quality, &err);
            }
 
            mRateIn = rateIn;
            mRateOut = rateOut;
            // Conversion buffers if not doing float resampling
            if (!std::is_same<T, float>::value) {
                mConvertIn.resize(maxBlock, maxChannels);
                mConvertOut.resize(calculateBufferSize(maxBlock), maxChannels);
            }
            return err == 0;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isInitialized()

template<typename T , class Buffer = AudioBufferTpl<T>>

bool tklb::ResamplerSpeexTpl< T, Buffer >::isInitialized ( ) const

inline

Definition at line 168 of file TResamplerSpeex.hpp.

168{ return mState != nullptr; }

Here is the caller graph for this function:

◆ process()

template<typename T , class Buffer = AudioBufferTpl<T>>

Size tklb::ResamplerSpeexTpl< T, Buffer >::process	(	const Buffer &	in,
		Buffer &	out
	)

inline

Resample function Make sure the out buffer has enough space.

Definition at line 102 of file TResamplerSpeex.hpp.

                                                    {
            TKLB_ASSERT(in.sampleRate == mRateIn);
            TKLB_ASSERT(out.sampleRate == mRateOut);
            TKLB_ASSERT(in.validSize() > 0)
            TKLB_ASSERT(estimateOut(in.validSize()) <= out.size())
            Size samplesOut = 0;
            if (std::is_same<T, float>::value) {
                // Input output buffer must not overlap when working directly on them
                TKLB_ASSERT(&in != &out)
                for (uchar c = 0; c < in.channels(); c++) {
                    spx_uint32_t countIn = in.validSize();
                    spx_uint32_t countOut = out.size();
                    const float* inBuf = reinterpret_cast<const float*>(in[c]);
                    float* outBuf = reinterpret_cast<float*>(out[c]);
                    speex_resampler_process_float(mState, c, inBuf, &countIn, outBuf, &countOut);
                    samplesOut = countOut;
                }
            } else {
                const Size validSamples = in.validSize();
                const Size blockSize = mConvertIn.size();
                for (Size i = 0; i < validSamples; i += blockSize) {
                    const Size blockLeft = min(blockSize, validSamples - i);
                    Size samplesEmitted = 0;
                    mConvertIn.set(in, blockLeft, i);
                    for (uchar c = 0; c < in.channels(); c++) {
                        spx_uint32_t countIn = blockLeft;
                        spx_uint32_t countOut = mConvertOut.size();
                        const float* inBuf = mConvertIn[c];
                        float* outBuf = mConvertOut[c];
                        speex_resampler_process_float(mState, c, inBuf, &countIn, outBuf, &countOut);
                        samplesEmitted = countOut;
                        TKLB_ASSERT(mConvertOut.size() >= countOut);
                    }
                    out.set(mConvertOut, samplesEmitted, 0, samplesOut);
                    samplesOut += samplesEmitted;
                }
            }
 
            // There might be some more samples beeing emitted, some padding is needed
            TKLB_ASSERT(out.size() >= samplesOut);
            out.setValidSize(samplesOut);
            return samplesOut;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resample()

template<typename T , class Buffer = AudioBufferTpl<T>>

static void tklb::ResamplerSpeexTpl< T, Buffer >::resample	(	Buffer &	buffer,
		const uint	rateOut,
		const uchar	quality = `5`
	)

inlinestatic

Resamples the provided buffer from its sampleRate to the target rate.

Parameters

buffer	Audiobuffer to resample, set the rate of the buffer object
rateOut	Desired output samplerate in Hz
quality	Quality from 1-10

Definition at line 185 of file TResamplerSpeex.hpp.

                                                                                          {
            // TODO tklb compensate delay
            const uint rateIn = buffer.sampleRate;
            const Size samples = buffer.size();
            TKLB_ASSERT(rateIn > 0)
            // Make a copy, this could be skipped when a conversion to float is needed anyways
            Buffer copy;
            copy.resize(buffer);
            copy.set(buffer);
            copy.sampleRate = rateIn;
            buffer.sampleRate = rateOut;
            copy.setValidSize(samples);
 
            ResamplerSpeexTpl<T, Buffer> resampler;
            resampler.init(rateIn, rateOut, copy.size(), buffer.channels(), quality);
            buffer.resize(resampler.calculateBufferSize(samples));
 
            resampler.process(copy, buffer);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ mConvertIn

template<typename T , class Buffer = AudioBufferTpl<T>>

AudioBufferFloat tklb::ResamplerSpeexTpl< T, Buffer >::mConvertIn

private

Definition at line 51 of file TResamplerSpeex.hpp.

◆ mConvertOut

template<typename T , class Buffer = AudioBufferTpl<T>>

AudioBufferFloat tklb::ResamplerSpeexTpl< T, Buffer >::mConvertOut

private

Definition at line 51 of file TResamplerSpeex.hpp.

◆ mRateIn

template<typename T , class Buffer = AudioBufferTpl<T>>

uint tklb::ResamplerSpeexTpl< T, Buffer >::mRateIn

private

Definition at line 50 of file TResamplerSpeex.hpp.

◆ mRateOut

template<typename T , class Buffer = AudioBufferTpl<T>>

uint tklb::ResamplerSpeexTpl< T, Buffer >::mRateOut

private

Definition at line 50 of file TResamplerSpeex.hpp.

◆ mState

template<typename T , class Buffer = AudioBufferTpl<T>>

SpeexResamplerState* tklb::ResamplerSpeexTpl< T, Buffer >::mState = nullptr

private

Definition at line 52 of file TResamplerSpeex.hpp.

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

TResamplerSpeex.hpp

Public Member Functions

Static Public Member Functions

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Size

◆ uchar

◆ uint

Constructor & Destructor Documentation

◆ ResamplerSpeexTpl() [1/2]

◆ ResamplerSpeexTpl() [2/2]

◆ ~ResamplerSpeexTpl()

Member Function Documentation

◆ calculateBufferSize()

◆ estimateNeed()

◆ estimateOut()

◆ getLatency()

◆ init()

◆ isInitialized()

◆ process()

◆ resample()

Member Data Documentation

◆ mConvertIn

◆ mConvertOut

◆ mRateIn

◆ mRateOut

◆ mState