fix crash when copy'ing latent plugins
[ardour.git] / libs / ardour / session_transport.cc
index a9d68a2363b66f4bb8eee9323fe821872ba71da9..8771af46aa7138df63c17c386571d89a52cb982e 100644 (file)
@@ -47,7 +47,7 @@
 #include "ardour/slave.h"
 #include "ardour/operations.h"
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 using namespace std;
 using namespace ARDOUR;
@@ -109,7 +109,7 @@ void
 Session::request_transport_speed (double speed, bool as_default)
 {
        SessionEvent* ev = new SessionEvent (SessionEvent::SetTransportSpeed, SessionEvent::Add, SessionEvent::Immediate, 0, speed);
-       ev->third_yes_or_no = true; // as_default
+       ev->third_yes_or_no = as_default; // as_default
        DEBUG_TRACE (DEBUG::Transport, string_compose ("Request transport speed = %1 as default = %2\n", speed, as_default));
        queue_event (ev);
 }
@@ -163,6 +163,12 @@ Session::force_locate (framepos_t target_frame, bool with_roll)
 void
 Session::request_play_loop (bool yn, bool change_transport_roll)
 {
+       if (_slave && yn) {
+               // don't attempt to loop when not using Internal Transport
+               // see also gtk2_ardour/ardour_ui_options.cc parameter_changed()
+               return;
+       }
+
        SessionEvent* ev;
        Location *location = _locations->auto_loop_location();
        double target_speed;
@@ -257,11 +263,11 @@ 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));
 
        /* the duration change is not guaranteed to have happened, but is likely */
-       
+
        todo = PostTransportWork (todo | PostTransportDuration);
 
        if (abort) {
@@ -286,7 +292,7 @@ Session::realtime_stop (bool abort, bool clear_state)
        if (clear_state && !Config->get_loop_is_mode()) {
                unset_play_loop ();
        }
-       
+
        reset_slave_state ();
 
        _transport_speed = 0;
@@ -314,19 +320,65 @@ Session::realtime_locate ()
 void
 Session::butler_transport_work ()
 {
+       /* Note: this function executes in the butler thread context */
+
   restart:
        bool finished;
        PostTransportWork ptw;
        boost::shared_ptr<RouteList> r = routes.reader ();
        uint64_t before;
-       
+
        int on_entry = g_atomic_int_get (&_butler->should_do_transport_work);
        finished = true;
        ptw = post_transport_work();
 
        DEBUG_TRACE (DEBUG::Transport, string_compose ("Butler transport work, todo = %1 at %2\n", enum_2_string (ptw), (before = g_get_monotonic_time())));
 
+
+       if (ptw & PostTransportLocate) {
+
+               if (get_play_loop() && !Config->get_seamless_loop()) {
+
+                       DEBUG_TRACE (DEBUG::Butler, "flush loop recording fragment to disk\n");
+
+                       /* this locate might be happening while we are
+                        * loop recording.
+                        *
+                        * Non-seamless looping will require a locate (below) that
+                        * will reset capture buffers and throw away data.
+                        *
+                        * Rather than first find all tracks and see if they
+                        * have outstanding data, just do a flush anyway. It
+                        * may be cheaper this way anyway, and is certainly
+                        * more accurate.
+                        */
+
+                       bool more_disk_io_to_do = false;
+                       uint32_t errors = 0;
+
+                       do {
+                               more_disk_io_to_do = _butler->flush_tracks_to_disk_after_locate (r, errors);
+
+                               if (errors) {
+                                       break;
+                               }
+
+                               if (more_disk_io_to_do) {
+                                       continue;
+                               }
+
+                       } while (false);
+
+               }
+       }
+
        if (ptw & PostTransportAdjustPlaybackBuffering) {
+               /* non_realtime_locate() calls Automatable::transport_located()
+                * for every route. This eventually calls
+                * ARDOUR::AutomationList::state () which has a LocaleGuard,
+                * and would switch locales forth/back every time.
+                */
+               LocaleGuard lg;
                for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
                        boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
                        if (tr) {
@@ -375,7 +427,7 @@ Session::butler_transport_work ()
                /* don't seek if locate will take care of that in non_realtime_stop() */
 
                if (!(ptw & PostTransportLocate)) {
-
+                       LocaleGuard lg; // see note for non_realtime_locate() above
                        for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
                                (*i)->non_realtime_locate (_transport_frame);
 
@@ -477,16 +529,19 @@ Session::non_realtime_locate ()
                } 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);
+
+       {
+               LocaleGuard lg; // see note for non_realtime_locate() above
+               boost::shared_ptr<RouteList> rl = routes.reader();
+               for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
+                       (*i)->non_realtime_locate (_transport_frame);
+               }
        }
 
        _scene_changer->locate (_transport_frame);
@@ -515,7 +570,7 @@ Session::select_playhead_priority_target (framepos_t& jump_to)
                // Next stop will put us where we need to be.
                return false;
        }
-       
+
        /* Note that the order of checking each AutoReturnTarget flag defines
           the priority each flag.
 
@@ -529,7 +584,7 @@ Session::select_playhead_priority_target (framepos_t& jump_to)
                           Region Selection
                           Last Locate
        */
-       
+
        if (autoreturn & RangeSelectionStart) {
                if (!_range_selection.empty()) {
                        jump_to = _range_selection.from;
@@ -543,13 +598,13 @@ Session::select_playhead_priority_target (framepos_t& jump_to)
                        }
                }
        }
