Main Page | Modules | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members

ark Namespace Reference


Classes

class  Alternate
struct  Assign
struct  AssignAscending
struct  AssignDescending
struct  AssignAscendingStride
struct  AssignDescendingStride
class  AsyncConsumer
class  AsyncNotifier
class  AsyncProducer
class  Atomic< int >
class  Atomic< unsigned >
class  Atomic< bool >
class  TimeInterval
class  TimeStamp
class  AudioUnitChain
class  Fifo
class  GenericCommand
class  GenericNotification
class  SystemAllocator
class  SimplePool
class  MissingMemory
class  AllocatorAuditor
class  ThreadSafeAllocatorAuditor
class  Allocator
class  MemoryDeallocServer
class  MemoryGate
struct  MemoryMessage
class  MessagePort
class  Notifier
class  Observer
class  SoundChunk
class  SoundFile_libsndfile
class  SoundPlayer
class  SoundRegion
class  SoundResource
class  SoundFile
class  SoundStreamer
class  SoundTime
struct  Overflow_Template
 Raised when an operation could not complete because of no room available in some queue. More...
struct  Underflow
 Raised when an operation cannot complete because there is not enough data in some queue. More...
class  SoundStreamerCreationPolicy< async_producer_policies::GenericDescription< SoundStreamerDescription > >

Namespaces

namespace  async_consumer_policies
namespace  async_producer_policies
namespace  detail
namespace  impl
namespace  memory_gate_policies

Typedefs

typedef semaphore_t Semaphore
typedef float Sample
typedef boost::shared_ptr<
SoundPlayer
SoundPlayerRef
typedef boost::tuple< unsigned,
unsigned, int > 
SoundStreamerDescription
typedef boost::tuple< SoundChunk,
SoundStreamerDescription
SoundStreamerChunk

Enumerations

enum  {
  LOG_MIN = 1, LOG_TRACE = 10, LOG_NORMAL = 20, LOG_HIGH = 30,
  LOG_MAX = 40
}

Functions

std::ostream & operator<< (std::ostream &os, TimeInterval const &ti)
std::ostream & operator<< (std::ostream &os, TimeStamp const &ts)
OSStatus AudioUnitChainCallback (void *inRefCon, AudioUnitRenderActionFlags *ioActionFlags, const AudioTimeStamp *inTimeStamp, UInt32 inBusNumber, UInt32 inNumberFrames, AudioBufferList *ioData)
template<typename T, typename Sub_t, typename Time_t, typename Tag_t, int fullSize>
boost::call_traits< T >::reference Get (GenericNotification< Sub_t, Time_t, Tag_t, fullSize > &note)
template<typename T, typename Sub_t, typename Time_t, typename Tag_t, int fullSize>
T * GetArray (GenericNotification< Sub_t, Time_t, Tag_t, fullSize > &note)
template<typename T, typename Sub_t, typename Time_t, typename Tag_t, int fullSize>
boost::call_traits< T >::const_reference Get (GenericNotification< Sub_t, Time_t, Tag_t, fullSize > const &note)
template<typename T, typename Sub_t, typename Time_t, typename Tag_t, int fullSize>
T const * GetArray (GenericNotification< Sub_t, Time_t, Tag_t, fullSize > const &note)
template<typename T>
T * AllocBuffer (unsigned count, Allocator &alloc=SystemAllocator::global())
template<typename T>
bool DeallocBuffer (T *buff, unsigned count, Allocator &alloc=SystemAllocator::global())
Semaphore CreateSemaphore ()
void DestroySemaphore (Semaphore sem)
void SignalSemaphore (Semaphore sem)
void WaitSemaphore (Semaphore sem, unsigned secs, unsigned nanos)
SampleInterleave (SoundChunk const &chunk, Allocator &alloc=SystemAllocator::global())
SoundChunk Deinterleave (Sample const *data, const unsigned channels, const unsigned frames, Allocator &alloc=SystemAllocator::global())
std::ostream & operator<< (std::ostream &os, SoundRegion const &reg)
bool RegionsOverlap (SoundRegion const &reg1, SoundRegion const &reg2)
SoundRegion UnionRegion (SoundRegion const &reg1, SoundRegion const &reg2)
static std::string _locationParam (ERR_LOCATION l)
void Log (std::string msg, unsigned thresh=1, bool fl=true)

Variables

const unsigned ONE_HUNDRED = 100
const unsigned ONE_THOUSAND = 1000
const unsigned TEN_THOUSAND = 10000
const unsigned ONE_HUNDRED_THOUSAND = 100000
const unsigned ONE_MILLION = 1000000
const unsigned TEN_MILLION = 10000000
const unsigned ONE_HUNDRED_MILLION = 100000000
const unsigned ONE_BILLION = 1000000000


Detailed Description

Note:
There used to be non shared_ptr versions of the below policies, but I fould that using shared_ptr's was far safer (and easier), thus far more commonly used, and removed all non- shared_ptr based policy classes.


Typedef Documentation

typedef float ark::Sample
 

typedef semaphore_t ark::Semaphore
 

typedef boost::shared_ptr<SoundPlayer> ark::SoundPlayerRef
 

typedef boost::tuple<SoundChunk, SoundStreamerDescription> ark::SoundStreamerChunk
 

