annotate runner/JAMSFeatureWriter.h @ 316:3cd337892a16

Update before install; seems to be necessary (based on other projects) to avoid recent Ruby-related error

/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */

/*
    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-2014 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 JAMS_FEATURE_WRITER_H
#define JAMS_FEATURE_WRITER_H

#include "transform/FileFeatureWriter.h"

#include "rdf/PluginRDFDescription.h"

class JAMSFileWriter;

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

    string getDescription() const;

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

    virtual void setTrackMetadata(QString trackid, TrackMetadata metadata);

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

    virtual void finish();

    virtual QString getWriterTag() const { return "jams"; }

private:
    enum Task {
	UnknownTask,
	BeatTask,
	OnsetTask,
	ChordTask,
	SegmentTask,
	KeyTask,
	NoteTask,
	MelodyTask,
	PitchTask,
    };

    typedef map<QString, PluginRDFDescription> RDFDescriptionMap; // by plugin id
    RDFDescriptionMap m_rdfDescriptions;

    typedef QString TrackId;
    typedef pair<TrackId, Transform> DataId;

    typedef map<TrackId, TrackMetadata> TrackMetadataMap;
    TrackMetadataMap m_trackMetadata;

    typedef set<TrackId> TrackIds;
    typedef map<QTextStream *, TrackIds> StreamTrackMap;
    StreamTrackMap m_streamTracks;

    typedef set<Task> Tasks;
    typedef map<QTextStream *, Tasks> StreamTaskMap;
    StreamTaskMap m_streamTasks;

    typedef set<DataId> DataIds;
    typedef map<QTextStream *, DataIds> StreamDataMap;
    StreamDataMap m_streamData;

    typedef map<DataId, QString> DataMap;
    DataMap m_data;

    typedef map<TransformId, Task> TaskMap;
    TaskMap m_tasks;

    void loadRDFDescription(const Transform &);
    void identifyTask(const Transform &);

    QString getTaskKey(Task);

    QString writeTransformToObjectContents(const Transform &);

    std::string m_format;
    bool m_network;
    bool m_networkRetrieved;
    int m_n;
    int m_m;
    int m_digits;
};

#endif