new transport option, "loop-is-mode" which optionally changes the role of the "play...
[ardour.git] / libs / ardour / session_transport.cc
index c25af99ab0fe582b8ea36a1fcaa33738034e5f6b..ea9f5d28dd6ee97e2beebb8e8cf65f8a95920c43 100644 (file)
 #include "pbd/enumwriter.h"
 #include "pbd/pthread_utils.h"
 #include "pbd/memento_command.h"
+#include "pbd/stacktrace.h"
 
 #include "midi++/mmc.h"
 #include "midi++/port.h"
-#include "midi++/manager.h"
 
 #include "ardour/audioengine.h"
 #include "ardour/auditioner.h"
@@ -41,6 +41,7 @@
 #include "ardour/click.h"
 #include "ardour/debug.h"
 #include "ardour/location.h"
+#include "ardour/profile.h"
 #include "ardour/session.h"
 #include "ardour/slave.h"
 #include "ardour/operations.h"
@@ -87,7 +88,7 @@ Session::request_sync_source (Slave* new_slave)
 
        seamless = Config->get_seamless_loop ();
 
-       if (dynamic_cast<JACK_Slave*>(new_slave)) {
+       if (dynamic_cast<Engine_Slave*>(new_slave)) {
                /* JACK cannot support seamless looping at present */
                Config->set_seamless_loop (false);
        } else {
@@ -99,6 +100,7 @@ Session::request_sync_source (Slave* new_slave)
        _was_seamless = seamless;
 
        ev->slave = new_slave;
+       DEBUG_TRACE (DEBUG::Slave, "sent request for new slave\n");
        queue_event (ev);
 }
 
@@ -158,10 +160,11 @@ Session::force_locate (framepos_t target_frame, bool with_roll)
 }
 
 void
-Session::request_play_loop (bool yn, bool leave_rolling)
+Session::request_play_loop (bool yn, bool change_transport_roll)
 {
        SessionEvent* ev;
        Location *location = _locations->auto_loop_location();
+       double target_speed;
 
        if (location == 0 && yn) {
                error << _("Cannot loop - no loop range defined")
@@ -169,14 +172,44 @@ Session::request_play_loop (bool yn, bool leave_rolling)
                return;
        }
 
-       ev = new SessionEvent (SessionEvent::SetLoop, SessionEvent::Add, SessionEvent::Immediate, 0, (leave_rolling ? 1.0 : 0.0), yn);
-       DEBUG_TRACE (DEBUG::Transport, string_compose ("Request set loop = %1, leave rolling ? %2\n", yn, leave_rolling));
+       if (change_transport_roll) {
+               if (transport_rolling()) {
+                       /* start looping at current speed */
+                       target_speed = transport_speed ();
+               } else {
+                       /* currently stopped */
+                       if (yn) {
+                               /* start looping at normal speed */
+                               target_speed = 1.0;
+                       } else {
+                               target_speed = 0.0;
+                       }
+               }
+       } else {
+               /* leave the speed alone */
+               target_speed = transport_speed ();
+       }
+
+       ev = new SessionEvent (SessionEvent::SetLoop, SessionEvent::Add, SessionEvent::Immediate, 0, target_speed, yn);
+       DEBUG_TRACE (DEBUG::Transport, string_compose ("Request set loop = %1, change roll state ? %2\n", yn, change_transport_roll));
        queue_event (ev);
 
-       if (!leave_rolling && !yn && Config->get_seamless_loop() && transport_rolling()) {
-               // request an immediate locate to refresh the tracks
-               // after disabling looping
-               request_locate (_transport_frame-1, false);
+       if (yn) {
+               if (!change_transport_roll) {
+                       if (!transport_rolling()) {
+                               /* we're not changing transport state, but we do want
+                                  to set up position for the new loop. Don't
+                                  do this if we're rolling already.
+                               */
+                               request_locate (location->start(), false);
+                       }
+               }
+       } else {
+               if (!change_transport_roll && Config->get_seamless_loop() && transport_rolling()) {
+                       // request an immediate locate to refresh the tracks
+                       // after disabling looping
+                       request_locate (_transport_frame-1, false);
+               }
        }
 }
 
@@ -203,6 +236,7 @@ Session::realtime_stop (bool abort, bool clear_state)
 
        if (_transport_speed < 0.0f) {
                todo = (PostTransportWork (todo | PostTransportStop | PostTransportReverse));
+               _default_transport_speed = 1.0;
        } else {
                todo = PostTransportWork (todo | PostTransportStop);
        }
@@ -382,6 +416,7 @@ Session::butler_transport_work ()
        g_atomic_int_dec_and_test (&_butler->should_do_transport_work);
 
        DEBUG_TRACE (DEBUG::Transport, X_("Butler transport work all done\n"));
+       DEBUG_TRACE (DEBUG::Transport, X_(string_compose ("Frame %1\n", _transport_frame)));
 }
 
 void