-       
+
        if (jump_to < 0 && (autoreturn & Loop) && get_play_loop()) {
                /* don't try to handle loop play when synced to JACK */
-               
+
                if (!synced_to_engine()) {
                        Location *location = _locations->auto_loop_location();
-                       
+
                        if (location) {
                                jump_to = location->start();
 
@@ -557,20 +612,20 @@ Session::select_playhead_priority_target (framepos_t& jump_to)
                                        /* need to get track buffers reloaded */
                                        set_track_loop (true);
                                }
-                       } 
+                       }
                }
        }
-       
+
        if (jump_to < 0 && (autoreturn & RegionSelectionStart)) {
                if (!_object_selection.empty()) {
                        jump_to = _object_selection.from;
                }
-       } 
+       }
 
        if (jump_to < 0 && (autoreturn & LastLocate)) {
                jump_to = _last_roll_location;
        }
-       
+
        return jump_to >= 0;
 }
 #else
@@ -578,7 +633,7 @@ Session::select_playhead_priority_target (framepos_t& jump_to)
 bool
 Session::select_playhead_priority_target (framepos_t& jump_to)
 {
-       if (!config.get_auto_return()) {
+       if (config.get_external_sync() || !config.get_auto_return()) {
                return false;
        }
 
@@ -743,15 +798,18 @@ Session::non_realtime_stop (bool abort, int on_entry, bool& finished)
 
        /* this for() block can be put inside the previous if() and has the effect of ... ??? what */
 
-       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()));
-               (*i)->non_realtime_locate (_transport_frame);
+       {
+               LocaleGuard lg; // see note for non_realtime_locate() above
+               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()));
+                       (*i)->non_realtime_locate (_transport_frame);
 
-               if (on_entry != g_atomic_int_get (&_butler->should_do_transport_work)) {
-                       finished = false;
-                       /* we will be back */
-                       return;
+                       if (on_entry != g_atomic_int_get (&_butler->should_do_transport_work)) {
+                               finished = false;
+                               /* we will be back */
+                               return;
+                       }
                }
        }
 
