2 Copyright (C) 2009-2010 Paul Davis
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.
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.
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.
20 #ifndef __ardour_processor_h__
21 #define __ardour_processor_h__
27 #include "pbd/statefuldestructible.h"
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"
38 class ProcessorWindowProxy;
39 class PluginPinWindowProxy;
46 /** A mixer strip element - plugin, send, meter, etc */
47 class LIBARDOUR_API Processor : public SessionObject, public Automatable, public Latent
50 static const std::string state_node_name;
52 Processor(Session&, const std::string& name);
53 Processor (const Processor& other);
55 virtual ~Processor() { }
57 virtual std::string display_name() const { return SessionObject::name(); }
59 virtual bool display_to_user() const { return _display_to_user; }
60 virtual void set_display_to_user (bool);
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
66 virtual bool does_routing() const { return false; }
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; }
71 virtual framecnt_t signal_latency() const { return 0; }
73 virtual int set_block_size (pframes_t /*nframes*/) { return 0; }
74 virtual bool requires_fixed_sized_buffers() const { return false; }
76 /** @param result_required true if, on return from this method, @a bufs is required to contain valid data;
77 * if false, the method need not bother writing to @a bufs if it doesn't want to.
79 virtual void run (BufferSet& /*bufs*/, framepos_t /*start_frame*/, framepos_t /*end_frame*/, double speed, pframes_t /*nframes*/, bool /*result_required*/) {}
80 virtual void silence (framecnt_t /*nframes*/, framepos_t /*start_frame*/) {}
82 virtual void activate () { _pending_active = true; ActiveChanged(); }
83 virtual void deactivate () { _pending_active = false; ActiveChanged(); }
84 virtual void flush() {}
86 virtual void enable (bool yn) { if (yn) { activate (); } else { deactivate (); } }
88 virtual bool configure_io (ChanCount in, ChanCount out);
90 /* Derived classes should override these, or processor appears as an in-place pass-through */
92 virtual bool can_support_io_configuration (const ChanCount& in, ChanCount& out) = 0;
93 virtual ChanCount input_streams () const { return _configured_input; }
94 virtual ChanCount output_streams() const { return _configured_output; }
96 virtual void realtime_handle_transport_stopped () {}
97 virtual void realtime_locate () {}
99 /* most processors won't care about this, but plugins that
100 receive MIDI or similar data from an input source that
101 may suddenly go "quiet" because of monitoring changes
102 need to know about it.
104 virtual void monitoring_changed() {}
106 /* note: derived classes should implement state(), NOT get_state(), to allow
107 us to merge C++ inheritance and XML lack-of-inheritance reasonably
111 virtual XMLNode& state (bool full);
112 XMLNode& get_state (void);
113 int set_state (const XMLNode&, int version);
115 virtual void set_pre_fader (bool);
117 PBD::Signal0<void> ActiveChanged;
118 PBD::Signal0<void> BypassableChanged;
119 PBD::Signal2<void,ChanCount,ChanCount> ConfigurationChanged;
122 void* get_ui () const { return _ui_pointer; }
124 ProcessorWindowProxy * window_proxy () const { return _window_proxy; }
125 void set_window_proxy (ProcessorWindowProxy* wp) { _window_proxy = wp; }
127 PluginPinWindowProxy * pinmgr_proxy () const { return _pinmgr_proxy; }
128 void set_pingmgr_proxy (PluginPinWindowProxy* wp) { _pinmgr_proxy = wp ; }
130 void set_owner (SessionObject*);
131 SessionObject* owner() const;
134 virtual int set_state_2X (const XMLNode&, int version);
138 bool _next_ab_is_active;
140 ChanCount _configured_input;
141 ChanCount _configured_output;
142 bool _display_to_user;
143 bool _pre_fader; ///< true if this processor is currently placed before the Amp, otherwise false
145 ProcessorWindowProxy *_window_proxy;
146 PluginPinWindowProxy *_pinmgr_proxy;
147 SessionObject* _owner;
150 } // namespace ARDOUR
152 #endif /* __ardour_processor_h__ */