Inheritance diagram for cAudio::cAudioCapture:

[legend]

Collaboration diagram for cAudio::cAudioCapture:

[legend]

Public Types
enum	Events { ON_INIT , ON_UPDATE , ON_RELEASE , ON_BEGINCAPTURE , ON_ENDCAPTURE , ON_USERREQUESTEDBUFFER }

Public Member Functions
virtual bool	initialize (const char *deviceName=0x0, unsigned int frequency=22050, AudioFormats format=EAF_16BIT_MONO, unsigned int internalBufferSize=8192)
	Initializes the capture device to the selected settings.

virtual bool	isReady ()
	Returns true if the capture device is ready to be used. False may indicate an error with the current settings.

virtual void	updateCaptureBuffer (bool force=false)
	Grabs samples from the OpenAL buffer into the capture buffer if the OpenAL buffer has reached half full. Should be run once every audio frame, unless threading is enabled.

virtual void	shutdown ()
	Shuts down the capture device, clearing the internal buffer and setting the audio capture into an uninitialized state. You must call initialize() again in order to reuse this object.

virtual bool	isUpdateThreadRunning ()
	Returns if the thread used to update all Audio Capture Objects is running.

virtual const char *	getDeviceName ()
	Returns the name of the audio device being used to capture audio.

virtual unsigned int	getFrequency ()
	Returns the frequency that the captured audio will be at.

virtual AudioFormats	getFormat ()
	Returns the format of the captured audio.

virtual unsigned int	getInternalBufferSize ()
	Returns the internal OpenAL buffer size in bytes.

virtual unsigned int	getSampleSize ()
	Returns the size of a "sample" of audio data. Useful for making sure you grab audio data at sample boundaries.

virtual bool	setDevice (const char *deviceName)
	Sets the audio device . Will cause the capture device to be reinitialized. Calling while in use will clear the internal audio buffer.

virtual bool	setFrequency (unsigned int frequency)
	Sets the frequency that the captured audio will be at. Will cause the capture device to be reinitialized. Calling while in use will clear the internal audio buffer.

virtual bool	setFormat (AudioFormats format)
	Sets the format that the captured audio will be at. Will cause the capture device to be reinitialized. Calling while in use will clear the internal audio buffer.

virtual bool	setInternalBufferSize (unsigned int internalBufferSize)
	Sets the internal buffer size that OpenAL will use to store captured audio between calls to getCapturedAudio() in bytes. Will cause the capture device to be reinitialized. Calling while in use will clear the internal audio buffer.

virtual bool	beginCapture ()
	Starts capturing audio data to an internal buffer. Will clear any old data in the buffer.

virtual void	stopCapture ()
	Stops capturing audio data to an internal buffer.

virtual unsigned int	getCapturedAudio (void *outputBuffer, unsigned int outputBufferSize)
	Allows access to the audio data in the internal capture buffer.

virtual AudioCaptureBuffer *	getCapturedAudioBuffer ()
	this method is the same as getCapturedAudio but it returns an managed CaptureBuffer

virtual unsigned int	getCurrentCapturedAudioSize ()
	Returns the current size of the internal audio buffer in bytes.

void	getAvailableDevices ()

virtual void	registerEventHandler (ICaptureEventHandler *handler)
	Registers a new event handler to this manager.

virtual void	unRegisterEventHandler (ICaptureEventHandler *handler)
	Removes the specified event handler from this manager.

virtual void	unRegisterAllEventHandlers ()
	Removes all event handlers attached to this manager.

virtual bool	initialize (const char *deviceName=0x0, unsigned int frequency=22050, AudioFormats format=EAF_16BIT_MONO, unsigned int internalBufferSize=8192)=0
	Initializes the capture device to the selected settings.

virtual bool	isReady ()=0
	Returns true if the capture device is ready to be used. False may indicate an error with the current settings.

virtual void	updateCaptureBuffer (bool force=false)=0
	Grabs samples from the OpenAL buffer into the capture buffer if the OpenAL buffer has reached half full. Should be run once every audio frame, unless threading is enabled.

virtual void	shutdown ()=0
	Shuts down the capture device, clearing the internal buffer and setting the audio capture into an uninitialized state. You must call initialize() again in order to reuse this object.

virtual bool	isUpdateThreadRunning ()=0
	Returns if the thread used to update all Audio Capture Objects is running.

