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;
45 /** A mixer strip element - plugin, send, meter, etc */
46 class LIBARDOUR_API Processor : public SessionObject, public Automatable, public Latent
49 static const std::string state_node_name;
51 Processor(Session&, const std::string& name);
52 Processor (const Processor& other);
54 virtual ~Processor() { }
56 virtual std::string display_name() const { return SessionObject::name(); }
58 virtual bool display_to_user() const { return _display_to_user; }
59 virtual void set_display_to_user (bool);
61 bool active () const { return _pending_active; }
63 virtual bool does_routing() const { return false; }
65 bool get_next_ab_is_active () const { return _next_ab_is_active; }
66 void set_next_ab_is_active (bool yn) { _next_ab_is_active = yn; }
68 virtual framecnt_t signal_latency() const { return 0; }
70 virtual int set_block_size (pframes_t /*nframes*/) { return 0; }
71 virtual bool requires_fixed_sized_buffers() const { return false; }
73 /** @param result_required true if, on return from this method, @a bufs is required to contain valid data;
74 * if false, the method need not bother writing to @a bufs if it doesn't want to.
76 virtual void run (BufferSet& /*bufs*/, framepos_t /*start_frame*/, framepos_t /*end_frame*/, pframes_t /*nframes*/, bool /*result_required*/) {}
77 virtual void silence (framecnt_t /*nframes*/) {}
79 virtual void activate () { _pending_active = true; ActiveChanged(); }
80 virtual void deactivate () { _pending_active = false; ActiveChanged(); }
81 virtual void flush() {}
83 virtual bool configure_io (ChanCount in, ChanCount out);
85 /* Derived classes should override these, or processor appears as an in-place pass-through */
87 virtual bool can_support_io_configuration (const ChanCount& in, ChanCount& out) = 0;
88 virtual ChanCount input_streams () const { return _configured_input; }
89 virtual ChanCount output_streams() const { return _configured_output; }
91 virtual void realtime_handle_transport_stopped () {}
92 virtual void realtime_locate () {}
94 /* most processors won't care about this, but plugins that
95 receive MIDI or similar data from an input source that
96 may suddenly go "quiet" because of monitoring changes
97 need to know about it.
99 virtual void monitoring_changed() {}
101 /* note: derived classes should implement state(), NOT get_state(), to allow
102 us to merge C++ inheritance and XML lack-of-inheritance reasonably
106 virtual XMLNode& state (bool full);
107 XMLNode& get_state (void);
108 int set_state (const XMLNode&, int version);
110 void set_pre_fader (bool);
112 PBD::Signal0<void> ActiveChanged;
113 PBD::Signal2<void,ChanCount,ChanCount> ConfigurationChanged;
116 void* get_ui () const { return _ui_pointer; }
118 ProcessorWindowProxy * window_proxy () const { return _window_proxy; }
119 void set_window_proxy (ProcessorWindowProxy* wp);
121 void set_owner (SessionObject*);
122 SessionObject* owner() const;
125 virtual int set_state_2X (const XMLNode&, int version);
129 bool _next_ab_is_active;
131 ChanCount _configured_input;
132 ChanCount _configured_output;
133 bool _display_to_user;
134 bool _pre_fader; ///< true if this processor is currently placed before the Amp, otherwise false
136 ProcessorWindowProxy *_window_proxy;
137 SessionObject* _owner;
140 } // namespace ARDOUR
142 #endif /* __ardour_processor_h__ */