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"
36 #include "midi++/manager.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/session.h"
45 #include "ardour/slave.h"
46 #include "ardour/operations.h"
51 using namespace ARDOUR;
55 Session::add_post_transport_work (PostTransportWork ptw)
57 PostTransportWork oldval;
58 PostTransportWork newval;
62 oldval = (PostTransportWork) g_atomic_int_get (&_post_transport_work);
63 newval = PostTransportWork (oldval | ptw);
64 if (g_atomic_int_compare_and_exchange (&_post_transport_work, oldval, newval)) {
70 error << "Could not set post transport work! Crazy thread madness, call the programmers" << endmsg;
74 Session::request_input_change_handling ()
76 if (!(_state_of_the_state & (InitialConnecting|Deletion))) {
77 SessionEvent* ev = new SessionEvent (SessionEvent::InputConfigurationChange, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
83 Session::request_sync_source (Slave* new_slave)
85 SessionEvent* ev = new SessionEvent (SessionEvent::SetSyncSource, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
88 seamless = Config->get_seamless_loop ();
90 if (dynamic_cast<JACK_Slave*>(new_slave)) {
91 /* JACK cannot support seamless looping at present */
92 Config->set_seamless_loop (false);
94 /* reset to whatever the value was before we last switched slaves */
95 Config->set_seamless_loop (_was_seamless);
98 /* save value of seamless from before the switch */
99 _was_seamless = seamless;
101 ev->slave = new_slave;
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));
207 todo = PostTransportWork (todo | PostTransportStop);
212 boost::shared_ptr<RouteList> r = routes.reader ();
214 for (RouteList::iterator i = r->begin (); i != r->end(); ++i) {
215 (*i)->realtime_handle_transport_stopped ();
218 if (actively_recording()) {
220 /* move the transport position back to where the
221 request for a stop was noticed. we rolled
222 past that point to pick up delayed input (and/or to delick)
225 if (worst_playback_latency() > current_block_size) {
226 /* we rolled past the stop point to pick up data that had
227 not yet arrived. move back to where the stop occured.
229 decrement_transport_position (current_block_size + (worst_input_latency() - current_block_size));
231 decrement_transport_position (current_block_size);
234 /* the duration change is not guaranteed to have happened, but is likely */
236 todo = PostTransportWork (todo | PostTransportDuration);
240 todo = PostTransportWork (todo | PostTransportAbort);
244 todo = PostTransportWork (todo | PostTransportClearSubstate);
248 add_post_transport_work (todo);
251 _clear_event_type (SessionEvent::StopOnce);
252 _clear_event_type (SessionEvent::RangeStop);
253 _clear_event_type (SessionEvent::RangeLocate);
255 /* if we're going to clear loop state, then force disabling record BUT only if we're not doing latched rec-enable */
256 disable_record (true, (!Config->get_latched_record_enable() && clear_state));
258 reset_slave_state ();
260 _transport_speed = 0;
261 _target_transport_speed = 0;
263 g_atomic_int_set (&_playback_load, 100);
264 g_atomic_int_set (&_capture_load, 100);
266 if (config.get_use_video_sync()) {
267 waiting_for_sync_offset = true;
270 transport_sub_state = 0;
274 Session::realtime_locate ()
276 boost::shared_ptr<RouteList> r = routes.reader ();
277 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
278 (*i)->realtime_locate ();
283 Session::butler_transport_work ()
287 PostTransportWork ptw;
288 boost::shared_ptr<RouteList> r = routes.reader ();
290 int on_entry = g_atomic_int_get (&_butler->should_do_transport_work);
292 ptw = post_transport_work();
294 DEBUG_TRACE (DEBUG::Transport, string_compose ("Butler transport work, todo = %1\n", enum_2_string (ptw)));
296 if (ptw & PostTransportAdjustPlaybackBuffering) {
297 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
298 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
300 tr->adjust_playback_buffering ();
301 /* and refill those buffers ... */
303 (*i)->non_realtime_locate (_transport_frame);
308 if (ptw & PostTransportAdjustCaptureBuffering) {
309 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
310 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
312 tr->adjust_capture_buffering ();
317 if (ptw & PostTransportCurveRealloc) {
318 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
319 (*i)->curve_reallocate();
323 if (ptw & PostTransportInputChange) {
324 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
325 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
327 tr->non_realtime_input_change ();
332 if (ptw & PostTransportSpeed) {
333 non_realtime_set_speed ();
336 if (ptw & PostTransportReverse) {
339 cumulative_rf_motion = 0;
342 /* don't seek if locate will take care of that in non_realtime_stop() */
344 if (!(ptw & PostTransportLocate)) {
346 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
347 (*i)->non_realtime_locate (_transport_frame);
349 if (on_entry != g_atomic_int_get (&_butler->should_do_transport_work)) {
350 /* new request, stop seeking, and start again */
351 g_atomic_int_dec_and_test (&_butler->should_do_transport_work);
358 if (ptw & PostTransportLocate) {
359 non_realtime_locate ();
362 if (ptw & PostTransportStop) {
363 non_realtime_stop (ptw & PostTransportAbort, on_entry, finished);
365 g_atomic_int_dec_and_test (&_butler->should_do_transport_work);
370 if (ptw & PostTransportOverWrite) {
371 non_realtime_overwrite (on_entry, finished);
373 g_atomic_int_dec_and_test (&_butler->should_do_transport_work);
378 if (ptw & PostTransportAudition) {
379 non_realtime_set_audition ();
382 g_atomic_int_dec_and_test (&_butler->should_do_transport_work);
384 DEBUG_TRACE (DEBUG::Transport, X_("Butler transport work all done\n"));
388 Session::non_realtime_set_speed ()
390 boost::shared_ptr<RouteList> rl = routes.reader();
391 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
392 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
394 tr->non_realtime_set_speed ();
400 Session::non_realtime_overwrite (int on_entry, bool& finished)
402 boost::shared_ptr<RouteList> rl = routes.reader();
403 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
404 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
405 if (tr && tr->pending_overwrite ()) {
406 tr->overwrite_existing_buffers ();
408 if (on_entry != g_atomic_int_get (&_butler->should_do_transport_work)) {
417 Session::non_realtime_locate ()
419 boost::shared_ptr<RouteList> rl = routes.reader();
420 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
421 (*i)->non_realtime_locate (_transport_frame);
424 /* XXX: it would be nice to generate the new clicks here (in the non-RT thread)
425 rather than clearing them so that the RT thread has to spend time constructing
426 them (in Session::click).
433 Session::non_realtime_stop (bool abort, int on_entry, bool& finished)
439 PostTransportWork ptw = post_transport_work();
444 boost::shared_ptr<RouteList> rl = routes.reader();
445 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
446 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
447 if (tr && tr->get_captured_frames () != 0) {
453 /* stop and locate are merged here because they share a lot of common stuff */
456 now = localtime (&xnow);
459 auditioner->cancel_audition ();
462 cumulative_rf_motion = 0;
466 begin_reversible_command (Operations::capture);
467 _have_captured = true;
470 DEBUG_TRACE (DEBUG::Transport, X_("Butler PTW: DS stop\n"));
472 if (abort && did_record) {
473 /* no reason to save the session file when we remove sources
475 _state_of_the_state = StateOfTheState (_state_of_the_state|InCleanup);
478 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
479 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
481 tr->transport_stopped_wallclock (*now, xnow, abort);
485 if (abort && did_record) {
486 _state_of_the_state = StateOfTheState (_state_of_the_state & ~InCleanup);
489 boost::shared_ptr<RouteList> r = routes.reader ();
491 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
492 if (!(*i)->is_hidden()) {
493 (*i)->set_pending_declick (0);
498 commit_reversible_command ();
501 if (_engine.running()) {
502 PostTransportWork ptw = post_transport_work ();
503 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
504 (*i)->nonrealtime_handle_transport_stopped (abort, (ptw & PostTransportLocate), (!(ptw & PostTransportLocate) || pending_locate_flush));
506 update_latency_compensation ();
509 bool const auto_return_enabled =
510 (!config.get_external_sync() && config.get_auto_return());
512 if (auto_return_enabled ||
513 (ptw & PostTransportLocate) ||
514 (_requested_return_frame >= 0) ||
517 if (pending_locate_flush) {
518 flush_all_inserts ();
521 if ((auto_return_enabled || synced_to_jack() || _requested_return_frame >= 0) &&
522 !(ptw & PostTransportLocate)) {
524 /* no explicit locate queued */
526 bool do_locate = false;
528 if (_requested_return_frame >= 0) {
530 /* explicit return request pre-queued in event list. overrides everything else */
532 cerr << "explicit auto-return to " << _requested_return_frame << endl;
534 _transport_frame = _requested_return_frame;
538 if (config.get_auto_return()) {
542 /* don't try to handle loop play when synced to JACK */
544 if (!synced_to_jack()) {
546 Location *location = _locations->auto_loop_location();
549 _transport_frame = location->start();
551 _transport_frame = _last_roll_location;
556 } else if (_play_range) {
558 /* return to start of range */
560 if (!current_audio_range.empty()) {
561 _transport_frame = current_audio_range.front().start;
567 /* regular auto-return */
569 _transport_frame = _last_roll_location;
575 _requested_return_frame = -1;
578 _engine.transport_locate (_transport_frame);
586 /* do this before seeking, because otherwise the tracks will do the wrong thing in seamless loop mode.
589 if (ptw & PostTransportClearSubstate) {
594 /* this for() block can be put inside the previous if() and has the effect of ... ??? what */
596 DEBUG_TRACE (DEBUG::Transport, X_("Butler PTW: locate\n"));
597 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
598 DEBUG_TRACE (DEBUG::Transport, string_compose ("Butler PTW: locate on %1\n", (*i)->name()));
599 (*i)->non_realtime_locate (_transport_frame);
601 if (on_entry != g_atomic_int_get (&_butler->should_do_transport_work)) {
603 /* we will be back */
610 if (!_engine.freewheeling()) {
611 send_full_time_code (_transport_frame);
613 if (!dynamic_cast<MTC_Slave*>(_slave)) {
614 MIDI::Manager::instance()->mmc()->send (MIDI::MachineControlCommand (MIDI::MachineControl::cmdStop));
615 send_mmc_locate (_transport_frame);
619 if ((ptw & PostTransportLocate) && get_record_enabled()) {
620 /* capture start has been changed, so save pending state */
621 save_state ("", true);
625 /* always try to get rid of this */
627 remove_pending_capture_state ();
629 /* save the current state of things if appropriate */
631 if (did_record && !saved) {
632 save_state (_current_snapshot_name);
635 if (ptw & PostTransportStop) {
640 PositionChanged (_transport_frame); /* EMIT SIGNAL */
641 DEBUG_TRACE (DEBUG::Transport, string_compose ("send TSC with speed = %1\n", _transport_speed));
642 TransportStateChange (); /* EMIT SIGNAL */
644 /* and start it up again if relevant */
646 if ((ptw & PostTransportLocate) && !config.get_external_sync() && pending_locate_roll) {
647 request_transport_speed (1.0);
650 /* Even if we didn't do a pending locate roll this time, we don't want it hanging
651 around for next time.
653 pending_locate_roll = false;
657 Session::check_declick_out ()
659 bool locate_required = transport_sub_state & PendingLocate;
661 /* this is called after a process() iteration. if PendingDeclickOut was set,
662 it means that we were waiting to declick the output (which has just been
663 done) before maybe doing something else. this is where we do that "something else".
665 note: called from the audio thread.
668 if (transport_sub_state & PendingDeclickOut) {
670 if (locate_required) {
671 start_locate (pending_locate_frame, pending_locate_roll, pending_locate_flush);
672 transport_sub_state &= ~(PendingDeclickOut|PendingLocate);
674 stop_transport (pending_abort);
675 transport_sub_state &= ~(PendingDeclickOut|PendingLocate);
678 } else if (transport_sub_state & PendingLoopDeclickOut) {
679 /* Nothing else to do here; we've declicked, and the loop event will be along shortly */
680 transport_sub_state &= ~PendingLoopDeclickOut;
685 Session::unset_play_loop ()
688 clear_events (SessionEvent::AutoLoop);
689 clear_events (SessionEvent::AutoLoopDeclick);
691 // set all tracks to NOT use internal looping
692 boost::shared_ptr<RouteList> rl = routes.reader ();
693 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
694 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
695 if (tr && !tr->hidden()) {
702 Session::set_play_loop (bool yn)
704 /* Called from event-handling context */
708 if (yn == play_loop || (actively_recording() && yn) || (loc = _locations->auto_loop_location()) == 0) {
709 /* nothing to do, or can't change loop status while recording */
713 if (yn && Config->get_seamless_loop() && synced_to_jack()) {
714 warning << string_compose (
715 _("Seamless looping cannot be supported while %1 is using JACK transport.\n"
716 "Recommend changing the configured options"), PROGRAM_NAME)
729 if (Config->get_seamless_loop()) {
730 // set all tracks to use internal looping
731 boost::shared_ptr<RouteList> rl = routes.reader ();
732 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
733 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
734 if (tr && !tr->hidden()) {
740 // set all tracks to NOT use internal looping
741 boost::shared_ptr<RouteList> rl = routes.reader ();
742 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
743 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
744 if (tr && !tr->hidden()) {
750 /* Put the delick and loop events in into the event list. The declick event will
751 cause a de-clicking fade-out just before the end of the loop, and it will also result
752 in a fade-in when the loop restarts. The AutoLoop event will peform the actual loop.
757 auto_loop_declick_range (loc, dcp, dcl);
758 merge_event (new SessionEvent (SessionEvent::AutoLoopDeclick, SessionEvent::Replace, dcp, dcl, 0.0f));
759 merge_event (new SessionEvent (SessionEvent::AutoLoop, SessionEvent::Replace, loc->end(), loc->start(), 0.0f));
761 /* locate to start of loop and roll.
763 args: positition, roll=true, flush=true, with_loop=false, force buffer refill if seamless looping
766 start_locate (loc->start(), true, true, false, Config->get_seamless_loop());
774 DEBUG_TRACE (DEBUG::Transport, string_compose ("send TSC2 with speed = %1\n", _transport_speed));
775 TransportStateChange ();
778 Session::flush_all_inserts ()
780 boost::shared_ptr<RouteList> r = routes.reader ();
782 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
783 (*i)->flush_processors ();
788 Session::start_locate (framepos_t target_frame, bool with_roll, bool with_flush, bool with_loop, bool force)
790 if (synced_to_jack()) {
795 _slave->speed_and_position (sp, pos);
797 if (target_frame != pos) {
799 if (config.get_jack_time_master()) {
800 /* actually locate now, since otherwise jack_timebase_callback
801 will use the incorrect _transport_frame and report an old
802 and incorrect time to Jack transport
804 locate (target_frame, with_roll, with_flush, with_loop, force);
807 /* tell JACK to change transport position, and we will
808 follow along later in ::follow_slave()
811 _engine.transport_locate (target_frame);
813 if (sp != 1.0f && with_roll) {
814 _engine.transport_start ();
820 locate (target_frame, with_roll, with_flush, with_loop, force);
825 Session::micro_locate (framecnt_t distance)
827 boost::shared_ptr<RouteList> rl = routes.reader();
828 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
829 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
830 if (tr && !tr->can_internal_playback_seek (distance)) {
835 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
836 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
838 tr->internal_playback_seek (distance);
842 _transport_frame += distance;
846 /** @param with_mmc true to send a MMC locate command when the locate is done */
848 Session::locate (framepos_t target_frame, bool with_roll, bool with_flush, bool for_seamless_loop, bool force, bool with_mmc)
850 /* Locates for seamless looping are fairly different from other
851 * locates. They assume that the diskstream buffers for each track
852 * already have the correct data in them, and thus there is no need to
853 * actually tell the tracks to locate. What does need to be done,
854 * though, is all the housekeeping that is associated with non-linear
855 * changes in the value of _transport_frame.
858 if (actively_recording() && !for_seamless_loop) {
862 if (!force && _transport_frame == target_frame && !loop_changing && !for_seamless_loop) {
864 set_transport_speed (1.0, false);
866 loop_changing = false;
867 Located (); /* EMIT SIGNAL */
871 if (_transport_speed && !for_seamless_loop) {
872 /* Schedule a declick. We'll be called again when its done.
873 We only do it this way for ordinary locates, not those
874 due to **seamless** loops.
877 if (!(transport_sub_state & PendingDeclickOut)) {
878 transport_sub_state |= (PendingDeclickOut|PendingLocate);
879 pending_locate_frame = target_frame;
880 pending_locate_roll = with_roll;
881 pending_locate_flush = with_flush;
886 // Update Timecode time
887 // [DR] FIXME: find out exactly where this should go below
888 _transport_frame = target_frame;
889 _last_roll_or_reversal_location = target_frame;
890 timecode_time(_transport_frame, transmitting_timecode_time);
891 outbound_mtc_timecode_frame = _transport_frame;
892 next_quarter_frame_to_send = 0;
894 /* do "stopped" stuff if:
897 * no autoplay in effect AND
898 * we're not going to keep rolling after the locate AND
899 * !(playing a loop with JACK sync)
903 bool transport_was_stopped = !transport_rolling();
905 if (transport_was_stopped && (!auto_play_legal || !config.get_auto_play()) && !with_roll && !(synced_to_jack() && play_loop)) {
906 realtime_stop (false, true); // XXX paul - check if the 2nd arg is really correct
907 transport_was_stopped = true;
909 /* otherwise tell the world that we located */
913 if (force || !for_seamless_loop || loop_changing) {
915 PostTransportWork todo = PostTransportLocate;
917 if (with_roll && transport_was_stopped) {
918 todo = PostTransportWork (todo | PostTransportRoll);
921 add_post_transport_work (todo);
922 _butler->schedule_transport_work ();
926 /* this is functionally what clear_clicks() does but with a tentative lock */
928 Glib::Threads::RWLock::WriterLock clickm (click_lock, Glib::Threads::TRY_LOCK);
930 if (clickm.locked()) {
932 for (Clicks::iterator i = clicks.begin(); i != clicks.end(); ++i) {
941 /* switch from input if we're going to roll */
942 if (Config->get_monitoring_model() == HardwareMonitoring) {
943 set_track_monitor_input_status (!config.get_auto_input());
946 /* otherwise we're going to stop, so do the opposite */
947 if (Config->get_monitoring_model() == HardwareMonitoring) {
948 set_track_monitor_input_status (true);
952 /* cancel looped playback if transport pos outside of loop range */
955 Location* al = _locations->auto_loop_location();
958 if (_transport_frame < al->start() || _transport_frame > al->end()) {
960 // located outside the loop: cancel looping directly, this is called from event handling context
962 set_play_loop (false);
964 } else if (_transport_frame == al->start()) {
966 // located to start of loop - this is looping, basically
968 if (for_seamless_loop) {
970 // this is only necessary for seamless looping
972 boost::shared_ptr<RouteList> rl = routes.reader();
974 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
975 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
977 if (tr && tr->record_enabled ()) {
978 // tell it we've looped, so it can deal with the record state
979 tr->transport_looped (_transport_frame);
985 TransportLooped(); // EMIT SIGNAL
990 loop_changing = false;
992 _send_timecode_update = true;
995 send_mmc_locate (_transport_frame);
998 Located (); /* EMIT SIGNAL */
1001 /** Set the transport speed.
1002 * Called from the process thread.
1003 * @param speed New speed
1006 Session::set_transport_speed (double speed, bool abort, bool clear_state, bool as_default)
1008 DEBUG_TRACE (DEBUG::Transport, string_compose ("@ %5 Set transport speed to %1, abort = %2 clear_state = %3, current = %4 as_default %6\n",
1009 speed, abort, clear_state, _transport_speed, _transport_frame, as_default));
1011 if (_transport_speed == speed) {
1012 if (as_default && speed == 0.0) { // => reset default transport speed. hacky or what?
1013 _default_transport_speed = 1.0;
1018 if (actively_recording() && speed != 1.0 && speed != 0.0) {
1019 /* no varispeed during recording */
1020 DEBUG_TRACE (DEBUG::Transport, string_compose ("No varispeed during recording cur_speed %1, frame %2\n",
1021 _transport_speed, _transport_frame));
1025 _target_transport_speed = fabs(speed);
1027 /* 8.0 max speed is somewhat arbitrary but based on guestimates regarding disk i/o capability
1028 and user needs. We really need CD-style "skip" playback for ffwd and rewind.
1032 speed = min (8.0, speed);
1033 } else if (speed < 0) {
1034 speed = max (-8.0, speed);
1037 if (transport_rolling() && speed == 0.0) {
1039 /* we are rolling and we want to stop */
1041 if (Config->get_monitoring_model() == HardwareMonitoring) {
1042 set_track_monitor_input_status (true);
1045 if (synced_to_jack ()) {
1047 /* do this here because our response to the slave won't
1050 _play_range = false;
1053 _engine.transport_stop ();
1055 stop_transport (abort);
1060 } else if (transport_stopped() && speed == 1.0) {
1062 /* we are stopped and we want to start rolling at speed 1 */
1064 if (Config->get_monitoring_model() == HardwareMonitoring && config.get_auto_input()) {
1065 set_track_monitor_input_status (false);
1068 if (synced_to_jack()) {
1069 _engine.transport_start ();
1076 /* not zero, not 1.0 ... varispeed */
1078 if ((synced_to_jack()) && speed != 0.0 && speed != 1.0) {
1079 warning << string_compose (
1080 _("Global varispeed cannot be supported while %1 is connected to JACK transport control"),
1086 if (actively_recording()) {
1090 if (speed > 0.0 && _transport_frame == current_end_frame()) {
1094 if (speed < 0.0 && _transport_frame == 0) {
1100 /* if we are reversing relative to the current speed, or relative to the speed
1101 before the last stop, then we have to do extra work.
1104 PostTransportWork todo = PostTransportWork (0);
1106 if ((_transport_speed && speed * _transport_speed < 0.0) || (_last_transport_speed * speed < 0.0) || (_last_transport_speed == 0.0f && speed < 0.0f)) {
1107 todo = PostTransportWork (todo | PostTransportReverse);
1108 _last_roll_or_reversal_location = _transport_frame;
1111 _last_transport_speed = _transport_speed;
1112 _transport_speed = speed;
1115 _default_transport_speed = speed;
1118 boost::shared_ptr<RouteList> rl = routes.reader();
1119 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1120 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
1121 if (tr && tr->realtime_set_speed (tr->speed(), true)) {
1122 todo = PostTransportWork (todo | PostTransportSpeed);
1127 add_post_transport_work (todo);
1128 _butler->schedule_transport_work ();
1131 DEBUG_TRACE (DEBUG::Transport, string_compose ("send TSC3 with speed = %1\n", _transport_speed));
1132 TransportStateChange (); /* EMIT SIGNAL */
1137 /** Stop the transport. */
1139 Session::stop_transport (bool abort, bool clear_state)
1141 if (_transport_speed == 0.0f) {
1145 if (actively_recording() && !(transport_sub_state & StopPendingCapture) && worst_input_latency() > current_block_size) {
1147 boost::shared_ptr<RouteList> rl = routes.reader();
1148 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1149 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
1151 tr->prepare_to_stop (_transport_frame);
1155 /* we need to capture the audio that has still not yet been received by the system
1156 at the time the stop is requested, so we have to roll past that time.
1158 we want to declick before stopping, so schedule the autostop for one
1159 block before the actual end. we'll declick in the subsequent block,
1160 and then we'll really be stopped.
1163 DEBUG_TRACE (DEBUG::Transport, string_compose ("stop transport requested @ %1, scheduled for + %2 - %3 = %4, abort = %5\n",
1164 _transport_frame, _worst_input_latency, current_block_size,
1165 _transport_frame - _worst_input_latency - current_block_size,
1168 SessionEvent *ev = new SessionEvent (SessionEvent::StopOnce, SessionEvent::Replace,
1169 _transport_frame + _worst_input_latency - current_block_size,
1173 transport_sub_state |= StopPendingCapture;
1174 pending_abort = abort;
1178 if ((transport_sub_state & PendingDeclickOut) == 0) {
1180 if (!(transport_sub_state & StopPendingCapture)) {
1181 boost::shared_ptr<RouteList> rl = routes.reader();
1182 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1183 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
1185 tr->prepare_to_stop (_transport_frame);
1190 transport_sub_state |= PendingDeclickOut;
1191 /* we'll be called again after the declick */
1192 pending_abort = abort;
1196 realtime_stop (abort, clear_state);
1197 _butler->schedule_transport_work ();
1200 /** Called from the process thread */
1202 Session::start_transport ()
1204 DEBUG_TRACE (DEBUG::Transport, "start_transport\n");
1206 _last_roll_location = _transport_frame;
1207 _last_roll_or_reversal_location = _transport_frame;
1209 have_looped = false;
1211 /* if record status is Enabled, move it to Recording. if its
1212 already Recording, move it to Disabled.
1215 switch (record_status()) {
1217 if (!config.get_punch_in()) {
1224 disable_record (false);
1232 transport_sub_state |= PendingDeclickIn;
1234 _transport_speed = _default_transport_speed;
1235 _target_transport_speed = _transport_speed;
1237 boost::shared_ptr<RouteList> rl = routes.reader();
1238 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1239 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
1241 tr->realtime_set_speed (tr->speed(), true);
1245 if (!_engine.freewheeling()) {
1246 Timecode::Time time;
1247 timecode_time_subframes (_transport_frame, time);
1248 if (!dynamic_cast<MTC_Slave*>(_slave)) {
1249 MIDI::Manager::instance()->mmc()->send (MIDI::MachineControlCommand (MIDI::MachineControl::cmdDeferredPlay));
1253 DEBUG_TRACE (DEBUG::Transport, string_compose ("send TSC4 with speed = %1\n", _transport_speed));
1254 TransportStateChange (); /* EMIT SIGNAL */
1257 /** Do any transport work in the audio thread that needs to be done after the
1258 * transport thread is finished. Audio thread, realtime safe.
1261 Session::post_transport ()
1263 PostTransportWork ptw = post_transport_work ();
1265 if (ptw & PostTransportAudition) {
1266 if (auditioner && auditioner->auditioning()) {
1267 process_function = &Session::process_audition;
1269 process_function = &Session::process_with_events;
1273 if (ptw & PostTransportStop) {
1275 transport_sub_state = 0;
1278 if (ptw & PostTransportLocate) {
1280 if (((!config.get_external_sync() && (auto_play_legal && config.get_auto_play())) && !_exporting) || (ptw & PostTransportRoll)) {
1283 transport_sub_state = 0;
1288 /* XXX is this really safe? shouldn't we just be unsetting the bits that we actually
1291 set_post_transport_work (PostTransportWork (0));
1295 Session::reset_rf_scale (framecnt_t motion)
1297 cumulative_rf_motion += motion;
1299 if (cumulative_rf_motion < 4 * _current_frame_rate) {
1301 } else if (cumulative_rf_motion < 8 * _current_frame_rate) {
1303 } else if (cumulative_rf_motion < 16 * _current_frame_rate) {
1315 Session::use_sync_source (Slave* new_slave)
1317 /* Runs in process() context */
1319 bool non_rt_required = false;
1321 /* XXX this deletion is problematic because we're in RT context */
1326 send_full_time_code (_transport_frame);
1328 boost::shared_ptr<RouteList> rl = routes.reader();
1329 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1330 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
1331 if (tr && !tr->hidden()) {
1332 if (tr->realtime_set_speed (tr->speed(), true)) {
1333 non_rt_required = true;
1335 tr->set_slaved (_slave != 0);
1339 if (non_rt_required) {
1340 add_post_transport_work (PostTransportSpeed);
1341 _butler->schedule_transport_work ();
1348 Session::drop_sync_source ()
1350 request_sync_source (0);
1354 Session::switch_to_sync_source (SyncSource src)
1358 DEBUG_TRACE (DEBUG::Slave, string_compose ("Setting up sync source %1\n", enum_2_string (src)));
1362 if (_slave && dynamic_cast<MTC_Slave*>(_slave)) {
1367 new_slave = new MTC_Slave (*this, *MIDI::Manager::instance()->mtc_input_port());
1370 catch (failed_constructor& err) {
1377 if (_slave && dynamic_cast<LTC_Slave*>(_slave)) {
1382 new_slave = new LTC_Slave (*this);
1385 catch (failed_constructor& err) {
1394 if (_slave && dynamic_cast<MIDIClock_Slave*>(_slave)) {
1399 new_slave = new MIDIClock_Slave (*this, *MIDI::Manager::instance()->midi_clock_input_port(), 24);
1402 catch (failed_constructor& err) {
1408 if (_slave && dynamic_cast<JACK_Slave*>(_slave)) {
1412 if (config.get_video_pullup() != 0.0f) {
1416 new_slave = new JACK_Slave (_engine.jack());
1424 request_sync_source (new_slave);
1428 Session::set_track_speed (Track* track, double speed)
1430 if (track->realtime_set_speed (speed, false)) {
1431 add_post_transport_work (PostTransportSpeed);
1432 _butler->schedule_transport_work ();
1438 Session::unset_play_range ()
1440 _play_range = false;
1441 _clear_event_type (SessionEvent::RangeStop);
1442 _clear_event_type (SessionEvent::RangeLocate);
1446 Session::set_play_range (list<AudioRange>& range, bool leave_rolling)
1450 /* Called from event-processing context */
1452 unset_play_range ();
1454 if (range.empty()) {
1455 /* _play_range set to false in unset_play_range()
1457 if (!leave_rolling) {
1458 /* stop transport */
1459 SessionEvent* ev = new SessionEvent (SessionEvent::SetTransportSpeed, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0f, false);
1467 /* cancel loop play */
1470 list<AudioRange>::size_type sz = range.size();
1474 list<AudioRange>::iterator i = range.begin();
1475 list<AudioRange>::iterator next;
1477 while (i != range.end()) {
1482 /* locating/stopping is subject to delays for declicking.
1485 framepos_t requested_frame = i->end;
1487 if (requested_frame > current_block_size) {
1488 requested_frame -= current_block_size;
1490 requested_frame = 0;
1493 if (next == range.end()) {
1494 ev = new SessionEvent (SessionEvent::RangeStop, SessionEvent::Add, requested_frame, 0, 0.0f);
1496 ev = new SessionEvent (SessionEvent::RangeLocate, SessionEvent::Add, requested_frame, (*next).start, 0.0f);
1504 } else if (sz == 1) {
1506 ev = new SessionEvent (SessionEvent::RangeStop, SessionEvent::Add, range.front().end, 0, 0.0f);
1511 /* save range so we can do auto-return etc. */
1513 current_audio_range = range;
1515 /* now start rolling at the right place */
1517 ev = new SessionEvent (SessionEvent::LocateRoll, SessionEvent::Add, SessionEvent::Immediate, range.front().start, 0.0f, false);
1520 DEBUG_TRACE (DEBUG::Transport, string_compose ("send TSC5 with speed = %1\n", _transport_speed));
1521 TransportStateChange ();
1525 Session::request_bounded_roll (framepos_t start, framepos_t end)
1527 AudioRange ar (start, end, 0);
1528 list<AudioRange> lar;
1531 request_play_range (&lar, true);
1534 Session::request_roll_at_and_return (framepos_t start, framepos_t return_to)
1536 SessionEvent *ev = new SessionEvent (SessionEvent::LocateRollLocate, SessionEvent::Add, SessionEvent::Immediate, return_to, 1.0);
1537 ev->target2_frame = start;
1542 Session::engine_halted ()
1546 /* there will be no more calls to process(), so
1547 we'd better clean up for ourselves, right now.
1549 but first, make sure the butler is out of
1554 g_atomic_int_set (&_butler->should_do_transport_work, 0);
1555 set_post_transport_work (PostTransportWork (0));
1559 realtime_stop (false, true);
1560 non_realtime_stop (false, 0, ignored);
1561 transport_sub_state = 0;
1563 DEBUG_TRACE (DEBUG::Transport, string_compose ("send TSC6 with speed = %1\n", _transport_speed));
1564 TransportStateChange (); /* EMIT SIGNAL */
1569 Session::xrun_recovery ()
1571 Xrun (_transport_frame); /* EMIT SIGNAL */
1573 if (Config->get_stop_recording_on_xrun() && actively_recording()) {
1575 /* it didn't actually halt, but we need
1576 to handle things in the same way.
1584 Session::route_processors_changed (RouteProcessorChange c)
1586 if (ignore_route_processor_changes) {
1590 if (c.type == RouteProcessorChange::MeterPointChange) {
1594 update_latency_compensation ();
1601 Session::allow_auto_play (bool yn)
1603 auto_play_legal = yn;
1607 Session::reset_jack_connection (jack_client_t* jack)
1611 if (_slave && ((js = dynamic_cast<JACK_Slave*> (_slave)) != 0)) {
1612 js->reset_client (jack);
1617 Session::maybe_stop (framepos_t limit)
1619 if ((_transport_speed > 0.0f && _transport_frame >= limit) || (_transport_speed < 0.0f && _transport_frame == 0)) {
1620 if (synced_to_jack () && config.get_jack_time_master ()) {
1621 _engine.transport_stop ();
1622 } else if (!synced_to_jack ()) {
1631 Session::send_mmc_locate (framepos_t t)
1633 if (!_engine.freewheeling()) {
1634 Timecode::Time time;
1635 timecode_time_subframes (t, time);
1636 MIDI::Manager::instance()->mmc()->send (MIDI::MachineControlCommand (time));
1640 /** Ask the transport to not send timecode until further notice. The suspension
1641 * will come into effect some finite time after this call, and timecode_transmission_suspended()
1642 * should be checked by the caller to find out when.
1645 Session::request_suspend_timecode_transmission ()
1647 SessionEvent* ev = new SessionEvent (SessionEvent::SetTimecodeTransmission, SessionEvent::Add, SessionEvent::Immediate, 0, 0, false);
1652 Session::request_resume_timecode_transmission ()
1654 SessionEvent* ev = new SessionEvent (SessionEvent::SetTimecodeTransmission, SessionEvent::Add, SessionEvent::Immediate, 0, 0, true);
1659 Session::timecode_transmission_suspended () const
1661 return g_atomic_int_get (&_suspend_timecode_transmission) == 1;