add tim's jack_utils code to rationalize setup of JACK config
[ardour.git] / libs / ardour / track.cc
index 8a4931d33601275af8c44bea492f55ae0297a311..c6a348ddfb1c4d7963b9a29239672f7323d76129 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"
 #include "ardour/session.h"
+#include "ardour/session_playlists.h"
 #include "ardour/track.h"
 #include "ardour/utils.h"
 
@@ -44,12 +43,9 @@ Track::Track (Session& sess, string name, Route::Flag flag, TrackMode mode, Data
         , _saved_meter_point (_meter_point)
         , _mode (mode)
        , _monitoring (MonitorAuto)
-       , _rec_enable_control (new RecEnableControllable(*this))
 {
        _freeze_record.state = NoFreeze;
         _declickable = true;
-
-       Config->ParameterChanged.connect_same_thread (*this, boost::bind (&Track::parameter_changed, this, _1));
 }
 
 Track::~Track ()
@@ -64,9 +60,30 @@ 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;
 }
 
+void
+Track::use_new_diskstream ()
+{
+       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_state ()
 {
@@ -81,19 +98,6 @@ Track::state (bool full)
        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;
 }      
@@ -115,7 +119,9 @@ Track::set_state (const XMLNode& node, int version)
                }
        }
 
-       _diskstream->playlist()->set_orig_track_id (id());
+       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
@@ -131,18 +137,6 @@ Track::set_state (const XMLNode& node, int version)
                                _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;
@@ -168,14 +162,6 @@ Track::get_template ()
        return state (false);
 }
 
-void
-Track::toggle_monitor_input ()
-{
-       for (PortSet::iterator i = _input->ports().begin(); i != _input->ports().end(); ++i) {
-               i->ensure_monitor_input(!i->monitoring_input());
-       }
-}
-
 Track::FreezeRecord::~FreezeRecord ()
 {
        for (vector<FreezeRecordProcessorInfo*>::iterator i = processor_info.begin(); i != processor_info.end(); ++i) {
@@ -189,23 +175,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
@@ -226,35 +223,8 @@ 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)
+Track::prep_record_enabled (bool yn, void *src)
 {
        if (!_session.writable()) {
                return;
@@ -265,7 +235,7 @@ Track::set_record_enabled (bool yn, void *src)
        }
 
        if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_recenable()) {
-               _route_group->apply (&Track::set_record_enabled, yn, _route_group);
+               _route_group->apply (&Track::prep_record_enabled, yn, _route_group);
                return;
        }
 
@@ -274,28 +244,46 @@ Track::set_record_enabled (bool yn, void *src)
                _saved_meter_point = _meter_point;
        }
 
-       if (Config->get_do_not_record_plugins ()) {
+       bool will_follow;
+       
+       if (yn) {
+               will_follow = _diskstream->prep_record_enable ();
+       } else {
+               will_follow = _diskstream->prep_record_disable ();
+       }
+
+       if (will_follow) {
                if (yn) {
-                       deactivate_visible_processors ();
+                       if (_meter_point != MeterCustom) {
+                               set_meter_point (MeterInput);
+                       }
                } else {
-                       activate_deactivated_processors ();
+                       set_meter_point (_saved_meter_point);
                }
        }
+}
 
-       _diskstream->set_record_enabled (yn);
+void
+Track::set_record_enabled (bool yn, void *src)
+{
+       if (!_session.writable()) {
+               return;
+       }
 
-       if (_diskstream->record_enabled()) {
-               if (_meter_point != MeterCustom) {
-                       set_meter_point (MeterInput);
-               }
-       } else {
-               set_meter_point (_saved_meter_point);
+       if (_freeze_record.state == Frozen) {
+               return;
+       }
+
+       if (_route_group && src != _route_group && _route_group->is_active() && _route_group->is_recenable()) {
+               _route_group->apply (&Track::set_record_enabled, yn, _route_group);
+               return;
        }
 
+       _diskstream->set_record_enabled (yn);
+
        _rec_enable_control->Changed ();
 }
 
-
 bool
 Track::set_name (const string& str)
 {
@@ -306,7 +294,21 @@ Track::set_name (const string& str)
                return false;
        }
 
-       _diskstream->set_name (str);
+       boost::shared_ptr<Track> me = boost::dynamic_pointer_cast<Track> (shared_from_this ());
+       if (_diskstream->playlist()->all_regions_empty () && _session.playlists->playlists_for_track (me).size() == 1) {
+               /* Only rename the diskstream (and therefore the playlist) if
+                  a) the playlist has never had a region added to it and
+                  b) there is only one playlist for this track.
+
+                  If (a) is not followed, people can get confused if, say,
+                  they have notes about a playlist with a given name and then
+                  it changes (see mantis #4759).
+
+                  If (b) is not followed, we rename the current playlist and not
+                  the other ones, which is a bit confusing (see mantis #4977).
+               */
+               _diskstream->set_name (str);
+       }
 
        /* save state so that the statefile fully reflects any filename changes */
 
@@ -327,19 +329,27 @@ Track::set_latency_compensation (framecnt_t longest_session_latency)
 int
 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);
+       Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
+
        if (!lm.locked()) {
                return 0;
        }
 
        bool can_record = _session.actively_recording ();
 
+       /* no outputs? nothing to do ... what happens if we have sends etc. ? */
+
        if (n_outputs().n_total() == 0) {
                return 0;
        }
 
+       /* not active ... do the minimum possible by just outputting silence */
+
        if (!_active) {
                silence (nframes);
+               if (_meter_point == MeterInput && (_monitoring & MonitorInput || _diskstream->record_enabled())) {
+                       _meter->reset();
+               }
                return 0;
        }
 
@@ -368,39 +378,90 @@ Track::no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
                   into the route.
                */
                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.
+               */
+               switch (s) {
+               case MonitoringSilence:
+                       /* if there is an instrument, be_silent should always
+                          be false
+                       */
+                       be_silent = (the_instrument_unlocked() == 0);
+                       break;
+               case MonitoringDisk:
+                       be_silent = true;
+                       break;
+               case MonitoringInput:
+                       be_silent = false;
+                       break;
+               }
        }
 
-       _amp->apply_gain_automation(false);
+       _amp->apply_gain_automation (false);
+
+       /* if have_internal_generator, or .. */
 
        if (be_silent) {
 
-               /* if we're sending silence, but we want the meters to show levels for the signal,
-                  meter right here.
-               */
+               if (_meter_point == MeterInput) {
+                       /* still need input monitoring and metering */
+
+                       bool const track_rec = _diskstream->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 ();
+                       bool no_meter = false;
+
+                       /* this needs a proper K-map
+                        * and should be separated into a function similar to monitoring_state()
+                        * that also handles roll() states in audio_track.cc, midi_track.cc and route.cc
+                        *
+                        * see http://www.oofus.co.uk/ardour/Ardour3MonitorModesV3.pdf
+                        */
+                       if (!auto_input && !track_rec) {
+                               no_meter=true;
+                       }
+                       else if (tape_machine_mode && !track_rec && auto_input) {
+                               no_meter=true;
+                       }
+                       else if (!software_monitor && tape_machine_mode && !track_rec) {
+                               no_meter=true;
+                       }
+                       else if (!software_monitor && !tape_machine_mode && !track_rec && !auto_input) {
+                               no_meter=true;
+                       }
 
-               if (_have_internal_generator) {
-                       passthru_silence (start_frame, end_frame, nframes, 0);
-               } else {
-                       if (_meter_point == MeterInput) {
+                       if (no_meter) {
+                               _meter->reset();
+                               _input->process_input (boost::shared_ptr<Processor>(), start_frame, end_frame, nframes);
+                       } else {
                                _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 {
 
-               /* we're sending signal, but we may still want to meter the input.
-                */
+               BufferSet& bufs = _session.get_scratch_buffers (n_process_buffers());
+               
+               fill_buffers_with_input (bufs, _input, nframes);
 
-               passthru (start_frame, end_frame, nframes, false);
+               if (_meter_point == MeterInput) {
+                       _meter->run (bufs, start_frame, end_frame, nframes, true);
+               }
+
+               passthru (bufs, start_frame, end_frame, nframes, false);
        }
 
        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, end_frame - start_frame - 1);
+                       d->flush_buffers (nframes);
                }
        }
 
@@ -410,7 +471,7 @@ Track::no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
 int
 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);
+       Glib::Threads::RWLock::ReaderLock lm (_processor_lock, Glib::Threads::TRY_LOCK);
        if (!lm.locked()) {
                return 0;
        }
@@ -430,7 +491,10 @@ Track::silent_roll (pframes_t nframes, framepos_t /*start_frame*/, framepos_t /*
        silence (nframes);
 
        framecnt_t playback_distance;
-       int const dret = _diskstream->process (_session.transport_frame(), nframes, playback_distance);
+
+       BufferSet& bufs (_session.get_silent_buffers (n_process_buffers()));
+
+       int const dret = _diskstream->process (bufs, _session.transport_frame(), nframes, playback_distance, false);
        need_butler = _diskstream->commit (playback_distance);
        return dret;
 }
@@ -478,9 +542,15 @@ Track::playlist ()
 }
 
 void
-Track::monitor_input (bool m)
+Track::request_jack_monitors_input (bool m)
+{
+       _diskstream->request_jack_monitors_input (m);
+}
+
+void
+Track::ensure_jack_monitors_input (bool m)
 {
-       _diskstream->monitor_input (m);
+       _diskstream->ensure_jack_monitors_input (m);
 }
 
 bool
@@ -556,13 +626,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);
 }
@@ -576,7 +646,14 @@ Track::non_realtime_input_change ()
 void
 Track::non_realtime_locate (framepos_t p)
 {
-       _diskstream->non_realtime_locate (p);
+       Route::non_realtime_locate (p);
+
+       if (!hidden()) {
+               /* don't waste i/o cycles and butler calls
+                  for hidden (secret) tracks
+               */
+               _diskstream->non_realtime_locate (p);
+       }
 }
 
 void
@@ -690,7 +767,11 @@ 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
@@ -758,101 +839,69 @@ Track::adjust_capture_buffering ()
         }
 }
 
-bool
-Track::send_silence () const
-{
-        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)
-                    && ((_monitoring & MonitorInput) || (_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)
-                    && ((_monitoring & MonitorInput) || 
-                       (!(_monitoring & MonitorDisk) && (_session.config.get_auto_input () || _diskstream->record_enabled())))){
-
-                       DEBUG_TRACE (DEBUG::Monitor, 
-                                    string_compose ("%1: no roll, use silence = FALSE,  monitoring choice %2 recenable %3 sRA %4 autoinput %5\n",
-                                                    name(), enum_2_string (_monitoring), 
-                                                    _diskstream->record_enabled(), _session.actively_recording(),
-                                                    _session.config.get_auto_input()));
-
-                        send_silence = false;
-                } else {
-                       DEBUG_TRACE (DEBUG::Monitor, 
-                                    string_compose ("%1: no roll, use silence = TRUE,  monitoring choice %2 recenable %3 sRA %4 autoinput %5\n",
-                                                    name(), enum_2_string (_monitoring), 
-                                                    _diskstream->record_enabled(), _session.actively_recording(),
-                                                    _session.config.get_auto_input()));
-                        send_silence = true;
-                }
-        }
-
-        return send_silence;
-}
-
 MonitorState
-Track::monitoring_state ()
+Track::monitoring_state () const
 {
-       MonitorState ms = MonitoringSilence;
-
-       if (_session.transport_rolling()) {
-               
-               /* roll case */
+       /* Explicit requests */
+       
+       if (_monitoring & MonitorInput) {
+               return MonitoringInput;
+       }
                
-               if (_monitoring & MonitorInput) { // explicitly requested input monitoring
-                       
-                       ms = MonitoringInput;
-
-               } else if (_monitoring & MonitorDisk) { // explicitly requested disk monitoring
-                       
-                       ms = MonitoringDisk;
+       if (_monitoring & MonitorDisk) {
+               return MonitoringDisk;
+       }
 
-               } else if (_diskstream->record_enabled() && _session.actively_recording()) { // Track actually recording
-                       
-                       ms = MonitoringInput;
+       /* 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.
+       */
 
-               } else if (_diskstream->record_enabled() && !_session.actively_recording() && _session.config.get_auto_input()) { // Track armed but not recording, with auto input enabled
-                       
-                       ms = MonitoringInput;
+       bool const roll = _session.transport_rolling ();
+       bool const track_rec = _diskstream->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 ();
+       bool session_rec;
+
+       /* I suspect that just use actively_recording() is good enough all the
+        * time, but just to keep the semantics the same as they were before
+        * sept 26th 2012, we differentiate between the cases where punch is
+        * enabled and those where it is not.
+        */
+
+       if (_session.config.get_punch_in() || _session.config.get_punch_out()) {
+               session_rec = _session.actively_recording ();
+       } else {
+               session_rec = _session.get_record_enabled();
+       }
 
-               } else { // Every other state
-                       
-                       ms = MonitoringDisk; 
+       if (track_rec) {
 
+               if (!session_rec && roll && auto_input) {
+                       return MonitoringDisk;
+               } else {
+                       return software_monitor ? MonitoringInput : MonitoringSilence;
                }
 
        } else {
 
-               /* no-roll case */
+               if (tape_machine_mode) {
+
+                       return MonitoringDisk;
 
-               if (send_silence()) {
-                       
-                       ms = MonitoringSilence;
                } else {
+
+                       if (!roll && auto_input) {
+                               return software_monitor ? MonitoringInput : MonitoringSilence;
+                       } else {
+                               return MonitoringDisk;
+                       }
                        
-                       ms = MonitoringInput;
                }
        }
 
-       return ms;
+       /* NOTREACHED */
+       return MonitoringSilence;
 }
 
 void
@@ -878,7 +927,7 @@ Track::maybe_declick (BufferSet& bufs, framecnt_t nframes, int declick)
 }
 
 framecnt_t
-Track::check_initial_delay (framecnt_t nframes, framecnt_t& transport_frame)
+Track::check_initial_delay (framecnt_t nframes, framepos_t& transport_frame)
 {
        if (_roll_delay > nframes) {
 
@@ -897,7 +946,7 @@ Track::check_initial_delay (framecnt_t nframes, framecnt_t& transport_frame)
                   to reflect that we just wrote _roll_delay frames of silence.
                */
 
-               Glib::RWLock::ReaderLock lm (_processor_lock);
+               Glib::Threads::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) {
@@ -918,24 +967,26 @@ 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)
+MeterState
+Track::metering_state () const
 {
-       if (p != "do-not-record-plugins") {
-               return;
-       }
-
-       if (record_enabled ()) {
-               if (Config->get_do_not_record_plugins ()) {
-                       deactivate_visible_processors ();
-               } else {
-                       activate_deactivated_processors ();
-               }
+       bool rv;
+       if (_session.transport_rolling ()) {
+               // audio_track.cc || midi_track.cc roll() runs meter IFF:
+               rv = _meter_point == MeterInput && (_monitoring & MonitorInput || _diskstream->record_enabled());
+       } else {
+               // track no_roll() always metering if
+               rv = _meter_point == MeterInput;
        }
+       return rv ? MeteringInput : MeteringRoute;
 }
-       
-       
+