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

#include <audio2.h>

Inheritance diagram for ost::AudioFile:

Public Member Functions
	AudioFile (const char *name, unsigned long offset=0)
	Construct and open an existing audio file for read/write.
	AudioFile (const char name, Info info, unsigned long minimum=0)
	Create and open a new audio file for writing.
	AudioFile ()
	Construct an audio file without attaching to the filesystem.
virtual	~AudioFile ()
void	open (const char *name, Mode mode=modeWrite, timeout_t framing=0)
	Open an audio file and associate it with this object.
void	create (const char name, Info info, bool exclusive=false, timeout_t framing=0)
	Create a new audio file and associate it with this object.
time_t	getAge (void)
	Returns age since last prior access.
size_t	getSize (void)
	Get maximum size of frame buffer for data use.
void	close (void)
	Close an object associated with an open file.
void	clear (void)
	Clear the AudioFile structure.
ssize_t	getBuffer (Encoded buffer, size_t len=0)
	Retrieve bytes from the file into a memory buffer.
unsigned	getLinear (Linear buffer, unsigned request=0)
	Retrieve and convert content to linear encoded audio data from it's original form.
ssize_t	putBuffer (Encoded buffer, size_t len=0)
	Insert bytes into the file from a memory buffer.
unsigned	putLinear (Linear buffer, unsigned request=0)
	Convert and store content from linear encoded audio data to the format of the audio file.
Error	getSamples (void *buffer, unsigned samples=0)
	Retrieve samples from the file into a memory buffer.
Error	putSamples (void *buffer, unsigned samples=0)
	Insert samples into the file from a memory buffer.
Error	skip (long number)
	Change the file position by skipping a specified number of audio samples of audio data.
Error	setPosition (unsigned long samples=~0l)
	Seek a file position by sample count.
Error	position (const char *timestamp)
	Seek a file position by timestamp.
void	getPosition (char *timestamp, size_t size)
	Return the timestamp of the current absolute file position.
Error	setLimit (unsigned long maximum=0l)
	Set the maximum file position for reading and writing of audio data by samples.
Error	getInfo (Info *info)
	Copy the source description of the audio file into the specified object.
Error	setMinimum (unsigned long minimum)
	Set minimum file size for a created file.
unsigned long	getAbsolutePosition (void)
	Get the current file pointer in bytes relative to the start of the file.
unsigned long	getPosition (void)
	Get the current file pointer in samples relative to the start of the sample buffer.
virtual bool	isOpen (void)
	Test if the file is opened.
virtual bool	hasPositioning (void)
	Return true if underlying derived class supports direct access to file positioning.
Encoding	getEncoding (void)
	Return audio encoding format for this audio file.
Format	getFormat (void)
	Return base file format of containing audio file.
unsigned	getSampleRate (void)
	Get audio encoding sample rate, in samples per second, for this audio file.
char *	getAnnotation (void)
	Get annotation extracted from header of containing file.
Error	getError (void)
	Get last error code.
bool	operator! (void)
bool	isSigned (void)
	Return if the current content is signed or unsigned samples.
Public Member Functions inherited from ost::AudioBase
	AudioBase ()
	Create audio base object with no info.
	AudioBase (Info *info)
	Create audio base object with audio source description.
virtual	~AudioBase ()
	Destroy an audio base object.
Encoding	getEncoding (void)
	Generic get encoding.
unsigned	getSampleRate (void)
	Generic sample rate.
ssize_t	putNative (Encoded data, size_t size)
	Puts raw data and does native to refined endian swapping if needed based on encoding type and local machine endian.
ssize_t	getPacket (Encoded data)
	Get's a packet of audio data.
ssize_t	getNative (Encoded data, size_t size)
	Get raw data and assure is in native machine endian.

