2 Copyright (C) 1999-2003 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 #include "libardour-config.h"
29 #include "pbd/error.h"
30 #include "pbd/enumwriter.h"
31 #include "pbd/pthread_utils.h"
32 #include "pbd/memento_command.h"
34 #include "midi++/mmc.h"
35 #include "midi++/port.h"
37 #include "ardour/audioengine.h"
38 #include "ardour/auditioner.h"
39 #include "ardour/butler.h"
40 #include "ardour/click.h"
41 #include "ardour/debug.h"
42 #include "ardour/location.h"
43 #include "ardour/session.h"
44 #include "ardour/slave.h"
45 #include "ardour/operations.h"
50 using namespace ARDOUR;
54 Session::add_post_transport_work (PostTransportWork ptw)
56 PostTransportWork oldval;
57 PostTransportWork newval;
61 oldval = (PostTransportWork) g_atomic_int_get (&_post_transport_work);
62 newval = PostTransportWork (oldval | ptw);
63 if (g_atomic_int_compare_and_exchange (&_post_transport_work, oldval, newval)) {
69 error << "Could not set post transport work! Crazy thread madness, call the programmers" << endmsg;
73 Session::request_input_change_handling ()
75 if (!(_state_of_the_state & (InitialConnecting|Deletion))) {
76 SessionEvent* ev = new SessionEvent (SessionEvent::InputConfigurationChange, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
82 Session::request_sync_source (Slave* new_slave)
84 SessionEvent* ev = new SessionEvent (SessionEvent::SetSyncSource, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
87 seamless = Config->get_seamless_loop ();
89 if (dynamic_cast<Engine_Slave*>(new_slave)) {
90 /* JACK cannot support seamless looping at present */
91 Config->set_seamless_loop (false);
93 /* reset to whatever the value was before we last switched slaves */
94 Config->set_seamless_loop (_was_seamless);
97 /* save value of seamless from before the switch */
98 _was_seamless = seamless;
100 ev->slave = new_slave;
101 DEBUG_TRACE (DEBUG::Slave, "sent request for new slave\n");
106 Session::request_transport_speed (double speed, bool as_default)
108 SessionEvent* ev = new SessionEvent (SessionEvent::SetTransportSpeed, SessionEvent::Add, SessionEvent::Immediate, 0, speed);
109 ev->third_yes_or_no = true;
110 DEBUG_TRACE (DEBUG::Transport, string_compose ("Request transport speed = %1 as default = %2\n", speed, as_default));
114 /** Request a new transport speed, but if the speed parameter is exactly zero then use
115 * a very small +ve value to prevent the transport actually stopping. This method should
116 * be used by callers who are varying transport speed but don't ever want to stop it.
119 Session::request_transport_speed_nonzero (double speed, bool as_default)
125 request_transport_speed (speed, as_default);
129 Session::request_track_speed (Track* tr, double speed)
131 SessionEvent* ev = new SessionEvent (SessionEvent::SetTrackSpeed, SessionEvent::Add, SessionEvent::Immediate, 0, speed);
137 Session::request_stop (bool abort, bool clear_state)
139 SessionEvent* ev = new SessionEvent (SessionEvent::SetTransportSpeed, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0, abort, clear_state);
140 DEBUG_TRACE (DEBUG::Transport, string_compose ("Request transport stop, abort = %1, clear state = %2\n", abort, clear_state));
145 Session::request_locate (framepos_t target_frame, bool with_roll)
147 SessionEvent *ev = new SessionEvent (with_roll ? SessionEvent::LocateRoll : SessionEvent::Locate, SessionEvent::Add, SessionEvent::Immediate, target_frame, 0, false);
148 DEBUG_TRACE (DEBUG::Transport, string_compose ("Request locate to %1\n", target_frame));
153 Session::force_locate (framepos_t target_frame, bool with_roll)
155 SessionEvent *ev = new SessionEvent (with_roll ? SessionEvent::LocateRoll : SessionEvent::Locate, SessionEvent::Add, SessionEvent::Immediate, target_frame, 0, true);
156 DEBUG_TRACE (DEBUG::Transport, string_compose ("Request forced locate to %1\n", target_frame));
161 Session::request_play_loop (bool yn, bool leave_rolling)
164 Location *location = _locations->auto_loop_location();
166 if (location == 0 && yn) {
167 error << _("Cannot loop - no loop range defined")
172 ev = new SessionEvent (SessionEvent::SetLoop, SessionEvent::Add, SessionEvent::Immediate, 0, (leave_rolling ? 1.0 : 0.0), yn);
173 DEBUG_TRACE (DEBUG::Transport, string_compose ("Request set loop = %1, leave rolling ? %2\n", yn, leave_rolling));
176 if (!leave_rolling && !yn && Config->get_seamless_loop() && transport_rolling()) {
177 // request an immediate locate to refresh the tracks
178 // after disabling looping
179 request_locate (_transport_frame-1, false);
184 Session::request_play_range (list<AudioRange>* range, bool leave_rolling)
186 SessionEvent* ev = new SessionEvent (SessionEvent::SetPlayAudioRange, SessionEvent::Add, SessionEvent::Immediate, 0, (leave_rolling ? 1.0 : 0.0));
188 ev->audio_range = *range;
190 ev->audio_range.clear ();
192 DEBUG_TRACE (DEBUG::Transport, string_compose ("Request play range, leave rolling ? %1\n", leave_rolling));
197 Session::realtime_stop (bool abort, bool clear_state)
199 DEBUG_TRACE (DEBUG::Transport, string_compose ("realtime stop @ %1\n", _transport_frame));
200 PostTransportWork todo = PostTransportWork (0);
202 /* assume that when we start, we'll be moving forwards */
204 if (_transport_speed < 0.0f) {
205 todo = (PostTransportWork (todo | PostTransportStop | PostTransportReverse));
206 _default_transport_speed = 1.0;
208 todo = PostTransportWork (todo | PostTransportStop);
213 boost::shared_ptr<RouteList> r = routes.reader ();
215 for (RouteList::iterator i = r->begin (); i != r->end(); ++i) {
216 (*i)->realtime_handle_transport_stopped ();
219 if (actively_recording()) {
221 /* move the transport position back to where the
222 request for a stop was noticed. we rolled
223 past that point to pick up delayed input (and/or to delick)
226 if (worst_playback_latency() > current_block_size) {
227 /* we rolled past the stop point to pick up data that had
228 not yet arrived. move back to where the stop occured.
230 decrement_transport_position (current_block_size + (worst_input_latency() - current_block_size));
232 decrement_transport_position (current_block_size);
235 /* the duration change is not guaranteed to have happened, but is likely */
237 todo = PostTransportWork (todo | PostTransportDuration);
241 todo = PostTransportWork (todo | PostTransportAbort);
245 todo = PostTransportWork (todo | PostTransportClearSubstate);
249 add_post_transport_work (todo);
252 _clear_event_type (SessionEvent::StopOnce);
253 _clear_event_type (SessionEvent::RangeStop);
254 _clear_event_type (SessionEvent::RangeLocate);
256 /* if we're going to clear loop state, then force disabling record BUT only if we're not doing latched rec-enable */
257 disable_record (true, (!Config->get_latched_record_enable() && clear_state));
259 reset_slave_state ();
261 _transport_speed = 0;
262 _target_transport_speed = 0;
264 g_atomic_int_set (&_playback_load, 100);
265 g_atomic_int_set (&_capture_load, 100);
267 if (config.get_use_video_sync()) {
268 waiting_for_sync_offset = true;
271 transport_sub_state = 0;
275 Session::realtime_locate ()
277 boost::shared_ptr<RouteList> r = routes.reader ();
278 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
279 (*i)->realtime_locate ();
284 Session::butler_transport_work ()
288 PostTransportWork ptw;
289 boost::shared_ptr<RouteList> r = routes.reader ();
291 int on_entry = g_atomic_int_get (&_butler->should_do_transport_work);
293 ptw = post_transport_work();
295 DEBUG_TRACE (DEBUG::Transport, string_compose ("Butler transport work, todo = %1\n", enum_2_string (ptw)));
297 if (ptw & PostTransportAdjustPlaybackBuffering) {
298 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
299 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
301 tr->adjust_playback_buffering ();
302 /* and refill those buffers ... */
304 (*i)->non_realtime_locate (_transport_frame);
309 if (ptw & PostTransportAdjustCaptureBuffering) {
310 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
311 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
313 tr->adjust_capture_buffering ();
318 if (ptw & PostTransportCurveRealloc) {
319 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
320 (*i)->curve_reallocate();
324 if (ptw & PostTransportInputChange) {
325 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
326 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
328 tr->non_realtime_input_change ();
333 if (ptw & PostTransportSpeed) {
334 non_realtime_set_speed ();
337 if (ptw & PostTransportReverse) {
340 cumulative_rf_motion = 0;
343 /* don't seek if locate will take care of that in non_realtime_stop() */
345 if (!(ptw & PostTransportLocate)) {
347 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
348 (*i)->non_realtime_locate (_transport_frame);
350 if (on_entry != g_atomic_int_get (&_butler->should_do_transport_work)) {
351 /* new request, stop seeking, and start again */
352 g_atomic_int_dec_and_test (&_butler->should_do_transport_work);
359 if (ptw & PostTransportLocate) {
360 non_realtime_locate ();
363 if (ptw & PostTransportStop) {
364 non_realtime_stop (ptw & PostTransportAbort, on_entry, finished);
366 g_atomic_int_dec_and_test (&_butler->should_do_transport_work);
371 if (ptw & PostTransportOverWrite) {
372 non_realtime_overwrite (on_entry, finished);
374 g_atomic_int_dec_and_test (&_butler->should_do_transport_work);
379 if (ptw & PostTransportAudition) {
380 non_realtime_set_audition ();
383 g_atomic_int_dec_and_test (&_butler->should_do_transport_work);
385 DEBUG_TRACE (DEBUG::Transport, X_("Butler transport work all done\n"));
386 DEBUG_TRACE (DEBUG::Transport, X_(string_compose ("Frame %1\n", _transport_frame)));
390 Session::non_realtime_set_speed ()
392 boost::shared_ptr<RouteList> rl = routes.reader();
393 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
394 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
396 tr->non_realtime_set_speed ();
402 Session::non_realtime_overwrite (int on_entry, bool& finished)
404 boost::shared_ptr<RouteList> rl = routes.reader();
405 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
406 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
407 if (tr && tr->pending_overwrite ()) {
408 tr->overwrite_existing_buffers ();
410 if (on_entry != g_atomic_int_get (&_butler->should_do_transport_work)) {
419 Session::non_realtime_locate ()
421 boost::shared_ptr<RouteList> rl = routes.reader();
422 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
423 (*i)->non_realtime_locate (_transport_frame);
426 /* XXX: it would be nice to generate the new clicks here (in the non-RT thread)
427 rather than clearing them so that the RT thread has to spend time constructing
428 them (in Session::click).
435 Session::non_realtime_stop (bool abort, int on_entry, bool& finished)
441 PostTransportWork ptw = post_transport_work();
446 boost::shared_ptr<RouteList> rl = routes.reader();
447 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
448 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
449 if (tr && tr->get_captured_frames () != 0) {
455 /* stop and locate are merged here because they share a lot of common stuff */
458 now = localtime (&xnow);
461 auditioner->cancel_audition ();
464 cumulative_rf_motion = 0;
468 begin_reversible_command (Operations::capture);
469 _have_captured = true;
472 DEBUG_TRACE (DEBUG::Transport, X_("Butler PTW: DS stop\n"));
474 if (abort && did_record) {
475 /* no reason to save the session file when we remove sources
477 _state_of_the_state = StateOfTheState (_state_of_the_state|InCleanup);
480 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
481 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
483 tr->transport_stopped_wallclock (*now, xnow, abort);
487 if (abort && did_record) {
488 _state_of_the_state = StateOfTheState (_state_of_the_state & ~InCleanup);
491 boost::shared_ptr<RouteList> r = routes.reader ();
493 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
494 if (!(*i)->is_auditioner()) {
495 (*i)->set_pending_declick (0);
500 commit_reversible_command ();
503 if (_engine.running()) {
504 PostTransportWork ptw = post_transport_work ();
505 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
506 (*i)->nonrealtime_handle_transport_stopped (abort, (ptw & PostTransportLocate), (!(ptw & PostTransportLocate) || pending_locate_flush));
508 update_latency_compensation ();
511 bool const auto_return_enabled =
512 (!config.get_external_sync() && config.get_auto_return());
514 if (auto_return_enabled ||
515 (ptw & PostTransportLocate) ||
516 (_requested_return_frame >= 0) ||
517 synced_to_engine()) {
519 if (pending_locate_flush) {
520 flush_all_inserts ();
523 if ((auto_return_enabled || synced_to_engine() || _requested_return_frame >= 0) &&
524 !(ptw & PostTransportLocate)) {
526 /* no explicit locate queued */
528 bool do_locate = false;
530 if (_requested_return_frame >= 0) {
532 /* explicit return request pre-queued in event list. overrides everything else */
534 cerr << "explicit auto-return to " << _requested_return_frame << endl;
536 _transport_frame = _requested_return_frame;
540 if (config.get_auto_return()) {
544 /* don't try to handle loop play when synced to JACK */
546 if (!synced_to_engine()) {
548 Location *location = _locations->auto_loop_location();
551 _transport_frame = location->start();
553 _transport_frame = _last_roll_location;
558 } else if (_play_range) {
560 /* return to start of range */
562 if (!current_audio_range.empty()) {
563 _transport_frame = current_audio_range.front().start;
569 /* regular auto-return */
571 _transport_frame = _last_roll_location;
577 _requested_return_frame = -1;
580 _engine.transport_locate (_transport_frame);
588 /* do this before seeking, because otherwise the tracks will do the wrong thing in seamless loop mode.
591 if (ptw & PostTransportClearSubstate) {
596 /* this for() block can be put inside the previous if() and has the effect of ... ??? what */
598 DEBUG_TRACE (DEBUG::Transport, X_("Butler PTW: locate\n"));
599 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
600 DEBUG_TRACE (DEBUG::Transport, string_compose ("Butler PTW: locate on %1\n", (*i)->name()));
601 (*i)->non_realtime_locate (_transport_frame);
603 if (on_entry != g_atomic_int_get (&_butler->should_do_transport_work)) {
605 /* we will be back */
612 /* don't bother with this stuff if we're disconnected from the engine,
613 because there will be no process callbacks to deliver stuff from
616 if (_engine.connected() && !_engine.freewheeling()) {
617 // need to queue this in the next RT cycle
618 _send_timecode_update = true;
620 if (!dynamic_cast<MTC_Slave*>(_slave)) {
621 _mmc->send (MIDI::MachineControlCommand (MIDI::MachineControl::cmdStop));
623 /* This (::non_realtime_stop()) gets called by main
624 process thread, which will lead to confusion
625 when calling AsyncMIDIPort::write().
627 Something must be done. XXX
629 send_mmc_locate (_transport_frame);
633 if ((ptw & PostTransportLocate) && get_record_enabled()) {
634 /* This is scheduled by realtime_stop(), which is also done
635 * when a slave requests /locate/ for an initial sync.
636 * We can't hold up the slave for long with a save() here,
637 * without breaking its initial sync cycle.
639 * save state only if there's no slave or if it's not yet locked.
641 if (!_slave || !_slave->locked()) {
642 DEBUG_TRACE (DEBUG::Transport, X_("Butler PTW: pending save\n"));
643 /* capture start has been changed, so save pending state */
644 save_state ("", true);
649 /* always try to get rid of this */
651 remove_pending_capture_state ();
653 /* save the current state of things if appropriate */
655 if (did_record && !saved) {
656 save_state (_current_snapshot_name);
659 if (ptw & PostTransportStop) {
664 PositionChanged (_transport_frame); /* EMIT SIGNAL */
665 DEBUG_TRACE (DEBUG::Transport, string_compose ("send TSC with speed = %1\n", _transport_speed));
666 TransportStateChange (); /* EMIT SIGNAL */
668 /* and start it up again if relevant */
670 if ((ptw & PostTransportLocate) && !config.get_external_sync() && pending_locate_roll) {
671 request_transport_speed (1.0);
674 /* Even if we didn't do a pending locate roll this time, we don't want it hanging
675 around for next time.
677 pending_locate_roll = false;
681 Session::check_declick_out ()
683 bool locate_required = transport_sub_state & PendingLocate;
685 /* this is called after a process() iteration. if PendingDeclickOut was set,
686 it means that we were waiting to declick the output (which has just been
687 done) before maybe doing something else. this is where we do that "something else".
689 note: called from the audio thread.
692 if (transport_sub_state & PendingDeclickOut) {
694 if (locate_required) {
695 start_locate (pending_locate_frame, pending_locate_roll, pending_locate_flush);
696 transport_sub_state &= ~(PendingDeclickOut|PendingLocate);
698 stop_transport (pending_abort);
699 transport_sub_state &= ~(PendingDeclickOut|PendingLocate);
702 } else if (transport_sub_state & PendingLoopDeclickOut) {
703 /* Nothing else to do here; we've declicked, and the loop event will be along shortly */
704 transport_sub_state &= ~PendingLoopDeclickOut;
709 Session::unset_play_loop ()
712 clear_events (SessionEvent::AutoLoop);
713 clear_events (SessionEvent::AutoLoopDeclick);
715 // set all tracks to NOT use internal looping
716 boost::shared_ptr<RouteList> rl = routes.reader ();
717 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
718 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
719 if (tr && !tr->hidden()) {
726 Session::set_play_loop (bool yn)
728 /* Called from event-handling context */
732 if (yn == play_loop || (actively_recording() && yn) || (loc = _locations->auto_loop_location()) == 0) {
733 /* nothing to do, or can't change loop status while recording */
737 if (yn && Config->get_seamless_loop() && synced_to_engine()) {
738 warning << string_compose (
739 _("Seamless looping cannot be supported while %1 is using JACK transport.\n"
740 "Recommend changing the configured options"), PROGRAM_NAME)
753 if (Config->get_seamless_loop()) {
754 // set all tracks to use internal looping
755 boost::shared_ptr<RouteList> rl = routes.reader ();
756 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
757 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
758 if (tr && !tr->hidden()) {
764 // set all tracks to NOT use internal looping
765 boost::shared_ptr<RouteList> rl = routes.reader ();
766 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
767 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
768 if (tr && !tr->hidden()) {
774 /* Put the delick and loop events in into the event list. The declick event will
775 cause a de-clicking fade-out just before the end of the loop, and it will also result
776 in a fade-in when the loop restarts. The AutoLoop event will peform the actual loop.
781 auto_loop_declick_range (loc, dcp, dcl);
782 merge_event (new SessionEvent (SessionEvent::AutoLoopDeclick, SessionEvent::Replace, dcp, dcl, 0.0f));
783 merge_event (new SessionEvent (SessionEvent::AutoLoop, SessionEvent::Replace, loc->end(), loc->start(), 0.0f));
785 /* locate to start of loop and roll.
787 args: positition, roll=true, flush=true, with_loop=false, force buffer refill if seamless looping
790 start_locate (loc->start(), true, true, false, Config->get_seamless_loop());
798 DEBUG_TRACE (DEBUG::Transport, string_compose ("send TSC2 with speed = %1\n", _transport_speed));
799 TransportStateChange ();
802 Session::flush_all_inserts ()
804 boost::shared_ptr<RouteList> r = routes.reader ();
806 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
807 (*i)->flush_processors ();
812 Session::start_locate (framepos_t target_frame, bool with_roll, bool with_flush, bool with_loop, bool force)
814 if (synced_to_engine()) {
819 _slave->speed_and_position (sp, pos);
821 if (target_frame != pos) {
823 if (config.get_jack_time_master()) {
824 /* actually locate now, since otherwise jack_timebase_callback
825 will use the incorrect _transport_frame and report an old
826 and incorrect time to Jack transport
828 locate (target_frame, with_roll, with_flush, with_loop, force);
831 /* tell JACK to change transport position, and we will
832 follow along later in ::follow_slave()
835 _engine.transport_locate (target_frame);
837 if (sp != 1.0f && with_roll) {
838 _engine.transport_start ();
844 locate (target_frame, with_roll, with_flush, with_loop, force);
849 Session::micro_locate (framecnt_t distance)
851 boost::shared_ptr<RouteList> rl = routes.reader();
852 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
853 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
854 if (tr && !tr->can_internal_playback_seek (distance)) {
859 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
860 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
862 tr->internal_playback_seek (distance);
866 _transport_frame += distance;
870 /** @param with_mmc true to send a MMC locate command when the locate is done */
872 Session::locate (framepos_t target_frame, bool with_roll, bool with_flush, bool for_seamless_loop, bool force, bool with_mmc)
874 /* Locates for seamless looping are fairly different from other
875 * locates. They assume that the diskstream buffers for each track
876 * already have the correct data in them, and thus there is no need to
877 * actually tell the tracks to locate. What does need to be done,
878 * though, is all the housekeeping that is associated with non-linear
879 * changes in the value of _transport_frame.
882 if (actively_recording() && !for_seamless_loop) {
886 if (!force && _transport_frame == target_frame && !loop_changing && !for_seamless_loop) {
888 set_transport_speed (1.0, false);
890 loop_changing = false;
891 Located (); /* EMIT SIGNAL */
895 if (_transport_speed && !for_seamless_loop) {
896 /* Schedule a declick. We'll be called again when its done.
897 We only do it this way for ordinary locates, not those
898 due to **seamless** loops.
901 if (!(transport_sub_state & PendingDeclickOut)) {
902 transport_sub_state |= (PendingDeclickOut|PendingLocate);
903 pending_locate_frame = target_frame;
904 pending_locate_roll = with_roll;
905 pending_locate_flush = with_flush;
910 // Update Timecode time
911 // [DR] FIXME: find out exactly where this should go below
912 _transport_frame = target_frame;
913 _last_roll_or_reversal_location = target_frame;
914 timecode_time(_transport_frame, transmitting_timecode_time);
915 outbound_mtc_timecode_frame = _transport_frame;
916 next_quarter_frame_to_send = 0;
918 /* do "stopped" stuff if:
921 * no autoplay in effect AND
922 * we're not going to keep rolling after the locate AND
923 * !(playing a loop with JACK sync)
927 bool transport_was_stopped = !transport_rolling();
929 if (transport_was_stopped && (!auto_play_legal || !config.get_auto_play()) && !with_roll && !(synced_to_engine() && play_loop)) {
930 realtime_stop (false, true); // XXX paul - check if the 2nd arg is really correct
931 transport_was_stopped = true;
933 /* otherwise tell the world that we located */
937 if (force || !for_seamless_loop || loop_changing) {
939 PostTransportWork todo = PostTransportLocate;
941 if (with_roll && transport_was_stopped) {
942 todo = PostTransportWork (todo | PostTransportRoll);
945 add_post_transport_work (todo);
946 _butler->schedule_transport_work ();
950 /* this is functionally what clear_clicks() does but with a tentative lock */
952 Glib::Threads::RWLock::WriterLock clickm (click_lock, Glib::Threads::TRY_LOCK);
954 if (clickm.locked()) {
956 for (Clicks::iterator i = clicks.begin(); i != clicks.end(); ++i) {
965 /* switch from input if we're going to roll */
966 if (Config->get_monitoring_model() == HardwareMonitoring) {
967 set_track_monitor_input_status (!config.get_auto_input());
970 /* otherwise we're going to stop, so do the opposite */
971 if (Config->get_monitoring_model() == HardwareMonitoring) {
972 set_track_monitor_input_status (true);
976 /* cancel looped playback if transport pos outside of loop range */
979 Location* al = _locations->auto_loop_location();
982 if (_transport_frame < al->start() || _transport_frame > al->end()) {
984 // located outside the loop: cancel looping directly, this is called from event handling context
986 set_play_loop (false);
988 } else if (_transport_frame == al->start()) {
990 // located to start of loop - this is looping, basically
992 if (for_seamless_loop) {
994 // this is only necessary for seamless looping
996 boost::shared_ptr<RouteList> rl = routes.reader();
998 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
999 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
1001 if (tr && tr->record_enabled ()) {
1002 // tell it we've looped, so it can deal with the record state
1003 tr->transport_looped (_transport_frame);
1009 TransportLooped(); // EMIT SIGNAL
1014 loop_changing = false;
1016 _send_timecode_update = true;
1019 send_mmc_locate (_transport_frame);
1022 _last_roll_location = _last_roll_or_reversal_location = _transport_frame;
1023 Located (); /* EMIT SIGNAL */
1026 /** Set the transport speed.
1027 * Called from the process thread.
1028 * @param speed New speed
1031 Session::set_transport_speed (double speed, bool abort, bool clear_state, bool as_default)
1033 DEBUG_TRACE (DEBUG::Transport, string_compose ("@ %5 Set transport speed to %1, abort = %2 clear_state = %3, current = %4 as_default %6\n",
1034 speed, abort, clear_state, _transport_speed, _transport_frame, as_default));
1036 if (_transport_speed == speed) {
1037 if (as_default && speed == 0.0) { // => reset default transport speed. hacky or what?
1038 _default_transport_speed = 1.0;
1043 if (actively_recording() && speed != 1.0 && speed != 0.0) {
1044 /* no varispeed during recording */
1045 DEBUG_TRACE (DEBUG::Transport, string_compose ("No varispeed during recording cur_speed %1, frame %2\n",
1046 _transport_speed, _transport_frame));
1050 _target_transport_speed = fabs(speed);
1052 /* 8.0 max speed is somewhat arbitrary but based on guestimates regarding disk i/o capability
1053 and user needs. We really need CD-style "skip" playback for ffwd and rewind.
1057 speed = min (8.0, speed);
1058 } else if (speed < 0) {
1059 speed = max (-8.0, speed);
1062 if (transport_rolling() && speed == 0.0) {
1064 /* we are rolling and we want to stop */
1066 if (Config->get_monitoring_model() == HardwareMonitoring) {
1067 set_track_monitor_input_status (true);
1070 if (synced_to_engine ()) {
1072 /* do this here because our response to the slave won't
1075 _play_range = false;
1078 _engine.transport_stop ();
1080 stop_transport (abort);
1085 } else if (transport_stopped() && speed == 1.0) {
1087 /* we are stopped and we want to start rolling at speed 1 */
1089 if (Config->get_monitoring_model() == HardwareMonitoring && config.get_auto_input()) {
1090 set_track_monitor_input_status (false);
1093 if (synced_to_engine()) {
1094 _engine.transport_start ();
1101 /* not zero, not 1.0 ... varispeed */
1103 if ((synced_to_engine()) && speed != 0.0 && speed != 1.0) {
1104 warning << string_compose (
1105 _("Global varispeed cannot be supported while %1 is connected to JACK transport control"),
1111 if (actively_recording()) {
1115 if (speed > 0.0 && _transport_frame == current_end_frame()) {
1119 if (speed < 0.0 && _transport_frame == 0) {
1125 /* if we are reversing relative to the current speed, or relative to the speed
1126 before the last stop, then we have to do extra work.
1129 PostTransportWork todo = PostTransportWork (0);
1131 if ((_transport_speed && speed * _transport_speed < 0.0) || (_last_transport_speed * speed < 0.0) || (_last_transport_speed == 0.0f && speed < 0.0f)) {
1132 todo = PostTransportWork (todo | PostTransportReverse);
1133 _last_roll_or_reversal_location = _transport_frame;
1136 _last_transport_speed = _transport_speed;
1137 _transport_speed = speed;
1140 _default_transport_speed = speed;
1143 boost::shared_ptr<RouteList> rl = routes.reader();
1144 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1145 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
1146 if (tr && tr->realtime_set_speed (tr->speed(), true)) {
1147 todo = PostTransportWork (todo | PostTransportSpeed);
1152 add_post_transport_work (todo);
1153 _butler->schedule_transport_work ();
1156 DEBUG_TRACE (DEBUG::Transport, string_compose ("send TSC3 with speed = %1\n", _transport_speed));
1157 TransportStateChange (); /* EMIT SIGNAL */
1162 /** Stop the transport. */
1164 Session::stop_transport (bool abort, bool clear_state)
1166 if (_transport_speed == 0.0f) {
1170 if (actively_recording() && !(transport_sub_state & StopPendingCapture) && worst_input_latency() > current_block_size) {
1172 boost::shared_ptr<RouteList> rl = routes.reader();
1173 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1174 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
1176 tr->prepare_to_stop (_transport_frame);
1180 /* we need to capture the audio that has still not yet been received by the system
1181 at the time the stop is requested, so we have to roll past that time.
1183 we want to declick before stopping, so schedule the autostop for one
1184 block before the actual end. we'll declick in the subsequent block,
1185 and then we'll really be stopped.
1188 DEBUG_TRACE (DEBUG::Transport, string_compose ("stop transport requested @ %1, scheduled for + %2 - %3 = %4, abort = %5\n",
1189 _transport_frame, _worst_input_latency, current_block_size,
1190 _transport_frame - _worst_input_latency - current_block_size,
1193 SessionEvent *ev = new SessionEvent (SessionEvent::StopOnce, SessionEvent::Replace,
1194 _transport_frame + _worst_input_latency - current_block_size,
1198 transport_sub_state |= StopPendingCapture;
1199 pending_abort = abort;
1203 if ((transport_sub_state & PendingDeclickOut) == 0) {
1205 if (!(transport_sub_state & StopPendingCapture)) {
1206 boost::shared_ptr<RouteList> rl = routes.reader();
1207 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1208 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
1210 tr->prepare_to_stop (_transport_frame);
1215 transport_sub_state |= PendingDeclickOut;
1216 /* we'll be called again after the declick */
1217 pending_abort = abort;
1221 realtime_stop (abort, clear_state);
1222 _butler->schedule_transport_work ();
1225 /** Called from the process thread */
1227 Session::start_transport ()
1229 DEBUG_TRACE (DEBUG::Transport, "start_transport\n");
1231 _last_roll_location = _transport_frame;
1232 _last_roll_or_reversal_location = _transport_frame;
1234 have_looped = false;
1236 /* if record status is Enabled, move it to Recording. if its
1237 already Recording, move it to Disabled.
1240 switch (record_status()) {
1242 if (!config.get_punch_in()) {
1249 disable_record (false);
1257 transport_sub_state |= PendingDeclickIn;
1259 _transport_speed = _default_transport_speed;
1260 _target_transport_speed = _transport_speed;
1262 boost::shared_ptr<RouteList> rl = routes.reader();
1263 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1264 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
1266 tr->realtime_set_speed (tr->speed(), true);
1270 if (!_engine.freewheeling()) {
1271 Timecode::Time time;
1272 timecode_time_subframes (_transport_frame, time);
1273 if (!dynamic_cast<MTC_Slave*>(_slave)) {
1274 _mmc->send (MIDI::MachineControlCommand (MIDI::MachineControl::cmdDeferredPlay));
1278 DEBUG_TRACE (DEBUG::Transport, string_compose ("send TSC4 with speed = %1\n", _transport_speed));
1279 TransportStateChange (); /* EMIT SIGNAL */
1282 /** Do any transport work in the audio thread that needs to be done after the
1283 * transport thread is finished. Audio thread, realtime safe.
1286 Session::post_transport ()
1288 PostTransportWork ptw = post_transport_work ();
1290 if (ptw & PostTransportAudition) {
1291 if (auditioner && auditioner->auditioning()) {
1292 process_function = &Session::process_audition;
1294 process_function = &Session::process_with_events;
1298 if (ptw & PostTransportStop) {
1300 transport_sub_state = 0;
1303 if (ptw & PostTransportLocate) {
1305 if (((!config.get_external_sync() && (auto_play_legal && config.get_auto_play())) && !_exporting) || (ptw & PostTransportRoll)) {
1308 transport_sub_state = 0;
1313 /* XXX is this really safe? shouldn't we just be unsetting the bits that we actually
1316 set_post_transport_work (PostTransportWork (0));
1320 Session::reset_rf_scale (framecnt_t motion)
1322 cumulative_rf_motion += motion;
1324 if (cumulative_rf_motion < 4 * _current_frame_rate) {
1326 } else if (cumulative_rf_motion < 8 * _current_frame_rate) {
1328 } else if (cumulative_rf_motion < 16 * _current_frame_rate) {
1340 Session::use_sync_source (Slave* new_slave)
1342 /* Runs in process() context */
1344 bool non_rt_required = false;
1346 /* XXX this deletion is problematic because we're in RT context */
1351 DEBUG_TRACE (DEBUG::Slave, string_compose ("set new slave to %1\n", _slave));
1353 // need to queue this for next process() cycle
1354 _send_timecode_update = true;
1356 boost::shared_ptr<RouteList> rl = routes.reader();
1357 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1358 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
1359 if (tr && !tr->hidden()) {
1360 if (tr->realtime_set_speed (tr->speed(), true)) {
1361 non_rt_required = true;
1363 tr->set_slaved (_slave != 0);
1367 if (non_rt_required) {
1368 add_post_transport_work (PostTransportSpeed);
1369 _butler->schedule_transport_work ();
1376 Session::drop_sync_source ()
1378 request_sync_source (0);
1382 Session::switch_to_sync_source (SyncSource src)
1386 DEBUG_TRACE (DEBUG::Slave, string_compose ("Setting up sync source %1\n", enum_2_string (src)));
1390 if (_slave && dynamic_cast<MTC_Slave*>(_slave)) {
1395 new_slave = new MTC_Slave (*this, *_midi_ports->mtc_input_port());
1398 catch (failed_constructor& err) {
1404 if (_slave && dynamic_cast<LTC_Slave*>(_slave)) {
1409 new_slave = new LTC_Slave (*this);
1412 catch (failed_constructor& err) {
1419 if (_slave && dynamic_cast<MIDIClock_Slave*>(_slave)) {
1424 new_slave = new MIDIClock_Slave (*this, *_midi_ports->midi_clock_input_port(), 24);
1427 catch (failed_constructor& err) {
1433 if (_slave && dynamic_cast<Engine_Slave*>(_slave)) {
1437 if (config.get_video_pullup() != 0.0f) {
1441 new_slave = new Engine_Slave (*AudioEngine::instance());
1449 request_sync_source (new_slave);
1453 Session::set_track_speed (Track* track, double speed)
1455 if (track->realtime_set_speed (speed, false)) {
1456 add_post_transport_work (PostTransportSpeed);
1457 _butler->schedule_transport_work ();
1463 Session::unset_play_range ()
1465 _play_range = false;
1466 _clear_event_type (SessionEvent::RangeStop);
1467 _clear_event_type (SessionEvent::RangeLocate);
1471 Session::set_play_range (list<AudioRange>& range, bool leave_rolling)
1475 /* Called from event-processing context */
1477 unset_play_range ();
1479 if (range.empty()) {
1480 /* _play_range set to false in unset_play_range()
1482 if (!leave_rolling) {
1483 /* stop transport */
1484 SessionEvent* ev = new SessionEvent (SessionEvent::SetTransportSpeed, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0f, false);
1492 /* cancel loop play */
1495 list<AudioRange>::size_type sz = range.size();
1499 list<AudioRange>::iterator i = range.begin();
1500 list<AudioRange>::iterator next;
1502 while (i != range.end()) {
1507 /* locating/stopping is subject to delays for declicking.
1510 framepos_t requested_frame = i->end;
1512 if (requested_frame > current_block_size) {
1513 requested_frame -= current_block_size;
1515 requested_frame = 0;
1518 if (next == range.end()) {
1519 ev = new SessionEvent (SessionEvent::RangeStop, SessionEvent::Add, requested_frame, 0, 0.0f);
1521 ev = new SessionEvent (SessionEvent::RangeLocate, SessionEvent::Add, requested_frame, (*next).start, 0.0f);
1529 } else if (sz == 1) {
1531 ev = new SessionEvent (SessionEvent::RangeStop, SessionEvent::Add, range.front().end, 0, 0.0f);
1536 /* save range so we can do auto-return etc. */
1538 current_audio_range = range;
1540 /* now start rolling at the right place */
1542 ev = new SessionEvent (SessionEvent::LocateRoll, SessionEvent::Add, SessionEvent::Immediate, range.front().start, 0.0f, false);
1545 DEBUG_TRACE (DEBUG::Transport, string_compose ("send TSC5 with speed = %1\n", _transport_speed));
1546 TransportStateChange ();
1550 Session::request_bounded_roll (framepos_t start, framepos_t end)
1552 AudioRange ar (start, end, 0);
1553 list<AudioRange> lar;
1556 request_play_range (&lar, true);
1559 Session::request_roll_at_and_return (framepos_t start, framepos_t return_to)
1561 SessionEvent *ev = new SessionEvent (SessionEvent::LocateRollLocate, SessionEvent::Add, SessionEvent::Immediate, return_to, 1.0);
1562 ev->target2_frame = start;
1567 Session::engine_halted ()
1571 /* there will be no more calls to process(), so
1572 we'd better clean up for ourselves, right now.
1574 but first, make sure the butler is out of
1579 g_atomic_int_set (&_butler->should_do_transport_work, 0);
1580 set_post_transport_work (PostTransportWork (0));
1584 realtime_stop (false, true);
1585 non_realtime_stop (false, 0, ignored);
1586 transport_sub_state = 0;
1588 DEBUG_TRACE (DEBUG::Transport, string_compose ("send TSC6 with speed = %1\n", _transport_speed));
1589 TransportStateChange (); /* EMIT SIGNAL */
1594 Session::xrun_recovery ()
1596 Xrun (_transport_frame); /* EMIT SIGNAL */
1598 if (Config->get_stop_recording_on_xrun() && actively_recording()) {
1600 /* it didn't actually halt, but we need
1601 to handle things in the same way.
1609 Session::route_processors_changed (RouteProcessorChange c)
1611 if (ignore_route_processor_changes) {
1615 if (c.type == RouteProcessorChange::MeterPointChange) {
1619 update_latency_compensation ();
1626 Session::allow_auto_play (bool yn)
1628 auto_play_legal = yn;
1632 Session::maybe_stop (framepos_t limit)
1634 if ((_transport_speed > 0.0f && _transport_frame >= limit) || (_transport_speed < 0.0f && _transport_frame == 0)) {
1635 if (synced_to_engine () && config.get_jack_time_master ()) {
1636 _engine.transport_stop ();
1637 } else if (!synced_to_engine ()) {
1646 Session::send_mmc_locate (framepos_t t)
1648 if (!_engine.freewheeling()) {
1649 Timecode::Time time;
1650 timecode_time_subframes (t, time);
1651 _mmc->send (MIDI::MachineControlCommand (time));
1655 /** Ask the transport to not send timecode until further notice. The suspension
1656 * will come into effect some finite time after this call, and timecode_transmission_suspended()
1657 * should be checked by the caller to find out when.
1660 Session::request_suspend_timecode_transmission ()
1662 SessionEvent* ev = new SessionEvent (SessionEvent::SetTimecodeTransmission, SessionEvent::Add, SessionEvent::Immediate, 0, 0, false);
1667 Session::request_resume_timecode_transmission ()
1669 SessionEvent* ev = new SessionEvent (SessionEvent::SetTimecodeTransmission, SessionEvent::Add, SessionEvent::Immediate, 0, 0, true);
1674 Session::timecode_transmission_suspended () const
1676 return g_atomic_int_get (&_suspend_timecode_transmission) == 1;