Return silence from read_from_sources() if we try to read a channel that our source...
[ardour.git] / libs / ardour / track.cc
index be992eaa61b20cb45558874ab57da94d3392756c..0ad59d1b31b93db50340e3a095044a5a9def0cea 100644 (file)
 #include "pbd/error.h"
 
 #include "ardour/amp.h"
-#include "ardour/audioplaylist.h"
-#include "ardour/audioregion.h"
-#include "ardour/audiosource.h"
 #include "ardour/debug.h"
 #include "ardour/delivery.h"
 #include "ardour/diskstream.h"
 #include "ardour/io_processor.h"
 #include "ardour/meter.h"
+#include "ardour/playlist.h"
 #include "ardour/port.h"
 #include "ardour/processor.h"
 #include "ardour/route_group_specialized.h"
@@ -43,10 +41,12 @@ Track::Track (Session& sess, string name, Route::Flag flag, TrackMode mode, Data
        : Route (sess, name, flag, default_type)
         , _saved_meter_point (_meter_point)
         , _mode (mode)
-       , _rec_enable_control (new RecEnableControllable(*this))
+       , _monitoring (MonitorAuto)
 {
        _freeze_record.state = NoFreeze;
         _declickable = true;
+
+       Config->ParameterChanged.connect_same_thread (*this, boost::bind (&Track::parameter_changed, this, _1));
 }
 
 Track::~Track ()
@@ -61,52 +61,131 @@ Track::init ()
                 return -1;
         }
 
+       boost::shared_ptr<Route> rp (shared_from_this());
+       boost::shared_ptr<Track> rt = boost::dynamic_pointer_cast<Track> (rp);
+       _rec_enable_control = boost::shared_ptr<RecEnableControl> (new RecEnableControl(rt));
+       _rec_enable_control->set_flags (Controllable::Toggle);
+
+       /* don't add rec_enable_control to controls because we don't want it to
+        * appear as an automatable parameter
+        */
+
         return 0;
 }
-XMLNode&
-Track::get_state ()
+
+void
+Track::use_new_diskstream ()
 {
-       return state (true);
-}
+       boost::shared_ptr<Diskstream> ds = create_diskstream ();
 
+       ds->do_refill_with_alloc ();
+       ds->set_block_size (_session.get_block_size ());
+       ds->playlist()->set_orig_track_id (id());
 
+       set_diskstream (ds);
+}
 
 XMLNode&
-Track::get_template ()
+Track::get_state ()
 {
-       return state (false);
+       return state (true);
 }
 