virtual const char *	getDeviceName ()=0
	Returns the name of the audio device being used to capture audio.

virtual unsigned int	getFrequency ()=0
	Returns the frequency that the captured audio will be at.

virtual AudioFormats	getFormat ()=0
	Returns the format of the captured audio.

virtual unsigned int	getInternalBufferSize ()=0
	Returns the internal OpenAL buffer size in bytes.

virtual unsigned int	getSampleSize ()=0
	Returns the size of a "sample" of audio data. Useful for making sure you grab audio data at sample boundaries.

virtual bool	setDevice (const char *deviceName)=0
	Sets the audio device . Will cause the capture device to be reinitialized. Calling while in use will clear the internal audio buffer.

virtual bool	setFrequency (unsigned int frequency)=0
	Sets the frequency that the captured audio will be at. Will cause the capture device to be reinitialized. Calling while in use will clear the internal audio buffer.

virtual bool	setFormat (AudioFormats format)=0
	Sets the format that the captured audio will be at. Will cause the capture device to be reinitialized. Calling while in use will clear the internal audio buffer.

virtual bool	setInternalBufferSize (unsigned int internalBufferSize)=0
	Sets the internal buffer size that OpenAL will use to store captured audio between calls to getCapturedAudio() in bytes. Will cause the capture device to be reinitialized. Calling while in use will clear the internal audio buffer.

virtual bool	beginCapture ()=0
	Starts capturing audio data to an internal buffer. Will clear any old data in the buffer.

virtual void	stopCapture ()=0
	Stops capturing audio data to an internal buffer.

virtual unsigned int	getCapturedAudio (void *outputBuffer, unsigned int outputBufferSize)=0
	Allows access to the audio data in the internal capture buffer.

virtual AudioCaptureBuffer *	getCapturedAudioBuffer ()=0
	this method is the same as getCapturedAudio but it returns an managed CaptureBuffer

virtual unsigned int	getCurrentCapturedAudioSize ()=0
	Returns the current size of the internal audio buffer in bytes.

virtual void	registerEventHandler (ICaptureEventHandler *handler)=0
	Registers a new event handler to this manager.

virtual void	unRegisterEventHandler (ICaptureEventHandler *handler)=0
	Removes the specified event handler from this manager.

virtual void	unRegisterAllEventHandlers ()=0
	Removes all event handlers attached to this manager.

Public Member Functions inherited from cAudio::cMemoryOverride
void *	operator new (size_t size, const char file, int line, const char function)

void *	operator new (size_t size)

void *	operator new (size_t size, void *pointer)

void *	operator new[] (size_t size, const char file, int line, const char function)

void *	operator new[] (size_t size)

void	operator delete (void *pointer)

void	operator delete (void pointer, void )

void	operator delete (void pointer, const char , int, const char *)

void	operator delete[] (void *pointer)

void	operator delete[] (void pointer, const char , int, const char *)

virtual void	run ()=0

Protected Member Functions
virtual void	run ()

bool	initOpenALDevice ()

void	shutdownOpenALDevice ()

bool	checkError ()

ALenum	convertAudioFormatEnum (AudioFormats format)

void	signalEvent (Events sevent)

Protected Attributes
cAudioMutex	Mutex

IThread *	AudioThread
	Our update thread.

unsigned int	Frequency

AudioFormats	Format

unsigned int	InternalBufferSize

int	SampleSize

cAudioVector< char >::Type	CaptureBuffer

cAudioList< ICaptureEventHandler * >::Type	eventHandlerList

bool	Ready

bool	Capturing

cAudioString	DeviceName

ALCdevice *	CaptureDevice

Detailed Description

Definition at line 17 of file cAudioCapture.h.

Member Enumeration Documentation

◆ Events

enum cAudio::cAudioCapture::Events

Definition at line 21 of file cAudioCapture.h.

Constructor & Destructor Documentation

◆ cAudioCapture()

cAudio::cAudioCapture::cAudioCapture ( )

Definition at line 17 of file cAudioCapture.cpp.

◆ ~cAudioCapture()

cAudio::cAudioCapture::~cAudioCapture ( )

Definition at line 23 of file cAudioCapture.cpp.

Member Function Documentation

◆ beginCapture()

bool cAudio::cAudioCapture::beginCapture ( )

