refactor MIDISceneChange color property addition by moving it into SceneChange to...
[ardour.git] / libs / ardour / diskstream.cc
index 97780972f8d20e3fe3a8e7fd9b5389c1ec02f240..e24e67895936fe03c2be6d3c0312de0ba1e54da6 100644 (file)
 #include <cstdlib>
 #include <ctime>
 #include <sys/stat.h>
-#include <sys/mman.h>
 
+#include <glibmm/threads.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"
 #include "ardour/debug.h"
 #include "ardour/diskstream.h"
-#include "ardour/utils.h"
-#include "ardour/configuration.h"
-#include "ardour/audiofilesource.h"
-#include "ardour/send.h"
+#include "ardour/io.h"
 #include "ardour/pannable.h"
-#include "ardour/panner_shell.h"
 #include "ardour/playlist.h"
-#include "ardour/cycle_timer.h"
-#include "ardour/region.h"
-#include "ardour/panner.h"
 #include "ardour/session.h"
-#include "ardour/io.h"
 #include "ardour/track.h"
 
 #include "i18n.h"
@@ -68,7 +58,7 @@ using namespace PBD;
  * default from configuration_vars.h).  0 is not a good value for
  * allocating buffer sizes..
  */
-ARDOUR::framecnt_t Diskstream::disk_io_chunk_frames = 1024 * 256;
+ARDOUR::framecnt_t Diskstream::disk_io_chunk_frames = 1024 * 256 / sizeof (Sample);
 
 PBD::Signal0<void>                Diskstream::DiskOverrun;
 PBD::Signal0<void>                Diskstream::DiskUnderrun;
@@ -82,7 +72,6 @@ Diskstream::Diskstream (Session &sess, const string &name, Flag flag)
         , _actual_speed (1.0f)
         , _buffer_reallocation_required (false)
         , _seek_required (false)
-        , force_refill (false)
         , capture_start_frame (0)
         , capture_captured (0)
         , was_recording (false)
@@ -93,7 +82,7 @@ Diskstream::Diskstream (Session &sess, const string &name, Flag flag)
         , last_recordable_frame (max_framepos)
         , last_possibly_recording (0)
         , _alignment_style (ExistingMaterial)
-        , _scrubbing (false)
+        , _alignment_choice (Automatic)
         , _slaved (false)
         , loop_location (0)
         , overwrite_frame (0)
@@ -106,12 +95,7 @@ Diskstream::Diskstream (Session &sess, const string &name, Flag flag)
         , _target_speed (_speed)
         , file_frame (0)
         , playback_sample (0)
-        , playback_distance (0)
-        , _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)
 {
@@ -126,7 +110,6 @@ Diskstream::Diskstream (Session& sess, const XMLNode& /*node*/)
         , _actual_speed (1.0f)
         , _buffer_reallocation_required (false)
         , _seek_required (false)
-        , force_refill (false)
         , capture_start_frame (0)
         , capture_captured (0)
         , was_recording (false)
@@ -137,7 +120,7 @@ Diskstream::Diskstream (Session& sess, const XMLNode& /*node*/)
         , last_recordable_frame (max_framepos)
         , last_possibly_recording (0)
         , _alignment_style (ExistingMaterial)
-        , _scrubbing (false)
+        , _alignment_choice (Automatic)
         , _slaved (false)
         , loop_location (0)
         , overwrite_frame (0)
@@ -150,12 +133,7 @@ Diskstream::Diskstream (Session& sess, const XMLNode& /*node*/)
         , _target_speed (_speed)
         , file_frame (0)
         , playback_sample (0)
-        , playback_distance (0)
-        , _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)
 {
@@ -181,9 +159,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));
 }
