Somewhat uncertain fix to playhead misbehaviour in rewind.
[ardour.git] / libs / ardour / diskstream.cc
index a600cce5e2ec9f17c643616994dcc676aaebaa38..df9d1a9b4df5c0dc84f747f1f93ab963c84c1b9f 100644 (file)
 #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"
 #include "ardour/panner.h"
 #include "ardour/session.h"
 #include "ardour/io.h"
-#include "ardour/route.h"
+#include "ardour/track.h"
 
 #include "i18n.h"
 #include <locale.h>
@@ -66,7 +68,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;
@@ -74,7 +76,7 @@ PBD::Signal0<void>                Diskstream::DiskUnderrun;
 Diskstream::Diskstream (Session &sess, const string &name, Flag flag)
        : SessionObject(sess, name)
         , i_am_the_modifier (0)
-        , _route (0)
+        , _track (0)
         , _record_enabled (0)
         , _visible_speed (1.0f)
         , _actual_speed (1.0f)
@@ -87,8 +89,8 @@ Diskstream::Diskstream (Session &sess, const string &name, Flag flag)
         , adjust_capture_position (0)
         , _capture_offset (0)
         , _roll_delay (0)
-        , first_recordable_frame (max_frames)
-        , last_recordable_frame (max_frames)
+        , first_recordable_frame (max_framepos)
+        , last_recordable_frame (max_framepos)
         , last_possibly_recording (0)
         , _alignment_style (ExistingMaterial)
         , _scrubbing (false)
@@ -96,9 +98,8 @@ Diskstream::Diskstream (Session &sess, const string &name, Flag flag)
         , loop_location (0)
         , overwrite_frame (0)
         , overwrite_offset (0)
-        , pending_overwrite (false)
+        , _pending_overwrite (false)
         , overwrite_queued (false)
-        , input_change_pending (NoChange)
         , wrap_buffer_size (0)
         , speed_buffer_size (0)
         , _speed (1.0)
@@ -111,9 +112,6 @@ Diskstream::Diskstream (Session &sess, const string &name, Flag flag)
         , in_set_state (false)
         , _persistent_alignment_style (ExistingMaterial)
         , first_input_change (true)
-        , scrub_start (0)
-        , scrub_buffer_size (0)
-        , scrub_offset (0)
         , _flags (flag)
 
 {
@@ -122,7 +120,7 @@ Diskstream::Diskstream (Session &sess, const string &name, Flag flag)
 Diskstream::Diskstream (Session& sess, const XMLNode& /*node*/)
        : SessionObject(sess, "unnamed diskstream")
         , i_am_the_modifier (0)
-        , _route (0)
+        , _track (0)
         , _record_enabled (0)
         , _visible_speed (1.0f)
         , _actual_speed (1.0f)
@@ -135,8 +133,8 @@ Diskstream::Diskstream (Session& sess, const XMLNode& /*node*/)
         , adjust_capture_position (0)
         , _capture_offset (0)
         , _roll_delay (0)
-        , first_recordable_frame (max_frames)
-        , last_recordable_frame (max_frames)
+        , first_recordable_frame (max_framepos)
+        , last_recordable_frame (max_framepos)
         , last_possibly_recording (0)
         , _alignment_style (ExistingMaterial)
         , _scrubbing (false)
@@ -144,9 +142,8 @@ Diskstream::Diskstream (Session& sess, const XMLNode& /*node*/)
         , loop_location (0)
         , overwrite_frame (0)
         , overwrite_offset (0)
-        , pending_overwrite (false)
+        , _pending_overwrite (false)
         , overwrite_queued (false)
-        , input_change_pending (NoChange)
         , wrap_buffer_size (0)
         , speed_buffer_size (0)
         , _speed (1.0)
@@ -159,9 +156,6 @@ Diskstream::Diskstream (Session& sess, const XMLNode& /*node*/)
         , in_set_state (false)
         , _persistent_alignment_style (ExistingMaterial)
         , first_input_change (true)
-        , scrub_start (0)
-        , scrub_buffer_size (0)
-        , scrub_offset (0)
         , _flags (Recordable)
 {
 }
@@ -176,19 +170,19 @@ Diskstream::~Diskstream ()
 }
 
 void
