Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members  

ost::AudioFile Class Reference

A class used to manipulate audio data. audio file access. More...

#include <audio.h>

List of all members.

Public Methods

 AudioFile (const char *fname, unsigned long samples=0)
 AudioFile (const char *fname, audioinfo_t *info, unsigned long min=0)
 AudioFile ()
 ~AudioFile ()
void Open (const char *fname)
void Create (const char *fname, audioinfo_t *info)
void Close (void)
int getBuffer (void *addr, unsigned len)
int putBuffer (void *attr, unsigned len)
audioerror_t getSamples (void *addr, unsigned samples)
audioerror_t putSamples (void *addr, unsigned samples)
audioerror_t Skip (long samples)
audioerror_t setPosition (unsigned long samples=~0l)
audioerror_t getInfo (audioinfo_t *info)
audioerror_t setMinimum (unsigned long samples)
unsigned long getPosition (void)
virtual bool isOpen (void)
virtual bool hasPositioning (void)
audioencoding_t getEncoding (void)
audioformat_t getFormat (void)
unsigned getSampleRate (void)
char * getAnnotation (void)
audioerror_t getError (void)
bool operator! (void)

Protected Methods

virtual bool afCreate (const char *path)
virtual bool afOpen (const char *path)
virtual bool afPeek (unsigned char *data, unsigned size)
virtual int afRead (unsigned char *data, unsigned size)
virtual int afWrite (unsigned char *data, unsigned size)
virtual bool afSeek (unsigned long pos)
virtual void afClose (void)
virtual char * getContinuation (void)
audioerror_t setError (audioerror_t err)
unsigned short getaushort (unsigned char *data)
void setaushort (unsigned char *data, unsigned short value)
unsigned long getaulong (unsigned char *data)
void setaulong (unsigned char *data, unsigned long value)

Protected Attributes

ost::AudioFile:: { ... }  file
int fd
void * handle


Detailed Description

A class used to manipulate audio data. audio file access.

This class provides file level access to audio data stored in different formats. This class also provides the ability to write audio data into a disk file.

Author:
David Sugar <dyfet@ostel.com>


Constructor & Destructor Documentation

ost::AudioFile::AudioFile const char *   fname,
unsigned long   samples = 0
 

ost::AudioFile::AudioFile const char *   fname,
audioinfo_t *   info,
unsigned long   min = 0
 

ost::AudioFile::AudioFile   [inline]
 

ost::AudioFile::~AudioFile   [inline]
 


Member Function Documentation

void ost::AudioFile::Close void  
 

void ost::AudioFile::Create const char *   fname,
audioinfo_t *   info
 

void ost::AudioFile::Open const char *   fname
 

audioerror_t ost::AudioFile::Skip long   samples
 

virtual void ost::AudioFile::afClose void   [protected, virtual]
 

virtual bool ost::AudioFile::afCreate const char *   path [protected, virtual]
 

virtual bool ost::AudioFile::afOpen const char *   path [protected, virtual]
 

virtual bool ost::AudioFile::afPeek unsigned char *   data,
unsigned   size
[protected, virtual]
 

virtual int ost::AudioFile::afRead unsigned char *   data,
unsigned   size
[protected, virtual]
 

virtual bool ost::AudioFile::afSeek unsigned long   pos [protected, virtual]
 

virtual int ost::AudioFile::afWrite unsigned char *   data,
unsigned   size
[protected, virtual]
 

char* ost::AudioFile::getAnnotation void   [inline]
 

int ost::AudioFile::getBuffer void *   addr,
unsigned   len
 

virtual char* ost::AudioFile::getContinuation void   [inline, protected, virtual]
 

audioencoding_t ost::AudioFile::getEncoding void   [inline]
 

audioerror_t ost::AudioFile::getError void   [inline]
 

audioformat_t ost::AudioFile::getFormat void   [inline]
 

audioerror_t ost::AudioFile::getInfo audioinfo_t *   info
 

unsigned long ost::AudioFile::getPosition void  
 

unsigned ost::AudioFile::getSampleRate void   [inline]
 

audioerror_t ost::AudioFile::getSamples void *   addr,
unsigned   samples
 

unsigned long ost::AudioFile::getaulong unsigned char *   data [protected]
 

unsigned short ost::AudioFile::getaushort unsigned char *   data [protected]
 

virtual bool ost::AudioFile::hasPositioning void   [inline, virtual]
 

virtual bool ost::AudioFile::isOpen void   [virtual]
 

bool ost::AudioFile::operator! void   [inline]
 

int ost::AudioFile::putBuffer void *   attr,
unsigned   len
 

audioerror_t ost::AudioFile::putSamples void *   addr,
unsigned   samples
 

audioerror_t ost::AudioFile::setError audioerror_t   err [protected]
 

audioerror_t ost::AudioFile::setMinimum unsigned long   samples
 

audioerror_t ost::AudioFile::setPosition unsigned long   samples = ~0l
 

void ost::AudioFile::setaulong unsigned char *   data,
unsigned long   value
[protected]
 

void ost::AudioFile::setaushort unsigned char *   data,
unsigned short   value
[protected]
 


Member Data Documentation

int ost::AudioFile::fd [protected]
 

union { ... } ost::AudioFile::file [protected]
 

void* ost::AudioFile::handle [protected]
 


The documentation for this class was generated from the following file:
Generated at Sat Nov 3 09:46:02 2001 for ccAudio by doxygen1.2.10 written by Dimitri van Heesch, © 1997-2001