libs/ardour/ardour/insert.h

   1 /*
   2     Copyright (C) 2000 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     $Id$
  19 */
  20
  21 #ifndef __ardour_insert_h__
  22 #define __ardour_insert_h__
  23
  24 #include <vector>
  25 #include <string>
  26 #include <exception>
  27
  28 #include <sigc++/signal.h>
  29 #include <ardour/ardour.h>
  30 #include <ardour/redirect.h>
  31 #include <ardour/plugin_state.h>
  32
  33 class XMLNode;
  34
  35 namespace MIDI {
  36         class Port;
  37 }
  38
  39 namespace ARDOUR {
  40
  41 class Session;
  42 class Plugin;
  43 class Route;
  44
  45 class Insert : public Redirect
  46 {
  47   public:
  48         Insert(Session& s, Placement p);
  49         Insert(Session& s, string name, Placement p);
  50
  51         Insert(Session& s, Placement p, int imin, int imax, int omin, int omax);
  52
  53         virtual ~Insert() { }
  54
  55         virtual void run (vector<Sample *>& bufs, uint32_t nbufs, jack_nframes_t nframes, jack_nframes_t offset) = 0;
  56         virtual void activate () {}
  57         virtual void deactivate () {}
  58
  59         virtual int32_t can_support_input_configuration (int32_t in) const = 0;
  60         virtual int32_t configure_io (int32_t magic, int32_t in, int32_t out) = 0;
  61         virtual int32_t compute_output_streams (int32_t cnt) const = 0;
  62 };
  63
  64 class PortInsert : public Insert
  65 {
  66   public:
  67         PortInsert (Session&, Placement);
  68         PortInsert (Session&, const XMLNode&);
  69         PortInsert (const PortInsert&);
  70         ~PortInsert ();
  71
  72         XMLNode& state(bool full);
  73         XMLNode& get_state(void);
  74         int set_state(const XMLNode&);
  75
  76         void init ();
  77         void run (vector<Sample *>& bufs, uint32_t nbufs, jack_nframes_t nframes, jack_nframes_t offset);
  78
  79         jack_nframes_t latency();
  80
  81         uint32_t output_streams() const;
  82         uint32_t input_streams() const;
  83
  84         int32_t can_support_input_configuration (int32_t) const;
  85         int32_t configure_io (int32_t magic, int32_t in, int32_t out);
  86         int32_t compute_output_streams (int32_t cnt) const;
  87 };
  88
  89 struct PluginInsertState : public RedirectState
  90 {
  91     PluginInsertState (std::string why)
  92             : RedirectState (why) {}
  93     ~PluginInsertState() {}
  94
  95     PluginState plugin_state;
  96 };
  97
  98 class PluginInsert : public Insert
  99 {
 100   public:
 101         PluginInsert (Session&, boost::shared_ptr<Plugin>, Placement);
 102         PluginInsert (Session&, const XMLNode&);
 103         PluginInsert (const PluginInsert&);
 104         ~PluginInsert ();
 105
 106         static const string port_automation_node_name;
 107
 108         XMLNode& state(bool);
 109         XMLNode& get_state(void);
 110         int set_state(const XMLNode&);
 111
 112         StateManager::State* state_factory (std::string why) const;
 113         Change restore_state (StateManager::State&);
 114
 115         void run (vector<Sample *>& bufs, uint32_t nbufs, jack_nframes_t nframes, jack_nframes_t offset);
 116         void silence (jack_nframes_t nframes, jack_nframes_t offset);
 117         void activate ();
 118         void deactivate ();
 119
 120         void set_block_size (jack_nframes_t nframes);
 121
 122         uint32_t output_streams() const;
 123         uint32_t input_streams() const;
 124         uint32_t natural_output_streams() const;
 125         uint32_t natural_input_streams() const;
 126
 127         int      set_count (uint32_t num);
 128         uint32_t get_count () const { return _plugins.size(); }
 129
 130         int32_t can_support_input_configuration (int32_t) const;
 131         int32_t configure_io (int32_t magic, int32_t in, int32_t out);
 132         int32_t compute_output_streams (int32_t cnt) const;
 133
 134         bool is_generator() const;
 135
 136         void set_parameter (uint32_t port, float val);
 137
 138         AutoState get_port_automation_state (uint32_t port);
 139         void set_port_automation_state (uint32_t port, AutoState);
 140         void protect_automation ();
 141
 142         float default_parameter_value (uint32_t which);
 143
 144         boost::shared_ptr<Plugin> plugin(uint32_t num=0) const {
 145                 if (num < _plugins.size()) {
 146                         return _plugins[num];
 147                 } else {
 148                         return _plugins[0]; // we always have one
 149                 }
 150         }
 151
 152         string describe_parameter (uint32_t);
 153
 154         jack_nframes_t latency();
 155
 156         void transport_stopped (jack_nframes_t now);
 157         void automation_snapshot (jack_nframes_t now);
 158
 159   protected:
 160         void store_state (PluginInsertState&) const;
 161
 162   private:
 163
 164         void parameter_changed (uint32_t, float);
 165
 166         vector<boost::shared_ptr<Plugin> > _plugins;
 167         void automation_run (vector<Sample *>& bufs, uint32_t nbufs, jack_nframes_t nframes, jack_nframes_t offset);
 168         void connect_and_run (vector<Sample *>& bufs, uint32_t nbufs, jack_nframes_t nframes, jack_nframes_t offset, bool with_auto, jack_nframes_t now = 0);
 169
 170         void init ();
 171         void set_automatable ();
 172         void auto_state_changed (uint32_t which);
 173         void automation_list_creation_callback (uint32_t, AutomationList&);
 174
 175         boost::shared_ptr<Plugin> plugin_factory (boost::shared_ptr<Plugin>);
 176 };
 177
 178 } // namespace ARDOUR
 179
 180 #endif /* __ardour_insert_h__ */