SoundFrame Class Reference

Please document me. More...

#include <SoundFrame.h>

List of all members.

Public Member Functions
jack_time_t	FrameTime ()
jack_default_audio_sample_t *	GetSamples () const
SoundFrame &	operator*= (float scalar)
SoundFrame &	operator*= (const SoundFrame &f)
SoundFrame &	operator+= (const SoundFrame &f)
SoundFrame &	operator= (const SoundFrame &f)
jack_nframes_t	SampleCount () const
jack_time_t	SampleTime (jack_nframes_t offset)
void	Set (jack_default_audio_sample_t *data, jack_nframes_t count)
void	Set (jack_nframes_t count)
void	Set (const SoundFrame &f)
void	Set ()
	SoundFrame (jack_default_audio_sample_t *data, jack_nframes_t count)
	SoundFrame (jack_nframes_t count)
	SoundFrame ()
void	Zero ()
	~SoundFrame ()
Private Attributes
bool	m_mallocd
jack_nframes_t	m_samplecount
jack_default_audio_sample_t *	m_samples

---

Detailed Description

Please document me.

Definition at line 14 of file SoundFrame.h.

---

Constructor & Destructor Documentation

SoundFrame::SoundFrame

(

)

Definition at line 19 of file SoundFrame.cpp.

References Set().

                       : m_mallocd(false)
{
    Set();
}

SoundFrame::SoundFrame

(

jack_nframes_t

count

)

Definition at line 13 of file SoundFrame.cpp.

References Set(), and Zero().

                                           : m_mallocd(false)
{
    Set(count);
    Zero();
}

SoundFrame::SoundFrame	(	jack_default_audio_sample_t *	data,
		jack_nframes_t	count
	)

Definition at line 8 of file SoundFrame.cpp.

References Set().

                                                                              : m_mallocd(false)
{
    Set(data, count);
}

SoundFrame::~SoundFrame

(

)

Definition at line 66 of file SoundFrame.cpp.

References Set().

{
    Set();
}

---

Member Function Documentation

jack_time_t SoundFrame::FrameTime

(

)

Definition at line 71 of file SoundFrame.cpp.

References JackClient::GetSingleton(), and m_samplecount.

{
    return jack_frames_to_time(JackClient::GetSingleton()->GetClient(), m_samplecount);
}

jack_default_audio_sample_t* SoundFrame::GetSamples

(

)

const [inline]

Definition at line 38 of file SoundFrame.h.

References m_samples.

Referenced by operator*(), operator*=(), operator+(), operator+=(), operator<<(), Waveform::Process(), JackAudioPort::PutFrame(), and Set().

{ return m_samples; }

SoundFrame & SoundFrame::operator*=

(

float

scalar

)

Definition at line 107 of file SoundFrame.cpp.

References m_samplecount, and m_samples.

{
    for (unsigned int x = 0; x < m_samplecount; ++x) {
        m_samples[x] *= scalar;
    }

    return *this;
}

SoundFrame & SoundFrame::operator*=

(

const SoundFrame &

f

)

Definition at line 94 of file SoundFrame.cpp.

References GetSamples(), m_samplecount, m_samples, SampleCount(), and Set().

{
    if (m_samplecount < f.SampleCount()) {
        Set(f.SampleCount());
    }

    for (unsigned int x = 0; x < m_samplecount; ++x) {
        m_samples[x] *= f.GetSamples()[x];
    }

    return *this;
}

SoundFrame & SoundFrame::operator+=

(

const SoundFrame &

f

)

Definition at line 81 of file SoundFrame.cpp.

References GetSamples(), m_samplecount, m_samples, SampleCount(), and Set().

{
    if (m_samplecount < f.SampleCount()) {
        Set(f.SampleCount());
    }

    for (unsigned int x = 0; x < m_samplecount; ++x) {
        m_samples[x] += f.GetSamples()[x];
    }

    return *this;
}

SoundFrame & SoundFrame::operator=

(

const SoundFrame &

f

)

Definition at line 116 of file SoundFrame.cpp.

References Set().

{
    Set(f);
    return *this;
}

jack_nframes_t SoundFrame::SampleCount

(

)

const [inline]

Definition at line 37 of file SoundFrame.h.

References m_samplecount.

Referenced by operator*(), operator*=(), operator+(), operator+=(), operator<<(), JackAudioPort::PutFrame(), and Set().

{ return m_samplecount; }

jack_time_t SoundFrame::SampleTime

(

jack_nframes_t

offset

)

Definition at line 76 of file SoundFrame.cpp.

References JackClient::GetSingleton().

{
    return jack_frames_to_time(JackClient::GetSingleton()->GetClient(), offset);
}

void SoundFrame::Set	(	jack_default_audio_sample_t *	data,
		jack_nframes_t	count
	)

Definition at line 60 of file SoundFrame.cpp.

References m_samples, and Set().

{
    Set(count);
    memcpy(m_samples, data, sizeof(jack_default_audio_sample_t) * count);
}

void SoundFrame::Set

(

jack_nframes_t

count

)

Definition at line 45 of file SoundFrame.cpp.

References m_mallocd, m_samplecount, m_samples, Set(), and Zero().

{
    if (m_mallocd) {
        m_samples = (jack_default_audio_sample_t*)realloc(m_samples, count * sizeof(jack_default_audio_sample_t));
    }
    else {
        Set();

        m_samples = (jack_default_audio_sample_t*)malloc(sizeof(jack_default_audio_sample_t) * count);
        m_samplecount = count;
        Zero();
        m_mallocd = true;
    }
}

void SoundFrame::Set

(

const SoundFrame &

f

)

Definition at line 39 of file SoundFrame.cpp.

References GetSamples(), m_samplecount, m_samples, SampleCount(), and Set().

{
    Set(f.SampleCount());
    memcpy(m_samples, f.GetSamples(), sizeof(jack_default_audio_sample_t) * m_samplecount);
}

void SoundFrame::Set

(

)

Definition at line 29 of file SoundFrame.cpp.

References m_mallocd, m_samplecount, and m_samples.

Referenced by JackAudioPort::GetFrame(), operator*(), operator*=(), operator+(), operator+=(), operator=(), Recorder::Process(), ISoundSource::Process(), Set(), SoundFrame(), and ~SoundFrame().

{
    if (m_mallocd) {
        free(m_samples);
    }
    m_samplecount = 0;
    m_samples = NULL;
    m_mallocd = false;
}

void SoundFrame::Zero

(

)

Definition at line 24 of file SoundFrame.cpp.

References m_samplecount, and m_samples.

Referenced by JackOutput::Process(), ISoundSource::Process(), ISoundElement::Process(), Set(), and SoundFrame().

{
    memset(m_samples, 0, sizeof(jack_default_audio_sample_t) * m_samplecount);
}

---

Member Data Documentation

bool SoundFrame::m_mallocd [private]

Definition at line 51 of file SoundFrame.h.

Referenced by Set().

jack_nframes_t SoundFrame::m_samplecount [private]

Definition at line 49 of file SoundFrame.h.

Referenced by FrameTime(), operator*=(), operator+=(), SampleCount(), Set(), and Zero().

jack_default_audio_sample_t* SoundFrame::m_samples [private]

Definition at line 48 of file SoundFrame.h.

Referenced by GetSamples(), operator*=(), operator+=(), Set(), and Zero().

---

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

• SoundFrame.h
• SoundFrame.cpp