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 framecnt_t signal_latency() const { return 0; }
  72
  73         virtual void set_input_latency (framecnt_t);
  74         framecnt_t input_latency () const { return _input_latency; }
  75
  76         virtual int set_block_size (pframes_t /*nframes*/) { return 0; }
  77         virtual bool requires_fixed_sized_buffers() const { return false; }
  78
  79         /** @param result_required true if, on return from this method, @a bufs is required to contain valid data;
  80          *  if false, the method need not bother writing to @a bufs if it doesn't want to.
  81          */
  82         virtual void run (BufferSet& /*bufs*/, framepos_t /*start_frame*/, framepos_t /*end_frame*/, double speed, pframes_t /*nframes*/, bool /*result_required*/) {}
  83         virtual void silence (framecnt_t nframes, framepos_t start_frame) { automation_run (start_frame, nframes); }
  84
  85         virtual void activate ()   { _pending_active = true; ActiveChanged(); }
  86         virtual void deactivate () { _pending_active = false; ActiveChanged(); }
  87         virtual void flush() {}
  88
  89         virtual void enable (bool yn) { if (yn) { activate (); } else { deactivate (); } }
  90
  91         virtual bool configure_io (ChanCount in, ChanCount out);
  92
  93         /* Derived classes should override these, or processor appears as an in-place pass-through */
  94
  95         virtual bool can_support_io_configuration (const ChanCount& in, ChanCount& out) = 0;
  96         virtual ChanCount input_streams () const { return _configured_input; }
  97         virtual ChanCount output_streams() const { return _configured_output; }
  98
  99         virtual void realtime_handle_transport_stopped () {}
 100         virtual void realtime_locate () {}
 101
 102         /* most processors won't care about this, but plugins that
 103            receive MIDI or similar data from an input source that
 104            may suddenly go "quiet" because of monitoring changes
 105            need to know about it.
 106         */
 107         virtual void monitoring_changed() {}
 108
 109         /* note: derived classes should implement state(), NOT get_state(), to allow
 110            us to merge C++ inheritance and XML lack-of-inheritance reasonably
 111            smoothly.
 112          */
 113
 114         virtual XMLNode& state (bool full);
 115         XMLNode& get_state (void);
 116         int set_state (const XMLNode&, int version);
 117
 118         virtual void set_pre_fader (bool);
 119
 120         PBD::Signal0<void>                     ActiveChanged;
 121         PBD::Signal0<void>                     BypassableChanged;
 122         PBD::Signal2<void,ChanCount,ChanCount> ConfigurationChanged;
 123
 124         /* cross-thread signals.
 125          * This allows control-surfaces to show/hide a plugin GUI.
 126          */
 127         PBD::Signal0<void> ToggleUI;
 128         PBD::Signal0<void> ShowUI;
 129         PBD::Signal0<void> HideUI;
 130
 131         ProcessorWindowProxy * window_proxy () const { return _window_proxy; }
 132         void set_window_proxy (ProcessorWindowProxy* wp) { _window_proxy = wp; }
 133
 134         PluginPinWindowProxy * pinmgr_proxy () const { return _pinmgr_proxy; }
 135         void set_pingmgr_proxy (PluginPinWindowProxy* wp) { _pinmgr_proxy = wp ; }
 136
 137         virtual void set_owner (SessionObject*);
 138         SessionObject* owner() const;
 139
 140 protected:
 141         virtual int set_state_2X (const XMLNode&, int version);
 142
 143         int       _pending_active;
 144         bool      _active;
 145         bool      _next_ab_is_active;
 146         bool      _configured;
 147         ChanCount _configured_input;
 148         ChanCount _configured_output;
 149         bool      _display_to_user;
 150         bool      _pre_fader; ///< true if this processor is currently placed before the Amp, otherwise false
 151         void*     _ui_pointer;
 152         ProcessorWindowProxy *_window_proxy;
 153         PluginPinWindowProxy *_pinmgr_proxy;
 154         SessionObject* _owner;
 155         framecnt_t _input_latency;
 156 };
 157
 158 } // namespace ARDOUR
 159
 160 #endif /* __ardour_processor_h__ */