tweaks to be ready for more information timecode display in Timecode clock mode
[ardour.git] / libs / ardour / session_transport.cc
index 8c1bc6ff90ff330203d23d03210924b2f292de9a..6141716301c23615e5fb8db2331b50dbcf8c0386 100644 (file)
 
 */
 
-#include <cmath>
-#include <cerrno>
-#include <unistd.h>
-
 #ifdef WAF_BUILD
 #include "libardour-config.h"
 #endif
 
+#include <cmath>
+#include <cerrno>
+#include <unistd.h>
 
 #include "pbd/undo.h"
 #include "pbd/error.h"
 #include "midi++/port.h"
 #include "midi++/manager.h"
 
-#include "ardour/ardour.h"
 #include "ardour/audioengine.h"
 #include "ardour/auditioner.h"
 #include "ardour/butler.h"
+#include "ardour/click.h"
 #include "ardour/debug.h"
 #include "ardour/location.h"
 #include "ardour/session.h"
@@ -100,14 +99,16 @@ 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);
 }
 
 void
-Session::request_transport_speed (double speed)
+Session::request_transport_speed (double speed, bool as_default)
 {
        SessionEvent* ev = new SessionEvent (SessionEvent::SetTransportSpeed, SessionEvent::Add, SessionEvent::Immediate, 0, speed);
-       DEBUG_TRACE (DEBUG::Transport, string_compose ("Request transport speed = %1\n", speed));
+       ev->third_yes_or_no = true;
+       DEBUG_TRACE (DEBUG::Transport, string_compose ("Request transport speed = %1 as default = %2\n", speed, as_default));
        queue_event (ev);
 }
 
@@ -116,13 +117,13 @@ Session::request_transport_speed (double speed)
  *  be used by callers who are varying transport speed but don't ever want to stop it.
  */
 void
-Session::request_transport_speed_nonzero (double speed)
+Session::request_transport_speed_nonzero (double speed, bool as_default)
 {
        if (speed == 0) {
                speed = DBL_EPSILON;
        }
 
-       request_transport_speed (speed);
+       request_transport_speed (speed, as_default);
 }
 
 void
@@ -299,8 +300,8 @@ Session::butler_transport_work ()
                        if (tr) {
                                tr->adjust_playback_buffering ();
                                /* and refill those buffers ... */
-                               tr->non_realtime_locate (_transport_frame);
                        }
+                       (*i)->non_realtime_locate (_transport_frame);
                }
 
        }
@@ -344,10 +345,8 @@ Session::butler_transport_work ()
                if (!(ptw & PostTransportLocate)) {
 
                        for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
-                               boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
-                               if (tr && !tr->hidden()) {
-                                       tr->non_realtime_locate (_transport_frame);
-                               }
+                               (*i)->non_realtime_locate (_transport_frame);
+
                                if (on_entry != g_atomic_int_get (&_butler->should_do_transport_work)) {
                                        /* new request, stop seeking, and start again */
                                        g_atomic_int_dec_and_test (&_butler->should_do_transport_work);
@@ -420,11 +419,14 @@ Session::non_realtime_locate ()
 {
        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->non_realtime_locate (_transport_frame);
-               }
+               (*i)->non_realtime_locate (_transport_frame);
        }
+
+       /* XXX: it would be nice to generate the new clicks here (in the non-RT thread)
+          rather than clearing them so that the RT thread has to spend time constructing
+          them (in Session::click).
+        */
+       clear_clicks ();
 }
 
 
@@ -458,7 +460,6 @@ Session::non_realtime_stop (bool abort, int on_entry, bool& finished)
                auditioner->cancel_audition ();
        }
 
-       clear_clicks();
        cumulative_rf_motion = 0;
        reset_rf_scale (0);
 
@@ -581,6 +582,8 @@ Session::non_realtime_stop (bool abort, int on_entry, bool& finished)
 
        }
 
+       clear_clicks();
+
        /* do this before seeking, because otherwise the tracks will do the wrong thing in seamless loop mode.
        */
 
