view transform/CSVFeatureWriter.h @ 1833:21c792334c2e sensible-delimited-data-strings

Rewrite all the DelimitedDataString stuff so as to return vectors of individual cell strings rather than having the classes add the delimiters themselves. Rename accordingly to names based on StringExport. Take advantage of this in the CSV writer code so as to properly quote cells that contain delimiter characters.

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

    Sonic Annotator
    A utility for batch feature extraction from audio files.

    Mark Levy, Chris Sutton and Chris Cannam, Queen Mary, University of London.
    Copyright 2007-2008 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.
*/

#ifndef SV_CSV_FEATURE_WRITER_H
#define SV_CSV_FEATURE_WRITER_H

#include <string>
#include <map>
#include <set>

#include <QString>

#include "FileFeatureWriter.h"

using std::string;
using std::map;

class QTextStream;
class QFile;

class CSVFeatureWriter : public FileFeatureWriter
{
public:
    CSVFeatureWriter();
    virtual ~CSVFeatureWriter();

    string getDescription() const override;

    ParameterList getSupportedParameters() const override;
    void setParameters(map<string, string> &params) override;

    void write(QString trackid,
                       const Transform &transform,
                       const Vamp::Plugin::OutputDescriptor &output,
                       const Vamp::Plugin::FeatureList &features,
                       std::string summaryType = "") override;

    void finish() override;

    QString getWriterTag() const override { return "csv"; }

private:
    QString m_separator;
    bool m_sampleTiming;
    bool m_endTimes;
    bool m_forceEnd;
    bool m_omitFilename;
    QString m_prevPrintedTrackId;

    typedef pair<QString, Transform> DataId; // track id, transform
    typedef map<DataId, Vamp::Plugin::Feature> PendingFeatures;
    typedef map<DataId, std::string> PendingSummaryTypes;
    PendingFeatures m_pending;
    PendingSummaryTypes m_pendingSummaryTypes;

    void writeFeature(DataId,
                      QTextStream &,
                      const Vamp::Plugin::Feature &f,
                      const Vamp::Plugin::Feature *optionalNextFeature,
                      std::string summaryType);

    int m_digits;
};

#endif