HGain< T > Class Template Reference

#include <hgain.h>

Inheritance diagram for HGain< T >:

Collaboration diagram for HGain< T >:

Public Member Functions
	HGain (HWriter< T > *writer, float gain, size_t blocksize, HProbe< T > *probe=NULL)
	HGain (HWriterConsumer< T > *consumer, float gain, size_t blocksize, HProbe< T > *probe=NULL)
	HGain (HReader< T > *reader, float gain, size_t blocksize, HProbe< T > *probe=NULL)
	~HGain ()
virtual void	Filter (T *src, T *dest, size_t blocksize)
void	SetGain (float gain)
float	GetGain ()
Public Member Functions inherited from HFilter< T >
	~HFilter ()
int	Write (T *src, size_t blocksize)
int	Read (T *dest, size_t blocksize)
bool	Start ()
bool	Stop ()
bool	Command (HCommand *command)
void	Enable ()
void	Disable ()
bool	GetEnabled ()
Public Member Functions inherited from HObject
	HObject ()
Public Member Functions inherited from HWriter< T >
virtual	~HWriter ()=default
HWriter< T > *	Writer ()
Public Member Functions inherited from HReader< T >
virtual	~HReader ()=default
HReader< T > *	Reader ()
Public Member Functions inherited from HWriterConsumer< T >
HWriterConsumer< T > *	Consumer ()

Additional Inherited Members
Static Public Member Functions inherited from HFilter< T >
static std::vector< float >	ReadCoeffsFromFile (std::string filename)
static std::vector< float >	ReadCoeffsFromFile (char *filename)
Protected Member Functions inherited from HFilter< T >
	HFilter (HWriter< T > *writer, size_t blocksize, HProbe< T > *probe=NULL)
	HFilter (HWriterConsumer< T > *consumer, size_t blocksize, HProbe< T > *probe=NULL)
	HFilter (HReader< T > *reader, size_t blocksize, HProbe< T > *probe=NULL)
void	SetWriter (HWriter< T > *writer)
Protected Attributes inherited from HFilter< T >
int	_blocksize

Detailed Description

template<class T>
class HGain< T >

A filter providing gain (or attenuation)

Examples

network.cpp, readers_and_consumers.cpp, readers_and_writers.cpp, and saq.cpp.

Constructor & Destructor Documentation

HGain() [1/3]

template<class T >

HGain< T >::HGain	(	HWriter< T > *	writer,
		float	gain,
		size_t	blocksize,
		HProbe< T > *	probe = NULL
	)

Construct a new HGain object that writes to a writer

HGain() [2/3]

template<class T >

HGain< T >::HGain	(	HWriterConsumer< T > *	consumer,
		float	gain,
		size_t	blocksize,
		HProbe< T > *	probe = NULL
	)

Construct a new HGain object that registers with an upstream writer

HGain() [3/3]

template<class T >

HGain< T >::HGain	(	HReader< T > *	reader,
		float	gain,
		size_t	blocksize,
		HProbe< T > *	probe = NULL
	)

Construct a new HGain object that reads from a reader

~HGain()

template<class T >

HGain< T >::~HGain

Default destructor

Member Function Documentation

Filter()

template<class T >

void HGain< T >::Filter ( T *  src, T *  dest, size_t  blocksize  )

virtual

Run a block of samples through the gain filter

Implements HFilter< T >.

Reimplemented in HAgc< T >, and HFade< T >.

GetGain()

template<class T >

float HGain< T >::GetGain ( )

inline

Get gain

SetGain()

template<class T >

void HGain< T >::SetGain

(

float

gain

)

Set gain

---

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

• /home/henrik/Git/Hardt/hardt/libhardt/include/hgain.h
• /home/henrik/Git/Hardt/hardt/libhardt/filters/hgain.cpp