libs/ardour/ardour/plugin_insert.h

   1 /*
   2     Copyright (C) 2000,2007 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_plugin_insert_h__
  21 #define __ardour_plugin_insert_h__
  22
  23 #include <vector>
  24 #include <string>
  25
  26 #include <sigc++/signal.h>
  27 #include <ardour/ardour.h>
  28 #include <ardour/plugin_state.h>
  29 #include <ardour/types.h>
  30 #include <ardour/processor.h>
  31 #include <ardour/automation_event.h>
  32
  33 class XMLNode;
  34
  35 namespace ARDOUR {
  36
  37 class Session;
  38 class Route;
  39 class Plugin;
  40
  41 /** Plugin inserts: send data through a plugin
  42  */
  43 class PluginInsert : public Processor
  44 {
  45   public:
  46         PluginInsert (Session&, boost::shared_ptr<Plugin>, Placement);
  47         PluginInsert (Session&, const XMLNode&);
  48         PluginInsert (const PluginInsert&);
  49         ~PluginInsert ();
  50
  51         static const string port_automation_node_name;
  52
  53         XMLNode& state(bool);
  54         XMLNode& get_state(void);
  55         int set_state(const XMLNode&);
  56
  57         void run (BufferSet& bufs, nframes_t start_frame, nframes_t end_frame, nframes_t nframes, nframes_t offset);
  58         void silence (nframes_t nframes, nframes_t offset);
  59
  60         void activate ();
  61         void deactivate ();
  62
  63         void set_block_size (nframes_t nframes);
  64
  65         ChanCount output_streams() const;
  66         ChanCount input_streams() const;
  67         ChanCount natural_output_streams() const;
  68         ChanCount natural_input_streams() const;
  69
  70         bool     set_count (uint32_t num);
  71         uint32_t get_count () const { return _plugins.size(); }
  72
  73         virtual bool      can_support_input_configuration (ChanCount in) const;
  74         virtual ChanCount output_for_input_configuration (ChanCount in) const;
  75         virtual bool      configure_io (ChanCount in, ChanCount out);
  76
  77         bool is_generator() const;
  78
  79         void set_parameter (ParamID param, float val);
  80
  81         float default_parameter_value (ParamID param);
  82
  83         boost::shared_ptr<Plugin> plugin(uint32_t num=0) const {
  84                 if (num < _plugins.size()) {
  85                         return _plugins[num];
  86                 } else {
  87                         return _plugins[0]; // we always have one
  88                 }
  89         }
  90
  91         PluginType type ();
  92
  93         string describe_parameter (ParamID param);
  94
  95         nframes_t latency();
  96
  97         void transport_stopped (nframes_t now);
  98         void automation_snapshot (nframes_t now);
  99
 100   private:
 101
 102         void parameter_changed (ParamID, float);
 103
 104         std::vector<boost::shared_ptr<Plugin> > _plugins;
 105
 106         void automation_run (BufferSet& bufs, nframes_t nframes, nframes_t offset);
 107         void connect_and_run (BufferSet& bufs, nframes_t nframes, nframes_t offset, bool with_auto, nframes_t now = 0);
 108
 109         void init ();
 110         void set_automatable ();
 111         void auto_state_changed (ParamID which);
 112         void automation_list_creation_callback (ParamID, AutomationList&);
 113
 114         int32_t count_for_configuration (ChanCount in, ChanCount out) const;
 115
 116         boost::shared_ptr<Plugin> plugin_factory (boost::shared_ptr<Plugin>);
 117 };
 118
 119 } // namespace ARDOUR
 120
 121 #endif /* __ardour_plugin_insert_h__ */