-void
-Track::toggle_monitor_input ()
-{
-       for (PortSet::iterator i = _input->ports().begin(); i != _input->ports().end(); ++i) {
-               i->ensure_monitor_input(!i->monitoring_input());
+XMLNode&
+Track::state (bool full)
+{
+       XMLNode& root (Route::state (full));
+       root.add_property (X_("monitoring"), enum_2_string (_monitoring));
+       root.add_property (X_("saved-meter-point"), enum_2_string (_saved_meter_point));
+       root.add_child_nocopy (_rec_enable_control->get_state());
+       root.add_child_nocopy (_diskstream->get_state ());
+
+       if (!_deactivated_processors.empty ()) {
+               XMLNode* node = new XMLNode (X_("DeactivatedProcessors"));
+               for (list<boost::weak_ptr<Processor> >::iterator i = _deactivated_processors.begin(); i != _deactivated_processors.end(); ++i) {
+                       boost::shared_ptr<Processor> p = i->lock ();
+                       if (p) {
+                               XMLNode* c = new XMLNode (X_("Processor"));
+                               c->add_property (X_("id"), p->id().to_s());
+                               node->add_child_nocopy (*c);
+                       }
+               }
+               root.add_child_nocopy (*node);
        }
-}
+       
+       return root;
+}      
 
-ARDOUR::framecnt_t
-Track::update_total_latency ()
+int
+Track::set_state (const XMLNode& node, int version)
 {
-       framecnt_t old = _output->effective_latency();
-       framecnt_t own_latency = _output->user_latency();
+       if (Route::set_state (node, version)) {
+               return -1;
+       }
 
-       for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
-               if ((*i)->active ()) {
-                       own_latency += (*i)->signal_latency ();
+       XMLNode* child;
+
+       if (version >= 3000) {
+               if ((child = find_named_node (node, X_("Diskstream"))) != 0) {
+                       boost::shared_ptr<Diskstream> ds = diskstream_factory (*child);
+                       ds->do_refill_with_alloc ();
+                       set_diskstream (ds);
                }
        }
 
-       DEBUG_TRACE (DEBUG::Latency, string_compose ("%1: track: internal redirect latency = %2\n", _name, own_latency));
+       if (_diskstream) {
+               _diskstream->playlist()->set_orig_track_id (id());
+       }
+
+       /* set rec-enable control *AFTER* setting up diskstream, because it may
+          want to operate on the diskstream as it sets its own state
+       */
+
+       XMLNodeList nlist = node.children();
+       for (XMLNodeConstIterator niter = nlist.begin(); niter != nlist.end(); ++niter) {
+               child = *niter;
+
+               XMLProperty* prop;
+               if (child->name() == Controllable::xml_node_name && (prop = child->property ("name")) != 0) {
+                       if (prop->value() == X_("recenable")) {
+                               _rec_enable_control->set_state (*child, version);
+                       }
+               }
+
+               if (child->name() == X_("DeactivatedProcessors")) {
+                       XMLNodeList dp = child->children ();
+                       for (XMLNodeConstIterator i = dp.begin(); i != dp.end(); ++i) {
+                               assert ((*i)->name() == X_("Processor"));
+                               XMLProperty* prop = (*i)->property (X_("id"));
+                               boost::shared_ptr<Processor> p = processor_by_id (PBD::ID (prop->value ()));
+                               if (p) {
+                                       _deactivated_processors.push_back (p);
+                               }
+                       }
+               }
+       }
+       
+       const XMLProperty* prop;
 
-       _output->set_port_latency (own_latency);
+       if ((prop = node.property (X_("monitoring"))) != 0) {
+               _monitoring = MonitorChoice (string_2_enum (prop->value(), _monitoring));
+       } else {
+               _monitoring = MonitorAuto;
+       }
 
-       if (old != own_latency) {
-               _output->set_latency_delay (own_latency);
-               signal_latency_changed (); /* EMIT SIGNAL */
+       if ((prop = node.property (X_("saved-meter-point"))) != 0) {
+               _saved_meter_point = MeterPoint (string_2_enum (prop->value(), _saved_meter_point));
+       } else {
+               _saved_meter_point = _meter_point;
        }
 
-       return _output->effective_latency();
+       return 0;
+}
+
+XMLNode&
+Track::get_template ()
+{
+       return state (false);
 }
 
 Track::FreezeRecord::~FreezeRecord ()
@@ -122,23 +201,34 @@ Track::freeze_state() const
        return _freeze_record.state;
 }
 
-Track::RecEnableControllable::RecEnableControllable (Track& s)
-       : Controllable (X_("recenable")), track (s)
+Track::RecEnableControl::RecEnableControl (boost::shared_ptr<Track> t)
+       : AutomationControl (t->session(), RecEnableAutomation, boost::shared_ptr<AutomationList>(), X_("recenable"))
+       , track (t)
 {
+       boost::shared_ptr<AutomationList> gl(new AutomationList(Evoral::Parameter(RecEnableAutomation)));
+       set_list (gl);
 }
 
 void
-Track::RecEnableControllable::set_value (double val)
+Track::RecEnableControl::set_value (double val)
 {
-       bool bval = ((val >= 0.5) ? true: false);
-       track.set_record_enabled (bval, this);
+       boost::shared_ptr<Track> t = track.lock ();
+       if (!t) {
+               return;
+       }
+       
+       t->set_record_enabled (val >= 0.5 ? true : false, this);
 }
 
 double
-Track::RecEnableControllable::get_value (void) const
+Track::RecEnableControl::get_value () const
 {
-       if (track.record_enabled()) { return 1.0; }
-       return 0.0;
+       boost::shared_ptr<Track> t = track.lock ();
+       if (!t) {
+               return 0;
+       }
+       
+       return (t->record_enabled() ? 1.0 : 0.0);
 }
 
 bool
@@ -159,6 +249,33 @@ Track::can_record()
        return will_record;
 }
 
+/* Turn off visible processors (except Fader), keeping track of the old states */
+void
+Track::deactivate_visible_processors ()
+{
+       _deactivated_processors.clear ();
+       Glib::RWLock::ReaderLock lm (_processor_lock);
+       
+       for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
+               if ((*i)->active() && (*i)->display_to_user() && boost::dynamic_pointer_cast<Amp> (*i) == 0) {
+                       (*i)->deactivate ();
+                       _deactivated_processors.push_back (*i);
+               }
+       }
+}
+
+/* Turn deactivated processors back on again */
+void
+Track::activate_deactivated_processors ()
+{
+       for (list<boost::weak_ptr<Processor> >::iterator i = _deactivated_processors.begin(); i != _deactivated_processors.end(); ++i) {
+               boost::shared_ptr<Processor> p = i->lock ();
+               if (p) {
+                       p->activate ();
+               }
+       }
+}
+
 void
 Track::set_record_enabled (bool yn, void *src)
 {
@@ -180,6 +297,14 @@ Track::set_record_enabled (bool yn, void *src)
                _saved_meter_point = _meter_point;
        }
 