Protected Member Functions
void	initialize (void)
void	getWaveFormat (int size)
void	mp3info (mpeg_audio *mp3)
virtual bool	afCreate (const char *path, bool exclusive=false)
virtual bool	afOpen (const char *path, Mode m=modeWrite)
virtual bool	afPeek (unsigned char *data, unsigned size)
AudioCodec *	getCodec (void)
virtual int	afRead (unsigned char *data, unsigned size)
	Read a given number of bytes from the file, starting from the current file pointer.
virtual int	afWrite (unsigned char *data, unsigned size)
	Write a number of bytes into the file at the current file pointer.
virtual bool	afSeek (unsigned long pos)
	Seek to the given position relative to the start of the file and set the file pointer.
virtual void	afClose (void)
	Close the derived file handling system's file handle.
virtual char *	getContinuation (void)
	This function is used to splice multiple audio files together into a single stream of continues audio data.
const char *	getErrorStr (Error err)
	Return a human-readable error message given a numeric error code of type Audio::Error.
Error	setError (Error err)
unsigned long	getHeader (void)
	Get number of bytes in the file header.
unsigned short	getShort (unsigned char *data)
	Convert binary 2 byte data stored in the order specified in the source description into a short variable.
void	setShort (unsigned char *data, unsigned short value)
	Save a short as two byte binary data stored in the endian order specified in the source description.
unsigned long	getLong (unsigned char *data)
	Convert binary 4 byte data stored in the order specified in the source description into a long variable.
void	setLong (unsigned char *data, unsigned long value)
	Save a long as four byte binary data stored in the endian order specified in the source description.

Protected Attributes
char *	pathname
Error	error
unsigned long	header
unsigned long	minimum
unsigned long	length
union {
int fd
void * handle
}	file
Mode	mode
unsigned long	iolimit
Protected Attributes inherited from ost::AudioBase
Info	info

Additional Inherited Members
Public Types inherited from ost::Audio
enum	Rate { rateUnknown , rate6khz = 6000 , rate8khz = 8000 , rate16khz = 16000 , rate32khz = 32000 , rate44khz = 44100 }
	Audio encoding rate, samples per second. More...
enum	Mode { modeRead , modeReadAny , modeReadOne , modeWrite , modeCache , modeInfo , modeFeed , modeAppend , modeCreate }
	File processing mode, whether to skip missing files, etc. More...
enum	Encoding { unknownEncoding = 0 , g721ADPCM , g722Audio , g722_7bit , g722_6bit , g723_2bit , g723_3bit , g723_5bit , gsmVoice , msgsmVoice , mulawAudio , alawAudio , mp1Audio , mp2Audio , mp3Audio , okiADPCM , voxADPCM , sx73Voice , sx96Voice , cdaStereo , cdaMono , pcm8Stereo , pcm8Mono , pcm16Stereo , pcm16Mono , pcm32Stereo , pcm32Mono , speexVoice , speexAudio , g729Audio , ilbcAudio , speexUltra , speexNarrow = speexVoice , speexWide = speexAudio , g723_4bit = g721ADPCM }
	Audio encoding formats. More...
enum	Format { raw , snd , riff , mpeg , wave }
	Audio container file format. More...
enum	DeviceMode { PLAY , RECORD , PLAYREC }
	Audio device access mode. More...
enum	Error { errSuccess = 0 , errReadLast , errNotOpened , errEndOfFile , errStartOfFile , errRateInvalid , errEncodingInvalid , errReadInterrupt , errWriteInterrupt , errReadFailure , errWriteFailure , errReadIncomplete , errWriteIncomplete , errRequestInvalid , errTOCFailed , errStatFailed , errInvalidTrack , errPlaybackFailed , errNotPlaying , errNoCodec }
	Audio error conditions. More...
