#include <ALSAPlugin.H>

Inheritance diagram for ALSA::ALSAPlugin:

Collaboration diagram for ALSA::ALSAPlugin:

Public Member Functions
	ALSAPlugin ()

virtual	~ALSAPlugin ()

virtual int	parseConfig (const char name, snd_config_t conf, snd_pcm_stream_t stream, int mode)

virtual int	start ()
	start method More...

virtual int	stop ()
	stop method More...

virtual snd_pcm_sframes_t	pointer ()=0
	virtual pointer method More...

int	create (const char *name, snd_pcm_stream_t stream, int mode)

virtual snd_pcm_sframes_t	transfer (const snd_pcm_channel_area_t *areas, snd_pcm_uframes_t offset, snd_pcm_uframes_t size)

virtual snd_pcm_t *	getPCM ()

snd_pcm_t **	getPCMP ()

Public Member Functions inherited from ALSA::Hardware
int	getHWParams ()

int	fillParams ()

int	resetParams ()

	Hardware ()

virtual	~Hardware ()

void	copyFrom (snd_pcm_hw_params_t *hParamsIn)

int	rateResample (unsigned int state)

int	setAccess (snd_pcm_access_t access)

int	getAccess (void)

int	setFormat (snd_pcm_format_t format)

int	getFormat (snd_pcm_format_t &format)

int	getFormatPhysicalWidth ()

int	setChannels (unsigned int cnt)

int	getChannels ()

int	getMaxChannels ()

int	setSampleRate (unsigned int rrate, int dir=0)

int	getSampleRate (int dir=0)

int	getPeriodSize (snd_pcm_uframes_t p, int dir=NULL)

int	getPeriodSize (int *dir=NULL)

int	setPeriodSize (snd_pcm_uframes_t p, int dir=0)

int	setBufSize (snd_pcm_uframes_t bufSize)

const char *	formatDescription (const snd_pcm_format_t format) const

const char *	getDeviceName ()

int	dumpHWParams ()

Public Member Functions inherited from ALSA::PCM
	PCM ()

virtual	~PCM ()

snd_pcm_t **	getPCMP ()

int	open (const char *device, snd_pcm_stream_t streamType, const int block)

int	close ()

int	drop ()

int	drain ()

int	reset ()

void	enableLog ()

int	logEnabled ()

int	dumpStatus ()

int	dumpPCM ()

int	dumpSetup ()

int	dumpHWSetup ()

int	dumpSWSetup ()

int	start ()

snd_pcm_state_t	getState ()

const char *	getStateName ()

bool	prepared ()

bool	opened ()

bool	isSetup ()

bool	running ()

bool	hasXrun ()

bool	draining ()

bool	paused ()

bool	suspended ()

bool	disconnected ()

Protected Member Functions
void	setName (const char *name)
	The slave. More...

Protected Member Functions inherited from ALSA::Hardware
int	setHWParams ()

Protected Attributes
snd_pcm_t *	slave

Protected Attributes inherited from ALSA::PCM
snd_output_t *	log
	The log stream if enabled. More...

snd_pcm_t *	handle
	PCM handle. More...