virtual

Starts capturing audio data to an internal buffer. Will clear any old data in the buffer.

Returns: True if capture was successfully started.

Implements cAudio::IAudioCapture.

Definition at line 116 of file cAudioCapture.cpp.

Here is the call graph for this function:

◆ checkError()

bool cAudio::cAudioCapture::checkError ( )

protected

Definition at line 254 of file cAudioCapture.cpp.

◆ convertAudioFormatEnum()

ALenum cAudio::cAudioCapture::convertAudioFormatEnum ( AudioFormats format )

protected

Definition at line 269 of file cAudioCapture.cpp.

◆ getCapturedAudio()

unsigned int cAudio::cAudioCapture::getCapturedAudio	(	void *	outputBuffer,
		unsigned int	outputBufferSize
	)

virtual

Allows access to the audio data in the internal capture buffer.

Can be called at any time to retrieve recorded audio. It is recommended that you call it every so often with long recordings to prevent the internal buffer from growing too large. Once successfully retrieved, the captured audio will be deleted from the internal buffer.

Parameters

outputBuffer	Pointer to an output array to copy audio data to.
outputBufferSize	Size of the output array in bytes.

Returns: Size in bytes of the data actually copied to the output buffer.

Implements cAudio::IAudioCapture.

Definition at line 157 of file cAudioCapture.cpp.

Here is the call graph for this function:

◆ getCapturedAudioBuffer()

AudioCaptureBuffer * cAudio::cAudioCapture::getCapturedAudioBuffer ( )

virtual

this method is the same as getCapturedAudio but it returns an managed CaptureBuffer

Implements cAudio::IAudioCapture.

Definition at line 150 of file cAudioCapture.cpp.

◆ getCurrentCapturedAudioSize()

unsigned int cAudio::cAudioCapture::getCurrentCapturedAudioSize ( )

virtual

Returns the current size of the internal audio buffer in bytes.

Implements cAudio::IAudioCapture.

Definition at line 174 of file cAudioCapture.cpp.

◆ getDeviceName()

virtual const char * cAudio::cAudioCapture::getDeviceName ( )

inlinevirtual

Returns the name of the audio device being used to capture audio.

Implements cAudio::IAudioCapture.

Definition at line 42 of file cAudioCapture.h.

◆ getFormat()

virtual AudioFormats cAudio::cAudioCapture::getFormat ( )

inlinevirtual

Returns the format of the captured audio.

Implements cAudio::IAudioCapture.

Definition at line 44 of file cAudioCapture.h.

◆ getFrequency()

virtual unsigned int cAudio::cAudioCapture::getFrequency ( )

inlinevirtual

Returns the frequency that the captured audio will be at.

Implements cAudio::IAudioCapture.

Definition at line 43 of file cAudioCapture.h.

◆ getInternalBufferSize()

virtual unsigned int cAudio::cAudioCapture::getInternalBufferSize ( )

inlinevirtual

Returns the internal OpenAL buffer size in bytes.

Returns: Size of the buffer in bytes.

Implements cAudio::IAudioCapture.

Definition at line 45 of file cAudioCapture.h.

◆ getSampleSize()

virtual unsigned int cAudio::cAudioCapture::getSampleSize ( )

inlinevirtual

Returns the size of a "sample" of audio data. Useful for making sure you grab audio data at sample boundaries.

Returns: Size of a sample in bytes.

Implements cAudio::IAudioCapture.

Definition at line 46 of file cAudioCapture.h.

◆ initialize()

bool cAudio::cAudioCapture::initialize	(	const char *	deviceName = `0x0`,
		unsigned int	frequency = `22050`,
		AudioFormats	format = `EAF_16BIT_MONO`,
		unsigned int	internalBufferSize = `8192`
	)

virtual

Initializes the capture device to the selected settings.

Note that calling this will cause the capture device to be reinitialized. Calling while in use will clear the internal audio buffer.

Parameters

deviceName	Name of the audio device to capture audio from, pass NULL to specify the default one.
frequency	Frequency that the captured audio will be captured at in hertz.
format	Format of the captured audio.
internalBufferSize	Size of the internal OpenAL buffer used to store the captured audio between calls to getCapturedAudio() in bytes.

Returns: True on success, False if the capture device failed to initialize.

Implements cAudio::IAudioCapture.

