AudioFileIf.h

Go to the documentation of this file.

#if !defined(__AudioFileIf_hdr__)
#define __AudioFileIf_hdr__
 
#include <string>
#include <fstream>
#include <algorithm>
#include "ErrorDef.h"
 
class CAudioFileIf
{
public:
    enum FileIoType_t
    {
        kFileRead   = 0x1L,     
        kFileWrite  = 0x2L,     
 
        kNumFileOpenTypes = 2
    };
    enum FileFormat_t
    {
        kFileFormatRaw,         
        kFileFormatWav,         
        kFileFormatAiff,        
        kFileFormatUnknown,     
 
        kNumFileFormats
    };
    enum BitStream_t
    {
        kFileBitStreamInt16,    
        kFileBitStreamFloat32,  
        kFileBitStreamUnknown,  
 
        kNumWordLengths
    };
    struct FileSpec_t
    {
        FileFormat_t    eFormat;            
        BitStream_t     eBitStreamType;     
        int             iNumChannels;       
        float           fSampleRateInHz;    
    };
 
    static Error_t create (CAudioFileIf*& pCInstance);
    static Error_t destroy (CAudioFileIf*& pCInstance);
    virtual Error_t reset (bool bFreeMemory = false);
 
    virtual Error_t openFile (std::string cAudioFileName, FileIoType_t eIoType, FileSpec_t const *psFileSpec = 0) = 0;
    virtual Error_t closeFile () = 0;
 
    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 () {return m_bWithClipping;};
 
    Error_t getPosition (long long &iFrame);
    Error_t getPosition (double &dTimeInS);
    Error_t getLength (long long &iLengthInFrames) ;
    Error_t getLength (double &dLengthInSeconds) ;
 
    virtual bool isEof () = 0;
    virtual bool isOpen () = 0;
    virtual bool isInitialized ();
 
protected:
 
    CAudioFileIf ();
    virtual ~CAudioFileIf ();
    virtual Error_t freeMemory ();
    virtual Error_t allocMemory ();
 
    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 {return (m_iNumBytesPerSample<<3);}
 
    float clip2Range(float fSample2Clip, float fMin, float fMax)
    {
        fSample2Clip = std::min (fSample2Clip, fMax);
        fSample2Clip = std::max (fSample2Clip, fMin);
        return fSample2Clip;
    }
 
    static const long long int    m_kiDefBlockLength;     
 
private:
    CAudioFileIf(const CAudioFileIf& that);
    virtual Error_t initDefaults ();
 
    virtual long long int readDataIntern (float **ppfAudioData, long long int iLength) = 0;
    virtual long long int writeDataIntern (float **ppfAudioData, long long int iLength) = 0;
    virtual long long getLengthIntern() = 0;
    virtual long long getPositionIntern() = 0;
    virtual Error_t setPositionIntern( long long iFrame ) = 0;
 
    FileSpec_t      m_CurrFileSpec;            
    FileIoType_t    m_eIoType;                  
 
    bool            m_bWithClipping;            
    bool            m_bIsInitialized;           
    int             m_iNumBytesPerSample;       
 
};
 
#endif // #if !defined(__AudioFileIf_hdr__)