typedef int16_t	snd16_t
typedef int32_t	snd32_t
typedef int16_t	Level
typedef int16_t	Sample
typedef int16_t *	Linear
typedef unsigned long	timeout_t
typedef unsigned char *	Encoded
typedef enum Rate	Rate
typedef enum Mode	Mode
typedef enum Encoding	Encoding
typedef enum Format	Format
typedef enum DeviceMode	DeviceMode
typedef enum Error	Error
Static Public Member Functions inherited from ost::Audio
static Level	tolevel (float dbm)
	Convert dbm power level to integer value (0-32768).
static float	todbm (Level power)
	Convert integer power levels to dbm.
static bool	hasDevice (unsigned device=0)
	Test for the presense of a specified (indexed) audio device.
static AudioDevice *	getDevice (unsigned device=0, DeviceMode mode=PLAY)
	Get a audio device object that can be used to play or record audio.
static const char *	getCodecPath (void)
	Get pathname to where loadable codec modules are stored.
static const char *	getMIME (Info &info)
	Get the mime descriptive type for a given Audio encoding description, usually retrieved from a newly opened audio file.
static const char *	getName (Encoding encoding)
	Get the short ascii description used for the given audio encoding type.
static const char *	getExtension (Encoding encoding)
	Get the preferred file extension name to use for a given audio encoding type.
static Encoding	getEncoding (const char *name)
	Get the audio encoding format that is specified by a short ascii name.
static Encoding	getStereo (Encoding encoding)
	Get the stereo encoding format associated with the given format.
static Encoding	getMono (Encoding encoding)
	Get the mono encoding format associated with the given format.
static bool	isLinear (Encoding encoding)
	Test if the audio encoding format is a linear one.
static bool	isBuffered (Encoding encoding)
	Test if the audio encoding format must be packetized (that is, has irregular sized frames) and must be processed only through buffered codecs.
static bool	isMono (Encoding encoding)
	Test if the audio encoding format is a mono format.
static bool	isStereo (Encoding encoding)
	Test if the audio encoding format is a stereo format.
static Rate	getRate (Encoding encoding)
	Return default sample rate associated with the specified audio encoding format.
static Rate	getRate (Encoding e, Rate request)
	Return optional rate setting effect.
static timeout_t	getFraming (Encoding encoding, timeout_t timeout=0)
	Return frame timing for an audio encoding format.
static timeout_t	getFraming (Info &info, timeout_t timeout=0)
	Return frame time for an audio source description.
static bool	isEndian (Encoding encoding)
	Test if the endian byte order of the encoding format is different from the machine's native byte order.
static bool	isEndian (Info &info)
	Test if the endian byte order of the audio source description is different from the machine's native byte order.
static bool	swapEndian (Encoding encoding, void *buffer, unsigned number)
	Optionally swap endian of audio data if the encoding format endian byte order is different from the machine's native endian.
static void	swapEncoded (Info &info, Encoded data, size_t bytes)
	Optionally swap endian of encoded audio data based on the audio encoding type, and relationship to native byte order.
static bool	swapEndian (Info &info, void *buffer, unsigned number)
	Optionally swap endian of audio data if the audio source description byte order is different from the machine's native endian byte order.
static Level	getImpulse (Encoding encoding, void *buffer, unsigned number)
	Get the energey impulse level of a frame of audio data.
static Level	getImpulse (Info &info, void *buffer, unsigned number=0)
	Get the energey impulse level of a frame of audio data.
static Level	getPeak (Encoding encoding, void *buffer, unsigned number)
	Get the peak (highest energy) level found in a frame of audio data.
static Level	getPeak (Info &info, void *buffer, unsigned number=0)
	Get the peak (highest energy) level found in a frame of audio data.
static void	toTimestamp (timeout_t duration, char *address, size_t size)
	Provide ascii timestamp representation of a timeout value.
static timeout_t	toTimeout (const char *timestamp)
	Convert ascii timestamp representation to a timeout number.
static int	getFrame (Encoding encoding, int samples=0)
	Returns the number of bytes in a sample frame for the given encoding type, rounded up to the nearest integer.
