Chris@498: /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
Chris@498: 
Chris@498: /*
Chris@498:     Sonic Visualiser
Chris@498:     An audio file viewer and annotation editor.
Chris@498: 
Chris@498:     Sonic Annotator
Chris@498:     A utility for batch feature extraction from audio files.
Chris@498: 
Chris@498:     Mark Levy, Chris Sutton and Chris Cannam, Queen Mary, University of London.
Chris@498:     Copyright 2007-2008 QMUL.
Chris@498: 
Chris@498:     This program is free software; you can redistribute it and/or
Chris@498:     modify it under the terms of the GNU General Public License as
Chris@498:     published by the Free Software Foundation; either version 2 of the
Chris@498:     License, or (at your option) any later version.  See the file
Chris@498:     COPYING included with this distribution for more information.
Chris@498: */
Chris@498: 
Chris@1581: #ifndef SV_FEATURE_WRITER_H
Chris@1581: #define SV_FEATURE_WRITER_H
Chris@498: 
Chris@498: #include <string>
Chris@498: #include <map>
Chris@498: #include <vector>
Chris@498: 
Chris@498: #include <QString>
Chris@498: 
Chris@498: #include "Transform.h"
Chris@498: 
Chris@498: #include <vamp-hostsdk/Plugin.h>
Chris@498: 
Chris@498: using std::string;
Chris@498: using std::map;
Chris@498: using std::vector;
Chris@498: 
Chris@498: class FeatureWriter
Chris@498: {
Chris@498: public:
Chris@498:     virtual ~FeatureWriter() { }
Chris@498: 
Chris@998:     virtual string getDescription() const = 0;
Chris@998: 
Chris@498:     struct Parameter { // parameter of the writer, not the plugin
Chris@1129:         Parameter() : hasArg(false), mandatory(false) { }
Chris@498:         string name;
Chris@498:         string description;
Chris@498:         bool hasArg;
Chris@1129:         bool mandatory;
Chris@498:     };
Chris@498:     typedef vector<Parameter> ParameterList;
Chris@498:     virtual ParameterList getSupportedParameters() const {
Chris@498:         return ParameterList();
Chris@498:     }
Chris@498: 
Chris@930:     virtual void setParameters(map<string, string> &) {
Chris@498:         return;
Chris@498:     }
Chris@498: 
Chris@504:     struct TrackMetadata {
Chris@504:         QString title;
Chris@504:         QString maker;
Chris@1143:         RealTime duration;
Chris@504:     };
Chris@930:     virtual void setTrackMetadata(QString /* trackid */, TrackMetadata) { }
Chris@504: 
Chris@604:     class FailedToOpenOutputStream : virtual public std::exception
Chris@604:     {
Chris@604:     public:
Chris@604:         FailedToOpenOutputStream(QString trackId, QString transformId) throw() :
Chris@604:             m_trackId(trackId),
Chris@604:             m_transformId(transformId)
Chris@604:         { }
Chris@604:         virtual ~FailedToOpenOutputStream() throw() { }
Chris@1580:         const char *what() const throw() override {
Chris@1848:             static QByteArray msg;
Chris@1848:             msg = QString("Failed to open output stream for track id \"%1\", transform id \"%2\"")
Chris@1848:                 .arg(m_trackId).arg(m_transformId).toLocal8Bit();
Chris@1848:             return msg.data();
Chris@604:         }            
Chris@604:         
Chris@604:     protected:
Chris@604:         QString m_trackId;
Chris@604:         QString m_transformId;
Chris@604:     };
Chris@604: 
Chris@1005:     /**
Chris@1005:      * Notify the writer that we are about to start extraction for
Chris@1005:      * input file N of M (where N is 1..M). May be useful when writing
Chris@1005:      * multiple outputs into a single file where some syntactic
Chris@1005:      * element is needed to connect them.
Chris@1005:      */
Chris@1005:     virtual void setNofM(int /* N */, int /* M */) { }
Chris@1005: 
Chris@498:     // may throw FailedToOpenFile or other exceptions
Chris@498:     virtual void write(QString trackid,
Chris@498:                        const Transform &transform,
Chris@498:                        const Vamp::Plugin::OutputDescriptor &output,
Chris@498:                        const Vamp::Plugin::FeatureList &features,
Chris@498:                        std::string summaryType = "") = 0;
Chris@498: 
Chris@625:     /**
Chris@625:      * Throw FailedToOpenOutputStream if we can already tell that we
Chris@625:      * will be unable to write to the output file.  This is called to
Chris@625:      * test the output stream before processing begins.  The writer
Chris@625:      * may legitimately succeed here but still fail later -- this is
Chris@625:      * really an optimisation to ensure that easy-to-recognise failure
Chris@625:      * cases fail early.
Chris@625:      */
Chris@930:     virtual void testOutputFile(QString /* trackId */, TransformId) { }
Chris@625: 
Chris@515:     virtual void flush() { } // whatever the last stream was
Chris@515: 
Chris@498:     virtual void finish() = 0;
Chris@604: 
Chris@604:     virtual QString getWriterTag() const = 0;
Chris@498: };
Chris@498: 
Chris@498: #endif