[Summary] Fixed race condition: "should_do_transport_work" must not be dropped to...
[ardour.git] / libs / ardour / session_transport.cc
index 19f86eb2b30a1e3200df00a5a396dce4ce951da7..4e93565f1159f11530f1126316a0c9d6ed9f2b97 100644 (file)
@@ -139,8 +139,8 @@ Session::request_track_speed (Track* tr, double speed)
 void
 Session::request_stop (bool abort, bool clear_state)
 {
-       SessionEvent* ev = new SessionEvent (SessionEvent::SetTransportSpeed, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0, abort, clear_state);
-       DEBUG_TRACE (DEBUG::Transport, string_compose ("Request transport stop, abort = %1, clear state = %2\n", abort, clear_state));
+       SessionEvent* ev = new SessionEvent (SessionEvent::SetTransportSpeed, SessionEvent::Add, SessionEvent::Immediate, audible_frame(), 0.0, abort, clear_state);
+       DEBUG_TRACE (DEBUG::Transport, string_compose ("Request transport stop, audible %3 transport %4 abort = %1, clear state = %2\n", abort, clear_state, audible_frame(), _transport_frame));
        queue_event (ev);
 }
 
@@ -257,27 +257,12 @@ Session::realtime_stop (bool abort, bool clear_state)
        for (RouteList::iterator i = r->begin (); i != r->end(); ++i) {
                (*i)->realtime_handle_transport_stopped ();
        }
+       
+       DEBUG_TRACE (DEBUG::Transport, string_compose ("stop complete, auto-return scheduled for return to %1\n", _requested_return_frame));
 
-       if (actively_recording()) {
-
-               /* move the transport position back to where the
-                  request for a stop was noticed. we rolled
-                  past that point to pick up delayed input (and/or to delick)
-               */
-
-               if (worst_playback_latency() > current_block_size) {
-                       /* we rolled past the stop point to pick up data that had
-                          not yet arrived. move back to where the stop occured.
-                       */
-                       decrement_transport_position (current_block_size + (worst_input_latency() - current_block_size));
-               } else {
-                       decrement_transport_position (current_block_size);
-               }
-
-               /* the duration change is not guaranteed to have happened, but is likely */
-
-               todo = PostTransportWork (todo | PostTransportDuration);
-       }
+       /* the duration change is not guaranteed to have happened, but is likely */
+       
+       todo = PostTransportWork (todo | PostTransportDuration);
 
        if (abort) {
                todo = PostTransportWork (todo | PostTransportAbort);
@@ -399,6 +384,7 @@ Session::butler_transport_work ()
        }
 
        if (ptw & PostTransportLocate) {
+               DEBUG_TRACE (DEBUG::Transport, "nonrealtime locate invoked from BTW\n");
                non_realtime_locate ();
        }
 
@@ -460,6 +446,39 @@ Session::non_realtime_overwrite (int on_entry, bool& finished)
 void
 Session::non_realtime_locate ()
 {
+       DEBUG_TRACE (DEBUG::Transport, string_compose ("locate tracks to %1\n", _transport_frame));
+
+       if (Config->get_loop_is_mode() && get_play_loop()) {
+
+               Location *loc  = _locations->auto_loop_location();
+
+               if (!loc || (_transport_frame < loc->start() || _transport_frame >= loc->end())) {
+                       /* jumped out of loop range: stop tracks from looping,
+                          but leave loop (mode) enabled.
+                        */
+                       set_track_loop (false);
+
+               } else if (loc && Config->get_seamless_loop() &&
+                   ((loc->start() <= _transport_frame) ||
+                   (loc->end() > _transport_frame) ) ) {
+
+                       /* jumping to start of loop. This  might have been done before but it is
+                        * idempotent and cheap. Doing it here ensures that when we start playback
+                        * outside the loop we still flip tracks into the magic seamless mode
+                        * when needed.
+                        */
+                       set_track_loop (true);
+
+               } else if (loc) {
+                       set_track_loop (false);
+               }
+               
+       } else {
+
+               /* no more looping .. should have been noticed elsewhere */
+       }
+
+       
        boost::shared_ptr<RouteList> rl = routes.reader();
        for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
                (*i)->non_realtime_locate (_transport_frame);
@@ -474,7 +493,6 @@ Session::non_realtime_locate ()
        clear_clicks ();
 }
 
