Beatmup::Audio::HarmonicSource Class Reference

A Source producing a sinusoidal signal, mainly for test purposes. More...

#include <source.h>

Inheritance diagram for Beatmup::Audio::HarmonicSource:

Public Member Functions
	HarmonicSource ()
void	setFrequency (float hz)
float	getFrequency () const
void	setPhase (float radians)
float	getPhase () const
void	setAmplitude (float amp)
float	getAmplitude () const
void	prepare (const dtime sampleRate, const AudioSampleFormat sampleFormat, const unsigned char numChannels, const dtime maxBufferLen)
	Prepares a source to render audio data. More...
void	render (TaskThread &thread, sample8 *buffer, const dtime bufferLength)
	Renders audio data to the target output buffer given by the user. More...
void	setClock (dtime time)
	Called by the source user when an abrupt time change occurs (e.g., due to seeking) More...
Public Member Functions inherited from Beatmup::Audio::Source
virtual	~Source ()
virtual ThreadIndex	getMaxThreads ()
	Returns the maximum number of working threads for rendering from this source. More...

Private Attributes
AudioSampleFormat	sampleFormat
dtime	sampleRate
dtime	time
float	amplitude
float	frequency
float	phase
unsigned char	numChannels

Detailed Description

A Source producing a sinusoidal signal, mainly for test purposes.

Definition at line 86 of file source.h.

Constructor & Destructor Documentation

HarmonicSource()

Beatmup::Audio::HarmonicSource::HarmonicSource ( )

inline

Definition at line 93 of file source.h.

: amplitude(0.05), frequency(800), phase(0) {}

Member Function Documentation

setFrequency()

void Beatmup::Audio::HarmonicSource::setFrequency ( float  hz )

inline

Definition at line 95 of file source.h.

{ frequency = hz; }

getFrequency()

float Beatmup::Audio::HarmonicSource::getFrequency ( ) const

inline

Definition at line 96 of file source.h.

{ return frequency; }

setPhase()

void Beatmup::Audio::HarmonicSource::setPhase ( float  radians )

inline

Definition at line 98 of file source.h.

{ phase = radians; }

getPhase()

float Beatmup::Audio::HarmonicSource::getPhase ( ) const

inline

Definition at line 99 of file source.h.

{ return phase; }

setAmplitude()

void Beatmup::Audio::HarmonicSource::setAmplitude ( float  amp )

inline

Definition at line 101 of file source.h.

{ this->amplitude = amp; }

getAmplitude()

float Beatmup::Audio::HarmonicSource::getAmplitude ( ) const

inline

Definition at line 102 of file source.h.

{ return amplitude; }

prepare()

void HarmonicSource::prepare ( const dtime  sampleRate, const AudioSampleFormat  sampleFormat, const unsigned char  numChannels, const dtime  maxBufferLen  )

virtual

Prepares a source to render audio data.

Called by the user before any rendering to communicate the configuration of the upcoming rendering process.

Parameters

sampleRate	The output sample rate in Hz
sampleFormat	The output sample format
numChannels	Number of channels in the output
maxBufferLen	Maximum expected length of target audio buffers on rendering phase, in samples per one channel

Implements Beatmup::Audio::Source.

Definition at line 57 of file source.cpp.

{
    this->sampleFormat = sampleFormat;
    this->sampleRate = sampleRate;
    this->numChannels = numChannels;
}

render()

void HarmonicSource::render ( TaskThread &  thread, sample8 *  buffer, const dtime  bufferLength  )

virtual

Renders audio data to the target output buffer given by the user.

Called after at least one call to prepare(). The sampling parameters must match the ones communicated on the preparation phase. The requested buffer length does not exceed the one set before. The time is given by the clock set before, and with every call it advances by {bufferLength} samples.

Parameters

thread	the task thread issuing this rendering call
buffer	a pointer to the beginning of a channelwise-multiplexed output buffer
bufferLength	the requested buffer length, in samples per single channel

Implements Beatmup::Audio::Source.

Definition at line 69 of file source.cpp.

                                                                                         {
    BEATMUP_DEBUG_I("FILLING BUFFER OF %d SAMPLES at time %d", bufferLength, time);
    switch (sampleFormat) {
        case Int8:
            fillSin<sample8>(buffer, time, bufferLength, amplitude, frequency, phase, sampleRate, numChannels, 127);
            break;
 
        case Int16:
            fillSin<sample16>(buffer, time, bufferLength, amplitude, frequency, phase, sampleRate, numChannels, 0x7FFF);
            break;
 
        case Int32:
            fillSin<sample32>(buffer, time, bufferLength, amplitude, frequency, phase, sampleRate, numChannels, 0x7FFFFFFF);
            break;
 
        case Float32:
            fillSin<sample32f>(buffer, time, bufferLength, amplitude, frequency, phase, sampleRate, numChannels, 1);
            break;
 
        default:
            Insanity::insanity("Unsupported sample format");
    }
    time += bufferLength;
}

setClock()

void HarmonicSource::setClock ( dtime  time )

virtual

Called by the source user when an abrupt time change occurs (e.g., due to seeking)

Reimplemented from Beatmup::Audio::Source.

Definition at line 95 of file source.cpp.

                                        {
    this->time = time;
}

Member Data Documentation

sampleFormat

AudioSampleFormat Beatmup::Audio::HarmonicSource::sampleFormat

private

Definition at line 88 of file source.h.

sampleRate

dtime Beatmup::Audio::HarmonicSource::sampleRate

private

Definition at line 89 of file source.h.

time

dtime Beatmup::Audio::HarmonicSource::time

private

Definition at line 89 of file source.h.

amplitude

float Beatmup::Audio::HarmonicSource::amplitude

private

Definition at line 90 of file source.h.

frequency

float Beatmup::Audio::HarmonicSource::frequency

private

Definition at line 90 of file source.h.

phase

float Beatmup::Audio::HarmonicSource::phase

private

Definition at line 90 of file source.h.

numChannels

unsigned char Beatmup::Audio::HarmonicSource::numChannels

private

Definition at line 91 of file source.h.

---

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

• core/audio/source.h
• core/audio/source.cpp