+       if (Config->get_do_not_record_plugins ()) {
+               if (yn) {
+                       deactivate_visible_processors ();
+               } else {
+                       activate_deactivated_processors ();
+               }
+       }
+
        _diskstream->set_record_enabled (yn);
 
        if (_diskstream->record_enabled()) {
@@ -204,8 +329,14 @@ Track::set_name (const string& str)
                return false;
        }
 
-       if (_diskstream->set_name (str)) {
-               return false;
+       if (_diskstream->playlist()->all_regions_empty ()) {
+               /* Only rename the diskstream (and therefore the playlist) if
+                  the playlist has never had a region added to it.  Otherwise
+                  people can get confused if, say, they have notes about a
+                  playlist with a given name and then it changes (see mantis
+                  #4759).
+               */
+               _diskstream->set_name (str);
        }
 
        /* save state so that the statefile fully reflects any filename changes */
@@ -218,29 +349,22 @@ Track::set_name (const string& str)
 }
 
 void
-Track::set_latency_delay (framecnt_t longest_session_latency)
+Track::set_latency_compensation (framecnt_t longest_session_latency)
 {
-       Route::set_latency_delay (longest_session_latency);
+       Route::set_latency_compensation (longest_session_latency);
        _diskstream->set_roll_delay (_roll_delay);
 }
 
-void
-Track::zero_diskstream_id_in_xml (XMLNode& node)
-{
-       if (node.property ("diskstream-id")) {
-               node.add_property ("diskstream-id", "0");
-       }
-}
-
 int
-Track::no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
-               bool session_state_changing, bool can_record, bool /*rec_monitors_input*/)
+Track::no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, bool session_state_changing)
 {
        Glib::RWLock::ReaderLock lm (_processor_lock, Glib::TRY_LOCK);
        if (!lm.locked()) {
                return 0;
        }
 
+       bool can_record = _session.actively_recording ();
+
        if (n_outputs().n_total() == 0) {
                return 0;
        }
@@ -276,25 +400,25 @@ Track::no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
                */
                be_silent = true;
        } else {
-                be_silent = send_silence ();
+               MonitorState const s = monitoring_state ();
+               /* we are not rolling, so be silent even if we are monitoring disk, as there
+                  will be no disk data coming in.
+               */
+                be_silent = (s == MonitoringSilence || s == MonitoringDisk);
+       }
+
+       if (!_have_internal_generator && metering_state() == MeteringInput) {
+               _input->process_input (_meter, start_frame, end_frame, nframes);
        }
 
        _amp->apply_gain_automation(false);
 