-
 void
 Session::non_realtime_stop (bool abort, int on_entry, bool& finished)
 {
@@ -558,7 +576,7 @@ Session::non_realtime_stop (bool abort, int on_entry, bool& finished)
        }
 
        bool const auto_return_enabled =
-               (!config.get_external_sync() && config.get_auto_return());
+               (!config.get_external_sync() && (config.get_auto_return() || abort));
 
        if (auto_return_enabled ||
            (ptw & PostTransportLocate) ||
@@ -618,6 +636,10 @@ Session::non_realtime_stop (bool abort, int on_entry, bool& finished)
                                                _transport_frame = _last_roll_location;
                                                do_locate = true;
                                        }
+                               } else if (abort) {
+
+                                       _transport_frame = _last_roll_location;
+                                       do_locate = true;
                                }
                        }
 
@@ -667,7 +689,7 @@ Session::non_realtime_stop (bool abort, int on_entry, bool& finished)
                _send_timecode_update = true;
                
                if (!dynamic_cast<MTC_Slave*>(_slave)) {
-                       _mmc->send (MIDI::MachineControlCommand (MIDI::MachineControl::cmdStop));
+                       send_immediate_mmc (MIDI::MachineControlCommand (MIDI::MachineControl::cmdStop));
 
                        /* This (::non_realtime_stop()) gets called by main
                           process thread, which will lead to confusion
@@ -688,9 +710,8 @@ Session::non_realtime_stop (bool abort, int on_entry, bool& finished)
                 * save state only if there's no slave or if it's not yet locked.
                 */
                if (!_slave || !_slave->locked()) {
-                       DEBUG_TRACE (DEBUG::Transport, X_("Butler PTW: pending save\n"));
-                       /* capture start has been changed, so save pending state */
-                       save_state ("", true);
+                       DEBUG_TRACE (DEBUG::Transport, X_("Butler PTW: requests save\n"));
+                       SaveSessionRequested (_current_snapshot_name);
                        saved = true;
                }
        }
@@ -702,7 +723,7 @@ Session::non_realtime_stop (bool abort, int on_entry, bool& finished)
        /* save the current state of things if appropriate */
 
        if (did_record && !saved) {
-               save_state (_current_snapshot_name);
+               SaveSessionRequested (_current_snapshot_name);
        }
 
        if (ptw & PostTransportStop) {
@@ -746,8 +767,10 @@ Session::check_declick_out ()
                        start_locate (pending_locate_frame, pending_locate_roll, pending_locate_flush);
                        transport_sub_state &= ~(PendingDeclickOut|PendingLocate);
                } else {
-                       stop_transport (pending_abort);
-                       transport_sub_state &= ~(PendingDeclickOut|PendingLocate);
+                       if (!(transport_sub_state & StopPendingCapture)) {
+                               stop_transport (pending_abort);
+                               transport_sub_state &= ~(PendingDeclickOut|PendingLocate);
+                       }
                }
 
        } else if (transport_sub_state & PendingLoopDeclickOut) {
@@ -759,16 +782,36 @@ Session::check_declick_out ()
 void
 Session::unset_play_loop ()
 {
-       play_loop = false;
-       clear_events (SessionEvent::AutoLoop);
-       clear_events (SessionEvent::AutoLoopDeclick);
+       if (play_loop) {
+               play_loop = false;
+               clear_events (SessionEvent::AutoLoop);
+               clear_events (SessionEvent::AutoLoopDeclick);
+               set_track_loop (false);
+               
+       
+               if (Config->get_seamless_loop()) {
+                       /* likely need to flush track buffers: this will locate us to wherever we are */
+                       add_post_transport_work (PostTransportLocate);
+                       _butler->schedule_transport_work ();
+               }
+       }
+}
+
+void
+Session::set_track_loop (bool yn)
+{
+       Location* loc = _locations->auto_loop_location ();
+
+       if (!loc) {
+               yn = false;
+       }
 
-       // set all tracks to NOT use internal looping
        boost::shared_ptr<RouteList> rl = routes.reader ();
+
        for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
                boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
                if (tr && !tr->hidden()) {
-                       tr->set_loop (0);
+                       tr->set_loop (yn ? loc : 0);
                }
        }
 }
