a gadzillion changes all over the place. nothing is finished, but all is better than...
[ardour.git] / libs / ardour / ardour / processor.h
1 /*
2     Copyright (C) 2000 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 <sigc++/signal.h>
30
31 #include "ardour/ardour.h"
32 #include "ardour/automatable_controls.h"
33 #include "ardour/buffer_set.h"
34 #include "ardour/latent.h"
35 #include "ardour/session_object.h"
36 #include "ardour/types.h"
37
38 class XMLNode;
39
40 namespace ARDOUR {
41
42 class Session;
43 class Route;
44
45 /* A mixer strip element - plugin, send, meter, etc.
46  */
47 class Processor : public SessionObject, public AutomatableControls, public Latent
48 {
49   public:
50         static const std::string state_node_name;
51
52         Processor(Session&, const std::string& name);
53         
54         virtual ~Processor() { }
55         
56         /** Configuration of a processor on a bus
57          * (i.e. how to apply to a BufferSet)
58          */
59         struct Mapping {
60             ChanCount in;
61             ChanCount out;
62         };
63
64         virtual bool visible() const { return true; }
65         
66         bool active () const { return _active; }
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 nframes_t signal_latency() const { return 0; }
72         
73         virtual void transport_stopped (nframes_t frame) {}
74         
75         virtual void set_block_size (nframes_t nframes) {}
76
77         virtual void run_in_place (BufferSet& bufs,
78                                    sframes_t start_frame, sframes_t end_frame,
79                                    nframes_t nframes) { assert(is_in_place()); }
80         
81         virtual void run_out_of_place (BufferSet& input, BufferSet& output,
82                                        sframes_t start_frame, sframes_t end_frame,
83                                        nframes_t nframes) { assert(is_out_of_place()); }
84         
85         virtual void silence (nframes_t nframes) {}
86         
87         void activate ()   { _active = true; ActiveChanged(); }
88         void deactivate () { _active = false; ActiveChanged(); }
89         
90         virtual bool configure_io (ChanCount in, ChanCount out);
91
92         /* Derived classes should override these, or processor appears as an in-place pass-through */
93
94         /** In-place processors implement run_in_place and modify thee input buffer parameter */
95         virtual bool is_in_place () const { return true; }
96
97         /* Out-Of-Place processors implement run_out_of_place, don't modify the input parameter
98          * and write to their output parameter */
99         virtual bool is_out_of_place () const { return false; }
100
101         virtual bool can_support_io_configuration (const ChanCount& in, ChanCount& out) const = 0;
102         virtual ChanCount input_streams () const { return _configured_input; }
103         virtual ChanCount output_streams() const { return _configured_output; }
104
105         /* note: derived classes should implement state(), NOT get_state(), to allow
106            us to merge C++ inheritance and XML lack-of-inheritance reasonably
107            smoothly.
108          */
109
110         virtual XMLNode& state (bool full);
111         XMLNode& get_state (void);
112         int set_state (const XMLNode&);
113         
114         void *get_gui () const { return _gui; }
115         void  set_gui (void *p) { _gui = p; }
116
117         static sigc::signal<void,Processor*> ProcessorCreated;
118
119         sigc::signal<void>                     ActiveChanged;
120         sigc::signal<void,ChanCount,ChanCount> ConfigurationChanged;
121
122 protected:
123         int       _pending_active;
124         bool      _active;
125         bool      _next_ab_is_active;
126         bool      _configured;
127         ChanCount _configured_input;
128         ChanCount _configured_output;
129         void*     _gui;  /* generic, we don't know or care what this is */
130         Mapping   _mapping;
131 };
132
133 } // namespace ARDOUR
134
135 #endif /* __ardour_processor_h__ */