static int	getCount (Encoding encoding)
	Returns the number of samples in all channels for a frame in the given encoding.
static unsigned long	toSamples (Encoding encoding, size_t bytes)
	Compute byte counts of audio data into number of samples based on the audio encoding format used.
static unsigned long	toSamples (Info &info, size_t bytes)
	Compute byte counts of audio data into number of samples based on the audio source description used.
static size_t	toBytes (Info &info, unsigned long number)
	Compute the number of bytes a given number of samples in a given audio encoding will occupy.
static size_t	toBytes (Encoding encoding, unsigned long number)
	Compute the number of bytes a given number of samples in a given audio encoding will occupy.
static void	fill (unsigned char *address, int number, Encoding encoding)
	Fill an audio buffer with "empty" (silent) audio data, based on the audio encoding format.
static bool	loadPlugin (const char *path)
	Load a dso plugin (codec plugin), used internally...
static size_t	maxFramesize (Info &info)
	Maximum framesize for a given coding that may be needed to store a result.
Static Public Attributes inherited from ost::Audio
static const unsigned	ndata

Detailed Description

A class used to manipulate audio data.

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.nosp@m.@ost.nosp@m.el.co.nosp@m.m

audio file access.

Constructor & Destructor Documentation

◆ AudioFile() [1/3]

ost::AudioFile::AudioFile	(	const char *	name,
		unsigned long	offset = 0 )

Construct and open an existing audio file for read/write.

Parameters

name	of file to open.
offset	to start access.

◆ AudioFile() [2/3]

ost::AudioFile::AudioFile	(	const char *	name,
		Info *	info,
		unsigned long	minimum = 0 )

Create and open a new audio file for writing.

Parameters

name	of file to create.
info	source description for new file.
minimum	file size to accept at close.

◆ AudioFile() [3/3]

ost::AudioFile::AudioFile ( )

inline

Construct an audio file without attaching to the filesystem.

◆ ~AudioFile()

virtual ost::AudioFile::~AudioFile ( )

virtual

Member Function Documentation

◆ afClose()

virtual void ost::AudioFile::afClose ( void )

protectedvirtual

Close the derived file handling system's file handle.

◆ afCreate()

virtual bool ost::AudioFile::afCreate	(	const char *	path,
		bool	exclusive = false )

protectedvirtual

◆ afOpen()

virtual bool ost::AudioFile::afOpen	(	const char *	path,
		Mode	m = modeWrite )

protectedvirtual

◆ afPeek()

virtual bool ost::AudioFile::afPeek	(	unsigned char *	data,
		unsigned	size )

protectedvirtual

◆ afRead()

virtual int ost::AudioFile::afRead	(	unsigned char *	data,
		unsigned	size )

protectedvirtual

Read a given number of bytes from the file, starting from the current file pointer.

May be overridden by derived classes.

Parameters

data	A pointer to the buffer to copy the bytes to.
size	The number of bytes to read.

Returns: 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.

◆ afSeek()

virtual bool ost::AudioFile::afSeek ( unsigned long pos )

protectedvirtual

Seek to the given position relative to the start of the file and set the file pointer.

This does not use 64-bit clean seek functions, so seeking to positions greater than (2^32)-1 will result in undefined behavior.

Parameters

pos	The position to seek to.

Returns: true if successful, false otherwise.

◆ afWrite()

virtual int ost::AudioFile::afWrite	(	unsigned char *	data,
		unsigned	size )

protectedvirtual

Write a number of bytes into the file at the current file pointer.

May be overridden by derived classes.

Parameters

data	A pointer to the buffer with the bytes to write.
size	The number of bytes to write from the buffer.

Returns: 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.

◆ clear()

void ost::AudioFile::clear ( void )

Clear the AudioFile structure.

Called by AudioFile::close(). 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.

◆ close()

void ost::AudioFile::close ( void )

Close an object associated with an open file.