@@ -594,10 +597,7 @@ Session::non_realtime_stop (bool abort, int on_entry, bool& finished)
        DEBUG_TRACE (DEBUG::Transport, X_("Butler PTW: locate\n"));
        for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
                DEBUG_TRACE (DEBUG::Transport, string_compose ("Butler PTW: locate on %1\n", (*i)->name()));
-               boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
-               if (tr && !tr->hidden()) {
-                       tr->non_realtime_locate (_transport_frame);
-               }
+               (*i)->non_realtime_locate (_transport_frame);
 
                if (on_entry != g_atomic_int_get (&_butler->should_do_transport_work)) {
                        finished = false;
@@ -608,11 +608,13 @@ Session::non_realtime_stop (bool abort, int on_entry, bool& finished)
 
        have_looped = false;
 
-       send_full_time_code (_transport_frame);
-
-       if (!dynamic_cast<MTC_Slave*>(_slave)) {
-               MIDI::Manager::instance()->mmc()->send (MIDI::MachineControlCommand (MIDI::MachineControl::cmdStop));
-               send_mmc_locate (_transport_frame);
+       if (!_engine.freewheeling()) {
+               send_full_time_code (_transport_frame);
+               
+               if (!dynamic_cast<MTC_Slave*>(_slave)) {
+                       MIDI::Manager::instance()->mmc()->send (MIDI::MachineControlCommand (MIDI::MachineControl::cmdStop));
+                       send_mmc_locate (_transport_frame);
+               }
        }
 
        if ((ptw & PostTransportLocate) && get_record_enabled()) {
@@ -637,14 +639,19 @@ Session::non_realtime_stop (bool abort, int on_entry, bool& finished)
        }
 
        PositionChanged (_transport_frame); /* EMIT SIGNAL */
+       DEBUG_TRACE (DEBUG::Transport, string_compose ("send TSC with speed = %1\n", _transport_speed));
        TransportStateChange (); /* EMIT SIGNAL */
 
        /* and start it up again if relevant */
 
        if ((ptw & PostTransportLocate) && !config.get_external_sync() && pending_locate_roll) {
                request_transport_speed (1.0);
-               pending_locate_roll = false;
        }
+
+       /* Even if we didn't do a pending locate roll this time, we don't want it hanging
+          around for next time.
+       */
+       pending_locate_roll = false;
 }
 
 void
@@ -654,7 +661,7 @@ Session::check_declick_out ()
 
        /* this is called after a process() iteration. if PendingDeclickOut was set,
           it means that we were waiting to declick the output (which has just been
-          done) before doing something else. this is where we do that "something else".
+          done) before maybe doing something else. this is where we do that "something else".
 
           note: called from the audio thread.
        */
@@ -668,6 +675,10 @@ Session::check_declick_out ()
                        stop_transport (pending_abort);
                        transport_sub_state &= ~(PendingDeclickOut|PendingLocate);
                }
+
+       } else if (transport_sub_state & PendingLoopDeclickOut) {
+               /* Nothing else to do here; we've declicked, and the loop event will be along shortly */
+               transport_sub_state &= ~PendingLoopDeclickOut;
        }
 }
 
@@ -676,6 +687,7 @@ Session::unset_play_loop ()
 {
        play_loop = false;
        clear_events (SessionEvent::AutoLoop);
+       clear_events (SessionEvent::AutoLoopDeclick);
 
        // set all tracks to NOT use internal looping
        boost::shared_ptr<RouteList> rl = routes.reader ();
@@ -736,13 +748,20 @@ Session::set_play_loop (bool yn)
                                }
                        }
 
-                       /* put the loop event into the event list */
+                       /* Put the delick and loop events in into the event list.  The declick event will
+                          cause a de-clicking fade-out just before the end of the loop, and it will also result
+                          in a fade-in when the loop restarts.  The AutoLoop event will peform the actual loop.
+                       */
+
+                       framepos_t dcp;
+                       framecnt_t dcl;
+                       auto_loop_declick_range (loc, dcp, dcl);
+                       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));
 
