dce8fd31d5bc5f166ef143cc877eab07e829e196
[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 <string>
24
25 #include "pbd/stateful.h"
26
27 #include "ardour/ardour.h"
28 #include "ardour/delivery.h"
29
30 namespace ARDOUR {
31
32 class PeakMeter;
33 class Amp;
34
35 class Send : public Delivery
36 {
37   public:
38         Send (Session&, boost::shared_ptr<Pannable> pannable, boost::shared_ptr<MuteMaster>, Delivery::Role r = Delivery::Send);
39         Send (Session&, const std::string& name, uint32_t bitslot, boost::shared_ptr<Pannable> pannable, boost::shared_ptr<MuteMaster>, Delivery::Role r = Delivery::Send);
40         virtual ~Send ();
41
42         uint32_t bit_slot() const { return _bitslot; }
43
44         bool display_to_user() const;
45
46         boost::shared_ptr<Amp> amp() const { return _amp; }
47         boost::shared_ptr<PeakMeter> meter() const { return _meter; }
48
49         bool metering() const { return _metering; }
50         void set_metering (bool yn) { _metering = yn; }
51
52         XMLNode& state (bool full);
53         XMLNode& get_state ();
54         int set_state(const XMLNode&, int version);
55
56         uint32_t pans_required() const { return _configured_input.n_audio(); }
57
58         void run (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, bool);
59
60         bool can_support_io_configuration (const ChanCount& in, ChanCount& out) const;
61         bool configure_io (ChanCount in, ChanCount out);
62
63         void activate ();
64         void deactivate ();
65
66         bool set_name (const std::string& str);
67
68         std::string value_as_string (boost::shared_ptr<AutomationControl>) const;
69         
70         static uint32_t how_many_sends();
71         static void make_unique (XMLNode &);
72         static std::string name_and_id_new_send (Session&, Delivery::Role r, uint32_t&);
73
74   protected:
75         bool _metering;
76         boost::shared_ptr<Amp> _amp;
77         boost::shared_ptr<PeakMeter> _meter;
78
79   private:
80         /* disallow copy construction */
81         Send (const Send&);
82
83         int set_state_2X (XMLNode const &, int);
84
85         uint32_t  _bitslot;
86 };
87
88 } // namespace ARDOUR
89
90 #endif /* __ardour_send_h__ */