This updates the header metadata with the file length if the file length has changed.

◆ create()

void ost::AudioFile::create	(	const char *	name,
		Info *	info,
		bool	exclusive = false,
		timeout_t	framing = 0 )

Create a new audio file and associate it with this object.

Called implicitly by the three-argument version of the constructor.

Parameters

name	The name of the file to open.
info	The type of the audio file to be created.
exclusive	create option.
framing	time in milliseconds.

◆ getAbsolutePosition()

unsigned long ost::AudioFile::getAbsolutePosition ( void )

Get the current file pointer in bytes relative to the start of the file.

See getPosition() to determine the position relative to the start of the sample buffer.

Returns: 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.

◆ getAge()

time_t ost::AudioFile::getAge ( void )

Returns age since last prior access.

Used for cache computations.

Returns: age in seconds.

◆ getAnnotation()

char * ost::AudioFile::getAnnotation ( void )

inline

Get annotation extracted from header of containing file.

Returns: annotation text if any, else NULL.

◆ getBuffer()

ssize_t ost::AudioFile::getBuffer	(	Encoded	buffer,
		size_t	len = 0 )

virtual

Retrieve bytes from the file into a memory buffer.

This increments the file pointer so subsequent calls read further bytes. If you want to read a number of samples rather than bytes, use getSamples().

Parameters

buffer	area to copy the samples to.
len	The number of bytes (not samples) to copy or 0 for frame.

Returns: The number of bytes (not samples) read. Returns -1 if no bytes are read and an error occurs.

Implements ost::AudioBase.

Reimplemented in ost::AudioStream.

◆ getCodec()

AudioCodec * ost::AudioFile::getCodec ( void )

protected

◆ getContinuation()

virtual char * ost::AudioFile::getContinuation ( void )

inlineprotectedvirtual

This function is used to splice multiple audio files together into a single stream of continues audio data.

The continuation method returns the next audio file to open.

Returns: next file to open or NULL when done.

◆ getEncoding()

Encoding ost::AudioFile::getEncoding ( void )

inline

Return audio encoding format for this audio file.

Returns: audio encoding format.

◆ getError()

Error ost::AudioFile::getError ( void )

inline

Get last error code.

Returns: alst error code.

◆ getErrorStr()

const char * ost::AudioFile::getErrorStr ( Error err )

protected

Return a human-readable error message given a numeric error code of type Audio::Error.

Parameters

err	The numeric error code to translate.

Returns: A pointer to a character string containing the human-readable error message.

◆ getFormat()

Format ost::AudioFile::getFormat ( void )

inline

Return base file format of containing audio file.

Returns: audio file container format.

◆ getHeader()

unsigned long ost::AudioFile::getHeader ( void )

inlineprotected

Get number of bytes in the file header.

Data packets will begin after this header.

Returns: number of bytes in file header.

◆ getInfo()

Error ost::AudioFile::getInfo ( Info * info )

Copy the source description of the audio file into the specified object.

Parameters

info	pointer to object to copy source description into.

Returns: errSucess.

◆ getLinear()

unsigned ost::AudioFile::getLinear	(	Linear	buffer,
		unsigned	request = 0 )

Retrieve and convert content to linear encoded audio data from it's original form.

Parameters

buffer	to copy linear data into.
request	number of linear samples to extract or 0 for frame.

Returns: number of samples retrieved, 0 if no codec or eof.

◆ getLong()

unsigned long ost::AudioFile::getLong ( unsigned char * data )

protected

Convert binary 4 byte data stored in the order specified in the source description into a long variable.

This is often used to manipulate header data.

Returns: long value.

Parameters

data	binary 4 byte data pointer.

◆ getPosition() [1/2]

void ost::AudioFile::getPosition	(	char *	timestamp,
		size_t	size )

Return the timestamp of the current absolute file position.

Parameters

timestamp	to save ascii position into.
size	of timestamp buffer.

