tklb::ConvolverRefTpl< T > Class Template Reference

Wraps up the FttConvolver to support type conversion. More...

#include <TConvolverRef.hpp>

Collaboration diagram for tklb::ConvolverRefTpl< T >:

Public Member Functions
	ConvolverRefTpl ()=default
template<typename T2 >
void	load (const AudioBufferTpl< T2 > &ir, const Size blockSize)
	Load a impulse response and prepare the convolution. More...
template<typename T2 >
void	process (const AudioBufferTpl< T2 > &in, AudioBufferTpl< T2 > &out)
	Do the convolution. More...

Static Public Member Functions
static const char *	getLicense ()

Private Types
using	Buffer = AudioBufferTpl< T >
using	uchar = unsigned char
using	Size = typename Buffer::Size

Private Attributes
fftconvolver::FFTConvolver	mConvolvers [AudioBufferTpl< T >::MAX_CHANNELS]
AudioBufferTpl< fftconvolver::Sample >	mConversion
Size	mBlockSize
uchar	mIrChannels = 0

Detailed Description

template<typename T>
class tklb::ConvolverRefTpl< T >

Wraps up the FttConvolver to support type conversion.

Definition at line 20 of file TConvolverRef.hpp.

Member Typedef Documentation

Buffer

template<typename T >

using tklb::ConvolverRefTpl< T >::Buffer = AudioBufferTpl<T>

private

Definition at line 21 of file TConvolverRef.hpp.

Size

template<typename T >

using tklb::ConvolverRefTpl< T >::Size = typename Buffer::Size

private

Definition at line 23 of file TConvolverRef.hpp.

uchar

template<typename T >

using tklb::ConvolverRefTpl< T >::uchar = unsigned char

private

Definition at line 22 of file TConvolverRef.hpp.

Constructor & Destructor Documentation

ConvolverRefTpl()

template<typename T >

tklb::ConvolverRefTpl< T >::ConvolverRefTpl ( )

default

Member Function Documentation

getLicense()

template<typename T >

static const char * tklb::ConvolverRefTpl< T >::getLicense ( )

inlinestatic

Definition at line 109 of file TConvolverRef.hpp.

                                        {
            return
                "Realtime Convolution by\n"
                "https://github.com/HiFi-LoFi\n"
                "https://github.com/HiFi-LoFi/FFTConvolver\n"
                "MIT License\n\n";
        }

load()

template<typename T >

template<typename T2 >

void tklb::ConvolverRefTpl< T >::load ( const AudioBufferTpl< T2 > &  ir, const Size  blockSize  )

inline

Load a impulse response and prepare the convolution.

Parameters

buffer	The ir buffer.
channel	Which channel to use from the AudioBuffer
blockSize	Size of blocks ir will be divided in

Definition at line 41 of file TConvolverRef.hpp.

                                                                      {
            // trim silence, since longer IRs increase CPU usage considerably
            Size irLength = ir.size();
            if (irLength == 0) { return; }
            const T2 silence = 0.0001;
 
            for (Size i = irLength - 1; 0 < i; i--) {
                for (uchar c = 0; c < ir.channels(); c++) {
                    if (silence < fabs(ir[c][i])) {
                        // if any of the channels are over the
                        // silence threshold we use the current
                        // size and bail
                        irLength = i + 1;
                        goto endLoop;
                    }
                }
            }
        endLoop:
            mIrChannels = ir.channels();
            mBlockSize = blockSize;
 
            if (std::is_same<T2, fftconvolver::Sample>::value) {
                for (uchar c = 0; c < mIrChannels; c++) {
                    auto buffer = reinterpret_cast<const fftconvolver::Sample*>(ir[c]);
                    mConvolvers[c].init(blockSize, buffer, irLength);
                }
            } else {
                mConversion.clone(ir);
                for (uchar c = 0; c < mIrChannels; c++) {
                    mConvolvers[c].init(blockSize, mConversion[c], irLength);
                }
            }
 
            mConversion.resize(blockSize); // in case we need to convert
        }

Here is the call graph for this function:

process()

template<typename T >

template<typename T2 >

void tklb::ConvolverRefTpl< T >::process ( const AudioBufferTpl< T2 > &  in, AudioBufferTpl< T2 > &  out  )

inline

Do the convolution.

Parameters

in	Input signal, can be mono
out	Output buffer, needs to have enough space allocated

Definition at line 83 of file TConvolverRef.hpp.

                                                                            {
            const Size length = in.validSize();
            const Size n = out.size();
            Size samplesLeft = n;
 
            for (Size i = 0; i < length; i += mBlockSize) {
                const Size remaining = std::min(mBlockSize, samplesLeft);
                for (uchar c = 0; c < out.channels(); c++) {
                    // eg the input is mono, but the IR stereo
                    // the result will still be stereo
                    const uchar inChannel = c % in.channels();
                    // TODO tklb the convolver channels can't be crossed
                    // so each output needds its own convolver
                    if (std::is_same<T2, fftconvolver::Sample>::value) {
                        auto inBuf = reinterpret_cast<const fftconvolver::Sample*>(in[inChannel] + i);
                        auto outBuf = reinterpret_cast<fftconvolver::Sample*>(out[c] + i);
                        mConvolvers[c].process(inBuf, outBuf, remaining);
                    } else {
                        // TODO tklb conversion
                    }
 
                }
                samplesLeft -= remaining;
            }
        }

Here is the call graph for this function:

Member Data Documentation

mBlockSize

template<typename T >

Size tklb::ConvolverRefTpl< T >::mBlockSize

private

Definition at line 28 of file TConvolverRef.hpp.

mConversion

template<typename T >

AudioBufferTpl<fftconvolver::Sample> tklb::ConvolverRefTpl< T >::mConversion

private

Definition at line 27 of file TConvolverRef.hpp.

mConvolvers

template<typename T >

fftconvolver::FFTConvolver tklb::ConvolverRefTpl< T >::mConvolvers[AudioBufferTpl< T >::MAX_CHANNELS]

private

Definition at line 25 of file TConvolverRef.hpp.

mIrChannels

template<typename T >

uchar tklb::ConvolverRefTpl< T >::mIrChannels = 0

private

Definition at line 29 of file TConvolverRef.hpp.

---

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

• TConvolverRef.hpp