view layer/Colour3DPlotExporter.h @ 1554:a0b2f3b4dd2f spectrogram-export

Start work on spectrogram export code

/* -*- 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 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.
*/

#ifndef COLOUR_3D_PLOT_EXPORTER_H
#define COLOUR_3D_PLOT_EXPORTER_H

#include "Colour3DPlotRenderer.h"

class Colour3DPlotExporter : public Model
{
    Q_OBJECT
    
public:
    struct Sources {
        // These must all outlive this class, or else discardSources()
        // must be called
        const VerticalBinLayer *verticalBinLayer; // always
        ModelId source; // always; a DenseThreeDimensionalModel
        ModelId fft; // optionally; an FFTModel; used for phase/peak-freq modes
        const LayerGeometryProvider *provider; // optionally
    };

    struct Parameters {
        Parameters() :
            binDisplay(BinDisplay::AllBins) { }

        /** Selection of bins to include in the export. */
        BinDisplay binDisplay;
    };
    
    Colour3DPlotExporter(Sources sources, Parameters parameters) :
        m_sources(sources),
        m_params(parameters)
    { }

    void discardSources() {
        QMutexLocker locker(&m_mutex);
        m_sources.verticalBinLayer = nullptr;
        m_sources.source = {};
        m_sources.fft = {};
        m_sources.provider = nullptr;
    }

    QString toDelimitedDataString(QString, DataExportOptions,
                                  sv_frame_t, sv_frame_t) const override;

private:
    Sources m_sources;
    Parameters m_params;
};

#endif