audiere.h File Reference

#include <vector>
#include <string>

Include dependency graph for audiere.h:

Go to the source code of this file.

Namespaces

namespace  audiere
namespace  audiere::hidden

Classes

class  audiere::RefCounted
class  audiere::RefPtr< T >
class  audiere::RefImplementation< Interface >
class  audiere::File
class  audiere::SampleSource
class  audiere::LoopPointSource
class  audiere::OutputStream
class  audiere::Event
 Base interface for event-specific data passed to callbacks. More...
class  audiere::StopEvent
class  audiere::Callback
class  audiere::StopCallback
class  audiere::AudioDevice
class  audiere::SampleBuffer
class  audiere::SoundEffect
class  audiere::CDDevice
class  audiere::MIDIStream
class  audiere::MIDIDevice
struct  audiere::FileFormatDesc
 Describes a file format that Audiere supports. More...
struct  audiere::AudioDeviceDesc
 Describes a supported audio device. More...

Defines

#define ADR_CALL
#define ADR_DECL
#define ADR_FUNCTION(ret)   extern "C" ADR_DECL ret ADR_CALL
#define ADR_METHOD(ret)   virtual ret ADR_CALL

Typedefs

typedef RefPtr< File > audiere::FilePtr
typedef RefPtr< SampleSource > audiere::SampleSourcePtr
typedef RefPtr< LoopPointSource > audiere::LoopPointSourcePtr
typedef RefPtr< OutputStream > audiere::OutputStreamPtr
typedef RefPtr< Event > audiere::EventPtr
typedef RefPtr< StopEvent > audiere::StopEventPtr
typedef RefPtr< Callback > audiere::CallbackPtr
typedef RefPtr< StopCallback > audiere::StopCallbackPtr
typedef RefPtr< AudioDevice > audiere::AudioDevicePtr
typedef RefPtr< SampleBuffer > audiere::SampleBufferPtr
typedef RefPtr< SoundEffect > audiere::SoundEffectPtr
typedef RefPtr< CDDevice > audiere::CDDevicePtr
typedef RefPtr< MIDIStream > audiere::MIDIStreamPtr
typedef RefPtr< MIDIDevice > audiere::MIDIDevicePtr

Enumerations

enum  audiere::SampleFormat { audiere::SF_U8, audiere::SF_S16 }
enum  audiere::FileFormat {
  audiere::FF_AUTODETECT, audiere::FF_WAV, audiere::FF_OGG, audiere::FF_FLAC,
  audiere::FF_MP3, audiere::FF_MOD, audiere::FF_AIFF, audiere::FF_SPEEX
}
enum  audiere::EventType { audiere::ET_STOP }
enum  audiere::SoundEffectType { audiere::SINGLE, audiere::MULTIPLE }

Functions

