JackClient Class Reference

Please document me. More...

#include <JackClient.h>

Collaboration diagram for JackClient:

[legend]

List of all members.

Public Member Functions
jack_client_t *	GetClient () const
pthread_t	GetThread () const
	JackClient ()
	~JackClient ()
Static Public Member Functions
static JackClient *	GetSingleton ()
Private Member Functions
void	Process (jack_nframes_t nframes)
Static Private Member Functions
static int	JackProcess (jack_nframes_t nframes, void *arg)
static void	JackShutdown (void *arg)
Private Attributes
jack_client_t *	m_client
list< ISoundElement * >	m_elements
list< JackMidiPort * >	m_midiports
list< ISoundSource * >	m_sources
Static Private Attributes
static JackClient *	m_singleton = NULL
Friends
class	ISoundElement
class	ISoundSource
class	JackMidiPort

---

Detailed Description

Please document me.

Definition at line 18 of file JackClient.h.

---

Constructor & Destructor Documentation

JackClient::JackClient

(

)

Definition at line 13 of file JackClient.cpp.

References JackProcess(), JackShutdown(), m_client, and m_singleton.

{
    assert(!m_singleton);
    m_singleton = this;

    jack_status_t status;

    m_client = jack_client_open("JackFX", JackNullOption, &status);
    if (m_client == NULL) {
        if (status & JackServerFailed) {
            throw jack_init_error("JackFX was unable to connect to the Jack server.");
        }
        else {
            throw jack_init_error("Jack client initialization failed.");
        }
    }

    if (status & JackServerStarted) {
        cout << "Jack server started." << endl;
    }

    if (status & JackNameNotUnique) {
        cout << "Client with name `JackFX' already existed. Client named `" << 
                jack_get_client_name(m_client) << "'" << endl;
    }

    jack_set_process_callback(m_client, JackClient::JackProcess, this);
    jack_on_shutdown(m_client, JackClient::JackShutdown, this);

    if (jack_activate(m_client)) {
        jack_client_close(m_client);
        throw jack_init_error("Unable to activate client.");
    }

    cout << "Jack client initialized. Sample rate is " << jack_get_sample_rate(m_client) << endl;
}

JackClient::~JackClient

(

)

Definition at line 50 of file JackClient.cpp.

References m_client, and m_singleton.

{
    jack_client_close(m_client);
    m_singleton = NULL;
}

---

Member Function Documentation

jack_client_t * JackClient::GetClient

(

)

const

Definition at line 56 of file JackClient.cpp.

References m_client.

{
    if (m_client) {
        return m_client;
    }
    throw jack_client_error("Jack client does not exist.");
}

JackClient * JackClient::GetSingleton

(

)

[static]

Definition at line 64 of file JackClient.cpp.

References m_singleton.

Referenced by JackPort::ConnectTo(), JackPort::DisconnectFrom(), SoundFrame::FrameTime(), Halt(), ISoundElement::ISoundElement(), ISoundSource::ISoundSource(), JackMidiPort::JackMidiPort(), JackPort::JackPort(), Waveform::Process(), SoundFrame::SampleTime(), ISoundElement::~ISoundElement(), ISoundSource::~ISoundSource(), JackMidiPort::~JackMidiPort(), and JackPort::~JackPort().

{
    if (m_singleton) {
        return m_singleton;
    }
    throw jack_client_error("Jack client does not exist.");
}

pthread_t JackClient::GetThread

(

)

const

Definition at line 72 of file JackClient.cpp.

References m_client.

{
    return jack_client_thread_id(m_client);
}

int JackClient::JackProcess	(	jack_nframes_t	nframes,
		void *	arg
	)			[static, private]

Definition at line 115 of file JackClient.cpp.

References Process().

Referenced by JackClient().

{
    JackClient* j = static_cast<JackClient*>(arg);
    j->Process(nframes);
    return 0;
}

void JackClient::JackShutdown

(

void *

arg

)

[static, private]

Definition at line 110 of file JackClient.cpp.

Referenced by JackClient().

{
    JackClient* j = static_cast<JackClient*>(arg);
}

void JackClient::Process

(

jack_nframes_t

nframes

)

[private]

Definition at line 77 of file JackClient.cpp.

References m_elements, m_midiports, and m_sources.

Referenced by JackProcess().

{
    //Generate a tick id
    unsigned int tickid = rand();

    list<JackMidiPort*>::iterator mi;
    for (mi = m_midiports.begin(); mi != m_midiports.end(); ++mi) {
        (*mi)->Read(nframes);
    }

    list<ISoundSource*>::iterator si;
    for (si = m_sources.begin(); si != m_sources.end(); ++si) {
        ISoundSource::Lock l(*si);
        //Unconditionally update all of our sound sources.
        (*si)->_Update(tickid, nframes);
    }

    list<ISoundElement*>::iterator ei;
    bool didwork = true;
    while (didwork) {
        //cout << "Executing pass." << endl;
        didwork = false;
        for (ei = m_elements.begin(); ei != m_elements.end(); ++ei) {
            //cout << "Testing " << *ei << endl;
            if ((*ei)->_Updatable(tickid)) {
                //cout << "Updating " << *ei << endl;
                (*ei)->_Update(tickid, nframes);
                didwork = true;
            }
        }
    }
}

---

Friends And Related Function Documentation

friend class ISoundElement [friend]

Definition at line 20 of file JackClient.h.

friend class ISoundSource [friend]

Definition at line 21 of file JackClient.h.

friend class JackMidiPort [friend]

Definition at line 22 of file JackClient.h.

---

Member Data Documentation

jack_client_t* JackClient::m_client [private]

Definition at line 44 of file JackClient.h.

Referenced by GetClient(), GetThread(), JackClient(), and ~JackClient().

list<ISoundElement*> JackClient::m_elements [private]

Definition at line 46 of file JackClient.h.

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

list<JackMidiPort*> JackClient::m_midiports [private]

Definition at line 48 of file JackClient.h.

Referenced by JackMidiPort::JackMidiPort(), Process(), and JackMidiPort::~JackMidiPort().

JackClient * JackClient::m_singleton = NULL [static, private]

Definition at line 50 of file JackClient.h.

Referenced by GetSingleton(), JackClient(), and ~JackClient().

list<ISoundSource*> JackClient::m_sources [private]

Definition at line 47 of file JackClient.h.

Referenced by ISoundSource::ISoundSource(), Process(), and ISoundSource::~ISoundSource().

---

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

• JackClient.h
• JackClient.cpp