/usr/include/CLAM/BufferedSDIFFileReader.hxx is in libclam-dev 1.4.0-6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 | #ifndef _BufferedSDIFFileReader_
#define _BufferedSDIFFileReader_
#include "SDIFInConfig.hxx"
#include "SDIFFileReader.hxx"
#include "Frame.hxx"
#include "Thread.hxx"
#include "Mutex.hxx"
#include <deque>
/// this defines how many frames will be preloaded when this object is first
/// created. if you're creating a lot of objects for a lot of SDIF files,
/// you shouldn't make this too large
#define DEFAULT_INITIAL_NUMBER_OF_FRAMES_TO_BUFFER 50
/// this defines how many frames should be loaded before the thread yields.
/// the current value is arbitrary, and needs to be refined.
#define DEFAULT_FRAME_LOAD_CHUNK_SIZE 5
/// this class starts loading more frames when it only has this many frames
/// left in the buffer
#define DEFAULT_THRESHHOLD_FOR_PRELOADING 5
/// this class starts loading more frames when it only has this many frames
/// left in the buffer if it is loading the frames on a thread
#define DEFAULT_THRESHHOLD_FOR_PRELOADING_ON_THREAD 20
namespace CLAM
{
/**
* BufferedSDIFFileReader is an SDIFFileReader that preloads some SDIF frames
* into an internal buffer so that real-time audio applications won't stall
* while waiting for disk reading operations. Instances can be given a thread
* (presumably from a thread pool) so that the SDIF frames will be loaded in the
* background.
*
* \author greg kellum [gkellum@iua.upf.edu] 7/6/07
* \since CLAM v1.1
*/
class BufferedSDIFFileReader
{
public:
/**
* You MUST give the instance the filename of the SDIF file to read.
* in the SDIFInConfig object.
*/
BufferedSDIFFileReader(const SDIFInConfig& argSDIFInConfig);
virtual ~BufferedSDIFFileReader();
/**
* You MUST to give the instance the filename of the SDIF file to read.
* in the SDIFInConfig object. You can further specify which kinds of
* objects to read from the SDIFFile. See the doc for SDIFInConfig.
*/
bool Configure(const SDIFInConfig& c);
const SDIFInConfig GetConfig();
/**
* This method returns the next frame from the internal buffer.
*/
virtual Frame* ReadFrame();
/**
* Use this method to give the instance a thread which it can use to load
* the SDIF file in the background.
*/
void LoadFramesIntoBufferOnThread(Thread* argThread);
/**
* This method stops the thread given to this object. This should never (?)
* be called however by a client because this class knows when it no longer
* needs its thread uses this method to stop the thread itself.
*
* TODO should this be protected?
*/
void StopLoadingFramesIntoBufferOnThread();
/**
* True if and only if this has a thread.
*/
bool IsThreaded();
/**
* The number of frames that have been read into the buffer.
*/
int GetNumberOfFramesLoaded();
protected:
int GetFrameBufferPosition();
void SetFrameBufferPosition(int frameBufferPosition);
Frame* GetFrame( int frameBufferPosition );
private:
/**
* Internal method for loading a certain sized chunk of SDIF frames.
*/
bool LoadFramesIntoBuffer(int argNumberOfBuffers);
/**
* Internal method to be called by a thread given by LoadFramesIntoBufferOnThread
*/
void Run();
/// The SDIFFileReader for reading the SDIF file
SDIFFileReader mSDIFFileReader;
/// The linked list for frames that haven't been read yet
std::deque<Frame*> frameBuffer;
/// The position in the frameBuffer where we are currently reading from
int frameBufferPosition;
/// How many chunks should be read at one time
int mFrameLoadChunkSize;
/// When the instance only has this many chunks left, it will start reading more
int mThreshholdForPreloading;
/// When the instance only has this many chunks left, the thread will start
/// reading more. This number should be higher than the mThreshholdForPreloading
/// Otherwise, the thread will never be used.
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;
/// Whether there are more SDIF frames in the buffer.
bool mReaderHasMoreFrames;
/// The thread to be used to read frames.
Thread* mThreadPtr;
/// The wrapper object that the thread will use to call the Run method.
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;
/// This is used to prevent the main thread and the reader thread from trying to
/// read the SDIF file at the same time.
// if mThreshholdForPreloadingOnThread > mThreshholdForPreloading.
Mutex readSDIFMutex;
/// How many frames of the file should be loaded. If the file has multiple loop
/// points. This should be the last loop point.
int totalNumberOfFramesToLoad;
};
}
#endif
|