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.
25 #include "libardour-config.h"
30 #include "pbd/error.h"
31 #include "pbd/enumwriter.h"
32 #include "pbd/pthread_utils.h"
33 #include "pbd/memento_command.h"
35 #include "midi++/mmc.h"
36 #include "midi++/port.h"
37 #include "midi++/manager.h"
39 #include "ardour/ardour.h"
40 #include "ardour/audioengine.h"
41 #include "ardour/auditioner.h"
42 #include "ardour/butler.h"
43 #include "ardour/click.h"
44 #include "ardour/debug.h"
45 #include "ardour/location.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<JACK_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;
108 Session::request_transport_speed (double speed)
110 SessionEvent* ev = new SessionEvent (SessionEvent::SetTransportSpeed, SessionEvent::Add, SessionEvent::Immediate, 0, speed);
111 DEBUG_TRACE (DEBUG::Transport, string_compose ("Request transport speed = %1\n", speed));
115 /** Request a new transport speed, but if the speed parameter is exactly zero then use
116 * a very small +ve value to prevent the transport actually stopping. This method should
117 * be used by callers who are varying transport speed but don't ever want to stop it.
120 Session::request_transport_speed_nonzero (double speed)
126 request_transport_speed (speed);
130 Session::request_track_speed (Track* tr, double speed)
132 SessionEvent* ev = new SessionEvent (SessionEvent::SetTrackSpeed, SessionEvent::Add, SessionEvent::Immediate, 0, speed);
138 Session::request_stop (bool abort, bool clear_state)
140 SessionEvent* ev = new SessionEvent (SessionEvent::SetTransportSpeed, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0, abort, clear_state);
141 DEBUG_TRACE (DEBUG::Transport, string_compose ("Request transport stop, abort = %1, clear state = %2\n", abort, clear_state));
146 Session::request_locate (framepos_t target_frame, bool with_roll)
148 SessionEvent *ev = new SessionEvent (with_roll ? SessionEvent::LocateRoll : SessionEvent::Locate, SessionEvent::Add, SessionEvent::Immediate, target_frame, 0, false);
149 DEBUG_TRACE (DEBUG::Transport, string_compose ("Request locate to %1\n", target_frame));
154 Session::force_locate (framepos_t target_frame, bool with_roll)
156 SessionEvent *ev = new SessionEvent (with_roll ? SessionEvent::LocateRoll : SessionEvent::Locate, SessionEvent::Add, SessionEvent::Immediate, target_frame, 0, true);
157 DEBUG_TRACE (DEBUG::Transport, string_compose ("Request forced locate to %1\n", target_frame));
162 Session::request_play_loop (bool yn, bool leave_rolling)
165 Location *location = _locations->auto_loop_location();
167 if (location == 0 && yn) {
168 error << _("Cannot loop - no loop range defined")
173 ev = new SessionEvent (SessionEvent::SetLoop, SessionEvent::Add, SessionEvent::Immediate, 0, (leave_rolling ? 1.0 : 0.0), yn);
174 DEBUG_TRACE (DEBUG::Transport, string_compose ("Request set loop = %1, leave rolling ? %2\n", yn, leave_rolling));
177 if (!leave_rolling && !yn && Config->get_seamless_loop() && transport_rolling()) {
178 // request an immediate locate to refresh the tracks
179 // after disabling looping
180 request_locate (_transport_frame-1, false);
185 Session::request_play_range (list<AudioRange>* range, bool leave_rolling)
187 SessionEvent* ev = new SessionEvent (SessionEvent::SetPlayAudioRange, SessionEvent::Add, SessionEvent::Immediate, 0, (leave_rolling ? 1.0 : 0.0));
189 ev->audio_range = *range;
191 ev->audio_range.clear ();
193 DEBUG_TRACE (DEBUG::Transport, string_compose ("Request play range, leave rolling ? %1\n", leave_rolling));
198 Session::realtime_stop (bool abort, bool clear_state)
200 DEBUG_TRACE (DEBUG::Transport, string_compose ("realtime stop @ %1\n", _transport_frame));
201 PostTransportWork todo = PostTransportWork (0);
203 /* assume that when we start, we'll be moving forwards */
205 if (_transport_speed < 0.0f) {
206 todo = (PostTransportWork (todo | PostTransportStop | PostTransportReverse));
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 ... */
303 tr->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 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
349 if (tr && !tr->hidden()) {
350 tr->non_realtime_locate (_transport_frame);
352 if (on_entry != g_atomic_int_get (&_butler->should_do_transport_work)) {
353 /* new request, stop seeking, and start again */
354 g_atomic_int_dec_and_test (&_butler->should_do_transport_work);
361 if (ptw & PostTransportLocate) {
362 non_realtime_locate ();
365 if (ptw & PostTransportStop) {
366 non_realtime_stop (ptw & PostTransportAbort, on_entry, finished);
368 g_atomic_int_dec_and_test (&_butler->should_do_transport_work);
373 if (ptw & PostTransportOverWrite) {
374 non_realtime_overwrite (on_entry, finished);
376 g_atomic_int_dec_and_test (&_butler->should_do_transport_work);
381 if (ptw & PostTransportAudition) {
382 non_realtime_set_audition ();
385 g_atomic_int_dec_and_test (&_butler->should_do_transport_work);
387 DEBUG_TRACE (DEBUG::Transport, X_("Butler transport work all done\n"));
391 Session::non_realtime_set_speed ()
393 boost::shared_ptr<RouteList> rl = routes.reader();
394 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
395 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
397 tr->non_realtime_set_speed ();
403 Session::non_realtime_overwrite (int on_entry, bool& finished)
405 boost::shared_ptr<RouteList> rl = routes.reader();
406 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
407 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
408 if (tr && tr->pending_overwrite ()) {
409 tr->overwrite_existing_buffers ();
411 if (on_entry != g_atomic_int_get (&_butler->should_do_transport_work)) {
420 Session::non_realtime_locate ()
422 boost::shared_ptr<RouteList> rl = routes.reader();
423 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
424 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
426 tr->non_realtime_locate (_transport_frame);
430 /* XXX: it would be nice to generate the new clicks here (in the non-RT thread)
431 rather than clearing them so that the RT thread has to spend time constructing
432 them (in Session::click).
439 Session::non_realtime_stop (bool abort, int on_entry, bool& finished)
445 PostTransportWork ptw = post_transport_work();
450 boost::shared_ptr<RouteList> rl = routes.reader();
451 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
452 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
453 if (tr && tr->get_captured_frames () != 0) {
459 /* stop and locate are merged here because they share a lot of common stuff */
462 now = localtime (&xnow);
465 auditioner->cancel_audition ();
468 cumulative_rf_motion = 0;
472 begin_reversible_command (Operations::capture);
473 _have_captured = true;
476 DEBUG_TRACE (DEBUG::Transport, X_("Butler PTW: DS stop\n"));
478 if (abort && did_record) {
479 /* no reason to save the session file when we remove sources
481 _state_of_the_state = StateOfTheState (_state_of_the_state|InCleanup);
484 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
485 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
487 tr->transport_stopped_wallclock (*now, xnow, abort);
491 if (abort && did_record) {
492 _state_of_the_state = StateOfTheState (_state_of_the_state & ~InCleanup);
495 boost::shared_ptr<RouteList> r = routes.reader ();
497 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
498 if (!(*i)->is_hidden()) {
499 (*i)->set_pending_declick (0);
504 commit_reversible_command ();
507 if (_engine.running()) {
508 PostTransportWork ptw = post_transport_work ();
509 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
510 (*i)->nonrealtime_handle_transport_stopped (abort, (ptw & PostTransportLocate), (!(ptw & PostTransportLocate) || pending_locate_flush));
512 update_latency_compensation ();
515 bool const auto_return_enabled =
516 (!config.get_external_sync() && config.get_auto_return());
518 if (auto_return_enabled ||
519 (ptw & PostTransportLocate) ||
520 (_requested_return_frame >= 0) ||
523 if (pending_locate_flush) {
524 flush_all_inserts ();
527 if ((auto_return_enabled || synced_to_jack() || _requested_return_frame >= 0) &&
528 !(ptw & PostTransportLocate)) {
530 /* no explicit locate queued */
532 bool do_locate = false;
534 if (_requested_return_frame >= 0) {
536 /* explicit return request pre-queued in event list. overrides everything else */
538 cerr << "explicit auto-return to " << _requested_return_frame << endl;
540 _transport_frame = _requested_return_frame;
544 if (config.get_auto_return()) {
548 /* don't try to handle loop play when synced to JACK */
550 if (!synced_to_jack()) {
552 Location *location = _locations->auto_loop_location();
555 _transport_frame = location->start();
557 _transport_frame = _last_roll_location;
562 } else if (_play_range) {
564 /* return to start of range */
566 if (!current_audio_range.empty()) {
567 _transport_frame = current_audio_range.front().start;
573 /* regular auto-return */
575 _transport_frame = _last_roll_location;
581 _requested_return_frame = -1;
584 _engine.transport_locate (_transport_frame);
592 /* do this before seeking, because otherwise the tracks will do the wrong thing in seamless loop mode.
595 if (ptw & PostTransportClearSubstate) {
600 /* this for() block can be put inside the previous if() and has the effect of ... ??? what */
602 DEBUG_TRACE (DEBUG::Transport, X_("Butler PTW: locate\n"));
603 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
604 DEBUG_TRACE (DEBUG::Transport, string_compose ("Butler PTW: locate on %1\n", (*i)->name()));
605 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
606 if (tr && !tr->hidden()) {
607 tr->non_realtime_locate (_transport_frame);
610 if (on_entry != g_atomic_int_get (&_butler->should_do_transport_work)) {
612 /* we will be back */
619 if (!_engine.freewheeling()) {
620 send_full_time_code (_transport_frame);
622 if (!dynamic_cast<MTC_Slave*>(_slave)) {
623 MIDI::Manager::instance()->mmc()->send (MIDI::MachineControlCommand (MIDI::MachineControl::cmdStop));
624 send_mmc_locate (_transport_frame);
628 if ((ptw & PostTransportLocate) && get_record_enabled()) {
629 /* capture start has been changed, so save pending state */
630 save_state ("", true);
634 /* always try to get rid of this */
636 remove_pending_capture_state ();
638 /* save the current state of things if appropriate */
640 if (did_record && !saved) {
641 save_state (_current_snapshot_name);
644 if (ptw & PostTransportStop) {
649 PositionChanged (_transport_frame); /* EMIT SIGNAL */
650 TransportStateChange (); /* EMIT SIGNAL */
652 /* and start it up again if relevant */
654 if ((ptw & PostTransportLocate) && !config.get_external_sync() && pending_locate_roll) {
655 request_transport_speed (1.0);
656 pending_locate_roll = false;
661 Session::check_declick_out ()
663 bool locate_required = transport_sub_state & PendingLocate;
665 /* this is called after a process() iteration. if PendingDeclickOut was set,
666 it means that we were waiting to declick the output (which has just been
667 done) before doing something else. this is where we do that "something else".
669 note: called from the audio thread.
672 if (transport_sub_state & PendingDeclickOut) {
674 if (locate_required) {
675 start_locate (pending_locate_frame, pending_locate_roll, pending_locate_flush);
676 transport_sub_state &= ~(PendingDeclickOut|PendingLocate);
678 stop_transport (pending_abort);
679 transport_sub_state &= ~(PendingDeclickOut|PendingLocate);
685 Session::unset_play_loop ()
688 clear_events (SessionEvent::AutoLoop);
690 // set all tracks to NOT use internal looping
691 boost::shared_ptr<RouteList> rl = routes.reader ();
692 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
693 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
694 if (tr && !tr->hidden()) {
701 Session::set_play_loop (bool yn)
703 /* Called from event-handling context */
707 if (yn == play_loop || (actively_recording() && yn) || (loc = _locations->auto_loop_location()) == 0) {
708 /* nothing to do, or can't change loop status while recording */
712 if (yn && Config->get_seamless_loop() && synced_to_jack()) {
713 warning << string_compose (
714 _("Seamless looping cannot be supported while %1 is using JACK transport.\n"
715 "Recommend changing the configured options"), PROGRAM_NAME)
728 if (Config->get_seamless_loop()) {
729 // set all tracks to use internal looping
730 boost::shared_ptr<RouteList> rl = routes.reader ();
731 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
732 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
733 if (tr && !tr->hidden()) {
739 // set all tracks to NOT use internal looping
740 boost::shared_ptr<RouteList> rl = routes.reader ();
741 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
742 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
743 if (tr && !tr->hidden()) {
749 /* put the loop event into the event list */
751 SessionEvent* event = new SessionEvent (SessionEvent::AutoLoop, SessionEvent::Replace, loc->end(), loc->start(), 0.0f);
754 /* locate to start of loop and roll. If doing seamless loop, force a
755 locate+buffer refill even if we are positioned there already.
758 start_locate (loc->start(), true, true, false, Config->get_seamless_loop());
766 TransportStateChange ();
769 Session::flush_all_inserts ()
771 boost::shared_ptr<RouteList> r = routes.reader ();
773 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
774 (*i)->flush_processors ();
779 Session::start_locate (framepos_t target_frame, bool with_roll, bool with_flush, bool with_loop, bool force)
781 if (synced_to_jack()) {
786 _slave->speed_and_position (sp, pos);
788 if (target_frame != pos) {
790 /* tell JACK to change transport position, and we will
791 follow along later in ::follow_slave()
794 _engine.transport_locate (target_frame);
796 if (sp != 1.0f && with_roll) {
797 _engine.transport_start ();
803 locate (target_frame, with_roll, with_flush, with_loop, force);
808 Session::micro_locate (framecnt_t distance)
810 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->can_internal_playback_seek (distance)) {
818 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
819 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
821 tr->internal_playback_seek (distance);
825 _transport_frame += distance;
829 /** @param with_mmc true to send a MMC locate command when the locate is done */
831 Session::locate (framepos_t target_frame, bool with_roll, bool with_flush, bool with_loop, bool force, bool with_mmc)
833 if (actively_recording() && !with_loop) {
837 if (!force && _transport_frame == target_frame && !loop_changing && !with_loop) {
839 set_transport_speed (1.0, false);
841 loop_changing = false;
842 Located (); /* EMIT SIGNAL */
846 if (_transport_speed) {
847 /* schedule a declick. we'll be called again when its done */
849 if (!(transport_sub_state & PendingDeclickOut)) {
850 transport_sub_state |= (PendingDeclickOut|PendingLocate);
851 pending_locate_frame = target_frame;
852 pending_locate_roll = with_roll;
853 pending_locate_flush = with_flush;
858 // Update Timecode time
859 // [DR] FIXME: find out exactly where this should go below
860 _transport_frame = target_frame;
861 timecode_time(_transport_frame, transmitting_timecode_time);
862 outbound_mtc_timecode_frame = _transport_frame;
863 next_quarter_frame_to_send = 0;
865 /* do "stopped" stuff if:
868 * no autoplay in effect AND
869 * we're not going to keep rolling after the locate AND
870 * !(playing a loop with JACK sync)
874 if (transport_rolling() && (!auto_play_legal || !config.get_auto_play()) && !with_roll && !(synced_to_jack() && play_loop)) {
875 realtime_stop (false, true); // XXX paul - check if the 2nd arg is really correct
877 /* otherwise tell the world that we located */
881 if (force || !with_loop || loop_changing) {
883 PostTransportWork todo = PostTransportLocate;
886 todo = PostTransportWork (todo | PostTransportRoll);
889 add_post_transport_work (todo);
890 _butler->schedule_transport_work ();
894 /* this is functionally what clear_clicks() does but with a tentative lock */
896 Glib::RWLock::WriterLock clickm (click_lock, Glib::TRY_LOCK);
898 if (clickm.locked()) {
900 for (Clicks::iterator i = clicks.begin(); i != clicks.end(); ++i) {
909 /* switch from input if we're going to roll */
910 if (Config->get_monitoring_model() == HardwareMonitoring) {
911 set_track_monitor_input_status (!config.get_auto_input());
914 /* otherwise we're going to stop, so do the opposite */
915 if (Config->get_monitoring_model() == HardwareMonitoring) {
916 set_track_monitor_input_status (true);
920 /* cancel looped playback if transport pos outside of loop range */
922 Location* al = _locations->auto_loop_location();
924 if (al && (_transport_frame < al->start() || _transport_frame > al->end())) {
925 // cancel looping directly, this is called from event handling context
926 set_play_loop (false);
928 else if (al && _transport_frame == al->start()) {
930 // this is only necessary for seamless looping
932 boost::shared_ptr<RouteList> rl = routes.reader();
933 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
934 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
935 if (tr && tr->record_enabled ()) {
936 // tell it we've looped, so it can deal with the record state
937 tr->transport_looped(_transport_frame);
942 TransportLooped(); // EMIT SIGNAL
946 loop_changing = false;
948 _send_timecode_update = true;
951 send_mmc_locate (_transport_frame);
954 Located (); /* EMIT SIGNAL */
957 /** Set the transport speed.
958 * Called from the process thread.
959 * @param speed New speed
962 Session::set_transport_speed (double speed, bool abort, bool clear_state)
964 DEBUG_TRACE (DEBUG::Transport, string_compose ("@ %5 Set transport speed to %1, abort = %2 clear_state = %3, current = %4\n",
965 speed, abort, clear_state, _transport_speed, _transport_frame));
967 if (_transport_speed == speed) {
971 if (actively_recording() && speed != 1.0 && speed != 0.0) {
972 /* no varispeed during recording */
976 _target_transport_speed = fabs(speed);
978 /* 8.0 max speed is somewhat arbitrary but based on guestimates regarding disk i/o capability
979 and user needs. We really need CD-style "skip" playback for ffwd and rewind.
983 speed = min (8.0, speed);
984 } else if (speed < 0) {
985 speed = max (-8.0, speed);
988 if (transport_rolling() && speed == 0.0) {
990 /* we are rolling and we want to stop */
992 if (Config->get_monitoring_model() == HardwareMonitoring) {
993 set_track_monitor_input_status (true);
996 if (synced_to_jack ()) {
998 /* do this here because our response to the slave won't
1001 _play_range = false;
1004 _engine.transport_stop ();
1006 stop_transport (abort);
1011 } else if (transport_stopped() && speed == 1.0) {
1013 /* we are stopped and we want to start rolling at speed 1 */
1015 if (Config->get_monitoring_model() == HardwareMonitoring && config.get_auto_input()) {
1016 set_track_monitor_input_status (false);
1019 if (synced_to_jack()) {
1020 _engine.transport_start ();
1027 /* not zero, not 1.0 ... varispeed */
1029 if ((synced_to_jack()) && speed != 0.0 && speed != 1.0) {
1030 warning << string_compose (
1031 _("Global varispeed cannot be supported while %1 is connected to JACK transport control"),
1037 if (actively_recording()) {
1041 if (speed > 0.0 && _transport_frame == current_end_frame()) {
1045 if (speed < 0.0 && _transport_frame == 0) {
1051 /* if we are reversing relative to the current speed, or relative to the speed
1052 before the last stop, then we have to do extra work.
1055 PostTransportWork todo = PostTransportWork (0);
1057 if ((_transport_speed && speed * _transport_speed < 0.0) || (_last_transport_speed * speed < 0.0) || (_last_transport_speed == 0.0f && speed < 0.0f)) {
1058 todo = PostTransportWork (todo | PostTransportReverse);
1059 _last_roll_or_reversal_location = _transport_frame;
1062 _last_transport_speed = _transport_speed;
1063 _transport_speed = speed;
1065 boost::shared_ptr<RouteList> rl = routes.reader();
1066 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1067 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
1068 if (tr && tr->realtime_set_speed (tr->speed(), true)) {
1069 todo = PostTransportWork (todo | PostTransportSpeed);
1074 add_post_transport_work (todo);
1075 _butler->schedule_transport_work ();
1078 TransportStateChange (); /* EMIT SIGNAL */
1083 /** Stop the transport. */
1085 Session::stop_transport (bool abort, bool clear_state)
1087 if (_transport_speed == 0.0f) {
1091 if (actively_recording() && !(transport_sub_state & StopPendingCapture) && worst_input_latency() > current_block_size) {
1093 boost::shared_ptr<RouteList> rl = routes.reader();
1094 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1095 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
1097 tr->prepare_to_stop (_transport_frame);
1101 /* we need to capture the audio that has still not yet been received by the system
1102 at the time the stop is requested, so we have to roll past that time.
1104 we want to declick before stopping, so schedule the autostop for one
1105 block before the actual end. we'll declick in the subsequent block,
1106 and then we'll really be stopped.
1109 DEBUG_TRACE (DEBUG::Transport, string_compose ("stop transport requested @ %1, scheduled for + %2 - %3 = %4, abort = %5\n",
1110 _transport_frame, _worst_input_latency, current_block_size,
1111 _transport_frame - _worst_input_latency - current_block_size,
1114 SessionEvent *ev = new SessionEvent (SessionEvent::StopOnce, SessionEvent::Replace,
1115 _transport_frame + _worst_input_latency - current_block_size,
1119 transport_sub_state |= StopPendingCapture;
1120 pending_abort = abort;
1124 if ((transport_sub_state & PendingDeclickOut) == 0) {
1126 if (!(transport_sub_state & StopPendingCapture)) {
1127 boost::shared_ptr<RouteList> rl = routes.reader();
1128 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1129 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
1131 tr->prepare_to_stop (_transport_frame);
1136 transport_sub_state |= PendingDeclickOut;
1137 /* we'll be called again after the declick */
1138 pending_abort = abort;
1142 realtime_stop (abort, clear_state);
1143 _butler->schedule_transport_work ();
1146 /** Called from the process thread */
1148 Session::start_transport ()
1150 DEBUG_TRACE (DEBUG::Transport, "start_transport\n");
1152 _last_roll_location = _transport_frame;
1153 _last_roll_or_reversal_location = _transport_frame;
1155 have_looped = false;
1157 /* if record status is Enabled, move it to Recording. if its
1158 already Recording, move it to Disabled.
1161 switch (record_status()) {
1163 if (!config.get_punch_in()) {
1170 disable_record (false);
1178 transport_sub_state |= PendingDeclickIn;
1180 _transport_speed = 1.0;
1181 _target_transport_speed = 1.0;
1183 boost::shared_ptr<RouteList> rl = routes.reader();
1184 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1185 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
1187 tr->realtime_set_speed (tr->speed(), true);
1189 (*i)->automation_snapshot (_transport_frame, true);
1192 if (!_engine.freewheeling()) {
1193 Timecode::Time time;
1194 timecode_time_subframes (_transport_frame, time);
1195 if (!dynamic_cast<MTC_Slave*>(_slave)) {
1196 MIDI::Manager::instance()->mmc()->send (MIDI::MachineControlCommand (MIDI::MachineControl::cmdDeferredPlay));
1200 TransportStateChange (); /* EMIT SIGNAL */
1203 /** Do any transport work in the audio thread that needs to be done after the
1204 * transport thread is finished. Audio thread, realtime safe.
1207 Session::post_transport ()
1209 PostTransportWork ptw = post_transport_work ();
1211 if (ptw & PostTransportAudition) {
1212 if (auditioner && auditioner->auditioning()) {
1213 process_function = &Session::process_audition;
1215 process_function = &Session::process_with_events;
1219 if (ptw & PostTransportStop) {
1221 transport_sub_state = 0;
1224 if (ptw & PostTransportLocate) {
1226 if (((!config.get_external_sync() && (auto_play_legal && config.get_auto_play())) && !_exporting) || (ptw & PostTransportRoll)) {
1230 transport_sub_state = 0;
1235 /* XXX is this really safe? shouldn't we just be unsetting the bits that we actually
1238 set_post_transport_work (PostTransportWork (0));
1242 Session::reset_rf_scale (framecnt_t motion)
1244 cumulative_rf_motion += motion;
1246 if (cumulative_rf_motion < 4 * _current_frame_rate) {
1248 } else if (cumulative_rf_motion < 8 * _current_frame_rate) {
1250 } else if (cumulative_rf_motion < 16 * _current_frame_rate) {
1262 Session::use_sync_source (Slave* new_slave)
1264 /* Runs in process() context */
1266 bool non_rt_required = false;
1268 /* XXX this deletion is problematic because we're in RT context */
1273 send_full_time_code (_transport_frame);
1275 boost::shared_ptr<RouteList> rl = routes.reader();
1276 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1277 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
1278 if (tr && !tr->hidden()) {
1279 if (tr->realtime_set_speed (tr->speed(), true)) {
1280 non_rt_required = true;
1282 tr->set_slaved (_slave != 0);
1286 if (non_rt_required) {
1287 add_post_transport_work (PostTransportSpeed);
1288 _butler->schedule_transport_work ();
1295 Session::drop_sync_source ()
1297 request_sync_source (0);
1301 Session::switch_to_sync_source (SyncSource src)
1305 DEBUG_TRACE (DEBUG::Slave, string_compose ("Setting up sync source %1\n", enum_2_string (src)));
1309 if (_slave && dynamic_cast<MTC_Slave*>(_slave)) {
1314 new_slave = new MTC_Slave (*this, *MIDI::Manager::instance()->mtc_input_port());
1317 catch (failed_constructor& err) {
1323 if (_slave && dynamic_cast<MIDIClock_Slave*>(_slave)) {
1328 new_slave = new MIDIClock_Slave (*this, *MIDI::Manager::instance()->midi_clock_input_port(), 24);
1331 catch (failed_constructor& err) {
1337 if (_slave && dynamic_cast<JACK_Slave*>(_slave)) {
1341 if (config.get_video_pullup() != 0.0f) {
1345 new_slave = new JACK_Slave (_engine.jack());
1353 request_sync_source (new_slave);
1357 Session::set_track_speed (Track* track, double speed)
1359 if (track->realtime_set_speed (speed, false)) {
1360 add_post_transport_work (PostTransportSpeed);
1361 _butler->schedule_transport_work ();
1367 Session::unset_play_range ()
1369 _play_range = false;
1370 _clear_event_type (SessionEvent::RangeStop);
1371 _clear_event_type (SessionEvent::RangeLocate);
1375 Session::set_play_range (list<AudioRange>& range, bool leave_rolling)
1379 /* Called from event-processing context */
1381 unset_play_range ();
1383 if (range.empty()) {
1384 /* _play_range set to false in unset_play_range()
1386 if (!leave_rolling) {
1387 /* stop transport */
1388 SessionEvent* ev = new SessionEvent (SessionEvent::SetTransportSpeed, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0f, false);
1396 /* cancel loop play */
1399 list<AudioRange>::size_type sz = range.size();
1403 list<AudioRange>::iterator i = range.begin();
1404 list<AudioRange>::iterator next;
1406 while (i != range.end()) {
1411 /* locating/stopping is subject to delays for declicking.
1414 framepos_t requested_frame = i->end;
1416 if (requested_frame > current_block_size) {
1417 requested_frame -= current_block_size;
1419 requested_frame = 0;
1422 if (next == range.end()) {
1423 ev = new SessionEvent (SessionEvent::RangeStop, SessionEvent::Add, requested_frame, 0, 0.0f);
1425 ev = new SessionEvent (SessionEvent::RangeLocate, SessionEvent::Add, requested_frame, (*next).start, 0.0f);
1433 } else if (sz == 1) {
1435 ev = new SessionEvent (SessionEvent::RangeStop, SessionEvent::Add, range.front().end, 0, 0.0f);
1440 /* save range so we can do auto-return etc. */
1442 current_audio_range = range;
1444 /* now start rolling at the right place */
1446 ev = new SessionEvent (SessionEvent::LocateRoll, SessionEvent::Add, SessionEvent::Immediate, range.front().start, 0.0f, false);
1449 TransportStateChange ();
1453 Session::request_bounded_roll (framepos_t start, framepos_t end)
1455 AudioRange ar (start, end, 0);
1456 list<AudioRange> lar;
1459 request_play_range (&lar, true);
1462 Session::request_roll_at_and_return (framepos_t start, framepos_t return_to)
1464 SessionEvent *ev = new SessionEvent (SessionEvent::LocateRollLocate, SessionEvent::Add, SessionEvent::Immediate, return_to, 1.0);
1465 ev->target2_frame = start;
1470 Session::engine_halted ()
1474 /* there will be no more calls to process(), so
1475 we'd better clean up for ourselves, right now.
1477 but first, make sure the butler is out of
1481 g_atomic_int_set (&_butler->should_do_transport_work, 0);
1482 set_post_transport_work (PostTransportWork (0));
1485 realtime_stop (false, true);
1486 non_realtime_stop (false, 0, ignored);
1487 transport_sub_state = 0;
1489 TransportStateChange (); /* EMIT SIGNAL */
1494 Session::xrun_recovery ()
1496 Xrun (_transport_frame); /* EMIT SIGNAL */
1498 if (Config->get_stop_recording_on_xrun() && actively_recording()) {
1500 /* it didn't actually halt, but we need
1501 to handle things in the same way.
1509 Session::route_processors_changed (RouteProcessorChange c)
1511 if (ignore_route_processor_changes) {
1515 if (c.type == RouteProcessorChange::MeterPointChange) {
1519 update_latency_compensation ();
1526 Session::allow_auto_play (bool yn)
1528 auto_play_legal = yn;
1532 Session::reset_jack_connection (jack_client_t* jack)
1536 if (_slave && ((js = dynamic_cast<JACK_Slave*> (_slave)) != 0)) {
1537 js->reset_client (jack);
1542 Session::maybe_stop (framepos_t limit)
1544 if ((_transport_speed > 0.0f && _transport_frame >= limit) || (_transport_speed < 0.0f && _transport_frame == 0)) {
1545 if (synced_to_jack () && config.get_jack_time_master ()) {
1546 _engine.transport_stop ();
1547 } else if (!synced_to_jack ()) {
1556 Session::send_mmc_locate (framepos_t t)
1558 if (!_engine.freewheeling()) {
1559 Timecode::Time time;
1560 timecode_time_subframes (t, time);
1561 MIDI::Manager::instance()->mmc()->send (MIDI::MachineControlCommand (time));
1565 /** Ask the transport to not send timecode until further notice. The suspension
1566 * will come into effect some finite time after this call, and timecode_transmission_suspended()
1567 * should be checked by the caller to find out when.
1570 Session::request_suspend_timecode_transmission ()
1572 SessionEvent* ev = new SessionEvent (SessionEvent::SetTimecodeTransmission, SessionEvent::Add, SessionEvent::Immediate, 0, 0, false);
1577 Session::request_resume_timecode_transmission ()
1579 SessionEvent* ev = new SessionEvent (SessionEvent::SetTimecodeTransmission, SessionEvent::Add, SessionEvent::Immediate, 0, 0, true);
1584 Session::timecode_transmission_suspended () const
1586 return g_atomic_int_get (&_suspend_timecode_transmission) == 1;