.TH "AudioFile" 3 "23 Jul 2003" "ccAudio" \" -*- nroff -*-
.ad l
.nh
.SH NAME
AudioFile \- A class used to manipulate audio data. audio file access. 
.SH SYNOPSIS
.br
.PP
\fC#include <audio.h>\fP
.PP
Inherits \fBAudio\fP.
.PP
.SS "Public Methods"

.in +1c
.ti -1c
.RI "void \fBopen\fP (const char *fname)"
.br
.RI "\fIOpen an audio file and associate it with this object.\fP"
.ti -1c
.RI "void \fBcreate\fP (const char *fname, Info *info)"
.br
.RI "\fICreate a new audio file and associate it with this object.\fP"
.ti -1c
.RI "void \fBclose\fP (void)"
.br
.RI "\fIClose an object associated with an open file.\fP"
.ti -1c
.RI "void \fBclear\fP (void)"
.br
.RI "\fIClear the AudioFile structure.\fP"
.ti -1c
.RI "int \fBgetBuffer\fP (void *addr, unsigned len)"
.br
.RI "\fIRetrieve bytes from the file into a memory buffer.\fP"
.ti -1c
.RI "unsigned \fBgetLinear\fP (Linear buffer, unsigned request)"
.br
.RI "\fIRetrieve and convert content to linear encoded audio data from it's original form.\fP"
.ti -1c
.RI "int \fBputBuffer\fP (void *attr, unsigned len)"
.br
.RI "\fIInsert bytes into the file from a memory buffer.\fP"
.ti -1c
.RI "unsigned \fBputLinear\fP (Linear buffer, unsigned request)"
.br
.RI "\fIConvert and store content from linear encoded audio data to the format of the audio file.\fP"
.ti -1c
.RI "Error \fBgetSamples\fP (void *addr, unsigned samples)"
.br
.RI "\fIRetrieve samples from the file into a memory buffer.\fP"
.ti -1c
.RI "Error \fBputSamples\fP (void *addr, unsigned samples)"
.br
.RI "\fIInsert samples into the file from a memory buffer.\fP"
.ti -1c
.RI "unsigned long \fBgetAbsolutePosition\fP (void)"
.br
.RI "\fIGet the current file pointer in bytes relative to the start of the file.\fP"
.ti -1c
.RI "unsigned long \fBgetPosition\fP (void)"
.br
.RI "\fIGet the current file pointer in samples relative to the start of the sample buffer.\fP"
.ti -1c
.RI "bool \fBisSigned\fP (void)"
.br
.RI "\fIReturn if the current content is signed or unsigned samples.\fP"
.in -1c
.SS "Protected Methods"