-                       SessionEvent* event = new SessionEvent (SessionEvent::AutoLoop, SessionEvent::Replace, loc->end(), loc->start(), 0.0f);
-                       merge_event (event);
+                       /* locate to start of loop and roll. 
 
-                       /* locate to start of loop and roll. If doing seamless loop, force a
-                          locate+buffer refill even if we are positioned there already.
+                          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());
@@ -753,6 +772,7 @@ Session::set_play_loop (bool yn)
                unset_play_loop ();
        }
 
+       DEBUG_TRACE (DEBUG::Transport, string_compose ("send TSC2 with speed = %1\n", _transport_speed));
        TransportStateChange ();
 }
 void
@@ -777,6 +797,14 @@ Session::start_locate (framepos_t target_frame, bool with_roll, bool with_flush,
 
                if (target_frame != pos) {
 
+                       if (config.get_jack_time_master()) {
+                               /* actually locate now, since otherwise jack_timebase_callback
+                                  will use the incorrect _transport_frame and report an old
+                                  and incorrect time to Jack transport
+                               */
+                               locate (target_frame, with_roll, with_flush, with_loop, force);
+                       }
+
                        /* tell JACK to change transport position, and we will
                           follow along later in ::follow_slave()
                        */
@@ -818,13 +846,21 @@ Session::micro_locate (framecnt_t distance)
 
 /** @param with_mmc true to send a MMC locate command when the locate is done */
 void
