Audio Processing Framework (APF) version 0.5.0
Public Types | Public Member Functions | Protected Member Functions | List of all members
apf::pointer_policy< T * > Class Template Referenceabstract

interface_policy which uses plain pointers. More...

#include <apf/pointer_policy.h>

Public Types

using sample_type = T
 

Public Member Functions

void audio_callback (size_t n, T *const *in, T *const *out)
 This has to be called for each audio block. More...
 
bool activate () const
 
bool deactivate () const
 
size_t block_size () const
 
size_t sample_rate () const
 
int in_channels () const
 
int out_channels () const
 

Protected Member Functions

 pointer_policy (const parameter_map &params=parameter_map())
 

Detailed Description

template<typename T>
class apf::pointer_policy< T * >

interface_policy which uses plain pointers.

See also
MimoProcessor

Definition at line 53 of file pointer_policy.h.

Member Typedef Documentation

◆ sample_type

template<typename T >
using apf::pointer_policy< T * >::sample_type = T

Definition at line 56 of file pointer_policy.h.

Constructor & Destructor Documentation

◆ pointer_policy()

template<typename T >
apf::pointer_policy< T * >::pointer_policy ( const parameter_map params = parameter_map())
inlineexplicitprotected

Definition at line 74 of file pointer_policy.h.

Member Function Documentation

◆ audio_callback()

template<typename T >
void apf::pointer_policy< T * >::audio_callback ( size_t  n,
T *const *  in,
T *const *  out 
)

This has to be called for each audio block.

Attention
You must make sure that there is enough memory available for input and output data. Inputs and outputs can be added, but in and out must be enlarged accordingly.
Warning
in and out can only grow bigger, if inputs/outputs are removed, the corresponding pointer of in/out must remain at its place!
Parameters
nblock size
inpointer to an array of pointers to input channels
outpointer to an array of pointers to output channels

Definition at line 117 of file pointer_policy.h.

◆ activate()

template<typename T >
bool apf::pointer_policy< T * >::activate ( ) const
inline

Definition at line 64 of file pointer_policy.h.

◆ deactivate()

template<typename T >
bool apf::pointer_policy< T * >::deactivate ( ) const
inline

Definition at line 65 of file pointer_policy.h.

◆ block_size()

template<typename T >
size_t apf::pointer_policy< T * >::block_size ( ) const
inline

Definition at line 67 of file pointer_policy.h.

◆ sample_rate()

template<typename T >
size_t apf::pointer_policy< T * >::sample_rate ( ) const
inline

Definition at line 68 of file pointer_policy.h.

◆ in_channels()

template<typename T >
int apf::pointer_policy< T * >::in_channels ( ) const
inline

Definition at line 70 of file pointer_policy.h.

◆ out_channels()

template<typename T >
int apf::pointer_policy< T * >::out_channels ( ) const
inline

Definition at line 71 of file pointer_policy.h.


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