@@ -191,9 +170,16 @@ Diskstream::set_track (Track* t)
 void
 Diskstream::handle_input_change (IOChange change, void * /*src*/)
 {
-       Glib::Mutex::Lock lm (state_lock);
+       Glib::Threads::Mutex::Lock lm (state_lock);
+
+        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 (change.type & IOChange::ConfigurationChanged) {
                 if (!(input_change_pending.type & change.type)) {
                         input_change_pending.type = IOChange::Type (input_change_pending.type | change.type);
                         _session.request_input_change_handling ();
@@ -206,7 +192,7 @@ Diskstream::non_realtime_set_speed ()
 {
        if (_buffer_reallocation_required)
        {
-               Glib::Mutex::Lock lm (state_lock);
+               Glib::Threads::Mutex::Lock lm (state_lock);
                allocate_temporary_buffers ();
 
                _buffer_reallocation_required = false;
@@ -237,8 +223,8 @@ Diskstream::realtime_set_speed (double sp, bool global)
 
        if (new_speed != _actual_speed) {
 
-               framecnt_t required_wrap_size = (framecnt_t) floor (_session.get_block_size() *
-                                                                  fabs (new_speed)) + 1;
+               framecnt_t required_wrap_size = (framecnt_t) ceil (_session.get_block_size() *
+                                                                  fabs (new_speed)) + 2;
 
                if (required_wrap_size > wrap_buffer_size) {
                        _buffer_reallocation_required = true;
@@ -266,23 +252,59 @@ Diskstream::set_capture_offset ()
                return;
        }
 
-       _capture_offset = _io->latency();
-        DEBUG_TRACE (DEBUG::CaptureAlignment, string_compose ("%1: using IO latency, capture offset set to %2\n", name(), _capture_offset));
+       switch (_alignment_style) {
+       case ExistingMaterial:
+               _capture_offset = _io->latency();
+               break;
+
+       case CaptureTime:
+       default:
+               _capture_offset = 0;
+               break;
+       }
+
+        DEBUG_TRACE (DEBUG::CaptureAlignment, string_compose ("%1: using IO latency, capture offset set to %2 with style = %3\n", name(), _capture_offset, enum_2_string (_alignment_style)));
 }
 
+
 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;
+               set_capture_offset ();
                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)
 {
@@ -303,7 +325,7 @@ Diskstream::set_loop (Location *location)
 ARDOUR::framepos_t
 Diskstream::get_capture_start_frame (uint32_t n) const
 {
-       Glib::Mutex::Lock lm (capture_info_lock);
+       Glib::Threads::Mutex::Lock lm (capture_info_lock);
 
        if (capture_info.size() > n) {
                /* this is a completed capture */
@@ -317,12 +339,12 @@ Diskstream::get_capture_start_frame (uint32_t n) const
 ARDOUR::framecnt_t
 Diskstream::get_captured_frames (uint32_t n) const
 {
-       Glib::Mutex::Lock lm (capture_info_lock);
+       Glib::Threads::Mutex::Lock lm (capture_info_lock);
 
        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;
        }
@@ -344,7 +366,7 @@ Diskstream::use_playlist (boost::shared_ptr<Playlist> playlist)
         bool prior_playlist = false;
 
        {
-               Glib::Mutex::Lock lm (state_lock);
+               Glib::Threads::Mutex::Lock lm (state_lock);
 
                if (playlist == _playlist) {
                        return 0;
@@ -424,17 +446,14 @@ Diskstream::set_name (const string& str)
        if (_name != str) {
                assert(playlist());
                playlist()->set_name (str);
-
                SessionObject::set_name(str);
-
-               if (!in_set_state && recordable()) {
-                       /* rename existing capture files so that they have the correct name */
-                       return rename_write_sources ();
-               } else {
-                       return false;
-               }
        }
+       return true;
+}
 
+bool
+Diskstream::set_write_source_name (const std::string& str) {
+       _write_source_name = str;
        return true;
 }
 
@@ -452,11 +471,12 @@ Diskstream::get_state ()
        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;
 }
 
@@ -470,33 +490,27 @@ Diskstream::set_state (const XMLNode& node, int /*version*/)
        }
 
        if (deprecated_io_node) {
-               if ((prop = deprecated_io_node->property ("id")) != 0) {
-                       _id = prop->value ();
-               }
+               set_id (*deprecated_io_node);
        } else {
-               if ((prop = node.property ("id")) != 0) {
-                       _id = prop->value ();
-               }
+               set_id (node);
        }
 
        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 (find_and_use_playlist (prop->value())) {
+               return -1;
        }
 
        if ((prop = node.property ("speed")) != 0) {
@@ -517,11 +531,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;
        }
@@ -538,14 +552,14 @@ Diskstream::playlist_ranges_moved (list< Evoral::RangeMove<framepos_t> > const &
        /* move panner automation */
        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) {
@@ -573,7 +587,7 @@ Diskstream::move_processor_automation (boost::weak_ptr<Processor> p, list< Evora
 
        set<Evoral::Parameter> const a = processor->what_can_be_automated ();
 
-       for (set<Evoral::Parameter>::iterator i = a.begin (); i != a.end (); ++i) {
+       for (set<Evoral::Parameter>::const_iterator i = a.begin (); i != a.end (); ++i) {
                boost::shared_ptr<AutomationList> al = processor->automation_control(*i)->alist();
                XMLNode & before = al->get_state ();
                bool const things_moved = al->move_ranges (movements);
@@ -596,101 +610,75 @@ Diskstream::check_record_status (framepos_t transport_frame, bool can_record)
        const int transport_rolling = 0x4;
        const int track_rec_enabled = 0x2;
        const int global_rec_enabled = 0x1;
-        const int fully_rec_enabled = (transport_rolling|track_rec_enabled|global_rec_enabled);
+       const int fully_rec_enabled = (transport_rolling|track_rec_enabled|global_rec_enabled);
 
        /* merge together the 3 factors that affect record status, and compute
-          what has changed.
-       */
+        * what has changed.
+        */
 
        rolling = _session.transport_speed() != 0.0f;
-       possibly_recording = (rolling << 2) | (record_enabled() << 1) | can_record;
+       possibly_recording = (rolling << 2) | ((int)record_enabled() << 1) | (int)can_record;
        change = possibly_recording ^ last_possibly_recording;
 
        if (possibly_recording == last_possibly_recording) {
                return;
        }
-        if (possibly_recording == fully_rec_enabled) {
 
-                if (last_possibly_recording == fully_rec_enabled) {
-                        return;
-                }
+       const framecnt_t existing_material_offset = _session.worst_playback_latency();
 
-                /* we transitioned to recording. lets see if its transport based or a punch */
-                
-               first_recordable_frame = transport_frame + _capture_offset;
+       if (possibly_recording == fully_rec_enabled) {
+
+               if (last_possibly_recording == fully_rec_enabled) {
+                       return;
+               }
+
+               capture_start_frame = _session.transport_frame();
+               first_recordable_frame = capture_start_frame + _capture_offset;
                last_recordable_frame = max_framepos;
-               capture_start_frame = transport_frame;
 
-                DEBUG_TRACE (DEBUG::CaptureAlignment, string_compose ("%1: @ %7 basic FRF = %2 LRF = %3 CSF = %4 CO = %5, WLO = %6\n",
+                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(),
-                                                                      transport_frame));
-
-                
-
-                if (change & transport_rolling) {
-
-                        /* transport-change (started rolling) */
-                        
-                       if (_alignment_style == ExistingMaterial) {
-                                
-                                /* audio played by ardour will take (up to) _session.worst_output_latency() ("WOL") to
-                                   appear at the speakers; audio played at the time when it does appear at
-                                   the speakers will take _capture_offset to arrive back here. we've
-                                   already added _capture_offset, so now add WOL.
-                                */
-                                
-                                first_recordable_frame += _session.worst_output_latency();
-                                DEBUG_TRACE (DEBUG::CaptureAlignment, string_compose ("\tROLL: shift FRF by delta between WOL %1\n",
-                                                                                      first_recordable_frame));
-                        } else {
-                               first_recordable_frame += _roll_delay;
-                                DEBUG_TRACE (DEBUG::CaptureAlignment, string_compose ("\tROLL: shift FRF by roll delay of %1 to %2\n",
-                                                                                      _roll_delay, first_recordable_frame));
-                       }
-                        
-                } else {
-
-                        /* punch in */
-
-                       if (_alignment_style == ExistingMaterial) {
-
-                                /* see comment in ExistingMaterial block above */
-                                first_recordable_frame += _session.worst_output_latency();
-                                DEBUG_TRACE (DEBUG::CaptureAlignment, string_compose ("\tMANUAL PUNCH: shift FRF by delta between WOL and CO to %1\n",
-                                                                                      first_recordable_frame));
-                       } else {
-                               capture_start_frame -= _roll_delay;
-                                DEBUG_TRACE (DEBUG::CaptureAlignment, string_compose ("\tPUNCH: shift CSF by roll delay of %1 to %2\n",
-                                                                                      _roll_delay, capture_start_frame));
-                       }
-                }
-                
-                prepare_record_status (capture_start_frame);
+                                                                      _session.worst_track_latency()));
 
-        } else {
 
-                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() */
-                                
-                        } else {
-                                /* punch out */
-                                
-                                last_recordable_frame = transport_frame + _capture_offset;
-                                
-                                if (_alignment_style == ExistingMaterial) {
-                                        last_recordable_frame += _session.worst_input_latency();
-                                } else {
-                                        last_recordable_frame += _roll_delay;
-                                }
-                        }
+                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 {
+
+               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(). 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 = _session.transport_frame() + _capture_offset;
+
+                               if (_alignment_style == ExistingMaterial) {
+                                       last_recordable_frame += existing_material_offset;
+                               }
+                       }
+               }
+       }
 
        last_possibly_recording = possibly_recording;
 }
@@ -702,15 +690,15 @@ Diskstream::route_going_away ()
 }
 
 void
-Diskstream::calculate_record_range(OverlapType ot, framepos_t transport_frame, framecnt_t nframes,
-                                  framecnt_t & rec_nframes, framecnt_t & rec_offset)
+Diskstream::calculate_record_range (Evoral::OverlapType ot, framepos_t transport_frame, framecnt_t nframes,
+                                   framecnt_t & rec_nframes, framecnt_t & rec_offset)
 {
        switch (ot) {
-       case OverlapNone:
+       case Evoral::OverlapNone:
                rec_nframes = 0;
                break;
 
-       case OverlapInternal:
+       case Evoral::OverlapInternal:
                /*     ----------    recrange
                         |---|       transrange
                */
@@ -718,7 +706,7 @@ Diskstream::calculate_record_range(OverlapType ot, framepos_t transport_frame, f
                rec_offset = 0;
                break;
 
-       case OverlapStart:
+       case Evoral::OverlapStart:
                /*    |--------|    recrange
                -----|          transrange
                */
@@ -728,7 +716,7 @@ Diskstream::calculate_record_range(OverlapType ot, framepos_t transport_frame, f
                }
                break;
 
-       case OverlapEnd:
+       case Evoral::OverlapEnd:
                /*    |--------|    recrange
                         |--------  transrange
                */
@@ -736,7 +724,7 @@ Diskstream::calculate_record_range(OverlapType ot, framepos_t transport_frame, f
                rec_offset = 0;
                break;
 
-       case OverlapExternal:
+       case Evoral::OverlapExternal:
                /*    |--------|    recrange
                    --------------  transrange
                */
@@ -744,10 +732,43 @@ 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
+Diskstream::prepare_to_stop (framepos_t transport_frame, framepos_t audible_frame)
+{
+       switch (_alignment_style) {
+       case ExistingMaterial:
+               last_recordable_frame = transport_frame + _capture_offset;
+               DEBUG_TRACE (DEBUG::CaptureAlignment, string_compose("%1: prepare to stop sets last recordable frame to %2 + %3 = %4\n", _name, transport_frame, _capture_offset, last_recordable_frame));
+               break;
+
+       case CaptureTime:
+               last_recordable_frame = audible_frame; // note that capture_offset is zero
+               /* we may already have captured audio before the last_recordable_frame (audible frame),
+                  so deal with this.
+               */
+               if (last_recordable_frame > capture_start_frame) {
+                       capture_captured = min (capture_captured, last_recordable_frame - capture_start_frame);
+               }
+               DEBUG_TRACE (DEBUG::CaptureAlignment, string_compose("%1: prepare to stop sets last recordable frame to audible frame @ %2\n", _name, audible_frame));
+               break;
+       }
+
+}
+
+void
+Diskstream::engage_record_enable ()
+{
+       g_atomic_int_set (&_record_enabled, 1);
 }
 
 void
-Diskstream::prepare_to_stop (framepos_t pos)
+Diskstream::disengage_record_enable ()
 {
-        last_recordable_frame = pos + _capture_offset;
+       g_atomic_int_set (&_record_enabled, 0);
 }