Waveform Class Reference

Please document me. More...

#include <Waveform.h>

Inheritance diagram for Waveform:

[legend]

Collaboration diagram for Waveform:

[legend]

List of all members.

Public Types
Public Member Functions
void	SetAmplitude (float p)
void	SetFrequency (float p)
void	SetOffset (float p)
void	SetPhase (float p)
	Waveform (WaveType t)
	~Waveform ()
Protected Member Functions
float	CalcWave (float t)
void	Process (jack_nframes_t count)
Private Attributes
float	m_amplitude
float	m_freq
float	m_last_time
float	m_offset
float	m_phase
float	m_time
WaveType	m_wavetype

---

Detailed Description

Please document me.

Definition at line 14 of file Waveform.h.

---

Member Enumeration Documentation

enum Waveform::WaveType

Enumerator:

W_SIN
W_TRI
W_SAW
W_RSAW
W_SQU

Definition at line 17 of file Waveform.h.

        {
            W_SIN,
            W_TRI,
            W_SAW,
            W_RSAW,
            W_SQU
        };

---

Constructor & Destructor Documentation

Waveform::Waveform

(

Waveform::WaveType

t

)

Definition at line 7 of file Waveform.cpp.

                                     : 
    ISoundSource(), 
    m_wavetype(t),
    m_phase(0),
    m_freq(1),
    m_offset(0),
    m_amplitude(1)
{
}

Waveform::~Waveform

(

)

Definition at line 17 of file Waveform.cpp.

{
}

---

Member Function Documentation

float Waveform::CalcWave

(

float

t

)

[protected]

Definition at line 40 of file Waveform.cpp.

References m_wavetype, W_RSAW, W_SAW, W_SIN, W_SQU, and W_TRI.

Referenced by Process().

{
    //cout << "Waveform for time position " << t << endl;
    float ret;
    switch (m_wavetype) {
        case W_SIN:
            ret = sin(t * 6.283);
            break;
        case W_TRI:
            ret = abs(0.5 - t);
            break;
        case W_SAW:
            ret = t;
            break;
        case W_RSAW:
            ret = 1 - t;
            break;
        case W_SQU:
            ret = t > 0.5;
            break;
        default:
            ret = 0;
    }
    return ret;
}

void Waveform::Process

(

jack_nframes_t

count

)

[protected, virtual]

Reimplemented from ISoundSource.

Definition at line 21 of file Waveform.cpp.

References CalcWave(), ISoundElement::GetPipe(), SoundFrame::GetSamples(), JackClient::GetSingleton(), m_amplitude, m_freq, m_offset, m_phase, and m_time.

{
    ISoundSource::Process(count);

    float samplelength = 4.0f / jack_get_sample_rate(JackClient::GetSingleton()->GetClient());
    for (unsigned int x = 0; x < count; ++x) {
        GetPipe().GetSamples()[x] = (
                CalcWave(
                        fmod(m_time + m_phase, 1.0f)
                    )
                + m_offset)
            * m_amplitude;
        m_time += samplelength * m_freq;
        while (m_time > 1) {
            m_time -= 1;
        }
    }
}

void Waveform::SetAmplitude

(

float

p

)

[inline]

Definition at line 35 of file Waveform.h.

References m_amplitude.

Referenced by BOOST_PYTHON_MODULE().

{ m_amplitude = p; }

void Waveform::SetFrequency

(

float

p

)

[inline]

Definition at line 34 of file Waveform.h.

References m_freq.

Referenced by BOOST_PYTHON_MODULE().

{ m_freq = p; }

void Waveform::SetOffset

(

float

p

)

[inline]

Definition at line 36 of file Waveform.h.

References m_offset.

Referenced by BOOST_PYTHON_MODULE().

{ m_offset = p; }

void Waveform::SetPhase

(

float

p

)

[inline]

Definition at line 37 of file Waveform.h.

References m_phase.

Referenced by BOOST_PYTHON_MODULE().

{ m_phase = p; }

---

Member Data Documentation

float Waveform::m_amplitude [private]

Definition at line 52 of file Waveform.h.

Referenced by Process(), and SetAmplitude().

float Waveform::m_freq [private]

Definition at line 51 of file Waveform.h.

Referenced by Process(), and SetFrequency().

float Waveform::m_last_time [private]

Definition at line 49 of file Waveform.h.

float Waveform::m_offset [private]

Definition at line 53 of file Waveform.h.

Referenced by Process(), and SetOffset().

float Waveform::m_phase [private]

Definition at line 54 of file Waveform.h.

Referenced by Process(), and SetPhase().

float Waveform::m_time [private]

Definition at line 48 of file Waveform.h.

Referenced by Process().

WaveType Waveform::m_wavetype [private]

Definition at line 46 of file Waveform.h.

Referenced by CalcWave().

---

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

• Waveform.h
• Waveform.cpp