BufferedSDIFFileReader.hxx

Go to the documentation of this file.

#ifndef _BufferedSDIFFileReader_
#define _BufferedSDIFFileReader_

#include "SDIFInConfig.hxx"
#include "SDIFFileReader.hxx"
#include "Frame.hxx"
#include "Thread.hxx"
#include "Mutex.hxx"
#include <deque>

#define DEFAULT_INITIAL_NUMBER_OF_FRAMES_TO_BUFFER 50


#define DEFAULT_FRAME_LOAD_CHUNK_SIZE 5


#define DEFAULT_THRESHHOLD_FOR_PRELOADING 5


#define DEFAULT_THRESHHOLD_FOR_PRELOADING_ON_THREAD 20

namespace CLAM
{

class BufferedSDIFFileReader
{
public:
        BufferedSDIFFileReader(const SDIFInConfig& argSDIFInConfig);
        
        virtual ~BufferedSDIFFileReader();

        bool Configure(const SDIFInConfig& c);

        const SDIFInConfig GetConfig();

        virtual Frame* ReadFrame();

        void LoadFramesIntoBufferOnThread(Thread* argThread);

        void StopLoadingFramesIntoBufferOnThread();

        bool IsThreaded();

        int GetNumberOfFramesLoaded();
        
protected:
        int GetFrameBufferPosition();
        void SetFrameBufferPosition(int frameBufferPosition);
        Frame* GetFrame( int frameBufferPosition );
        
private:
        bool LoadFramesIntoBuffer(int argNumberOfBuffers);

        void Run();

        SDIFFileReader mSDIFFileReader;
        std::deque<Frame*> frameBuffer;
        int frameBufferPosition;
        
        int mFrameLoadChunkSize;
        int mThreshholdForPreloading;
        int mThreshholdForPreloadingOnThread;
        // The maximum amount of time that a thread can remain idle. After this
        // threshhold is crossed, the thread is stopped thereby returning it to the
        // pool where it can be reused.
        int mMaximumThreadIdleTime;
        bool mReaderHasMoreFrames;
        Thread* mThreadPtr;
        CBL::Functor0 mFunctor;
        // This is used to prevent the main thread and the reader thread from trying
        // to access the deque of frames simultaneously
        Mutex dequeMutex;
        // if mThreshholdForPreloadingOnThread > mThreshholdForPreloading.
        Mutex readSDIFMutex;
        int totalNumberOfFramesToLoad;
};

}

#endif