#include <ALSAExternalPlugin.H>

Inheritance diagram for ALSA::ALSAExternalPlugin:

Collaboration diagram for ALSA::ALSAExternalPlugin:

Public Member Functions
	ALSAExternalPlugin ()

virtual	~ALSAExternalPlugin ()

virtual int	close ()

virtual int	hwParams (snd_pcm_hw_params_t *params)

virtual int	specifyHWParams ()=0

virtual int	hwFree ()

virtual void	dump (snd_output_t *out)

virtual int	init ()

snd_pcm_sframes_t	doTransfer (const snd_pcm_channel_area_t dst_areas, snd_pcm_uframes_t dst_offset, const snd_pcm_channel_area_t src_areas, snd_pcm_uframes_t src_offset, snd_pcm_uframes_t size)

virtual snd_pcm_sframes_t	transfer (const snd_pcm_channel_area_t dst_areas, snd_pcm_uframes_t dst_offset, const snd_pcm_channel_area_t src_areas, snd_pcm_uframes_t src_offset, snd_pcm_uframes_t size)

int	create (const char name, snd_config_t root, snd_pcm_stream_t stream, int mode)

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

virtual snd_pcm_t *	getPCM ()

Public Member Functions inherited from ALSA::Software
	Software (void)

virtual	~Software (void)

int	getSWParams ()

int	setSWParams ()

int	setSWThreshold (snd_pcm_uframes_t thresh)

int	setAvailMin (snd_pcm_uframes_t cnt)

void *	getAddress (const snd_pcm_channel_area_t *areas, snd_pcm_uframes_t offset) const

template<typename SAMPLE_TYPE >
int	getChannelCount (const snd_pcm_channel_area_t *areas) const

int	dumpSWParams ()

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 to use. More...

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

Protected Attributes
snd_pcm_extplug_t	extplug

snd_config_t *	slaveConf
	The ALSA plugin. More...

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

snd_pcm_t *	handle
	PCM handle. More...

Static Private Member Functions
static snd_pcm_sframes_t	transfer_static (snd_pcm_extplug_t extplug, const snd_pcm_channel_area_t dst_areas, snd_pcm_uframes_t dst_offset, const snd_pcm_channel_area_t *src_areas, snd_pcm_uframes_t src_offset, snd_pcm_uframes_t size)
	The callback functions. More...

Private Attributes
snd_pcm_extplug_callback_t	callbacks

Detailed Description

Examples:: ALSAExternalPluginTest.C.

Definition at line 29 of file ALSAExternalPlugin.H.

Constructor & Destructor Documentation

◆ ALSAExternalPlugin()

ALSA::ALSAExternalPlugin::ALSAExternalPlugin ( )

inline

Definition at line 67 of file ALSAExternalPlugin.H.

Here is the call graph for this function:

◆ ~ALSAExternalPlugin()

virtual ALSA::ALSAExternalPlugin::~ALSAExternalPlugin ( )

inlinevirtual

Definition at line 88 of file ALSAExternalPlugin.H.

Member Function Documentation

◆ close()

virtual int ALSA::ALSAExternalPlugin::close ( )

inlinevirtual

Close

Returns: 0 on success, < 0 on failure

Definition at line 95 of file ALSAExternalPlugin.H.

Here is the caller graph for this function:

◆ create()

int ALSA::ALSAExternalPlugin::create	(	const char *	name,
		snd_config_t *	root,
		snd_pcm_stream_t	stream,
		int	mode
	)

inline

This method creates the external plugin

Definition at line 154 of file ALSAExternalPlugin.H.

◆ doTransfer()

snd_pcm_sframes_t ALSA::ALSAExternalPlugin::doTransfer	(	const snd_pcm_channel_area_t *	dst_areas,
		snd_pcm_uframes_t	dst_offset,
		const snd_pcm_channel_area_t *	src_areas,
		snd_pcm_uframes_t	src_offset,
		snd_pcm_uframes_t	size
	)

inline

Definition at line 141 of file ALSAExternalPlugin.H.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ dump()