template<typename T, typename U>
bool audiere::operator== (const RefPtr< T > &a, const RefPtr< U > &b)
template<typename T>
bool audiere::operator== (const RefPtr< T > &a, const T *b)
template<typename T>
bool audiere::operator== (const T *a, const RefPtr< T > &b)
template<typename T, typename U>
bool audiere::operator!= (const RefPtr< T > &a, const RefPtr< U > &b)
template<typename T>
bool audiere::operator!= (const RefPtr< T > &a, const T *b)
template<typename T>
bool audiere::operator!= (const T *a, const RefPtr< T > &b)
const char * audiere::hidden::AdrGetVersion ()
const char * audiere::hidden::AdrGetSupportedFileFormats ()
const char * audiere::hidden::AdrGetSupportedAudioDevices ()
int audiere::hidden::AdrGetSampleSize (SampleFormat format)
AudioDevice * audiere::hidden::AdrOpenDevice (const char *name, const char *parameters)
SampleSource * audiere::hidden::AdrOpenSampleSource (const char *filename, FileFormat file_format)
SampleSource * audiere::hidden::AdrOpenSampleSourceFromFile (File *file, FileFormat file_format)
SampleSource * audiere::hidden::AdrCreateTone (double frequency)
SampleSource * audiere::hidden::AdrCreateSquareWave (double frequency)
SampleSource * audiere::hidden::AdrCreateWhiteNoise ()
SampleSource * audiere::hidden::AdrCreatePinkNoise ()
LoopPointSource * audiere::hidden::AdrCreateLoopPointSource (SampleSource *source)
OutputStream * audiere::hidden::AdrOpenSound (AudioDevice *device, SampleSource *source, bool streaming)
SampleBuffer * audiere::hidden::AdrCreateSampleBuffer (void *samples, int frame_count, int channel_count, int sample_rate, SampleFormat sample_format)
SampleBuffer * audiere::hidden::AdrCreateSampleBufferFromSource (SampleSource *source)
SoundEffect * audiere::hidden::AdrOpenSoundEffect (AudioDevice *device, SampleSource *source, SoundEffectType type)
File * audiere::hidden::AdrOpenFile (const char *name, bool writeable)
File * audiere::hidden::AdrCreateMemoryFile (const void *buffer, int size)
const char * audiere::hidden::AdrEnumerateCDDevices ()
CDDevice * audiere::hidden::AdrOpenCDDevice (const char *name)
MIDIDevice * audiere::hidden::AdrOpenMIDIDevice (const char *name)
const char * audiere::GetVersion ()
void audiere::SplitString (std::vector< std::string > &out, const char *in, char delim)
void audiere::GetSupportedFileFormats (std::vector< FileFormatDesc > &formats)
void audiere::GetSupportedAudioDevices (std::vector< AudioDeviceDesc > &devices)
int audiere::GetSampleSize (SampleFormat format)
AudioDevice * audiere::OpenDevice (const char *name=0, const char *parameters=0)
SampleSource * audiere::OpenSampleSource (const char *filename, FileFormat file_format=FF_AUTODETECT)
SampleSource * audiere::OpenSampleSource (const FilePtr &file, FileFormat file_format=FF_AUTODETECT)
SampleSource * audiere::CreateTone (double frequency)
SampleSource * audiere::CreateSquareWave (double frequency)
SampleSource * audiere::CreateWhiteNoise ()
SampleSource * audiere::CreatePinkNoise ()
LoopPointSource * audiere::CreateLoopPointSource (const SampleSourcePtr &source)
LoopPointSource * audiere::CreateLoopPointSource (const char *filename, FileFormat file_format=FF_AUTODETECT)
LoopPointSource * audiere::CreateLoopPointSource (const FilePtr &file, FileFormat file_format=FF_AUTODETECT)
OutputStream * audiere::OpenSound (const AudioDevicePtr &device, const SampleSourcePtr &source, bool streaming=false)
OutputStream * audiere::OpenSound (const AudioDevicePtr &device, const char *filename, bool streaming=false, FileFormat file_format=FF_AUTODETECT)
OutputStream * audiere::OpenSound (const AudioDevicePtr &device, const FilePtr &file, bool streaming=false, FileFormat file_format=FF_AUTODETECT)
SampleBuffer * audiere::CreateSampleBuffer (void *samples, int frame_count, int channel_count, int sample_rate, SampleFormat sample_format)
SampleBuffer * audiere::CreateSampleBuffer (const SampleSourcePtr &source)
SoundEffect * audiere::OpenSoundEffect (const AudioDevicePtr &device, const SampleSourcePtr &source, SoundEffectType type)
SoundEffect * audiere::OpenSoundEffect (const AudioDevicePtr &device, const char *filename, SoundEffectType type, FileFormat file_format=FF_AUTODETECT)
SoundEffect * audiere::OpenSoundEffect (const AudioDevicePtr &device, const FilePtr &file, SoundEffectType type, FileFormat file_format=FF_AUTODETECT)
File * audiere::OpenFile (const char *filename, bool writeable)
File * audiere::CreateMemoryFile (const void *buffer, int size)
void audiere::EnumerateCDDevices (std::vector< std::string > &devices)
CDDevice * audiere::OpenCDDevice (const char *device)
MIDIDevice * audiere::OpenMIDIDevice (const char *device)


Detailed Description

Audiere Sound System Version 1.9.4 (c) 2001-2003 Chad Austin

This API uses principles explained at http://aegisknight.org/cppinterface.html

This code licensed under the terms of the LGPL. See doc/license.txt.

Note: When compiling this header in gcc, you may want to use the -Wno-non-virtual-dtor flag to get rid of those annoying "class has virtual functions but no virtual destructor" warnings.

This file is structured as follows:

Definition in file audiere.h.


Define Documentation

#define ADR_CALL
 

Definition at line 47 of file audiere.h.

#define ADR_DECL
 

Definition at line 60 of file audiere.h.

#define ADR_FUNCTION ret   )     extern "C" ADR_DECL ret ADR_CALL
 

Definition at line 66 of file audiere.h.

#define ADR_METHOD ret   )     virtual ret ADR_CALL
 

Definition at line 67 of file audiere.h.


Generated on Mon Feb 13 23:07:15 2006 for audiere by  doxygen 1.4.6