1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
|
/* -*- 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_FEATURE_WRITER_H
#define SV_FEATURE_WRITER_H
#include <string>
#include <map>
#include <vector>
#include <QString>
#include "Transform.h"
#include <vamp-hostsdk/Plugin.h>
namespace sv {
class FeatureWriter
{
public:
virtual ~FeatureWriter() { }
virtual std::string getDescription() const = 0;
struct Parameter { // parameter of the writer, not the plugin
Parameter() : hasArg(false), mandatory(false) { }
std::string name;
std::string description;
bool hasArg;
bool mandatory;
};
typedef std::vector<Parameter> ParameterList;
virtual ParameterList getSupportedParameters() const {
return ParameterList();
}
virtual void setParameters(std::map<std::string, std::string> &) {
return;
}
struct TrackMetadata {
QString title;
QString maker;
RealTime duration;
};
virtual void setTrackMetadata(QString /* trackid */, TrackMetadata) { }
class FailedToOpenOutputStream : virtual public std::exception
{
public:
FailedToOpenOutputStream(QString trackId, QString transformId) throw() :
m_trackId(trackId),
m_transformId(transformId)
{ }
virtual ~FailedToOpenOutputStream() throw() { }
const char *what() const throw() override {
static QByteArray msg;
msg = QString("Failed to open output stream for track id \"%1\", transform id \"%2\"")
.arg(m_trackId).arg(m_transformId).toLocal8Bit();
return msg.data();
}
protected:
QString m_trackId;
QString m_transformId;
};
/**
* Notify the writer that we are about to start extraction for
* input file N of M (where N is 1..M). May be useful when writing
* multiple outputs into a single file where some syntactic
* element is needed to connect them.
*/
virtual void setNofM(int /* N */, int /* M */) { }
// may throw FailedToOpenFile or other exceptions
virtual void write(QString trackid,
const Transform &transform,
const Vamp::Plugin::OutputDescriptor &output,
const Vamp::Plugin::FeatureList &features,
std::string summaryType = "") = 0;
/**
* Throw FailedToOpenOutputStream if we can already tell that we
* will be unable to write to the output file. This is called to
* test the output stream before processing begins. The writer
* may legitimately succeed here but still fail later -- this is
* really an optimisation to ensure that easy-to-recognise failure
* cases fail early.
*/
virtual void testOutputFile(QString /* trackId */, TransformId) { }
virtual void flush() { } // whatever the last stream was
virtual void finish() = 0;
virtual QString getWriterTag() const = 0;
};
} // end namespace sv
#endif
|
