Fix broken whitespace. I'd apologize for the compile times if it was my fault :D
[ardour.git] / libs / ardour / diskstream.cc
index d566584d9f6cae2bafbc6b8f61e441f1b51a6113..9d5925322d42a3afa93584f71c4febcac3585ff9 100644 (file)
 #include <sys/mman.h>
 
 
+#include <glibmm/thread.h>
+
 #include "pbd/error.h"
 #include "pbd/basename.h"
-#include <glibmm/thread.h>
-#include "pbd/xml++.h"
 #include "pbd/memento_command.h"
+#include "pbd/xml++.h"
+#include "pbd/stacktrace.h"
 
 #include "ardour/ardour.h"
 #include "ardour/audioengine.h"
@@ -46,6 +48,8 @@
 #include "ardour/configuration.h"
 #include "ardour/audiofilesource.h"
 #include "ardour/send.h"
+#include "ardour/pannable.h"
+#include "ardour/panner_shell.h"
 #include "ardour/playlist.h"
 #include "ardour/cycle_timer.h"
 #include "ardour/region.h"
@@ -66,7 +70,7 @@ using namespace PBD;
  * default from configuration_vars.h).  0 is not a good value for
  * allocating buffer sizes..
  */
-ARDOUR::nframes_t Diskstream::disk_io_chunk_frames = 1024 * 256;
+ARDOUR::framecnt_t Diskstream::disk_io_chunk_frames = 1024 * 256;
 
 PBD::Signal0<void>                Diskstream::DiskOverrun;
 PBD::Signal0<void>                Diskstream::DiskUnderrun;
@@ -91,6 +95,7 @@ Diskstream::Diskstream (Session &sess, const string &name, Flag flag)
         , last_recordable_frame (max_framepos)
         , last_possibly_recording (0)
         , _alignment_style (ExistingMaterial)
+        , _alignment_choice (Automatic)
         , _scrubbing (false)
         , _slaved (false)
         , loop_location (0)
@@ -108,10 +113,8 @@ Diskstream::Diskstream (Session &sess, const string &name, Flag flag)
         , _read_data_count (0)
         , _write_data_count (0)
         , in_set_state (false)
-        , _persistent_alignment_style (ExistingMaterial)
-        , first_input_change (true)
         , _flags (flag)
-
+        , deprecated_io_node (0)
 {
 }
 
@@ -135,6 +138,7 @@ Diskstream::Diskstream (Session& sess, const XMLNode& /*node*/)
         , last_recordable_frame (max_framepos)
         , last_possibly_recording (0)
         , _alignment_style (ExistingMaterial)
+        , _alignment_choice (Automatic)
         , _scrubbing (false)
         , _slaved (false)
         , loop_location (0)
@@ -152,9 +156,8 @@ Diskstream::Diskstream (Session& sess, const XMLNode& /*node*/)
         , _read_data_count (0)
         , _write_data_count (0)
         , in_set_state (false)
-        , _persistent_alignment_style (ExistingMaterial)
-        , first_input_change (true)
         , _flags (Recordable)
+        , deprecated_io_node (0)
 {
 }
 
@@ -165,6 +168,8 @@ Diskstream::~Diskstream ()
        if (_playlist) {
                _playlist->release ();
        }
+
+        delete deprecated_io_node;
 }
 
 void
@@ -176,9 +181,10 @@ Diskstream::set_track (Track* t)
        ic_connection.disconnect();
        _io->changed.connect_same_thread (ic_connection, boost::bind (&Diskstream::handle_input_change, this, _1, _2));
 
-       input_change_pending = IOChange::ConfigurationChanged;
-       non_realtime_input_change ();
-       set_align_style_from_io ();
+        if (_io->n_ports() != ChanCount::ZERO) {
+                input_change_pending.type = IOChange::Type (IOChange::ConfigurationChanged|IOChange::ConnectionsChanged);
+                non_realtime_input_change ();
+        }
 
        _track->Destroyed.connect_same_thread (*this, boost::bind (&Diskstream::route_going_away, this));
 }