virtual void ALSA::ALSAExternalPlugin::dump ( snd_output_t * out )

inlinevirtual

dump

Returns: 0 on success, < 0 on failure

Definition at line 129 of file ALSAExternalPlugin.H.

Here is the caller graph for this function:

◆ getPCM()

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

inlinevirtual

This method returns the pcm struct

Returns: The pcm struct

Reimplemented from ALSA::PCM.

Definition at line 197 of file ALSAExternalPlugin.H.

◆ hwFree()

virtual int ALSA::ALSAExternalPlugin::hwFree ( )

inlinevirtual

free

Returns: 0 on success, < 0 on failure

Definition at line 121 of file ALSAExternalPlugin.H.

Here is the caller graph for this function:

◆ hwParams()

virtual int ALSA::ALSAExternalPlugin::hwParams ( snd_pcm_hw_params_t * params )

inlinevirtual

Set various hw params The params of the system

Returns: 0 on success, < 0 on failure

Definition at line 104 of file ALSAExternalPlugin.H.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ init()

virtual int ALSA::ALSAExternalPlugin::init ( )

inlinevirtual

init

Returns: 0 on success, < 0 on failure

Definition at line 136 of file ALSAExternalPlugin.H.

Here is the caller graph for this function:

◆ parseConfig()

virtual int ALSA::ALSAExternalPlugin::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 167 of file ALSAExternalPlugin.H.

◆ setName()

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

inlineprotected

The slave to use.

Set the name of the plugin

Parameters

name	The name to set

Definition at line 62 of file ALSAExternalPlugin.H.

Here is the caller graph for this function:

◆ specifyHWParams()

virtual int ALSA::ALSAExternalPlugin::specifyHWParams ( )

pure virtual

We have to specify hwparams

Returns: 0 on success, < 0 on failure

Here is the caller graph for this function:

◆ transfer()

virtual snd_pcm_sframes_t ALSA::ALSAExternalPlugin::transfer	(	const snd_pcm_channel_area_t *	dst_areas,
		snd_pcm_uframes_t	dst_offset,
		const snd_pcm_channel_area_t *	src_areas,
		snd_pcm_uframes_t	src_offset,
		snd_pcm_uframes_t	size
	)

inlinevirtual

The transfer method

Definition at line 147 of file ALSAExternalPlugin.H.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ transfer_static()

static snd_pcm_sframes_t ALSA::ALSAExternalPlugin::transfer_static	(	snd_pcm_extplug_t *	extplug,
		const snd_pcm_channel_area_t *	dst_areas,
		snd_pcm_uframes_t	dst_offset,
		const snd_pcm_channel_area_t *	src_areas,
		snd_pcm_uframes_t	src_offset,
		snd_pcm_uframes_t	size
	)

inlinestaticprivate

The callback functions.

Definition at line 50 of file ALSAExternalPlugin.H.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ callbacks

snd_pcm_extplug_callback_t ALSA::ALSAExternalPlugin::callbacks

private

Definition at line 38 of file ALSAExternalPlugin.H.

◆ extplug

snd_pcm_extplug_t ALSA::ALSAExternalPlugin::extplug

protected

Definition at line 56 of file ALSAExternalPlugin.H.

◆ slaveConf

snd_config_t* ALSA::ALSAExternalPlugin::slaveConf

protected

The ALSA plugin.

Definition at line 57 of file ALSAExternalPlugin.H.

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

/tmp/gtkiostream/include/ALSA/ALSAExternalPlugin.H

Public Member Functions

Protected Member Functions

Protected Attributes

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ALSAExternalPlugin()

◆ ~ALSAExternalPlugin()

Member Function Documentation

◆ close()

◆ create()

◆ doTransfer()

◆ dump()

◆ getPCM()

◆ hwFree()

◆ hwParams()

◆ init()

◆ parseConfig()

◆ setName()

◆ specifyHWParams()

◆ transfer()

◆ transfer_static()

Member Data Documentation

◆ callbacks

◆ extplug

◆ slaveConf