libs/ardour/ardour/processor.h

   1 /*
   2     Copyright (C) 2009-2010 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_processor_h__
  21 #define __ardour_processor_h__
  22
  23 #include <vector>
  24 #include <string>
  25 #include <exception>
  26
  27 #include "pbd/statefuldestructible.h"
  28
  29 #include "ardour/ardour.h"
  30 #include "ardour/buffer_set.h"
  31 #include "ardour/latent.h"
  32 #include "ardour/session_object.h"
  33 #include "ardour/libardour_visibility.h"
  34 #include "ardour/types.h"
  35 #include "ardour/automatable.h"
  36
  37 class XMLNode;
  38 class ProcessorWindowProxy;
  39 class PluginPinWindowProxy;
  40
  41 namespace ARDOUR {
  42
  43 class Session;
  44 class Route;
  45
  46 /** A mixer strip element - plugin, send, meter, etc */
  47 class LIBARDOUR_API Processor : public SessionObject, public Automatable, public Latent
  48 {
  49   public:
  50         static const std::string state_node_name;
  51
  52         Processor(Session&, const std::string& name);
  53         Processor (const Processor& other);
  54
  55         virtual ~Processor();
  56
  57         virtual std::string display_name() const { return SessionObject::name(); }
  58
  59         virtual bool display_to_user() const { return _display_to_user; }
  60         virtual void set_display_to_user (bool);
  61
  62         bool active () const { return _pending_active; } ///< ardour hard bypass
  63         virtual bool enabled () const { return _pending_active; } ///< processor enabled/bypass
  64         virtual bool bypassable () const { return true; } ///< enable is not automated or locked
  65
  66         virtual bool does_routing() const { return false; }
  67
  68         bool get_next_ab_is_active () const { return _next_ab_is_active; }
  69         void set_next_ab_is_active (bool yn) { _next_ab_is_active = yn; }
  70
  71         virtual samplecnt_t signal_latency() const { return 0; }
  72
  73         virtual void set_input_latency (samplecnt_t cnt) { _input_latency = cnt; }
  74         samplecnt_t input_latency () const               { return _input_latency; }
  75
  76         virtual void set_output_latency (samplecnt_t cnt) { _output_latency = cnt; }
  77         samplecnt_t output_latency () const               { return _output_latency; }
  78
  79         virtual int set_block_size (pframes_t /*nframes*/) { return 0; }
  80         virtual bool requires_fixed_sized_buffers() const { return false; }
  81
  82         /** @param result_required true if, on return from this method, @a bufs is required to contain valid data;
  83          *  if false, the method need not bother writing to @a bufs if it doesn't want to.
  84          */
  85         virtual void run (BufferSet& /*bufs*/, samplepos_t /*start_sample*/, samplepos_t /*end_sample*/, double speed, pframes_t /*nframes*/, bool /*result_required*/) {}
  86         virtual void silence (samplecnt_t nframes, samplepos_t start_sample) { automation_run (start_sample, nframes); }
  87
  88         virtual void activate ()   { _pending_active = true; ActiveChanged(); }
  89         virtual void deactivate () { _pending_active = false; ActiveChanged(); }
  90         virtual void flush() {}
  91
  92         virtual void enable (bool yn) { if (yn) { activate (); } else { deactivate (); } }
  93
  94         virtual bool configure_io (ChanCount in, ChanCount out);
  95
  96         /* Derived classes should override these, or processor appears as an in-place pass-through */
  97
  98         virtual bool can_support_io_configuration (const ChanCount& in, ChanCount& out) = 0;
  99         virtual ChanCount input_streams () const { return _configured_input; }
 100         virtual ChanCount output_streams() const { return _configured_output; }
 101
 102         virtual void realtime_handle_transport_stopped () {}
 103         virtual void realtime_locate () {}
 104
 105         /* most processors won't care about this, but plugins that
 106            receive MIDI or similar data from an input source that
 107            may suddenly go "quiet" because of monitoring changes
 108            need to know about it.
 109         */
 110         virtual void monitoring_changed() {}
 111
 112         /* note: derived classes should implement state(), NOT get_state(), to allow
 113            us to merge C++ inheritance and XML lack-of-inheritance reasonably
 114            smoothly.
 115          */
 116
 117         virtual XMLNode& state (bool full);
 118         XMLNode& get_state (void);
 119         int set_state (const XMLNode&, int version);
 120
 121         virtual void set_pre_fader (bool);
 122
 123         PBD::Signal0<void>                     ActiveChanged;
 124         PBD::Signal0<void>                     BypassableChanged;
 125         PBD::Signal2<void,ChanCount,ChanCount> ConfigurationChanged;
 126
 127         /* cross-thread signals.
 128          * This allows control-surfaces to show/hide a plugin GUI.
 129          */
 130         PBD::Signal0<void> ToggleUI;
 131         PBD::Signal0<void> ShowUI;
 132         PBD::Signal0<void> HideUI;
 133
 134         ProcessorWindowProxy * window_proxy () const { return _window_proxy; }
 135         void set_window_proxy (ProcessorWindowProxy* wp) { _window_proxy = wp; }
 136
 137         PluginPinWindowProxy * pinmgr_proxy () const { return _pinmgr_proxy; }
 138         void set_pingmgr_proxy (PluginPinWindowProxy* wp) { _pinmgr_proxy = wp ; }
 139
 140         virtual void set_owner (SessionObject*);
 141         SessionObject* owner() const;
 142
 143 protected:
 144         virtual int set_state_2X (const XMLNode&, int version);
 145
 146         int       _pending_active;
 147         bool      _active;
 148         bool      _next_ab_is_active;
 149         bool      _configured;
 150         ChanCount _configured_input;
 151         ChanCount _configured_output;
 152         bool      _display_to_user;
 153         bool      _pre_fader; ///< true if this processor is currently placed before the Amp, otherwise false
 154         void*     _ui_pointer;
 155         ProcessorWindowProxy *_window_proxy;
 156         PluginPinWindowProxy *_pinmgr_proxy;
 157         SessionObject* _owner;
 158         samplecnt_t _input_latency;
 159         samplecnt_t _output_latency;
 160 };
 161
 162 } // namespace ARDOUR
 163
 164 #endif /* __ardour_processor_h__ */