◆ getPosition() [2/2]

unsigned long ost::AudioFile::getPosition ( void )

Get the current file pointer in samples relative to the start of the sample buffer.

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.

Returns: 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.

◆ getSampleRate()

unsigned ost::AudioFile::getSampleRate ( void )

inline

Get audio encoding sample rate, in samples per second, for this audio file.

Returns: sample rate.

◆ getSamples()

Error ost::AudioFile::getSamples	(	void *	buffer,
		unsigned	samples = 0 )

Retrieve samples from the file into a memory buffer.

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 getBuffer().

Parameters

buffer	pointer to copy the samples to.
samples	The number of samples to read or 0 for frame.

Returns: errSuccess if successful, !errSuccess if error. Use getErrorStr() to retrieve the human-readable error string.

◆ getShort()

unsigned short ost::AudioFile::getShort ( unsigned char * data )

protected

Convert binary 2 byte data stored in the order specified in the source description into a short variable.

This is often used to manipulate header data.

Returns: short value.

Parameters

data	binary 2 byte data pointer.

◆ getSize()

size_t ost::AudioFile::getSize ( void )

inline

Get maximum size of frame buffer for data use.

Returns: max frame size in bytes.

◆ getWaveFormat()

void ost::AudioFile::getWaveFormat ( int size )

protected

◆ hasPositioning()

virtual bool ost::AudioFile::hasPositioning ( void )

inlinevirtual

Return true if underlying derived class supports direct access to file positioning.

Derived classes based on URL's or fifo devices may not have this ability.

Returns: true if file positioning is supported.

◆ initialize()

void ost::AudioFile::initialize ( void )

protected

◆ isOpen()

virtual bool ost::AudioFile::isOpen ( void )

virtual

Test if the file is opened.

Returns: true if a file is open.

◆ isSigned()

bool ost::AudioFile::isSigned ( void )

Return if the current content is signed or unsigned samples.

Returns: true if signed.

◆ mp3info()

void ost::AudioFile::mp3info ( mpeg_audio * mp3 )

protected

◆ open()

void ost::AudioFile::open	(	const char *	name,
		Mode	mode = modeWrite,
		timeout_t	framing = 0 )

Open an audio file and associate it with this object.

Called implicitly by the two-argument version of the constructor.

Parameters

name	of the file to open. Don't forget to double your backslashes for DOS-style pathnames.
mode	to open file under.
framing	time in milliseconds.

◆ operator!()

bool ost::AudioFile::operator! ( void )

inline

◆ position()

Error ost::AudioFile::position ( const char * timestamp )

Seek a file position by timestamp.

The actual position will be rounded by framing.

Returns: errSuccess if successful.

Parameters

timestamp position to seek.

◆ putBuffer()

ssize_t ost::AudioFile::putBuffer	(	Encoded	buffer,
		size_t	len = 0 )

virtual

Insert bytes into the file from a memory buffer.

This increments the file pointer so subsequent calls append further samples. If you want to write a number of samples rather than bytes, use putSamples().

Parameters

buffer	area to append the samples from.
len	The number of bytes (not samples) to append.

Returns: The number of bytes (not samples) read. Returns -1 if an error occurs and no bytes are written.

Implements ost::AudioBase.

◆ putLinear()

unsigned ost::AudioFile::putLinear	(	Linear	buffer,
		unsigned	request = 0 )

Convert and store content from linear encoded audio data to the format of the audio file.

Parameters

buffer	to copy linear data from.
request	Number of linear samples to save or 0 for frame.

Returns: number of samples saved, 0 if no codec or eof.

◆ putSamples()

Error ost::AudioFile::putSamples	(	void *	buffer,
		unsigned	samples = 0 )

Insert samples into the file from a memory buffer.

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 putBuffer().

Parameters

buffer	pointer to append the samples from.
samples	The number of samples (not bytes) to append.

