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 <ostream>
  26 #include <fstream>
  27 #include <vamp-sdk/Plugin.h>
  28 #include <boost/utility.hpp>
  29 #include "ardour/audioregion.h"
  30
  31 namespace ARDOUR {
  32
  33 class Readable;
  34 class Session;
  35
  36 class AudioAnalyser : public boost::noncopyable {
  37
  38   public:
  39         typedef Vamp::Plugin AnalysisPlugin;
  40         typedef std::string AnalysisPluginKey;
  41
  42         AudioAnalyser (float sample_rate, AnalysisPluginKey key);
  43         virtual ~AudioAnalyser();
  44
  45         /* analysis object should provide a run method
  46            that accepts a path to write the results to (optionally empty)
  47            a Readable* to read data from
  48            and a reference to a type-specific container to return the
  49            results.
  50         */
  51
  52         void reset ();
  53
  54   protected:
  55         float sample_rate;
  56         AnalysisPlugin* plugin;
  57         AnalysisPluginKey plugin_key;
  58
  59         nframes64_t bufsize;
  60         nframes64_t stepsize;
  61
  62         int initialize_plugin (AnalysisPluginKey name, float sample_rate);
  63         int analyse (const std::string& path, Readable*, uint32_t channel);
  64
  65         /* instances of an analysis object will have this method called
  66            whenever there are results to process. if out is non-null,
  67            the data should be written to the stream it points to.
  68         */
  69
  70         virtual int use_features (Vamp::Plugin::FeatureSet&, std::ostream*) = 0;
  71 };
  72
  73 } /* namespace */
  74
  75 #endif /* __ardour_audioanalyser_h__ */