@@ -796,30 +839,24 @@ Session::set_play_loop (bool yn, double speed)
        if (yn) {
 
                play_loop = true;
-
+               have_looped = false;
+               
                if (loc) {
 
                        unset_play_range ();
 
                        if (Config->get_seamless_loop()) {
-                               // set all tracks to use internal looping
-                               boost::shared_ptr<RouteList> rl = routes.reader ();
-                               for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
-                                       boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
-                                       if (tr && !tr->hidden()) {
-                                               tr->set_loop (loc);
-                                       }
-                               }
-                       }
-                       else {
-                               // set all tracks to NOT use internal looping
-                               boost::shared_ptr<RouteList> rl = routes.reader ();
-                               for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
-                                       boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
-                                       if (tr && !tr->hidden()) {
-                                               tr->set_loop (0);
-                                       }
+                               if (!Config->get_loop_is_mode()) {
+                                       /* set all tracks to use internal looping */
+                                       set_track_loop (true);
+                               } else {
+                                       /* we will do this in the locate to the start OR when we hit the end 
+                                        * of the loop for the first time 
+                                        */
                                }
+                       } else {
+                               /* set all tracks to NOT use internal looping */
+                               set_track_loop (false);
                        }
 
                        /* Put the delick and loop events in into the event list.  The declick event will
@@ -874,6 +911,11 @@ Session::flush_all_inserts ()
 void
 Session::start_locate (framepos_t target_frame, bool with_roll, bool with_flush, bool with_loop, bool force)
 {
+       if (target_frame < 0) {
+               error << _("Locate called for negative sample position - ignored") << endmsg;
+               return;
+       }
+
        if (synced_to_engine()) {
 
                double sp;
@@ -934,6 +976,8 @@ Session::micro_locate (framecnt_t distance)
 void
 Session::locate (framepos_t target_frame, bool with_roll, bool with_flush, bool for_seamless_loop, bool force, bool with_mmc)
 {
+       bool need_butler = false;
+       
        /* Locates for seamless looping are fairly different from other
         * locates. They assume that the diskstream buffers for each track
         * already have the correct data in them, and thus there is no need to
@@ -942,13 +986,16 @@ Session::locate (framepos_t target_frame, bool with_roll, bool with_flush, bool
         * changes in the value of _transport_frame. 
         */
 
+       DEBUG_TRACE (DEBUG::Transport, string_compose ("rt-locate to %1, roll %2 flush %3 seamless %4 force %5 mmc %6\n",
+                                                      target_frame, with_roll, with_flush, for_seamless_loop, force, with_mmc));
+       
        if (actively_recording() && !for_seamless_loop) {
                return;
        }
 
        if (!force && _transport_frame == target_frame && !loop_changing && !for_seamless_loop) {
                if (with_roll) {
-                       set_transport_speed (1.0, false);
+                       set_transport_speed (1.0, 0, false);
                }
                loop_changing = false;
                Located (); /* EMIT SIGNAL */
@@ -988,7 +1035,7 @@ Session::locate (framepos_t target_frame, bool with_roll, bool with_flush, bool
         */
 
        bool transport_was_stopped = !transport_rolling();
-
+       
        if (transport_was_stopped && (!auto_play_legal || !config.get_auto_play()) && !with_roll && !(synced_to_engine() && play_loop)) {
                realtime_stop (false, true); // XXX paul - check if the 2nd arg is really correct
                transport_was_stopped = true;
@@ -1006,8 +1053,8 @@ Session::locate (framepos_t target_frame, bool with_roll, bool with_flush, bool
                }
 
                add_post_transport_work (todo);
-               _butler->schedule_transport_work ();
-
+               need_butler = true;
+               
        } else {
 
                /* this is functionally what clear_clicks() does but with a tentative lock */
@@ -1046,8 +1093,18 @@ Session::locate (framepos_t target_frame, bool with_roll, bool with_flush, bool
 
                                // located outside the loop: cancel looping directly, this is called from event handling context
 
+                               have_looped = false;
+                               
                                if (!Config->get_loop_is_mode()) {
                                        set_play_loop (false, _transport_speed);
+                               } else {
+                                       if (Config->get_seamless_loop()) {
+                                               /* this will make the non_realtime_locate() in the butler
+                                                  which then causes seek() in tracks actually do the right
+                                                  thing.
+                                               */
+                                               set_track_loop (false);
+                                       }
                                }
                                
                        } else if (_transport_frame == al->start()) {
@@ -1056,6 +1113,19 @@ Session::locate (framepos_t target_frame, bool with_roll, bool with_flush, bool
 
                                if (for_seamless_loop) {
 
+                                       if (!have_looped) {
+                                               /* first time */
+                                               if (_last_roll_location != al->start()) {
+                                                       /* didn't start at loop start - playback must have
+                                                        * started before loop since we've now hit the loop
+                                                        * end.
+                                                        */
+                                                       add_post_transport_work (PostTransportLocate);
+                                                       need_butler = true;
+                                               }
+                                                   
+                                       }
+                               
                                        // this is only necessary for seamless looping
                                        
                                        boost::shared_ptr<RouteList> rl = routes.reader();
@@ -1076,6 +1146,10 @@ Session::locate (framepos_t target_frame, bool with_roll, bool with_flush, bool
                }
        }
 
+       if (need_butler) {
+               _butler->schedule_transport_work ();
+       }
+
        loop_changing = false;
 
        _send_timecode_update = true;
@@ -1093,7 +1167,7 @@ Session::locate (framepos_t target_frame, bool with_roll, bool with_flush, bool
  *  @param speed New speed
  */
 void
-Session::set_transport_speed (double speed, bool abort, bool clear_state, bool as_default)
+Session::set_transport_speed (double speed, framepos_t destination_frame, bool abort, bool clear_state, bool as_default)
 {
        DEBUG_TRACE (DEBUG::Transport, string_compose ("@ %5 Set transport speed to %1, abort = %2 clear_state = %3, current = %4 as_default %6\n", 
                                                       speed, abort, clear_state, _transport_speed, _transport_frame, as_default));
@@ -1131,7 +1205,7 @@ Session::set_transport_speed (double speed, bool abort, bool clear_state, bool a
                if (Config->get_monitoring_model() == HardwareMonitoring) {
                        set_track_monitor_input_status (true);
                }
-
+               
                if (synced_to_engine ()) {
                        if (clear_state) {
                                /* do this here because our response to the slave won't
@@ -1142,6 +1216,12 @@ Session::set_transport_speed (double speed, bool abort, bool clear_state, bool a
                        }
                        _engine.transport_stop ();
                } else {
+                       bool const auto_return_enabled = (!config.get_external_sync() && (config.get_auto_return() || abort));
+
+                       if (!auto_return_enabled) {
+                               _requested_return_frame = destination_frame;
+                       }
+
                        stop_transport (abort);
                }
 
@@ -1159,7 +1239,14 @@ Session::set_transport_speed (double speed, bool abort, bool clear_state, bool a
                        
                        if (location != 0) {
                                if (_transport_frame != location->start()) {
+
+                                       if (Config->get_seamless_loop()) {
+                                               /* force tracks to do their thing */
+                                               set_track_loop (true);
+                                       }
+
                                        /* jump to start and then roll from there */
+
                                        request_locate (location->start(), true);
                                        return;
                                }
@@ -1234,7 +1321,28 @@ Session::set_transport_speed (double speed, bool abort, bool clear_state, bool a
                }
 
                DEBUG_TRACE (DEBUG::Transport, string_compose ("send TSC3 with speed = %1\n", _transport_speed));
-               TransportStateChange (); /* EMIT SIGNAL */
+
+               /* throttle signal emissions. 
+                * when slaved [_last]_transport_speed
+                * usually changes every cycle (tiny amounts due to DLL).
+                * Emitting a signal every cycle is overkill and unwarranted.
+                *
+                * Using _last_transport_speed is not acceptable,
+                * since it allows for large changes over a long period 
+                * of time. Hence we introduce a dedicated variable to keep track
+                *
+                * The 0.2% dead-zone is somewhat arbitrary. Main use-case
+                * for TransportStateChange() here is the ShuttleControl display.
+                */
+               if (fabsf(_signalled_varispeed - speed) > .002f
+                   // still, signal hard changes to 1.0 and 0.0:
+                   || ( speed == 1.f && _signalled_varispeed != 1.f)
+                   || ( speed == 0.f && _signalled_varispeed != 0.f)
+                  )
+               {
+                       TransportStateChange (); /* EMIT SIGNAL */
+                       _signalled_varispeed = speed;
+               }
        }
 }
 
@@ -1247,59 +1355,77 @@ Session::stop_transport (bool abort, bool clear_state)
                return;
        }
 
-       if (actively_recording() && !(transport_sub_state & StopPendingCapture) && worst_input_latency() > current_block_size) {
+       if (!get_transport_declick_required()) {
+
+               /* stop has not yet been scheduled */
 
                boost::shared_ptr<RouteList> rl = routes.reader();
+               framepos_t stop_target = audible_frame();
+
                for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
                        boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
                        if (tr) {
-                               tr->prepare_to_stop (_transport_frame);
+                               tr->prepare_to_stop (_transport_frame, stop_target);
                        }
                }
 
-               /* we need to capture the audio that has still not yet been received by the system
-                  at the time the stop is requested, so we have to roll past that time.
-
-                  we want to declick before stopping, so schedule the autostop for one
-                  block before the actual end. we'll declick in the subsequent block,
-                  and then we'll really be stopped.
-               */
-
-               DEBUG_TRACE (DEBUG::Transport, string_compose ("stop transport requested @ %1, scheduled for + %2 - %3 = %4, abort = %5\n",
-                                                              _transport_frame, _worst_input_latency, current_block_size,
-                                                              _transport_frame - _worst_input_latency - current_block_size,
-                                                              abort));
-
-               SessionEvent *ev = new SessionEvent (SessionEvent::StopOnce, SessionEvent::Replace,
-                                                    _transport_frame + _worst_input_latency - current_block_size,
-                                                    0, 0, abort);
-
-               merge_event (ev);
-               transport_sub_state |= StopPendingCapture;
-               pending_abort = abort;
-               return;
-       }
-
-       if ((transport_sub_state & PendingDeclickOut) == 0) {
+               SubState new_bits;
+               
+               if (actively_recording() &&                           /* we are recording */
+                   worst_input_latency() > current_block_size) {     /* input latency exceeds block size, so simple 1 cycle delay before stop is not enough */
+                       
+                       /* we need to capture the audio that is still somewhere in the pipeline between
+                          wherever it was generated and the process callback. This means that even though
+                          the user (or something else)  has asked us to stop, we have to roll
+                          past this point and then reset the playhead/transport location to
+                          the position at which the stop was requested.
+
+                          we still need playback to "stop" now, however, which is why we schedule
+                          a declick below.
+                       */
+                       
+                       DEBUG_TRACE (DEBUG::Transport, string_compose ("stop transport requested @ %1, scheduled for + %2 = %3, abort = %4\n",
+                                                                      _transport_frame, _worst_input_latency,
+                                                                      _transport_frame + _worst_input_latency,
+                                                                      abort));
+                       
+                       SessionEvent *ev = new SessionEvent (SessionEvent::StopOnce, SessionEvent::Replace,
+                                                            _transport_frame + _worst_input_latency,
+                                                            0, 0, abort);
+                       
+                       merge_event (ev);
 
-               if (!(transport_sub_state & StopPendingCapture)) {
-                       boost::shared_ptr<RouteList> rl = routes.reader();
-                       for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
-                               boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
-                               if (tr) {
-                                       tr->prepare_to_stop (_transport_frame);
-                               }
-                       }
+                       /* request a declick at the start of the next process cycle() so that playback ceases.
+                          It will remain silent until we actually stop (at the StopOnce event somewhere in 
+                          the future). The extra flag (StopPendingCapture) is set to ensure that check_declick_out()
+                          does not stop the transport too early.
+                        */
+                       new_bits = SubState (PendingDeclickOut|StopPendingCapture);
+                       
+               } else {
+                       
+                       /* Not recording, schedule a declick in the next process() cycle and then stop at its end */
+                       
+                       new_bits = PendingDeclickOut;
                }
 
-               transport_sub_state |= PendingDeclickOut;
+               
                /* we'll be called again after the declick */
+               transport_sub_state = SubState (transport_sub_state|new_bits);
                pending_abort = abort;
+
                return;
-       }
 
-       realtime_stop (abort, clear_state);
-       _butler->schedule_transport_work ();
+       } else {
+               
+               /* declick was scheduled, but we've been called again, which means it is really time to stop
+                  
+                  XXX: we should probably split this off into its own method and call it explicitly.
+               */
+
+               realtime_stop (abort, clear_state);
+               _butler->schedule_transport_work ();
+       }
 }
 
 /** Called from the process thread */
@@ -1351,7 +1477,7 @@ Session::start_transport ()
                Timecode::Time time;
                timecode_time_subframes (_transport_frame, time);
                if (!dynamic_cast<MTC_Slave*>(_slave)) {
-                       _mmc->send (MIDI::MachineControlCommand (MIDI::MachineControl::cmdDeferredPlay));
+                       send_immediate_mmc (MIDI::MachineControlCommand (MIDI::MachineControl::cmdDeferredPlay));
                }
        }
 
@@ -1635,6 +1761,13 @@ Session::request_bounded_roll (framepos_t start, framepos_t end)
        lar.push_back (ar);
        request_play_range (&lar, true);
 }
+
+void
+Session::set_requested_return_frame (framepos_t return_to)
+{
+       _requested_return_frame = return_to;
+}
+
 void
 Session::request_roll_at_and_return (framepos_t start, framepos_t return_to)
 {
@@ -1656,8 +1789,6 @@ Session::engine_halted ()
        */
 
        if (_butler) {
-               g_atomic_int_set (&_butler->should_do_transport_work, 0);
-               set_post_transport_work (PostTransportWork (0));
                _butler->stop ();
        }
 
@@ -1673,6 +1804,8 @@ Session::engine_halted ()
 void
 Session::xrun_recovery ()
 {
+       ++_xrun_count;
+
        Xrun (_transport_frame); /* EMIT SIGNAL */
 
        if (Config->get_stop_recording_on_xrun() && actively_recording()) {
@@ -1693,6 +1826,12 @@ Session::route_processors_changed (RouteProcessorChange c)
        }
 
        if (c.type == RouteProcessorChange::MeterPointChange) {
+               set_dirty ();
+               return;
+       }
+
+       if (c.type == RouteProcessorChange::RealTimeChange) {
+               set_dirty ();
                return;
        }
 
@@ -1725,10 +1864,14 @@ Session::maybe_stop (framepos_t limit)
 void
 Session::send_mmc_locate (framepos_t t)
 {
+       if (t < 0) {
+               return;
+       }
+
        if (!_engine.freewheeling()) {
                Timecode::Time time;
                timecode_time_subframes (t, time);
-               _mmc->send (MIDI::MachineControlCommand (time));
+               send_immediate_mmc (MIDI::MachineControlCommand (time));
        }
 }