summaryrefslogtreecommitdiff
path: root/libs/ardour/ardour/processor.h
blob: 61a266e9c5e333226fe032165f8ce7988361b332 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
/*
    Copyright (C) 2000 Paul Davis 

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/

#ifndef __ardour_processor_h__
#define __ardour_processor_h__

#include <vector>
#include <string>
#include <exception>

#include "pbd/statefuldestructible.h" 

#include <sigc++/signal.h>

#include "ardour/ardour.h"
#include "ardour/automatable_controls.h"
#include "ardour/buffer_set.h"
#include "ardour/latent.h"
#include "ardour/session_object.h"
#include "ardour/types.h"

class XMLNode;

namespace ARDOUR {

class Session;
class Route;

/* A mixer strip element - plugin, send, meter, etc.
 */
class Processor : public SessionObject, public AutomatableControls, public Latent
{
  public:
	static const std::string state_node_name;

	Processor(Session&, const std::string& name);
	
	virtual ~Processor() { }
	
	virtual bool visible() const { return true; }
	
	bool active () const { return _active; }

	/* we keep loose tabs on the "placement" of a Processor. Ultimately,
	   they are all executed as a single list, but there are some
	   semantics that require knowing whether a Processor is before
	   or after the fader, or panner etc. See Route::reorder_processors()
	   to see where this gets set.
	*/

	Placement placement() const { return _placement; }
	void set_placement (Placement p) { _placement = p; }
	
	bool get_next_ab_is_active () const { return _next_ab_is_active; }
	void set_next_ab_is_active (bool yn) { _next_ab_is_active = yn; }
	
	virtual nframes_t signal_latency() const { return 0; }
	
	virtual void transport_stopped (sframes_t frame) {}
	
	virtual void set_block_size (nframes_t nframes) {}

	virtual void run_in_place (BufferSet& bufs,
				   sframes_t start_frame, sframes_t end_frame,
				   nframes_t nframes) { assert(is_in_place()); }
	
	virtual void run_out_of_place (BufferSet& input, BufferSet& output,
				       sframes_t start_frame, sframes_t end_frame,
				       nframes_t nframes) { assert(is_out_of_place()); }
	
	virtual void silence (nframes_t nframes) {}
	
	void activate ()   { _active = true; ActiveChanged(); }
	void deactivate () { _active = false; ActiveChanged(); }
	
	virtual bool configure_io (ChanCount in, ChanCount out);

	/* Derived classes should override these, or processor appears as an in-place pass-through */

	/** In-place processors implement run_in_place and modify thee input buffer parameter */
	virtual bool is_in_place () const { return true; }

	/* Out-Of-Place processors implement run_out_of_place, don't modify the input parameter
	 * and write to their output parameter */
	virtual bool is_out_of_place () const { return false; }

	virtual bool can_support_io_configuration (const ChanCount& in, ChanCount& out) const = 0;
	virtual ChanCount input_streams () const { return _configured_input; }
	virtual ChanCount output_streams() const { return _configured_output; }

	/* note: derived classes should implement state(), NOT get_state(), to allow
	   us to merge C++ inheritance and XML lack-of-inheritance reasonably
	   smoothly.
	 */

	virtual XMLNode& state (bool full);
	XMLNode& get_state (void);
	int set_state (const XMLNode&);
	
	void *get_gui () const { return _gui; }
	void  set_gui (void *p) { _gui = p; }

	static sigc::signal<void,Processor*> ProcessorCreated;

	sigc::signal<void>                     ActiveChanged;
	sigc::signal<void,ChanCount,ChanCount> ConfigurationChanged;

protected:
	int       _pending_active;
	bool      _active;
	bool      _next_ab_is_active;
	bool      _configured;
	ChanCount _configured_input;
	ChanCount _configured_output;
	void*     _gui;  /* generic, we don't know or care what this is */
	Placement _placement;
};

} // namespace ARDOUR

#endif /* __ardour_processor_h__ */