CLAM::JACKNetworkPlayer Class Reference

#include <JACKNetworkPlayer.hxx>

Inheritance diagram for CLAM::JACKNetworkPlayer:

List of all members.

Public Member Functions
	JACKNetworkPlayer (const std::string &name="CLAM network player")
virtual	~JACKNetworkPlayer ()
void	InitClient ()
bool	IsWorking ()
	Should return true when the backend is able to run the network.
virtual bool	IsRealTime () const
std::string	NonWorkingReason ()
	Whenever the backend is not working, this method returns the reason.
void	RegisterPorts ()
void	RegisterInputPorts (const Network &net)
void	RegisterOutputPorts (const Network &net)
void	UnRegisterPorts ()
void	OnShutdown ()
void	CopyJackBuffersToSources (const jack_nframes_t nframes)
void	CopySinksToJackBuffers (const jack_nframes_t nframes)
void	BlankJackBuffers (const jack_nframes_t nframes)
virtual void	Start ()
	Redefine to make the backend ready to process and start the network. If IsPlaying() should do nothing. If it IsPaused() you should consider just call BePlaying() without starting the processings.
virtual void	Stop ()
	Redefine it to deactivate the backend.
virtual void	Init ()
	Redefine to add any initialization after being attached to a network TODO: Consider removing it as just Jack backend uses it but it is redundant.
virtual unsigned	BackendBufferSize ()
virtual unsigned	BackendSampleRate ()
void	Do (const jack_nframes_t nframes)
void	StoreConnections ()
void	RestoreConnections ()
void	AutoConnectPorts ()
Classes
struct	JackConnection
	Memento to restore jack connection status.

---

Detailed Description

Definition at line 14 of file JACKNetworkPlayer.hxx.

---

Constructor & Destructor Documentation

CLAM::JACKNetworkPlayer::JACKNetworkPlayer

(

const std::string &

name = "CLAM network player"

)

Definition at line 26 of file JACKNetworkPlayer.cxx.

References InitClient().

CLAM::JACKNetworkPlayer::~JACKNetworkPlayer

(

)

[virtual]

Definition at line 35 of file JACKNetworkPlayer.cxx.

References Stop().

---

Member Function Documentation

void CLAM::JACKNetworkPlayer::InitClient

(

)

Definition at line 59 of file JACKNetworkPlayer.cxx.

References CLAM_ASSERT, CLAM::JackProcessingCallback(), and CLAM::JackShutdownCallback().

Referenced by Init(), JACKNetworkPlayer(), and Start().

bool CLAM::JACKNetworkPlayer::IsWorking

(

)

[virtual]

Should return true when the backend is able to run the network.

Implements CLAM::NetworkPlayer.

Definition at line 48 of file JACKNetworkPlayer.cxx.

virtual bool CLAM::JACKNetworkPlayer::IsRealTime

(

)

const [inline, virtual]

Implements CLAM::NetworkPlayer.

Definition at line 55 of file JACKNetworkPlayer.hxx.

std::string CLAM::JACKNetworkPlayer::NonWorkingReason

(

)

[virtual]

Whenever the backend is not working, this method returns the reason.

Implements CLAM::NetworkPlayer.

Definition at line 53 of file JACKNetworkPlayer.cxx.

void CLAM::JACKNetworkPlayer::RegisterPorts

(

)

Definition at line 92 of file JACKNetworkPlayer.cxx.

References CLAM::NetworkPlayer::GetNetwork(), RegisterInputPorts(), and RegisterOutputPorts().

Referenced by Start().

void CLAM::JACKNetworkPlayer::RegisterInputPorts

(

const Network &

net

)

Definition at line 98 of file JACKNetworkPlayer.cxx.

References CLAM_ASSERT, CLAM::NetworkPlayer::GetNSources(), CLAM::NetworkPlayer::SetSourceFrameSize(), and CLAM::NetworkPlayer::SourceName().

Referenced by RegisterPorts().

void CLAM::JACKNetworkPlayer::RegisterOutputPorts

(

const Network &

net

)

Definition at line 113 of file JACKNetworkPlayer.cxx.

References CLAM_ASSERT, CLAM::NetworkPlayer::GetNSinks(), CLAM::NetworkPlayer::SetSinkFrameSize(), and CLAM::NetworkPlayer::SinkName().

Referenced by RegisterPorts().

void CLAM::JACKNetworkPlayer::UnRegisterPorts

(

)

