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/types.h"
34 #include "ardour/automatable.h"
43 /* A mixer strip element - plugin, send, meter, etc.
45 class Processor : public SessionObject, public Automatable, public Latent
48 static const std::string state_node_name;
50 Processor(Session&, const std::string& name);
52 virtual ~Processor() { }
54 virtual std::string display_name() const { return SessionObject::name(); }
56 virtual bool display_to_user() const { return _display_to_user; }
57 virtual void set_display_to_user (bool);
59 bool active () const { return _pending_active; }
61 bool get_next_ab_is_active () const { return _next_ab_is_active; }
62 void set_next_ab_is_active (bool yn) { _next_ab_is_active = yn; }
64 virtual framecnt_t signal_latency() const { return 0; }
66 virtual int set_block_size (pframes_t /*nframes*/) { return 0; }
67 virtual bool requires_fixed_sized_buffers() const { return false; }
69 /** @param result_required true if, on return from this method, bufs is required to contain valid data;
70 * if false, the method need not bother writing to bufs if it doesn't want to.
72 virtual void run (BufferSet& /*bufs*/, framepos_t /*start_frame*/, framepos_t /*end_frame*/, pframes_t /*nframes*/, bool /*result_required*/) {}
73 virtual void silence (framecnt_t /*nframes*/) {}
75 virtual void activate () { _pending_active = true; ActiveChanged(); }
76 virtual void deactivate () { _pending_active = false; ActiveChanged(); }
77 virtual void flush() {}
79 virtual bool configure_io (ChanCount in, ChanCount out);
81 /* Derived classes should override these, or processor appears as an in-place pass-through */
83 virtual bool can_support_io_configuration (const ChanCount& in, ChanCount& out) const = 0;
84 virtual ChanCount input_streams () const { return _configured_input; }
85 virtual ChanCount output_streams() const { return _configured_output; }
87 /* note: derived classes should implement state(), NOT get_state(), to allow
88 us to merge C++ inheritance and XML lack-of-inheritance reasonably
92 virtual XMLNode& state (bool full);
93 XMLNode& get_state (void);
94 int set_state (const XMLNode&, int version);
96 void set_pre_fader (bool);
98 PBD::Signal0<void> ActiveChanged;
99 PBD::Signal2<void,ChanCount,ChanCount> ConfigurationChanged;
102 virtual int set_state_2X (const XMLNode&, int version);
106 bool _next_ab_is_active;
108 ChanCount _configured_input;
109 ChanCount _configured_output;
110 bool _display_to_user;
114 } // namespace ARDOUR
116 #endif /* __ardour_processor_h__ */