@@ -489,7 +524,7 @@ Session::non_realtime_stop (bool abort, int on_entry, bool& finished)
        boost::shared_ptr<RouteList> r = routes.reader ();
 
        for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
-               if (!(*i)->is_hidden()) {
+               if (!(*i)->is_auditioner()) {
                        (*i)->set_pending_declick (0);
                }
        }
@@ -512,13 +547,13 @@ Session::non_realtime_stop (bool abort, int on_entry, bool& finished)
        if (auto_return_enabled ||
            (ptw & PostTransportLocate) ||
            (_requested_return_frame >= 0) ||
-           synced_to_jack()) {
+           synced_to_engine()) {
 
                if (pending_locate_flush) {
                        flush_all_inserts ();
                }
 
-               if ((auto_return_enabled || synced_to_jack() || _requested_return_frame >= 0) &&
+               if ((auto_return_enabled || synced_to_engine() || _requested_return_frame >= 0) &&
                    !(ptw & PostTransportLocate)) {
 
                        /* no explicit locate queued */
@@ -529,8 +564,6 @@ Session::non_realtime_stop (bool abort, int on_entry, bool& finished)
 
                                /* explicit return request pre-queued in event list. overrides everything else */
 
-                               cerr << "explicit auto-return to " << _requested_return_frame << endl;
-
                                _transport_frame = _requested_return_frame;
                                do_locate = true;
 
@@ -541,7 +574,7 @@ Session::non_realtime_stop (bool abort, int on_entry, bool& finished)
 
                                                /* don't try to handle loop play when synced to JACK */
 
-                                               if (!synced_to_jack()) {
+                                               if (!synced_to_engine()) {
 
                                                        Location *location = _locations->auto_loop_location();
 
@@ -587,8 +620,10 @@ Session::non_realtime_stop (bool abort, int on_entry, bool& finished)
        */
 
        if (ptw & PostTransportClearSubstate) {
-               _play_range = false;
-               unset_play_loop ();
+               unset_play_range ();
+               if (!Config->get_loop_is_mode()) {
+                       unset_play_loop ();
+               }
        }
 
        /* this for() block can be put inside the previous if() and has the effect of ... ??? what */
@@ -607,19 +642,41 @@ Session::non_realtime_stop (bool abort, int on_entry, bool& finished)
 
        have_looped = false;
 
-       if (!_engine.freewheeling()) {
-               send_full_time_code (_transport_frame);
+       /* don't bother with this stuff if we're disconnected from the engine,
+          because there will be no process callbacks to deliver stuff from
+       */
+
+       if (_engine.connected() && !_engine.freewheeling()) {
+               // need to queue this in the next RT cycle
+               _send_timecode_update = true;
                
                if (!dynamic_cast<MTC_Slave*>(_slave)) {
-                       MIDI::Manager::instance()->mmc()->send (MIDI::MachineControlCommand (MIDI::MachineControl::cmdStop));
+                       _mmc->send (MIDI::MachineControlCommand (MIDI::MachineControl::cmdStop));
+
+                       /* This (::non_realtime_stop()) gets called by main
+                          process thread, which will lead to confusion
+                          when calling AsyncMIDIPort::write().
+                          
+                          Something must be done. XXX
+                       */
                        send_mmc_locate (_transport_frame);
                }
        }
 
        if ((ptw & PostTransportLocate) && get_record_enabled()) {
-               /* capture start has been changed, so save pending state */
-               save_state ("", true);
-               saved = true;
+               /* This is scheduled by realtime_stop(), which is also done
+                * when a slave requests /locate/ for an initial sync.
+                * We can't hold up the slave for long with a save() here,
+                * without breaking its initial sync cycle.
+                *
+                * 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);
+                       saved = true;
+               }
        }
 
        /* always try to get rid of this */
@@ -633,8 +690,10 @@ Session::non_realtime_stop (bool abort, int on_entry, bool& finished)
        }
 
        if (ptw & PostTransportStop) {
-               _play_range = false;
-               play_loop = false;
+               unset_play_range ();
+               if (!Config->get_loop_is_mode()) {
+                       unset_play_loop ();
+               }
        }
 
        PositionChanged (_transport_frame); /* EMIT SIGNAL */
@@ -699,7 +758,7 @@ Session::unset_play_loop ()
 }
 
 void
-Session::set_play_loop (bool yn)
+Session::set_play_loop (bool yn, double speed)
 {
        /* Called from event-handling context */
 
@@ -710,7 +769,7 @@ Session::set_play_loop (bool yn)
                return;
        }
 
-       if (yn && Config->get_seamless_loop() && synced_to_jack()) {
+       if (yn && Config->get_seamless_loop() && synced_to_engine()) {
                warning << string_compose (
                        _("Seamless looping cannot be supported while %1 is using JACK transport.\n"
                          "Recommend changing the configured options"), PROGRAM_NAME)
@@ -758,12 +817,24 @@ Session::set_play_loop (bool yn)
                        merge_event (new SessionEvent (SessionEvent::AutoLoopDeclick, SessionEvent::Replace, dcp, dcl, 0.0f));
                        merge_event (new SessionEvent (SessionEvent::AutoLoop, SessionEvent::Replace, loc->end(), loc->start(), 0.0f));
 
-                       /* locate to start of loop and roll. 
+                       /* if requested to roll, locate to start of loop and
+                        * roll but ONLY if we're not already rolling.
 
                           args: positition, roll=true, flush=true, with_loop=false, force buffer refill if seamless looping
                        */
 
-                       start_locate (loc->start(), true, true, false, Config->get_seamless_loop());
+                       if (Config->get_loop_is_mode()) {
+                               /* loop IS a transport mode: if already
+                                  rolling, do not locate to loop start.
+                               */
+                               if (!transport_rolling() && (speed != 0.0)) {
+                                       start_locate (loc->start(), true, true, false, Config->get_seamless_loop());
+                               }
+                       } else {
+                               if (speed != 0.0) {
+                                       start_locate (loc->start(), true, true, false, Config->get_seamless_loop());
+                               }
+                       }
                }
 
        } else {
@@ -787,7 +858,7 @@ Session::flush_all_inserts ()
 void
 Session::start_locate (framepos_t target_frame, bool with_roll, bool with_flush, bool with_loop, bool force)
 {
-       if (synced_to_jack()) {
+       if (synced_to_engine()) {
 
                double sp;
                framepos_t pos;
@@ -902,7 +973,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_jack() && play_loop)) {
+       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;
        } else {
@@ -959,7 +1030,9 @@ 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
 
-                               set_play_loop (false);
+                               if (!Config->get_loop_is_mode()) {
+                                       set_play_loop (false, _transport_speed);
+                               }
                                
                        } else if (_transport_frame == al->start()) {
 
@@ -995,6 +1068,7 @@ Session::locate (framepos_t target_frame, bool with_roll, bool with_flush, bool
                send_mmc_locate (_transport_frame);
        }
 
+       _last_roll_location = _last_roll_or_reversal_location =  _transport_frame;
        Located (); /* EMIT SIGNAL */
 }
 
@@ -1017,6 +1091,8 @@ Session::set_transport_speed (double speed, bool abort, bool clear_state, bool a
 
        if (actively_recording() && speed != 1.0 && speed != 0.0) {
                /* no varispeed during recording */
+               DEBUG_TRACE (DEBUG::Transport, string_compose ("No varispeed during recording cur_speed %1, frame %2\n", 
+                                                      _transport_speed, _transport_frame));
                return;
        }
 
@@ -1040,7 +1116,7 @@ Session::set_transport_speed (double speed, bool abort, bool clear_state, bool a
                        set_track_monitor_input_status (true);
                }
 
-               if (synced_to_jack ()) {
+               if (synced_to_engine ()) {
                        if (clear_state) {
                                /* do this here because our response to the slave won't
                                   take care of it.
@@ -1053,17 +1129,32 @@ Session::set_transport_speed (double speed, bool abort, bool clear_state, bool a
                        stop_transport (abort);
                }
 
-               unset_play_loop ();
+               if (!Config->get_loop_is_mode()) {
+                       unset_play_loop ();
+               }
 
        } else if (transport_stopped() && speed == 1.0) {
 
                /* we are stopped and we want to start rolling at speed 1 */
 
+               if (Config->get_loop_is_mode() && play_loop) {
+
+                       Location *location = _locations->auto_loop_location();
+                       
+                       if (location != 0) {
+                               if (_transport_frame != location->start()) {
+                                       /* jump to start and then roll from there */
+                                       request_locate (location->start(), true);
+                                       return;
+                               }
+                       }
+               }
+
                if (Config->get_monitoring_model() == HardwareMonitoring && config.get_auto_input()) {
                        set_track_monitor_input_status (false);
                }
 
-               if (synced_to_jack()) {
+               if (synced_to_engine()) {
                        _engine.transport_start ();
                } else {
                        start_transport ();
@@ -1073,7 +1164,7 @@ Session::set_transport_speed (double speed, bool abort, bool clear_state, bool a
 
                /* not zero, not 1.0 ... varispeed */
 
-               if ((synced_to_jack()) && speed != 0.0 && speed != 1.0) {
+               if ((synced_to_engine()) && speed != 0.0 && speed != 1.0) {
                        warning << string_compose (
                                _("Global varispeed cannot be supported while %1 is connected to JACK transport control"),
                                PROGRAM_NAME)
@@ -1244,7 +1335,7 @@ Session::start_transport ()
                Timecode::Time time;
                timecode_time_subframes (_transport_frame, time);
                if (!dynamic_cast<MTC_Slave*>(_slave)) {
-                       MIDI::Manager::instance()->mmc()->send (MIDI::MachineControlCommand (MIDI::MachineControl::cmdDeferredPlay));
+                       _mmc->send (MIDI::MachineControlCommand (MIDI::MachineControl::cmdDeferredPlay));
                }
        }
 
@@ -1321,7 +1412,10 @@ Session::use_sync_source (Slave* new_slave)
        delete _slave;
        _slave = new_slave;
 
-       send_full_time_code (_transport_frame);
+       DEBUG_TRACE (DEBUG::Slave, string_compose ("set new slave to %1\n", _slave));
+       
+       // need to queue this for next process() cycle
+       _send_timecode_update = true;
 
        boost::shared_ptr<RouteList> rl = routes.reader();
        for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
@@ -1362,12 +1456,27 @@ Session::switch_to_sync_source (SyncSource src)
                }
 
                try {
-                       new_slave = new MTC_Slave (*this, *MIDI::Manager::instance()->mtc_input_port());
+                       new_slave = new MTC_Slave (*this, *_midi_ports->mtc_input_port());
+               }
+
+               catch (failed_constructor& err) {
+                       return;
+               }
+               break;
+
+       case LTC:
+               if (_slave && dynamic_cast<LTC_Slave*>(_slave)) {
+                       return;
+               }
+
+               try {
+                       new_slave = new LTC_Slave (*this);
                }
 
                catch (failed_constructor& err) {
                        return;
                }
+
                break;
 
        case MIDIClock:
@@ -1376,7 +1485,7 @@ Session::switch_to_sync_source (SyncSource src)
                }
 
                try {
-                       new_slave = new MIDIClock_Slave (*this, *MIDI::Manager::instance()->midi_clock_input_port(), 24);
+                       new_slave = new MIDIClock_Slave (*this, *_midi_ports->midi_clock_input_port(), 24);
                }
 
                catch (failed_constructor& err) {
@@ -1384,8 +1493,8 @@ Session::switch_to_sync_source (SyncSource src)
                }
                break;
 
-       case JACK:
-               if (_slave && dynamic_cast<JACK_Slave*>(_slave)) {
+       case Engine:
+               if (_slave && dynamic_cast<Engine_Slave*>(_slave)) {
                        return;
                }
 
@@ -1393,7 +1502,7 @@ Session::switch_to_sync_source (SyncSource src)
                        return;
                }
 
-               new_slave = new JACK_Slave (_engine.jack());
+               new_slave = new Engine_Slave (*AudioEngine::instance());
                break;
 
        default:
@@ -1583,23 +1692,13 @@ Session::allow_auto_play (bool yn)
        auto_play_legal = yn;
 }
 
-void
-Session::reset_jack_connection (jack_client_t* jack)
-{
-       JACK_Slave* js;
-
-       if (_slave && ((js = dynamic_cast<JACK_Slave*> (_slave)) != 0)) {
-               js->reset_client (jack);
-       }
-}
-
 bool
 Session::maybe_stop (framepos_t limit)
 {
        if ((_transport_speed > 0.0f && _transport_frame >= limit) || (_transport_speed < 0.0f && _transport_frame == 0)) {
-               if (synced_to_jack () && config.get_jack_time_master ()) {
+               if (synced_to_engine () && config.get_jack_time_master ()) {
                        _engine.transport_stop ();
-               } else if (!synced_to_jack ()) {
+               } else if (!synced_to_engine ()) {
                        stop_transport ();
                }
                return true;
@@ -1613,7 +1712,7 @@ Session::send_mmc_locate (framepos_t t)
        if (!_engine.freewheeling()) {
                Timecode::Time time;
                timecode_time_subframes (t, time);
-               MIDI::Manager::instance()->mmc()->send (MIDI::MachineControlCommand (time));
+               _mmc->send (MIDI::MachineControlCommand (time));
        }
 }