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 ... */
302 tr->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 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
348 if (tr && !tr->hidden()) {
349 tr->non_realtime_locate (_transport_frame);
351 if (on_entry != g_atomic_int_get (&_butler->should_do_transport_work)) {
352 /* new request, stop seeking, and start again */
353 g_atomic_int_dec_and_test (&_butler->should_do_transport_work);
360 if (ptw & PostTransportLocate) {
361 non_realtime_locate ();
364 if (ptw & PostTransportStop) {
365 non_realtime_stop (ptw & PostTransportAbort, on_entry, finished);
367 g_atomic_int_dec_and_test (&_butler->should_do_transport_work);
372 if (ptw & PostTransportOverWrite) {
373 non_realtime_overwrite (on_entry, finished);
375 g_atomic_int_dec_and_test (&_butler->should_do_transport_work);
380 if (ptw & PostTransportAudition) {
381 non_realtime_set_audition ();
384 g_atomic_int_dec_and_test (&_butler->should_do_transport_work);
386 DEBUG_TRACE (DEBUG::Transport, X_("Butler transport work all done\n"));
390 Session::non_realtime_set_speed ()
392 boost::shared_ptr<RouteList> rl = routes.reader();
393 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
394 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
396 tr->non_realtime_set_speed ();
402 Session::non_realtime_overwrite (int on_entry, bool& finished)
404 boost::shared_ptr<RouteList> rl = routes.reader();
405 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
406 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
407 if (tr && tr->pending_overwrite ()) {
408 tr->overwrite_existing_buffers ();
410 if (on_entry != g_atomic_int_get (&_butler->should_do_transport_work)) {
419 Session::non_realtime_locate ()
421 boost::shared_ptr<RouteList> rl = routes.reader();
422 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
423 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
425 tr->non_realtime_locate (_transport_frame);
429 /* XXX: it would be nice to generate the new clicks here (in the non-RT thread)
430 rather than clearing them so that the RT thread has to spend time constructing
431 them (in Session::click).
438 Session::non_realtime_stop (bool abort, int on_entry, bool& finished)
444 PostTransportWork ptw = post_transport_work();
449 boost::shared_ptr<RouteList> rl = routes.reader();
450 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
451 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
452 if (tr && tr->get_captured_frames () != 0) {
458 /* stop and locate are merged here because they share a lot of common stuff */
461 now = localtime (&xnow);
464 auditioner->cancel_audition ();
467 cumulative_rf_motion = 0;
471 begin_reversible_command (Operations::capture);
472 _have_captured = true;
475 DEBUG_TRACE (DEBUG::Transport, X_("Butler PTW: DS stop\n"));
477 if (abort && did_record) {
478 /* no reason to save the session file when we remove sources
480 _state_of_the_state = StateOfTheState (_state_of_the_state|InCleanup);
483 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
484 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
486 tr->transport_stopped_wallclock (*now, xnow, abort);
490 if (abort && did_record) {
491 _state_of_the_state = StateOfTheState (_state_of_the_state & ~InCleanup);
494 boost::shared_ptr<RouteList> r = routes.reader ();
496 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
497 if (!(*i)->is_hidden()) {
498 (*i)->set_pending_declick (0);
503 commit_reversible_command ();
506 if (_engine.running()) {
507 PostTransportWork ptw = post_transport_work ();
508 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
509 (*i)->nonrealtime_handle_transport_stopped (abort, (ptw & PostTransportLocate), (!(ptw & PostTransportLocate) || pending_locate_flush));
511 update_latency_compensation ();
514 bool const auto_return_enabled =
515 (!config.get_external_sync() && config.get_auto_return());
517 if (auto_return_enabled ||
518 (ptw & PostTransportLocate) ||
519 (_requested_return_frame >= 0) ||
522 if (pending_locate_flush) {
523 flush_all_inserts ();
526 if ((auto_return_enabled || synced_to_jack() || _requested_return_frame >= 0) &&
527 !(ptw & PostTransportLocate)) {
529 /* no explicit locate queued */
531 bool do_locate = false;
533 if (_requested_return_frame >= 0) {
535 /* explicit return request pre-queued in event list. overrides everything else */
537 cerr << "explicit auto-return to " << _requested_return_frame << endl;
539 _transport_frame = _requested_return_frame;
543 if (config.get_auto_return()) {
547 /* don't try to handle loop play when synced to JACK */
549 if (!synced_to_jack()) {
551 Location *location = _locations->auto_loop_location();
554 _transport_frame = location->start();
556 _transport_frame = _last_roll_location;
561 } else if (_play_range) {
563 /* return to start of range */
565 if (!current_audio_range.empty()) {
566 _transport_frame = current_audio_range.front().start;
572 /* regular auto-return */
574 _transport_frame = _last_roll_location;
580 _requested_return_frame = -1;
583 _engine.transport_locate (_transport_frame);
591 /* do this before seeking, because otherwise the tracks will do the wrong thing in seamless loop mode.
594 if (ptw & PostTransportClearSubstate) {
599 /* this for() block can be put inside the previous if() and has the effect of ... ??? what */
601 DEBUG_TRACE (DEBUG::Transport, X_("Butler PTW: locate\n"));
602 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
603 DEBUG_TRACE (DEBUG::Transport, string_compose ("Butler PTW: locate on %1\n", (*i)->name()));
604 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
605 if (tr && !tr->hidden()) {
606 tr->non_realtime_locate (_transport_frame);
609 if (on_entry != g_atomic_int_get (&_butler->should_do_transport_work)) {
611 /* we will be back */
618 if (!_engine.freewheeling()) {
619 send_full_time_code (_transport_frame);
621 if (!dynamic_cast<MTC_Slave*>(_slave)) {
622 MIDI::Manager::instance()->mmc()->send (MIDI::MachineControlCommand (MIDI::MachineControl::cmdStop));
623 send_mmc_locate (_transport_frame);
627 if ((ptw & PostTransportLocate) && get_record_enabled()) {
628 /* capture start has been changed, so save pending state */
629 save_state ("", true);
633 /* always try to get rid of this */
635 remove_pending_capture_state ();
637 /* save the current state of things if appropriate */
639 if (did_record && !saved) {
640 save_state (_current_snapshot_name);
643 if (ptw & PostTransportStop) {
648 PositionChanged (_transport_frame); /* EMIT SIGNAL */
649 TransportStateChange (); /* EMIT SIGNAL */
651 /* and start it up again if relevant */
653 if ((ptw & PostTransportLocate) && !config.get_external_sync() && pending_locate_roll) {
654 request_transport_speed (1.0);
655 pending_locate_roll = false;
660 Session::check_declick_out ()
662 bool locate_required = transport_sub_state & PendingLocate;
664 /* this is called after a process() iteration. if PendingDeclickOut was set,
665 it means that we were waiting to declick the output (which has just been
666 done) before maybe doing something else. this is where we do that "something else".
668 note: called from the audio thread.
671 if (transport_sub_state & PendingDeclickOut) {
673 if (locate_required) {
674 start_locate (pending_locate_frame, pending_locate_roll, pending_locate_flush);
675 transport_sub_state &= ~(PendingDeclickOut|PendingLocate);
677 stop_transport (pending_abort);
678 transport_sub_state &= ~(PendingDeclickOut|PendingLocate);
681 } else if (transport_sub_state & PendingLoopDeclickOut) {
682 /* Nothing else to do here; we've declicked, and the loop event will be along shortly */
683 transport_sub_state &= ~PendingLoopDeclickOut;
688 Session::unset_play_loop ()
691 clear_events (SessionEvent::AutoLoop);
692 clear_events (SessionEvent::AutoLoopDeclick);
694 // set all tracks to NOT use internal looping
695 boost::shared_ptr<RouteList> rl = routes.reader ();
696 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
697 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
698 if (tr && !tr->hidden()) {
705 Session::set_play_loop (bool yn)
707 /* Called from event-handling context */
711 if (yn == play_loop || (actively_recording() && yn) || (loc = _locations->auto_loop_location()) == 0) {
712 /* nothing to do, or can't change loop status while recording */
716 if (yn && Config->get_seamless_loop() && synced_to_jack()) {
717 warning << string_compose (
718 _("Seamless looping cannot be supported while %1 is using JACK transport.\n"
719 "Recommend changing the configured options"), PROGRAM_NAME)
732 if (Config->get_seamless_loop()) {
733 // set all tracks to use internal looping
734 boost::shared_ptr<RouteList> rl = routes.reader ();
735 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
736 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
737 if (tr && !tr->hidden()) {
743 // set all tracks to NOT use internal looping
744 boost::shared_ptr<RouteList> rl = routes.reader ();
745 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
746 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
747 if (tr && !tr->hidden()) {
753 /* Put the delick and loop events in into the event list. The declick event will
754 cause a de-clicking fade-out just before the end of the loop, and it will also result
755 in a fade-in when the loop restarts. The AutoLoop event will peform the actual loop.
760 auto_loop_declick_range (loc, dcp, dcl);
761 merge_event (new SessionEvent (SessionEvent::AutoLoopDeclick, SessionEvent::Replace, dcp, dcl, 0.0f));
762 merge_event (new SessionEvent (SessionEvent::AutoLoop, SessionEvent::Replace, loc->end(), loc->start(), 0.0f));
764 /* locate to start of loop and roll.
766 args: positition, roll=true, flush=true, with_loop=false, force buffer refill if seamless looping
769 start_locate (loc->start(), true, true, false, Config->get_seamless_loop());
777 TransportStateChange ();
780 Session::flush_all_inserts ()
782 boost::shared_ptr<RouteList> r = routes.reader ();
784 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
785 (*i)->flush_processors ();
790 Session::start_locate (framepos_t target_frame, bool with_roll, bool with_flush, bool with_loop, bool force)
792 if (synced_to_jack()) {
797 _slave->speed_and_position (sp, pos);
799 if (target_frame != pos) {
801 if (config.get_jack_time_master()) {
802 /* actually locate now, since otherwise jack_timebase_callback
803 will use the incorrect _transport_frame and report an old
804 and incorrect time to Jack transport
806 locate (target_frame, with_roll, with_flush, with_loop, force);
809 /* tell JACK to change transport position, and we will
810 follow along later in ::follow_slave()
813 _engine.transport_locate (target_frame);
815 if (sp != 1.0f && with_roll) {
816 _engine.transport_start ();
822 locate (target_frame, with_roll, with_flush, with_loop, force);
827 Session::micro_locate (framecnt_t distance)
829 boost::shared_ptr<RouteList> rl = routes.reader();
830 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
831 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
832 if (tr && !tr->can_internal_playback_seek (distance)) {
837 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
838 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
840 tr->internal_playback_seek (distance);
844 _transport_frame += distance;
848 /** @param with_mmc true to send a MMC locate command when the locate is done */
850 Session::locate (framepos_t target_frame, bool with_roll, bool with_flush, bool for_seamless_loop, bool force, bool with_mmc)
852 /* Locates for seamless looping are fairly different from other
853 * locates. They assume that the diskstream buffers for each track
854 * already have the correct data in them, and thus there is no need to
855 * actually tell the tracks to locate. What does need to be done,
856 * though, is all the housekeeping that is associated with non-linear
857 * changes in the value of _transport_frame.
860 if (actively_recording() && !for_seamless_loop) {
864 if (!force && _transport_frame == target_frame && !loop_changing && !for_seamless_loop) {
866 set_transport_speed (1.0, false);
868 loop_changing = false;
869 Located (); /* EMIT SIGNAL */
873 if (_transport_speed && !for_seamless_loop) {
874 /* Schedule a declick. We'll be called again when its done.
875 We only do it this way for ordinary locates, not those
876 due to **seamless** loops.
879 if (!(transport_sub_state & PendingDeclickOut)) {
880 transport_sub_state |= (PendingDeclickOut|PendingLocate);
881 pending_locate_frame = target_frame;
882 pending_locate_roll = with_roll;
883 pending_locate_flush = with_flush;
888 // Update Timecode time
889 // [DR] FIXME: find out exactly where this should go below
890 _transport_frame = target_frame;
891 _last_roll_or_reversal_location = target_frame;
892 timecode_time(_transport_frame, transmitting_timecode_time);
893 outbound_mtc_timecode_frame = _transport_frame;
894 next_quarter_frame_to_send = 0;
896 /* do "stopped" stuff if:
899 * no autoplay in effect AND
900 * we're not going to keep rolling after the locate AND
901 * !(playing a loop with JACK sync)
905 bool transport_was_stopped = !transport_rolling();
907 if (transport_was_stopped && (!auto_play_legal || !config.get_auto_play()) && !with_roll && !(synced_to_jack() && play_loop)) {
908 realtime_stop (false, true); // XXX paul - check if the 2nd arg is really correct
909 transport_was_stopped = true;
911 /* otherwise tell the world that we located */
915 if (force || !for_seamless_loop || loop_changing) {
917 PostTransportWork todo = PostTransportLocate;
919 if (with_roll && transport_was_stopped) {
920 todo = PostTransportWork (todo | PostTransportRoll);
923 add_post_transport_work (todo);
924 _butler->schedule_transport_work ();
928 /* this is functionally what clear_clicks() does but with a tentative lock */
930 Glib::RWLock::WriterLock clickm (click_lock, Glib::TRY_LOCK);
932 if (clickm.locked()) {
934 for (Clicks::iterator i = clicks.begin(); i != clicks.end(); ++i) {
943 /* switch from input if we're going to roll */
944 if (Config->get_monitoring_model() == HardwareMonitoring) {
945 set_track_monitor_input_status (!config.get_auto_input());
948 /* otherwise we're going to stop, so do the opposite */
949 if (Config->get_monitoring_model() == HardwareMonitoring) {
950 set_track_monitor_input_status (true);
954 /* cancel looped playback if transport pos outside of loop range */
957 Location* al = _locations->auto_loop_location();
960 if (_transport_frame < al->start() || _transport_frame > al->end()) {
962 // located outside the loop: cancel looping directly, this is called from event handling context
964 set_play_loop (false);
966 } else if (_transport_frame == al->start()) {
968 // located to start of loop - this is looping, basically
970 if (for_seamless_loop) {
972 // this is only necessary for seamless looping
974 boost::shared_ptr<RouteList> rl = routes.reader();
976 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
977 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
979 if (tr && tr->record_enabled ()) {
980 // tell it we've looped, so it can deal with the record state
981 tr->transport_looped (_transport_frame);
987 TransportLooped(); // EMIT SIGNAL
992 loop_changing = false;
994 _send_timecode_update = true;
997 send_mmc_locate (_transport_frame);
1000 Located (); /* EMIT SIGNAL */
1003 /** Set the transport speed.
1004 * Called from the process thread.
1005 * @param speed New speed
1008 Session::set_transport_speed (double speed, bool abort, bool clear_state, bool as_default)
1010 DEBUG_TRACE (DEBUG::Transport, string_compose ("@ %5 Set transport speed to %1, abort = %2 clear_state = %3, current = %4 as_default %5\n",
1011 speed, abort, clear_state, _transport_speed, _transport_frame, as_default));
1013 if (_transport_speed == speed) {
1017 if (actively_recording() && speed != 1.0 && speed != 0.0) {
1018 /* no varispeed during recording */
1022 _target_transport_speed = fabs(speed);
1024 /* 8.0 max speed is somewhat arbitrary but based on guestimates regarding disk i/o capability
1025 and user needs. We really need CD-style "skip" playback for ffwd and rewind.
1029 speed = min (8.0, speed);
1030 } else if (speed < 0) {
1031 speed = max (-8.0, speed);
1034 if (transport_rolling() && speed == 0.0) {
1036 /* we are rolling and we want to stop */
1038 if (Config->get_monitoring_model() == HardwareMonitoring) {
1039 set_track_monitor_input_status (true);
1042 if (synced_to_jack ()) {
1044 /* do this here because our response to the slave won't
1047 _play_range = false;
1050 _engine.transport_stop ();
1052 stop_transport (abort);
1057 } else if (transport_stopped() && speed == 1.0) {
1059 /* we are stopped and we want to start rolling at speed 1 */
1061 if (Config->get_monitoring_model() == HardwareMonitoring && config.get_auto_input()) {
1062 set_track_monitor_input_status (false);
1065 if (synced_to_jack()) {
1066 _engine.transport_start ();
1073 /* not zero, not 1.0 ... varispeed */
1075 if ((synced_to_jack()) && speed != 0.0 && speed != 1.0) {
1076 warning << string_compose (
1077 _("Global varispeed cannot be supported while %1 is connected to JACK transport control"),
1083 if (actively_recording()) {
1087 if (speed > 0.0 && _transport_frame == current_end_frame()) {
1091 if (speed < 0.0 && _transport_frame == 0) {
1097 /* if we are reversing relative to the current speed, or relative to the speed
1098 before the last stop, then we have to do extra work.
1101 PostTransportWork todo = PostTransportWork (0);
1103 if ((_transport_speed && speed * _transport_speed < 0.0) || (_last_transport_speed * speed < 0.0) || (_last_transport_speed == 0.0f && speed < 0.0f)) {
1104 todo = PostTransportWork (todo | PostTransportReverse);
1105 _last_roll_or_reversal_location = _transport_frame;
1108 _last_transport_speed = _transport_speed;
1109 _transport_speed = speed;
1112 _default_transport_speed = speed;
1115 boost::shared_ptr<RouteList> rl = routes.reader();
1116 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1117 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
1118 if (tr && tr->realtime_set_speed (tr->speed(), true)) {
1119 todo = PostTransportWork (todo | PostTransportSpeed);
1124 add_post_transport_work (todo);
1125 _butler->schedule_transport_work ();
1128 TransportStateChange (); /* EMIT SIGNAL */
1133 /** Stop the transport. */
1135 Session::stop_transport (bool abort, bool clear_state)
1137 if (_transport_speed == 0.0f) {
1141 if (actively_recording() && !(transport_sub_state & StopPendingCapture) && worst_input_latency() > current_block_size) {
1143 boost::shared_ptr<RouteList> rl = routes.reader();
1144 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1145 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
1147 tr->prepare_to_stop (_transport_frame);
1151 /* we need to capture the audio that has still not yet been received by the system
1152 at the time the stop is requested, so we have to roll past that time.
1154 we want to declick before stopping, so schedule the autostop for one
1155 block before the actual end. we'll declick in the subsequent block,
1156 and then we'll really be stopped.
1159 DEBUG_TRACE (DEBUG::Transport, string_compose ("stop transport requested @ %1, scheduled for + %2 - %3 = %4, abort = %5\n",
1160 _transport_frame, _worst_input_latency, current_block_size,
1161 _transport_frame - _worst_input_latency - current_block_size,
1164 SessionEvent *ev = new SessionEvent (SessionEvent::StopOnce, SessionEvent::Replace,
1165 _transport_frame + _worst_input_latency - current_block_size,
1169 transport_sub_state |= StopPendingCapture;
1170 pending_abort = abort;
1174 if ((transport_sub_state & PendingDeclickOut) == 0) {
1176 if (!(transport_sub_state & StopPendingCapture)) {
1177 boost::shared_ptr<RouteList> rl = routes.reader();
1178 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1179 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
1181 tr->prepare_to_stop (_transport_frame);
1186 transport_sub_state |= PendingDeclickOut;
1187 /* we'll be called again after the declick */
1188 pending_abort = abort;
1192 realtime_stop (abort, clear_state);
1193 _butler->schedule_transport_work ();
1196 /** Called from the process thread */
1198 Session::start_transport ()
1200 DEBUG_TRACE (DEBUG::Transport, "start_transport\n");
1202 _last_roll_location = _transport_frame;
1203 _last_roll_or_reversal_location = _transport_frame;
1205 have_looped = false;
1207 /* if record status is Enabled, move it to Recording. if its
1208 already Recording, move it to Disabled.
1211 switch (record_status()) {
1213 if (!config.get_punch_in()) {
1220 disable_record (false);
1228 transport_sub_state |= PendingDeclickIn;
1230 _transport_speed = _default_transport_speed;
1231 _target_transport_speed = _transport_speed;
1233 boost::shared_ptr<RouteList> rl = routes.reader();
1234 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1235 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
1237 tr->realtime_set_speed (tr->speed(), true);
1239 (*i)->automation_snapshot (_transport_frame, true);
1242 if (!_engine.freewheeling()) {
1243 Timecode::Time time;
1244 timecode_time_subframes (_transport_frame, time);
1245 if (!dynamic_cast<MTC_Slave*>(_slave)) {
1246 MIDI::Manager::instance()->mmc()->send (MIDI::MachineControlCommand (MIDI::MachineControl::cmdDeferredPlay));
1250 TransportStateChange (); /* EMIT SIGNAL */
1253 /** Do any transport work in the audio thread that needs to be done after the
1254 * transport thread is finished. Audio thread, realtime safe.
1257 Session::post_transport ()
1259 PostTransportWork ptw = post_transport_work ();
1261 if (ptw & PostTransportAudition) {
1262 if (auditioner && auditioner->auditioning()) {
1263 process_function = &Session::process_audition;
1265 process_function = &Session::process_with_events;
1269 if (ptw & PostTransportStop) {
1271 transport_sub_state = 0;
1274 if (ptw & PostTransportLocate) {
1276 if (((!config.get_external_sync() && (auto_play_legal && config.get_auto_play())) && !_exporting) || (ptw & PostTransportRoll)) {
1279 transport_sub_state = 0;
1284 /* XXX is this really safe? shouldn't we just be unsetting the bits that we actually
1287 set_post_transport_work (PostTransportWork (0));
1291 Session::reset_rf_scale (framecnt_t motion)
1293 cumulative_rf_motion += motion;
1295 if (cumulative_rf_motion < 4 * _current_frame_rate) {
1297 } else if (cumulative_rf_motion < 8 * _current_frame_rate) {
1299 } else if (cumulative_rf_motion < 16 * _current_frame_rate) {
1311 Session::use_sync_source (Slave* new_slave)
1313 /* Runs in process() context */
1315 bool non_rt_required = false;
1317 /* XXX this deletion is problematic because we're in RT context */
1322 send_full_time_code (_transport_frame);
1324 boost::shared_ptr<RouteList> rl = routes.reader();
1325 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1326 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
1327 if (tr && !tr->hidden()) {
1328 if (tr->realtime_set_speed (tr->speed(), true)) {
1329 non_rt_required = true;
1331 tr->set_slaved (_slave != 0);
1335 if (non_rt_required) {
1336 add_post_transport_work (PostTransportSpeed);
1337 _butler->schedule_transport_work ();
1344 Session::drop_sync_source ()
1346 request_sync_source (0);
1350 Session::switch_to_sync_source (SyncSource src)
1354 DEBUG_TRACE (DEBUG::Slave, string_compose ("Setting up sync source %1\n", enum_2_string (src)));
1358 if (_slave && dynamic_cast<MTC_Slave*>(_slave)) {
1363 new_slave = new MTC_Slave (*this, *MIDI::Manager::instance()->mtc_input_port());
1366 catch (failed_constructor& err) {
1372 if (_slave && dynamic_cast<MIDIClock_Slave*>(_slave)) {
1377 new_slave = new MIDIClock_Slave (*this, *MIDI::Manager::instance()->midi_clock_input_port(), 24);
1380 catch (failed_constructor& err) {
1386 if (_slave && dynamic_cast<JACK_Slave*>(_slave)) {
1390 if (config.get_video_pullup() != 0.0f) {
1394 new_slave = new JACK_Slave (_engine.jack());
1402 request_sync_source (new_slave);
1406 Session::set_track_speed (Track* track, double speed)
1408 if (track->realtime_set_speed (speed, false)) {
1409 add_post_transport_work (PostTransportSpeed);
1410 _butler->schedule_transport_work ();
1416 Session::unset_play_range ()
1418 _play_range = false;
1419 _clear_event_type (SessionEvent::RangeStop);
1420 _clear_event_type (SessionEvent::RangeLocate);
1424 Session::set_play_range (list<AudioRange>& range, bool leave_rolling)
1428 /* Called from event-processing context */
1430 unset_play_range ();
1432 if (range.empty()) {
1433 /* _play_range set to false in unset_play_range()
1435 if (!leave_rolling) {
1436 /* stop transport */
1437 SessionEvent* ev = new SessionEvent (SessionEvent::SetTransportSpeed, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0f, false);
1445 /* cancel loop play */
1448 list<AudioRange>::size_type sz = range.size();
1452 list<AudioRange>::iterator i = range.begin();
1453 list<AudioRange>::iterator next;
1455 while (i != range.end()) {
1460 /* locating/stopping is subject to delays for declicking.
1463 framepos_t requested_frame = i->end;
1465 if (requested_frame > current_block_size) {
1466 requested_frame -= current_block_size;
1468 requested_frame = 0;
1471 if (next == range.end()) {
1472 ev = new SessionEvent (SessionEvent::RangeStop, SessionEvent::Add, requested_frame, 0, 0.0f);
1474 ev = new SessionEvent (SessionEvent::RangeLocate, SessionEvent::Add, requested_frame, (*next).start, 0.0f);
1482 } else if (sz == 1) {
1484 ev = new SessionEvent (SessionEvent::RangeStop, SessionEvent::Add, range.front().end, 0, 0.0f);
1489 /* save range so we can do auto-return etc. */
1491 current_audio_range = range;
1493 /* now start rolling at the right place */
1495 ev = new SessionEvent (SessionEvent::LocateRoll, SessionEvent::Add, SessionEvent::Immediate, range.front().start, 0.0f, false);
1498 TransportStateChange ();
1502 Session::request_bounded_roll (framepos_t start, framepos_t end)
1504 AudioRange ar (start, end, 0);
1505 list<AudioRange> lar;
1508 request_play_range (&lar, true);
1511 Session::request_roll_at_and_return (framepos_t start, framepos_t return_to)
1513 SessionEvent *ev = new SessionEvent (SessionEvent::LocateRollLocate, SessionEvent::Add, SessionEvent::Immediate, return_to, 1.0);
1514 ev->target2_frame = start;
1519 Session::engine_halted ()
1523 /* there will be no more calls to process(), so
1524 we'd better clean up for ourselves, right now.
1526 but first, make sure the butler is out of
1531 g_atomic_int_set (&_butler->should_do_transport_work, 0);
1532 set_post_transport_work (PostTransportWork (0));
1536 realtime_stop (false, true);
1537 non_realtime_stop (false, 0, ignored);
1538 transport_sub_state = 0;
1540 TransportStateChange (); /* EMIT SIGNAL */
1545 Session::xrun_recovery ()
1547 Xrun (_transport_frame); /* EMIT SIGNAL */
1549 if (Config->get_stop_recording_on_xrun() && actively_recording()) {
1551 /* it didn't actually halt, but we need
1552 to handle things in the same way.
1560 Session::route_processors_changed (RouteProcessorChange c)
1562 if (ignore_route_processor_changes) {
1566 if (c.type == RouteProcessorChange::MeterPointChange) {
1570 update_latency_compensation ();
1577 Session::allow_auto_play (bool yn)
1579 auto_play_legal = yn;
1583 Session::reset_jack_connection (jack_client_t* jack)
1587 if (_slave && ((js = dynamic_cast<JACK_Slave*> (_slave)) != 0)) {
1588 js->reset_client (jack);
1593 Session::maybe_stop (framepos_t limit)
1595 if ((_transport_speed > 0.0f && _transport_frame >= limit) || (_transport_speed < 0.0f && _transport_frame == 0)) {
1596 if (synced_to_jack () && config.get_jack_time_master ()) {
1597 _engine.transport_stop ();
1598 } else if (!synced_to_jack ()) {
1607 Session::send_mmc_locate (framepos_t t)
1609 if (!_engine.freewheeling()) {
1610 Timecode::Time time;
1611 timecode_time_subframes (t, time);
1612 MIDI::Manager::instance()->mmc()->send (MIDI::MachineControlCommand (time));
1616 /** Ask the transport to not send timecode until further notice. The suspension
1617 * will come into effect some finite time after this call, and timecode_transmission_suspended()
1618 * should be checked by the caller to find out when.
1621 Session::request_suspend_timecode_transmission ()
1623 SessionEvent* ev = new SessionEvent (SessionEvent::SetTimecodeTransmission, SessionEvent::Add, SessionEvent::Immediate, 0, 0, false);
1628 Session::request_resume_timecode_transmission ()
1630 SessionEvent* ev = new SessionEvent (SessionEvent::SetTimecodeTransmission, SessionEvent::Add, SessionEvent::Immediate, 0, 0, true);
1635 Session::timecode_transmission_suspended () const
1637 return g_atomic_int_get (&_suspend_timecode_transmission) == 1;