Chris@87: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
Chris@87: 
Chris@87: /*
Chris@87:     Sonic Visualiser
Chris@87:     An audio file viewer and annotation editor.
Chris@87:     Centre for Digital Music, Queen Mary, University of London.
Chris@87:     This file copyright 2006 Chris Cannam.
Chris@87:     
Chris@87:     This program is free software; you can redistribute it and/or
Chris@87:     modify it under the terms of the GNU General Public License as
Chris@87:     published by the Free Software Foundation; either version 2 of the
Chris@87:     License, or (at your option) any later version.  See the file
Chris@87:     COPYING included with this distribution for more information.
Chris@87: */
Chris@87: 
Chris@87: #include "MatrixFileCache.h"
Chris@87: #include "base/TempDirectory.h"
Chris@87: 
Chris@87: #include <sys/types.h>
Chris@87: #include <sys/stat.h>
Chris@87: #include <fcntl.h>
Chris@87: #include <unistd.h>
Chris@87: 
Chris@87: #include <iostream>
Chris@87: 
Chris@87: #include <cstdio>
Chris@87: 
Chris@87: #include <QFileInfo>
Chris@87: #include <QDir>
Chris@87: 
Chris@87: MatrixFileCache::MatrixFileCache(QString fileBase, Mode mode) :
Chris@87:     m_fd(-1),
Chris@87:     m_off(-1),
Chris@87:     m_mode(mode),
Chris@87:     m_width(0),
Chris@87:     m_height(0),
Chris@87:     m_rx(0),
Chris@87:     m_rw(0),
Chris@87:     m_range(0),
Chris@87:     m_headerSize(2 * sizeof(size_t))
Chris@87: {
Chris@87:     QDir tempDir(TempDirectory::instance()->getPath());
Chris@87:     QString fileName(tempDir.filePath(QString("%1.mfc").arg(fileBase)));
Chris@87:     bool newFile = !QFileInfo(fileName).exists();
Chris@87: 
Chris@87:     if (newFile && mode == ReadOnly) {
Chris@87:         std::cerr << "ERROR: MatrixFileCache::MatrixFileCache: Read-only mode "
Chris@87:                   << "specified, but cache file does not exist" << std::endl;
Chris@87:         return;
Chris@87:     }
Chris@87: 
Chris@87:     int flags = 0;
Chris@87:     mode_t fmode = S_IRUSR | S_IWUSR;
Chris@87: 
Chris@87:     if (mode == ReadWrite) {
Chris@87:         flags = O_RDWR | O_CREAT;
Chris@87:     } else {
Chris@87:         flags = O_RDONLY;
Chris@87:     }
Chris@87: 
Chris@87:     if ((m_fd = ::open(fileName.toLocal8Bit(), flags, mode)) < 0) {
Chris@87:         ::perror("Open failed");
Chris@87:         std::cerr << "ERROR: MatrixFileCache::MatrixFileCache: "
Chris@87:                   << "Failed to open cache file \""
Chris@87:                   << fileName.toStdString() << "\"";
Chris@87:         if (mode == ReadWrite) std::cerr << " for writing";
Chris@87:         std::cerr << std::endl;
Chris@87:     }
Chris@87: 
Chris@87:     if (newFile) {
Chris@87:         resize(0, 0); // write header
Chris@87:     } else {
Chris@87:         size_t header[2];
Chris@87:         if (::read(m_fd, header, 2 * sizeof(size_t))) {
Chris@87:             perror("Read failed");
Chris@87:             std::cerr << "ERROR: MatrixFileCache::MatrixFileCache: "
Chris@87:                       << "Failed to read header" << std::endl;
Chris@87:             return;
Chris@87:         }
Chris@87:         m_width = header[0];
Chris@87:         m_height = header[1];
Chris@87:         seekTo(0, 0);
Chris@87:     }
Chris@87: 
Chris@87:     std::cerr << "MatrixFileCache::MatrixFileCache: Done, size is " << m_width << "x" << m_height << std::endl;
Chris@87: 
Chris@87: }
Chris@87: 
Chris@87: MatrixFileCache::~MatrixFileCache()
Chris@87: {
Chris@87:     if (m_fd >= 0) {
Chris@87:         if (::close(m_fd) < 0) {
Chris@87:             ::perror("MatrixFileCache::~MatrixFileCache: close failed");
Chris@87:         }
Chris@87:     }
Chris@87: }
Chris@87: 
Chris@87: size_t 
Chris@87: MatrixFileCache::getWidth() const
Chris@87: {
Chris@87:     return m_width;
Chris@87: }
Chris@87: 
Chris@87: size_t
Chris@87: MatrixFileCache::getHeight() const
Chris@87: {
Chris@87:     return m_height;
Chris@87: }
Chris@87: 
Chris@87: void
Chris@87: MatrixFileCache::resize(size_t w, size_t h)
Chris@87: {
Chris@87:     if (m_mode != ReadWrite) {
Chris@87:         std::cerr << "ERROR: MatrixFileCache::resize called on read-only cache"
Chris@87:                   << std::endl;
Chris@87:         return;
Chris@87:     }
Chris@87: 
Chris@87:     off_t off = m_headerSize + (w * h * sizeof(float));
Chris@87: 
Chris@87:     if (w * h > m_width * m_height) {
Chris@87: 
Chris@87:         if (::lseek(m_fd, off - sizeof(float), SEEK_SET) == (off_t)-1) {
Chris@87:             ::perror("Seek failed");
Chris@87:             std::cerr << "ERROR: MatrixFileCache::resize(" << w << ", "
Chris@87:                       << h << "): seek failed, cannot resize" << std::endl;
Chris@87:             return;
Chris@87:         }
Chris@87: 
Chris@87:         // guess this requires efficient support for sparse files
Chris@87:         
Chris@87:         float f(0);
Chris@87:         if (::write(m_fd, &f, sizeof(float)) != sizeof(float)) {
Chris@87:             ::perror("WARNING: MatrixFileCache::resize: write failed");
Chris@87:         }
Chris@87: 
Chris@87:     } else {
Chris@87:         
Chris@87:         if (::ftruncate(m_fd, off) < 0) {
Chris@87:             ::perror("MatrixFileCache::resize: ftruncate failed");
Chris@87:         }
Chris@87:     }
Chris@87: 
Chris@87:     m_width = 0;
Chris@87:     m_height = 0;
Chris@87:     m_off = 0;
Chris@87: 
Chris@87:     if (::lseek(m_fd, 0, SEEK_SET) == (off_t)-1) {
Chris@87:         ::perror("ERROR: MatrixFileCache::resize: Seek to write header failed");
Chris@87:         return;
Chris@87:     }
Chris@87: 
Chris@87:     size_t header[2];
Chris@87:     header[0] = w;
Chris@87:     header[1] = h;
Chris@87:     if (::write(m_fd, header, 2 * sizeof(size_t)) != 2 * sizeof(size_t)) {
Chris@87:         ::perror("ERROR: MatrixFileCache::resize: Failed to write header");
Chris@87:         return;
Chris@87:     }
Chris@87: 
Chris@87:     m_width = w;
Chris@87:     m_height = h;
Chris@87: 
Chris@87:     seekTo(0, 0);
Chris@87: }
Chris@87: 
Chris@87: void
Chris@87: MatrixFileCache::reset()
Chris@87: {
Chris@87:     if (m_mode != ReadWrite) {
Chris@87:         std::cerr << "ERROR: MatrixFileCache::reset called on read-only cache"
Chris@87:                   << std::endl;
Chris@87:         return;
Chris@87:     }
Chris@87:     
Chris@87:     //...
Chris@87: }
Chris@87: 
Chris@87: void
Chris@87: MatrixFileCache::setRangeOfInterest(size_t x, size_t width)
Chris@87: {
Chris@87: }
Chris@87: 
Chris@87: float
Chris@87: MatrixFileCache::getValueAt(size_t x, size_t y) const
Chris@87: {
Chris@87:     if (m_rw > 0 && x >= m_rx && x < m_rx + m_rw) {
Chris@87:         return m_range[x - m_rx][y];
Chris@87:     }
Chris@87: 
Chris@87:     if (!seekTo(x, y)) return 0.f;
Chris@87:     float value;
Chris@87:     if (::read(m_fd, &value, sizeof(float)) != sizeof(float)) {
Chris@87:         ::perror("MatrixFileCache::getValueAt: read failed");
Chris@87:         return 0.f;
Chris@87:     }
Chris@87:     return value;
Chris@87: }
Chris@87: 
Chris@87: void
Chris@87: MatrixFileCache::getColumnAt(size_t x, float *values) const
Chris@87: {
Chris@87:     if (m_rw > 0 && x >= m_rx && x < m_rx + m_rw) {
Chris@87:         for (size_t y = 0; y < m_height; ++y) {
Chris@87:             values[y] = m_range[x - m_rx][y];
Chris@87:         }
Chris@87:     }
Chris@87: 
Chris@87:     if (!seekTo(x, 0)) return;
Chris@87:     if (::read(m_fd, values, m_height * sizeof(float)) != m_height * sizeof(float)) {
Chris@87:         ::perror("MatrixFileCache::getColumnAt: read failed");
Chris@87:     }
Chris@87:     return;
Chris@87: }
Chris@87: 
Chris@87: void
Chris@87: MatrixFileCache::setValueAt(size_t x, size_t y, float value)
Chris@87: {
Chris@87:     if (m_mode != ReadWrite) {
Chris@87:         std::cerr << "ERROR: MatrixFileCache::setValueAt called on read-only cache"
Chris@87:                   << std::endl;
Chris@87:         return;
Chris@87:     }
Chris@87: 
Chris@87:     if (!seekTo(x, y)) return;
Chris@87:     if (::write(m_fd, &value, sizeof(float)) != sizeof(float)) {
Chris@87:         ::perror("WARNING: MatrixFileCache::setValueAt: write failed");
Chris@87:     }
Chris@87: 
Chris@87:     //... update range as appropriate
Chris@87: }
Chris@87: 
Chris@87: void
Chris@87: MatrixFileCache::setColumnAt(size_t x, float *values)
Chris@87: {
Chris@87:     if (m_mode != ReadWrite) {
Chris@87:         std::cerr << "ERROR: MatrixFileCache::setColumnAt called on read-only cache"
Chris@87:                   << std::endl;
Chris@87:         return;
Chris@87:     }
Chris@87: 
Chris@87:     if (!seekTo(x, 0)) return;
Chris@87:     if (::write(m_fd, values, m_height * sizeof(float)) != m_height * sizeof(float)) {
Chris@87:         ::perror("WARNING: MatrixFileCache::setColumnAt: write failed");
Chris@87:     }
Chris@87: 
Chris@87:     //... update range as appropriate
Chris@87: }
Chris@87: 
Chris@87: bool
Chris@87: MatrixFileCache::seekTo(size_t x, size_t y) const
Chris@87: {
Chris@87:     off_t off = m_headerSize + (x * m_height + y) * sizeof(float);
Chris@87:     if (off == m_off) return true;
Chris@87: 
Chris@87:     if (::lseek(m_fd, off, SEEK_SET) == (off_t)-1) {
Chris@87:         ::perror("Seek failed");
Chris@87:         std::cerr << "ERROR: MatrixFileCache::seekTo(" << x << ", " << y
Chris@87:                   << ") failed" << std::endl;
Chris@87:         return false;
Chris@87:     }
Chris@87: 
Chris@87:     m_off = off;
Chris@87:     return true;
Chris@87: }
Chris@87: