annotate data/fileio/WavFileWriter.cpp @ 1798:13bd41bd8a17

Some work on making Model classes thread-safe in typical use - and documenting this. Some of the implementations are simpler now that EventSeries is thread-safe

/* -*- 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 and QMUL.
    
    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 "WavFileWriter.h"

#include "model/DenseTimeValueModel.h"
#include "base/Selection.h"
#include "base/TempWriteFile.h"
#include "base/Exceptions.h"
#include "base/Debug.h"

#include <bqvec/Allocators.h>
#include <bqvec/VectorOps.h>

#include <QFileInfo>

#include <iostream>
#include <cmath>
#include <string>

using namespace std;

WavFileWriter::WavFileWriter(QString path,
                             sv_samplerate_t sampleRate,
                             int channels,
                             FileWriteMode mode) :
    m_path(path),
    m_sampleRate(sampleRate),
    m_channels(channels),
    m_temp(nullptr),
    m_file(nullptr)
{
    SF_INFO fileInfo;

    int fileRate = int(round(m_sampleRate));
    if (m_sampleRate != sv_samplerate_t(fileRate)) {
        SVCERR << "WavFileWriter: WARNING: Non-integer sample rate "
             << m_sampleRate << " presented, rounding to " << fileRate
             << endl;
    }
    fileInfo.samplerate = fileRate;
    fileInfo.channels = m_channels;
    fileInfo.format = SF_FORMAT_WAV | SF_FORMAT_FLOAT;

    try {
        QString writePath = m_path;
        if (mode == WriteToTemporary) {
            m_temp = new TempWriteFile(m_path);
            writePath = m_temp->getTemporaryFilename();
        }
#ifdef Q_OS_WIN
        m_file = sf_wchar_open((LPCWSTR)writePath.utf16(), SFM_WRITE, &fileInfo);
#else
        m_file = sf_open(writePath.toLocal8Bit(), SFM_WRITE, &fileInfo);
#endif
        if (!m_file) {
            SVCERR << "WavFileWriter: Failed to create float-WAV file of "
                   << m_channels << " channels at rate " << fileRate << " ("
                   << sf_strerror(m_file) << ")" << endl;
            m_error = QString("Failed to open audio file '%1' for writing")
                .arg(writePath);
            if (m_temp) {
                delete m_temp;
                m_temp = nullptr;
            }
        }
    } catch (FileOperationFailed &f) {
        m_error = f.what();
        m_temp = nullptr;
        m_file = nullptr;
    }
}

WavFileWriter::~WavFileWriter()
{
    if (m_file) close();
}

bool
WavFileWriter::isOK() const
{
    return (m_error.isEmpty());
}

QString
WavFileWriter::getError() const
{
    return m_error;
}

QString
WavFileWriter::getWriteFilename() const
{
    if (m_temp) {
        return m_temp->getTemporaryFilename();
    } else {
        return m_path;
    }
}

bool
WavFileWriter::writeModel(DenseTimeValueModel *source,
                          MultiSelection *selection)
{
    if (source->getChannelCount() != m_channels) {
        SVDEBUG << "WavFileWriter::writeModel: Wrong number of channels ("
                  << source->getChannelCount()  << " != " << m_channels << ")"
                  << endl;
        m_error = QString("Failed to write model to audio file '%1'")
            .arg(getWriteFilename());
        return false;
    }

    if (!m_file) {
        m_error = QString("Failed to write model to audio file '%1': File not open")
            .arg(getWriteFilename());
        return false;
    }

    bool ownSelection = false;
    if (!selection) {
        selection = new MultiSelection;
        selection->setSelection(Selection(source->getStartFrame(),
                                          source->getEndFrame()));
        ownSelection = true;
    }

    sv_frame_t bs = 2048;

    for (MultiSelection::SelectionList::iterator i =
         selection->getSelections().begin();
         i != selection->getSelections().end(); ++i) {
        
        sv_frame_t f0(i->getStartFrame()), f1(i->getEndFrame());

        for (sv_frame_t f = f0; f < f1; f += bs) {
            
            sv_frame_t n = min(bs, f1 - f);
            floatvec_t interleaved(n * m_channels, 0.f);

            for (int c = 0; c < int(m_channels); ++c) {
                auto chanbuf = source->getData(c, f, n);
                for (int i = 0; in_range_for(chanbuf, i); ++i) {
                    interleaved[i * m_channels + c] = chanbuf[i];
                }
            }

            sf_count_t written = sf_writef_float(m_file, interleaved.data(), n);

            if (written < n) {
                m_error = QString("Only wrote %1 of %2 frames at file frame %3")
                        .arg(written).arg(n).arg(f);
                break;
            }
        }
    }

    if (ownSelection) delete selection;

    return isOK();
}
        
bool
WavFileWriter::writeSamples(const float *const *samples, sv_frame_t count)
{
    if (!m_file) {
        m_error = QString("Failed to write model to audio file '%1': File not open")
            .arg(getWriteFilename());
        return false;
    }

    float *b = new float[count * m_channels];
    for (sv_frame_t i = 0; i < count; ++i) {
        for (int c = 0; c < int(m_channels); ++c) {
            b[i * m_channels + c] = samples[c][i];
        }
    }

    sv_frame_t written = sf_writef_float(m_file, b, count);

    delete[] b;

    if (written < count) {
        m_error = QString("Only wrote %1 of %2 frames")
            .arg(written).arg(count);
    }

    return isOK();
}

bool
WavFileWriter::putInterleavedFrames(const floatvec_t &frames)
{
    sv_frame_t count = frames.size() / m_channels;
    float **samples =
        breakfastquay::allocate_channels<float>(m_channels, count);
    breakfastquay::v_deinterleave
        (samples, frames.data(), m_channels, int(count));
    bool result = writeSamples(samples, count);
    breakfastquay::deallocate_channels(samples, m_channels);
    return result;
}

bool
WavFileWriter::close()
{
    if (m_file) {
        sf_close(m_file);
        m_file = nullptr;
    }
    if (m_temp) {
        m_temp->moveToTarget();
        delete m_temp;
        m_temp = nullptr;
    }
    return true;
}