-Diskstream::set_route (Route& r)
+Diskstream::set_track (Track* t)
 {
-       _route = &r;
-       _io = _route->input();
+       _track = t;
+       _io = _track->input();
 
        ic_connection.disconnect();
        _io->changed.connect_same_thread (ic_connection, boost::bind (&Diskstream::handle_input_change, this, _1, _2));
 
-       input_change_pending = ConfigurationChanged;
+       input_change_pending = IOChange::ConfigurationChanged;
        non_realtime_input_change ();
        set_align_style_from_io ();
 
-       _route->Destroyed.connect_same_thread (*this, boost::bind (&Diskstream::route_going_away, this));
+       _track->Destroyed.connect_same_thread (*this, boost::bind (&Diskstream::route_going_away, this));
 }
 
 void
@@ -196,10 +190,12 @@ Diskstream::handle_input_change (IOChange change, void * /*src*/)
 {
        Glib::Mutex::Lock lm (state_lock);
 
-       if (!(input_change_pending & change)) {
-               input_change_pending = IOChange (input_change_pending|change);
-               _session.request_input_change_handling ();
-       }
+        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 ();
+                }
+        }
 }
 
 void
@@ -215,7 +211,7 @@ Diskstream::non_realtime_set_speed ()
 
        if (_seek_required) {
                if (speed() != 1.0f || speed() != -1.0f) {
-                       seek ((nframes_t) (_session.transport_frame() * (double) speed()), true);
+                       seek ((framepos_t) (_session.transport_frame() * (double) speed()), true);
                }
                else {
                        seek (_session.transport_frame(), true);
@@ -238,8 +234,8 @@ 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() *
-                                                                           fabs (new_speed)) + 1;
+               framecnt_t required_wrap_size = (framecnt_t) floor (_session.get_block_size() *
+                                                                  fabs (new_speed)) + 1;
 
                if (required_wrap_size > wrap_buffer_size) {
                        _buffer_reallocation_required = true;
@@ -295,59 +291,53 @@ Diskstream::set_loop (Location *location)
 
        loop_location = location;
 
-        LoopSet (location); /* EMIT SIGNAL */
+       LoopSet (location); /* EMIT SIGNAL */
        return 0;
 }
 
-ARDOUR::nframes_t
-Diskstream::get_capture_start_frame (uint32_t n)
+/** Get the start position (in session frames) of the nth capture in the current pass */
+ARDOUR::framepos_t
+Diskstream::get_capture_start_frame (uint32_t n) const
 {
        Glib::Mutex::Lock lm (capture_info_lock);
 
        if (capture_info.size() > n) {
+               /* this is a completed capture */
                return capture_info[n]->start;
-       }
-       else {
+       } else {
+               /* this is the currently in-progress capture */
                return capture_start_frame;
        }
 }
 
-ARDOUR::nframes_t
-Diskstream::get_captured_frames (uint32_t n)
+ARDOUR::framecnt_t
+Diskstream::get_captured_frames (uint32_t n) const
 {
        Glib::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;
        }
 }
 
 void
-Diskstream::set_roll_delay (ARDOUR::nframes_t nframes)
+Diskstream::set_roll_delay (ARDOUR::framecnt_t nframes)
 {
        _roll_delay = nframes;
 }
 
