lbajardsilogic@0: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
lbajardsilogic@0: 
lbajardsilogic@0: /*
lbajardsilogic@0:     Sonic Visualiser
lbajardsilogic@0:     An audio file viewer and annotation editor.
lbajardsilogic@0:     Centre for Digital Music, Queen Mary, University of London.
lbajardsilogic@0:     This file copyright 2006 Chris Cannam.
lbajardsilogic@0:     
lbajardsilogic@0:     This program is free software; you can redistribute it and/or
lbajardsilogic@0:     modify it under the terms of the GNU General Public License as
lbajardsilogic@0:     published by the Free Software Foundation; either version 2 of the
lbajardsilogic@0:     License, or (at your option) any later version.  See the file
lbajardsilogic@0:     COPYING included with this distribution for more information.
lbajardsilogic@0: */
lbajardsilogic@0: 
lbajardsilogic@0: #ifndef _MATRIX_FILE_CACHE_H_
lbajardsilogic@0: #define _MATRIX_FILE_CACHE_H_
lbajardsilogic@0: 
lbajardsilogic@0: #include "base/ResizeableBitset.h"
lbajardsilogic@0: 
lbajardsilogic@0: #include "FileReadThread.h"
lbajardsilogic@0: 
lbajardsilogic@0: #include <sys/types.h>
lbajardsilogic@0: #include <QString>
lbajardsilogic@0: #include <QMutex>
lbajardsilogic@0: #include <map>
lbajardsilogic@0: 
lbajardsilogic@0: class MatrixFile : public QObject
lbajardsilogic@0: {
lbajardsilogic@0:     Q_OBJECT
lbajardsilogic@0: 
lbajardsilogic@0: public:
lbajardsilogic@0:     enum Mode { ReadOnly, ReadWrite };
lbajardsilogic@0: 
lbajardsilogic@0:     /**
lbajardsilogic@0:      * Construct a MatrixFile object reading from and/or writing to
lbajardsilogic@0:      * the matrix file with the given base name in the application's
lbajardsilogic@0:      * temporary directory.
lbajardsilogic@0:      *
lbajardsilogic@0:      * If mode is ReadOnly, the file must exist and be readable.
lbajardsilogic@0:      *
lbajardsilogic@0:      * If mode is ReadWrite and the file does not exist, it will be
lbajardsilogic@0:      * created.  If mode is ReadWrite and the file does exist, the
lbajardsilogic@0:      * existing file will be used and the mode will be reset to
lbajardsilogic@0:      * ReadOnly.  Call getMode() to check whether this has occurred
lbajardsilogic@0:      * after construction.
lbajardsilogic@0:      *
lbajardsilogic@0:      * cellSize specifies the size in bytes of the object type stored
lbajardsilogic@0:      * in the matrix.  For example, use cellSize = sizeof(float) for a
lbajardsilogic@0:      * matrix of floats.  The MatrixFile object doesn't care about the
lbajardsilogic@0:      * objects themselves, it just deals with raw data of a given size.
lbajardsilogic@0:      *
lbajardsilogic@0:      * If eagerCache is true, blocks from the file will be cached for
lbajardsilogic@0:      * read.  If eagerCache is false, only columns that have been set
lbajardsilogic@0:      * by calling setColumnAt on this MatrixFile (i.e. columns for
lbajardsilogic@0:      * which haveSetColumnAt returns true) will be cached.
lbajardsilogic@0:      */
lbajardsilogic@0:     MatrixFile(QString fileBase, Mode mode, size_t cellSize, bool eagerCache);
lbajardsilogic@0:     virtual ~MatrixFile();
lbajardsilogic@0: 
lbajardsilogic@0:     Mode getMode() const { return m_mode; }
lbajardsilogic@0: 
lbajardsilogic@0:     size_t getWidth() const { return m_width; }
lbajardsilogic@0:     size_t getHeight() const { return m_height; }
lbajardsilogic@0:     size_t getCellSize() const { return m_cellSize; }
lbajardsilogic@0:     
lbajardsilogic@0:     void resize(size_t width, size_t height);
lbajardsilogic@0:     void reset();
lbajardsilogic@0: 
lbajardsilogic@0:     bool haveSetColumnAt(size_t x) const { return m_columnBitset->get(x); }
lbajardsilogic@0:     void getColumnAt(size_t x, void *data);
lbajardsilogic@0:     void setColumnAt(size_t x, const void *data);
lbajardsilogic@0: 
lbajardsilogic@0:     void suspend();
lbajardsilogic@0: 
lbajardsilogic@0: protected:
lbajardsilogic@0:     int     m_fd;
lbajardsilogic@0:     Mode    m_mode;
lbajardsilogic@0:     int     m_flags;
lbajardsilogic@0:     mode_t  m_fmode;
lbajardsilogic@0:     size_t  m_cellSize;
lbajardsilogic@0:     size_t  m_width;
lbajardsilogic@0:     size_t  m_height;
lbajardsilogic@0:     size_t  m_headerSize;
lbajardsilogic@0:     QString m_fileName;
lbajardsilogic@0:     size_t  m_defaultCacheWidth;
lbajardsilogic@0:     size_t  m_prevX;
lbajardsilogic@0: 
lbajardsilogic@0:     struct Cache {
lbajardsilogic@0:         size_t x;
lbajardsilogic@0:         size_t width;
lbajardsilogic@0:         char *data;
lbajardsilogic@0:     };
lbajardsilogic@0: 
lbajardsilogic@0:     Cache m_cache;
lbajardsilogic@0:     bool  m_eagerCache;
lbajardsilogic@0: 
lbajardsilogic@0:     bool getFromCache(size_t x, size_t ystart, size_t ycount, void *data);
lbajardsilogic@0:     void primeCache(size_t x, bool left);
lbajardsilogic@0: 
lbajardsilogic@0:     void resume();
lbajardsilogic@0: 
lbajardsilogic@0:     bool seekTo(size_t x, size_t y);
lbajardsilogic@0: 
lbajardsilogic@0:     static FileReadThread *m_readThread;
lbajardsilogic@0:     int m_requestToken;
lbajardsilogic@0: 
lbajardsilogic@0:     size_t m_requestingX;
lbajardsilogic@0:     size_t m_requestingWidth;
lbajardsilogic@0:     char *m_spareData;
lbajardsilogic@0: 
lbajardsilogic@0:     static std::map<QString, int> m_refcount;
lbajardsilogic@0:     static QMutex m_refcountMutex;
lbajardsilogic@0:     QMutex m_fdMutex;
lbajardsilogic@0:     QMutex m_cacheMutex;
lbajardsilogic@0: 
lbajardsilogic@0:     typedef std::map<QString, ResizeableBitset *> ResizeableBitsetMap;
lbajardsilogic@0:     static ResizeableBitsetMap m_columnBitsets;
lbajardsilogic@0:     static QMutex m_columnBitsetWriteMutex;
lbajardsilogic@0:     ResizeableBitset *m_columnBitset;
lbajardsilogic@0: };
lbajardsilogic@0: 
lbajardsilogic@0: #endif
lbajardsilogic@0: