don't display internal returns to user
[ardour.git] / libs / ardour / ardour / internal_return.h
1 /*
2     Copyright (C) 2009 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_internal_return_h__
21 #define __ardour_internal_return_h__
22
23
24 #include "ardour/ardour.h"
25 #include "ardour/return.h"
26 #include "ardour/buffer_set.h"
27
28 namespace ARDOUR {
29
30 class InternalReturn : public Return
31 {
32   public:
33         InternalReturn (Session&);
34
35 XMLNode& state(bool full);
36         XMLNode& get_state(void);
37         int set_state(const XMLNode&, int version);
38
39         void run (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, nframes_t nframes, bool);
40         bool configure_io (ChanCount in, ChanCount out);
41         bool can_support_io_configuration (const ChanCount& in, ChanCount& out) const;
42         int  set_block_size (nframes_t);
43
44         BufferSet* get_buffers();
45         void release_buffers();
46
47         static PBD::Signal1<void,nframes_t> CycleStart;
48
49   private:
50         BufferSet buffers;
51         gint user_count; /* atomic */
52         void allocate_buffers (nframes_t);
53         void cycle_start (nframes_t);
54 };
55
56 } // namespace ARDOUR
57
58 #endif /* __ardour_internal_return_h__ */