Definition at line 223 of file cAudioCapture.cpp.

Here is the caller graph for this function:

◆ initOpenALDevice()

bool cAudio::cAudioCapture::initOpenALDevice ( )

protected

Definition at line 34 of file cAudioCapture.cpp.

◆ isReady()

virtual bool cAudio::cAudioCapture::isReady ( )

inlinevirtual

Returns true if the capture device is ready to be used. False may indicate an error with the current settings.

Implements cAudio::IAudioCapture.

Definition at line 34 of file cAudioCapture.h.

◆ isUpdateThreadRunning()

virtual bool cAudio::cAudioCapture::isUpdateThreadRunning ( )

inlinevirtual

Returns if the thread used to update all Audio Capture Objects is running.

Note: Will always return false if threading is disabled. The library automatically shuts down the thread if no Audio Capture objects exist and will restart the thread on creation of a new object.

Returns: True if the thread is currently running, false otherwise.

Implements cAudio::IAudioCapture.

Definition at line 37 of file cAudioCapture.h.

◆ registerEventHandler()

void cAudio::cAudioCapture::registerEventHandler ( ICaptureEventHandler * handler )

virtual

Registers a new event handler to this manager.

Parameters

handler Pointer to an event handler to attach.

Implements cAudio::IAudioCapture.

Definition at line 286 of file cAudioCapture.cpp.

◆ run()

void cAudio::cAudioCapture::run ( )

protectedvirtual

Implements cAudio::IThreadWorker.

Definition at line 28 of file cAudioCapture.cpp.

◆ setDevice()

bool cAudio::cAudioCapture::setDevice ( const char * deviceName )

virtual

Sets the audio device . Will cause the capture device to be reinitialized. Calling while in use will clear the internal audio buffer.

Parameters

deviceName Name of the audio device to capture audio from, pass NULL to specify the default one.

Returns: True on success, False if the capture device failed to initialize.

Implements cAudio::IAudioCapture.

Definition at line 214 of file cAudioCapture.cpp.

◆ setFormat()

bool cAudio::cAudioCapture::setFormat ( AudioFormats format )

virtual

Sets the format that the captured audio will be at. Will cause the capture device to be reinitialized. Calling while in use will clear the internal audio buffer.

Parameters

format Format of the captured audio.

Returns: True on success, False if the capture device failed to initialize.

Implements cAudio::IAudioCapture.

Definition at line 188 of file cAudioCapture.cpp.

◆ setFrequency()

bool cAudio::cAudioCapture::setFrequency ( unsigned int frequency )

virtual

Sets the frequency that the captured audio will be at. Will cause the capture device to be reinitialized. Calling while in use will clear the internal audio buffer.

Parameters

frequency Frequency that the captured audio will be captured at in hertz.

Returns: True on success, False if the capture device failed to initialize.

Implements cAudio::IAudioCapture.

Definition at line 180 of file cAudioCapture.cpp.

◆ setInternalBufferSize()

bool cAudio::cAudioCapture::setInternalBufferSize ( unsigned int internalBufferSize )

virtual

Sets the internal buffer size that OpenAL will use to store captured audio between calls to getCapturedAudio() in bytes. Will cause the capture device to be reinitialized. Calling while in use will clear the internal audio buffer.

Parameters

internalBufferSize Size of the internal OpenAL buffer in bytes.

Returns: True on success, False if the capture device failed to initialize.

Implements cAudio::IAudioCapture.

Definition at line 205 of file cAudioCapture.cpp.

◆ shutdown()

void cAudio::cAudioCapture::shutdown ( )

virtual

Shuts down the capture device, clearing the internal buffer and setting the audio capture into an uninitialized state. You must call initialize() again in order to reuse this object.

Implements cAudio::IAudioCapture.

Definition at line 75 of file cAudioCapture.cpp.

◆ shutdownOpenALDevice()

void cAudio::cAudioCapture::shutdownOpenALDevice ( )

protected

Definition at line 57 of file cAudioCapture.cpp.

◆ signalEvent()

void cAudio::cAudioCapture::signalEvent ( Events sevent )

protected

Definition at line 307 of file cAudioCapture.cpp.

◆ stopCapture()

void cAudio::cAudioCapture::stopCapture ( )

virtual

Stops capturing audio data to an internal buffer.

Implements cAudio::IAudioCapture.

