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"
33 #include "pbd/stacktrace.h"
35 #include "midi++/mmc.h"
36 #include "midi++/port.h"
38 #include "ardour/audioengine.h"
39 #include "ardour/auditioner.h"
40 #include "ardour/butler.h"
41 #include "ardour/click.h"
42 #include "ardour/debug.h"
43 #include "ardour/location.h"
44 #include "ardour/profile.h"
45 #include "ardour/scene_changer.h"
46 #include "ardour/session.h"
47 #include "ardour/slave.h"
48 #include "ardour/operations.h"
53 using namespace ARDOUR;
57 Session::add_post_transport_work (PostTransportWork ptw)
59 PostTransportWork oldval;
60 PostTransportWork newval;
64 oldval = (PostTransportWork) g_atomic_int_get (&_post_transport_work);
65 newval = PostTransportWork (oldval | ptw);
66 if (g_atomic_int_compare_and_exchange (&_post_transport_work, oldval, newval)) {
72 error << "Could not set post transport work! Crazy thread madness, call the programmers" << endmsg;
76 Session::request_input_change_handling ()
78 if (!(_state_of_the_state & (InitialConnecting|Deletion))) {
79 SessionEvent* ev = new SessionEvent (SessionEvent::InputConfigurationChange, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
85 Session::request_sync_source (Slave* new_slave)
87 SessionEvent* ev = new SessionEvent (SessionEvent::SetSyncSource, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
90 seamless = Config->get_seamless_loop ();
92 if (dynamic_cast<Engine_Slave*>(new_slave)) {
93 /* JACK cannot support seamless looping at present */
94 Config->set_seamless_loop (false);
96 /* reset to whatever the value was before we last switched slaves */
97 Config->set_seamless_loop (_was_seamless);
100 /* save value of seamless from before the switch */
101 _was_seamless = seamless;
103 ev->slave = new_slave;
104 DEBUG_TRACE (DEBUG::Slave, "sent request for new slave\n");
109 Session::request_transport_speed (double speed, bool as_default)
111 SessionEvent* ev = new SessionEvent (SessionEvent::SetTransportSpeed, SessionEvent::Add, SessionEvent::Immediate, 0, speed);
112 ev->third_yes_or_no = true;
113 DEBUG_TRACE (DEBUG::Transport, string_compose ("Request transport speed = %1 as default = %2\n", speed, as_default));
117 /** Request a new transport speed, but if the speed parameter is exactly zero then use
118 * a very small +ve value to prevent the transport actually stopping. This method should
119 * be used by callers who are varying transport speed but don't ever want to stop it.
122 Session::request_transport_speed_nonzero (double speed, bool as_default)
128 request_transport_speed (speed, as_default);
132 Session::request_track_speed (Track* tr, double speed)
134 SessionEvent* ev = new SessionEvent (SessionEvent::SetTrackSpeed, SessionEvent::Add, SessionEvent::Immediate, 0, speed);
140 Session::request_stop (bool abort, bool clear_state)
142 SessionEvent* ev = new SessionEvent (SessionEvent::SetTransportSpeed, SessionEvent::Add, SessionEvent::Immediate, audible_frame(), 0.0, abort, clear_state);
143 DEBUG_TRACE (DEBUG::Transport, string_compose ("Request transport stop, audible %3 transport %4 abort = %1, clear state = %2\n", abort, clear_state, audible_frame(), _transport_frame));
148 Session::request_locate (framepos_t target_frame, bool with_roll)
150 SessionEvent *ev = new SessionEvent (with_roll ? SessionEvent::LocateRoll : SessionEvent::Locate, SessionEvent::Add, SessionEvent::Immediate, target_frame, 0, false);
151 DEBUG_TRACE (DEBUG::Transport, string_compose ("Request locate to %1\n", target_frame));
156 Session::force_locate (framepos_t target_frame, bool with_roll)
158 SessionEvent *ev = new SessionEvent (with_roll ? SessionEvent::LocateRoll : SessionEvent::Locate, SessionEvent::Add, SessionEvent::Immediate, target_frame, 0, true);
159 DEBUG_TRACE (DEBUG::Transport, string_compose ("Request forced locate to %1\n", target_frame));
164 Session::request_play_loop (bool yn, bool change_transport_roll)
167 Location *location = _locations->auto_loop_location();
170 if (location == 0 && yn) {
171 error << _("Cannot loop - no loop range defined")
176 if (change_transport_roll) {
177 if (transport_rolling()) {
178 /* start looping at current speed */
179 target_speed = transport_speed ();
181 /* currently stopped */
183 /* start looping at normal speed */
190 /* leave the speed alone */
191 target_speed = transport_speed ();
194 ev = new SessionEvent (SessionEvent::SetLoop, SessionEvent::Add, SessionEvent::Immediate, 0, target_speed, yn);
195 DEBUG_TRACE (DEBUG::Transport, string_compose ("Request set loop = %1, change roll state ? %2\n", yn, change_transport_roll));
199 if (!change_transport_roll) {
200 if (!transport_rolling()) {
201 /* we're not changing transport state, but we do want
202 to set up position for the new loop. Don't
203 do this if we're rolling already.
205 request_locate (location->start(), false);
209 if (!change_transport_roll && Config->get_seamless_loop() && transport_rolling()) {
210 // request an immediate locate to refresh the tracks
211 // after disabling looping
212 request_locate (_transport_frame-1, false);
218 Session::request_play_range (list<AudioRange>* range, bool leave_rolling)
220 SessionEvent* ev = new SessionEvent (SessionEvent::SetPlayAudioRange, SessionEvent::Add, SessionEvent::Immediate, 0, (leave_rolling ? 1.0 : 0.0));
222 ev->audio_range = *range;
224 ev->audio_range.clear ();
226 DEBUG_TRACE (DEBUG::Transport, string_compose ("Request play range, leave rolling ? %1\n", leave_rolling));
231 Session::request_cancel_play_range ()
233 SessionEvent* ev = new SessionEvent (SessionEvent::CancelPlayAudioRange, SessionEvent::Add, SessionEvent::Immediate, 0, 0);
239 Session::realtime_stop (bool abort, bool clear_state)
241 DEBUG_TRACE (DEBUG::Transport, string_compose ("realtime stop @ %1\n", _transport_frame));
242 PostTransportWork todo = PostTransportWork (0);
244 /* assume that when we start, we'll be moving forwards */
246 if (_transport_speed < 0.0f) {
247 todo = (PostTransportWork (todo | PostTransportStop | PostTransportReverse));
248 _default_transport_speed = 1.0;
250 todo = PostTransportWork (todo | PostTransportStop);
255 boost::shared_ptr<RouteList> r = routes.reader ();
257 for (RouteList::iterator i = r->begin (); i != r->end(); ++i) {
258 (*i)->realtime_handle_transport_stopped ();
261 DEBUG_TRACE (DEBUG::Transport, string_compose ("stop complete, auto-return scheduled for return to %1\n", _requested_return_frame));
263 /* the duration change is not guaranteed to have happened, but is likely */
265 todo = PostTransportWork (todo | PostTransportDuration);
268 todo = PostTransportWork (todo | PostTransportAbort);
272 todo = PostTransportWork (todo | PostTransportClearSubstate);
276 add_post_transport_work (todo);
279 _clear_event_type (SessionEvent::StopOnce);
280 _clear_event_type (SessionEvent::RangeStop);
281 _clear_event_type (SessionEvent::RangeLocate);
283 /* if we're going to clear loop state, then force disabling record BUT only if we're not doing latched rec-enable */
284 disable_record (true, (!Config->get_latched_record_enable() && clear_state));
286 reset_slave_state ();
288 _transport_speed = 0;
289 _target_transport_speed = 0;
291 g_atomic_int_set (&_playback_load, 100);
292 g_atomic_int_set (&_capture_load, 100);
294 if (config.get_use_video_sync()) {
295 waiting_for_sync_offset = true;
298 transport_sub_state = 0;
302 Session::realtime_locate ()
304 boost::shared_ptr<RouteList> r = routes.reader ();
305 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
306 (*i)->realtime_locate ();
311 Session::butler_transport_work ()
315 PostTransportWork ptw;
316 boost::shared_ptr<RouteList> r = routes.reader ();
318 int on_entry = g_atomic_int_get (&_butler->should_do_transport_work);
320 ptw = post_transport_work();
322 DEBUG_TRACE (DEBUG::Transport, string_compose ("Butler transport work, todo = %1\n", enum_2_string (ptw)));
324 if (ptw & PostTransportAdjustPlaybackBuffering) {
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->adjust_playback_buffering ();
329 /* and refill those buffers ... */
331 (*i)->non_realtime_locate (_transport_frame);
336 if (ptw & PostTransportAdjustCaptureBuffering) {
337 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
338 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
340 tr->adjust_capture_buffering ();
345 if (ptw & PostTransportCurveRealloc) {
346 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
347 (*i)->curve_reallocate();
351 if (ptw & PostTransportInputChange) {
352 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
353 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
355 tr->non_realtime_input_change ();
360 if (ptw & PostTransportSpeed) {
361 non_realtime_set_speed ();
364 if (ptw & PostTransportReverse) {
367 cumulative_rf_motion = 0;
370 /* don't seek if locate will take care of that in non_realtime_stop() */
372 if (!(ptw & PostTransportLocate)) {
374 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
375 (*i)->non_realtime_locate (_transport_frame);
377 if (on_entry != g_atomic_int_get (&_butler->should_do_transport_work)) {
378 /* new request, stop seeking, and start again */
379 g_atomic_int_dec_and_test (&_butler->should_do_transport_work);
386 if (ptw & PostTransportLocate) {
387 DEBUG_TRACE (DEBUG::Transport, "nonrealtime locate invoked from BTW\n");
388 non_realtime_locate ();
391 if (ptw & PostTransportStop) {
392 non_realtime_stop (ptw & PostTransportAbort, on_entry, finished);
394 g_atomic_int_dec_and_test (&_butler->should_do_transport_work);
399 if (ptw & PostTransportOverWrite) {
400 non_realtime_overwrite (on_entry, finished);
402 g_atomic_int_dec_and_test (&_butler->should_do_transport_work);
407 if (ptw & PostTransportAudition) {
408 non_realtime_set_audition ();
411 g_atomic_int_dec_and_test (&_butler->should_do_transport_work);
413 DEBUG_TRACE (DEBUG::Transport, X_("Butler transport work all done\n"));
414 DEBUG_TRACE (DEBUG::Transport, X_(string_compose ("Frame %1\n", _transport_frame)));
418 Session::non_realtime_set_speed ()
420 boost::shared_ptr<RouteList> rl = routes.reader();
421 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
422 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
424 tr->non_realtime_set_speed ();
430 Session::non_realtime_overwrite (int on_entry, bool& finished)
432 boost::shared_ptr<RouteList> rl = routes.reader();
433 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
434 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
435 if (tr && tr->pending_overwrite ()) {
436 tr->overwrite_existing_buffers ();
438 if (on_entry != g_atomic_int_get (&_butler->should_do_transport_work)) {
447 Session::non_realtime_locate ()
449 DEBUG_TRACE (DEBUG::Transport, string_compose ("locate tracks to %1\n", _transport_frame));
451 if (Config->get_loop_is_mode() && get_play_loop()) {
453 Location *loc = _locations->auto_loop_location();
455 if (!loc || (_transport_frame < loc->start() || _transport_frame >= loc->end())) {
456 /* jumped out of loop range: stop tracks from looping,
457 but leave loop (mode) enabled.
459 set_track_loop (false);
461 } else if (loc && Config->get_seamless_loop() &&
462 ((loc->start() <= _transport_frame) ||
463 (loc->end() > _transport_frame) ) ) {
465 /* jumping to start of loop. This might have been done before but it is
466 * idempotent and cheap. Doing it here ensures that when we start playback
467 * outside the loop we still flip tracks into the magic seamless mode
470 set_track_loop (true);
473 set_track_loop (false);
478 /* no more looping .. should have been noticed elsewhere */
482 boost::shared_ptr<RouteList> rl = routes.reader();
483 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
484 (*i)->non_realtime_locate (_transport_frame);
487 _scene_changer->locate (_transport_frame);
489 /* XXX: it would be nice to generate the new clicks here (in the non-RT thread)
490 rather than clearing them so that the RT thread has to spend time constructing
491 them (in Session::click).
497 Session::non_realtime_stop (bool abort, int on_entry, bool& finished)
503 PostTransportWork ptw = post_transport_work();
508 boost::shared_ptr<RouteList> rl = routes.reader();
509 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
510 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
511 if (tr && tr->get_captured_frames () != 0) {
517 /* stop and locate are merged here because they share a lot of common stuff */
520 now = localtime (&xnow);
523 auditioner->cancel_audition ();
526 cumulative_rf_motion = 0;
530 begin_reversible_command (Operations::capture);
531 _have_captured = true;
534 DEBUG_TRACE (DEBUG::Transport, X_("Butler PTW: DS stop\n"));
536 if (abort && did_record) {
537 /* no reason to save the session file when we remove sources
539 _state_of_the_state = StateOfTheState (_state_of_the_state|InCleanup);
542 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
543 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
545 tr->transport_stopped_wallclock (*now, xnow, abort);
549 if (abort && did_record) {
550 _state_of_the_state = StateOfTheState (_state_of_the_state & ~InCleanup);
553 boost::shared_ptr<RouteList> r = routes.reader ();
555 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
556 if (!(*i)->is_auditioner()) {
557 (*i)->set_pending_declick (0);
562 commit_reversible_command ();
563 /* increase take name */
564 if (config.get_track_name_take () && !config.get_take_name ().empty()) {
565 string newname = config.get_take_name();
566 config.set_take_name(bump_name_number (newname));
570 if (_engine.running()) {
571 PostTransportWork ptw = post_transport_work ();
572 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
573 (*i)->nonrealtime_handle_transport_stopped (abort, (ptw & PostTransportLocate), (!(ptw & PostTransportLocate) || pending_locate_flush));
575 update_latency_compensation ();
578 bool const auto_return_enabled =
579 (!config.get_external_sync() && (config.get_auto_return() || abort));
581 if (auto_return_enabled ||
582 (ptw & PostTransportLocate) ||
583 (_requested_return_frame >= 0) ||
584 synced_to_engine()) {
586 if (pending_locate_flush) {
587 flush_all_inserts ();
590 if ((auto_return_enabled || synced_to_engine() || _requested_return_frame >= 0) &&
591 !(ptw & PostTransportLocate)) {
593 /* no explicit locate queued */
595 bool do_locate = false;
597 if (_requested_return_frame >= 0) {
599 /* explicit return request pre-queued in event list. overrides everything else */
601 _transport_frame = _requested_return_frame;
605 if (config.get_auto_return()) {
609 /* don't try to handle loop play when synced to JACK */
611 if (!synced_to_engine()) {
613 Location *location = _locations->auto_loop_location();
616 _transport_frame = location->start();
618 _transport_frame = _last_roll_location;
623 } else if (_play_range) {
625 /* return to start of range */
627 if (!current_audio_range.empty()) {
628 _transport_frame = current_audio_range.front().start;
634 /* regular auto-return */
636 _transport_frame = _last_roll_location;
641 _transport_frame = _last_roll_location;
646 _requested_return_frame = -1;
649 _engine.transport_locate (_transport_frame);
657 /* do this before seeking, because otherwise the tracks will do the wrong thing in seamless loop mode.
660 if (ptw & PostTransportClearSubstate) {
662 if (!Config->get_loop_is_mode()) {
667 /* this for() block can be put inside the previous if() and has the effect of ... ??? what */
669 DEBUG_TRACE (DEBUG::Transport, X_("Butler PTW: locate\n"));
670 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
671 DEBUG_TRACE (DEBUG::Transport, string_compose ("Butler PTW: locate on %1\n", (*i)->name()));
672 (*i)->non_realtime_locate (_transport_frame);
674 if (on_entry != g_atomic_int_get (&_butler->should_do_transport_work)) {
676 /* we will be back */
683 /* don't bother with this stuff if we're disconnected from the engine,
684 because there will be no process callbacks to deliver stuff from
687 if (_engine.connected() && !_engine.freewheeling()) {
688 // need to queue this in the next RT cycle
689 _send_timecode_update = true;
691 if (!dynamic_cast<MTC_Slave*>(_slave)) {
692 send_immediate_mmc (MIDI::MachineControlCommand (MIDI::MachineControl::cmdStop));
694 /* This (::non_realtime_stop()) gets called by main
695 process thread, which will lead to confusion
696 when calling AsyncMIDIPort::write().
698 Something must be done. XXX
700 send_mmc_locate (_transport_frame);
704 if ((ptw & PostTransportLocate) && get_record_enabled()) {
705 /* This is scheduled by realtime_stop(), which is also done
706 * when a slave requests /locate/ for an initial sync.
707 * We can't hold up the slave for long with a save() here,
708 * without breaking its initial sync cycle.
710 * save state only if there's no slave or if it's not yet locked.
712 if (!_slave || !_slave->locked()) {
713 DEBUG_TRACE (DEBUG::Transport, X_("Butler PTW: requests save\n"));
714 SaveSessionRequested (_current_snapshot_name);
719 /* always try to get rid of this */
721 remove_pending_capture_state ();
723 /* save the current state of things if appropriate */
725 if (did_record && !saved) {
726 SaveSessionRequested (_current_snapshot_name);
729 if (ptw & PostTransportStop) {
731 if (!Config->get_loop_is_mode()) {
736 PositionChanged (_transport_frame); /* EMIT SIGNAL */
737 DEBUG_TRACE (DEBUG::Transport, string_compose ("send TSC with speed = %1\n", _transport_speed));
738 TransportStateChange (); /* EMIT SIGNAL */
740 /* and start it up again if relevant */
742 if ((ptw & PostTransportLocate) && !config.get_external_sync() && pending_locate_roll) {
743 request_transport_speed (1.0);
746 /* Even if we didn't do a pending locate roll this time, we don't want it hanging
747 around for next time.
749 pending_locate_roll = false;
753 Session::check_declick_out ()
755 bool locate_required = transport_sub_state & PendingLocate;
757 /* this is called after a process() iteration. if PendingDeclickOut was set,
758 it means that we were waiting to declick the output (which has just been
759 done) before maybe doing something else. this is where we do that "something else".
761 note: called from the audio thread.
764 if (transport_sub_state & PendingDeclickOut) {
766 if (locate_required) {
767 start_locate (pending_locate_frame, pending_locate_roll, pending_locate_flush);
768 transport_sub_state &= ~(PendingDeclickOut|PendingLocate);
770 if (!(transport_sub_state & StopPendingCapture)) {
771 stop_transport (pending_abort);
772 transport_sub_state &= ~(PendingDeclickOut|PendingLocate);
776 } else if (transport_sub_state & PendingLoopDeclickOut) {
777 /* Nothing else to do here; we've declicked, and the loop event will be along shortly */
778 transport_sub_state &= ~PendingLoopDeclickOut;
783 Session::unset_play_loop ()
787 clear_events (SessionEvent::AutoLoop);
788 clear_events (SessionEvent::AutoLoopDeclick);
789 set_track_loop (false);
792 if (Config->get_seamless_loop()) {
793 /* likely need to flush track buffers: this will locate us to wherever we are */
794 add_post_transport_work (PostTransportLocate);
795 _butler->schedule_transport_work ();
801 Session::set_track_loop (bool yn)
803 Location* loc = _locations->auto_loop_location ();
809 boost::shared_ptr<RouteList> rl = routes.reader ();
811 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
812 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
813 if (tr && !tr->hidden()) {
814 tr->set_loop (yn ? loc : 0);
820 Session::set_play_loop (bool yn, double speed)
822 /* Called from event-handling context */
826 if (yn == play_loop || (actively_recording() && yn) || (loc = _locations->auto_loop_location()) == 0) {
827 /* nothing to do, or can't change loop status while recording */
831 if (yn && Config->get_seamless_loop() && synced_to_engine()) {
832 warning << string_compose (
833 _("Seamless looping cannot be supported while %1 is using JACK transport.\n"
834 "Recommend changing the configured options"), PROGRAM_NAME)
848 if (Config->get_seamless_loop()) {
849 if (!Config->get_loop_is_mode()) {
850 /* set all tracks to use internal looping */
851 set_track_loop (true);
853 /* we will do this in the locate to the start OR when we hit the end
854 * of the loop for the first time
858 /* set all tracks to NOT use internal looping */
859 set_track_loop (false);
862 /* Put the delick and loop events in into the event list. The declick event will
863 cause a de-clicking fade-out just before the end of the loop, and it will also result
864 in a fade-in when the loop restarts. The AutoLoop event will peform the actual loop.
869 auto_loop_declick_range (loc, dcp, dcl);
870 merge_event (new SessionEvent (SessionEvent::AutoLoopDeclick, SessionEvent::Replace, dcp, dcl, 0.0f));
871 merge_event (new SessionEvent (SessionEvent::AutoLoop, SessionEvent::Replace, loc->end(), loc->start(), 0.0f));
873 /* if requested to roll, locate to start of loop and
874 * roll but ONLY if we're not already rolling.
876 args: positition, roll=true, flush=true, with_loop=false, force buffer refill if seamless looping
879 if (Config->get_loop_is_mode()) {
880 /* loop IS a transport mode: if already
881 rolling, do not locate to loop start.
883 if (!transport_rolling() && (speed != 0.0)) {
884 start_locate (loc->start(), true, true, false, Config->get_seamless_loop());
888 start_locate (loc->start(), true, true, false, Config->get_seamless_loop());
898 DEBUG_TRACE (DEBUG::Transport, string_compose ("send TSC2 with speed = %1\n", _transport_speed));
899 TransportStateChange ();
902 Session::flush_all_inserts ()
904 boost::shared_ptr<RouteList> r = routes.reader ();
906 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
907 (*i)->flush_processors ();
912 Session::start_locate (framepos_t target_frame, bool with_roll, bool with_flush, bool with_loop, bool force)
914 if (target_frame < 0) {
915 error << _("Locate called for negative sample position - ignored") << endmsg;
919 if (synced_to_engine()) {
924 _slave->speed_and_position (sp, pos);
926 if (target_frame != pos) {
928 if (config.get_jack_time_master()) {
929 /* actually locate now, since otherwise jack_timebase_callback
930 will use the incorrect _transport_frame and report an old
931 and incorrect time to Jack transport
933 locate (target_frame, with_roll, with_flush, with_loop, force);
936 /* tell JACK to change transport position, and we will
937 follow along later in ::follow_slave()
940 _engine.transport_locate (target_frame);
942 if (sp != 1.0f && with_roll) {
943 _engine.transport_start ();
949 locate (target_frame, with_roll, with_flush, with_loop, force);
954 Session::micro_locate (framecnt_t distance)
956 boost::shared_ptr<RouteList> rl = routes.reader();
957 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
958 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
959 if (tr && !tr->can_internal_playback_seek (distance)) {
964 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
965 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
967 tr->internal_playback_seek (distance);
971 _transport_frame += distance;
975 /** @param with_mmc true to send a MMC locate command when the locate is done */
977 Session::locate (framepos_t target_frame, bool with_roll, bool with_flush, bool for_seamless_loop, bool force, bool with_mmc)
979 bool need_butler = false;
981 /* Locates for seamless looping are fairly different from other
982 * locates. They assume that the diskstream buffers for each track
983 * already have the correct data in them, and thus there is no need to
984 * actually tell the tracks to locate. What does need to be done,
985 * though, is all the housekeeping that is associated with non-linear
986 * changes in the value of _transport_frame.
989 DEBUG_TRACE (DEBUG::Transport, string_compose ("rt-locate to %1, roll %2 flush %3 seamless %4 force %5 mmc %6\n",
990 target_frame, with_roll, with_flush, for_seamless_loop, force, with_mmc));
992 if (actively_recording() && !for_seamless_loop) {
996 if (!force && _transport_frame == target_frame && !loop_changing && !for_seamless_loop) {
998 set_transport_speed (1.0, 0, false);
1000 loop_changing = false;
1001 Located (); /* EMIT SIGNAL */
1005 if (_transport_speed && !for_seamless_loop) {
1006 /* Schedule a declick. We'll be called again when its done.
1007 We only do it this way for ordinary locates, not those
1008 due to **seamless** loops.
1011 if (!(transport_sub_state & PendingDeclickOut)) {
1012 transport_sub_state |= (PendingDeclickOut|PendingLocate);
1013 pending_locate_frame = target_frame;
1014 pending_locate_roll = with_roll;
1015 pending_locate_flush = with_flush;
1020 // Update Timecode time
1021 // [DR] FIXME: find out exactly where this should go below
1022 _transport_frame = target_frame;
1023 _last_roll_or_reversal_location = target_frame;
1024 timecode_time(_transport_frame, transmitting_timecode_time);
1025 outbound_mtc_timecode_frame = _transport_frame;
1026 next_quarter_frame_to_send = 0;
1028 /* do "stopped" stuff if:
1030 * we are rolling AND
1031 * no autoplay in effect AND
1032 * we're not going to keep rolling after the locate AND
1033 * !(playing a loop with JACK sync)
1037 bool transport_was_stopped = !transport_rolling();
1039 if (transport_was_stopped && (!auto_play_legal || !config.get_auto_play()) && !with_roll && !(synced_to_engine() && play_loop)) {
1040 realtime_stop (false, true); // XXX paul - check if the 2nd arg is really correct
1041 transport_was_stopped = true;
1043 /* otherwise tell the world that we located */
1047 if (force || !for_seamless_loop || loop_changing) {
1049 PostTransportWork todo = PostTransportLocate;
1051 if (with_roll && transport_was_stopped) {
1052 todo = PostTransportWork (todo | PostTransportRoll);
1055 add_post_transport_work (todo);
1060 /* this is functionally what clear_clicks() does but with a tentative lock */
1062 Glib::Threads::RWLock::WriterLock clickm (click_lock, Glib::Threads::TRY_LOCK);
1064 if (clickm.locked()) {
1066 for (Clicks::iterator i = clicks.begin(); i != clicks.end(); ++i) {
1075 /* switch from input if we're going to roll */
1076 if (Config->get_monitoring_model() == HardwareMonitoring) {
1077 set_track_monitor_input_status (!config.get_auto_input());
1080 /* otherwise we're going to stop, so do the opposite */
1081 if (Config->get_monitoring_model() == HardwareMonitoring) {
1082 set_track_monitor_input_status (true);
1086 /* cancel looped playback if transport pos outside of loop range */
1089 Location* al = _locations->auto_loop_location();
1092 if (_transport_frame < al->start() || _transport_frame > al->end()) {
1094 // located outside the loop: cancel looping directly, this is called from event handling context
1096 have_looped = false;
1098 if (!Config->get_loop_is_mode()) {
1099 set_play_loop (false, _transport_speed);
1101 if (Config->get_seamless_loop()) {
1102 /* this will make the non_realtime_locate() in the butler
1103 which then causes seek() in tracks actually do the right
1106 set_track_loop (false);
1110 } else if (_transport_frame == al->start()) {
1112 // located to start of loop - this is looping, basically
1114 if (for_seamless_loop) {
1118 if (_last_roll_location != al->start()) {
1119 /* didn't start at loop start - playback must have
1120 * started before loop since we've now hit the loop
1123 add_post_transport_work (PostTransportLocate);
1129 // this is only necessary for seamless looping
1131 boost::shared_ptr<RouteList> rl = routes.reader();
1133 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1134 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
1136 if (tr && tr->record_enabled ()) {
1137 // tell it we've looped, so it can deal with the record state
1138 tr->transport_looped (_transport_frame);
1144 TransportLooped(); // EMIT SIGNAL
1150 _butler->schedule_transport_work ();
1153 loop_changing = false;
1155 _send_timecode_update = true;
1158 send_mmc_locate (_transport_frame);
1161 _last_roll_location = _last_roll_or_reversal_location = _transport_frame;
1162 Located (); /* EMIT SIGNAL */
1165 /** Set the transport speed.
1166 * Called from the process thread.
1167 * @param speed New speed
1170 Session::set_transport_speed (double speed, framepos_t destination_frame, bool abort, bool clear_state, bool as_default)
1172 DEBUG_TRACE (DEBUG::Transport, string_compose ("@ %5 Set transport speed to %1, abort = %2 clear_state = %3, current = %4 as_default %6\n",
1173 speed, abort, clear_state, _transport_speed, _transport_frame, as_default));
1175 if (_transport_speed == speed) {
1176 if (as_default && speed == 0.0) { // => reset default transport speed. hacky or what?
1177 _default_transport_speed = 1.0;
1182 if (actively_recording() && speed != 1.0 && speed != 0.0) {
1183 /* no varispeed during recording */
1184 DEBUG_TRACE (DEBUG::Transport, string_compose ("No varispeed during recording cur_speed %1, frame %2\n",
1185 _transport_speed, _transport_frame));
1189 _target_transport_speed = fabs(speed);
1191 /* 8.0 max speed is somewhat arbitrary but based on guestimates regarding disk i/o capability
1192 and user needs. We really need CD-style "skip" playback for ffwd and rewind.
1196 speed = min (8.0, speed);
1197 } else if (speed < 0) {
1198 speed = max (-8.0, speed);
1201 if (transport_rolling() && speed == 0.0) {
1203 /* we are rolling and we want to stop */
1205 if (Config->get_monitoring_model() == HardwareMonitoring) {
1206 set_track_monitor_input_status (true);
1209 if (synced_to_engine ()) {
1211 /* do this here because our response to the slave won't
1214 _play_range = false;
1217 _engine.transport_stop ();
1219 bool const auto_return_enabled = (!config.get_external_sync() && (config.get_auto_return() || abort));
1221 if (!auto_return_enabled) {
1222 _requested_return_frame = destination_frame;
1225 stop_transport (abort);
1228 if (!Config->get_loop_is_mode()) {
1232 } else if (transport_stopped() && speed == 1.0) {
1234 /* we are stopped and we want to start rolling at speed 1 */
1236 if (Config->get_loop_is_mode() && play_loop) {
1238 Location *location = _locations->auto_loop_location();
1240 if (location != 0) {
1241 if (_transport_frame != location->start()) {
1243 if (Config->get_seamless_loop()) {
1244 /* force tracks to do their thing */
1245 set_track_loop (true);
1248 /* jump to start and then roll from there */
1250 request_locate (location->start(), true);
1256 if (Config->get_monitoring_model() == HardwareMonitoring && config.get_auto_input()) {
1257 set_track_monitor_input_status (false);
1260 if (synced_to_engine()) {
1261 _engine.transport_start ();
1268 /* not zero, not 1.0 ... varispeed */
1270 if ((synced_to_engine()) && speed != 0.0 && speed != 1.0) {
1271 warning << string_compose (
1272 _("Global varispeed cannot be supported while %1 is connected to JACK transport control"),
1278 if (actively_recording()) {
1282 if (speed > 0.0 && _transport_frame == current_end_frame()) {
1286 if (speed < 0.0 && _transport_frame == 0) {
1292 /* if we are reversing relative to the current speed, or relative to the speed
1293 before the last stop, then we have to do extra work.
1296 PostTransportWork todo = PostTransportWork (0);
1298 if ((_transport_speed && speed * _transport_speed < 0.0) || (_last_transport_speed * speed < 0.0) || (_last_transport_speed == 0.0f && speed < 0.0f)) {
1299 todo = PostTransportWork (todo | PostTransportReverse);
1300 _last_roll_or_reversal_location = _transport_frame;
1303 _last_transport_speed = _transport_speed;
1304 _transport_speed = speed;
1307 _default_transport_speed = speed;
1310 boost::shared_ptr<RouteList> rl = routes.reader();
1311 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1312 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
1313 if (tr && tr->realtime_set_speed (tr->speed(), true)) {
1314 todo = PostTransportWork (todo | PostTransportSpeed);
1319 add_post_transport_work (todo);
1320 _butler->schedule_transport_work ();
1323 DEBUG_TRACE (DEBUG::Transport, string_compose ("send TSC3 with speed = %1\n", _transport_speed));
1325 /* throttle signal emissions.
1326 * when slaved [_last]_transport_speed
1327 * usually changes every cycle (tiny amounts due to DLL).
1328 * Emitting a signal every cycle is overkill and unwarranted.
1330 * Using _last_transport_speed is not acceptable,
1331 * since it allows for large changes over a long period
1332 * of time. Hence we introduce a dedicated variable to keep track
1334 * The 0.2% dead-zone is somewhat arbitrary. Main use-case
1335 * for TransportStateChange() here is the ShuttleControl display.
1337 if (fabsf(_signalled_varispeed - speed) > .002f
1338 // still, signal hard changes to 1.0 and 0.0:
1339 || ( speed == 1.f && _signalled_varispeed != 1.f)
1340 || ( speed == 0.f && _signalled_varispeed != 0.f)
1343 TransportStateChange (); /* EMIT SIGNAL */
1344 _signalled_varispeed = speed;
1350 /** Stop the transport. */
1352 Session::stop_transport (bool abort, bool clear_state)
1354 if (_transport_speed == 0.0f) {
1358 if (!get_transport_declick_required()) {
1360 /* stop has not yet been scheduled */
1362 boost::shared_ptr<RouteList> rl = routes.reader();
1363 framepos_t stop_target = audible_frame();
1365 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1366 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
1368 tr->prepare_to_stop (_transport_frame, stop_target);
1374 if (actively_recording() && /* we are recording */
1375 worst_input_latency() > current_block_size) { /* input latency exceeds block size, so simple 1 cycle delay before stop is not enough */
1377 /* we need to capture the audio that is still somewhere in the pipeline between
1378 wherever it was generated and the process callback. This means that even though
1379 the user (or something else) has asked us to stop, we have to roll
1380 past this point and then reset the playhead/transport location to
1381 the position at which the stop was requested.
1383 we still need playback to "stop" now, however, which is why we schedule
1387 DEBUG_TRACE (DEBUG::Transport, string_compose ("stop transport requested @ %1, scheduled for + %2 = %3, abort = %4\n",
1388 _transport_frame, _worst_input_latency,
1389 _transport_frame + _worst_input_latency,
1392 SessionEvent *ev = new SessionEvent (SessionEvent::StopOnce, SessionEvent::Replace,
1393 _transport_frame + _worst_input_latency,
1398 /* request a declick at the start of the next process cycle() so that playback ceases.
1399 It will remain silent until we actually stop (at the StopOnce event somewhere in
1400 the future). The extra flag (StopPendingCapture) is set to ensure that check_declick_out()
1401 does not stop the transport too early.
1403 new_bits = SubState (PendingDeclickOut|StopPendingCapture);
1407 /* Not recording, schedule a declick in the next process() cycle and then stop at its end */
1409 new_bits = PendingDeclickOut;
1413 /* we'll be called again after the declick */
1414 transport_sub_state = SubState (transport_sub_state|new_bits);
1415 pending_abort = abort;
1421 /* declick was scheduled, but we've been called again, which means it is really time to stop
1423 XXX: we should probably split this off into its own method and call it explicitly.
1426 realtime_stop (abort, clear_state);
1427 _butler->schedule_transport_work ();
1431 /** Called from the process thread */
1433 Session::start_transport ()
1435 DEBUG_TRACE (DEBUG::Transport, "start_transport\n");
1437 _last_roll_location = _transport_frame;
1438 _last_roll_or_reversal_location = _transport_frame;
1440 have_looped = false;
1442 /* if record status is Enabled, move it to Recording. if its
1443 already Recording, move it to Disabled.
1446 switch (record_status()) {
1448 if (!config.get_punch_in()) {
1455 disable_record (false);
1463 transport_sub_state |= PendingDeclickIn;
1465 _transport_speed = _default_transport_speed;
1466 _target_transport_speed = _transport_speed;
1468 boost::shared_ptr<RouteList> rl = routes.reader();
1469 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1470 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
1472 tr->realtime_set_speed (tr->speed(), true);
1476 if (!_engine.freewheeling()) {
1477 Timecode::Time time;
1478 timecode_time_subframes (_transport_frame, time);
1479 if (!dynamic_cast<MTC_Slave*>(_slave)) {
1480 send_immediate_mmc (MIDI::MachineControlCommand (MIDI::MachineControl::cmdDeferredPlay));
1484 DEBUG_TRACE (DEBUG::Transport, string_compose ("send TSC4 with speed = %1\n", _transport_speed));
1485 TransportStateChange (); /* EMIT SIGNAL */
1488 /** Do any transport work in the audio thread that needs to be done after the
1489 * transport thread is finished. Audio thread, realtime safe.
1492 Session::post_transport ()
1494 PostTransportWork ptw = post_transport_work ();
1496 if (ptw & PostTransportAudition) {
1497 if (auditioner && auditioner->auditioning()) {
1498 process_function = &Session::process_audition;
1500 process_function = &Session::process_with_events;
1504 if (ptw & PostTransportStop) {
1506 transport_sub_state = 0;
1509 if (ptw & PostTransportLocate) {
1511 if (((!config.get_external_sync() && (auto_play_legal && config.get_auto_play())) && !_exporting) || (ptw & PostTransportRoll)) {
1514 transport_sub_state = 0;
1519 /* XXX is this really safe? shouldn't we just be unsetting the bits that we actually
1522 set_post_transport_work (PostTransportWork (0));
1526 Session::reset_rf_scale (framecnt_t motion)
1528 cumulative_rf_motion += motion;
1530 if (cumulative_rf_motion < 4 * _current_frame_rate) {
1532 } else if (cumulative_rf_motion < 8 * _current_frame_rate) {
1534 } else if (cumulative_rf_motion < 16 * _current_frame_rate) {
1546 Session::use_sync_source (Slave* new_slave)
1548 /* Runs in process() context */
1550 bool non_rt_required = false;
1552 /* XXX this deletion is problematic because we're in RT context */
1557 DEBUG_TRACE (DEBUG::Slave, string_compose ("set new slave to %1\n", _slave));
1559 // need to queue this for next process() cycle
1560 _send_timecode_update = true;
1562 boost::shared_ptr<RouteList> rl = routes.reader();
1563 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1564 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
1565 if (tr && !tr->hidden()) {
1566 if (tr->realtime_set_speed (tr->speed(), true)) {
1567 non_rt_required = true;
1569 tr->set_slaved (_slave != 0);
1573 if (non_rt_required) {
1574 add_post_transport_work (PostTransportSpeed);
1575 _butler->schedule_transport_work ();
1582 Session::drop_sync_source ()
1584 request_sync_source (0);
1588 Session::switch_to_sync_source (SyncSource src)
1592 DEBUG_TRACE (DEBUG::Slave, string_compose ("Setting up sync source %1\n", enum_2_string (src)));
1596 if (_slave && dynamic_cast<MTC_Slave*>(_slave)) {
1601 new_slave = new MTC_Slave (*this, *_midi_ports->mtc_input_port());
1604 catch (failed_constructor& err) {
1610 if (_slave && dynamic_cast<LTC_Slave*>(_slave)) {
1615 new_slave = new LTC_Slave (*this);
1618 catch (failed_constructor& err) {
1625 if (_slave && dynamic_cast<MIDIClock_Slave*>(_slave)) {
1630 new_slave = new MIDIClock_Slave (*this, *_midi_ports->midi_clock_input_port(), 24);
1633 catch (failed_constructor& err) {
1639 if (_slave && dynamic_cast<Engine_Slave*>(_slave)) {
1643 if (config.get_video_pullup() != 0.0f) {
1647 new_slave = new Engine_Slave (*AudioEngine::instance());
1655 request_sync_source (new_slave);
1659 Session::set_track_speed (Track* track, double speed)
1661 if (track->realtime_set_speed (speed, false)) {
1662 add_post_transport_work (PostTransportSpeed);
1663 _butler->schedule_transport_work ();
1669 Session::unset_play_range ()
1671 _play_range = false;
1672 _clear_event_type (SessionEvent::RangeStop);
1673 _clear_event_type (SessionEvent::RangeLocate);
1677 Session::set_play_range (list<AudioRange>& range, bool leave_rolling)
1681 /* Called from event-processing context */
1683 unset_play_range ();
1685 if (range.empty()) {
1686 /* _play_range set to false in unset_play_range()
1688 if (!leave_rolling) {
1689 /* stop transport */
1690 SessionEvent* ev = new SessionEvent (SessionEvent::SetTransportSpeed, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0f, false);
1698 /* cancel loop play */
1701 list<AudioRange>::size_type sz = range.size();
1705 list<AudioRange>::iterator i = range.begin();
1706 list<AudioRange>::iterator next;
1708 while (i != range.end()) {
1713 /* locating/stopping is subject to delays for declicking.
1716 framepos_t requested_frame = i->end;
1718 if (requested_frame > current_block_size) {
1719 requested_frame -= current_block_size;
1721 requested_frame = 0;
1724 if (next == range.end()) {
1725 ev = new SessionEvent (SessionEvent::RangeStop, SessionEvent::Add, requested_frame, 0, 0.0f);
1727 ev = new SessionEvent (SessionEvent::RangeLocate, SessionEvent::Add, requested_frame, (*next).start, 0.0f);
1735 } else if (sz == 1) {
1737 ev = new SessionEvent (SessionEvent::RangeStop, SessionEvent::Add, range.front().end, 0, 0.0f);
1742 /* save range so we can do auto-return etc. */
1744 current_audio_range = range;
1746 /* now start rolling at the right place */
1748 ev = new SessionEvent (SessionEvent::LocateRoll, SessionEvent::Add, SessionEvent::Immediate, range.front().start, 0.0f, false);
1751 DEBUG_TRACE (DEBUG::Transport, string_compose ("send TSC5 with speed = %1\n", _transport_speed));
1752 TransportStateChange ();
1756 Session::request_bounded_roll (framepos_t start, framepos_t end)
1758 AudioRange ar (start, end, 0);
1759 list<AudioRange> lar;
1762 request_play_range (&lar, true);
1766 Session::set_requested_return_frame (framepos_t return_to)
1768 _requested_return_frame = return_to;
1772 Session::request_roll_at_and_return (framepos_t start, framepos_t return_to)
1774 SessionEvent *ev = new SessionEvent (SessionEvent::LocateRollLocate, SessionEvent::Add, SessionEvent::Immediate, return_to, 1.0);
1775 ev->target2_frame = start;
1780 Session::engine_halted ()
1784 /* there will be no more calls to process(), so
1785 we'd better clean up for ourselves, right now.
1787 but first, make sure the butler is out of
1792 g_atomic_int_set (&_butler->should_do_transport_work, 0);
1793 set_post_transport_work (PostTransportWork (0));
1797 realtime_stop (false, true);
1798 non_realtime_stop (false, 0, ignored);
1799 transport_sub_state = 0;
1801 DEBUG_TRACE (DEBUG::Transport, string_compose ("send TSC6 with speed = %1\n", _transport_speed));
1802 TransportStateChange (); /* EMIT SIGNAL */
1807 Session::xrun_recovery ()
1811 Xrun (_transport_frame); /* EMIT SIGNAL */
1813 if (Config->get_stop_recording_on_xrun() && actively_recording()) {
1815 /* it didn't actually halt, but we need
1816 to handle things in the same way.
1824 Session::route_processors_changed (RouteProcessorChange c)
1826 if (ignore_route_processor_changes) {
1830 if (c.type == RouteProcessorChange::MeterPointChange) {
1835 if (c.type == RouteProcessorChange::RealTimeChange) {
1840 update_latency_compensation ();
1847 Session::allow_auto_play (bool yn)
1849 auto_play_legal = yn;
1853 Session::maybe_stop (framepos_t limit)
1855 if ((_transport_speed > 0.0f && _transport_frame >= limit) || (_transport_speed < 0.0f && _transport_frame == 0)) {
1856 if (synced_to_engine () && config.get_jack_time_master ()) {
1857 _engine.transport_stop ();
1858 } else if (!synced_to_engine ()) {
1867 Session::send_mmc_locate (framepos_t t)
1873 if (!_engine.freewheeling()) {
1874 Timecode::Time time;
1875 timecode_time_subframes (t, time);
1876 send_immediate_mmc (MIDI::MachineControlCommand (time));
1880 /** Ask the transport to not send timecode until further notice. The suspension
1881 * will come into effect some finite time after this call, and timecode_transmission_suspended()
1882 * should be checked by the caller to find out when.
1885 Session::request_suspend_timecode_transmission ()
1887 SessionEvent* ev = new SessionEvent (SessionEvent::SetTimecodeTransmission, SessionEvent::Add, SessionEvent::Immediate, 0, 0, false);
1892 Session::request_resume_timecode_transmission ()
1894 SessionEvent* ev = new SessionEvent (SessionEvent::SetTimecodeTransmission, SessionEvent::Add, SessionEvent::Immediate, 0, 0, true);
1899 Session::timecode_transmission_suspended () const
1901 return g_atomic_int_get (&_suspend_timecode_transmission) == 1;