libs/ardour/ardour/audioanalyser.h

   1 /*
   2     Copyright (C) 2008 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef __ardour_audioanalyser_h__
  21 #define __ardour_audioanalyser_h__
  22
  23 #include <vector>
  24 #include <string>
  25 #include <boost/utility.hpp>
  26 #include "vamp-sdk/Plugin.h"
  27 #include "ardour/libardour_visibility.h"
  28 #include "ardour/types.h"
  29
  30 namespace ARDOUR {
  31
  32 class Readable;
  33 class Session;
  34
  35 class LIBARDOUR_API AudioAnalyser : public boost::noncopyable {
  36
  37   public:
  38         typedef Vamp::Plugin AnalysisPlugin;
  39         typedef std::string AnalysisPluginKey;
  40
  41         AudioAnalyser (float sample_rate, AnalysisPluginKey key);
  42         virtual ~AudioAnalyser();
  43
  44         /* analysis object should provide a run method
  45            that accepts a path to write the results to (optionally empty)
  46            a Readable* to read data from
  47            and a reference to a type-specific container to return the
  48            results.
  49         */
  50
  51         void reset ();
  52
  53   protected:
  54         float sample_rate;
  55         AnalysisPlugin* plugin;
  56         AnalysisPluginKey plugin_key;
  57
  58         framecnt_t bufsize;
  59         framecnt_t stepsize;
  60
  61         int initialize_plugin (AnalysisPluginKey name, float sample_rate);
  62         int analyse (const std::string& path, Readable*, uint32_t channel);
  63
  64         /* instances of an analysis object will have this method called
  65            whenever there are results to process. if out is non-null,
  66            the data should be written to the stream it points to.
  67         */
  68
  69         virtual int use_features (Vamp::Plugin::FeatureSet&, std::ostream*) = 0;
  70 };
  71
  72 } /* namespace */
  73
  74 #endif /* __ardour_audioanalyser_h__ */