Give Processor::run a new parameter to say whether or not the run method must leave
[ardour.git] / libs / ardour / ardour / send.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_send_h__
21 #define __ardour_send_h__
22
23 #include <sigc++/signal.h>
24 #include <string>
25
26 #include "pbd/stateful.h"
27
28 #include "ardour/ardour.h"
29 #include "ardour/audioengine.h"
30 #include "ardour/delivery.h"
31
32 namespace ARDOUR {
33
34 class PeakMeter;
35 class Amp;
36
37 class Send : public Delivery
38 {
39   public:
40         Send (Session&, boost::shared_ptr<MuteMaster>, Delivery::Role r = Delivery::Send);
41         Send (Session&, boost::shared_ptr<MuteMaster>, const XMLNode&, int version = 3000, Delivery::Role r = Delivery::Send);
42         virtual ~Send ();
43
44         uint32_t bit_slot() const { return _bitslot; }
45
46         bool display_to_user() const;
47
48         boost::shared_ptr<Amp> amp() const { return _amp; }
49         boost::shared_ptr<PeakMeter> meter() const { return _meter; }
50
51         bool metering() const { return _metering; }
52         void set_metering (bool yn) { _metering = yn; }
53
54         XMLNode& state(bool full);
55         XMLNode& get_state(void);
56         int set_state(const XMLNode&, int version);
57
58         uint32_t pans_required() const { return _configured_input.n_audio(); }
59
60         void run (BufferSet& bufs, sframes_t start_frame, sframes_t end_frame, nframes_t nframes, bool);
61
62         bool can_support_io_configuration (const ChanCount& in, ChanCount& out) const;
63         bool configure_io (ChanCount in, ChanCount out);
64
65         void activate ();
66         void deactivate ();
67
68         bool set_name (const std::string& str);
69
70         static uint32_t how_many_sends();
71         static void make_unique (XMLNode &, Session &);
72
73   protected:
74         bool _metering;
75         boost::shared_ptr<Amp> _amp;
76         boost::shared_ptr<PeakMeter> _meter;
77
78   private:
79         /* disallow copy construction */
80         Send (const Send&);
81
82         uint32_t  _bitslot;
83 };
84
85 } // namespace ARDOUR
86
87 #endif /* __ardour_send_h__ */