more work on the new all-Processor-all-The-Time redesign of Route - LOTS OF BREAKAGE...
[ardour.git] / libs / ardour / ardour / return.h
1 /*
2     Copyright (C) 2009 Paul Davis 
3     Author: Dave Robillard
4
5     This program is free software; you can redistribute it and/or modify
6     it under the terms of the GNU General Public License as published by
7     the Free Software Foundation; either version 2 of the License, or
8     (at your option) any later version.
9
10     This program is distributed in the hope that it will be useful,
11     but WITHOUT ANY WARRANTY; without even the implied warranty of
12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13     GNU General Public License for more details.
14
15     You should have received a copy of the GNU General Public License
16     along with this program; if not, write to the Free Software
17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18
19 */
20
21 #ifndef __ardour_return_h__
22 #define __ardour_return_h__
23
24 #include <sigc++/signal.h>
25 #include <string>
26
27
28 #include "pbd/stateful.h" 
29 #include "ardour/ardour.h"
30 #include "ardour/audioengine.h"
31 #include "ardour/io_processor.h"
32
33 namespace ARDOUR {
34
35 class Return : public IOProcessor 
36 {
37 public: 
38         Return (Session&);
39         Return (Session&, const XMLNode&);
40         virtual ~Return ();
41         
42         uint32_t bit_slot() const { return _bitslot; }
43
44         void run_in_place (BufferSet& bufs, sframes_t start_frame, sframes_t end_frame, nframes_t nframes);
45         
46         void activate() {}
47         void deactivate () {}
48
49         XMLNode& state(bool full);
50         XMLNode& get_state(void);
51         int      set_state(const XMLNode& node);
52
53         uint32_t pans_required() const { return _configured_input.n_audio(); }
54
55         bool can_support_io_configuration (const ChanCount& in, ChanCount& out) const;
56         bool configure_io (ChanCount in, ChanCount out);
57
58         static uint32_t how_many_sends();
59         static void make_unique (XMLNode &, Session &);
60
61 private:
62         /* disallow copy construction */
63         Return (const Return&);
64         
65         uint32_t  _bitslot;
66 };
67
68 } // namespace ARDOUR
69
70 #endif /* __ardour_return_h__ */
71