@@ -188,7 +194,14 @@ Diskstream::handle_input_change (IOChange change, void * /*src*/)
 {
        Glib::Mutex::Lock lm (state_lock);
 
-        if (change.type & IOChange::ConfigurationChanged) {
+        if (change.type & (IOChange::ConfigurationChanged|IOChange::ConnectionsChanged)) {
+
+                /* rather than handle this here on a DS-by-DS basis we defer to the
+                   session transport/butler thread, and let it tackle
+                   as many diskstreams as need it in one shot. this avoids many repeated
+                   takings of the audioengine process lock.
+                */
+
                 if (!(input_change_pending.type & change.type)) {
                         input_change_pending.type = IOChange::Type (input_change_pending.type | change.type);
                         _session.request_input_change_handling ();
@@ -232,7 +245,7 @@ Diskstream::realtime_set_speed (double sp, bool global)
 
        if (new_speed != _actual_speed) {
 
-               nframes_t required_wrap_size = (nframes_t) floor (_session.get_block_size() *
+               framecnt_t required_wrap_size = (framecnt_t) floor (_session.get_block_size() *
                                                                   fabs (new_speed)) + 1;
 
                if (required_wrap_size > wrap_buffer_size) {
@@ -262,21 +275,47 @@ Diskstream::set_capture_offset ()
        }
 
        _capture_offset = _io->latency();
+        DEBUG_TRACE (DEBUG::CaptureAlignment, string_compose ("%1: using IO latency, capture offset set to %2\n", name(), _capture_offset));
 }
 
+
 void
-Diskstream::set_align_style (AlignStyle a)
+Diskstream::set_align_style (AlignStyle a, bool force)
 {
        if (record_enabled() && _session.actively_recording()) {
                return;
        }
 
-       if (a != _alignment_style) {
+       if ((a != _alignment_style) || force) {
                _alignment_style = a;
                AlignmentStyleChanged ();
        }
 }
 
+void
+Diskstream::set_align_choice (AlignChoice a, bool force)
+{
+       if (record_enabled() && _session.actively_recording()) {
+               return;
+       }
+
+       if ((a != _alignment_choice) || force) {
+               _alignment_choice = a;
+
+                switch (_alignment_choice) {
+                case Automatic:
+                        set_align_style_from_io ();
+                        break;
+                case UseExistingMaterial:
+                        set_align_style (ExistingMaterial);
+                        break;
+                case UseCaptureTime:
+                        set_align_style (CaptureTime);
+                        break;
+                }
+       }
+}
+
 int
 Diskstream::set_loop (Location *location)
 {
@@ -316,14 +355,14 @@ Diskstream::get_captured_frames (uint32_t n) const
        if (capture_info.size() > n) {
                /* this is a completed capture */
                return capture_info[n]->frames;
-       } else {  
+       } else {
                /* this is the currently in-progress capture */
                return capture_captured;
        }
 }
 
 void
-Diskstream::set_roll_delay (ARDOUR::nframes_t nframes)
+Diskstream::set_roll_delay (ARDOUR::framecnt_t nframes)
 {
        _roll_delay = nframes;
 }
@@ -418,18 +457,88 @@ Diskstream::set_name (const string& str)
        if (_name != str) {
                assert(playlist());
                playlist()->set_name (str);
-
                SessionObject::set_name(str);
+       }
+        return true;
+}
 
-               if (!in_set_state && recordable()) {
-                       /* rename existing capture files so that they have the correct name */
-                       return rename_write_sources ();
-               } else {
-                       return false;
+XMLNode&
+Diskstream::get_state ()
+{
+       XMLNode* node = new XMLNode ("Diskstream");
+        char buf[64];
+       LocaleGuard lg (X_("POSIX"));
+
+       node->add_property ("flags", enum_2_string (_flags));
+       node->add_property ("playlist", _playlist->name());
+       node->add_property("name", _name);
+       id().print (buf, sizeof (buf));
+       node->add_property("id", buf);
+       snprintf (buf, sizeof(buf), "%f", _visible_speed);
+       node->add_property ("speed", buf);
+        node->add_property ("capture-alignment", enum_2_string (_alignment_choice));
+
+       if (_extra_xml) {
+               node->add_child_copy (*_extra_xml);
+       }
+
+        return *node;
+}
+
+int
+Diskstream::set_state (const XMLNode& node, int /*version*/)
+{
+       const XMLProperty* prop;
+
+       if ((prop = node.property ("name")) != 0) {
+               _name = prop->value();
+       }
+
+       if (deprecated_io_node) {
+               if ((prop = deprecated_io_node->property ("id")) != 0) {
+                       _id = prop->value ();
+               }
+       } else {
+               if ((prop = node.property ("id")) != 0) {
+                       _id = prop->value ();
                }
        }
 
-       return true;
+       if ((prop = node.property ("flags")) != 0) {
+               _flags = Flag (string_2_enum (prop->value(), _flags));
+       }
+
+        if ((prop = node.property (X_("capture-alignment"))) != 0) {
+                set_align_choice (AlignChoice (string_2_enum (prop->value(), _alignment_choice)), true);
+        } else {
+                set_align_choice (Automatic, true);
+        }
+
+       if ((prop = node.property ("playlist")) == 0) {
+               return -1;
+       }
+
+       {
+               bool had_playlist = (_playlist != 0);
+
+               if (find_and_use_playlist (prop->value())) {
+                       return -1;
+               }
+
+               if (!had_playlist) {
+                       _playlist->set_orig_diskstream_id (id());
+               }
+       }
+
+       if ((prop = node.property ("speed")) != 0) {
+               double sp = atof (prop->value().c_str());
+
+               if (realtime_set_speed (sp, false)) {
+                       non_realtime_set_speed ();
+               }
+       }
+
+        return 0;
 }
 
 void
@@ -439,11 +548,11 @@ Diskstream::playlist_ranges_moved (list< Evoral::RangeMove<framepos_t> > const &
           automation undo (it must, since automation-follows-regions
           can lose automation data).  Hence we can do nothing here.
        */
-       
+
        if (from_undo) {
                return;
        }
-       
+
        if (!_track || Config->get_automation_follows_regions () == false) {
                return;
        }
@@ -458,18 +567,23 @@ Diskstream::playlist_ranges_moved (list< Evoral::RangeMove<framepos_t> > const &
        }
 
        /* move panner automation */
-       boost::shared_ptr<Panner> p = _track->main_outs()->panner ();
-       if (p) {
-               for (uint32_t i = 0; i < p->npanners (); ++i) {
-                       boost::shared_ptr<AutomationList> pan_alist = p->streampanner(i).pan_control()->alist();
-                       XMLNode & before = pan_alist->get_state ();
-                       bool const things_moved = pan_alist->move_ranges (movements);
-                       if (things_moved) {
-                               _session.add_command (new MementoCommand<AutomationList> (
-                                                             *pan_alist.get(), &before, &pan_alist->get_state ()));
-                       }
-               }
-       }
+       boost::shared_ptr<Pannable> pannable = _track->pannable();
+        Evoral::ControlSet::Controls& c (pannable->controls());
+
+        for (Evoral::ControlSet::Controls::iterator ci = c.begin(); ci != c.end(); ++ci) {
+                boost::shared_ptr<AutomationControl> ac = boost::dynamic_pointer_cast<AutomationControl>(ci->second);
+                if (!ac) {
+                        continue;
+                }
+                boost::shared_ptr<AutomationList> alist = ac->alist();
+
+                XMLNode & before = alist->get_state ();
+                bool const things_moved = alist->move_ranges (movements);
+                if (things_moved) {
+                        _session.add_command (new MementoCommand<AutomationList> (
+                                                      *alist.get(), &before, &alist->get_state ()));
+                }
+        }
 
        /* move processor automation */
        _track->foreach_processor (boost::bind (&Diskstream::move_processor_automation, this, _1, movements_frames));
@@ -526,75 +640,36 @@ Diskstream::check_record_status (framepos_t transport_frame, bool can_record)
        if (possibly_recording == last_possibly_recording) {
                return;
        }
+
+        framecnt_t existing_material_offset = _session.worst_playback_latency();
+
         if (possibly_recording == fully_rec_enabled) {
 
                 if (last_possibly_recording == fully_rec_enabled) {
                         return;
                 }
 
-                /* we transitioned to recording. lets see if its transport based or a punch */
-                
-               first_recordable_frame = transport_frame + _capture_offset;
+               capture_start_frame = _session.transport_frame();
+               first_recordable_frame = capture_start_frame + _capture_offset;
                last_recordable_frame = max_framepos;
-               capture_start_frame = transport_frame;
-
-                if (change & transport_rolling) {
-
-                        /* transport-change (started rolling) */
-                        
-                       if (_alignment_style == ExistingMaterial) {
-                                
-                                /* there are two delays happening:
-                                   
-                                   1) inbound, represented by _capture_offset
-                                   2) outbound, represented by _session.worst_output_latency()
-
-                                   the first sample to record occurs when the larger of these
-                                   two has elapsed, since they occur in parallel.
-
-                                   since we've already added _capture_offset, just add the
-                                   difference if _session.worst_output_latency() is larger.
-                                */
-
-                                if (_capture_offset < _session.worst_output_latency()) {
-                                        first_recordable_frame += (_session.worst_output_latency() - _capture_offset);
-                                } 
-                        } else {
-                               first_recordable_frame += _roll_delay;
-                       }
-                        
-                } else {
-
-                        /* punch in */
-
-                       if (_alignment_style == ExistingMaterial) {
-
-                               /* There are two kinds of punch:
-                                   
-                                   manual punch in happens at the correct transport frame
-                                   because the user hit a button. but to get alignment correct 
-                                   we have to back up the position of the new region to the 
-                                   appropriate spot given the roll delay.
-
-                                   autopunch toggles recording at the precise
-                                  transport frame, and then the DS waits
-                                  to start recording for a time that depends
-                                  on the output latency.
 
-                                   XXX: BUT THIS CODE DOESN'T DIFFERENTIATE !!!
-
-                               */
-
-                                if (_capture_offset < _session.worst_output_latency()) {
-                                        /* see comment in ExistingMaterial block above */
-                                        first_recordable_frame += (_session.worst_output_latency() - _capture_offset);
-                                }
-
-                       } else {
-                               capture_start_frame -= _roll_delay;
-                       }
+                DEBUG_TRACE (DEBUG::CaptureAlignment, string_compose ("%1: @ %7 (%9) FRF = %2 CSF = %4 CO = %5, EMO = %6 RD = %8 WOL %10 WTL %11\n",
+                                                                      name(), first_recordable_frame, last_recordable_frame, capture_start_frame,
+                                                                      _capture_offset,
+                                                                      existing_material_offset,
+                                                                      transport_frame,
+                                                                      _roll_delay,
+                                                                      _session.transport_frame(),
+                                                                      _session.worst_output_latency(),
+                                                                      _session.worst_track_latency()));
+
+
+                if (_alignment_style == ExistingMaterial) {
+                        first_recordable_frame += existing_material_offset;
+                        DEBUG_TRACE (DEBUG::CaptureAlignment, string_compose ("\tshift FRF by EMO %1\n",
+                                                                              first_recordable_frame));
                 }
-                
+
                 prepare_record_status (capture_start_frame);
 
         } else {
@@ -602,21 +677,21 @@ Diskstream::check_record_status (framepos_t transport_frame, bool can_record)
                 if (last_possibly_recording == fully_rec_enabled) {
 
                         /* we were recording last time */
-                        
+
                         if (change & transport_rolling) {
-                                /* transport-change (stopped rolling): last_recordable_frame was set in ::prepare_to_stop() */
-                                
+
+                                /* transport-change (stopped rolling): last_recordable_frame was set in ::prepare_to_stop(). We
+                                   had to set it there because we likely rolled past the stopping point to declick out,
+                                   and then backed up.
+                                 */
+
                         } else {
                                 /* punch out */
-                                
-                                last_recordable_frame = transport_frame + _capture_offset;
-                                
+
+                                last_recordable_frame = _session.transport_frame() + _capture_offset;
+
                                 if (_alignment_style == ExistingMaterial) {
-                                        if (_session.worst_output_latency() > _capture_offset) {
-                                                last_recordable_frame += (_session.worst_output_latency() - _capture_offset);
-                                        }
-                                } else {
-                                        last_recordable_frame += _roll_delay;
+                                        last_recordable_frame += existing_material_offset;
                                 }
                         }
                 }
@@ -633,7 +708,7 @@ Diskstream::route_going_away ()
 
 void
 Diskstream::calculate_record_range(OverlapType ot, framepos_t transport_frame, framecnt_t nframes,
-                                  nframes_t& rec_nframes, nframes_t& rec_offset)
+                                  framecnt_t & rec_nframes, framecnt_t & rec_offset)
 {
        switch (ot) {
        case OverlapNone:
@@ -674,6 +749,10 @@ Diskstream::calculate_record_range(OverlapType ot, framepos_t transport_frame, f
                rec_offset = first_recordable_frame - transport_frame;
                break;
        }
+
+        DEBUG_TRACE (DEBUG::CaptureAlignment, string_compose ("%1 rec? %2 @ %3 (for %4) FRF %5 LRF %6 : rf %7 @ %8\n",
+                                                              _name, enum_2_string (ot), transport_frame, nframes,
+                                                              first_recordable_frame, last_recordable_frame, rec_nframes, rec_offset));
 }
 
 void