AudioDevice Class Reference

Audio Device. More...

#include <audiodevice.h>

Inheritance diagram for AudioDevice:

List of all members.

Public Member Functions
	AudioDevice (const char *name="/dev/dsp")
	~AudioDevice ()
cardinal	getSyncCount () const
void	resetSyncCount ()
card16	getSamplingRate () const
card8	getBits () const
card8	getChannels () const
card16	getByteOrder () const
cardinal	getBytesPerSecond () const
cardinal	getBitsPerSample () const
card16	setSamplingRate (const card16 samplingRate)
card8	setBits (const card8 bits)
card8	setChannels (const card8 channels)
card16	setByteOrder (const card16 byteOrder)
bool	ready () const
void	sync ()
bool	write (const void *data, const size_t length)
cardinal	getCurrentCapacity ()
Static Public Attributes
static const cardinal	RingBufferSize = 128 * 1024
static const cardinal	ResizeThresholdPercent = 75
static const cardinal	ResizeModulo = 4
Private Member Functions
void	run ()
Private Attributes
bool	IsReady
cardinal	SyncCount
cardinal	JitterCompensationLatency
card16	AudioSamplingRate
card8	AudioBits
card8	AudioChannels
card16	AudioByteOrder
card16	DeviceSamplingRate
card8	DeviceBits
card8	DeviceChannels
card16	DeviceByteOrder
int	DeviceFD
int	DeviceCapabilities
int	DeviceFormats
integer	DeviceBlockSize
integer	DeviceFragmentSize
integer	DeviceOSpace
RingBuffer	Buffer
cardinal	ResizeThreshold
card64	LastWriteTimeStamp
integer	Balance
bool	IsFillingBuffer

---

Detailed Description

Audio Device.

This class implements AudioWriterInterface for the audio device.

Author:

Thomas Dreibholz

Version:

1.0

---

Constructor & Destructor Documentation

AudioDevice::AudioDevice

(

const char *

name = "/dev/dsp"

)

Constructor.

Parameters:

name	Name of the audio device (normally "/dev/dsp").

AudioDevice::~AudioDevice

(

)

Destructor.

---

Member Function Documentation

card8 AudioDevice::getBits

(

)

const [virtual]

getBits() Implementation of AudioQualityInterface.

See also:

AudioQualityInterface::getBits

Implements AudioQualityInterface.

cardinal AudioDevice::getBitsPerSample

(

)

const [virtual]

getBitsPerSample() Implementation of AudioQualityInterface.

See also:

AudioQualityInterface::getBitsPerSample

Implements AudioQualityInterface.

card16 AudioDevice::getByteOrder

(

)

const [virtual]

getByteOrder() Implementation of AudioQualityInterface.

See also:

AudioQualityInterface::getByteOrder

Implements AudioQualityInterface.

cardinal AudioDevice::getBytesPerSecond

(

)

const [virtual]

getBytesPerSecond() Implementation of AudioQualityInterface.

See also:

AudioQualityInterface::getBytesPerSecond

Implements AudioQualityInterface.

card8 AudioDevice::getChannels

(

)

const [virtual]

getChannels() Implementation of AudioQualityInterface.

See also:

AudioQualityInterface::getChannels

Implements AudioQualityInterface.

cardinal AudioDevice::getCurrentCapacity

(

)

getCurrentCapacity() implementation of AudioWriterInterface

See also:

AudioWriterInterface::write

card16 AudioDevice::getSamplingRate

(

)

const [virtual]

getSamplingRate() Implementation of AudioQualityInterface.

See also:

AudioQualityInterface::getSamplingRate

Implements AudioQualityInterface.

cardinal AudioDevice::getSyncCount

(

)

const [inline]

Get number of times, sync() has been called.

Returns:

Number of times, sync() has been called.

See also:

AudioWriterInterface::sync

bool AudioDevice::ready

(

)

const [virtual]

ready() implementation of AudioWriterInterface

See also:

AudioWriterInterface::ready

Implements AudioWriterInterface.

void AudioDevice::resetSyncCount

(

)

[inline]

Reset number of times, sync() has been called.

See also:

AudioWriterInterface::sync

void AudioDevice::run

(

)

[private, virtual]

The virtual run() method, which contains the thread's implementation. It has to be implemented by classes, which inherit Thread.

Implements Thread.

card8 AudioDevice::setBits

(

const card8

bits

)

[virtual]

setBits() Implementation of AdjustableAudioQualityInterface.

See also:

AdjustableAudioQualityInterface::setBits

Implements AdjustableAudioQualityInterface.

card16 AudioDevice::setByteOrder

(

const card16

byteOrder

)

[virtual]

setByteOrder() Implementation of AdjustableAudioQualityInterface.

See also:

AdjustableAudioQualityInterface::setByteOrder

Implements AdjustableAudioQualityInterface.

card8 AudioDevice::setChannels

(

const card8

channels

)

[virtual]

setChannels() Implementation of AdjustableAudioQualityInterface.

See also:

AdjustableAudioQualityInterface::setChannels

Implements AdjustableAudioQualityInterface.

card16 AudioDevice::setSamplingRate

(

const card16

samplingRate

)

[virtual]

setSamplingRate() Implementation of AdjustableAudioQualityInterface.

See also:

AdjustableAudioQualityInterface::setSamplingRate

Implements AdjustableAudioQualityInterface.

void AudioDevice::sync

(

)

[virtual]

sync() implementation of AudioWriterInterface

See also:

AudioWriterInterface::sync

Implements AudioWriterInterface.

bool AudioDevice::write	(	const void *	data,
		const size_t	length
	)		[virtual]

write() implementation of AudioWriterInterface

See also:

AudioWriterInterface::write

Implements AudioWriterInterface.

---

Member Data Documentation

card8 AudioDevice::AudioBits [private]

card16 AudioDevice::AudioByteOrder [private]

card8 AudioDevice::AudioChannels [private]

card16 AudioDevice::AudioSamplingRate [private]

integer AudioDevice::Balance [private]

RingBuffer AudioDevice::Buffer [private]

card8 AudioDevice::DeviceBits [private]

integer AudioDevice::DeviceBlockSize [private]

card16 AudioDevice::DeviceByteOrder [private]

int AudioDevice::DeviceCapabilities [private]

card8 AudioDevice::DeviceChannels [private]

int AudioDevice::DeviceFD [private]

int AudioDevice::DeviceFormats [private]

integer AudioDevice::DeviceFragmentSize [private]

integer AudioDevice::DeviceOSpace [private]

card16 AudioDevice::DeviceSamplingRate [private]

bool AudioDevice::IsFillingBuffer [private]

bool AudioDevice::IsReady [private]

cardinal AudioDevice::JitterCompensationLatency [private]

card64 AudioDevice::LastWriteTimeStamp [private]

const cardinal AudioDevice::ResizeModulo = 4 [static]

Buffer resize modulo: The buffer's size will be removed by the fraction of (1/ResizeModulo) by removing every ResizeModulo-th 32-bit word.

cardinal AudioDevice::ResizeThreshold [private]

const cardinal AudioDevice::ResizeThresholdPercent = 75 [static]

Buffer fill threshold to Resize (in percent).

const cardinal AudioDevice::RingBufferSize = 128 * 1024 [static]

Size of audio ringbuffer in bytes.

cardinal AudioDevice::SyncCount [private]

---

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

• audiodevice.h
• audiodevice.cc