2 Copyright (C) 1999-2002 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 #include "pbd/error.h"
27 #include <glibmm/thread.h>
29 #include "ardour/ardour.h"
30 #include "ardour/audio_diskstream.h"
31 #include "ardour/audioengine.h"
32 #include "ardour/auditioner.h"
33 #include "ardour/butler.h"
34 #include "ardour/debug.h"
35 #include "ardour/session.h"
36 #include "ardour/slave.h"
37 #include "ardour/timestamps.h"
39 #include "midi++/manager.h"
43 using namespace ARDOUR;
47 /** Called by the audio engine when there is work to be done with JACK.
48 * @param nframes Number of frames to process.
51 Session::process (nframes_t nframes)
53 // This is no more the appropriate place to call cycle
54 // start. cycle_start needs to be called at the Route::roll()
55 // where the signals which we want to mixdown have been calculated.
57 MIDI::Manager::instance()->cycle_start(nframes);
61 if (processing_blocked()) {
66 if (non_realtime_work_pending()) {
67 if (!_butler->transport_work_requested ()) {
72 (this->*process_function) (nframes);
74 // the ticker is for sending time information like MidiClock
75 nframes_t transport_frames = transport_frame();
76 BBT_Time transport_bbt;
77 bbt_time(transport_frames, transport_bbt);
78 Timecode::Time transport_timecode;
79 timecode_time(transport_frames, transport_timecode);
80 tick (transport_frames, transport_bbt, transport_timecode); /* EMIT SIGNAL */
82 SendFeedback (); /* EMIT SIGNAL */
84 MIDI::Manager::instance()->cycle_end();
88 Session::prepare_diskstreams ()
90 boost::shared_ptr<DiskstreamList> dsl = diskstreams.reader();
91 for (DiskstreamList::iterator i = dsl->begin(); i != dsl->end(); ++i) {
97 Session::fail_roll (nframes_t nframes)
99 return no_roll (nframes);
103 Session::no_roll (nframes_t nframes)
105 nframes_t end_frame = _transport_frame + nframes; // FIXME: varispeed + no_roll ??
107 bool declick = get_transport_declick_required();
108 boost::shared_ptr<RouteList> r = routes.reader ();
111 _click_io->silence (nframes);
114 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
116 if ((*i)->is_hidden()) {
120 (*i)->set_pending_declick (declick);
122 if ((*i)->no_roll (nframes, _transport_frame, end_frame, non_realtime_work_pending(),
123 actively_recording(), declick)) {
124 error << string_compose(_("Session: error in no roll for %1"), (*i)->name()) << endmsg;
134 Session::process_routes (nframes_t nframes)
137 int declick = get_transport_declick_required();
138 bool rec_monitors = get_rec_monitors_input();
139 boost::shared_ptr<RouteList> r = routes.reader ();
141 if (transport_sub_state & StopPendingCapture) {
142 /* force a declick out */
146 record_active = actively_recording(); // || (get_record_enabled() && get_punch_in());
148 const nframes_t start_frame = _transport_frame;
149 const nframes_t end_frame = _transport_frame + (nframes_t)floor(nframes * _transport_speed);
151 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
155 if ((*i)->is_hidden()) {
159 (*i)->set_pending_declick (declick);
161 if ((ret = (*i)->roll (nframes, start_frame, end_frame, declick, record_active, rec_monitors)) < 0) {
163 /* we have to do this here. Route::roll() for an AudioTrack will have called AudioDiskstream::process(),
164 and the DS will expect AudioDiskstream::commit() to be called. but we're aborting from that
165 call path, so make sure we release any outstanding locks here before we return failure.
168 boost::shared_ptr<DiskstreamList> dsl = diskstreams.reader();
169 for (DiskstreamList::iterator ids = dsl->begin(); ids != dsl->end(); ++ids) {
182 Session::silent_process_routes (nframes_t nframes)
184 bool record_active = actively_recording();
185 int declick = get_transport_declick_required();
186 bool rec_monitors = get_rec_monitors_input();
187 boost::shared_ptr<RouteList> r = routes.reader ();
189 if (transport_sub_state & StopPendingCapture) {
190 /* force a declick out */
194 const nframes_t start_frame = _transport_frame;
195 const nframes_t end_frame = _transport_frame + lrintf(nframes * _transport_speed);
197 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
201 if ((*i)->is_hidden()) {
205 if ((ret = (*i)->silent_roll (nframes, start_frame, end_frame, record_active, rec_monitors)) < 0) {
207 /* we have to do this here. Route::roll() for an AudioTrack will have called AudioDiskstream::process(),
208 and the DS will expect AudioDiskstream::commit() to be called. but we're aborting from that
209 call path, so make sure we release any outstanding locks here before we return failure.
212 boost::shared_ptr<DiskstreamList> dsl = diskstreams.reader();
213 for (DiskstreamList::iterator ids = dsl->begin(); ids != dsl->end(); ++ids) {
226 Session::commit_diskstreams (nframes_t nframes, bool &needs_butler)
232 boost::shared_ptr<DiskstreamList> dsl = diskstreams.reader();
233 for (DiskstreamList::iterator i = dsl->begin(); i != dsl->end(); ++i) {
235 if ((*i)->hidden()) {
239 /* force all diskstreams not handled by a Route to call do their stuff.
240 Note: the diskstreams that were handled by a route will just return zero
241 from this call, because they know they were processed. So in fact, this
242 also runs commit() for every diskstream.
245 if ((dret = (*i)->process (_transport_frame, nframes, actively_recording(), get_rec_monitors_input())) == 0) {
246 if ((*i)->commit (nframes)) {
250 } else if (dret < 0) {
254 pworst = min (pworst, (*i)->playback_buffer_load());
255 cworst = min (cworst, (*i)->capture_buffer_load());
258 uint32_t pmin = g_atomic_int_get (&_playback_load);
259 uint32_t pminold = g_atomic_int_get (&_playback_load_min);
260 uint32_t cmin = g_atomic_int_get (&_capture_load);
261 uint32_t cminold = g_atomic_int_get (&_capture_load_min);
263 g_atomic_int_set (&_playback_load, (uint32_t) floor (pworst * 100.0f));
264 g_atomic_int_set (&_capture_load, (uint32_t) floor (cworst * 100.0f));
265 g_atomic_int_set (&_playback_load_min, min (pmin, pminold));
266 g_atomic_int_set (&_capture_load_min, min (cmin, cminold));
268 if (actively_recording()) {
273 /** Process callback used when the auditioner is not active */
275 Session::process_with_events (nframes_t nframes)
278 nframes_t this_nframes;
280 bool session_needs_butler = false;
281 nframes_t stop_limit;
284 /* make sure the auditioner is silent */
287 auditioner->silence (nframes);
290 /* handle any pending events */
292 while (pending_events.read (&ev, 1) == 1) {
296 /* if we are not in the middle of a state change,
297 and there are immediate events queued up,
301 while (!non_realtime_work_pending() && !immediate_events.empty()) {
302 Event *ev = immediate_events.front ();
303 immediate_events.pop_front ();
307 /* Events caused a transport change, send an MTC Full Frame (Timecode) message.
308 * This is sent whether rolling or not, to give slaves an idea of ardour time
309 * on locates (and allow slow slaves to position and prepare for rolling)
311 if (_send_timecode_update) {
312 send_full_time_code(nframes);
313 deliver_mmc (MIDI::MachineControl::cmdLocate, _transport_frame);
316 if (!process_can_proceed()) {
321 if (events.empty() || next_event == events.end()) {
322 process_without_events (nframes);
326 if (_transport_speed == 1.0) {
327 frames_moved = (long) nframes;
329 interpolation.set_target_speed (fabs(_target_transport_speed));
330 interpolation.set_speed (fabs(_transport_speed));
331 frames_moved = (long) interpolation.interpolate (0, nframes, 0, 0);
334 end_frame = _transport_frame + (nframes_t)frames_moved;
338 Events::iterator the_next_one;
340 if (!process_can_proceed()) {
345 if (!_exporting && _slave) {
346 if (!follow_slave (nframes)) {
351 if (_transport_speed == 0) {
357 send_midi_time_code_for_cycle (nframes);
360 if (actively_recording()) {
361 stop_limit = max_frames;
364 if (Config->get_stop_at_session_end()) {
365 stop_limit = current_end_frame();
367 stop_limit = max_frames;
371 if (maybe_stop (stop_limit)) {
376 this_event = *next_event;
377 the_next_one = next_event;
380 /* yes folks, here it is, the actual loop where we really truly
386 this_nframes = nframes; /* real (jack) time relative */
387 frames_moved = (long) floor (_transport_speed * nframes); /* transport relative */
389 /* running an event, position transport precisely to its time */
390 if (this_event && this_event->action_frame <= end_frame && this_event->action_frame >= _transport_frame) {
391 /* this isn't quite right for reverse play */
392 frames_moved = (long) (this_event->action_frame - _transport_frame);
393 this_nframes = (nframes_t) abs( floor(frames_moved / _transport_speed) );
398 click (_transport_frame, this_nframes);
400 /* now process frames between now and the first event in this block */
401 prepare_diskstreams ();
403 if (process_routes (this_nframes)) {
408 commit_diskstreams (this_nframes, session_needs_butler);
410 nframes -= this_nframes;
412 if (frames_moved < 0) {
413 decrement_transport_position (-frames_moved);
415 increment_transport_position (frames_moved);
418 maybe_stop (stop_limit);
419 check_declick_out ();
422 _engine.split_cycle (this_nframes);
424 /* now handle this event and all others scheduled for the same time */
426 while (this_event && this_event->action_frame == _transport_frame) {
427 process_event (this_event);
429 if (the_next_one == events.end()) {
432 this_event = *the_next_one;
437 /* if an event left our state changing, do the right thing */
439 if (nframes && non_realtime_work_pending()) {
444 /* this is necessary to handle the case of seamless looping */
445 end_frame = _transport_frame + (nframes_t) floor (nframes * _transport_speed);
451 } /* implicit release of route lock */
453 if (session_needs_butler) {
459 Session::reset_slave_state ()
461 average_slave_delta = 1800;
462 delta_accumulator_cnt = 0;
463 have_first_delta_accumulator = false;
464 slave_state = Stopped;
468 Session::transport_locked () const
472 if (!locate_pending() && (!config.get_external_sync() || (sl && sl->ok() && sl->locked()))) {
480 Session::follow_slave (nframes_t nframes)
483 nframes64_t slave_transport_frame;
484 nframes_t this_delta;
490 config.set_external_sync (false);
494 _slave->speed_and_position (slave_speed, slave_transport_frame);
496 DEBUG_TRACE (DEBUG::Slave, string_compose ("Slave @ %2 speed %1\n", slave_speed, slave_transport_frame));
498 if (!_slave->locked()) {
502 if (slave_transport_frame > _transport_frame) {
503 this_delta = slave_transport_frame - _transport_frame;
506 this_delta = _transport_frame - slave_transport_frame;
510 if ((starting = _slave->starting())) {
514 if (_slave->is_always_synced() || config.get_timecode_source_is_synced()) {
516 /* if the TC source is synced, then we assume that its
517 speed is binary: 0.0 or 1.0
520 if (slave_speed != 0.0f) {
526 /* TC source is able to drift relative to us (slave)
527 so we need to keep track of the drift and adjust
528 our speed to remain locked.
531 calculate_moving_average_of_slave_delta(dir, this_delta);
534 track_slave_state (slave_speed, slave_transport_frame, this_delta, starting);
536 if (slave_state == Running && !_slave->is_always_synced() && !config.get_timecode_source_is_synced()) {
538 if (_transport_speed != 0.0f) {
541 note that average_dir is +1 or -1
546 #ifdef USE_MOVING_AVERAGE_OF_SLAVE
547 if (average_slave_delta == 0) {
551 delta = average_slave_delta;
552 delta *= average_dir;
559 if (fabs(delta) > _slave->resolution() * 2) {
560 /* too far off, so locate and keep rolling */
561 DEBUG_TRACE (DEBUG::Slave, string_compose ("slave delta %1 is too big, locate to %2\n", delta, slave_transport_frame));
562 request_locate (slave_transport_frame, true);
565 float adjusted_speed = slave_speed + (delta / float(_current_frame_rate));
567 if (_slave->give_slave_full_control_over_transport_speed()) {
568 request_transport_speed (slave_speed);
570 request_transport_speed (adjusted_speed);
571 DEBUG_TRACE (DEBUG::Slave, string_compose ("adjust using %1 towards %2 ratio %3 current %4 slave @ %5\n",
572 delta, adjusted_speed, adjusted_speed/slave_speed, _transport_speed,
577 if (abs(average_slave_delta) > (long) _slave->resolution()) {
578 cerr << "average slave delta greater than slave resolution, going to silent motion\n";
585 if (slave_speed != 0.0) {
586 DEBUG_TRACE (DEBUG::Slave, string_compose ("delta = %1 speed = %2 ts = %3 M@%4 S@%5 avgdelta %6\n",
587 (int) (dir * this_delta),
591 slave_transport_frame,
593 average_slave_delta));
597 if (!starting && !non_realtime_work_pending()) {
598 /* speed is set, we're locked, and good to go */
603 DEBUG_TRACE (DEBUG::Slave, "silent motion\n")
604 follow_slave_silently (nframes, slave_speed);
607 /* don't move at all */
608 DEBUG_TRACE (DEBUG::Slave, "no roll\n")
614 Session::calculate_moving_average_of_slave_delta(int dir, nframes_t this_delta)
616 if (delta_accumulator_cnt >= delta_accumulator_size) {
617 have_first_delta_accumulator = true;
618 delta_accumulator_cnt = 0;
621 if (delta_accumulator_cnt != 0 || this_delta < _current_frame_rate) {
622 delta_accumulator[delta_accumulator_cnt++] = long(dir) * long(this_delta);
625 if (have_first_delta_accumulator) {
626 average_slave_delta = 0L;
627 for (int i = 0; i < delta_accumulator_size; ++i) {
628 average_slave_delta += delta_accumulator[i];
630 average_slave_delta /= long(delta_accumulator_size);
631 if (average_slave_delta < 0L) {
633 average_slave_delta = abs(average_slave_delta);
641 Session::track_slave_state(
643 nframes_t slave_transport_frame,
644 nframes_t this_delta,
647 if (slave_speed != 0.0f) {
649 /* slave is running */
651 switch (slave_state) {
653 if (_slave->requires_seekahead()) {
654 slave_wait_end = slave_transport_frame + _current_frame_rate;
655 locate (slave_wait_end, false, false);
656 slave_state = Waiting;
661 slave_state = Running;
663 Location* al = _locations.auto_loop_location();
665 if (al && play_loop && (slave_transport_frame < al->start() || slave_transport_frame > al->end())) {
667 request_play_loop(false);
670 if (slave_transport_frame != _transport_frame) {
671 locate (slave_transport_frame, false, false);
684 if (slave_state == Waiting) {
687 cerr << "waiting at " << slave_transport_frame << endl;
689 if (slave_transport_frame >= slave_wait_end) {
691 cerr << "\tstart at " << _transport_frame << endl;
693 slave_state = Running;
696 nframes_t frame_delta = slave_transport_frame - _transport_frame;
698 boost::shared_ptr<DiskstreamList> dsl = diskstreams.reader();
700 for (DiskstreamList::iterator i = dsl->begin(); i != dsl->end(); ++i) {
701 if (!(*i)->can_internal_playback_seek (frame_delta)) {
708 for (DiskstreamList::iterator i = dsl->begin(); i != dsl->end(); ++i) {
709 (*i)->internal_playback_seek (frame_delta);
711 _transport_frame += frame_delta;
714 cerr << "cannot micro-seek\n";
718 memset (delta_accumulator, 0, sizeof (long) * delta_accumulator_size);
719 average_slave_delta = 0L;
724 if (slave_state == Running && _transport_speed == 0.0f) {
725 DEBUG_TRACE (DEBUG::Slave, "slave starts transport\n");
729 } else { // slave_speed is 0
731 /* slave has stopped */
733 if (_transport_speed != 0.0f) {
734 DEBUG_TRACE (DEBUG::Slave, string_compose ("slave stops transport: %1 frame %2 tf %3\n", slave_speed, slave_transport_frame, _transport_frame));
738 if (slave_transport_frame != _transport_frame) {
739 DEBUG_TRACE (DEBUG::Slave, string_compose ("slave stopped, move to %1\n", slave_transport_frame));
740 force_locate (slave_transport_frame, false);
743 slave_state = Stopped;
748 Session::follow_slave_silently (nframes_t nframes, float slave_speed)
750 if (slave_speed && _transport_speed) {
752 /* something isn't right, but we should move with the master
758 prepare_diskstreams ();
759 silent_process_routes (nframes);
760 commit_diskstreams (nframes, need_butler);
766 int32_t frames_moved = (int32_t) floor (_transport_speed * nframes);
768 if (frames_moved < 0) {
769 decrement_transport_position (-frames_moved);
771 increment_transport_position (frames_moved);
774 nframes_t stop_limit;
776 if (actively_recording()) {
777 stop_limit = max_frames;
779 if (Config->get_stop_at_session_end()) {
780 stop_limit = current_end_frame();
782 stop_limit = max_frames;
786 maybe_stop (stop_limit);
791 Session::process_without_events (nframes_t nframes)
793 bool session_needs_butler = false;
794 nframes_t stop_limit;
797 if (!process_can_proceed()) {
802 if (!_exporting && _slave) {
803 if (!follow_slave (nframes)) {
808 if (_transport_speed == 0) {
814 send_midi_time_code_for_cycle (nframes);
817 if (actively_recording()) {
818 stop_limit = max_frames;
820 if (Config->get_stop_at_session_end()) {
821 stop_limit = current_end_frame();
823 stop_limit = max_frames;
827 if (maybe_stop (stop_limit)) {
832 if (maybe_sync_start (nframes)) {
836 click (_transport_frame, nframes);
838 prepare_diskstreams ();
840 if (_transport_speed == 1.0) {
841 frames_moved = (long) nframes;
843 interpolation.set_target_speed (fabs(_target_transport_speed));
844 interpolation.set_speed (fabs(_transport_speed));
845 frames_moved = (long) interpolation.interpolate (0, nframes, 0, 0);
848 if (process_routes (nframes)) {
853 commit_diskstreams (nframes, session_needs_butler);
855 if (frames_moved < 0) {
856 decrement_transport_position (-frames_moved);
858 increment_transport_position (frames_moved);
861 maybe_stop (stop_limit);
862 check_declick_out ();
864 if (session_needs_butler) {
869 /** Process callback used when the auditioner is active.
870 * @param nframes number of frames to process.
873 Session::process_audition (nframes_t nframes)
876 boost::shared_ptr<RouteList> r = routes.reader ();
878 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
879 if (!(*i)->is_hidden()) {
880 (*i)->silence (nframes);
884 /* run the auditioner, and if it says we need butler service, ask for it */
886 if (auditioner->play_audition (nframes) > 0) {
890 /* handle pending events */
892 while (pending_events.read (&ev, 1) == 1) {
896 /* if we are not in the middle of a state change,
897 and there are immediate events queued up,
901 while (!non_realtime_work_pending() && !immediate_events.empty()) {
902 Event *ev = immediate_events.front ();
903 immediate_events.pop_front ();
907 if (!auditioner->active()) {
908 /* auditioner no longer active, so go back to the normal process callback */
909 process_function = &Session::process_with_events;
914 Session::maybe_sync_start (nframes_t& nframes)
916 nframes_t sync_offset;
918 if (!waiting_for_sync_offset) {
922 if (_engine.get_sync_offset (sync_offset) && sync_offset < nframes) {
924 /* generate silence up to the sync point, then
925 adjust nframes + offset to reflect whatever
929 no_roll (sync_offset);
930 nframes -= sync_offset;
931 Port::increment_port_offset (sync_offset);
932 waiting_for_sync_offset = false;
935 return true; // done, nothing left to process
940 /* sync offset point is not within this process()
941 cycle, so just generate silence. and don't bother
942 with any fancy stuff here, just the minimal silence.
947 if (Config->get_locate_while_waiting_for_sync()) {
948 if (micro_locate (nframes)) {
949 /* XXX ERROR !!! XXX */
953 return true; // done, nothing left to process