+       /* if have_internal_generator, or .. */
+       //_input->process_input (_meter, start_frame, end_frame, nframes);
+
        if (be_silent) {
 
-               /* if we're sending silence, but we want the meters to show levels for the signal,
-                  meter right here.
-               */
-
-               if (_have_internal_generator) {
-                       passthru_silence (start_frame, end_frame, nframes, 0);
-               } else {
-                       if (_meter_point == MeterInput) {
-                               _input->process_input (_meter, start_frame, end_frame, nframes);
-                       }
-                       passthru_silence (start_frame, end_frame, nframes, 0);
-               }
+               passthru_silence (start_frame, end_frame, nframes, 0);
 
        } else {
 
@@ -304,14 +428,18 @@ Track::no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
                passthru (start_frame, end_frame, nframes, false);
        }
 
-       _main_outs->flush_buffers (nframes, end_frame - start_frame - 1);
+       for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
+               boost::shared_ptr<Delivery> d = boost::dynamic_pointer_cast<Delivery> (*i);
+               if (d) {
+                       d->flush_buffers (nframes);
+               }
+       }
 
        return 0;
 }
 
 int
-Track::silent_roll (pframes_t nframes, framepos_t /*start_frame*/, framepos_t /*end_frame*/,
-                   bool can_record, bool rec_monitors_input, bool& need_butler)
+Track::silent_roll (pframes_t nframes, framepos_t /*start_frame*/, framepos_t /*end_frame*/, bool& need_butler)
 {
        Glib::RWLock::ReaderLock lm (_processor_lock, Glib::TRY_LOCK);
        if (!lm.locked()) {
@@ -332,14 +460,17 @@ Track::silent_roll (pframes_t nframes, framepos_t /*start_frame*/, framepos_t /*
 
        silence (nframes);
 
-       return _diskstream->process (_session.transport_frame(), nframes, can_record, rec_monitors_input, need_butler);
+       framecnt_t playback_distance;
+       int const dret = _diskstream->process (_session.transport_frame(), nframes, playback_distance);
+       need_butler = _diskstream->commit (playback_distance);
+       return dret;
 }
 
 void
 Track::set_diskstream (boost::shared_ptr<Diskstream> ds)
 {
        _diskstream = ds;
-       
+
        ds->PlaylistChanged.connect_same_thread (*this, boost::bind (&Track::diskstream_playlist_changed, this));
        diskstream_playlist_changed ();
        ds->RecordEnableChanged.connect_same_thread (*this, boost::bind (&Track::diskstream_record_enable_changed, this));
@@ -378,9 +509,15 @@ Track::playlist ()
 }
 
 void
-Track::monitor_input (bool m)
+Track::request_jack_monitors_input (bool m)
 {
-       _diskstream->monitor_input (m);
+       _diskstream->request_jack_monitors_input (m);
+}
+
+void
+Track::ensure_jack_monitors_input (bool m)
+{
+       _diskstream->ensure_jack_monitors_input (m);
 }
 
 bool
@@ -401,7 +538,7 @@ Track::set_capture_offset ()
        _diskstream->set_capture_offset ();
 }
 
-list<boost::shared_ptr<Source> > 
+list<boost::shared_ptr<Source> >
 Track::steal_write_sources()
 {
         return _diskstream->steal_write_sources ();
@@ -456,13 +593,13 @@ Track::hidden () const
 }
 
 int
-Track::can_internal_playback_seek (framepos_t p)
+Track::can_internal_playback_seek (framecnt_t p)
 {
        return _diskstream->can_internal_playback_seek (p);
 }
 
 int
-Track::internal_playback_seek (framepos_t p)
+Track::internal_playback_seek (framecnt_t p)
 {
        return _diskstream->internal_playback_seek (p);
 }
@@ -563,6 +700,12 @@ Track::alignment_style () const
        return _diskstream->alignment_style ();
 }
 
+AlignChoice
+Track::alignment_choice () const
+{
+       return _diskstream->alignment_choice ();
+}
+
 framepos_t
 Track::current_capture_start () const
 {
@@ -584,43 +727,53 @@ Track::playlist_modified ()
 int
 Track::use_playlist (boost::shared_ptr<Playlist> p)
 {
-       return _diskstream->use_playlist (p);
+       int ret = _diskstream->use_playlist (p);
+       if (ret == 0) {
+               p->set_orig_track_id (id());
+       }
+       return ret;
 }
 
 int
 Track::use_copy_playlist ()
 {
-       return _diskstream->use_copy_playlist ();
+       int ret =  _diskstream->use_copy_playlist ();
+
+       if (ret == 0) {
+               _diskstream->playlist()->set_orig_track_id (id());
+       }
+
+       return ret;
 }
 
 int
 Track::use_new_playlist ()
 {
-       return _diskstream->use_new_playlist ();
-}
+       int ret = _diskstream->use_new_playlist ();
 
-uint32_t
-Track::read_data_count () const
-{
-       return _diskstream->read_data_count ();
+       if (ret == 0) {
+               _diskstream->playlist()->set_orig_track_id (id());
+       }
+
+       return ret;
 }
 
 void
-Track::set_align_style (AlignStyle s)
+Track::set_align_style (AlignStyle s, bool force)
 {
-       _diskstream->set_align_style (s);
+       _diskstream->set_align_style (s, force);
 }
 
-uint32_t
-Track::write_data_count () const
+void
+Track::set_align_choice (AlignChoice s, bool force)
 {
-       return _diskstream->write_data_count ();
+       _diskstream->set_align_choice (s, force);
 }
 
-PBD::ID const &
-Track::diskstream_id () const
+bool
+Track::using_diskstream_id (PBD::ID id) const
 {
-       return _diskstream->id ();
+       return (id == _diskstream->id ());
 }
 
 void
@@ -630,7 +783,7 @@ Track::set_block_size (pframes_t n)
        _diskstream->set_block_size (n);
 }
 
-void 
+void
 Track::adjust_playback_buffering ()
 {
         if (_diskstream) {
@@ -638,7 +791,7 @@ Track::adjust_playback_buffering ()
         }
 }
 
-void 
+void
 Track::adjust_capture_buffering ()
 {
         if (_diskstream) {
@@ -646,56 +799,69 @@ Track::adjust_capture_buffering ()
         }
 }
 
-bool
-Track::send_silence () const
+MonitorState
+Track::monitoring_state () const
 {
-        /*
-          ADATs work in a strange way..
-          they monitor input always when stopped.and auto-input is engaged.
+       /* Explicit requests */
+       
+       if (_monitoring & MonitorInput) {
+               return MonitoringInput;
+       }
+               
+       if (_monitoring & MonitorDisk) {
+               return MonitoringDisk;
+       }
 
-          Other machines switch to input on stop if the track is record enabled,
-          regardless of the auto input setting (auto input only changes the
-          monitoring state when the transport is rolling)
-        */
+       /* This is an implementation of the truth table in doc/monitor_modes.pdf;
+          I don't think it's ever going to be too pretty too look at.
+       */
 
-        bool send_silence;
-
-        if (!Config->get_tape_machine_mode()) {
-                /*
-                  ADATs work in a strange way..
-                  they monitor input always when stopped.and auto-input is engaged.
-                */
-                if ((Config->get_monitoring_model() == SoftwareMonitoring)
-                    && (_session.config.get_auto_input () || _diskstream->record_enabled())) {
-                        send_silence = false;
-                } else {
-                        send_silence = true;
-                }
-        } else {
-                /*
-                  Other machines switch to input on stop if the track is record enabled,
-                  regardless of the auto input setting (auto input only changes the
-                  monitoring state when the transport is rolling)
-                */
-                if ((Config->get_monitoring_model() == SoftwareMonitoring)
-                    && _diskstream->record_enabled()) {
-                        send_silence = false;
-                } else {
-                        send_silence = true;
-                }
-        }
+       bool const roll = _session.transport_rolling ();
+       bool const track_rec = _diskstream->record_enabled ();
+       bool const session_rec = _session.get_record_enabled ();
+       bool const auto_input = _session.config.get_auto_input ();
+       bool const software_monitor = Config->get_monitoring_model() == SoftwareMonitoring;
+       bool const tape_machine_mode = Config->get_tape_machine_mode ();
+
+       if (track_rec) {
+
+               if (!session_rec && roll && auto_input) {
+                       return MonitoringDisk;
+               } else {
+                       return software_monitor ? MonitoringInput : MonitoringSilence;
+               }
+
+       } else {
+
+               if (tape_machine_mode) {
+
+                       return MonitoringDisk;
+
+               } else {
 
-        return send_silence;
+                       if (!roll && auto_input) {
+                               return software_monitor ? MonitoringInput : MonitoringSilence;
+                       } else {
+                               return MonitoringDisk;
+                       }
+                       
+               }
+       }
+
+       /* NOTREACHED */
+       return MonitoringSilence;
 }
 
 void
 Track::maybe_declick (BufferSet& bufs, framecnt_t nframes, int declick)
-{      
-        /* never declick if there is an internal generator - we just want it to 
+{
+        /* never declick if there is an internal generator - we just want it to
            keep generating sound without interruption.
+
+          ditto if we are monitoring inputs.
         */
 
-        if (_have_internal_generator) {
+        if (_have_internal_generator || monitoring_choice() == MonitorInput) {
                 return;
         }
 
@@ -707,3 +873,75 @@ Track::maybe_declick (BufferSet& bufs, framecnt_t nframes, int declick)
                Amp::declick (bufs, nframes, declick);
        }
 }
+
+framecnt_t
+Track::check_initial_delay (framecnt_t nframes, framepos_t& transport_frame)
+{
+       if (_roll_delay > nframes) {
+
+               _roll_delay -= nframes;
+               silence_unlocked (nframes);
+               /* transport frame is not legal for caller to use */
+               return 0;
+
+       } else if (_roll_delay > 0) {
+
+               nframes -= _roll_delay;
+               silence_unlocked (_roll_delay);
+               transport_frame += _roll_delay;
+
+               /* shuffle all the port buffers for things that lead "out" of this Route
+                  to reflect that we just wrote _roll_delay frames of silence.
+               */
+
+               Glib::RWLock::ReaderLock lm (_processor_lock);
+               for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
+                       boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor> (*i);
+                       if (iop) {
+                               iop->increment_port_buffer_offset (_roll_delay);
+                       }
+               }
+               _output->increment_port_buffer_offset (_roll_delay);
+
+               _roll_delay = 0;
+
+       }
+
+       return nframes; 
+}
+
+void
+Track::set_monitoring (MonitorChoice mc)
+{
+       if (mc !=  _monitoring) {
+               _monitoring = mc;
+
+               for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
+                       (*i)->monitoring_changed ();
+               }
+
+               MonitoringChanged (); /* EMIT SIGNAL */
+       }
+}
+
+void
+Track::parameter_changed (string p)
+{
+       if (p != "do-not-record-plugins") {
+               return;
+       }
+
+       if (record_enabled ()) {
+               if (Config->get_do_not_record_plugins ()) {
+                       deactivate_visible_processors ();
+               } else {
+                       activate_deactivated_processors ();
+               }
+       }
+}
+       
+MeterState
+Track::metering_state () const
+{
+       return _diskstream->record_enabled() ? MeteringInput : MeteringRoute;
+}