2 * Copyright (C) 1999-2019 Paul Davis <paul@linuxaudiosystems.com>
3 * Copyright (C) 2005-2009 Taybin Rutkin <taybin@taybin.com>
4 * Copyright (C) 2006-2007 Jesse Chappell <jesse@essej.net>
5 * Copyright (C) 2006-2012 David Robillard <d@drobilla.net>
6 * Copyright (C) 2007-2012 Carl Hetherington <carl@carlh.net>
7 * Copyright (C) 2008-2009 Hans Baier <hansfbaier@googlemail.com>
8 * Copyright (C) 2012-2019 Robin Gareus <robin@gareus.org>
9 * Copyright (C) 2014-2018 Ben Loftis <ben@harrisonconsoles.com>
10 * Copyright (C) 2015 GZharun <grygoriiz@wavesglobal.com>
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License along
23 * with this program; if not, write to the Free Software Foundation, Inc.,
24 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
28 #include "libardour-config.h"
35 #include <boost/algorithm/string/erase.hpp>
37 #include "pbd/error.h"
38 #include "pbd/enumwriter.h"
40 #include "pbd/memento_command.h"
41 #include "pbd/pthread_utils.h"
42 #include "pbd/stacktrace.h"
45 #include "midi++/mmc.h"
46 #include "midi++/port.h"
48 #include "ardour/audioengine.h"
49 #include "ardour/auditioner.h"
50 #include "ardour/automation_watch.h"
51 #include "ardour/butler.h"
52 #include "ardour/click.h"
53 #include "ardour/debug.h"
54 #include "ardour/disk_reader.h"
55 #include "ardour/location.h"
56 #include "ardour/playlist.h"
57 #include "ardour/profile.h"
58 #include "ardour/scene_changer.h"
59 #include "ardour/session.h"
60 #include "ardour/transport_fsm.h"
61 #include "ardour/transport_master.h"
62 #include "ardour/transport_master_manager.h"
63 #include "ardour/tempo.h"
64 #include "ardour/operations.h"
65 #include "ardour/vca.h"
66 #include "ardour/vca_manager.h"
69 using namespace ARDOUR;
74 # define ENSURE_PROCESS_THREAD do {} while (0)
76 # define ENSURE_PROCESS_THREAD \
78 if (!AudioEngine::instance()->in_process_thread()) { \
79 PBD::stacktrace (std::cerr, 30); \
85 #define TFSM_EVENT(evtype) { _transport_fsm->enqueue (new TransportFSM::Event (evtype)); }
86 #define TFSM_STOP(abort,clear) { _transport_fsm->enqueue (new TransportFSM::Event (TransportFSM::StopTransport,abort,clear)); }
87 #define TFSM_LOCATE(target,roll,flush,loop,force) { _transport_fsm->enqueue (new TransportFSM::Event (TransportFSM::Locate,target,roll,flush,loop,force)); }
89 /* *****************************************************************************
90 * REALTIME ACTIONS (to be called on state transitions)
91 * ****************************************************************************/
94 Session::realtime_stop (bool abort, bool clear_state)
96 ENSURE_PROCESS_THREAD;
98 DEBUG_TRACE (DEBUG::Transport, string_compose ("realtime stop @ %1 speed = %2\n", _transport_sample, _transport_speed));
99 PostTransportWork todo = PostTransportWork (0);
101 if (_last_transport_speed < 0.0f) {
102 todo = (PostTransportWork (todo | PostTransportStop | PostTransportReverse));
103 _default_transport_speed = 1.0;
104 DiskReader::inc_no_disk_output (); // for the buffer reversal
106 todo = PostTransportWork (todo | PostTransportStop);
111 boost::shared_ptr<RouteList> r = routes.reader ();
113 for (RouteList::iterator i = r->begin (); i != r->end(); ++i) {
114 (*i)->realtime_handle_transport_stopped ();
117 DEBUG_TRACE (DEBUG::Transport, string_compose ("stop complete, auto-return scheduled for return to %1\n", _requested_return_sample));
120 todo = PostTransportWork (todo | PostTransportAbort);
124 todo = PostTransportWork (todo | PostTransportClearSubstate);
128 add_post_transport_work (todo);
131 _clear_event_type (SessionEvent::RangeStop);
132 _clear_event_type (SessionEvent::RangeLocate);
134 //clear our solo-selection, if there is one
135 if ( solo_selection_active() ) {
136 solo_selection ( _soloSelection, false );
139 /* if we're going to clear loop state, then force disabling record BUT only if we're not doing latched rec-enable */
140 disable_record (true, (!Config->get_latched_record_enable() && clear_state));
142 if (clear_state && !Config->get_loop_is_mode()) {
146 reset_slave_state ();
148 _transport_speed = 0;
149 _target_transport_speed = 0;
152 g_atomic_int_set (&_playback_load, 100);
153 g_atomic_int_set (&_capture_load, 100);
155 if (config.get_use_video_sync()) {
156 waiting_for_sync_offset = true;
160 TFSM_EVENT (TransportFSM::ButlerRequired);
165 Session::locate (samplepos_t target_sample, bool with_roll, bool with_flush, bool for_loop_enabled, bool force, bool with_mmc)
167 ENSURE_PROCESS_THREAD;
169 if (target_sample < 0) {
170 error << _("Locate called for negative sample position - ignored") << endmsg;
174 if (synced_to_engine()) {
178 samplepos_t ignore1, ignore2;
180 transport_master()->speed_and_position (sp, pos, ignore1, ignore2, 0);
182 if (target_sample != pos) {
184 if (config.get_jack_time_master()) {
185 /* actually locate now, since otherwise jack_timebase_callback
186 will use the incorrect _transport_sample and report an old
187 and incorrect time to Jack transport
189 do_locate (target_sample, with_roll, with_flush, for_loop_enabled, force, with_mmc);
192 /* tell JACK to change transport position, and we will
193 follow along later in ::follow_slave()
196 _engine.transport_locate (target_sample);
198 if (sp != 1.0f && with_roll) {
199 _engine.transport_start ();
205 do_locate (target_sample, with_roll, with_flush, for_loop_enabled, force, with_mmc);
209 /** @param with_mmc true to send a MMC locate command when the locate is done */
211 Session::do_locate (samplepos_t target_sample, bool with_roll, bool with_flush, bool for_loop_enabled, bool force, bool with_mmc)
213 ENSURE_PROCESS_THREAD;
215 bool need_butler = false;
217 /* Locates for seamless looping are fairly different from other
218 * locates. They assume that the diskstream buffers for each track
219 * already have the correct data in them, and thus there is no need to
220 * actually tell the tracks to locate. What does need to be done,
221 * though, is all the housekeeping that is associated with non-linear
222 * changes in the value of _transport_sample.
225 DEBUG_TRACE (DEBUG::Transport, string_compose ("rt-locate to %1, roll %2 flush %3 loop-enabled %4 force %5 mmc %6\n",
226 target_sample, with_roll, with_flush, for_loop_enabled, force, with_mmc));
228 if (!force && _transport_sample == target_sample && !loop_changing && !for_loop_enabled) {
230 /* already at the desired position. Not forced to locate,
231 the loop isn't changing, so unless we're told to
232 start rolling also, there's nothing to do but
233 tell the world where we are (again).
237 set_transport_speed (1.0, 0, false);
239 loop_changing = false;
240 TFSM_EVENT (TransportFSM::LocateDone);
241 Located (); /* EMIT SIGNAL */
245 // Update Timecode time
246 _transport_sample = target_sample;
247 // Bump seek counter so that any in-process locate in the butler
248 // thread(s?) can restart.
249 g_atomic_int_inc (&_seek_counter);
250 _last_roll_or_reversal_location = target_sample;
251 _remaining_latency_preroll = worst_latency_preroll ();
252 timecode_time(_transport_sample, transmitting_timecode_time); // XXX here?
254 /* do "stopped" stuff if:
257 * no autoplay in effect AND
258 * we're not going to keep rolling after the locate AND
259 * !(playing a loop with JACK sync) AND
260 * we're not synced to an external transport master
265 /* it is important here that we use the internal state of the transport
266 FSM, not the public facing result of ::transport_rolling()
268 bool transport_was_stopped = _transport_fsm->stopped();
270 if (!transport_was_stopped &&
271 (!auto_play_legal || !config.get_auto_play()) &&
273 !(synced_to_engine() && play_loop) &&
274 (!Profile->get_trx() || !(config.get_external_sync() && !synced_to_engine()))) {
276 realtime_stop (false, true); // XXX paul - check if the 2nd arg is really correct
277 transport_was_stopped = true;
281 /* Tell all routes to do the RT part of locate */
283 boost::shared_ptr<RouteList> r = routes.reader ();
284 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
285 (*i)->realtime_locate ();
289 if (force || !for_loop_enabled || loop_changing) {
291 PostTransportWork todo = PostTransportLocate;
293 if (with_roll && transport_was_stopped) {
294 todo = PostTransportWork (todo | PostTransportRoll);
297 add_post_transport_work (todo);
302 /* this is functionally what clear_clicks() does but with a tentative lock */
304 Glib::Threads::RWLock::WriterLock clickm (click_lock, Glib::Threads::TRY_LOCK);
306 if (clickm.locked()) {
308 for (Clicks::iterator i = clicks.begin(); i != clicks.end(); ++i) {
317 /* switch from input if we're going to roll */
318 if (Config->get_monitoring_model() == HardwareMonitoring) {
319 set_track_monitor_input_status (!config.get_auto_input());
322 /* otherwise we're going to stop, so do the opposite */
323 if (Config->get_monitoring_model() == HardwareMonitoring) {
324 set_track_monitor_input_status (true);
328 /* cancel looped playback if transport pos outside of loop range */
331 Location* al = _locations->auto_loop_location();
334 if (_transport_sample < al->start() || _transport_sample >= al->end()) {
336 // located outside the loop: cancel looping directly, this is called from event handling context
340 if (!Config->get_loop_is_mode()) {
341 set_play_loop (false, _transport_speed);
343 if (Config->get_seamless_loop()) {
344 /* this will make the non_realtime_locate() in the butler
345 which then causes seek() in tracks actually do the right
348 set_track_loop (false);
352 } else if (_transport_sample == al->start()) {
354 // located to start of loop - this is looping, basically
358 if (_last_roll_location != al->start()) {
359 /* didn't start at loop start - playback must have
360 * started before loop since we've now hit the loop
363 add_post_transport_work (PostTransportLocate);
369 boost::shared_ptr<RouteList> rl = routes.reader();
371 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
372 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
374 if (tr && tr->rec_enable_control()->get_value()) {
375 // tell it we've looped, so it can deal with the record state
376 tr->transport_looped (_transport_sample);
381 TransportLooped(); // EMIT SIGNAL
387 TFSM_EVENT (TransportFSM::ButlerRequired);
389 TFSM_EVENT (TransportFSM::LocateDone);
392 loop_changing = false;
394 _send_timecode_update = true;
397 send_mmc_locate (_transport_sample);
400 _last_roll_location = _last_roll_or_reversal_location = _transport_sample;
401 if (!synced_to_engine () || _transport_sample == _engine.transport_sample ()) {
402 Located (); /* EMIT SIGNAL */
407 Session::post_locate ()
409 if (transport_master_is_external() && !synced_to_engine()) {
410 const samplepos_t current_master_position = TransportMasterManager::instance().get_current_position_in_process_context();
411 if (abs (current_master_position - _transport_sample) > TransportMasterManager::instance().current()->resolution()) {
412 _last_roll_location = _last_roll_or_reversal_location = _transport_sample;
417 /** Set the transport speed.
418 * Called from the process thread.
419 * @param speed New speed
422 Session::set_transport_speed (double speed, samplepos_t destination_sample, bool abort, bool clear_state, bool as_default)
424 ENSURE_PROCESS_THREAD;
425 DEBUG_TRACE (DEBUG::Transport, string_compose ("@ %5 Set transport speed to %1, abort = %2 clear_state = %3, current = %4 as_default %6\n",
426 speed, abort, clear_state, _transport_speed, _transport_sample, as_default));
428 /* max speed is somewhat arbitrary but based on guestimates regarding disk i/o capability
429 and user needs. We really need CD-style "skip" playback for ffwd and rewind.
433 speed = min ((double) Config->get_max_transport_speed(), speed);
434 } else if (speed < 0) {
435 speed = max ((double) -Config->get_max_transport_speed(), speed);
438 double new_engine_speed = 1.0;
440 new_engine_speed = fabs (speed);
441 if (speed < 0) speed = -1;
442 if (speed > 0) speed = 1;
445 if (_transport_speed == speed && new_engine_speed == _engine_speed) {
446 if (as_default && speed == 0.0) { // => reset default transport speed. hacky or what?
447 _default_transport_speed = 1.0;
452 #if 0 // TODO pref: allow vari-speed recording
453 if (actively_recording() && speed != 1.0 && speed != 0.0) {
454 /* no varispeed during recording */
455 DEBUG_TRACE (DEBUG::Transport, string_compose ("No varispeed during recording cur_speed %1, sample %2\n",
456 _transport_speed, _transport_sample));
461 _target_transport_speed = fabs(speed);
462 _engine_speed = new_engine_speed;
464 if (transport_rolling() && speed == 0.0) {
466 /* we are rolling and we want to stop */
468 if (Config->get_monitoring_model() == HardwareMonitoring) {
469 set_track_monitor_input_status (true);
472 if (synced_to_engine ()) {
474 /* do this here because our response to the slave won't
478 _count_in_once = false;
481 _engine.transport_stop ();
483 bool const auto_return_enabled = (!config.get_external_sync() && (Config->get_auto_return_target_list() || abort));
485 if (!auto_return_enabled) {
486 _requested_return_sample = destination_sample;
489 TFSM_STOP (abort, false);
492 } else if (transport_stopped() && speed == 1.0) {
494 _default_transport_speed = speed;
496 /* we are stopped and we want to start rolling at speed 1 */
498 if (Config->get_loop_is_mode() && play_loop) {
500 Location *location = _locations->auto_loop_location();
503 if (_transport_sample != location->start()) {
505 if (Config->get_seamless_loop()) {
506 /* force tracks to do their thing */
507 set_track_loop (true);
510 /* jump to start and then roll from there */
512 request_locate (location->start(), true);
518 if (Config->get_monitoring_model() == HardwareMonitoring && config.get_auto_input()) {
519 set_track_monitor_input_status (false);
522 if (synced_to_engine()) {
523 _engine.transport_start ();
524 _count_in_once = false;
526 TFSM_EVENT (TransportFSM::StartTransport);
531 /* not zero, not 1.0 ... varispeed */
533 // TODO handled transport start.. _remaining_latency_preroll
534 // and reversal of playback direction.
536 if ((synced_to_engine()) && speed != 0.0 && speed != 1.0) {
537 warning << string_compose (
538 _("Global varispeed cannot be supported while %1 is connected to JACK transport control"),
545 if (actively_recording()) {
550 if (speed > 0.0 && _transport_sample == current_end_sample()) {
554 if (speed < 0.0 && _transport_sample == 0) {
560 /* if we are reversing relative to the current speed, or relative to the speed
561 before the last stop, then we have to do extra work.
564 PostTransportWork todo = PostTransportWork (0);
566 if ((_transport_speed && speed * _transport_speed < 0.0) || (_last_transport_speed * speed < 0.0) || (_last_transport_speed == 0.0 && speed < 0.0)) {
567 todo = PostTransportWork (todo | PostTransportReverse);
568 DiskReader::inc_no_disk_output (); // for the buffer reversal
569 _last_roll_or_reversal_location = _transport_sample;
572 _last_transport_speed = _transport_speed;
573 _transport_speed = speed;
576 _default_transport_speed = speed;
580 add_post_transport_work (todo);
581 TFSM_EVENT (TransportFSM::ButlerRequired);
584 DEBUG_TRACE (DEBUG::Transport, string_compose ("send TSC3 with speed = %1\n", _transport_speed));
586 /* throttle signal emissions.
587 * when slaved [_last]_transport_speed
588 * usually changes every cycle (tiny amounts due to DLL).
589 * Emitting a signal every cycle is overkill and unwarranted.
591 * Using _last_transport_speed is not acceptable,
592 * since it allows for large changes over a long period
593 * of time. Hence we introduce a dedicated variable to keep track
595 * The 0.2% dead-zone is somewhat arbitrary. Main use-case
596 * for TransportStateChange() here is the ShuttleControl display.
598 if (fabs (_signalled_varispeed - actual_speed ()) > .002
599 // still, signal hard changes to 1.0 and 0.0:
600 || (actual_speed () == 1.0 && _signalled_varispeed != 1.0)
601 || (actual_speed () == 0.0 && _signalled_varispeed != 0.0)
604 TransportStateChange (); /* EMIT SIGNAL */
605 _signalled_varispeed = actual_speed ();
610 /** Stop the transport. */
612 Session::stop_transport (bool abort, bool clear_state)
614 ENSURE_PROCESS_THREAD;
616 _count_in_once = false;
618 DEBUG_TRACE (DEBUG::Transport, string_compose ("time to actually stop with TS @ %1\n", _transport_sample));
620 realtime_stop (abort, clear_state);
623 /** Called from the process thread */
625 Session::start_transport ()
627 ENSURE_PROCESS_THREAD;
628 DEBUG_TRACE (DEBUG::Transport, "start_transport\n");
630 _last_roll_location = _transport_sample;
631 _last_roll_or_reversal_location = _transport_sample;
632 _remaining_latency_preroll = worst_latency_preroll ();
636 /* if record status is Enabled, move it to Recording. if its
637 already Recording, move it to Disabled.
640 switch (record_status()) {
642 if (!config.get_punch_in()) {
643 /* This is only for UIs (keep blinking rec-en before
644 * punch-in, don't show rec-region etc). The UI still
645 * depends on SessionEvent::PunchIn and ensuing signals.
647 * The disk-writers handle punch in/out internally
648 * in their local delay-compensated timeframe.
656 disable_record (false);
664 _transport_speed = _default_transport_speed;
665 _target_transport_speed = _transport_speed;
667 if (!_engine.freewheeling()) {
669 timecode_time_subframes (_transport_sample, time);
670 if (transport_master()->type() == MTC) {
671 send_immediate_mmc (MIDI::MachineControlCommand (MIDI::MachineControl::cmdDeferredPlay));
674 if ((actively_recording () || (config.get_punch_in () && get_record_enabled ()))
675 && click_data && (config.get_count_in () || _count_in_once)) {
676 _count_in_once = false;
677 /* calculate count-in duration (in audio samples)
678 * - use [fixed] tempo/meter at _transport_sample
679 * - calc duration of 1 bar + time-to-beat before or at transport_sample
681 const Tempo& tempo = _tempo_map->tempo_at_sample (_transport_sample);
682 const Meter& meter = _tempo_map->meter_at_sample (_transport_sample);
684 const double num = meter.divisions_per_bar ();
685 const double den = meter.note_divisor ();
686 const double barbeat = _tempo_map->exact_qn_at_sample (_transport_sample, 0) * den / (4. * num);
687 const double bar_fract = fmod (barbeat, 1.0); // fraction of bar elapsed.
689 _count_in_samples = meter.samples_per_bar (tempo, _current_sample_rate);
691 double dt = _count_in_samples / num;
692 if (bar_fract == 0) {
693 /* at bar boundary, count-in 2 bars before start. */
694 _count_in_samples *= 2;
696 /* beats left after full bar until roll position */
697 _count_in_samples *= 1. + bar_fract;
700 if (_count_in_samples > _remaining_latency_preroll) {
701 _remaining_latency_preroll = _count_in_samples;
705 samplepos_t cf = _transport_sample - _count_in_samples;
706 samplecnt_t offset = _click_io->connected_latency (true);
707 while (cf < _transport_sample + offset) {
708 add_click (cf, clickbeat == 0);
710 clickbeat = fmod (clickbeat + 1, num);
713 if (_count_in_samples < _remaining_latency_preroll) {
714 _count_in_samples = _remaining_latency_preroll;
719 DEBUG_TRACE (DEBUG::Transport, string_compose ("send TSC4 with speed = %1\n", _transport_speed));
720 TransportStateChange (); /* EMIT SIGNAL */
724 Session::should_roll_after_locate () const
726 /* a locate must previously have been requested and completed */
728 return ((!config.get_external_sync() && (auto_play_legal && config.get_auto_play())) && !_exporting) || (post_transport_work() & PostTransportRoll);
732 /** Do any transport work in the audio thread that needs to be done after the
733 * butler thread is finished. Audio thread, realtime safe.
736 Session::butler_completed_transport_work ()
738 ENSURE_PROCESS_THREAD;
739 PostTransportWork ptw = post_transport_work ();
741 DEBUG_TRACE (DEBUG::Transport, string_compose ("Butler done, RT cleanup for %1\n", enum_2_string (ptw)));
743 if (ptw & PostTransportAudition) {
744 if (auditioner && auditioner->auditioning()) {
745 process_function = &Session::process_audition;
747 process_function = &Session::process_with_events;
749 ptw = PostTransportWork (ptw & ~PostTransportAudition);
750 set_post_transport_work (ptw);
753 if (ptw & PostTransportLocate) {
755 ptw = PostTransportWork (ptw & ~PostTransportLocate);
756 set_post_transport_work (ptw);
757 TFSM_EVENT (TransportFSM::LocateDone);
760 if (ptw & PostTransportAdjustPlaybackBuffering) {
761 /* we blocked output while this happened */
762 DiskReader::dec_no_disk_output ();
763 ptw = PostTransportWork (ptw & ~PostTransportAdjustPlaybackBuffering);
764 set_post_transport_work (ptw);
767 ptw = PostTransportWork (ptw & ~(PostTransportAdjustCaptureBuffering|PostTransportOverWrite));
768 set_post_transport_work (ptw);
772 if (_transport_fsm->waiting_for_butler()) {
773 TFSM_EVENT (TransportFSM::ButlerDone);
776 DiskReader::dec_no_disk_output ();
780 Session::schedule_butler_for_transport_work ()
782 assert (_transport_fsm->waiting_for_butler ());
783 DEBUG_TRACE (DEBUG::Butler, "summon butler for transport work\n");
784 _butler->schedule_transport_work ();
788 Session::maybe_stop (samplepos_t limit)
790 ENSURE_PROCESS_THREAD;
791 if ((_transport_speed > 0.0f && _transport_sample >= limit) || (_transport_speed < 0.0f && _transport_sample == 0)) {
792 if (synced_to_engine () && config.get_jack_time_master ()) {
793 _engine.transport_stop ();
794 } else if (!synced_to_engine ()) {
795 TFSM_EVENT (TransportFSM::StopTransport);
803 Session::micro_locate (samplecnt_t distance)
805 ENSURE_PROCESS_THREAD;
807 boost::shared_ptr<RouteList> rl = routes.reader();
808 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
809 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
810 if (tr && !tr->can_internal_playback_seek (distance)) {
815 DEBUG_TRACE (DEBUG::Transport, string_compose ("micro-locate by %1\n", distance));
817 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
818 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
820 tr->internal_playback_seek (distance);
824 _transport_sample += distance;
829 Session::flush_all_inserts ()
831 ENSURE_PROCESS_THREAD;
832 boost::shared_ptr<RouteList> r = routes.reader ();
834 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
835 (*i)->flush_processors ();
840 Session::set_play_loop (bool yn, double speed)
842 ENSURE_PROCESS_THREAD;
843 /* Called from event-handling context */
847 if (yn == play_loop || (actively_recording() && yn) || (loc = _locations->auto_loop_location()) == 0) {
848 /* nothing to do, or can't change loop status while recording */
852 if (yn && Config->get_seamless_loop() && synced_to_engine()) {
853 warning << string_compose (
854 _("Seamless looping cannot be supported while %1 is using JACK transport.\n"
855 "Recommend changing the configured options"), PROGRAM_NAME)
869 if (Config->get_seamless_loop()) {
870 if (!Config->get_loop_is_mode()) {
871 /* set all tracks to use internal looping */
872 set_track_loop (true);
874 /* we will do this in the locate to the start OR when we hit the end
875 * of the loop for the first time
879 /* set all tracks to NOT use internal looping */
880 set_track_loop (false);
883 /* Put the delick and loop events in into the event list. The declick event will
884 cause a de-clicking fade-out just before the end of the loop, and it will also result
885 in a fade-in when the loop restarts. The AutoLoop event will peform the actual loop.
890 auto_loop_declick_range (loc, dcp, dcl);
891 merge_event (new SessionEvent (SessionEvent::AutoLoop, SessionEvent::Replace, loc->end(), loc->start(), 0.0f));
893 /* if requested to roll, locate to start of loop and
894 * roll but ONLY if we're not already rolling.
896 args: positition, roll=true, flush=true, with_loop=false, force buffer refill if seamless looping
899 if (Config->get_loop_is_mode()) {
900 /* loop IS a transport mode: if already
901 rolling, do not locate to loop start.
903 if (!transport_rolling() && (speed != 0.0)) {
904 TFSM_LOCATE (loc->start(), true, true, false, true);
908 TFSM_LOCATE (loc->start(), true, true, false, true);
918 DEBUG_TRACE (DEBUG::Transport, string_compose ("send TSC2 with speed = %1\n", _transport_speed));
919 TransportStateChange ();
922 /* *****************************************************************************
923 * END REALTIME ACTIONS
924 * ****************************************************************************/
928 Session::add_post_transport_work (PostTransportWork ptw)
930 PostTransportWork oldval;
931 PostTransportWork newval;
935 oldval = (PostTransportWork) g_atomic_int_get (&_post_transport_work);
936 newval = PostTransportWork (oldval | ptw);
937 if (g_atomic_int_compare_and_exchange (&_post_transport_work, oldval, newval)) {
943 error << "Could not set post transport work! Crazy thread madness, call the programmers" << endmsg;
947 Session::should_ignore_transport_request (TransportRequestSource src, TransportRequestType type) const
949 if (config.get_external_sync()) {
950 if (TransportMasterManager::instance().current()->allow_request (src, type)) {
960 Session::synced_to_engine() const {
961 return config.get_external_sync() && TransportMasterManager::instance().current()->type() == Engine;
965 Session::request_sync_source (boost::shared_ptr<TransportMaster> tm)
967 SessionEvent* ev = new SessionEvent (SessionEvent::SetTransportMaster, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
968 ev->transport_master = tm;
969 DEBUG_TRACE (DEBUG::Slave, "sent request for new transport master\n");
974 Session::request_transport_speed (double speed, bool as_default, TransportRequestSource origin)
976 if (should_ignore_transport_request (origin, TR_Speed)) {
979 SessionEvent* ev = new SessionEvent (SessionEvent::SetTransportSpeed, SessionEvent::Add, SessionEvent::Immediate, 0, speed);
980 ev->third_yes_or_no = as_default; // as_default
981 DEBUG_TRACE (DEBUG::Transport, string_compose ("Request transport speed = %1 as default = %2\n", speed, as_default));
985 /** Request a new transport speed, but if the speed parameter is exactly zero then use
986 * a very small +ve value to prevent the transport actually stopping. This method should
987 * be used by callers who are varying transport speed but don't ever want to stop it.
990 Session::request_transport_speed_nonzero (double speed, bool as_default, TransportRequestSource origin)
992 if (should_ignore_transport_request (origin, TransportRequestType (TR_Speed|TR_Start))) {
1000 request_transport_speed (speed, as_default);
1004 Session::request_stop (bool abort, bool clear_state, TransportRequestSource origin)
1006 if (should_ignore_transport_request (origin, TR_Stop)) {
1010 SessionEvent* ev = new SessionEvent (SessionEvent::SetTransportSpeed, SessionEvent::Add, SessionEvent::Immediate, audible_sample(), 0.0, abort, clear_state);
1011 DEBUG_TRACE (DEBUG::Transport, string_compose ("Request transport stop, audible %3 transport %4 abort = %1, clear state = %2\n", abort, clear_state, audible_sample(), _transport_sample));
1016 Session::request_locate (samplepos_t target_sample, bool with_roll, TransportRequestSource origin)
1018 if (should_ignore_transport_request (origin, TR_Locate)) {
1022 SessionEvent *ev = new SessionEvent (with_roll ? SessionEvent::LocateRoll : SessionEvent::Locate, SessionEvent::Add, SessionEvent::Immediate, target_sample, 0, false);
1023 DEBUG_TRACE (DEBUG::Transport, string_compose ("Request locate to %1\n", target_sample));
1028 Session::force_locate (samplepos_t target_sample, bool with_roll)
1030 SessionEvent *ev = new SessionEvent (with_roll ? SessionEvent::LocateRoll : SessionEvent::Locate, SessionEvent::Add, SessionEvent::Immediate, target_sample, 0, true);
1031 DEBUG_TRACE (DEBUG::Transport, string_compose ("Request forced locate to %1\n", target_sample));
1036 Session::unset_preroll_record_trim ()
1038 _preroll_record_trim_len = 0;
1042 Session::request_preroll_record_trim (samplepos_t rec_in, samplecnt_t preroll)
1044 if (actively_recording ()) {
1047 unset_preroll_record_trim ();
1049 config.set_punch_in (false);
1050 config.set_punch_out (false);
1052 samplepos_t pos = std::max ((samplepos_t)0, rec_in - preroll);
1053 _preroll_record_trim_len = preroll;
1054 maybe_enable_record ();
1055 request_locate (pos, true);
1056 set_requested_return_sample (rec_in);
1060 Session::request_count_in_record ()
1062 if (actively_recording ()) {
1065 if (transport_rolling()) {
1068 maybe_enable_record ();
1069 _count_in_once = true;
1070 request_transport_speed (1.0, true);
1074 Session::request_play_loop (bool yn, bool change_transport_roll)
1076 if (transport_master_is_external() && yn) {
1077 // don't attempt to loop when not using Internal Transport
1078 // see also gtk2_ardour/ardour_ui_options.cc parameter_changed()
1083 Location *location = _locations->auto_loop_location();
1084 double target_speed;
1086 if (location == 0 && yn) {
1087 error << _("Cannot loop - no loop range defined")
1092 if (change_transport_roll) {
1093 if (transport_rolling()) {
1094 /* start looping at current speed */
1095 target_speed = transport_speed ();
1097 /* currently stopped */
1099 /* start looping at normal speed */
1106 /* leave the speed alone */
1107 target_speed = transport_speed ();
1110 ev = new SessionEvent (SessionEvent::SetLoop, SessionEvent::Add, SessionEvent::Immediate, 0, target_speed, yn);
1111 DEBUG_TRACE (DEBUG::Transport, string_compose ("Request set loop = %1, change roll state ? %2\n", yn, change_transport_roll));
1115 if (!change_transport_roll) {
1116 if (!transport_rolling()) {
1117 /* we're not changing transport state, but we do want
1118 to set up position for the new loop. Don't
1119 do this if we're rolling already.
1121 request_locate (location->start(), false);
1125 if (!change_transport_roll && Config->get_seamless_loop() && transport_rolling()) {
1126 // request an immediate locate to refresh the tracks
1127 // after disabling looping
1128 request_locate (_transport_sample-1, false);
1134 Session::request_play_range (list<AudioRange>* range, bool leave_rolling)
1136 SessionEvent* ev = new SessionEvent (SessionEvent::SetPlayAudioRange, SessionEvent::Add, SessionEvent::Immediate, 0, (leave_rolling ? 1.0 : 0.0));
1138 ev->audio_range = *range;
1140 ev->audio_range.clear ();
1142 DEBUG_TRACE (DEBUG::Transport, string_compose ("Request play range, leave rolling ? %1\n", leave_rolling));
1147 Session::request_cancel_play_range ()
1149 SessionEvent* ev = new SessionEvent (SessionEvent::CancelPlayAudioRange, SessionEvent::Add, SessionEvent::Immediate, 0, 0);
1155 Session::solo_selection_active ()
1157 if (_soloSelection.empty()) {
1164 Session::solo_selection (StripableList &list, bool new_state)
1166 boost::shared_ptr<ControlList> solo_list (new ControlList);
1167 boost::shared_ptr<ControlList> unsolo_list (new ControlList);
1170 _soloSelection = list;
1172 _soloSelection.clear();
1174 boost::shared_ptr<RouteList> rl = get_routes();
1176 for (ARDOUR::RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1178 if ( !(*i)->is_track() ) {
1182 boost::shared_ptr<Stripable> s (*i);
1184 bool found = (std::find(list.begin(), list.end(), s) != list.end());
1185 if ( new_state && found ) {
1187 solo_list->push_back (s->solo_control());
1189 //must invalidate playlists on selected tracks, so only selected regions get heard
1190 boost::shared_ptr<Track> track = boost::dynamic_pointer_cast<Track> (*i);
1192 boost::shared_ptr<Playlist> playlist = track->playlist();
1194 playlist->ContentsChanged();
1198 unsolo_list->push_back (s->solo_control());
1202 set_controls (solo_list, 1.0, Controllable::NoGroup);
1203 set_controls (unsolo_list, 0.0, Controllable::NoGroup);
1208 Session::butler_transport_work ()
1210 /* Note: this function executes in the butler thread context */
1213 boost::shared_ptr<RouteList> r = routes.reader ();
1214 int on_entry = g_atomic_int_get (&_butler->should_do_transport_work);
1215 bool finished = true;
1216 PostTransportWork ptw = post_transport_work();
1219 DEBUG_TRACE (DEBUG::Transport, string_compose ("Butler transport work, todo = [%1] (0x%3%4%5) at %2\n", enum_2_string (ptw), (before = g_get_monotonic_time()), std::hex, ptw, std::dec));
1221 if (ptw & PostTransportLocate) {
1223 if (get_play_loop() && !Config->get_seamless_loop()) {
1225 DEBUG_TRACE (DEBUG::Butler, "flush loop recording fragment to disk\n");
1227 /* this locate might be happening while we are
1230 * Non-seamless looping will require a locate (below) that
1231 * will reset capture buffers and throw away data.
1233 * Rather than first find all tracks and see if they
1234 * have outstanding data, just do a flush anyway. It
1235 * may be cheaper this way anyway, and is certainly
1239 bool more_disk_io_to_do = false;
1240 uint32_t errors = 0;
1243 more_disk_io_to_do = _butler->flush_tracks_to_disk_after_locate (r, errors);
1249 if (more_disk_io_to_do) {
1258 if (ptw & PostTransportAdjustPlaybackBuffering) {
1259 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
1260 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
1262 tr->adjust_playback_buffering ();
1263 /* and refill those buffers ... */
1265 (*i)->non_realtime_locate (_transport_sample);
1267 VCAList v = _vca_manager->vcas ();
1268 for (VCAList::const_iterator i = v.begin(); i != v.end(); ++i) {
1269 (*i)->non_realtime_locate (_transport_sample);
1273 if (ptw & PostTransportAdjustCaptureBuffering) {
1274 /* need to prevent concurrency with ARDOUR::DiskWriter::run(),
1275 * DiskWriter::adjust_buffering() re-allocates the ringbuffer */
1276 Glib::Threads::Mutex::Lock lx (AudioEngine::instance()->process_lock ());
1277 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
1278 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
1280 tr->adjust_capture_buffering ();
1285 if (ptw & PostTransportReverse) {
1289 /* don't seek if locate will take care of that in non_realtime_stop() */
1291 if (!(ptw & PostTransportLocate)) {
1292 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
1293 (*i)->non_realtime_locate (_transport_sample);
1295 if (on_entry != g_atomic_int_get (&_butler->should_do_transport_work)) {
1296 /* new request, stop seeking, and start again */
1297 g_atomic_int_dec_and_test (&_butler->should_do_transport_work);
1301 VCAList v = _vca_manager->vcas ();
1302 for (VCAList::const_iterator i = v.begin(); i != v.end(); ++i) {
1303 (*i)->non_realtime_locate (_transport_sample);
1308 if (ptw & PostTransportLocate) {
1309 DEBUG_TRACE (DEBUG::Transport, "nonrealtime locate invoked from BTW\n");
1310 non_realtime_locate ();
1313 if (ptw & PostTransportStop) {
1314 non_realtime_stop (ptw & PostTransportAbort, on_entry, finished);
1316 g_atomic_int_dec_and_test (&_butler->should_do_transport_work);
1321 if (ptw & PostTransportOverWrite) {
1322 non_realtime_overwrite (on_entry, finished);
1324 g_atomic_int_dec_and_test (&_butler->should_do_transport_work);
1329 if (ptw & PostTransportAudition) {
1330 non_realtime_set_audition ();
1333 g_atomic_int_dec_and_test (&_butler->should_do_transport_work);
1335 DEBUG_TRACE (DEBUG::Transport, string_compose (X_("Butler transport work all done after %1 usecs @ %2 trw = %3\n"), g_get_monotonic_time() - before, _transport_sample, _butler->transport_work_requested()));
1339 Session::non_realtime_overwrite (int on_entry, bool& finished)
1341 boost::shared_ptr<RouteList> rl = routes.reader();
1342 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1343 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
1344 if (tr && tr->pending_overwrite ()) {
1345 tr->overwrite_existing_buffers ();
1347 if (on_entry != g_atomic_int_get (&_butler->should_do_transport_work)) {
1355 Session::non_realtime_locate ()
1357 DEBUG_TRACE (DEBUG::Transport, string_compose ("locate tracks to %1\n", _transport_sample));
1359 if (Config->get_loop_is_mode() && get_play_loop()) {
1361 Location *loc = _locations->auto_loop_location();
1363 if (!loc || (_transport_sample < loc->start() || _transport_sample >= loc->end())) {
1364 /* jumped out of loop range: stop tracks from looping,
1365 but leave loop (mode) enabled.
1367 set_track_loop (false);
1369 } else if (loc && Config->get_seamless_loop() &&
1370 ((loc->start() <= _transport_sample) || (loc->end() > _transport_sample))) {
1372 /* jumping to start of loop. This might have been done before but it is
1373 * idempotent and cheap. Doing it here ensures that when we start playback
1374 * outside the loop we still flip tracks into the magic seamless mode
1377 set_track_loop (true);
1380 set_track_loop (false);
1385 /* no more looping .. should have been noticed elsewhere */
1392 boost::shared_ptr<RouteList> rl = routes.reader();
1395 gint sc = g_atomic_int_get (&_seek_counter);
1396 tf = _transport_sample;
1398 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1399 (*i)->non_realtime_locate (tf);
1400 if (sc != g_atomic_int_get (&_seek_counter)) {
1401 std::cerr << "\n\nLOCATE INTERRUPTED BY LOCATE!!!\n\n";
1408 /* VCAs are quick to locate because they have no data (except
1409 automation) associated with them. Don't bother with a
1410 restart mechanism here, but do use the same transport sample
1411 that the Routes used.
1413 VCAList v = _vca_manager->vcas ();
1414 for (VCAList::const_iterator i = v.begin(); i != v.end(); ++i) {
1415 (*i)->non_realtime_locate (tf);
1419 _scene_changer->locate (_transport_sample);
1421 /* XXX: it would be nice to generate the new clicks here (in the non-RT thread)
1422 rather than clearing them so that the RT thread has to spend time constructing
1423 them (in Session::click).
1429 Session::select_playhead_priority_target (samplepos_t& jump_to)
1431 if (!transport_master_no_external_or_using_engine() || !config.get_auto_return()) {
1435 jump_to = _last_roll_location;
1436 return jump_to >= 0;
1440 Session::follow_playhead_priority ()
1444 if (select_playhead_priority_target (target)) {
1445 request_locate (target);
1450 Session::non_realtime_stop (bool abort, int on_entry, bool& finished)
1456 PostTransportWork ptw = post_transport_work();
1461 boost::shared_ptr<RouteList> rl = routes.reader();
1462 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1463 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
1464 if (tr && tr->get_captured_samples () != 0) {
1470 /* stop and locate are merged here because they share a lot of common stuff */
1473 now = localtime (&xnow);
1476 auditioner->cancel_audition ();
1480 begin_reversible_command (Operations::capture);
1481 _have_captured = true;
1484 DEBUG_TRACE (DEBUG::Transport, X_("Butler PTW: DS stop\n"));
1486 if (abort && did_record) {
1487 /* no reason to save the session file when we remove sources
1489 _state_of_the_state = StateOfTheState (_state_of_the_state | InCleanup);
1492 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1493 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
1495 tr->transport_stopped_wallclock (*now, xnow, abort);
1499 if (abort && did_record) {
1500 _state_of_the_state = StateOfTheState (_state_of_the_state & ~InCleanup);
1503 boost::shared_ptr<RouteList> r = routes.reader ();
1506 commit_reversible_command ();
1507 /* increase take name */
1508 if (config.get_track_name_take () && !config.get_take_name ().empty()) {
1509 string newname = config.get_take_name();
1510 config.set_take_name(bump_name_number (newname));
1514 if (_engine.running()) {
1515 PostTransportWork ptw = post_transport_work ();
1517 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
1518 (*i)->non_realtime_transport_stop (_transport_sample, !(ptw & PostTransportLocate));
1520 VCAList v = _vca_manager->vcas ();
1521 for (VCAList::const_iterator i = v.begin(); i != v.end(); ++i) {
1522 (*i)->non_realtime_transport_stop (_transport_sample, !(ptw & PostTransportLocate));
1525 update_latency_compensation ();
1528 /* If we are not synced to a "true" external master, and we're not
1529 * handling an explicit locate, we should consider whether or not to
1530 * "auto-return". This could mean going to a specifically requested
1531 * location, or just back to the start of the last roll.
1534 if (transport_master_no_external_or_using_engine() && !(ptw & PostTransportLocate)) {
1536 bool do_locate = false;
1538 if (_requested_return_sample >= 0) {
1540 /* explicit return request pre-queued in event list. overrides everything else */
1542 _transport_sample = _requested_return_sample;
1544 /* cancel this request */
1545 _requested_return_sample = -1;
1548 } else if (Config->get_auto_return_target_list()) {
1550 samplepos_t jump_to;
1552 if (select_playhead_priority_target (jump_to)) {
1554 /* there's a valid target (we don't care how it
1558 _transport_sample = jump_to;
1563 /* roll aborted (typically capture) with
1564 * auto-return enabled
1567 _transport_sample = _last_roll_location;
1574 if (do_locate && synced_to_engine()) {
1576 /* We will unconditionally locate to _transport_sample
1577 * below, which will refill playback buffers based on
1578 * _transport_sample, and maximises the buffering they
1581 * But if we are synced to engine (JACK), we should
1582 * locate the engine (JACK) as well. We would follow
1583 * the engine (JACK) on the next process cycle, but
1584 * since we're going to do a locate below anyway,
1585 * it seems pointless to not use just do it ourselves
1586 * right now, rather than wait for the engine (JACK) to
1587 * provide the new position on the next cycle.
1589 * Despite the generic name of the called method
1590 * (::transport_locate()) this method only does
1591 * anything if the audio/MIDI backend is JACK.
1594 _engine.transport_locate (_transport_sample);
1600 unset_preroll_record_trim ();
1602 /* do this before seeking, because otherwise the tracks will do the wrong thing in seamless loop mode.
1605 if (ptw & (PostTransportClearSubstate|PostTransportStop)) {
1606 unset_play_range ();
1607 if (!Config->get_loop_is_mode()) {
1612 /* this for() block can be put inside the previous if() and has the effect of ... ??? what */
1615 DEBUG_TRACE (DEBUG::Transport, X_("Butler PTW: locate\n"));
1616 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
1617 DEBUG_TRACE (DEBUG::Transport, string_compose ("Butler PTW: locate on %1\n", (*i)->name()));
1618 (*i)->non_realtime_locate (_transport_sample);
1620 if (on_entry != g_atomic_int_get (&_butler->should_do_transport_work)) {
1622 /* we will be back */
1629 VCAList v = _vca_manager->vcas ();
1630 for (VCAList::const_iterator i = v.begin(); i != v.end(); ++i) {
1631 (*i)->non_realtime_locate (_transport_sample);
1635 have_looped = false;
1637 /* don't bother with this stuff if we're disconnected from the engine,
1638 because there will be no process callbacks to deliver stuff from
1641 if (_engine.running() && !_engine.freewheeling()) {
1642 // need to queue this in the next RT cycle
1643 _send_timecode_update = true;
1645 if (transport_master()->type() == MTC) {
1646 send_immediate_mmc (MIDI::MachineControlCommand (MIDI::MachineControl::cmdStop));
1648 /* This (::non_realtime_stop()) gets called by main
1649 process thread, which will lead to confusion
1650 when calling AsyncMIDIPort::write().
1652 Something must be done. XXX
1654 send_mmc_locate (_transport_sample);
1658 if ((ptw & PostTransportLocate) && get_record_enabled()) {
1659 /* This is scheduled by realtime_stop(), which is also done
1660 * when a slave requests /locate/ for an initial sync.
1661 * We can't hold up the slave for long with a save() here,
1662 * without breaking its initial sync cycle.
1664 * save state only if there's no slave or if it's not yet locked.
1666 if (!transport_master_is_external() || !transport_master()->locked()) {
1667 DEBUG_TRACE (DEBUG::Transport, X_("Butler PTW: requests save\n"));
1668 SaveSessionRequested (_current_snapshot_name);
1673 /* save the current state of things if appropriate */
1675 if (did_record && !saved) {
1676 SaveSessionRequested (_current_snapshot_name);
1679 PositionChanged (_transport_sample); /* EMIT SIGNAL */
1680 DEBUG_TRACE (DEBUG::Transport, string_compose ("send TSC with speed = %1\n", _transport_speed));
1681 TransportStateChange (); /* EMIT SIGNAL */
1682 AutomationWatch::instance().transport_stop_automation_watches (_transport_sample);
1684 ptw = PostTransportWork (ptw & ~(PostTransportStop|PostTransportClearSubstate));
1685 set_post_transport_work (ptw);
1689 Session::unset_play_loop ()
1693 clear_events (SessionEvent::AutoLoop);
1694 set_track_loop (false);
1697 if (Config->get_seamless_loop()) {
1698 /* likely need to flush track buffers: this will locate us to wherever we are */
1699 add_post_transport_work (PostTransportLocate);
1700 TFSM_EVENT (TransportFSM::ButlerRequired);
1702 TransportStateChange (); /* EMIT SIGNAL */
1707 Session::set_track_loop (bool yn)
1709 Location* loc = _locations->auto_loop_location ();
1715 boost::shared_ptr<RouteList> rl = routes.reader ();
1717 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1718 if (*i && !(*i)->is_private_route()) {
1719 (*i)->set_loop (yn ? loc : 0);
1725 Session::worst_latency_preroll () const
1727 return _worst_output_latency + _worst_input_latency;
1731 Session::unset_play_range ()
1733 _play_range = false;
1734 _clear_event_type (SessionEvent::RangeStop);
1735 _clear_event_type (SessionEvent::RangeLocate);
1739 Session::set_play_range (list<AudioRange>& range, bool leave_rolling)
1743 /* Called from event-processing context */
1745 unset_play_range ();
1747 if (range.empty()) {
1748 /* _play_range set to false in unset_play_range()
1750 if (!leave_rolling) {
1751 /* stop transport */
1752 SessionEvent* ev = new SessionEvent (SessionEvent::SetTransportSpeed, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0f, false);
1760 /* cancel loop play */
1763 list<AudioRange>::size_type sz = range.size();
1767 list<AudioRange>::iterator i = range.begin();
1768 list<AudioRange>::iterator next;
1770 while (i != range.end()) {
1775 /* locating/stopping is subject to delays for declicking.
1778 samplepos_t requested_sample = i->end;
1780 if (requested_sample > current_block_size) {
1781 requested_sample -= current_block_size;
1783 requested_sample = 0;
1786 if (next == range.end()) {
1787 ev = new SessionEvent (SessionEvent::RangeStop, SessionEvent::Add, requested_sample, 0, 0.0f);
1789 ev = new SessionEvent (SessionEvent::RangeLocate, SessionEvent::Add, requested_sample, (*next).start, 0.0f);
1797 } else if (sz == 1) {
1799 ev = new SessionEvent (SessionEvent::RangeStop, SessionEvent::Add, range.front().end, 0, 0.0f);
1804 /* save range so we can do auto-return etc. */
1806 current_audio_range = range;
1808 /* now start rolling at the right place */
1810 ev = new SessionEvent (SessionEvent::LocateRoll, SessionEvent::Add, SessionEvent::Immediate, range.front().start, 0.0f, false);
1813 DEBUG_TRACE (DEBUG::Transport, string_compose ("send TSC5 with speed = %1\n", _transport_speed));
1814 TransportStateChange ();
1818 Session::request_bounded_roll (samplepos_t start, samplepos_t end)
1820 AudioRange ar (start, end, 0);
1821 list<AudioRange> lar;
1824 request_play_range (&lar, true);
1828 Session::set_requested_return_sample (samplepos_t return_to)
1830 _requested_return_sample = return_to;
1834 Session::request_roll_at_and_return (samplepos_t start, samplepos_t return_to)
1836 SessionEvent *ev = new SessionEvent (SessionEvent::LocateRollLocate, SessionEvent::Add, SessionEvent::Immediate, return_to, 1.0);
1837 ev->target2_sample = start;
1842 Session::engine_halted ()
1844 /* there will be no more calls to process(), so
1845 we'd better clean up for ourselves, right now.
1847 We can't queue SessionEvents because they only get
1848 handled from within a process callback.
1851 /* this just stops the FSM engine ... it doesn't change the state of
1852 * the FSM directly or anything else ... but the FSM will be
1853 * reinitialized when we call its ::start() method from
1854 * ::engine_running() (if we ever get there)
1857 _transport_fsm->stop ();
1859 /* Synchronously do the realtime part of a transport stop.
1861 * Calling this will cause the butler to asynchronously run
1862 * ::non_realtime_stop() where the rest of the "stop" work will be
1866 realtime_stop (false, true);
1870 Session::engine_running ()
1872 initialize_latencies ();
1873 _transport_fsm->start ();
1877 Session::xrun_recovery ()
1881 Xrun (_transport_sample); /* EMIT SIGNAL */
1883 if (Config->get_stop_recording_on_xrun() && actively_recording()) {
1885 /* it didn't actually halt, but we need
1886 to handle things in the same way.
1894 Session::route_processors_changed (RouteProcessorChange c)
1896 if (g_atomic_int_get (&_ignore_route_processor_changes) > 0) {
1900 if (c.type == RouteProcessorChange::MeterPointChange) {
1905 if (c.type == RouteProcessorChange::RealTimeChange) {
1910 update_latency_compensation ();
1917 Session::allow_auto_play (bool yn)
1919 auto_play_legal = yn;
1924 Session::send_mmc_locate (samplepos_t t)
1930 if (!_engine.freewheeling()) {
1931 Timecode::Time time;
1932 timecode_time_subframes (t, time);
1933 send_immediate_mmc (MIDI::MachineControlCommand (time));
1937 /** Ask the transport to not send timecode until further notice. The suspension
1938 * will come into effect some finite time after this call, and timecode_transmission_suspended()
1939 * should be checked by the caller to find out when.
1942 Session::request_suspend_timecode_transmission ()
1944 SessionEvent* ev = new SessionEvent (SessionEvent::SetTimecodeTransmission, SessionEvent::Add, SessionEvent::Immediate, 0, 0, false);
1949 Session::request_resume_timecode_transmission ()
1951 SessionEvent* ev = new SessionEvent (SessionEvent::SetTimecodeTransmission, SessionEvent::Add, SessionEvent::Immediate, 0, 0, true);
1956 Session::timecode_transmission_suspended () const
1958 return g_atomic_int_get (&_suspend_timecode_transmission) == 1;
1961 boost::shared_ptr<TransportMaster>
1962 Session::transport_master() const
1964 return TransportMasterManager::instance().current();
1968 Session::transport_master_is_external () const
1970 return TransportMasterManager::instance().current() && config.get_external_sync();
1974 Session::transport_master_no_external_or_using_engine () const
1976 return !TransportMasterManager::instance().current() || !config.get_external_sync() || (TransportMasterManager::instance().current()->type() == Engine);
1980 Session::sync_source_changed (SyncSource type, samplepos_t pos, pframes_t cycle_nframes)
1982 /* Runs in process() context */
1984 boost::shared_ptr<TransportMaster> master = TransportMasterManager::instance().current();
1986 /* save value of seamless from before the switch */
1987 _was_seamless = Config->get_seamless_loop ();
1989 if (type == Engine) {
1990 /* JACK cannot support seamless looping at present */
1991 Config->set_seamless_loop (false);
1993 /* reset to whatever the value was before we last switched slaves */
1994 Config->set_seamless_loop (_was_seamless);
1997 if (master->can_loop()) {
1998 request_play_loop (false);
1999 } else if (master->has_loop()) {
2000 request_play_loop (true);
2003 /* slave change, reset any DiskIO block on disk output because it is no
2004 longer valid with a new slave.
2007 DiskReader::dec_no_disk_output ();
2010 we should not be treating specific transport masters as special cases because there maybe > 1 of a particular type
2012 boost::shared_ptr<MTC_TransportMaster> mtc_master = boost::dynamic_pointer_cast<MTC_TransportMaster> (master);
2015 mtc_master->ActiveChanged.connect_same_thread (mtc_status_connection, boost::bind (&Session::mtc_status_changed, this, _1));
2016 MTCSyncStateChanged(mtc_master->locked() );
2018 if (g_atomic_int_compare_and_exchange (&_mtc_active, 1, 0)) {
2019 MTCSyncStateChanged( false );
2021 mtc_status_connection.disconnect ();
2024 boost::shared_ptr<LTC_TransportMaster> ltc_master = boost::dynamic_pointer_cast<LTC_TransportMaster> (master);
2027 ltc_master->ActiveChanged.connect_same_thread (ltc_status_connection, boost::bind (&Session::ltc_status_changed, this, _1));
2028 LTCSyncStateChanged (ltc_master->locked() );
2030 if (g_atomic_int_compare_and_exchange (&_ltc_active, 1, 0)) {
2031 LTCSyncStateChanged( false );
2033 ltc_status_connection.disconnect ();
2037 DEBUG_TRACE (DEBUG::Slave, string_compose ("set new slave to %1\n", master));
2039 // need to queue this for next process() cycle
2040 _send_timecode_update = true;
2042 boost::shared_ptr<RouteList> rl = routes.reader();
2043 const bool externally_slaved = transport_master_is_external();
2045 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
2046 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
2047 if (tr && !tr->is_private_route()) {
2048 tr->set_slaved (externally_slaved);
2056 Session::transport_stopped() const
2058 return _transport_fsm->stopped();
2062 Session::transport_rolling() const
2064 return _transport_speed != 0.0 && _count_in_samples == 0 && _remaining_latency_preroll == 0;
2068 Session::locate_pending () const
2070 return _transport_fsm->locating();
2074 Session::declick_in_progress () const
2076 return _transport_fsm->declick_in_progress();