libs/ardour/ardour/filter.h

   1 /*
   2  * Copyright (C) 2007-2011 David Robillard <d@drobilla.net>
   3  * Copyright (C) 2007-2015 Paul Davis <paul@linuxaudiosystems.com>
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18  */
  19
  20 #ifndef __ardour_filter_h__
  21 #define __ardour_filter_h__
  22
  23 #include <vector>
  24
  25 #include "ardour/libardour_visibility.h"
  26 #include "ardour/types.h"
  27
  28 namespace ARDOUR {
  29
  30 class Region;
  31 class Session;
  32 class Progress;
  33
  34 class LIBARDOUR_API Filter {
  35
  36   public:
  37         virtual ~Filter() {}
  38
  39         virtual int run (boost::shared_ptr<ARDOUR::Region>, Progress* progress = 0) = 0;
  40         std::vector<boost::shared_ptr<ARDOUR::Region> > results;
  41
  42   protected:
  43         Filter (ARDOUR::Session& s) : session(s) {}
  44
  45         int make_new_sources (boost::shared_ptr<ARDOUR::Region>, ARDOUR::SourceList&, std::string suffix = "", bool use_session_sample_rate = true);
  46         int finish (boost::shared_ptr<ARDOUR::Region>, ARDOUR::SourceList&, std::string region_name = "");
  47
  48         ARDOUR::Session& session;
  49 };
  50
  51 } /* namespace */
  52
  53 #endif /* __ardour_filter_h__ */