@@ -764,14 +822,14 @@ Session::non_realtime_stop (bool abort, int on_entry, bool& finished)
        if (_engine.connected() && !_engine.freewheeling()) {
                // need to queue this in the next RT cycle
                _send_timecode_update = true;
-               
+
                if (!dynamic_cast<MTC_Slave*>(_slave)) {
                        send_immediate_mmc (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);
@@ -864,8 +922,8 @@ Session::unset_play_loop ()
                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);
@@ -917,7 +975,7 @@ Session::set_play_loop (bool yn, double speed)
 
                play_loop = true;
                have_looped = false;
-               
+
                if (loc) {
 
                        unset_play_range ();
@@ -927,8 +985,8 @@ Session::set_play_loop (bool yn, double speed)
                                        /* 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 
+                                       /* we will do this in the locate to the start OR when we hit the end
+                                        * of the loop for the first time
                                         */
                                }
                        } else {
@@ -958,11 +1016,11 @@ Session::set_play_loop (bool yn, double speed)
                                   rolling, do not locate to loop start.
                                */
                                if (!transport_rolling() && (speed != 0.0)) {
-                                       start_locate (loc->start(), true, true, false, Config->get_seamless_loop());
+                                       start_locate (loc->start(), true, true, false, true);
                                }
                        } else {
                                if (speed != 0.0) {
-                                       start_locate (loc->start(), true, true, false, Config->get_seamless_loop());
+                                       start_locate (loc->start(), true, true, false, true);
                                }
                        }
                }
@@ -986,7 +1044,7 @@ Session::flush_all_inserts ()
 }
 
 void
-Session::start_locate (framepos_t target_frame, bool with_roll, bool with_flush, bool with_loop, bool force)
+Session::start_locate (framepos_t target_frame, bool with_roll, bool with_flush, bool for_loop_enabled, bool force)
 {
        if (target_frame < 0) {
                error << _("Locate called for negative sample position - ignored") << endmsg;
@@ -1007,7 +1065,7 @@ Session::start_locate (framepos_t target_frame, bool with_roll, bool with_flush,
                                   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);
+                               locate (target_frame, with_roll, with_flush, for_loop_enabled, force);
                        }
 
                        /* tell JACK to change transport position, and we will
@@ -1023,7 +1081,7 @@ Session::start_locate (framepos_t target_frame, bool with_roll, bool with_flush,
                }
 
        } else {
-               locate (target_frame, with_roll, with_flush, with_loop, force);
+               locate (target_frame, with_roll, with_flush, for_loop_enabled, force);
        }
 }
 
@@ -1051,26 +1109,29 @@ 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 for_seamless_loop, bool force, bool with_mmc)
+Session::locate (framepos_t target_frame, bool with_roll, bool with_flush, bool for_loop_enabled, 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
         * 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. 
+        * 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;
-       }
+       DEBUG_TRACE (DEBUG::Transport, string_compose ("rt-locate to %1, roll %2 flush %3 loop-enabled %4 force %5 mmc %6\n",
+                                                      target_frame, with_roll, with_flush, for_loop_enabled, force, with_mmc));
+
+       if (!force && _transport_frame == target_frame && !loop_changing && !for_loop_enabled) {
+
+               /* already at the desired position. Not forced to locate,
+                  the loop isn't changing, so unless we're told to
+                  start rolling also, there's nothing to do but
+                  tell the world where we are (again).
+               */
 
-       if (!force && _transport_frame == target_frame && !loop_changing && !for_seamless_loop) {
                if (with_roll) {
                        set_transport_speed (1.0, 0, false);
                }
@@ -1079,7 +1140,7 @@ Session::locate (framepos_t target_frame, bool with_roll, bool with_flush, bool
                return;
        }
 
-       if (_transport_speed && !for_seamless_loop) {
+       if (_transport_speed && !(for_loop_enabled && Config->get_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.
@@ -1095,12 +1156,9 @@ 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;
 
        /* do "stopped" stuff if:
         *
@@ -1112,7 +1170,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) &&
            (!Profile->get_trx() || !(config.get_external_sync() && !synced_to_engine()))) {
                realtime_stop (false, true); // XXX paul - check if the 2nd arg is really correct
@@ -1122,7 +1180,7 @@ Session::locate (framepos_t target_frame, bool with_roll, bool with_flush, bool
                realtime_locate ();
        }
 
-       if (force || !for_seamless_loop || loop_changing) {
+       if (force || !for_loop_enabled || loop_changing) {
 
                PostTransportWork todo = PostTransportLocate;
 
@@ -1132,7 +1190,7 @@ Session::locate (framepos_t target_frame, bool with_roll, bool with_flush, bool
 
                add_post_transport_work (todo);
                need_butler = true;
-               
+
        } else {
 
                /* this is functionally what clear_clicks() does but with a tentative lock */
@@ -1172,7 +1230,7 @@ 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 {
@@ -1184,37 +1242,32 @@ Session::locate (framepos_t target_frame, bool with_roll, bool with_flush, bool
                                                set_track_loop (false);
                                        }
                                }
-                               
+
                        } else if (_transport_frame == al->start()) {
 
                                // located to start of loop - this is looping, basically
 
-                               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;
-                                               }
-                                                   
+                               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();
-
-                                       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);
-                                               }
+
+                               }
+
+                               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->rec_enable_control()->get_value()) {
+                                               // tell it we've looped, so it can deal with the record state
+                                               tr->transport_looped (_transport_frame);
                                        }
                                }
 