-void
-Diskstream::set_speed (double sp)
-{
-       _session.request_diskstream_speed (*this, sp);
-
-       /* to force a rebuffering at the right place */
-       playlist_modified();
-}
-
 int
 Diskstream::use_playlist (boost::shared_ptr<Playlist> playlist)
 {
         if (!playlist) {
-                return;
+                return 0;
         }
 
-        bool no_prior_playlist = true;
+        bool prior_playlist = false;
 
        {
                Glib::Mutex::Lock lm (state_lock);
@@ -360,7 +350,7 @@ Diskstream::use_playlist (boost::shared_ptr<Playlist> playlist)
 
                if (_playlist) {
                        _playlist->release();
-                        no_prior_playlist = false;
+                        prior_playlist = true;
                }
 
                _playlist = playlist;
@@ -372,7 +362,7 @@ Diskstream::use_playlist (boost::shared_ptr<Playlist> playlist)
 
                _playlist->ContentsChanged.connect_same_thread (playlist_connections, boost::bind (&Diskstream::playlist_modified, this));
                _playlist->DropReferences.connect_same_thread (playlist_connections, boost::bind (&Diskstream::playlist_deleted, this, boost::weak_ptr<Playlist>(_playlist)));
-               _playlist->RangesMoved.connect_same_thread (playlist_connections, boost::bind (&Diskstream::playlist_ranges_moved, this, _1));
+               _playlist->RangesMoved.connect_same_thread (playlist_connections, boost::bind (&Diskstream::playlist_ranges_moved, this, _1, _2));
        }
 
        /* don't do this if we've already asked for it *or* if we are setting up
@@ -380,8 +370,8 @@ Diskstream::use_playlist (boost::shared_ptr<Playlist> playlist)
           take care of the buffer refill.
        */
 
-       if (!overwrite_queued && no_prior_playlist) {
-               _session.request_overwrite_buffer (this);
+       if (!overwrite_queued && prior_playlist) {
+               _session.request_overwrite_buffer (_track);
                overwrite_queued = true;
        }
 
@@ -401,7 +391,7 @@ void
 Diskstream::playlist_modified ()
 {
        if (!i_am_the_modifier && !overwrite_queued) {
-               _session.request_overwrite_buffer (this);
+               _session.request_overwrite_buffer (_track);
                overwrite_queued = true;
        }
 }
@@ -445,21 +435,18 @@ Diskstream::set_name (const string& str)
 }
 
 void
-Diskstream::remove_region_from_last_capture (boost::weak_ptr<Region> wregion)
+Diskstream::playlist_ranges_moved (list< Evoral::RangeMove<framepos_t> > const & movements_frames, bool from_undo)
 {
-       boost::shared_ptr<Region> region (wregion.lock());
-
-       if (!region) {
+       /* If we're coming from an undo, it will have handled
+          automation undo (it must, since automation-follows-regions
+          can lose automation data).  Hence we can do nothing here.
+       */
+       
+       if (from_undo) {
                return;
        }
-
-       _last_capture_regions.remove (region);
-}
-
-void
-Diskstream::playlist_ranges_moved (list< Evoral::RangeMove<framepos_t> > const & movements_frames)
-{
-       if (!_route || Config->get_automation_follows_regions () == false) {
+       
+       if (!_track || Config->get_automation_follows_regions () == false) {
                return;
        }
 
@@ -473,19 +460,26 @@ Diskstream::playlist_ranges_moved (list< Evoral::RangeMove<framepos_t> > const &
        }
 
        /* move panner automation */
-       boost::shared_ptr<Panner> p = _route->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 ();
-                       pan_alist->move_ranges (movements);
-                       _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 */
-       _route->foreach_processor (boost::bind (&Diskstream::move_processor_automation, this, _1, movements_frames));
+       _track->foreach_processor (boost::bind (&Diskstream::move_processor_automation, this, _1, movements_frames));
 }
 
 void
@@ -497,8 +491,7 @@ Diskstream::move_processor_automation (boost::weak_ptr<Processor> p, list< Evora
        }
 
        list< Evoral::RangeMove<double> > movements;
-       for (list< Evoral::RangeMove<framepos_t> >::const_iterator i = movements_frames.begin();
-                  i != movements_frames.end(); ++i) {
+       for (list< Evoral::RangeMove<framepos_t> >::const_iterator i = movements_frames.begin(); i != movements_frames.end(); ++i) {
                movements.push_back(Evoral::RangeMove<double>(i->from, i->length, i->to));
        }
 
@@ -507,17 +500,19 @@ Diskstream::move_processor_automation (boost::weak_ptr<Processor> p, list< Evora
        for (set<Evoral::Parameter>::iterator i = a.begin (); i != a.end (); ++i) {
                boost::shared_ptr<AutomationList> al = processor->automation_control(*i)->alist();
                XMLNode & before = al->get_state ();
-               al->move_ranges (movements);
-               _session.add_command (
-                       new MementoCommand<AutomationList> (
-                               *al.get(), &before, &al->get_state ()
-                               )
-                       );
+               bool const things_moved = al->move_ranges (movements);
+               if (things_moved) {
+                       _session.add_command (
+                               new MementoCommand<AutomationList> (
+                                       *al.get(), &before, &al->get_state ()
+                                       )
+                               );
+               }
        }
 }
 
 void
-Diskstream::check_record_status (nframes_t transport_frame, nframes_t /*nframes*/, bool can_record)
+Diskstream::check_record_status (framepos_t transport_frame, bool can_record)
 {
        int possibly_recording;
        int rolling;
@@ -525,6 +520,7 @@ Diskstream::check_record_status (nframes_t transport_frame, nframes_t /*nframes*
        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);
 
        /* merge together the 3 factors that affect record status, and compute
           what has changed.
@@ -537,88 +533,101 @@ Diskstream::check_record_status (nframes_t transport_frame, nframes_t /*nframes*
        if (possibly_recording == last_possibly_recording) {
                return;
        }
+        if (possibly_recording == fully_rec_enabled) {
 
-       /* change state */
-
-       /* if per-track or global rec-enable turned on while the other was already on, we've started recording */
-
-       if (((change & track_rec_enabled) && record_enabled() && (!(change & global_rec_enabled) && can_record)) ||
-           ((change & global_rec_enabled) && can_record && (!(change & track_rec_enabled) && record_enabled()))) {
-
-               /* starting to record: compute first+last frames */
+                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;
-               last_recordable_frame = max_frames;
+               last_recordable_frame = max_framepos;
                capture_start_frame = transport_frame;
 
-               if (!(last_possibly_recording & transport_rolling) && (possibly_recording & transport_rolling)) {
-
-                       /* was stopped, now rolling (and recording) */
+                if (change & transport_rolling) {
 
+                        /* transport-change (started rolling) */
+                        
                        if (_alignment_style == ExistingMaterial) {
-                         
-                               first_recordable_frame += _session.worst_output_latency();
-                               
-                               DEBUG_TRACE (DEBUG::Latency, string_compose ("Offset rec from stop. Capture offset: %1 Worst O/P Latency: %2 Roll Delay: %3 First Recordable Frame: %4 Transport Frame: %5\n",
-                                                                            _capture_offset, _session.worst_output_latency(), _roll_delay, first_recordable_frame, transport_frame));
-                       } else {
+                                
+                                /* 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 {
+                       }
+                        
+                } else {
 
-                       /* was rolling, but record state changed */
+                        /* punch in */
 
                        if (_alignment_style == ExistingMaterial) {
 
-                               /* 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
+                               /* 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.
-                               */
-                               
-                               first_recordable_frame += _session.worst_output_latency();
-                               
-                               DEBUG_TRACE (DEBUG::Latency, string_compose ("Punch in manual/auto. Capture offset: %1 Worst O/P Latency: %2 Roll Delay: %3 First Recordable Frame: %4 Transport Frame: %5\n",
-                                                                            _capture_offset, _session.worst_output_latency(), _roll_delay, first_recordable_frame, transport_frame));
-                       } else {
-
-                               if (_session.config.get_punch_in()) {
-                                       first_recordable_frame += _roll_delay;
-                               } else {
-                                       capture_start_frame -= _roll_delay;
-                               }
-                       }
-
-               }
 
-               prepare_record_status(capture_start_frame);
+                                   XXX: BUT THIS CODE DOESN'T DIFFERENTIATE !!!
 
-       } else if (!record_enabled() || !can_record) {
-
-               /* stop recording */
+                               */
 
-               last_recordable_frame = transport_frame + _capture_offset;
+                                if (_capture_offset < _session.worst_output_latency()) {
+                                        /* see comment in ExistingMaterial block above */
+                                        first_recordable_frame += (_session.worst_output_latency() - _capture_offset);
+                                }
 
-               if (_alignment_style == ExistingMaterial) {
-                       last_recordable_frame += _session.worst_output_latency();
-               } else {
-                       last_recordable_frame += _roll_delay;
-               }
-               
-               //first_recordable_frame = max_frames;
-               
-               DEBUG_TRACE (DEBUG::Latency, string_compose ("Stop record - %6 | %7. Capture offset: %1 Worst O/P Latency: %2 Roll Delay: %3 First Recordable Frame: %4 Transport Frame: %5\n",
-                                                            _capture_offset, _session.worst_output_latency(), _roll_delay, first_recordable_frame, transport_frame,
-                                                            can_record, record_enabled()));
-       }
+                       } else {
+                               capture_start_frame -= _roll_delay;
+                       }
+                }
+                
+                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() */
+                                
+                        } else {
+                                /* punch out */
+                                
+                                last_recordable_frame = 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_possibly_recording = possibly_recording;
 }
@@ -630,8 +639,8 @@ Diskstream::route_going_away ()
 }
 
 void
-Diskstream::calculate_record_range(OverlapType ot, sframes_t transport_frame, nframes_t nframes,
-                                  nframes_t& rec_nframes, nframes_t& rec_offset)
+Diskstream::calculate_record_range(OverlapType ot, framepos_t transport_frame, framecnt_t nframes,
+                                  framecnt_t & rec_nframes, framecnt_t & rec_offset)
 {
        switch (ot) {
        case OverlapNone:
@@ -673,3 +682,9 @@ Diskstream::calculate_record_range(OverlapType ot, sframes_t transport_frame, nf
                break;
        }
 }
+
+void
+Diskstream::prepare_to_stop (framepos_t pos)
+{
+        last_recordable_frame = pos + _capture_offset;
+}