comparison data/model/WaveFileModel.cpp @ 147:3a13b0d4934e

* Reorganising code base.  This revision will not compile.

+/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
+
+/*
+    Sonic Visualiser
+    An audio file viewer and annotation editor.
+    Centre for Digital Music, Queen Mary, University of London.
+    This file copyright 2006 Chris Cannam.
+    
+    This program is free software; you can redistribute it and/or
+    modify it under the terms of the GNU General Public License as
+    published by the Free Software Foundation; either version 2 of the
+    License, or (at your option) any later version.  See the file
+    COPYING included with this distribution for more information.
+*/
+
+#include "model/WaveFileModel.h"
+
+#include "fileio/AudioFileReader.h"
+#include "fileio/AudioFileReaderFactory.h"
+
+#include "base/System.h"
+
+#include <QMessageBox>
+#include <QFileInfo>
+
+#include <iostream>
+#include <unistd.h>
+#include <math.h>
+#include <sndfile.h>
+
+#include <cassert>
+
+using std::cerr;
+using std::endl;
+
+WaveFileModel::WaveFileModel(QString path) :
+    m_path(path),
+    m_fillThread(0),
+    m_updateTimer(0),
+    m_lastFillExtent(0),
+    m_exiting(false)
+{
+    m_reader = AudioFileReaderFactory::createReader(path);
+    setObjectName(QFileInfo(path).fileName());
+    if (isOK()) fillCache();
+}
+
+WaveFileModel::~WaveFileModel()
+{
+    m_exiting = true;
+    if (m_fillThread) m_fillThread->wait();
+    delete m_reader;
+    m_reader = 0;
+}
+
+bool
+WaveFileModel::isOK() const
+{
+    return m_reader && m_reader->isOK();
+}
+
+bool
+WaveFileModel::isReady(int *completion) const
+{
+    bool ready = (isOK() && (m_fillThread == 0));
+    double c = double(m_lastFillExtent) / double(getEndFrame() - getStartFrame());
+    if (completion) *completion = int(c * 100.0 + 0.01);
+    return ready;
+}
+
+Model *
+WaveFileModel::clone() const
+{
+    WaveFileModel *model = new WaveFileModel(m_path);
+    return model;
+}
+
+size_t
+WaveFileModel::getFrameCount() const
+{
+    if (!m_reader) return 0;
+    return m_reader->getFrameCount();
+}
+
+size_t
+WaveFileModel::getChannelCount() const
+{
+    if (!m_reader) return 0;
+    return m_reader->getChannelCount();
+}
+
+size_t
+WaveFileModel::getSampleRate() const 
+{
+    if (!m_reader) return 0;
+    return m_reader->getSampleRate();
+}
+
+size_t
+WaveFileModel::getValues(int channel, size_t start, size_t end,
+			 float *buffer) const
+{
+    // Always read these directly from the file. 
+    // This is used for e.g. audio playback.
+    // Could be much more efficient (although compiler optimisation will help)
+
+    if (end < start) {
+	std::cerr << "ERROR: WaveFileModel::getValues[float]: end < start ("
+		  << end << " < " << start << ")" << std::endl;
+	assert(end >= start);
+    }
+
+    if (!m_reader || !m_reader->isOK()) return 0;
+
+    SampleBlock frames;
+    m_reader->getInterleavedFrames(start, end - start, frames);
+
+    size_t i = 0;
+
+    int ch0 = channel, ch1 = channel, channels = getChannelCount();
+    if (channel == -1) {
+	ch0 = 0;
+	ch1 = channels - 1;
+    }
+    
+    while (i < end - start) {
+
+	buffer[i] = 0.0;
+
+	for (int ch = ch0; ch <= ch1; ++ch) {
+
+	    size_t index = i * channels + ch;
+	    if (index >= frames.size()) break;
+            
+	    float sample = frames[index];
+	    buffer[i] += sample;
+	}
+
+	++i;
+    }
+
+    return i;
+}
+
+size_t
+WaveFileModel::getValues(int channel, size_t start, size_t end,
+			 double *buffer) const
+{
+    if (end < start) {
+	std::cerr << "ERROR: WaveFileModel::getValues[double]: end < start ("
+		  << end << " < " << start << ")" << std::endl;
+	assert(end >= start);
+    }
+
+    if (!m_reader || !m_reader->isOK()) return 0;
+
+    SampleBlock frames;
+    m_reader->getInterleavedFrames(start, end - start, frames);
+
+    size_t i = 0;
+
+    int ch0 = channel, ch1 = channel, channels = getChannelCount();
+    if (channel == -1) {
+	ch0 = 0;
+	ch1 = channels - 1;
+    }
+
+    while (i < end - start) {
+
+	buffer[i] = 0.0;
+
+	for (int ch = ch0; ch <= ch1; ++ch) {
+
+	    size_t index = i * channels + ch;
+	    if (index >= frames.size()) break;
+            
+	    float sample = frames[index];
+	    buffer[i] += sample;
+	}
+
+	++i;
+    }
+
+    return i;
+}
+
+WaveFileModel::RangeBlock
+WaveFileModel::getRanges(size_t channel, size_t start, size_t end,
+			 size_t &blockSize) const
+{
+    RangeBlock ranges;
+    if (!isOK()) return ranges;
+
+    if (end <= start) {
+	std::cerr << "WARNING: Internal error: end <= start in WaveFileModel::getRanges (end = " << end << ", start = " << start << ", blocksize = " << blockSize << ")" << std::endl;
+	return ranges;
+    }
+
+    int cacheType = 0;
+    int power = getMinCachePower();
+    blockSize = getNearestBlockSize(blockSize, cacheType, power,
+				    ZoomConstraint::RoundUp);
+
+    size_t channels = getChannelCount();
+
+    if (cacheType != 0 && cacheType != 1) {
+
+	// We need to read directly from the file.  We haven't got
+	// this cached.  Hope the requested area is small.  This is
+	// not optimal -- we'll end up reading the same frames twice
+	// for stereo files, in two separate calls to this method.
+	// We could fairly trivially handle this for most cases that
+	// matter by putting a single cache in getInterleavedFrames
+	// for short queries.
+
+	SampleBlock frames;
+	m_reader->getInterleavedFrames(start, end - start, frames);
+	float max = 0.0, min = 0.0, total = 0.0;
+	size_t i = 0, count = 0;
+
+	while (i < end - start) {
+
+	    size_t index = i * channels + channel;
+	    if (index >= frames.size()) break;
+            
+	    float sample = frames[index];
+            if (sample > max || count == 0) max = sample;
+	    if (sample < min || count == 0) min = sample;
+            total += fabsf(sample);
+	    
+	    ++i;
+            ++count;
+            
+            if (count == blockSize) {
+                ranges.push_back(Range(min, max, total / count));
+                min = max = total = 0.0f;
+                count = 0;
+	    }
+	}
+
+	if (count > 0) {
+            ranges.push_back(Range(min, max, total / count));
+	}
+
+	return ranges;
+
+    } else {
+
+	QMutexLocker locker(&m_mutex);
+    
+	const RangeBlock &cache = m_cache[cacheType];
+
+	size_t cacheBlock, div;
+        
+	if (cacheType == 0) {
+	    cacheBlock = (1 << getMinCachePower());
+            div = (1 << power) / cacheBlock;
+	} else {
+	    cacheBlock = ((unsigned int)((1 << getMinCachePower()) * sqrt(2) + 0.01));
+            div = ((unsigned int)((1 << power) * sqrt(2) + 0.01)) / cacheBlock;
+	}
+
+	size_t startIndex = start / cacheBlock;
+	size_t endIndex = end / cacheBlock;
+
+	float max = 0.0, min = 0.0, total = 0.0;
+	size_t i = 0, count = 0;
+
+	//cerr << "blockSize is " << blockSize << ", cacheBlock " << cacheBlock << ", start " << start << ", end " << end << ", power is " << power << ", div is " << div << ", startIndex " << startIndex << ", endIndex " << endIndex << endl;
+
+	for (i = 0; i < endIndex - startIndex; ) {
+        
+	    size_t index = (i + startIndex) * channels + channel;
+	    if (index >= cache.size()) break;
+            
+            const Range &range = cache[index];
+            if (range.max > max || count == 0) max = range.max;
+            if (range.min < min || count == 0) min = range.min;
+            total += range.absmean;
+            
+	    ++i;
+            ++count;
+            
+	    if (count == div) {
+		ranges.push_back(Range(min, max, total / count));
+                min = max = total = 0.0f;
+                count = 0;
+	    }
+	}
+		
+	if (count > 0) {
+            ranges.push_back(Range(min, max, total / count));
+	}
+    }
+
+    //cerr << "returning " << ranges.size() << " ranges" << endl;
+    return ranges;
+}
+
+WaveFileModel::Range
+WaveFileModel::getRange(size_t channel, size_t start, size_t end) const
+{
+    Range range;
+    if (!isOK()) return range;
+
+    if (end <= start) {
+	std::cerr << "WARNING: Internal error: end <= start in WaveFileModel::getRange (end = " << end << ", start = " << start << ")" << std::endl;
+	return range;
+    }
+
+    size_t blockSize;
+    for (blockSize = 1; blockSize <= end - start; blockSize *= 2);
+    blockSize /= 2;
+
+    bool first = false;
+
+    size_t blockStart = (start / blockSize) * blockSize;
+    size_t blockEnd = (end / blockSize) * blockSize;
+
+    if (blockStart < start) blockStart += blockSize;
+        
+    if (blockEnd > blockStart) {
+        RangeBlock ranges = getRanges(channel, blockStart, blockEnd, blockSize);
+        for (size_t i = 0; i < ranges.size(); ++i) {
+            if (first || ranges[i].min < range.min) range.min = ranges[i].min;
+            if (first || ranges[i].max > range.max) range.max = ranges[i].max;
+            if (first || ranges[i].absmean < range.absmean) range.absmean = ranges[i].absmean;
+            first = false;
+        }
+    }
+
+    if (blockStart > start) {
+        Range startRange = getRange(channel, start, blockStart);
+        range.min = std::min(range.min, startRange.min);
+        range.max = std::max(range.max, startRange.max);
+        range.absmean = std::min(range.absmean, startRange.absmean);
+    }
+
+    if (blockEnd < end) {
+        Range endRange = getRange(channel, blockEnd, end);
+        range.min = std::min(range.min, endRange.min);
+        range.max = std::max(range.max, endRange.max);
+        range.absmean = std::min(range.absmean, endRange.absmean);
+    }
+
+    return range;
+}
+
+void
+WaveFileModel::fillCache()
+{
+    m_mutex.lock();
+    m_updateTimer = new QTimer(this);
+    connect(m_updateTimer, SIGNAL(timeout()), this, SLOT(fillTimerTimedOut()));
+    m_updateTimer->start(100);
+    m_fillThread = new RangeCacheFillThread(*this);
+    connect(m_fillThread, SIGNAL(finished()), this, SLOT(cacheFilled()));
+    m_mutex.unlock();
+    m_fillThread->start();
+}   
+
+void
+WaveFileModel::fillTimerTimedOut()
+{
+    if (m_fillThread) {
+	size_t fillExtent = m_fillThread->getFillExtent();
+	if (fillExtent > m_lastFillExtent) {
+	    emit modelChanged(m_lastFillExtent, fillExtent);
+	    m_lastFillExtent = fillExtent;
+	}
+    } else {
+	emit modelChanged();
+    }
+}
+
+void
+WaveFileModel::cacheFilled()
+{
+    m_mutex.lock();
+    delete m_fillThread;
+    m_fillThread = 0;
+    delete m_updateTimer;
+    m_updateTimer = 0;
+    m_mutex.unlock();
+    emit modelChanged();
+//    cerr << "WaveFileModel::cacheFilled" << endl;
+}
+
+void
+WaveFileModel::RangeCacheFillThread::run()
+{
+    size_t cacheBlockSize[2];
+    cacheBlockSize[0] = (1 << m_model.getMinCachePower());
+    cacheBlockSize[1] = ((unsigned int)((1 << m_model.getMinCachePower()) *
+                                        sqrt(2) + 0.01));
+    
+    size_t frame = 0;
+    size_t readBlockSize = 16384;
+    SampleBlock block;
+
+    if (!m_model.isOK()) return;
+    
+    size_t channels = m_model.getChannelCount();
+    size_t frames = m_model.getFrameCount();
+
+    Range *range = new Range[2 * channels];
+    size_t count[2];
+    count[0] = count[1] = 0;
+    
+    while (frame < frames) {
+
+	m_model.m_reader->getInterleavedFrames(frame, readBlockSize, block);
+
+        for (size_t i = 0; i < readBlockSize; ++i) {
+		
+	    for (size_t ch = 0; ch < size_t(channels); ++ch) {
+
+                size_t index = channels * i + ch;
+		if (index >= block.size()) continue;
+                float sample = block[index];
+                
+                for (size_t ct = 0; ct < 2; ++ct) {
+                
+                    size_t rangeIndex = ch * 2 + ct;
+                    
+                    if (sample > range[rangeIndex].max || count[ct] == 0) {
+                        range[rangeIndex].max = sample;
+                    }
+                    if (sample < range[rangeIndex].min || count[ct] == 0) {
+                        range[rangeIndex].min = sample;
+                    }
+                    range[rangeIndex].absmean += fabsf(sample);
+                }
+	    }
+            
+	    QMutexLocker locker(&m_model.m_mutex);
+            for (size_t ct = 0; ct < 2; ++ct) {
+                if (++count[ct] == cacheBlockSize[ct]) {
+                    for (size_t ch = 0; ch < size_t(channels); ++ch) {
+                        size_t rangeIndex = ch * 2 + ct;
+                        range[rangeIndex].absmean /= count[ct];
+                        m_model.m_cache[ct].push_back(range[rangeIndex]);
+                        range[rangeIndex] = Range();
+                    }
+                    count[ct] = 0;
+                }
+            }
+            
+            ++frame;
+        }
+
+	if (m_model.m_exiting) break;
+
+	m_fillExtent = frame;
+    }
+
+    QMutexLocker locker(&m_model.m_mutex);
+    for (size_t ct = 0; ct < 2; ++ct) {
+        if (count[ct] > 0) {
+            for (size_t ch = 0; ch < size_t(channels); ++ch) {
+                size_t rangeIndex = ch * 2 + ct;
+                range[rangeIndex].absmean /= count[ct];
+                m_model.m_cache[ct].push_back(range[rangeIndex]);
+                range[rangeIndex] = Range();
+            }
+            count[ct] = 0;
+        }
+
+	const Range &rr = *m_model.m_cache[ct].begin();
+	MUNLOCK(&rr, m_model.m_cache[ct].capacity() * sizeof(Range));
+    }
+    
+    delete[] range;
+
+    m_fillExtent = frames;
+        
+//    for (size_t ct = 0; ct < 2; ++ct) {
+//        cerr << "Cache type " << ct << " now contains " << m_model.m_cache[ct].size() << " ranges" << endl;
+//    }
+}
+
+QString
+WaveFileModel::toXmlString(QString indent,
+			   QString extraAttributes) const
+{
+    return Model::toXmlString(indent,
+			      QString("type=\"wavefile\" file=\"%1\" %2")
+			      .arg(m_path).arg(extraAttributes));
+}
+    
+
+#ifdef INCLUDE_MOCFILES
+#ifdef INCLUDE_MOCFILES
+#include "WaveFileModel.moc.cpp"
+#endif
+#endif
+