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/audioplaylist.h"
22 #include "ardour/audioregion.h"
23 #include "ardour/audiosource.h"
24 #include "ardour/debug.h"
25 #include "ardour/delivery.h"
26 #include "ardour/diskstream.h"
27 #include "ardour/io_processor.h"
28 #include "ardour/meter.h"
29 #include "ardour/port.h"
30 #include "ardour/processor.h"
31 #include "ardour/route_group_specialized.h"
32 #include "ardour/session.h"
33 #include "ardour/track.h"
34 #include "ardour/utils.h"
39 using namespace ARDOUR;
42 Track::Track (Session& sess, string name, Route::Flag flag, TrackMode mode, DataType default_type)
43 : Route (sess, name, flag, default_type)
44 , _saved_meter_point (_meter_point)
46 , _monitoring (MonitorAuto)
48 _freeze_record.state = NoFreeze;
51 Config->ParameterChanged.connect_same_thread (*this, boost::bind (&Track::parameter_changed, this, _1));
56 DEBUG_TRACE (DEBUG::Destruction, string_compose ("track %1 destructor\n", _name));
66 boost::shared_ptr<Route> rp (shared_from_this());
67 boost::shared_ptr<Track> rt = boost::dynamic_pointer_cast<Track> (rp);
68 _rec_enable_control = boost::shared_ptr<RecEnableControl> (new RecEnableControl(rt));
69 _rec_enable_control->set_flags (Controllable::Toggle);
71 /* don't add rec_enable_control to controls because we don't want it to
72 * appear as an automatable parameter
79 Track::use_new_diskstream ()
81 boost::shared_ptr<Diskstream> ds = create_diskstream ();
83 ds->do_refill_with_alloc ();
84 ds->set_block_size (_session.get_block_size ());
85 ds->playlist()->set_orig_track_id (id());
97 Track::state (bool full)
99 XMLNode& root (Route::state (full));
100 root.add_property (X_("monitoring"), enum_2_string (_monitoring));
101 root.add_property (X_("saved-meter-point"), enum_2_string (_saved_meter_point));
102 root.add_child_nocopy (_rec_enable_control->get_state());
103 root.add_child_nocopy (_diskstream->get_state ());
105 if (!_deactivated_processors.empty ()) {
106 XMLNode* node = new XMLNode (X_("DeactivatedProcessors"));
107 for (list<boost::weak_ptr<Processor> >::iterator i = _deactivated_processors.begin(); i != _deactivated_processors.end(); ++i) {
108 boost::shared_ptr<Processor> p = i->lock ();
110 XMLNode* c = new XMLNode (X_("Processor"));
111 c->add_property (X_("id"), p->id().to_s());
112 node->add_child_nocopy (*c);
115 root.add_child_nocopy (*node);
122 Track::set_state (const XMLNode& node, int version)
124 if (Route::set_state (node, version)) {
130 if (version >= 3000) {
131 if ((child = find_named_node (node, X_("Diskstream"))) != 0) {
132 boost::shared_ptr<Diskstream> ds = diskstream_factory (*child);
133 ds->do_refill_with_alloc ();
139 _diskstream->playlist()->set_orig_track_id (id());
142 /* set rec-enable control *AFTER* setting up diskstream, because it may
143 want to operate on the diskstream as it sets its own state
146 XMLNodeList nlist = node.children();
147 for (XMLNodeConstIterator niter = nlist.begin(); niter != nlist.end(); ++niter) {
151 if (child->name() == Controllable::xml_node_name && (prop = child->property ("name")) != 0) {
152 if (prop->value() == X_("recenable")) {
153 _rec_enable_control->set_state (*child, version);
157 if (child->name() == X_("DeactivatedProcessors")) {
158 XMLNodeList dp = child->children ();
159 for (XMLNodeConstIterator i = dp.begin(); i != dp.end(); ++i) {
160 assert ((*i)->name() == X_("Processor"));
161 XMLProperty* prop = (*i)->property (X_("id"));
162 boost::shared_ptr<Processor> p = processor_by_id (PBD::ID (prop->value ()));
164 _deactivated_processors.push_back (p);
170 const XMLProperty* prop;
172 if ((prop = node.property (X_("monitoring"))) != 0) {
173 _monitoring = MonitorChoice (string_2_enum (prop->value(), _monitoring));
175 _monitoring = MonitorAuto;
178 if ((prop = node.property (X_("saved-meter-point"))) != 0) {
179 _saved_meter_point = MeterPoint (string_2_enum (prop->value(), _saved_meter_point));
181 _saved_meter_point = _meter_point;
188 Track::get_template ()
190 return state (false);
193 Track::FreezeRecord::~FreezeRecord ()
195 for (vector<FreezeRecordProcessorInfo*>::iterator i = processor_info.begin(); i != processor_info.end(); ++i) {
201 Track::freeze_state() const
203 return _freeze_record.state;
206 Track::RecEnableControl::RecEnableControl (boost::shared_ptr<Track> t)
207 : AutomationControl (t->session(), RecEnableAutomation, boost::shared_ptr<AutomationList>(), X_("recenable"))
210 boost::shared_ptr<AutomationList> gl(new AutomationList(Evoral::Parameter(RecEnableAutomation)));
215 Track::RecEnableControl::set_value (double val)
217 track->set_record_enabled (val >= 0.5 ? true : false, this);
221 Track::RecEnableControl::get_value (void) const
223 return (track->record_enabled() ? 1.0 : 0.0);
227 Track::record_enabled () const
229 return _diskstream && _diskstream->record_enabled ();
235 bool will_record = true;
236 for (PortSet::iterator i = _input->ports().begin(); i != _input->ports().end() && will_record; ++i) {
244 /* Turn off visible processors (except Fader), keeping track of the old states */
246 Track::deactivate_visible_processors ()
248 _deactivated_processors.clear ();
249 Glib::RWLock::ReaderLock lm (_processor_lock);
251 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
252 if ((*i)->active() && (*i)->display_to_user() && boost::dynamic_pointer_cast<Amp> (*i) == 0) {
254 _deactivated_processors.push_back (*i);
259 /* Turn deactivated processors back on again */
261 Track::activate_deactivated_processors ()
263 for (list<boost::weak_ptr<Processor> >::iterator i = _deactivated_processors.begin(); i != _deactivated_processors.end(); ++i) {
264 boost::shared_ptr<Processor> p = i->lock ();
272 Track::set_record_enabled (bool yn, void *src)
274 if (!_session.writable()) {
278 if (_freeze_record.state == Frozen) {
282 if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_recenable()) {
283 _route_group->apply (&Track::set_record_enabled, yn, _route_group);
287 /* keep track of the meter point as it was before we rec-enabled */
288 if (!_diskstream->record_enabled()) {
289 _saved_meter_point = _meter_point;
292 if (Config->get_do_not_record_plugins ()) {
294 deactivate_visible_processors ();
296 activate_deactivated_processors ();
300 _diskstream->set_record_enabled (yn);
302 if (_diskstream->record_enabled()) {
303 if (_meter_point != MeterCustom) {
304 set_meter_point (MeterInput);
307 set_meter_point (_saved_meter_point);
310 _rec_enable_control->Changed ();
315 Track::set_name (const string& str)
319 if (record_enabled() && _session.actively_recording()) {
320 /* this messes things up if done while recording */
324 _diskstream->set_name (str);
326 /* save state so that the statefile fully reflects any filename changes */
328 if ((ret = Route::set_name (str)) == 0) {
329 _session.save_state ("");
336 Track::set_latency_compensation (framecnt_t longest_session_latency)
338 Route::set_latency_compensation (longest_session_latency);
339 _diskstream->set_roll_delay (_roll_delay);
343 Track::no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, bool session_state_changing)
345 Glib::RWLock::ReaderLock lm (_processor_lock, Glib::TRY_LOCK);
350 bool can_record = _session.actively_recording ();
352 if (n_outputs().n_total() == 0) {
361 if (session_state_changing) {
362 if (_session.transport_speed() != 0.0f) {
363 /* we're rolling but some state is changing (e.g. our diskstream contents)
364 so we cannot use them. Be silent till this is over. Don't declick.
366 XXX note the absurdity of ::no_roll() being called when we ARE rolling!
368 passthru_silence (start_frame, end_frame, nframes, 0);
371 /* we're really not rolling, so we're either delivery silence or actually
372 monitoring, both of which are safe to do while session_state_changing is true.
376 _diskstream->check_record_status (start_frame, can_record);
380 if (_have_internal_generator) {
381 /* since the instrument has no input streams,
382 there is no reason to send any signal
387 MonitorState const s = monitoring_state ();
388 /* we are not rolling, so be silent even if we are monitoring disk, as there
389 will be no disk data coming in.
391 be_silent = (s == MonitoringSilence || s == MonitoringDisk);
394 if (!_have_internal_generator && metering_state() == MeteringInput) {
395 _input->process_input (_meter, start_frame, end_frame, nframes);
398 _amp->apply_gain_automation(false);
400 /* if have_internal_generator, or .. */
401 //_input->process_input (_meter, start_frame, end_frame, nframes);
405 passthru_silence (start_frame, end_frame, nframes, 0);
409 /* we're sending signal, but we may still want to meter the input.
412 passthru (start_frame, end_frame, nframes, false);
415 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
416 boost::shared_ptr<Delivery> d = boost::dynamic_pointer_cast<Delivery> (*i);
418 d->flush_buffers (nframes);
426 Track::silent_roll (pframes_t nframes, framepos_t /*start_frame*/, framepos_t /*end_frame*/, bool& need_butler)
428 Glib::RWLock::ReaderLock lm (_processor_lock, Glib::TRY_LOCK);
433 if (n_outputs().n_total() == 0 && _processors.empty()) {
443 _amp->apply_gain_automation(false);
447 framecnt_t playback_distance;
448 int const dret = _diskstream->process (_session.transport_frame(), nframes, playback_distance);
449 need_butler = _diskstream->commit (playback_distance);
454 Track::set_diskstream (boost::shared_ptr<Diskstream> ds)
458 ds->PlaylistChanged.connect_same_thread (*this, boost::bind (&Track::diskstream_playlist_changed, this));
459 diskstream_playlist_changed ();
460 ds->RecordEnableChanged.connect_same_thread (*this, boost::bind (&Track::diskstream_record_enable_changed, this));
461 ds->SpeedChanged.connect_same_thread (*this, boost::bind (&Track::diskstream_speed_changed, this));
462 ds->AlignmentStyleChanged.connect_same_thread (*this, boost::bind (&Track::diskstream_alignment_style_changed, this));
466 Track::diskstream_playlist_changed ()
468 PlaylistChanged (); /* EMIT SIGNAL */
472 Track::diskstream_record_enable_changed ()
474 RecordEnableChanged (); /* EMIT SIGNAL */
478 Track::diskstream_speed_changed ()
480 SpeedChanged (); /* EMIT SIGNAL */
484 Track::diskstream_alignment_style_changed ()
486 AlignmentStyleChanged (); /* EMIT SIGNAL */
489 boost::shared_ptr<Playlist>
492 return _diskstream->playlist ();
496 Track::request_jack_monitors_input (bool m)
498 _diskstream->request_jack_monitors_input (m);
502 Track::ensure_jack_monitors_input (bool m)
504 _diskstream->ensure_jack_monitors_input (m);
508 Track::destructive () const
510 return _diskstream->destructive ();
513 list<boost::shared_ptr<Source> > &
514 Track::last_capture_sources ()
516 return _diskstream->last_capture_sources ();
520 Track::set_capture_offset ()
522 _diskstream->set_capture_offset ();
525 list<boost::shared_ptr<Source> >
526 Track::steal_write_sources()
528 return _diskstream->steal_write_sources ();
532 Track::reset_write_sources (bool r, bool force)
534 _diskstream->reset_write_sources (r, force);
538 Track::playback_buffer_load () const
540 return _diskstream->playback_buffer_load ();
544 Track::capture_buffer_load () const
546 return _diskstream->capture_buffer_load ();
552 return _diskstream->do_refill ();
556 Track::do_flush (RunContext c, bool force)
558 return _diskstream->do_flush (c, force);
562 Track::set_pending_overwrite (bool o)
564 _diskstream->set_pending_overwrite (o);
568 Track::seek (framepos_t p, bool complete_refill)
570 return _diskstream->seek (p, complete_refill);
574 Track::hidden () const
576 return _diskstream->hidden ();
580 Track::can_internal_playback_seek (framepos_t p)
582 return _diskstream->can_internal_playback_seek (p);
586 Track::internal_playback_seek (framepos_t p)
588 return _diskstream->internal_playback_seek (p);
592 Track::non_realtime_input_change ()
594 _diskstream->non_realtime_input_change ();
598 Track::non_realtime_locate (framepos_t p)
600 _diskstream->non_realtime_locate (p);
604 Track::non_realtime_set_speed ()
606 _diskstream->non_realtime_set_speed ();
610 Track::overwrite_existing_buffers ()
612 return _diskstream->overwrite_existing_buffers ();
616 Track::get_captured_frames (uint32_t n) const
618 return _diskstream->get_captured_frames (n);
622 Track::set_loop (Location* l)
624 return _diskstream->set_loop (l);
628 Track::transport_looped (framepos_t p)
630 _diskstream->transport_looped (p);
634 Track::realtime_set_speed (double s, bool g)
636 return _diskstream->realtime_set_speed (s, g);
640 Track::transport_stopped_wallclock (struct tm & n, time_t t, bool g)
642 _diskstream->transport_stopped_wallclock (n, t, g);
646 Track::pending_overwrite () const
648 return _diskstream->pending_overwrite ();
652 Track::speed () const
654 return _diskstream->speed ();
658 Track::prepare_to_stop (framepos_t p)
660 _diskstream->prepare_to_stop (p);
664 Track::set_slaved (bool s)
666 _diskstream->set_slaved (s);
672 return _diskstream->n_channels ();
676 Track::get_capture_start_frame (uint32_t n) const
678 return _diskstream->get_capture_start_frame (n);
682 Track::alignment_style () const
684 return _diskstream->alignment_style ();
688 Track::alignment_choice () const
690 return _diskstream->alignment_choice ();
694 Track::current_capture_start () const
696 return _diskstream->current_capture_start ();
700 Track::current_capture_end () const
702 return _diskstream->current_capture_end ();
706 Track::playlist_modified ()
708 _diskstream->playlist_modified ();
712 Track::use_playlist (boost::shared_ptr<Playlist> p)
714 int ret = _diskstream->use_playlist (p);
716 p->set_orig_track_id (id());
722 Track::use_copy_playlist ()
724 int ret = _diskstream->use_copy_playlist ();
727 _diskstream->playlist()->set_orig_track_id (id());
734 Track::use_new_playlist ()
736 int ret = _diskstream->use_new_playlist ();
739 _diskstream->playlist()->set_orig_track_id (id());
746 Track::set_align_style (AlignStyle s, bool force)
748 _diskstream->set_align_style (s, force);
752 Track::set_align_choice (AlignChoice s, bool force)
754 _diskstream->set_align_choice (s, force);
758 Track::using_diskstream_id (PBD::ID id) const
760 return (id == _diskstream->id ());
764 Track::set_block_size (pframes_t n)
766 Route::set_block_size (n);
767 _diskstream->set_block_size (n);
771 Track::adjust_playback_buffering ()
774 _diskstream->adjust_playback_buffering ();
779 Track::adjust_capture_buffering ()
782 _diskstream->adjust_capture_buffering ();
787 Track::monitoring_state () const
789 /* Explicit requests */
791 if (_monitoring & MonitorInput) {
792 return MonitoringInput;
795 if (_monitoring & MonitorDisk) {
796 return MonitoringDisk;
799 /* This is an implementation of the truth table in doc/monitor_modes.pdf;
800 I don't think it's ever going to be too pretty too look at.
803 bool const roll = _session.transport_rolling ();
804 bool const track_rec = _diskstream->record_enabled ();
805 bool const session_rec = _session.get_record_enabled ();
806 bool const auto_input = _session.config.get_auto_input ();
807 bool const software_monitor = Config->get_monitoring_model() == SoftwareMonitoring;
808 bool const tape_machine_mode = Config->get_tape_machine_mode ();
812 if (!session_rec && roll && auto_input) {
813 return MonitoringDisk;
815 return software_monitor ? MonitoringInput : MonitoringSilence;
820 if (tape_machine_mode) {
822 return MonitoringDisk;
826 if (!roll && auto_input) {
827 return software_monitor ? MonitoringInput : MonitoringSilence;
829 return MonitoringDisk;
836 return MonitoringSilence;
840 Track::maybe_declick (BufferSet& bufs, framecnt_t nframes, int declick)
842 /* never declick if there is an internal generator - we just want it to
843 keep generating sound without interruption.
845 ditto if we are monitoring inputs.
848 if (_have_internal_generator || monitoring_choice() == MonitorInput) {
853 declick = _pending_declick;
857 Amp::declick (bufs, nframes, declick);
862 Track::check_initial_delay (framecnt_t nframes, framecnt_t& transport_frame)
864 if (_roll_delay > nframes) {
866 _roll_delay -= nframes;
867 silence_unlocked (nframes);
868 /* transport frame is not legal for caller to use */
871 } else if (_roll_delay > 0) {
873 nframes -= _roll_delay;
874 silence_unlocked (_roll_delay);
875 transport_frame += _roll_delay;
877 /* shuffle all the port buffers for things that lead "out" of this Route
878 to reflect that we just wrote _roll_delay frames of silence.
881 Glib::RWLock::ReaderLock lm (_processor_lock);
882 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
883 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor> (*i);
885 iop->increment_port_buffer_offset (_roll_delay);
888 _output->increment_port_buffer_offset (_roll_delay);
898 Track::set_monitoring (MonitorChoice mc)
900 if (mc != _monitoring) {
903 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
904 (*i)->monitoring_changed ();
907 MonitoringChanged (); /* EMIT SIGNAL */
912 Track::parameter_changed (string p)
914 if (p != "do-not-record-plugins") {
918 if (record_enabled ()) {
919 if (Config->get_do_not_record_plugins ()) {
920 deactivate_visible_processors ();
922 activate_deactivated_processors ();
928 Track::metering_state () const
930 return _diskstream->record_enabled() ? MeteringInput : MeteringRoute;