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/session.h"
31 #include "ardour/timestamps.h"
32 #include "ardour/audio_diskstream.h"
33 #include "ardour/audioengine.h"
34 #include "ardour/slave.h"
35 #include "ardour/auditioner.h"
36 #include "ardour/cycles.h"
37 #include "ardour/cycle_timer.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 (non_realtime_work_pending()) {
62 if (!transport_work_requested ()) {
67 (this->*process_function) (nframes);
69 // the ticker is for sending time information like MidiClock
70 nframes_t transport_frames = transport_frame();
71 BBT_Time transport_bbt;
72 bbt_time(transport_frames, transport_bbt);
73 SMPTE::Time transport_smpte;
74 smpte_time(transport_frames, transport_smpte);
75 tick (transport_frames, transport_bbt, transport_smpte); /* EMIT SIGNAL */
77 SendFeedback (); /* EMIT SIGNAL */
79 MIDI::Manager::instance()->cycle_end();
83 Session::prepare_diskstreams ()
85 boost::shared_ptr<DiskstreamList> dsl = diskstreams.reader();
86 for (DiskstreamList::iterator i = dsl->begin(); i != dsl->end(); ++i) {
92 Session::no_roll (nframes_t nframes, nframes_t offset)
94 nframes_t end_frame = _transport_frame + nframes; // FIXME: varispeed + no_roll ??
96 bool declick = get_transport_declick_required();
97 boost::shared_ptr<RouteList> r = routes.reader ();
100 _click_io->silence (nframes, offset);
103 if (g_atomic_int_get (&processing_prohibited)) {
104 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
105 (*i)->silence (nframes, offset);
110 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
112 if ((*i)->is_hidden()) {
116 (*i)->set_pending_declick (declick);
118 if ((*i)->no_roll (nframes, _transport_frame, end_frame, offset, non_realtime_work_pending(),
119 actively_recording(), declick)) {
120 error << string_compose(_("Session: error in no roll for %1"), (*i)->name()) << endmsg;
130 Session::process_routes (nframes_t nframes, nframes_t offset)
133 int declick = get_transport_declick_required();
134 bool rec_monitors = get_rec_monitors_input();
135 boost::shared_ptr<RouteList> r = routes.reader ();
137 if (transport_sub_state & StopPendingCapture) {
138 /* force a declick out */
142 record_active = actively_recording(); // || (get_record_enabled() && get_punch_in());
144 const nframes_t start_frame = _transport_frame;
145 const nframes_t end_frame = _transport_frame + (nframes_t)floor(nframes * _transport_speed);
147 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
151 if ((*i)->is_hidden()) {
155 (*i)->set_pending_declick (declick);
157 if ((ret = (*i)->roll (nframes, start_frame, end_frame, offset, declick, record_active, rec_monitors)) < 0) {
159 /* we have to do this here. Route::roll() for an AudioTrack will have called AudioDiskstream::process(),
160 and the DS will expect AudioDiskstream::commit() to be called. but we're aborting from that
161 call path, so make sure we release any outstanding locks here before we return failure.
164 boost::shared_ptr<DiskstreamList> dsl = diskstreams.reader();
165 for (DiskstreamList::iterator ids = dsl->begin(); ids != dsl->end(); ++ids) {
178 Session::silent_process_routes (nframes_t nframes, nframes_t offset)
180 bool record_active = actively_recording();
181 int declick = get_transport_declick_required();
182 bool rec_monitors = get_rec_monitors_input();
183 boost::shared_ptr<RouteList> r = routes.reader ();
185 if (transport_sub_state & StopPendingCapture) {
186 /* force a declick out */
190 const nframes_t start_frame = _transport_frame;
191 const nframes_t end_frame = _transport_frame + lrintf(nframes * _transport_speed);
193 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
197 if ((*i)->is_hidden()) {
201 if ((ret = (*i)->silent_roll (nframes, start_frame, end_frame, offset, record_active, rec_monitors)) < 0) {
203 /* we have to do this here. Route::roll() for an AudioTrack will have called AudioDiskstream::process(),
204 and the DS will expect AudioDiskstream::commit() to be called. but we're aborting from that
205 call path, so make sure we release any outstanding locks here before we return failure.
208 boost::shared_ptr<DiskstreamList> dsl = diskstreams.reader();
209 for (DiskstreamList::iterator ids = dsl->begin(); ids != dsl->end(); ++ids) {
222 Session::commit_diskstreams (nframes_t nframes, bool &needs_butler)
228 boost::shared_ptr<DiskstreamList> dsl = diskstreams.reader();
229 for (DiskstreamList::iterator i = dsl->begin(); i != dsl->end(); ++i) {
231 if ((*i)->hidden()) {
235 /* force all diskstreams not handled by a Route to call do their stuff.
236 Note: the diskstreams that were handled by a route will just return zero
237 from this call, because they know they were processed. So in fact, this
238 also runs commit() for every diskstream.
241 if ((dret = (*i)->process (_transport_frame, nframes, 0, actively_recording(), get_rec_monitors_input())) == 0) {
242 if ((*i)->commit (nframes)) {
246 } else if (dret < 0) {
250 pworst = min (pworst, (*i)->playback_buffer_load());
251 cworst = min (cworst, (*i)->capture_buffer_load());
254 uint32_t pmin = g_atomic_int_get (&_playback_load);
255 uint32_t pminold = g_atomic_int_get (&_playback_load_min);
256 uint32_t cmin = g_atomic_int_get (&_capture_load);
257 uint32_t cminold = g_atomic_int_get (&_capture_load_min);
259 g_atomic_int_set (&_playback_load, (uint32_t) floor (pworst * 100.0f));
260 g_atomic_int_set (&_capture_load, (uint32_t) floor (cworst * 100.0f));
261 g_atomic_int_set (&_playback_load_min, min (pmin, pminold));
262 g_atomic_int_set (&_capture_load_min, min (cmin, cminold));
264 if (actively_recording()) {
269 /** Process callback used when the auditioner is not active */
271 Session::process_with_events (nframes_t nframes)
274 nframes_t this_nframes;
277 bool session_needs_butler = false;
278 nframes_t stop_limit;
281 /* make sure the auditioner is silent */
284 auditioner->silence (nframes, 0);
287 /* handle any pending events */
289 while (pending_events.read (&ev, 1) == 1) {
293 /* if we are not in the middle of a state change,
294 and there are immediate events queued up,
298 while (!non_realtime_work_pending() && !immediate_events.empty()) {
299 Event *ev = immediate_events.front ();
300 immediate_events.pop_front ();
304 /* Events caused a transport change, send an MTC Full Frame (SMPTE) message.
305 * This is sent whether rolling or not, to give slaves an idea of ardour time
306 * on locates (and allow slow slaves to position and prepare for rolling)
308 if (_send_smpte_update) {
309 send_full_time_code(nframes);
312 if (!process_can_proceed()) {
317 if (events.empty() || next_event == events.end()) {
318 process_without_events (nframes);
322 /// TODO: Figure out what happens to phi and phase, if transport speed momentarily becomes
323 /// 1.0 eg. during the adjustments of a slave. If that is a bug, then AudioDiskstream::process
324 /// is very likely broken too
325 if (_transport_speed == 1.0) {
326 frames_moved = (long) nframes;
328 frames_moved = (long) AudioDiskstream::
329 calculate_varispeed_playback_distance(nframes, phase, phi, target_phi);
332 end_frame = _transport_frame + (nframes_t)frames_moved;
336 Events::iterator the_next_one;
338 if (!process_can_proceed()) {
343 if (!_exporting && _slave) {
344 if (!follow_slave (nframes, 0)) {
349 if (_transport_speed == 0) {
350 no_roll (nframes, 0);
355 send_midi_time_code_for_cycle (nframes);
358 if (actively_recording()) {
359 stop_limit = max_frames;
362 if (Config->get_stop_at_session_end()) {
363 stop_limit = current_end_frame();
365 stop_limit = max_frames;
369 if (maybe_stop (stop_limit)) {
370 no_roll (nframes, 0);
374 this_event = *next_event;
375 the_next_one = next_event;
380 /* yes folks, here it is, the actual loop where we really truly
381 process some audio */
384 this_nframes = nframes; /* real (jack) time relative */
386 /* running an event, position transport precisely to its time */
387 if (this_event && this_event->action_frame <= end_frame && this_event->action_frame >= _transport_frame) {
388 /* this isn't quite right for reverse play */
389 frames_moved = (long) (this_event->action_frame - _transport_frame);
390 this_nframes = (nframes_t) abs( floor(frames_moved / _transport_speed) );
395 click (_transport_frame, nframes, offset);
397 /* now process frames between now and the first event in this block */
398 prepare_diskstreams ();
400 if (process_routes (this_nframes, offset)) {
401 no_roll (nframes, 0);
405 commit_diskstreams (this_nframes, session_needs_butler);
407 nframes -= this_nframes;
408 offset += this_nframes;
410 if (frames_moved < 0) {
411 decrement_transport_position (-frames_moved);
413 increment_transport_position (frames_moved);
416 maybe_stop (stop_limit);
417 check_declick_out ();
420 /* now handle this event and all others scheduled for the same time */
422 while (this_event && this_event->action_frame == _transport_frame) {
423 process_event (this_event);
425 if (the_next_one == events.end()) {
428 this_event = *the_next_one;
433 /* if an event left our state changing, do the right thing */
435 if (non_realtime_work_pending()) {
436 no_roll (nframes, offset);
440 /* this is necessary to handle the case of seamless looping */
441 end_frame = _transport_frame + (nframes_t) floor (nframes * _transport_speed);
447 } /* implicit release of route lock */
449 if (session_needs_butler)
454 Session::reset_slave_state ()
456 average_slave_delta = 1800;
457 delta_accumulator_cnt = 0;
458 have_first_delta_accumulator = false;
459 slave_state = Stopped;
463 Session::transport_locked () const
467 if (!locate_pending() && ((Config->get_slave_source() == None) || (sl && sl->ok() && sl->locked()))) {
475 Session::follow_slave (nframes_t nframes, nframes_t offset)
478 nframes_t slave_transport_frame;
479 nframes_t this_delta;
485 Config->set_slave_source (None);
489 _slave->speed_and_position (slave_speed, slave_transport_frame);
491 if (!_slave->locked()) {
495 if (slave_transport_frame > _transport_frame) {
496 this_delta = slave_transport_frame - _transport_frame;
499 this_delta = _transport_frame - slave_transport_frame;
503 if ((starting = _slave->starting())) {
507 if (_slave->is_always_synced() || Config->get_timecode_source_is_synced()) {
509 /* if the TC source is synced, then we assume that its
510 speed is binary: 0.0 or 1.0
513 if (slave_speed != 0.0f) {
519 /* TC source is able to drift relative to us (slave)
520 so we need to keep track of the drift and adjust
521 our speed to remain locked.
524 calculate_moving_average_of_slave_delta(dir, this_delta);
527 track_slave_state(slave_speed, slave_transport_frame, this_delta, starting);
529 if (slave_state == Running && !_slave->is_always_synced() && !Config->get_timecode_source_is_synced()) {
531 if (_transport_speed != 0.0f) {
534 note that average_dir is +1 or -1
539 #ifdef USE_MOVING_AVERAGE_OF_SLAVE
540 if (average_slave_delta == 0) {
544 delta = average_slave_delta;
545 delta *= average_dir;
552 float adjusted_speed = slave_speed + (delta / float(_current_frame_rate));
554 if (_slave->give_slave_full_control_over_transport_speed()) {
555 request_transport_speed(slave_speed);
557 request_transport_speed(adjusted_speed);
559 cerr << "adjust using " << delta
560 << " towards " << adjusted_speed
561 << " ratio = " << adjusted_speed / slave_speed
562 << " current = " << _transport_speed
563 << " slave @ " << slave_speed
568 if (abs(average_slave_delta) > (long) _slave->resolution()) {
569 cerr << "average slave delta greater than slave resolution, going to silent motion\n";
576 if (slave_speed != 0.0)
577 cerr << "delta = " << (int) (dir * this_delta)
578 << " speed = " << slave_speed
579 << " ts = " << _transport_speed
580 << " M@ "<< slave_transport_frame << " S@ " << _transport_frame
581 << " avgdelta = " << average_slave_delta
585 if (!starting && !non_realtime_work_pending()) {
586 /* speed is set, we're locked, and good to go */
592 cerr << "reached silent_motion:" <<endl;
595 follow_slave_silently(nframes, offset, slave_speed);
598 /* don't move at all */
600 cerr << "reached no_roll:" <<endl;
602 no_roll (nframes, 0);
607 Session::calculate_moving_average_of_slave_delta(int dir, nframes_t this_delta)
609 if (delta_accumulator_cnt >= delta_accumulator_size) {
610 have_first_delta_accumulator = true;
611 delta_accumulator_cnt = 0;
614 if (delta_accumulator_cnt != 0 || this_delta < _current_frame_rate) {
615 delta_accumulator[delta_accumulator_cnt++] = long(dir) * long(this_delta);
618 if (have_first_delta_accumulator) {
619 average_slave_delta = 0L;
620 for (int i = 0; i < delta_accumulator_size; ++i) {
621 average_slave_delta += delta_accumulator[i];
623 average_slave_delta /= long(delta_accumulator_size);
624 if (average_slave_delta < 0L) {
626 average_slave_delta = abs(average_slave_delta);
634 Session::track_slave_state(
636 nframes_t slave_transport_frame,
637 nframes_t this_delta,
640 if (slave_speed != 0.0f) {
642 /* slave is running */
644 switch (slave_state) {
646 if (_slave->requires_seekahead()) {
647 slave_wait_end = slave_transport_frame + _current_frame_rate;
648 locate (slave_wait_end, false, false);
649 slave_state = Waiting;
654 slave_state = Running;
656 Location* al = _locations.auto_loop_location();
658 if (al && play_loop && (slave_transport_frame < al->start() || slave_transport_frame > al->end())) {
660 request_play_loop(false);
663 if (slave_transport_frame != _transport_frame) {
664 locate (slave_transport_frame, false, false);
677 if (slave_state == Waiting) {
680 cerr << "waiting at " << slave_transport_frame << endl;
682 if (slave_transport_frame >= slave_wait_end) {
684 cerr << "\tstart at " << _transport_frame << endl;
686 slave_state = Running;
689 nframes_t frame_delta = slave_transport_frame - _transport_frame;
691 boost::shared_ptr<DiskstreamList> dsl = diskstreams.reader();
693 for (DiskstreamList::iterator i = dsl->begin(); i != dsl->end(); ++i) {
694 if (!(*i)->can_internal_playback_seek (frame_delta)) {
701 for (DiskstreamList::iterator i = dsl->begin(); i != dsl->end(); ++i) {
702 (*i)->internal_playback_seek (frame_delta);
704 _transport_frame += frame_delta;
707 cerr << "cannot micro-seek\n";
711 memset (delta_accumulator, 0, sizeof (long) * delta_accumulator_size);
712 average_slave_delta = 0L;
717 if (slave_state == Running && _transport_speed == 0.0f) {
720 cerr << "slave starts transport\n";
725 } else { // slave_speed is 0
727 /* slave has stopped */
729 if (_transport_speed != 0.0f) {
732 cerr << "slave stops transport: " << slave_speed << " frame: " << slave_transport_frame
733 << " tf = " << _transport_frame << endl;
739 if (slave_transport_frame != _transport_frame) {
741 cerr << "slave stopped, move to " << slave_transport_frame << endl;
743 force_locate (slave_transport_frame, false);
746 slave_state = Stopped;
751 Session::follow_slave_silently(nframes_t nframes, nframes_t offset, float slave_speed)
753 if (slave_speed && _transport_speed) {
755 /* something isn't right, but we should move with the master
761 prepare_diskstreams ();
762 silent_process_routes (nframes, offset);
763 commit_diskstreams (nframes, need_butler);
769 int32_t frames_moved = (int32_t) floor (_transport_speed * nframes);
771 if (frames_moved < 0) {
772 decrement_transport_position (-frames_moved);
774 increment_transport_position (frames_moved);
777 nframes_t stop_limit;
779 if (actively_recording()) {
780 stop_limit = max_frames;
782 if (Config->get_stop_at_session_end()) {
783 stop_limit = current_end_frame();
785 stop_limit = max_frames;
789 maybe_stop (stop_limit);
794 Session::process_without_events (nframes_t nframes)
796 bool session_needs_butler = false;
797 nframes_t stop_limit;
799 nframes_t offset = 0;
801 if (!process_can_proceed()) {
806 if (!_exporting && _slave) {
807 if (!follow_slave (nframes, 0)) {
812 if (_transport_speed == 0) {
813 no_roll (nframes, 0);
818 send_midi_time_code_for_cycle (nframes);
821 if (actively_recording()) {
822 stop_limit = max_frames;
824 if (Config->get_stop_at_session_end()) {
825 stop_limit = current_end_frame();
827 stop_limit = max_frames;
831 if (maybe_stop (stop_limit)) {
832 no_roll (nframes, 0);
836 if (maybe_sync_start (nframes, offset)) {
840 click (_transport_frame, nframes, offset);
842 prepare_diskstreams ();
844 /// TODO: Figure out what happens to phi and phase, if transport speed momentarily becomes
845 /// 1.0 eg. during the adjustments of a slave. If that is a bug, then AudioDiskstream::process
846 /// is very likely broken too
847 if (_transport_speed == 1.0) {
848 frames_moved = (long) nframes;
850 frames_moved = (long) AudioDiskstream::
851 calculate_varispeed_playback_distance(nframes, phase, phi, target_phi);
854 if (process_routes (nframes, offset)) {
855 no_roll (nframes, offset);
859 commit_diskstreams (nframes, session_needs_butler);
861 if (frames_moved < 0) {
862 decrement_transport_position (-frames_moved);
864 increment_transport_position (frames_moved);
867 maybe_stop (stop_limit);
868 check_declick_out ();
870 if (session_needs_butler)
874 /** Process callback used when the auditioner is active.
875 * @param nframes number of frames to process.
878 Session::process_audition (nframes_t nframes)
881 boost::shared_ptr<RouteList> r = routes.reader ();
883 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
884 if (!(*i)->is_hidden()) {
885 (*i)->silence (nframes, 0);
889 /* run the auditioner, and if it says we need butler service, ask for it */
891 if (auditioner->play_audition (nframes) > 0) {
895 /* handle pending events */
897 while (pending_events.read (&ev, 1) == 1) {
901 /* if we are not in the middle of a state change,
902 and there are immediate events queued up,
906 while (!non_realtime_work_pending() && !immediate_events.empty()) {
907 Event *ev = immediate_events.front ();
908 immediate_events.pop_front ();
912 if (!auditioner->active()) {
913 /* auditioner no longer active, so go back to the normal process callback */
914 process_function = &Session::process_with_events;
919 Session::maybe_sync_start (nframes_t& nframes, nframes_t& offset)
921 nframes_t sync_offset;
923 if (!waiting_for_sync_offset) {
927 if (_engine.get_sync_offset (sync_offset) && sync_offset < nframes) {
929 /* generate silence up to the sync point, then
930 adjust nframes + offset to reflect whatever
934 no_roll (sync_offset, 0);
935 nframes -= sync_offset;
936 offset += sync_offset;
937 waiting_for_sync_offset = false;
940 return true; // done, nothing left to process
945 /* sync offset point is not within this process()
946 cycle, so just generate silence. and don't bother
947 with any fancy stuff here, just the minimal silence.
950 g_atomic_int_inc (&processing_prohibited);
951 no_roll (nframes, 0);
952 g_atomic_int_dec_and_test (&processing_prohibited);
954 if (Config->get_locate_while_waiting_for_sync()) {
955 if (micro_locate (nframes)) {
956 /* XXX ERROR !!! XXX */
960 return true; // done, nothing left to process