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