Kwave::Osc Class Reference

#include <Osc.h>

Inheritance diagram for Kwave::Osc:

Collaboration diagram for Kwave::Osc:

Public Slots
void	setFrequency (const QVariant &f)
void	setPhase (const QVariant &p)
void	setAmplitude (const QVariant &a)

Signals
void	output (Kwave::SampleArray data)
Signals inherited from Kwave::StreamObject
void	attributeChanged (const QVariant value)

Public Member Functions
	Osc ()
virtual	~Osc () Q_DECL_OVERRIDE
virtual void	goOn () Q_DECL_OVERRIDE
Public Member Functions inherited from Kwave::SampleSource
	SampleSource (QObject *parent=Q_NULLPTR)
virtual	~SampleSource ()
virtual bool	done () const
Public Member Functions inherited from Kwave::StreamObject
	StreamObject (QObject *parent=Q_NULLPTR)
virtual	~StreamObject ()
virtual unsigned int	tracks () const
virtual Kwave::StreamObject *	operator[] (unsigned int track)
virtual unsigned int	tracksOfPort (const char *port) const
virtual Kwave::StreamObject *	port (const char *port, unsigned int track)
virtual unsigned int	blockSize () const
void	setAttribute (const char *attribute, const QVariant &value)

Private Attributes
Kwave::SampleArray	m_buffer
double	m_omega_t
double	m_f
double	m_a

Additional Inherited Members
Static Public Member Functions inherited from Kwave::StreamObject
static void	setInteractive (bool interactive)

Detailed Description

Definition at line 32 of file Osc.h.

Constructor & Destructor Documentation

Osc()

Kwave::Osc::Osc

(

)

Constructor

Definition at line 25 of file Osc.cpp.

    :Kwave::SampleSource(),
    m_buffer(blockSize()), m_omega_t(0.0), m_f(44.1), m_a(1.0)
{
}

~Osc()

Kwave::Osc::~Osc ( )

virtual

Destructor

Definition at line 32 of file Osc.cpp.

{
}

Member Function Documentation

goOn()

void Kwave::Osc::goOn ( )

virtual

does the calculation

Implements Kwave::SampleSource.

Definition at line 37 of file Osc.cpp.

References double2sample(), m_a, m_buffer, m_f, m_omega_t, output(), and Kwave::SampleArray::size().

Referenced by Kwave::PlayBackPlugin::run().

{
    unsigned int samples = m_buffer.size();
    const double two_pi = 2.0 * M_PI;

    Q_ASSERT(!qFuzzyIsNull(m_f));
    if (qFuzzyIsNull(m_f)) return;

    double omega = two_pi / m_f;
    for (unsigned int sample = 0; sample < samples; sample++) {
        // calculate one sample as sin(w * t)
        m_buffer[sample] = double2sample(m_a * sin(m_omega_t));

        // next time, t++
        m_omega_t += omega;

        // limit the argument of sin() to [0 ... 4*Pi]
        while (m_omega_t > two_pi)
            m_omega_t -= two_pi;
    }

    emit output(m_buffer);
}

Here is the call graph for this function:

Here is the caller graph for this function:

output

void Kwave::Osc::output ( Kwave::SampleArray  data )

signal

emits a block with sine wave data

Referenced by goOn().

Here is the caller graph for this function:

setAmplitude

void Kwave::Osc::setAmplitude ( const QVariant &  a )

slot

Sets the amplitude of the sine wave, normed to the range of [0.0 ... 1.0]. The default is 1.0.

Definition at line 74 of file Osc.cpp.

References m_a.

{
    m_a = QVariant(a).toDouble();
}

setFrequency

void Kwave::Osc::setFrequency ( const QVariant &  f )

slot

Sets the frequency of the sine wave, normed to the sample frequency. You should pass the frequency that you want, divided through the sample frequency. If you never call this, the frequency will be undefined!

Definition at line 62 of file Osc.cpp.

References m_f.

{
    m_f = QVariant(f).toDouble();
}

setPhase

void Kwave::Osc::setPhase ( const QVariant &  p )

slot

Sets the phase of the sine wave in RAD [0...2*Pi]. The default setting is zero.

Definition at line 68 of file Osc.cpp.

References m_omega_t.

{
    m_omega_t = QVariant(p).toDouble();
}

Member Data Documentation

m_a

double Kwave::Osc::m_a

private

amplitude [0...1]

Definition at line 82 of file Osc.h.

Referenced by goOn(), and setAmplitude().

m_buffer

Kwave::SampleArray Kwave::Osc::m_buffer

private

buffer for output data

Definition at line 73 of file Osc.h.

Referenced by goOn().

m_f

double Kwave::Osc::m_f

private

frequency [samples/period]

Definition at line 79 of file Osc.h.

Referenced by goOn(), and setFrequency().

m_omega_t

double Kwave::Osc::m_omega_t

private

current time multiplied by 2*Pi*f

Definition at line 76 of file Osc.h.

Referenced by goOn(), and setPhase().

---

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

• libkwave/modules/Osc.h
• libkwave/modules/Osc.cpp