Definition at line 128 of file JACKNetworkPlayer.cxx.

Referenced by Start().

void CLAM::JACKNetworkPlayer::OnShutdown

(

)

Definition at line 214 of file JACKNetworkPlayer.cxx.

References CLAM::NetworkPlayer::BeStopped(), CLAM::NetworkPlayer::GetNetwork(), and CLAM::Network::Stop().

Referenced by CLAM::JackShutdownCallback().

void CLAM::JACKNetworkPlayer::CopyJackBuffersToSources

(

const jack_nframes_t

nframes

)

Definition at line 151 of file JACKNetworkPlayer.cxx.

References CLAM::NetworkPlayer::SetSourceBuffer().

Referenced by Do().

void CLAM::JACKNetworkPlayer::CopySinksToJackBuffers

(

const jack_nframes_t

nframes

)

Definition at line 161 of file JACKNetworkPlayer.cxx.

References CLAM::NetworkPlayer::SetSinkBuffer().

Referenced by Do().

void CLAM::JACKNetworkPlayer::BlankJackBuffers

(

const jack_nframes_t

nframes

)

Definition at line 171 of file JACKNetworkPlayer.cxx.

Referenced by Do().

void CLAM::JACKNetworkPlayer::Start

(

)

[virtual]

Redefine to make the backend ready to process and start the network. If IsPlaying() should do nothing. If it IsPaused() you should consider just call BePlaying() without starting the processings.

Implements CLAM::NetworkPlayer.

Definition at line 181 of file JACKNetworkPlayer.cxx.

References AutoConnectPorts(), CLAM::NetworkPlayer::BePlaying(), CLAM::NetworkPlayer::CacheSourcesAndSinks(), CLAM::NetworkPlayer::GetNetwork(), InitClient(), CLAM::NetworkPlayer::IsPaused(), CLAM::NetworkPlayer::IsPlaying(), RegisterPorts(), RestoreConnections(), CLAM::Network::Start(), and UnRegisterPorts().

void CLAM::JACKNetworkPlayer::Stop

(

)

[virtual]

Redefine it to deactivate the backend.

Implements CLAM::NetworkPlayer.

Definition at line 224 of file JACKNetworkPlayer.cxx.

References CLAM::NetworkPlayer::BeStopped(), CLAM::NetworkPlayer::GetNetwork(), CLAM::NetworkPlayer::IsStopped(), CLAM::Network::Stop(), and StoreConnections().

Referenced by ~JACKNetworkPlayer().

void CLAM::JACKNetworkPlayer::Init

(

)

[virtual]

Redefine to add any initialization after being attached to a network TODO: Consider removing it as just Jack backend uses it but it is redundant.

Reimplemented from CLAM::NetworkPlayer.

Definition at line 210 of file JACKNetworkPlayer.cxx.

References InitClient().

virtual unsigned CLAM::JACKNetworkPlayer::BackendBufferSize

(

)

[inline, virtual]

Reimplemented from CLAM::NetworkPlayer.

Definition at line 75 of file JACKNetworkPlayer.hxx.

virtual unsigned CLAM::JACKNetworkPlayer::BackendSampleRate

(

)

[inline, virtual]

Reimplemented from CLAM::NetworkPlayer.

Definition at line 80 of file JACKNetworkPlayer.hxx.

void CLAM::JACKNetworkPlayer::Do

(

const jack_nframes_t

nframes

)

Definition at line 237 of file JACKNetworkPlayer.cxx.

References BlankJackBuffers(), CopyJackBuffersToSources(), CopySinksToJackBuffers(), CLAM::Network::Do(), CLAM::NetworkPlayer::GetNetwork(), CLAM::NetworkPlayer::IsPaused(), and CLAM::NetworkPlayer::IsStopped().

Referenced by CLAM::JackProcessingCallback().

void CLAM::JACKNetworkPlayer::StoreConnections

(

)

Definition at line 252 of file JACKNetworkPlayer.cxx.

Referenced by Stop().

void CLAM::JACKNetworkPlayer::RestoreConnections

(

)

Definition at line 272 of file JACKNetworkPlayer.cxx.

Referenced by Start().

void CLAM::JACKNetworkPlayer::AutoConnectPorts

(

)

Definition at line 303 of file JACKNetworkPlayer.cxx.

References NULL.

Referenced by Start().

---

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

• JACKNetworkPlayer.hxx
• JACKNetworkPlayer.cxx