Rework Port class hierarchy a bit. Hopefully now simpler, and should
[ardour.git] / libs / ardour / track.cc
1 /*
2     Copyright (C) 2006 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 #include <pbd/error.h>
19 #include <sigc++/retype.h>
20 #include <sigc++/retype_return.h>
21 #include <sigc++/bind.h>
22
23 #include <ardour/track.h>
24 #include <ardour/diskstream.h>
25 #include <ardour/session.h>
26 #include <ardour/io_processor.h>
27 #include <ardour/audioregion.h>
28 #include <ardour/audiosource.h>
29 #include <ardour/route_group_specialized.h>
30 #include <ardour/processor.h>
31 #include <ardour/audioplaylist.h>
32 #include <ardour/panner.h>
33 #include <ardour/utils.h>
34 #include <ardour/port.h>
35
36 #include "i18n.h"
37
38 using namespace std;
39 using namespace ARDOUR;
40 using namespace PBD;
41
42 Track::Track (Session& sess, string name, Route::Flag flag, TrackMode mode, DataType default_type)
43         : Route (sess, name, 1, -1, -1, -1, flag, default_type)
44         , _rec_enable_control (new RecEnableControllable(*this))
45 {
46         _declickable = true;
47         _freeze_record.state = NoFreeze;
48         _saved_meter_point = _meter_point;
49         _mode = mode;
50 }
51
52 Track::Track (Session& sess, const XMLNode& node, DataType default_type)
53         : Route (sess, node)
54         , _rec_enable_control (new RecEnableControllable(*this))
55 {
56         _freeze_record.state = NoFreeze;
57         _declickable = true;
58         _saved_meter_point = _meter_point;
59 }
60
61 Track::~Track ()
62 {
63 }
64
65 void
66 Track::set_meter_point (MeterPoint p, void *src)
67 {
68         Route::set_meter_point (p, src);
69 }
70
71 XMLNode&
72 Track::get_state ()
73 {
74         return state (true);
75 }
76
77 XMLNode&
78 Track::get_template ()
79 {
80         return state (false);
81 }
82
83 void
84 Track::toggle_monitor_input ()
85 {
86         for (PortSet::iterator i = _inputs.begin(); i != _inputs.end(); ++i) {
87                 i->ensure_monitor_input(!i->monitoring_input());
88         }
89 }
90
91 ARDOUR::nframes_t
92 Track::update_total_latency ()
93 {
94         nframes_t old = _own_latency;
95
96         if (_user_latency) {
97                 _own_latency = _user_latency;
98         } else {
99                 _own_latency = 0;
100
101                 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
102                         if ((*i)->active ()) {
103                                 _own_latency += (*i)->signal_latency ();
104                         }
105                 }
106         }
107
108 #undef DEBUG_LATENCY
109 #ifdef DEBUG_LATENCY
110         cerr << _name << ": internal redirect (final) latency = " << _own_latency << endl;
111 #endif
112
113         set_port_latency (_own_latency);
114
115         if (old != _own_latency) {
116                 signal_latency_changed (); /* EMIT SIGNAL */
117         }
118
119         return _own_latency;
120 }
121
122 Track::FreezeRecord::~FreezeRecord ()
123 {
124         for (vector<FreezeRecordProcessorInfo*>::iterator i = processor_info.begin(); i != processor_info.end(); ++i) {
125                 delete *i;
126         }
127 }
128
129 Track::FreezeState
130 Track::freeze_state() const
131 {
132         return _freeze_record.state;
133 }
134
135 Track::RecEnableControllable::RecEnableControllable (Track& s)
136         : Controllable (X_("recenable")), track (s)
137 {
138 }
139
140 void
141 Track::RecEnableControllable::set_value (float val)
142 {
143         bool bval = ((val >= 0.5f) ? true: false);
144         track.set_record_enable (bval, this);
145 }
146
147 float
148 Track::RecEnableControllable::get_value (void) const
149 {
150         if (track.record_enabled()) { return 1.0f; }
151         return 0.0f;
152 }
153
154 bool
155 Track::record_enabled () const
156 {
157         return _diskstream->record_enabled ();
158 }
159
160 bool
161 Track::can_record()
162 {
163         bool will_record = true;
164         for (PortSet::iterator i = _inputs.begin(); i != _inputs.end() && will_record; ++i) {
165                 if (!i->connected())
166                         will_record = false;
167         }
168
169         return will_record;
170 }
171         
172 void
173 Track::set_record_enable (bool yn, void *src)
174 {
175         if (_freeze_record.state == Frozen) {
176                 return;
177         }
178
179         if (_mix_group && src != _mix_group && _mix_group->is_active()) {
180                 _mix_group->apply (&Track::set_record_enable, yn, _mix_group);
181                 return;
182         }
183
184         /* keep track of the meter point as it was before we rec-enabled */
185         if (!_diskstream->record_enabled()) {
186                 _saved_meter_point = _meter_point;
187         }
188         
189         _diskstream->set_record_enabled (yn);
190
191         if (_diskstream->record_enabled()) {
192                 set_meter_point (MeterInput, this);
193         } else {
194                 set_meter_point (_saved_meter_point, this);
195         }
196
197         _rec_enable_control->Changed ();
198 }
199
200
201 bool
202 Track::set_name (const string& str)
203 {
204         bool ret;
205
206         if (record_enabled() && _session.actively_recording()) {
207                 /* this messes things up if done while recording */
208                 return false;
209         }
210
211         if (_diskstream->set_name (str)) {
212                 return false;
213         }
214
215         /* save state so that the statefile fully reflects any filename changes */
216
217         if ((ret = IO::set_name (str)) == 0) {
218                 _session.save_state ("");
219         }
220
221         return ret;
222 }
223
224 void
225 Track::set_latency_delay (nframes_t longest_session_latency)
226 {
227         Route::set_latency_delay (longest_session_latency);
228         _diskstream->set_roll_delay (_roll_delay);
229 }
230