ISoundElement Class Reference

Please document me. More...

#include <ISoundElement.h>

Inheritance diagram for ISoundElement:

[legend]

Collaboration diagram for ISoundElement:

[legend]

List of all members.

Classes
class	Lock
Public Member Functions
void	AddInput (ISoundElement *element)
void	DelParameter (const string &pname)
ISoundElement *	GetParameter (const string &pname)
SoundFrame &	GetPipe ()
	ISoundElement ()
void	RemoveInput (ISoundElement *element)
void	SetParameter (const string &pname, ISoundElement *e)
virtual	~ISoundElement ()
Protected Member Functions
virtual void	Process (jack_nframes_t count)
Protected Attributes
list< ISoundElement * >	m_inputs
Private Member Functions
bool	_Ready (unsigned int tickid)
bool	_Updatable (unsigned int tickid)
void	_Update (unsigned int tickid, jack_nframes_t count)
Private Attributes
unsigned int	m_lasttickid
pthread_mutex_t	m_mtx
map< string, ISoundElement * >	m_parameters
SoundFrame	m_pipe
Friends
class	JackClient
class	Lock

---

Detailed Description

Please document me.

Definition at line 14 of file ISoundElement.h.

---

Constructor & Destructor Documentation

ISoundElement::ISoundElement

(

)

Definition at line 8 of file ISoundElement.cpp.

References JackClient::GetSingleton(), JackClient::m_elements, and m_mtx.

{
    JackClient::GetSingleton()->m_elements.push_back(this);
    pthread_mutex_init(&m_mtx, NULL);
}

ISoundElement::~ISoundElement

(

)

[virtual]

Definition at line 14 of file ISoundElement.cpp.

References JackClient::GetSingleton(), JackClient::m_elements, and m_mtx.

{
    pthread_mutex_destroy(&m_mtx);
    try {
        JackClient::GetSingleton()->m_elements.remove(this);
    }
    catch(...) {} //Ignore.
}

---

Member Function Documentation

bool ISoundElement::_Ready

(

unsigned int

tickid

)

[private]

Definition at line 93 of file ISoundElement.cpp.

References m_lasttickid.

Referenced by _Updatable().

{
    //Return whether our pipe is out of date.
    return m_lasttickid != tickid;
}

bool ISoundElement::_Updatable

(

unsigned int

tickid

)

[private]

Definition at line 70 of file ISoundElement.cpp.

References _Ready(), m_inputs, and m_parameters.

{
    Lock l(this);

    list<ISoundElement*>::iterator i;
    for (i = m_inputs.begin(); i != m_inputs.end(); ++i) {
        //If any of our inputs still need updating, we're not yet updatable.
        if ((*i)->_Ready(tickid) == true) {
            return false;
        }
    }

    map<string, ISoundElement*>::iterator pi;
    for (pi = m_parameters.begin(); pi != m_parameters.end(); ++pi) {
        //If any of our parameters still need updating, we're not yet updatable.
        if (pi->second->_Ready(tickid) == true) {
            return false;
        }
    }

    return true && _Ready(tickid);
}

void ISoundElement::_Update	(	unsigned int	tickid,
		jack_nframes_t	count
	)			[private]

Definition at line 99 of file ISoundElement.cpp.

References m_lasttickid, and Process().

{
    //Lock l(this);

    m_lasttickid = tickid;
    Process(count);
}

void ISoundElement::AddInput

(

ISoundElement *

element

)

Definition at line 38 of file ISoundElement.cpp.

References m_inputs.

Referenced by BOOST_PYTHON_MODULE().

{
    Lock l(this);
    m_inputs.push_back(element);
}

void ISoundElement::DelParameter

(

const string &

pname

)

Definition at line 65 of file ISoundElement.cpp.

References m_parameters.

Referenced by BOOST_PYTHON_MODULE().

{
    m_parameters.erase(pname);
}

ISoundElement * ISoundElement::GetParameter

(

const string &

pname

)

Definition at line 50 of file ISoundElement.cpp.

References m_parameters.

Referenced by Amp::Process().

{
    Lock l(this);
    map<string, ISoundElement*>::iterator i = m_parameters.find(pname);
    if (i != m_parameters.end()) {
        return i->second;
    }
    throw runtime_error("No parameter named " + pname + "." );
}

SoundFrame & ISoundElement::GetPipe

(

)

Definition at line 24 of file ISoundElement.cpp.

References m_pipe.

Referenced by Waveform::Process(), Recorder::Process(), JackOutput::Process(), JackInput::Process(), ISoundSource::Process(), Process(), and Amp::Process().

{
    return m_pipe;
}

void ISoundElement::Process

(

jack_nframes_t

count

)

[protected, virtual]

Reimplemented in Amp, ISoundSource, JackInput, JackOutput, Recorder, and Waveform.

Definition at line 29 of file ISoundElement.cpp.

References GetPipe(), m_inputs, and SoundFrame::Zero().

Referenced by _Update().

{
    GetPipe().Zero();
    list<ISoundElement*>::iterator i;
    for (i = m_inputs.begin(); i != m_inputs.end(); i++) {
        GetPipe() += (*i)->GetPipe();
    }
}

void ISoundElement::RemoveInput

(

ISoundElement *

element

)

Definition at line 44 of file ISoundElement.cpp.

References m_inputs.

Referenced by BOOST_PYTHON_MODULE().

{
    Lock l(this);
    m_inputs.remove(element);
}

void ISoundElement::SetParameter	(	const string &	pname,
		ISoundElement *	e
	)

Definition at line 60 of file ISoundElement.cpp.

References m_parameters.

Referenced by BOOST_PYTHON_MODULE().

{
    m_parameters[pname] = e;
}

---

Friends And Related Function Documentation

friend class JackClient [friend]

Definition at line 16 of file ISoundElement.h.

friend class Lock [friend]

Definition at line 17 of file ISoundElement.h.

---

Member Data Documentation

list<ISoundElement*> ISoundElement::m_inputs [protected]

Definition at line 47 of file ISoundElement.h.

Referenced by _Updatable(), AddInput(), Process(), and RemoveInput().

unsigned int ISoundElement::m_lasttickid [private]

Definition at line 56 of file ISoundElement.h.

Referenced by _Ready(), and _Update().

pthread_mutex_t ISoundElement::m_mtx [private]

Definition at line 54 of file ISoundElement.h.

Referenced by ISoundElement(), ISoundElement::ISoundElement::Lock::Lock(), ~ISoundElement(), and ISoundElement::ISoundElement::Lock::~Lock().

map<string, ISoundElement*> ISoundElement::m_parameters [private]

Definition at line 49 of file ISoundElement.h.

Referenced by _Updatable(), DelParameter(), GetParameter(), and SetParameter().

SoundFrame ISoundElement::m_pipe [private]

Definition at line 55 of file ISoundElement.h.

Referenced by GetPipe().

---

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

• ISoundElement.h
• ISoundElement.cpp