annotate plugin/transform/FeatureExtractionPluginTransformer.h @ 328:21bd032ae791

* Introduce new Transform class which contains data necessary to describe the
  context for a plugin -- the plugin's name and output, the step/block size
  etc (formerly spread across ExecutionContext and TransformFactory).  Other
  code hasn't been updated to use this yet.
* Rename existing Transform stuff to Transformers (because they run Transforms)

I'm still not 100% sure about this change, don't rely on it.

/* -*- 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.
    Centre for Digital Music, Queen Mary, University of London.
    This file copyright 2006 Chris Cannam and 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 _FEATURE_EXTRACTION_PLUGIN_TRANSFORMER_H_
#define _FEATURE_EXTRACTION_PLUGIN_TRANSFORMER_H_

#include "PluginTransformer.h"

class DenseTimeValueModel;

class FeatureExtractionPluginTransformer : public PluginTransformer
{
    Q_OBJECT

public:
    FeatureExtractionPluginTransformer(Model *inputModel,
                                       QString plugin,
                                       const ExecutionContext &context,
                                       QString configurationXml = "",
                                       QString outputName = "");
    virtual ~FeatureExtractionPluginTransformer();

protected:
    virtual void run();

    Vamp::Plugin *m_plugin;
    Vamp::Plugin::OutputDescriptor *m_descriptor;
    int m_outputFeatureNo;

    void addFeature(size_t blockFrame,
		    const Vamp::Plugin::Feature &feature);

    void setCompletion(int);

    void getFrames(int channel, int channelCount,
                   long startFrame, long size, float *buffer);

    // just casts
    DenseTimeValueModel *getInput();
    template <typename ModelClass> ModelClass *getOutput() {
	ModelClass *mc = dynamic_cast<ModelClass *>(m_output);
	if (!mc) {
	    std::cerr << "FeatureExtractionPluginTransformer::getOutput: Output model not conformable" << std::endl;
	}
	return mc;
    }
};

#endif