SoundFile.h

Go to the documentation of this file.

#ifndef CSL_SoundFile_H
#define CSL_SoundFile_H

#include "CSL_Core.h"           // the core of CSL 5
#include "Oscillator.h"         // the superclass of sound files

#include <string.h>

namespace csl {


#ifdef CSL_ENUMS                // use enumerations or integers?

typedef enum {                  
    kSoundFileRead,
    kSoundFileWrite,    
    kSoundFileReadWrite
} SoundFileMode;

typedef enum {                  
    kSoundFileFormatWAV,        
    kSoundFileFormatAIFF,       
    kSoundFileFormatSND,        
    kSoundFileFormatEBICSF,     
    kSoundFileFormatRaw,        
    kSoundFileFormatOther,      
} SoundFileFormat;

#else
    #define kSoundFileRead 0
    #define kSoundFileWrite 1
    #define kSoundFileReadWrite 2
    typedef int SoundFileMode;
    
    #define kSoundFileFormatWAV 0
    #define kSoundFileFormatAIFF 1
    #define kSoundFileFormatSND 2
    #define kSoundFileFormatEBICSF 3
    #define kSoundFileFormatRaw 4
    #define kSoundFileFormatOther 5
    typedef int SoundFileFormat;
#endif


class Abst_SoundFile : public WavetableOscillator, public Writeable, public Seekable {
public:                                 
    Abst_SoundFile(string path, int start = -1, int stop = -1);
    Abst_SoundFile(string folder, string path, int start = -1, int stop = -1);
    Abst_SoundFile(Abst_SoundFile & otherSndFile);          
    ~Abst_SoundFile();
    unsigned channels() const;                      
    unsigned duration() const;                      
    float durationInSecs();                         
    virtual SoundFileFormat format() = 0;           
    bool isValid() { return mIsValid; }             
    bool isActive();                                
    unsigned sampleSize() { return mBytesPerSample; };  

    virtual void setPath(string path);              
    string path() { return mPath; }                 
    virtual void dump();                            

    SoundFileMode mode() { return mMode; }          
    int startFrame() { return mStart; }             
    void setStart(int val);
    void setStartSec(float val);
    void setStartRatio(float val);
    int stopFrame() { return mStop; }               
    void setStop(int val);
    void setStopSec(float val);
    void setStopRatio(float val);
    
    double playbackRate() { return mRate; }         
    void setRate(UnitGenerator & frequency);        
    void setRate(float frequency);

    bool isLooping() { return mIsLooping; }         
    void setIsLooping(bool tLooping) { mIsLooping = tLooping; }
    virtual bool isCached();                        

    virtual void openForRead() throw (CException) = 0;  

    virtual void openForWrite(SoundFileFormat format = kSoundFileFormatAIFF, 
                    unsigned channels = 1, 
                    unsigned rate = 44100,
                    unsigned bitDepth = 16) throw (CException) = 0;
    virtual unsigned seekTo(int position, SeekPosition whence) throw(CException) = 0;
    unsigned seekTo(int position) throw(CException) { return seekTo(position, kPositionStart); }; 
    virtual void readBufferFromFile(unsigned numFr) = 0;    
    void mergeToMono();                                     
    
    virtual void setToEnd();                                
    virtual void trigger();                                 
    virtual void close() = 0;                               
    virtual void freeBuffer();                              
    
    virtual void nextBuffer(Buffer &outB) throw (CException);       
    virtual void writeBuffer(Buffer &inB) throw (CException) = 0;   

protected:
    string mPath;                                   
    SoundFileMode mMode;                            
    bool mIsValid;                                  
    bool mIsLooping;                                
    int mStart, mStop;                              
    double mRate;                                   
    unsigned mNumFrames;                            
    unsigned mBytesPerSample;                       

    virtual void initFromSndfile() = 0;             
    virtual void checkBuffer(unsigned numFrames);   
};


class SoundCue : public UnitGenerator {

public:
    SoundCue();                         
    SoundCue(string name, Abst_SoundFile *file = 0, int start = 1, int stop = -1);
//  SoundCue(string name, int start = 1, int stop = -1);
    ~SoundCue();

    string mName;                       
    Abst_SoundFile * mFile;             
    int mStart, mStop, mCurrent;        
    UnitGenerator *mReadRate;           

    void readFrom(FILE *input);         
    void dump(void);                    

    void nextBuffer(Buffer & outputBuffer) throw(CException);   

    bool isActive();
    unsigned channels() const { return (mFile->channels()); }
    void setToEnd(void);
    void trigger(void);
    float duration() const { return (mStop - mStart); }         

protected:
    float mFloatCurrent;                
};

#ifdef UNDEFINED                        // this was never completed...

class SampleFile : public Abst_SoundFile {
public:
    SampleFile();                           
    SampleFile(string name, Abst_SoundFile *file = 0, int start = 1, int stop = -1);
    ~SampleFile();
    unsigned mMIDIKey;          // sample's MIDI key #
    double mFrequency;          // sample's actual frequency
    double mMinRatio;           // min transp.
    double mMaxRatio;           // max transp. (often 1.0)
    
    double ratioForKey(int desiredMIDI);
    double ratioForPitch(int desiredMIDI);
};

#endif

}

#endif