-Session::locate (framepos_t target_frame, bool with_roll, bool with_flush, bool with_loop, bool force, bool with_mmc)
+Session::locate (framepos_t target_frame, bool with_roll, bool with_flush, bool for_seamless_loop, bool force, bool with_mmc)
 {
-       if (actively_recording() && !with_loop) {
+       /* 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
+        * actually tell the tracks to locate. What does need to be done,
+        * though, is all the housekeeping that is associated with non-linear
+        * changes in the value of _transport_frame. 
+        */
+
+       if (actively_recording() && !for_seamless_loop) {
                return;
        }
 
-       if (!force && _transport_frame == target_frame && !loop_changing && !with_loop) {
+       if (!force && _transport_frame == target_frame && !loop_changing && !for_seamless_loop) {
                if (with_roll) {
                        set_transport_speed (1.0, false);
                }
@@ -833,8 +869,11 @@ Session::locate (framepos_t target_frame, bool with_roll, bool with_flush, bool
                return;
        }
 
-       if (_transport_speed) {
-               /* schedule a declick. we'll be called again when its done */
+       if (_transport_speed && !for_seamless_loop) {
+               /* Schedule a declick.  We'll be called again when its done.
+                  We only do it this way for ordinary locates, not those
+                  due to **seamless** loops.
+               */
 
                if (!(transport_sub_state & PendingDeclickOut)) {
                        transport_sub_state |= (PendingDeclickOut|PendingLocate);
@@ -848,6 +887,7 @@ Session::locate (framepos_t target_frame, bool with_roll, bool with_flush, bool
        // Update Timecode time
        // [DR] FIXME: find out exactly where this should go below
        _transport_frame = target_frame;
+       _last_roll_or_reversal_location = target_frame;
        timecode_time(_transport_frame, transmitting_timecode_time);
        outbound_mtc_timecode_frame = _transport_frame;
        next_quarter_frame_to_send = 0;
@@ -861,18 +901,21 @@ Session::locate (framepos_t target_frame, bool with_roll, bool with_flush, bool
          *
         */
 
-       if (transport_rolling() && (!auto_play_legal || !config.get_auto_play()) && !with_roll && !(synced_to_jack() && play_loop)) {
+       bool transport_was_stopped = !transport_rolling();
+
+       if (transport_was_stopped && (!auto_play_legal || !config.get_auto_play()) && !with_roll && !(synced_to_jack() && play_loop)) {
                realtime_stop (false, true); // XXX paul - check if the 2nd arg is really correct
+               transport_was_stopped = true;
        } else {
                /* otherwise tell the world that we located */
                realtime_locate ();
        }
 
-       if (force || !with_loop || loop_changing) {
+       if (force || !for_seamless_loop || loop_changing) {
 
                PostTransportWork todo = PostTransportLocate;
 
-               if (with_roll) {
+               if (with_roll && transport_was_stopped) {
                        todo = PostTransportWork (todo | PostTransportRoll);
                }
 
@@ -883,7 +926,7 @@ Session::locate (framepos_t target_frame, bool with_roll, bool with_flush, bool
 
                /* this is functionally what clear_clicks() does but with a tentative lock */
 
-               Glib::RWLock::WriterLock clickm (click_lock, Glib::TRY_LOCK);
+               Glib::Threads::RWLock::WriterLock clickm (click_lock, Glib::Threads::TRY_LOCK);
 
                if (clickm.locked()) {
 
@@ -909,27 +952,39 @@ Session::locate (framepos_t target_frame, bool with_roll, bool with_flush, bool
 
        /* cancel looped playback if transport pos outside of loop range */
        if (play_loop) {
+
                Location* al = _locations->auto_loop_location();
 
-               if (al && (_transport_frame < al->start() || _transport_frame > al->end())) {
-                       // cancel looping directly, this is called from event handling context
-                       set_play_loop (false);
-               }
-               else if (al && _transport_frame == al->start()) {
-                       if (with_loop) {
-                               // this is only necessary for seamless looping
+               if (al) {
+                       if (_transport_frame < al->start() || _transport_frame > al->end()) {
 
-                               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->record_enabled ()) {
-                                               // tell it we've looped, so it can deal with the record state
-                                               tr->transport_looped(_transport_frame);
+                               // located outside the loop: cancel looping directly, this is called from event handling context
+
+                               set_play_loop (false);
+                               
+                       } else if (_transport_frame == al->start()) {
+
+                               // located to start of loop - this is looping, basically
+
+                               if (for_seamless_loop) {
+
+                                       // this is only necessary for seamless 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->record_enabled ()) {
+                                                       // tell it we've looped, so it can deal with the record state
+                                                       tr->transport_looped (_transport_frame);
+                                               }
                                        }
                                }
+
+                               have_looped = true;
+                               TransportLooped(); // EMIT SIGNAL
                        }
-                       have_looped = true;
-                       TransportLooped(); // EMIT SIGNAL
                }
        }
 
@@ -949,17 +1004,22 @@ 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)
+Session::set_transport_speed (double speed, 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\n", 
-                                                      speed, abort, clear_state, _transport_speed, _transport_frame));
+       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));
 
        if (_transport_speed == speed) {
+               if (as_default && speed == 0.0) { // => reset default transport speed. hacky or what?
+                       _default_transport_speed = 1.0;
+               }
                return;
        }
 
        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;
        }
 
@@ -1052,6 +1112,10 @@ Session::set_transport_speed (double speed, bool abort, bool clear_state)
                _last_transport_speed = _transport_speed;
                _transport_speed = speed;
 
+               if (as_default) {
+                       _default_transport_speed = speed;
+               }
+
                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);
@@ -1065,6 +1129,7 @@ Session::set_transport_speed (double speed, bool abort, bool clear_state)
                        _butler->schedule_transport_work ();
                }
 
+               DEBUG_TRACE (DEBUG::Transport, string_compose ("send TSC3 with speed = %1\n", _transport_speed));
                TransportStateChange (); /* EMIT SIGNAL */
        }
 }
@@ -1167,8 +1232,8 @@ Session::start_transport ()
 
        transport_sub_state |= PendingDeclickIn;
 
-       _transport_speed = 1.0;
-       _target_transport_speed = 1.0;
+       _transport_speed = _default_transport_speed;
+       _target_transport_speed = _transport_speed;
 
        boost::shared_ptr<RouteList> rl = routes.reader();
        for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
@@ -1176,15 +1241,17 @@ Session::start_transport ()
                if (tr) {
                        tr->realtime_set_speed (tr->speed(), true);
                }
-               (*i)->automation_snapshot (_transport_frame, true);
        }
 
-       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));
+       if (!_engine.freewheeling()) {
+               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));
+               }
        }
 
+       DEBUG_TRACE (DEBUG::Transport, string_compose ("send TSC4 with speed = %1\n", _transport_speed));
        TransportStateChange (); /* EMIT SIGNAL */
 }
 
