RingBuffer.h

Go to the documentation of this file.

//
//  RingBuffer.h -- the ring buffer class specification
//  See the copyright notice and acknowledgment of authors in the file COPYRIGHT
//
// This is a typical circular buffer with one writer and multiple readers (tap instances)

#ifndef CSL_RingBuffer_H
#define CSL_RingBuffer_H

#include "CSL_Core.h"

namespace csl {

//class RingBuffer;     ///< forward declaration

class RingBufferTap: public UnitGenerator, public Scalable, public Seekable {

public:
    friend class RingBuffer;                    

    RingBufferTap(RingBuffer *parent, int offset = 0);  

    unsigned mLoopStartFrame;               
    unsigned mLoopEndFrame;             

    unsigned duration() const;
    unsigned seekTo(int position, SeekPosition whence) throw(CException);
    void setLoopStart(unsigned frame) { mLoopStartFrame = frame; }
    void setLoopEnd(unsigned frame) { mLoopEndFrame = frame; }
    
    void nextBuffer(Buffer &outputBuffer) throw(CException);            
    void nextBuffer(Buffer &outputBuffer, unsigned outBufNum) throw(CException);
    void destructiveNextBuffer(Buffer&outputBuffer) throw(CException);  
    void destructiveNextBuffer(Buffer &outputBuffer, unsigned outBufNum) throw(CException);
                                
protected:
    unsigned mTempCurrentFrame;         // A hack necessary to track info.
    RingBuffer *mParentBuffer;              // A reference to the buffer from which i'm reading.
    
    void setOffset(int offset);
};

// NOTE: Doesn't delete the memory allocated for the buffer. It should! Jorge, June 2006.


class RingBuffer : public UnitGenerator, public Scalable, public Writeable {

public:
    friend class RingBufferTap;  

    RingBuffer() : UnitGenerator(), Writeable(), mCurrentWriteFrame(0), mBuffer(), mTap(this), mTempCurrentWriteFrame(0) { };
    RingBuffer(unsigned int numChannels, unsigned int numFrames) : UnitGenerator(), Writeable(), mCurrentWriteFrame(0),
            mBuffer(numChannels, numFrames), mTap(this), mTempCurrentWriteFrame(0) { mBuffer.allocateMonoBuffers(); };


    unsigned mCurrentWriteFrame; 
    Buffer mBuffer;
    RingBufferTap mTap;         

    unsigned seekTo(int position) throw(CException);
    
    void setLoopStart(unsigned frame) { mTap.setLoopStart(frame); };    
    void setLoopEnd(unsigned frame) { mTap.setLoopEnd(frame); };        

    void nextBuffer(Buffer &outputBuffer) throw(CException);            
    void writeBuffer(Buffer &inputBuffer) throw(CException);                
    void sumIntoBuffer(Buffer &inputBuffer) throw(CException);          
    void destructiveNextBuffer(Buffer &outputBuffer) throw(CException); 
    void writeBuffer(Buffer &inputBuffer, unsigned bufNum) throw(CException);
    void sumIntoBuffer(Buffer &inputBuffer, unsigned bufNum) throw(CException);
    
protected:
    unsigned mTempCurrentWriteFrame;    
};


class BufferStream : public UnitGenerator, public Seekable, public Writeable {
public:
    BufferStream(Buffer &buffer) : UnitGenerator(), Seekable(), Writeable(), mBuffer(&buffer), 
                    mCurrentWriteFrame(0), mTempCurrentFrame(0), mTempCurrentWriteFrame(0) { };

    void nextBuffer(Buffer &outputBuffer) throw(CException); 
    void writeBuffer(Buffer &inputBuffer) throw(CException); 
    void nextBuffer(Buffer &outputBuffer, unsigned outBufNum) throw(CException);
    void writeBuffer(Buffer &inputBuffer, unsigned bufNum) throw(CException);
    void setBuffer(Buffer &buffer) { mBuffer = &buffer; }
    unsigned seekTo(int position, SeekPosition whence) throw(CException);
    unsigned duration() const;

protected:
    Buffer *mBuffer;
    unsigned mCurrentWriteFrame;
    unsigned mTempCurrentFrame;         
    unsigned mTempCurrentWriteFrame;    
};

}

#endif

---