Main namespace for the entire cAudio library. More...
Classes | |
| class | cVector3 |
| Class for manipulating vectors in 3D space. More... | |
| class | IAudioCapture |
| Interface for capturing operations in the cAudio Engine. More... | |
| class | IAudioDecoder |
| Interface for all Audio Decoders in cAudio. More... | |
| class | IAudioDecoderFactory |
| Interface for factories that create Audio Decoders for cAudio. More... | |
| class | IAudioEffects |
| Interface for Audio Effects in cAudio. More... | |
| class | IAudioManager |
| Interface for the playback capabilities of cAudio. More... | |
| class | IAudioPlugin |
| Interface for all plugins in cAudio. More... | |
| class | IAudioSource |
| Interface for a single audio source, which allow you to manipulate sound sources (speakers) in 2D or 3D space. More... | |
| class | ICaptureEventHandler |
| Interface for recieving Capture Manager Events. More... | |
| class | IDataSource |
| Interface for data providers in cAudio. More... | |
| class | IDataSourceFactory |
| Interface for creating data sources for use with the engine. More... | |
| class | IEffect |
| Interface for a single effect in cAudio. More... | |
| struct | sEAXReverbParameters |
| Contains parameters for the EAX Reverb Effect. This effect tries to simulate how sound behaves in different environments. More... | |
| struct | sReverbParameters |
| Similar to the above EAX Reverb Effect, but has less features, meaning it may be better supported on lower end hardware. More... | |
| struct | sChorusParameters |
| The chorus effect essentially replays the input audio accompanied by another slightly delayed version of the signal, creating a "doubling" effect. More... | |
| struct | sDistortionParameters |
| The distortion effect simulates turning up (overdriving) the gain stage on a guitar amplifier or adding a distortion pedal to an instrument's output. More... | |
| struct | sEchoParameters |
| The echo effect generates discrete, delayed instances of the input signal. More... | |
| struct | sFlangerParameters |
| The flanger effect creates a "tearing" or "whooshing" sound (like a jet flying overhead). More... | |
| struct | sFrequencyShiftParameters |
| The frequency shifter is a single-sideband modulator, which translates all the component frequencies of the input signal by an equal amount. More... | |
| struct | sVocalMorpherParameters |
| The vocal morpher consists of a pair of 4-band formant filters, used to impose vocal tract effects upon the input signal. More... | |
| struct | sPitchShifterParameters |
| The pitch shifter applies time-invariant pitch shifting to the input signal, over a one octave range and controllable at a semi-tone and cent resolution. More... | |
| struct | sRingModulatorParameters |
| The ring modulator multiplies an input signal by a carrier signal in the time domain, resulting in tremolo or inharmonic effects. More... | |
| struct | sAutowahParameters |
| The Auto-wah effect emulates the sound of a wah-wah pedal used with an electric guitar, or a mute on a brass instrument. More... | |
| struct | sCompressorParameters |
| The Automatic Gain Control effect performs the same task as a studio compressor, evening out the audio dynamic range of an input sound. More... | |
| struct | sEqualizerParameters |
| The OpenAL Effects Extension EQ is very flexible, providing tonal control over four different adjustable frequency ranges. More... | |
| class | IFilter |
| Interface for a filter in cAudio. More... | |
| class | IListener |
| Interface for the listener in cAudio. This class provides abilities to move and orient where your camera or user is in the audio world. More... | |
| class | ILogger |
| Interface for all logging operations in cAudio. More... | |
| class | ILogReceiver |
| Interface for receiving log messages and relaying them to some kind of output device or stream. More... | |
| class | IManagerEventHandler |
| Interface for event handlers for playback manager events. More... | |
| class | IMemoryProvider |
| Interface for a class that allocates and frees memory used by cAudio. More... | |
| class | IPluginManager |
| Interface for the plugin capabilities of cAudio. More... | |
| class | IRefCounted |
| Applies reference counting to certain cAudio objects. More... | |
| class | ISourceEventHandler |
| Interface for event handlers on Audio Sources. More... | |
| class | cAudioCapture |
| class | cAudioEffects |
| class | cAudioManager |
| class | cAudioSource |
| class | cConsoleLogReceiver |
| class | cEffect |
| struct | cEFXFunctions |
| EFX Extension function pointers and setup. More... | |
| class | cFileLogReceiver |
| class | cFileSource |
| class | cFileSourceFactory |
| class | cFilter |
| class | cListener |
| class | cLogger |
| class | cMemoryOverride |
| Overrides the memory allocations for classes derived from it and makes them use the cAudio memory system. More... | |
| class | cMemorySource |
| Class used to read from a memory buffer. More... | |
| class | cMemoryTracker |
| Tracks all allocations that go through cAudio's memory system and keeps statistics on it. More... | |
| class | cAudioMutex |
| Basic mutex class used for internal thread locking. More... | |
| class | cAudioMutexBasicLock |
| class | cOggAudioDecoderFactory |
| class | cOggDecoder |
| class | cPluginManager |
| class | cRawAudioDecoderFactory |
| class | cRawDecoder |
| class | cStandardMemoryProvider |
| Memory provider that wraps the standard memalloc and free. More... | |
| class | cSTLAllocator |
| Reroutes allocations from STL containers into cAudio's memory system. More... | |
| class | cSTLAllocator< void > |
| struct | cAudioMap |
| struct | cAudioSet |
| struct | cAudioList |
| struct | cAudioVector |
| class | cAudioThread |
| class | cWavAudioDecoderFactory |
| class | cWavDecoder |
Typedefs | |
| typedef IAudioPlugin *(* | GetPluginModule )(const char *version) |
|
typedef std::basic_string < char, std::char_traits< char > , cSTLAllocator< char > > | cAudioString |
Enumerations | |
| enum | AudioFormats { EAF_8BIT_MONO, EAF_8BIT_STEREO, EAF_16BIT_MONO, EAF_16BIT_STEREO } |
Enumeration of audio formats supported by the engine. | |
| enum | EffectTypes { EET_NULL, EET_EAX_REVERB, EET_REVERB, EET_CHORUS, EET_DISTORTION, EET_ECHO, EET_FLANGER, EET_FREQUENCY_SHIFTER, EET_VOCAL_MORPHER, EET_PITCH_SHIFTER, EET_RING_MODULATOR, EET_AUTOWAH, EET_COMPRESSOR, EET_EQUALIZER, EET_COUNT } |
Enum of all available effect types in cAudio. | |
| enum | FilterTypes { EFT_NULL, EFT_LOWPASS, EFT_HIGHPASS, EFT_BANDPASS, EFT_COUNT } |
Enum of all available filter types in cAudio. | |
| enum | LogLevel { ELL_DEBUG, ELL_INFO, ELL_WARNING, ELL_ERROR, ELL_CRITICAL, ELL_COUNT } |
Enum of all supported log levels in cAudio. | |
Functions | |
| CAUDIO_API IMemoryProvider * | getMemoryProvider () |
| Returns a pointer to the memory provider of cAudio. | |
| CAUDIO_API void | cAudioSleep (unsigned int ms) |
| Causes the current thread to give up control for a certain duration. | |
| bool | float_equals (const float a, const float b) |
| Internal function that compares two floats while keeping the Epsilon in mind. | |
| CAUDIO_API IAudioCapture * | createAudioCapture (bool initializeDefault=true) |
| Creates an interface to an Audio Capture Object. | |
| CAUDIO_API void | destroyAudioCapture (IAudioCapture *capture) |
| Destroys an interface to a previously created Audio Capture Object and frees the memory allocated for it. | |
| CAUDIO_API bool | isAudioCaptureThreadRunning () |
| Returns if the thread used to update all Audio Capture Objects is running. | |
| CAUDIO_API IAudioManager * | createAudioManager (bool initializeDefault=true) |
| Creates an interface to an Audio Manager. | |
| CAUDIO_API void | destroyAudioManager (IAudioManager *manager) |
| Destroys an interface to a previously created Audio Manager and frees the memory allocated for it. | |
| CAUDIO_API bool | isAudioManagerThreadRunning () |
| Returns if the thread used to update all Audio Managers is running. | |
| CAUDIO_API ILogger * | getLogger () |
| Gets the interface to the logger. | |
| CAUDIO_API IPluginManager * | getPluginManager () |
| Gets the interface to the plugin manager. | |
| CAUDIO_DECLARE_THREAD_FUNCTION (AudioCaptureUpdateThread) | |
| CAUDIO_DECLARE_THREAD_FUNCTION (AudioManagerUpdateThread) | |
| bool | compareDataSourcePriorities (std::pair< int, cAudioString > left, std::pair< int, cAudioString > right) |
| size_t | VorbisRead (void *ptr, size_t byteSize, size_t sizeToRead, void *datasource) |
| Read Vorbis Data. | |
| int | VorbisSeek (void *datasource, ogg_int64_t offset, int whence) |
| Seek Vorbis Data. | |
| long | VorbisTell (void *datasource) |
| Returns the vorbis data that was stored. | |
| int | VorbisCloseFunc (void *datasource) |
| template<typename T > | |
| bool | operator== (const cSTLAllocator< T > &, const cSTLAllocator< T > &) |
| template<typename T > | |
| bool | operator!= (const cSTLAllocator< T > &, const cSTLAllocator< T > &) |
Variables | |
| const float | Epsilon = 0.000001f |
| Smallest number that can be represented with a 32 bit float (may not match your compiler/os varient). | |
| const char *const | LogLevelStrings [] |
| Contains strings for each log level to make them easier to print to a stream. | |
Main namespace for the entire cAudio library.
| void cAudio::cAudioSleep | ( | unsigned int | ms | ) |
Causes the current thread to give up control for a certain duration.
| ms,: | amount of miliseconds to sleep |
Definition at line 19 of file cAudioSleep.cpp.
| CAUDIO_API IAudioCapture * cAudio::createAudioCapture | ( | bool | initializeDefault = true |
) |
Creates an interface to an Audio Capture Object.
Note: This is the only way to get access to the audio capture capabilities of cAudio. You must delete this interface using destroyAudioCapture() once you are done with it.
| initializeDefault,: | Whether to return an object initialized with the default settings. If set to false, you must make a call to initialize before audio can be captured. |
Definition at line 340 of file cAudioCapture.cpp.
| CAUDIO_API IAudioManager * cAudio::createAudioManager | ( | bool | initializeDefault = true |
) |
Creates an interface to an Audio Manager.
Note: This is the only way to get access to the audio playback capabilities of cAudio. You must delete this interface using destroyAudioManager() once you are done with it.
| initializeDefault,: | Whether to return an object initialized with the default settings. If set to false, you must make a call to initialize before you can create audio sources. |
Definition at line 726 of file cAudioManager.cpp.
| CAUDIO_API void cAudio::destroyAudioCapture | ( | IAudioCapture * | capture | ) |
Destroys an interface to a previously created Audio Capture Object and frees the memory allocated for it.
| capture,: | The object to destroy |
Definition at line 369 of file cAudioCapture.cpp.
| CAUDIO_API void cAudio::destroyAudioManager | ( | IAudioManager * | manager | ) |
Destroys an interface to a previously created Audio Manager and frees the memory allocated for it.
| capture,: | The object to destroy. |
Definition at line 770 of file cAudioManager.cpp.
| CAUDIO_API ILogger * cAudio::getLogger | ( | ) |
Gets the interface to the logger.
Note: This is the only way to get access to the logging capabilities of cAudio.
Definition at line 151 of file cLogger.cpp.
| CAUDIO_API IMemoryProvider * cAudio::getMemoryProvider | ( | ) |
Returns a pointer to the memory provider of cAudio.
Used by cAudio for all allocations of memory
Definition at line 6 of file cAudioMemory.cpp.
| CAUDIO_API IPluginManager * cAudio::getPluginManager | ( | ) |
Gets the interface to the plugin manager.
Note: This is the only way to get access to the plugin capabilities of cAudio.
Definition at line 174 of file cPluginManager.cpp.
| CAUDIO_API bool cAudio::isAudioCaptureThreadRunning | ( | ) |
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.
Definition at line 396 of file cAudioCapture.cpp.
| CAUDIO_API bool cAudio::isAudioManagerThreadRunning | ( | ) |
Returns if the thread used to update all Audio Managers is running.
Note: Will always return false if threading is disabled. The library automatically shuts down the thread if no Audio Managers exist and will restart the thread on creation of a new manager.
Definition at line 802 of file cAudioManager.cpp.
| const char* const cAudio::LogLevelStrings[] |
{
"Debug",
"Information",
"Warning",
"Error",
"Critical",
0
}
Contains strings for each log level to make them easier to print to a stream.
Definition at line 22 of file ILogReceiver.h.
1.6.2