typedef boost::tuple<unsigned, unsigned, int> ark::SoundStreamerDescription
 


Enumeration Type Documentation

anonymous enum
 

A few default logging levels, to fine tune output. You can use a level with a midifier between 1 and 9, such as NORMAL_LOG + 5 if you want extreme control over output.

Enumerator:
LOG_MIN 
LOG_TRACE 
LOG_NORMAL 
LOG_HIGH 
LOG_MAX 


Function Documentation

static std::string ark::_locationParam ERR_LOCATION  l  )  [inline, static]
 

template<typename T>
T* ark::AllocBuffer unsigned  count,
Allocator &  alloc = SystemAllocator::global()
[inline]
 

OSStatus ark::AudioUnitChainCallback void *  inRefCon,
AudioUnitRenderActionFlags *  ioActionFlags,
const AudioTimeStamp *  inTimeStamp,
UInt32  inBusNumber,
UInt32  inNumberFrames,
AudioBufferList *  ioData
 

Semaphore ark::CreateSemaphore  )  [inline]
 

CreateSemaphore Creates and returns a platform dependant semaphore.

Returns:
An initialized platform dependant semaphore
See also:
DestroySemaphore()

template<typename T>
bool ark::DeallocBuffer T *  buff,
unsigned  count,
Allocator &  alloc = SystemAllocator::global()
[inline]
 

SoundChunk ark::Deinterleave Sample const *  data,
const unsigned  channels,
const unsigned  frames,
Allocator &  alloc = SystemAllocator::global()
[inline]
 

DeinterleavedChunk Creates a new chunk holding the deinterleaved channels of the parameter.

Parameters:
data The interleaved sample buffer to deinterleave
frames The number of frames in the interleaved buffer
channels The number of channels in the interleaved buffer
alloc Optional allocator defines how the return chunk gets it's memory
See also:
Interleave()

void ark::DestroySemaphore Semaphore  sem  )  [inline]
 

DestroySemaphore Destroys the platform dependant semaphore 'sem'.

Parameters:
sem The semaphore to destroy

template<typename T, typename Sub_t, typename Time_t, typename Tag_t, int fullSize>
boost::call_traits<T>::const_reference ark::Get GenericNotification< Sub_t, Time_t, Tag_t, fullSize > const &  note  )  [inline]
 

template<typename T, typename Sub_t, typename Time_t, typename Tag_t, int fullSize>
boost::call_traits<T>::reference ark::Get GenericNotification< Sub_t, Time_t, Tag_t, fullSize > &  note  )  [inline]
 

template<typename T, typename Sub_t, typename Time_t, typename Tag_t, int fullSize>
T const* ark::GetArray GenericNotification< Sub_t, Time_t, Tag_t, fullSize > const &  note  )  [inline]
 

template<typename T, typename Sub_t, typename Time_t, typename Tag_t, int fullSize>
T* ark::GetArray GenericNotification< Sub_t, Time_t, Tag_t, fullSize > &  note  )  [inline]
 

Sample* ark::Interleave SoundChunk const &  chunk,
Allocator &  alloc = SystemAllocator::global()
[inline]
 

Interleave Creates a new buffer holding the interleaved channels of the parameter.

Parameters:
chunk The chunk to interleave
alloc An optional allocator to define how memory is allocated, default is SystemAllocator
Returns:
The interleaved sound buffer
See also:
Deinterleave()

void ark::Log std::string  msg,
unsigned  thresh = 1,
bool  fl = true
[inline]
 

std::ostream& ark::operator<< std::ostream &  os,
SoundRegion const &  reg
[inline]
 

std::ostream& ark::operator<< std::ostream &  os,
TimeStamp const &  ts
[inline]
 

std::ostream& ark::operator<< std::ostream &  os,
TimeInterval const &  ti
[inline]
 

bool ark::RegionsOverlap SoundRegion const &  reg1,
SoundRegion const &  reg2
[inline]
 

void ark::SignalSemaphore Semaphore  sem  )  [inline]
 

SignalSemaphore Signals the platform dependant sempahore 'sem'.

Parameters:
sem The semaphore to signal

SoundRegion ark::UnionRegion SoundRegion const &  reg1,
SoundRegion const &  reg2
[inline]
 

void ark::WaitSemaphore Semaphore  sem,
unsigned  secs,
unsigned  nanos
[inline]
 

WaitSemaphore Waits for a platform specific semaphore until timeout or it is signalled, and returns whether it was signaled or not.

Parameters:
sem The semaphore to wait on
secs The amount of seconds to wait
nanos The amount of nanoseconds to wait


Variable Documentation

const unsigned ark::ONE_BILLION = 1000000000
 

const unsigned ark::ONE_HUNDRED = 100
 

const unsigned ark::ONE_HUNDRED_MILLION = 100000000
 

const unsigned ark::ONE_HUNDRED_THOUSAND = 100000
 

const unsigned ark::ONE_MILLION = 1000000
 

const unsigned ark::ONE_THOUSAND = 1000
 

const unsigned ark::TEN_MILLION = 10000000
 

const unsigned ark::TEN_THOUSAND = 10000
 


Generated on Tue Sep 6 14:54:39 2005 for Arkonnekt Sound by  doxygen 1.4.4