@@ -1213,7 +1280,6 @@ Session::post_transport ()
 
                if (((!config.get_external_sync() && (auto_play_legal && config.get_auto_play())) && !_exporting) || (ptw & PostTransportRoll)) {
                        start_transport ();
-
                } else {
                        transport_sub_state = 0;
                }
@@ -1258,6 +1324,8 @@ Session::use_sync_source (Slave* new_slave)
        delete _slave;
        _slave = new_slave;
 
+       DEBUG_TRACE (DEBUG::Slave, string_compose ("set new slave to %1\n", _slave));
+
        send_full_time_code (_transport_frame);
 
        boost::shared_ptr<RouteList> rl = routes.reader();
@@ -1307,6 +1375,24 @@ Session::switch_to_sync_source (SyncSource src)
                }
                break;
 
+       case LTC:
+#ifdef HAVE_LTC
+               if (_slave && dynamic_cast<LTC_Slave*>(_slave)) {
+                       return;
+               }
+
+               try {
+                       new_slave = new LTC_Slave (*this);
+               }
+
+               catch (failed_constructor& err) {
+                       return;
+               }
+#else
+               return;
+#endif
+               break;
+
        case MIDIClock:
                if (_slave && dynamic_cast<MIDIClock_Slave*>(_slave)) {
                        return;
@@ -1341,13 +1427,6 @@ Session::switch_to_sync_source (SyncSource src)
        request_sync_source (new_slave);
 }
 
-void
-Session::reverse_track_buffers ()
-{
-       add_post_transport_work (PostTransportReverse);
-       _butler->schedule_transport_work ();
-}
-
 void
 Session::set_track_speed (Track* track, double speed)
 {
@@ -1441,6 +1520,7 @@ Session::set_play_range (list<AudioRange>& range, bool leave_rolling)
        ev = new SessionEvent (SessionEvent::LocateRoll, SessionEvent::Add, SessionEvent::Immediate, range.front().start, 0.0f, false);
        merge_event (ev);
 
+       DEBUG_TRACE (DEBUG::Transport, string_compose ("send TSC5 with speed = %1\n", _transport_speed));
        TransportStateChange ();
 }
 
@@ -1473,14 +1553,17 @@ Session::engine_halted ()
           the picture.
        */
 
-       g_atomic_int_set (&_butler->should_do_transport_work, 0);
-       set_post_transport_work (PostTransportWork (0));
-       _butler->stop ();
+       if (_butler) {
+               g_atomic_int_set (&_butler->should_do_transport_work, 0);
+               set_post_transport_work (PostTransportWork (0));
+               _butler->stop ();
+       }
 
        realtime_stop (false, true);
        non_realtime_stop (false, 0, ignored);
        transport_sub_state = 0;
 
+       DEBUG_TRACE (DEBUG::Transport, string_compose ("send TSC6 with speed = %1\n", _transport_speed));
        TransportStateChange (); /* EMIT SIGNAL */
 }
 
@@ -1503,6 +1586,10 @@ Session::xrun_recovery ()
 void
 Session::route_processors_changed (RouteProcessorChange c)
 {
+       if (ignore_route_processor_changes) {
+               return;
+       }
+
        if (c.type == RouteProcessorChange::MeterPointChange) {
                return;
        }
@@ -1546,9 +1633,11 @@ Session::maybe_stop (framepos_t limit)
 void
 Session::send_mmc_locate (framepos_t t)
 {
-       Timecode::Time time;
-       timecode_time_subframes (t, time);
-       MIDI::Manager::instance()->mmc()->send (MIDI::MachineControlCommand (time));
+       if (!_engine.freewheeling()) {
+               Timecode::Time time;
+               timecode_time_subframes (t, time);
+               MIDI::Manager::instance()->mmc()->send (MIDI::MachineControlCommand (time));
+       }
 }
 
 /** Ask the transport to not send timecode until further notice.  The suspension