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