Returns: errSuccess if successful, !errSuccess if error. Use getErrorStr() to retrieve the human-readable error string.

◆ setError()

Error ost::AudioFile::setError ( Error err )

protected

◆ setLimit()

Error ost::AudioFile::setLimit ( unsigned long maximum = 0l )

Set the maximum file position for reading and writing of audio data by samples.

If 0, then no limit is set.

Parameters

maximum file i/o access size sample position.

Returns: errSuccess if successful.

◆ setLong()

void ost::AudioFile::setLong	(	unsigned char *	data,
		unsigned long	value )

protected

Save a long as four byte binary data stored in the endian order specified in the source description.

This is often used to manipulate header data.

Parameters

data	binary 4 byte data pointer.
value	to convert.

◆ setMinimum()

Error ost::AudioFile::setMinimum ( unsigned long minimum )

Set minimum file size for a created file.

If the file is closed with fewer samples than this, it will also be deleted.

Parameters

minimum number of samples for new file.

Returns: errSuccess if successful.

◆ setPosition()

Error ost::AudioFile::setPosition ( unsigned long samples = ~0l )

Seek a file position by sample count.

If no position specified, then seeks to end of file.

Returns: errSuccess or error condition on failure.

Parameters

samples position to seek in file.

◆ setShort()

void ost::AudioFile::setShort	(	unsigned char *	data,
		unsigned short	value )

protected

Save a short as two byte binary data stored in the endian order specified in the source description.

This is often used to manipulate header data.

Parameters

data	binary 2 byte data pointer.
value	to convert.

◆ skip()

Error ost::AudioFile::skip ( long number )

Change the file position by skipping a specified number of audio samples of audio data.

Returns: errSuccess or error condition on failure.

Parameters

number of samples to skip.

Member Data Documentation

◆ error

Error ost::AudioFile::error

protected

◆ fd

int ost::AudioFile::fd

◆ [union]

union { ... } ost::AudioFile::file

◆ handle

void* ost::AudioFile::handle

◆ header

unsigned long ost::AudioFile::header

protected

◆ iolimit

unsigned long ost::AudioFile::iolimit

protected

◆ length

unsigned long ost::AudioFile::length

protected

◆ minimum

unsigned long ost::AudioFile::minimum

protected

◆ mode

Mode ost::AudioFile::mode

protected

◆ pathname

char* ost::AudioFile::pathname

protected

The documentation for this class was generated from the following file:

audio2.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AudioFile() [1/3]

◆ AudioFile() [2/3]

◆ AudioFile() [3/3]

◆ ~AudioFile()

Member Function Documentation

◆ afClose()

◆ afCreate()

◆ afOpen()

◆ afPeek()

◆ afRead()

◆ afSeek()

◆ afWrite()

◆ clear()

◆ close()

◆ create()

◆ getAbsolutePosition()

◆ getAge()

◆ getAnnotation()

◆ getBuffer()

◆ getCodec()

◆ getContinuation()

◆ getEncoding()

◆ getError()

◆ getErrorStr()

◆ getFormat()

◆ getHeader()

◆ getInfo()

◆ getLinear()

◆ getLong()

◆ getPosition() [1/2]

◆ getPosition() [2/2]

◆ getSampleRate()

◆ getSamples()

◆ getShort()

◆ getSize()

◆ getWaveFormat()

◆ hasPositioning()

◆ initialize()

◆ isOpen()

◆ isSigned()

◆ mp3info()

◆ open()

◆ operator!()

◆ position()

◆ putBuffer()

◆ putLinear()

◆ putSamples()

◆ setError()

◆ setLimit()

◆ setLong()

◆ setMinimum()

◆ setPosition()

◆ setShort()

◆ skip()

Member Data Documentation

◆ error

◆ fd

◆ [union]

◆ handle

◆ header

◆ iolimit

◆ length

◆ minimum

◆ mode

◆ pathname