.in +1c
.ti -1c
.RI "virtual int \fBafRead\fP (unsigned char *data, unsigned size)"
.br
.RI "\fIRead a given number of bytes from the file, starting from the current file pointer.\fP"
.ti -1c
.RI "virtual int \fBafWrite\fP (unsigned char *data, unsigned size)"
.br
.RI "\fIWrite a number of bytes into the file at the current file pointer.\fP"
.ti -1c
.RI "virtual bool \fBafSeek\fP (unsigned long pos)"
.br
.RI "\fISeek to the given position relative to the start of the file and set the file pointer.\fP"
.ti -1c
.RI "const char * \fBgetErrorStr\fP (Error err)"
.br
.RI "\fIReturn a human-readable error message given a numeric error code of type Audio::Error.\fP"
.in -1c
.SH "DETAILED DESCRIPTION"
.PP 
A class used to manipulate audio data. audio file access.
.PP
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.
.PP
\fBAuthor: \fP
.in +1c
David Sugar <dyfet@ostel.com> 
.PP
.SH "MEMBER FUNCTION DOCUMENTATION"
.PP 
.SS "virtual int AudioFile::afRead (unsigned char * data, unsigned size)\fC [protected, virtual]\fP"
.PP
Read a given number of bytes from the file, starting from the current file pointer.
.PP
May be overridden by derived classes.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIdata\fP\fP
A pointer to the buffer to copy the bytes to. 
.TP
\fB\fIsize\fP\fP
The number of bytes to read. 
.PP
\fBReturns: \fP
.in +1c
The number of bytes read, or -1 if an error occurs. On UNIX platforms, use strerror(errno) to get the human-readable error string or FormatMessage(GetLastError()) on Windows platforms. 
.SS "virtual bool AudioFile::afSeek (unsigned long pos)\fC [protected, virtual]\fP"
.PP
Seek to the given position relative to the start of the file and set the file pointer.
.PP
This does not use 64-bit clean seek functions, so seeking to positions greater than (2^32)-1 will result in undefined behavior.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIpos\fP\fP
The position to seek to. 
.PP
\fBReturns: \fP
.in +1c
true if successful, false otherwise. 
.SS "virtual int AudioFile::afWrite (unsigned char * data, unsigned size)\fC [protected, virtual]\fP"
.PP
Write a number of bytes into the file at the current file pointer.
.PP
May be overridden by derived classes.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIdata\fP\fP
A pointer to the buffer with the bytes to write. 
.TP
\fB\fIsize\fP\fP
The number of bytes to write from the buffer. 
.PP
\fBReturns: \fP
.in +1c
The number of bytes written, or -1 if an error occurs. On UNIX platforms, use strerror(errno) to get the human-readable error string or FormatMessage(GetLastError()) on Windows platforms. 
.SS "void AudioFile::clear (void)"
.PP
Clear the AudioFile structure.
.PP
Called by \fBAudioFile::close()\fP. Sets all fields to zero and deletes the dynamically allocated memory pointed to by the pathname and info.annotation members. See AudioFile::initialize() for the dynamic allocation code. 
.SS "void AudioFile::close (void)"
.PP
Close an object associated with an open file.
.PP
This updates the header metadata with the file length if the file length has changed. 
.SS "void AudioFile::create (const char * fname, Info * info)"
.PP
Create a new audio file and associate it with this object.
.PP
Called implicitly by the three-argument version of the constructor.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIfname\fP\fP
The name of the file to open. 
.TP
\fB\fIinfo\fP\fP
The type of the audio file to be created. 
.SS "unsigned long AudioFile::getAbsolutePosition (void)"
.PP
Get the current file pointer in bytes relative to the start of the file.
.PP
See \fBgetPosition()\fP to determine the position relative to the start of the sample buffer.
.PP
\fBReturns: \fP
.in +1c
The current file pointer in bytes relative to the start of the file. Returns 0 if the file is not open, is empty, or an error has occured. 
.SS "int AudioFile::getBuffer (void * addr, unsigned len)"
.PP
Retrieve bytes from the file into a memory buffer.
.PP
This increments the file pointer so subsequent calls read further bytes. If you want to read a number of samples rather than bytes, use \fBgetSamples()\fP.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIaddr\fP\fP
A pointer to the memory area to copy the samples to. 
.TP
\fB\fIlen\fP\fP
The number of bytes (not samples) to copy. 
.PP
\fBReturns: \fP
.in +1c
The number of bytes (not samples) read. Returns -1 if no bytes are read and an error occurs. 
.SS "const char* AudioFile::getErrorStr (Error err)\fC [protected]\fP"
.PP
Return a human-readable error message given a numeric error code of type Audio::Error.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIerr\fP\fP
The numeric error code to translate. 
.PP
\fBReturns: \fP
.in +1c
A pointer to a character string containing the human-readable error message. 
.SS "unsigned AudioFile::getLinear (Linear buffer, unsigned request)"
.PP
Retrieve and convert content to linear encoded audio data from it's original form.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIaddr\fP\fP
A pointer to copy linear data into. 
.TP
\fB\fIlen\fP\fP
Number of linear samples to extract. 
.PP
\fBReturns: \fP
.in +1c
number of samples retrieved, 0 if no codec or eof. 
.SS "unsigned long AudioFile::getPosition (void)"
.PP
Get the current file pointer in samples relative to the start of the sample buffer.
.PP
Note that you must multiply this result by the result of a call to toBytes(info.encoding, 1) in order to determine the offset in bytes.
.PP
\fBReturns: \fP
.in +1c
the current file pointer in samples relative to the start of the sample buffer. Returns 0 if the file is not open, is empty, or an error has occured. 
.SS "Error AudioFile::getSamples (void * addr, unsigned samples)"
.PP
Retrieve samples from the file into a memory buffer.
.PP
This increments the file pointer so subsequent calls read further samples. If a limit has been set using setLimit(), the number of samples read will be truncated to the limit position. If you want to read a certain number of bytes rather than a certain number of samples, use \fBgetBuffer()\fP.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIaddr\fP\fP
A pointer to the memory area to copy the samples to. 
.TP
\fB\fIsamples\fP\fP
The number of samples to read. 
.PP
\fBReturns: \fP
.in +1c
errSuccess if successful, !errSuccess if error. Use \fBgetErrorStr()\fP to retrieve the human-readable error string. 
.SS "bool AudioFile::isSigned (void)"
.PP
Return if the current content is signed or unsigned samples.
.PP
\fBReturns: \fP
.in +1c
true if signed. 
.SS "void AudioFile::open (const char * fname)"
.PP
Open an audio file and associate it with this object.
.PP
Called implicitly by the two-argument version of the constructor.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIfname\fP\fP
The name of the file to open. Don't forget to double your backslashes for DOS-style pathnames. 
.SS "int AudioFile::putBuffer (void * attr, unsigned len)"
.PP
Insert bytes into the file from a memory buffer.
.PP
This increments the file pointer so subsequent calls append further samples. If you want to write a number of samples rather than bytes, use \fBputSamples()\fP.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIattr\fP\fP
A pointer to the memory area to append the samples from. 
.TP
\fB\fIlen\fP\fP
The number of bytes (not samples) to append. 
.PP
\fBReturns: \fP
.in +1c
The number of bytes (not samples) read. Returns -1 if an error occurs and no bytes are written. 
.SS "unsigned AudioFile::putLinear (Linear buffer, unsigned request)"
.PP
Convert and store content from linear encoded audio data to the format of the audio file.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIaddr\fP\fP
A pointer to copy linear data from. 
.TP
\fB\fIlen\fP\fP
Number of linear samples to save. 
.PP
\fBReturns: \fP
.in +1c
number of samples saved, 0 if no codec or eof. 
.SS "Error AudioFile::putSamples (void * addr, unsigned samples)"
.PP
Insert samples into the file from a memory buffer.
.PP
This increments the file pointer so subsequent calls append further samples. If you want to write a certain number of bytes rather than a certain number of samples, use \fBputBuffer()\fP.
.PP
\fBParameters: \fP
.in +1c
.TP
\fB\fIaddr\fP\fP
A pointer to the memory area to append the samples from. 
.TP
\fB\fIsamples\fP\fP
The number of samples (not bytes) to append. 
.PP
\fBReturns: \fP
.in +1c
errSuccess if successful, !errSuccess if error. Use \fBgetErrorStr()\fP to retrieve the human-readable error string. 

.SH "AUTHOR"
.PP 
Generated automatically by Doxygen for ccAudio from the source code.