Private Member Functions
	STATICFN (int, start) STATICFN(int
	The callback functions. More...

stop	STATICFN (snd_pcm_sframes_t, pointer) static snd_pcm_sframes_t transfer_static(snd_pcm_ioplug_t *io
	< stop the PCM; required More...

return	static_cast (io->private_data) -> transfer(areas, offset, size)

virtual int	HWParams (snd_pcm_hw_params_t *params)

Static Private Member Functions
static int	HWParams_static (snd_pcm_ioplug_t io, snd_pcm_hw_params_t params)

Private Attributes
snd_pcm_ioplug_t	io

snd_pcm_ioplug_callback_t	ioplugCallback
	The ALSA plugin. More...

stop const snd_pcm_channel_area_t *	areas

stop const snd_pcm_channel_area_t snd_pcm_uframes_t	offset

stop const snd_pcm_channel_area_t snd_pcm_uframes_t snd_pcm_uframes_t	size

Detailed Description

Definition at line 33 of file ALSAPlugin.H.

Constructor & Destructor Documentation

◆ ALSAPlugin()

ALSA::ALSAPlugin::ALSAPlugin ( )

inline

Definition at line 67 of file ALSAPlugin.H.

Here is the call graph for this function:

◆ ~ALSAPlugin()

virtual ALSA::ALSAPlugin::~ALSAPlugin ( )

inlinevirtual

Definition at line 84 of file ALSAPlugin.H.

Member Function Documentation

◆ create()

int ALSA::ALSAPlugin::create	(	const char *	name,
		snd_pcm_stream_t	stream,
		int	mode
	)

inline

This method creates the ioplug

Definition at line 119 of file ALSAPlugin.H.

◆ getPCM()

virtual snd_pcm_t* ALSA::ALSAPlugin::getPCM ( )

inlinevirtual

This method returns the pcm struct

Reimplemented from ALSA::PCM.

Definition at line 130 of file ALSAPlugin.H.

◆ getPCMP()

snd_pcm_t** ALSA::ALSAPlugin::getPCMP ( )

inline

This method returns a pointer to the pcm struct

Definition at line 137 of file ALSAPlugin.H.

◆ HWParams()

virtual int ALSA::ALSAPlugin::HWParams ( snd_pcm_hw_params_t * params )

inlineprivatevirtual

Definition at line 54 of file ALSAPlugin.H.

Here is the caller graph for this function:

◆ HWParams_static()

static int ALSA::ALSAPlugin::HWParams_static	(	snd_pcm_ioplug_t *	io,
		snd_pcm_hw_params_t *	params
	)

inlinestaticprivate

Definition at line 47 of file ALSAPlugin.H.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseConfig()

virtual int ALSA::ALSAPlugin::parseConfig	(	const char *	name,
		snd_config_t *	conf,
		snd_pcm_stream_t	stream,
		int	mode
	)

inlinevirtual

Parse the snd_config_t passed to the plugin

Returns: 0 on success, < 0 on failure

Definition at line 91 of file ALSAPlugin.H.

◆ pointer()

virtual snd_pcm_sframes_t ALSA::ALSAPlugin::pointer ( )

pure virtual

virtual pointer method

Here is the caller graph for this function:

◆ setName()

void ALSA::ALSAPlugin::setName ( const char * name )

inlineprotected

The slave.

Definition at line 62 of file ALSAPlugin.H.

Here is the caller graph for this function:

◆ start()

virtual int ALSA::ALSAPlugin::start ( )

inlinevirtual

start method

Definition at line 97 of file ALSAPlugin.H.

Here is the caller graph for this function:

◆ static_cast()

return ALSA::ALSAPlugin::static_cast ( io-> private_data ) -> transfer(areas, offset, size)

private

◆ STATICFN() [1/2]

ALSA::ALSAPlugin::STATICFN	(	int	,
		start
	)

private

The callback functions.

◆ STATICFN() [2/2]

stop ALSA::ALSAPlugin::STATICFN	(	snd_pcm_sframes_t	,
		pointer
	)

private

< stop the PCM; required

◆ stop()

virtual int ALSA::ALSAPlugin::stop ( )

inlinevirtual

stop method

Definition at line 109 of file ALSAPlugin.H.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ transfer()

virtual snd_pcm_sframes_t ALSA::ALSAPlugin::transfer	(	const snd_pcm_channel_area_t *	areas,
		snd_pcm_uframes_t	offset,
		snd_pcm_uframes_t	size
	)

inlinevirtual

Definition at line 123 of file ALSAPlugin.H.

Member Data Documentation

◆ areas

stop const snd_pcm_channel_area_t* ALSA::ALSAPlugin::areas

private

Definition at line 42 of file ALSAPlugin.H.

◆ io

snd_pcm_ioplug_t ALSA::ALSAPlugin::io

private

Definition at line 34 of file ALSAPlugin.H.

◆ ioplugCallback

snd_pcm_ioplug_callback_t ALSA::ALSAPlugin::ioplugCallback

private

The ALSA plugin.

Definition at line 35 of file ALSAPlugin.H.

◆ offset

stop const snd_pcm_channel_area_t snd_pcm_uframes_t ALSA::ALSAPlugin::offset

private

Definition at line 42 of file ALSAPlugin.H.

◆ size

stop const snd_pcm_channel_area_t snd_pcm_uframes_t snd_pcm_uframes_t ALSA::ALSAPlugin::size

private

Initial value:

{

std::cout<<__func__<<std::endl

Definition at line 42 of file ALSAPlugin.H.

◆ slave

snd_pcm_t* ALSA::ALSAPlugin::slave

protected

Definition at line 60 of file ALSAPlugin.H.

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

/tmp/gtkiostream/include/ALSA/ALSAPlugin.H

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ALSAPlugin()

◆ ~ALSAPlugin()

Member Function Documentation

◆ create()

◆ getPCM()

◆ getPCMP()

◆ HWParams()

◆ HWParams_static()

◆ parseConfig()

◆ pointer()

◆ setName()

◆ start()

◆ static_cast()

◆ STATICFN() [1/2]

◆ STATICFN() [2/2]

◆ stop()

◆ transfer()

Member Data Documentation

◆ areas

◆ io

◆ ioplugCallback

◆ offset

◆ size

◆ slave