Audio Effects Framework
Public Member Functions | List of all members
CAudioFileSndLib Class Reference

open, read, and write audio files with sndlib (CMake option WITH_SNDLIB has to be ON) More...

#include <AudioFile.h>

Inheritance diagram for CAudioFileSndLib:
Inheritance graph
[legend]
Collaboration diagram for CAudioFileSndLib:
Collaboration graph
[legend]

Public Member Functions

 CAudioFileSndLib ()
 
virtual ~CAudioFileSndLib ()
 
Error_t openFile (std::string cAudioFileName, FileIoType_t eIoType, FileSpec_t const *psFileSpec=0) override
 
Error_t closeFile () override
 
bool isEof () override
 
bool isOpen () override
 
Error_t freeMemory () override
 
Error_t allocMemory () override
 
- Public Member Functions inherited from CAudioFileIf
virtual Error_t reset (bool bFreeMemory=false)
 
virtual Error_t readData (float **ppfAudioData, long long int &iNumFrames)
 
virtual Error_t writeData (float **ppfAudioData, long long int iNumFrames)
 
Error_t getFileSpec (FileSpec_t &sFileSpec)
 
virtual Error_t setPosition (long long iFrame=0)
 
Error_t setPosition (double dTimeInS=.0)
 
Error_t setClippingEnabled (bool bIsEnabled=true)
 
bool isClippingEnabled ()
 
Error_t getPosition (long long &iFrame)
 
Error_t getPosition (double &dTimeInS)
 
Error_t getLength (long long &iLengthInFrames)
 
Error_t getLength (double &dLengthInSeconds)
 
virtual bool isInitialized ()
 

Additional Inherited Members

- Public Types inherited from CAudioFileIf
enum  FileIoType_t { kFileRead = 0x1L, kFileWrite = 0x2L, kNumFileOpenTypes = 2 }
 
enum  FileFormat_t {
  kFileFormatRaw, kFileFormatWav, kFileFormatAiff, kFileFormatUnknown,
  kNumFileFormats
}
 
enum  BitStream_t { kFileBitStreamInt16, kFileBitStreamFloat32, kFileBitStreamUnknown, kNumWordLengths }
 
- Static Public Member Functions inherited from CAudioFileIf
static Error_t create (CAudioFileIf *&pCInstance)
 
static Error_t destroy (CAudioFileIf *&pCInstance)
 
- Protected Member Functions inherited from CAudioFileIf
 CAudioFileIf ()
 
virtual ~CAudioFileIf ()
 
Error_t setInitialized (bool bInitialized=true)
 
Error_t setIoType (FileIoType_t eIoType)
 
FileIoType_t getIoType () const
 
Error_t setFileSpec (const FileSpec_t *pFileSpec)
 
int getNumChannels () const
 
long long convFrames2Bytes (long long iNumFrames)
 
long long convBytes2Frames (long long iNumFrames)
 
Error_t setNumBytesPerSample (int iNumBytes)
 
int getNumBytesPerSample () const
 
int getNumBitsPerSample () const
 
float clip2Range (float fSample2Clip, float fMin, float fMax)
 
- Static Protected Attributes inherited from CAudioFileIf
static const long long int m_kiDefBlockLength = 1024
 buffer length for read and write operations More...
 

Detailed Description

open, read, and write audio files with sndlib (CMake option WITH_SNDLIB has to be ON)

Constructor & Destructor Documentation

◆ CAudioFileSndLib()

CAudioFileSndLib::CAudioFileSndLib ( )

◆ ~CAudioFileSndLib()

CAudioFileSndLib::~CAudioFileSndLib ( )
virtual

Member Function Documentation

◆ allocMemory()

Error_t CAudioFileSndLib::allocMemory ( )
overridevirtual

Reimplemented from CAudioFileIf.

◆ closeFile()

Error_t CAudioFileSndLib::closeFile ( )
overridevirtual

close the current file

Returns
Error_t

Implements CAudioFileIf.

◆ freeMemory()

Error_t CAudioFileSndLib::freeMemory ( )
overridevirtual

Reimplemented from CAudioFileIf.

◆ isEof()

bool CAudioFileSndLib::isEof ( )
overridevirtual

check if EOF is true

Returns
bool

Implements CAudioFileIf.

◆ isOpen()

bool CAudioFileSndLib::isOpen ( )
overridevirtual

check if a file is opened

Returns
bool

Implements CAudioFileIf.

◆ openFile()

Error_t CAudioFileSndLib::openFile ( std::string  cAudioFileName,
FileIoType_t  eIoType,
FileSpec_t const *  psFileSpec = 0 
)
overridevirtual

open a file for reading or writing

Parameters
cAudioFileName
eIoType
psFileSpec
Returns
Error_t

Implements CAudioFileIf.

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