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