Definition at line 136 of file cAudioCapture.cpp.

Here is the call graph for this function:

◆ unRegisterAllEventHandlers()

void cAudio::cAudioCapture::unRegisterAllEventHandlers ( )

virtual

Removes all event handlers attached to this manager.

Implements cAudio::IAudioCapture.

Definition at line 302 of file cAudioCapture.cpp.

◆ unRegisterEventHandler()

void cAudio::cAudioCapture::unRegisterEventHandler ( ICaptureEventHandler * handler )

virtual

Removes the specified event handler from this manager.

Parameters

handler Pointer to an event handler to remove.

Implements cAudio::IAudioCapture.

Definition at line 294 of file cAudioCapture.cpp.

◆ updateCaptureBuffer()

void cAudio::cAudioCapture::updateCaptureBuffer ( bool force = false )

virtual

Grabs samples from the OpenAL buffer into the capture buffer if the OpenAL buffer has reached half full. Should be run once every audio frame, unless threading is enabled.

Parameters

force Force capturing data from the buffer, even if the buffer is not half full.

Implements cAudio::IAudioCapture.

Definition at line 90 of file cAudioCapture.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ AudioThread

IThread* cAudio::cAudioCapture::AudioThread

protected

Our update thread.

Definition at line 71 of file cAudioCapture.h.

◆ CaptureBuffer

cAudioVector<char>::Type cAudio::cAudioCapture::CaptureBuffer

protected

Definition at line 81 of file cAudioCapture.h.

◆ CaptureDevice

ALCdevice* cAudio::cAudioCapture::CaptureDevice

protected

Definition at line 88 of file cAudioCapture.h.

◆ Capturing

bool cAudio::cAudioCapture::Capturing

protected

Definition at line 85 of file cAudioCapture.h.

◆ DeviceName

cAudioString cAudio::cAudioCapture::DeviceName

protected

Definition at line 87 of file cAudioCapture.h.

◆ eventHandlerList

cAudioList<ICaptureEventHandler*>::Type cAudio::cAudioCapture::eventHandlerList

protected

Definition at line 82 of file cAudioCapture.h.

◆ Format

AudioFormats cAudio::cAudioCapture::Format

protected

Definition at line 77 of file cAudioCapture.h.

◆ Frequency

unsigned int cAudio::cAudioCapture::Frequency

protected

Definition at line 76 of file cAudioCapture.h.

◆ InternalBufferSize

unsigned int cAudio::cAudioCapture::InternalBufferSize

protected

Definition at line 78 of file cAudioCapture.h.

◆ Mutex

cAudioMutex cAudio::cAudioCapture::Mutex

protected

Definition at line 68 of file cAudioCapture.h.

◆ Ready

bool cAudio::cAudioCapture::Ready

protected

Definition at line 84 of file cAudioCapture.h.

◆ SampleSize

int cAudio::cAudioCapture::SampleSize

protected

Definition at line 79 of file cAudioCapture.h.

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

cAudio/Headers/cAudioCapture.h
cAudio/src/cAudioCapture.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ Events

Constructor & Destructor Documentation

◆ cAudioCapture()

◆ ~cAudioCapture()

Member Function Documentation

◆ beginCapture()

◆ checkError()

◆ convertAudioFormatEnum()

◆ getCapturedAudio()

◆ getCapturedAudioBuffer()

◆ getCurrentCapturedAudioSize()

◆ getDeviceName()

◆ getFormat()

◆ getFrequency()

◆ getInternalBufferSize()

◆ getSampleSize()

◆ initialize()

◆ initOpenALDevice()

◆ isReady()

◆ isUpdateThreadRunning()

◆ registerEventHandler()

◆ run()

◆ setDevice()

◆ setFormat()

◆ setFrequency()

◆ setInternalBufferSize()

◆ shutdown()

◆ shutdownOpenALDevice()

◆ signalEvent()

◆ stopCapture()

◆ unRegisterAllEventHandlers()

◆ unRegisterEventHandler()

◆ updateCaptureBuffer()

Member Data Documentation

◆ AudioThread

◆ CaptureBuffer

◆ CaptureDevice

◆ Capturing

◆ DeviceName

◆ eventHandlerList

◆ Format

◆ Frequency

◆ InternalBufferSize

◆ Mutex

◆ Ready

◆ SampleSize