# HG changeset patch
# User Chris Cannam
# Date 1413207891 -3600
# Node ID e25dc8d575656f0409233b29a3f621eb225bbd52
# Parent  2104ea2204d2b8e5f19401526d8009ac8eba63ea
Add descriptions for writers; add housekeeping options to Sonic Annotator to list writers and formats

diff -r 2104ea2204d2 -r e25dc8d57565 rdf/RDFFeatureWriter.cpp
--- a/rdf/RDFFeatureWriter.cpp	Mon Oct 13 10:56:16 2014 +0100
+++ b/rdf/RDFFeatureWriter.cpp	Mon Oct 13 14:44:51 2014 +0100
@@ -47,6 +47,12 @@
 {
 }
 
+string
+RDFFeatureWriter::getDescription() const
+{
+    return "Write output in Audio Features Ontology RDF/Turtle format.";
+}
+
 RDFFeatureWriter::ParameterList
 RDFFeatureWriter::getSupportedParameters() const
 {
diff -r 2104ea2204d2 -r e25dc8d57565 rdf/RDFFeatureWriter.h
--- a/rdf/RDFFeatureWriter.h	Mon Oct 13 10:56:16 2014 +0100
+++ b/rdf/RDFFeatureWriter.h	Mon Oct 13 14:44:51 2014 +0100
@@ -44,6 +44,8 @@
     RDFFeatureWriter();
     virtual ~RDFFeatureWriter();
 
+    virtual string getDescription() const;
+
     virtual ParameterList getSupportedParameters() const;
     virtual void setParameters(map<string, string> &params);
 
diff -r 2104ea2204d2 -r e25dc8d57565 transform/CSVFeatureWriter.cpp
--- a/transform/CSVFeatureWriter.cpp	Mon Oct 13 10:56:16 2014 +0100
+++ b/transform/CSVFeatureWriter.cpp	Mon Oct 13 14:44:51 2014 +0100
@@ -41,6 +41,12 @@
 {
 }
 
+string
+CSVFeatureWriter::getDescription() const
+{
+    return "Write features in comma-separated (CSV) format. If transforms are being written to a single file or to stdout, the first column in the output will contain the input audio filename, or an empty string if the feature hails from the same audio file as its predecessor. If transforms are being written to multiple files, the audio filename column will be omitted. Subsequent columns will contain the feature timestamp, then any or all of duration, values, and label.";
+}
+
 CSVFeatureWriter::ParameterList
 CSVFeatureWriter::getSupportedParameters() const
 {
diff -r 2104ea2204d2 -r e25dc8d57565 transform/CSVFeatureWriter.h
--- a/transform/CSVFeatureWriter.h	Mon Oct 13 10:56:16 2014 +0100
+++ b/transform/CSVFeatureWriter.h	Mon Oct 13 14:44:51 2014 +0100
@@ -40,6 +40,8 @@
     CSVFeatureWriter();
     virtual ~CSVFeatureWriter();
 
+    virtual string getDescription() const;
+
     virtual ParameterList getSupportedParameters() const;
     virtual void setParameters(map<string, string> &params);
 
diff -r 2104ea2204d2 -r e25dc8d57565 transform/FeatureWriter.h
--- a/transform/FeatureWriter.h	Mon Oct 13 10:56:16 2014 +0100
+++ b/transform/FeatureWriter.h	Mon Oct 13 14:44:51 2014 +0100
@@ -39,6 +39,8 @@
 public:
     virtual ~FeatureWriter() { }
 
+    virtual string getDescription() const = 0;
+
     struct Parameter { // parameter of the writer, not the plugin
         string name;
         string description;