2 Copyright (C) 2006 Paul Davis
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.
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.
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.
18 #include "pbd/error.h"
20 #include "ardour/amp.h"
21 #include "ardour/debug.h"
22 #include "ardour/delivery.h"
23 #include "ardour/diskstream.h"
24 #include "ardour/io_processor.h"
25 #include "ardour/meter.h"
26 #include "ardour/playlist.h"
27 #include "ardour/port.h"
28 #include "ardour/processor.h"
29 #include "ardour/route_group_specialized.h"
30 #include "ardour/session.h"
31 #include "ardour/track.h"
32 #include "ardour/utils.h"
37 using namespace ARDOUR;
40 Track::Track (Session& sess, string name, Route::Flag flag, TrackMode mode, DataType default_type)
41 : Route (sess, name, flag, default_type)
42 , _saved_meter_point (_meter_point)
44 , _monitoring (MonitorAuto)
46 _freeze_record.state = NoFreeze;
49 Config->ParameterChanged.connect_same_thread (*this, boost::bind (&Track::parameter_changed, this, _1));
54 DEBUG_TRACE (DEBUG::Destruction, string_compose ("track %1 destructor\n", _name));
64 boost::shared_ptr<Route> rp (shared_from_this());
65 boost::shared_ptr<Track> rt = boost::dynamic_pointer_cast<Track> (rp);
66 _rec_enable_control = boost::shared_ptr<RecEnableControl> (new RecEnableControl(rt));
67 _rec_enable_control->set_flags (Controllable::Toggle);
69 /* don't add rec_enable_control to controls because we don't want it to
70 * appear as an automatable parameter
77 Track::use_new_diskstream ()
79 boost::shared_ptr<Diskstream> ds = create_diskstream ();
81 ds->do_refill_with_alloc ();
82 ds->set_block_size (_session.get_block_size ());
83 ds->playlist()->set_orig_track_id (id());
95 Track::state (bool full)
97 XMLNode& root (Route::state (full));
98 root.add_property (X_("monitoring"), enum_2_string (_monitoring));
99 root.add_property (X_("saved-meter-point"), enum_2_string (_saved_meter_point));
100 root.add_child_nocopy (_rec_enable_control->get_state());
101 root.add_child_nocopy (_diskstream->get_state ());
103 if (!_deactivated_processors.empty ()) {
104 XMLNode* node = new XMLNode (X_("DeactivatedProcessors"));
105 for (list<boost::weak_ptr<Processor> >::iterator i = _deactivated_processors.begin(); i != _deactivated_processors.end(); ++i) {
106 boost::shared_ptr<Processor> p = i->lock ();
108 XMLNode* c = new XMLNode (X_("Processor"));
109 c->add_property (X_("id"), p->id().to_s());
110 node->add_child_nocopy (*c);
113 root.add_child_nocopy (*node);
120 Track::set_state (const XMLNode& node, int version)
124 /* Create the diskstream before calling Route::set_state, as MidiTrack
125 needs it if the track is muted (it ends up calling MidiTrack::get_channel_mask)
128 if (version >= 3000) {
129 if ((child = find_named_node (node, X_("Diskstream"))) != 0) {
130 boost::shared_ptr<Diskstream> ds = diskstream_factory (*child);
131 ds->do_refill_with_alloc ();
136 if (Route::set_state (node, version)) {
141 _diskstream->playlist()->set_orig_track_id (id());
144 /* set rec-enable control *AFTER* setting up diskstream, because it may
145 want to operate on the diskstream as it sets its own state
148 XMLNodeList nlist = node.children();
149 for (XMLNodeConstIterator niter = nlist.begin(); niter != nlist.end(); ++niter) {
153 if (child->name() == Controllable::xml_node_name && (prop = child->property ("name")) != 0) {
154 if (prop->value() == X_("recenable")) {
155 _rec_enable_control->set_state (*child, version);
159 if (child->name() == X_("DeactivatedProcessors")) {
160 XMLNodeList dp = child->children ();
161 for (XMLNodeConstIterator i = dp.begin(); i != dp.end(); ++i) {
162 assert ((*i)->name() == X_("Processor"));
163 XMLProperty* prop = (*i)->property (X_("id"));
164 boost::shared_ptr<Processor> p = processor_by_id (PBD::ID (prop->value ()));
166 _deactivated_processors.push_back (p);
172 const XMLProperty* prop;
174 if ((prop = node.property (X_("monitoring"))) != 0) {
175 _monitoring = MonitorChoice (string_2_enum (prop->value(), _monitoring));
177 _monitoring = MonitorAuto;
180 if ((prop = node.property (X_("saved-meter-point"))) != 0) {
181 _saved_meter_point = MeterPoint (string_2_enum (prop->value(), _saved_meter_point));
183 _saved_meter_point = _meter_point;
190 Track::get_template ()
192 return state (false);
195 Track::FreezeRecord::~FreezeRecord ()
197 for (vector<FreezeRecordProcessorInfo*>::iterator i = processor_info.begin(); i != processor_info.end(); ++i) {
203 Track::freeze_state() const
205 return _freeze_record.state;
208 Track::RecEnableControl::RecEnableControl (boost::shared_ptr<Track> t)
209 : AutomationControl (t->session(), RecEnableAutomation, boost::shared_ptr<AutomationList>(), X_("recenable"))
212 boost::shared_ptr<AutomationList> gl(new AutomationList(Evoral::Parameter(RecEnableAutomation)));
217 Track::RecEnableControl::set_value (double val)
219 boost::shared_ptr<Track> t = track.lock ();
224 t->set_record_enabled (val >= 0.5 ? true : false, this);
228 Track::RecEnableControl::get_value () const
230 boost::shared_ptr<Track> t = track.lock ();
235 return (t->record_enabled() ? 1.0 : 0.0);
239 Track::record_enabled () const
241 return _diskstream && _diskstream->record_enabled ();
247 bool will_record = true;
248 for (PortSet::iterator i = _input->ports().begin(); i != _input->ports().end() && will_record; ++i) {
256 /* Turn off visible processors (except Fader), keeping track of the old states */
258 Track::deactivate_visible_processors ()
260 _deactivated_processors.clear ();
261 Glib::RWLock::ReaderLock lm (_processor_lock);
263 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
264 if ((*i)->active() && (*i)->display_to_user() && boost::dynamic_pointer_cast<Amp> (*i) == 0) {
266 _deactivated_processors.push_back (*i);
271 /* Turn deactivated processors back on again */
273 Track::activate_deactivated_processors ()
275 for (list<boost::weak_ptr<Processor> >::iterator i = _deactivated_processors.begin(); i != _deactivated_processors.end(); ++i) {
276 boost::shared_ptr<Processor> p = i->lock ();
284 Track::set_record_enabled (bool yn, void *src)
286 if (!_session.writable()) {
290 if (_freeze_record.state == Frozen) {
294 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_recenable()) {
295 _route_group->apply (&Track::set_record_enabled, yn, _route_group);
299 /* keep track of the meter point as it was before we rec-enabled */
300 if (!_diskstream->record_enabled()) {
301 _saved_meter_point = _meter_point;
304 if (Config->get_do_not_record_plugins ()) {
306 deactivate_visible_processors ();
308 activate_deactivated_processors ();
312 _diskstream->set_record_enabled (yn);
314 if (_diskstream->record_enabled()) {
315 if (_meter_point != MeterCustom) {
316 set_meter_point (MeterInput);
319 set_meter_point (_saved_meter_point);
322 _rec_enable_control->Changed ();
327 Track::set_name (const string& str)
331 if (record_enabled() && _session.actively_recording()) {
332 /* this messes things up if done while recording */
336 if (_diskstream->playlist()->all_regions_empty ()) {
337 /* Only rename the diskstream (and therefore the playlist) if
338 the playlist has never had a region added to it. Otherwise
339 people can get confused if, say, they have notes about a
340 playlist with a given name and then it changes (see mantis
343 _diskstream->set_name (str);
346 /* save state so that the statefile fully reflects any filename changes */
348 if ((ret = Route::set_name (str)) == 0) {
349 _session.save_state ("");
356 Track::set_latency_compensation (framecnt_t longest_session_latency)
358 Route::set_latency_compensation (longest_session_latency);
359 _diskstream->set_roll_delay (_roll_delay);
363 Track::no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, bool session_state_changing)
365 Glib::RWLock::ReaderLock lm (_processor_lock, Glib::TRY_LOCK);
370 bool can_record = _session.actively_recording ();
372 if (n_outputs().n_total() == 0) {
381 if (session_state_changing) {
382 if (_session.transport_speed() != 0.0f) {
383 /* we're rolling but some state is changing (e.g. our diskstream contents)
384 so we cannot use them. Be silent till this is over. Don't declick.
386 XXX note the absurdity of ::no_roll() being called when we ARE rolling!
388 passthru_silence (start_frame, end_frame, nframes, 0);
391 /* we're really not rolling, so we're either delivery silence or actually
392 monitoring, both of which are safe to do while session_state_changing is true.
396 _diskstream->check_record_status (start_frame, can_record);
400 if (_have_internal_generator) {
401 /* since the instrument has no input streams,
402 there is no reason to send any signal
407 MonitorState const s = monitoring_state ();
408 /* we are not rolling, so be silent even if we are monitoring disk, as there
409 will be no disk data coming in.
411 be_silent = (s == MonitoringSilence || s == MonitoringDisk);
414 if (!_have_internal_generator && metering_state() == MeteringInput) {
415 _input->process_input (_meter, start_frame, end_frame, nframes);
418 _amp->apply_gain_automation(false);
420 /* if have_internal_generator, or .. */
421 //_input->process_input (_meter, start_frame, end_frame, nframes);
425 passthru_silence (start_frame, end_frame, nframes, 0);
429 /* we're sending signal, but we may still want to meter the input.
432 passthru (start_frame, end_frame, nframes, false);
435 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
436 boost::shared_ptr<Delivery> d = boost::dynamic_pointer_cast<Delivery> (*i);
438 d->flush_buffers (nframes);
446 Track::silent_roll (pframes_t nframes, framepos_t /*start_frame*/, framepos_t /*end_frame*/, bool& need_butler)
448 Glib::RWLock::ReaderLock lm (_processor_lock, Glib::TRY_LOCK);
453 if (n_outputs().n_total() == 0 && _processors.empty()) {
463 _amp->apply_gain_automation(false);
467 framecnt_t playback_distance;
468 int const dret = _diskstream->process (_session.transport_frame(), nframes, playback_distance);
469 need_butler = _diskstream->commit (playback_distance);
474 Track::set_diskstream (boost::shared_ptr<Diskstream> ds)
478 ds->PlaylistChanged.connect_same_thread (*this, boost::bind (&Track::diskstream_playlist_changed, this));
479 diskstream_playlist_changed ();
480 ds->RecordEnableChanged.connect_same_thread (*this, boost::bind (&Track::diskstream_record_enable_changed, this));
481 ds->SpeedChanged.connect_same_thread (*this, boost::bind (&Track::diskstream_speed_changed, this));
482 ds->AlignmentStyleChanged.connect_same_thread (*this, boost::bind (&Track::diskstream_alignment_style_changed, this));
486 Track::diskstream_playlist_changed ()
488 PlaylistChanged (); /* EMIT SIGNAL */
492 Track::diskstream_record_enable_changed ()
494 RecordEnableChanged (); /* EMIT SIGNAL */
498 Track::diskstream_speed_changed ()
500 SpeedChanged (); /* EMIT SIGNAL */
504 Track::diskstream_alignment_style_changed ()
506 AlignmentStyleChanged (); /* EMIT SIGNAL */
509 boost::shared_ptr<Playlist>
512 return _diskstream->playlist ();
516 Track::request_jack_monitors_input (bool m)
518 _diskstream->request_jack_monitors_input (m);
522 Track::ensure_jack_monitors_input (bool m)
524 _diskstream->ensure_jack_monitors_input (m);
528 Track::destructive () const
530 return _diskstream->destructive ();
533 list<boost::shared_ptr<Source> > &
534 Track::last_capture_sources ()
536 return _diskstream->last_capture_sources ();
540 Track::set_capture_offset ()
542 _diskstream->set_capture_offset ();
545 list<boost::shared_ptr<Source> >
546 Track::steal_write_sources()
548 return _diskstream->steal_write_sources ();
552 Track::reset_write_sources (bool r, bool force)
554 _diskstream->reset_write_sources (r, force);
558 Track::playback_buffer_load () const
560 return _diskstream->playback_buffer_load ();
564 Track::capture_buffer_load () const
566 return _diskstream->capture_buffer_load ();
572 return _diskstream->do_refill ();
576 Track::do_flush (RunContext c, bool force)
578 return _diskstream->do_flush (c, force);
582 Track::set_pending_overwrite (bool o)
584 _diskstream->set_pending_overwrite (o);
588 Track::seek (framepos_t p, bool complete_refill)
590 return _diskstream->seek (p, complete_refill);
594 Track::hidden () const
596 return _diskstream->hidden ();
600 Track::can_internal_playback_seek (framecnt_t p)
602 return _diskstream->can_internal_playback_seek (p);
606 Track::internal_playback_seek (framecnt_t p)
608 return _diskstream->internal_playback_seek (p);
612 Track::non_realtime_input_change ()
614 _diskstream->non_realtime_input_change ();
618 Track::non_realtime_locate (framepos_t p)
620 _diskstream->non_realtime_locate (p);
624 Track::non_realtime_set_speed ()
626 _diskstream->non_realtime_set_speed ();
630 Track::overwrite_existing_buffers ()
632 return _diskstream->overwrite_existing_buffers ();
636 Track::get_captured_frames (uint32_t n) const
638 return _diskstream->get_captured_frames (n);
642 Track::set_loop (Location* l)
644 return _diskstream->set_loop (l);
648 Track::transport_looped (framepos_t p)
650 _diskstream->transport_looped (p);
654 Track::realtime_set_speed (double s, bool g)
656 return _diskstream->realtime_set_speed (s, g);
660 Track::transport_stopped_wallclock (struct tm & n, time_t t, bool g)
662 _diskstream->transport_stopped_wallclock (n, t, g);
666 Track::pending_overwrite () const
668 return _diskstream->pending_overwrite ();
672 Track::speed () const
674 return _diskstream->speed ();
678 Track::prepare_to_stop (framepos_t p)
680 _diskstream->prepare_to_stop (p);
684 Track::set_slaved (bool s)
686 _diskstream->set_slaved (s);
692 return _diskstream->n_channels ();
696 Track::get_capture_start_frame (uint32_t n) const
698 return _diskstream->get_capture_start_frame (n);
702 Track::alignment_style () const
704 return _diskstream->alignment_style ();
708 Track::alignment_choice () const
710 return _diskstream->alignment_choice ();
714 Track::current_capture_start () const
716 return _diskstream->current_capture_start ();
720 Track::current_capture_end () const
722 return _diskstream->current_capture_end ();
726 Track::playlist_modified ()
728 _diskstream->playlist_modified ();
732 Track::use_playlist (boost::shared_ptr<Playlist> p)
734 int ret = _diskstream->use_playlist (p);
736 p->set_orig_track_id (id());
742 Track::use_copy_playlist ()
744 int ret = _diskstream->use_copy_playlist ();
747 _diskstream->playlist()->set_orig_track_id (id());
754 Track::use_new_playlist ()
756 int ret = _diskstream->use_new_playlist ();
759 _diskstream->playlist()->set_orig_track_id (id());
766 Track::set_align_style (AlignStyle s, bool force)
768 _diskstream->set_align_style (s, force);
772 Track::set_align_choice (AlignChoice s, bool force)
774 _diskstream->set_align_choice (s, force);
778 Track::using_diskstream_id (PBD::ID id) const
780 return (id == _diskstream->id ());
784 Track::set_block_size (pframes_t n)
786 Route::set_block_size (n);
787 _diskstream->set_block_size (n);
791 Track::adjust_playback_buffering ()
794 _diskstream->adjust_playback_buffering ();
799 Track::adjust_capture_buffering ()
802 _diskstream->adjust_capture_buffering ();
807 Track::monitoring_state () const
809 /* Explicit requests */
811 if (_monitoring & MonitorInput) {
812 return MonitoringInput;
815 if (_monitoring & MonitorDisk) {
816 return MonitoringDisk;
819 /* This is an implementation of the truth table in doc/monitor_modes.pdf;
820 I don't think it's ever going to be too pretty too look at.
823 bool const roll = _session.transport_rolling ();
824 bool const track_rec = _diskstream->record_enabled ();
825 bool const session_rec = _session.get_record_enabled ();
826 bool const auto_input = _session.config.get_auto_input ();
827 bool const software_monitor = Config->get_monitoring_model() == SoftwareMonitoring;
828 bool const tape_machine_mode = Config->get_tape_machine_mode ();
832 if (!session_rec && roll && auto_input) {
833 return MonitoringDisk;
835 return software_monitor ? MonitoringInput : MonitoringSilence;
840 if (tape_machine_mode) {
842 return MonitoringDisk;
846 if (!roll && auto_input) {
847 return software_monitor ? MonitoringInput : MonitoringSilence;
849 return MonitoringDisk;
856 return MonitoringSilence;
860 Track::maybe_declick (BufferSet& bufs, framecnt_t nframes, int declick)
862 /* never declick if there is an internal generator - we just want it to
863 keep generating sound without interruption.
865 ditto if we are monitoring inputs.
868 if (_have_internal_generator || monitoring_choice() == MonitorInput) {
873 declick = _pending_declick;
877 Amp::declick (bufs, nframes, declick);
882 Track::check_initial_delay (framecnt_t nframes, framepos_t& transport_frame)
884 if (_roll_delay > nframes) {
886 _roll_delay -= nframes;
887 silence_unlocked (nframes);
888 /* transport frame is not legal for caller to use */
891 } else if (_roll_delay > 0) {
893 nframes -= _roll_delay;
894 silence_unlocked (_roll_delay);
895 transport_frame += _roll_delay;
897 /* shuffle all the port buffers for things that lead "out" of this Route
898 to reflect that we just wrote _roll_delay frames of silence.
901 Glib::RWLock::ReaderLock lm (_processor_lock);
902 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
903 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor> (*i);
905 iop->increment_port_buffer_offset (_roll_delay);
908 _output->increment_port_buffer_offset (_roll_delay);
918 Track::set_monitoring (MonitorChoice mc)
920 if (mc != _monitoring) {
923 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
924 (*i)->monitoring_changed ();
927 MonitoringChanged (); /* EMIT SIGNAL */
932 Track::parameter_changed (string p)
934 if (p != "do-not-record-plugins") {
938 if (record_enabled ()) {
939 if (Config->get_do_not_record_plugins ()) {
940 deactivate_visible_processors ();
942 activate_deactivated_processors ();
948 Track::metering_state () const
950 return _diskstream->record_enabled() ? MeteringInput : MeteringRoute;