annotate plugins/Silence.h @ 20:8c939fff7ee1

* First bit of Vamp v2 work -- add an optional duration to features in
  a backward compatible way.

  Warning: this code is unstable and experimental and may change
  significantly in the coming weeks.

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

/*
    Vamp feature extraction plugins using Paul Brossier's Aubio library.

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

#include <vamp-sdk/Plugin.h>
#include <aubio/aubio.h>

class Silence : public Vamp::Plugin
{
public:
    Silence(float inputSampleRate, unsigned int apiVersion);
    virtual ~Silence();

    bool initialise(size_t channels, size_t stepSize, size_t blockSize);
    void reset();

    InputDomain getInputDomain() const { return TimeDomain; }

    std::string getIdentifier() const;
    std::string getName() const;
    std::string getDescription() const;
    std::string getMaker() const;
    int getPluginVersion() const;
    std::string getCopyright() const;

    ParameterList getParameterDescriptors() const;
    float getParameter(std::string) const;
    void setParameter(std::string, float);

    size_t getPreferredStepSize() const;
    size_t getPreferredBlockSize() const;

    OutputList getOutputDescriptors() const;

    FeatureSet process(const float *const *inputBuffers,
                       Vamp::RealTime timestamp);

    FeatureSet getRemainingFeatures();

protected:
    unsigned int m_apiVersion;
    fvec_t *m_ibuf;
    fvec_t *m_pbuf;
    smpl_t **m_tmpptrs;
    float m_threshold;
    size_t m_stepSize;
    size_t m_blockSize;
    size_t m_channelCount;
    bool m_prevSilent;
    bool m_first;
    Vamp::RealTime m_lastChange;
    Vamp::RealTime m_lastTimestamp;
};


#endif