arduino-audio-tools
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
PinkNoiseGenerator< T > Class Template Reference

Generates pink noise. More...

#include <SoundGenerator.h>

Inheritance diagram for PinkNoiseGenerator< T >:
SoundGenerator< T >

Public Member Functions

 PinkNoiseGenerator (T amplitude=32767)
 the amplitude defines the max value which is generated
 
virtual AudioInfo audioInfo ()
 Provides the AudioInfo.
 
virtual bool begin ()
 
virtual bool begin (AudioInfo info)
 
virtual AudioInfo defaultConfig ()
 Provides the default configuration.
 
virtual void end ()
 ends the processing
 
virtual bool isActive ()
 
virtual size_t readBytes (uint8_t *buffer, size_t lengthBytes)
 Provides the data as byte array with the requested number of channels.
 
readSample ()
 Provides a single sample.
 
virtual void setAudioInfo (AudioInfo info)
 Defines/updates the AudioInfo.
 
virtual void setFrequency (float frequency)
 Abstract method: not implemented! Just provides an error message...
 

Protected Member Functions

size_t readBytesFrames (uint8_t *buffer, size_t lengthBytes, int frames, int channels)
 
size_t readBytesFromBuffer (uint8_t *buffer, size_t lengthBytes, int frame_size, int channels)
 

Protected Attributes

bool active = false
 
bool activeWarningIssued = false
 
unsigned int amplitude
 
AudioInfo info
 
key
 
max_key
 
RingBuffer< uint8_t > ring_buffer {0}
 
unsigned int white_values [5]
 

Detailed Description

template<class T>
class audio_tools::PinkNoiseGenerator< T >

Generates pink noise.

Author
Phil Schatzmann

Member Function Documentation

◆ isActive()

virtual bool isActive ( )
inlinevirtualinherited

Checks if the begin method has been called - after end() isActive returns false


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