@@ -1247,7 +1300,7 @@ Session::locate (framepos_t target_frame, bool with_roll, bool with_flush, bool
 void
 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", 
+       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) {
@@ -1259,7 +1312,7 @@ Session::set_transport_speed (double speed, framepos_t destination_frame, 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", 
+               DEBUG_TRACE (DEBUG::Transport, string_compose ("No varispeed during recording cur_speed %1, frame %2\n",
                                                       _transport_speed, _transport_frame));
                return;
        }
@@ -1283,7 +1336,7 @@ Session::set_transport_speed (double speed, framepos_t destination_frame, 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
@@ -1304,13 +1357,15 @@ Session::set_transport_speed (double speed, framepos_t destination_frame, bool a
                }
 
        } else if (transport_stopped() && speed == 1.0) {
-
+               if (as_default) {
+                       _default_transport_speed = speed;
+               }
                /* 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()) {
 
@@ -1396,13 +1451,13 @@ Session::set_transport_speed (double speed, framepos_t destination_frame, bool a
 
                DEBUG_TRACE (DEBUG::Transport, string_compose ("send TSC3 with speed = %1\n", _transport_speed));
 
-               /* throttle signal emissions. 
+               /* 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 
+                * 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
@@ -1430,7 +1485,7 @@ Session::stop_transport (bool abort, bool clear_state)
        }
 
        DEBUG_TRACE (DEBUG::Transport, string_compose ("stop_transport, declick required? %1\n", get_transport_declick_required()));
-       
+
        if (!get_transport_declick_required()) {
 
                /* stop has not yet been scheduled */
@@ -1446,10 +1501,10 @@ Session::stop_transport (bool abort, bool clear_state)
                }
 
                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
@@ -1459,33 +1514,33 @@ Session::stop_transport (bool abort, bool clear_state)
                           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);
 
                        /* 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 
+                          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;
                        DEBUG_TRACE (DEBUG::Transport, string_compose ("stop scheduled for next process cycle @ %1\n", _transport_frame));
                }
-               
+
                /* we'll be called again after the declick */
                transport_sub_state = SubState (transport_sub_state|new_bits);
                pending_abort = abort;
@@ -1495,9 +1550,9 @@ Session::stop_transport (bool abort, bool clear_state)
        } else {
 
                DEBUG_TRACE (DEBUG::Transport, "time to actually stop\n");
-               
+
                /* 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.
                */
 
@@ -1671,7 +1726,7 @@ Session::use_sync_source (Slave* new_slave)
        }
 
        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;