Declick before the end of seamless loops, not after the end, so that loops are render...
[ardour.git] / libs / ardour / session_process.cc
index 662da4db9114be5c5edc55f9cefc4cea051961fd..3936423b141a98e46ffc0cb09504e5bbe0bfd894 100644 (file)
 
 #include <glibmm/thread.h>
 
-#include "ardour/ardour.h"
 #include "ardour/audioengine.h"
 #include "ardour/auditioner.h"
 #include "ardour/butler.h"
+#include "ardour/cycle_timer.h"
 #include "ardour/debug.h"
+#include "ardour/graph.h"
+#include "ardour/port.h"
 #include "ardour/process_thread.h"
 #include "ardour/session.h"
 #include "ardour/slave.h"
-#include "ardour/timestamps.h"
-#include "ardour/graph.h"
-#include "ardour/audio_port.h"
+#include "ardour/ticker.h"
+#include "ardour/types.h"
 
 #include "midi++/manager.h"
 #include "midi++/mmc.h"
 
 #include "i18n.h"
 
+#include <xmmintrin.h>
+
 using namespace ARDOUR;
 using namespace PBD;
 using namespace std;
@@ -51,10 +54,11 @@ using namespace std;
 /** Called by the audio engine when there is work to be done with JACK.
  * @param nframes Number of frames to process.
  */
+
 void
 Session::process (pframes_t nframes)
 {
-       MIDI::Manager::instance()->cycle_start(nframes);
+       framepos_t transport_at_start = _transport_frame;
 
        _silent = false;
 
@@ -75,17 +79,21 @@ Session::process (pframes_t nframes)
 
        _engine.main_thread()->drop_buffers ();
 
-       // the ticker is for sending time information like MidiClock
-       framepos_t transport_frames = transport_frame();
-       Timecode::BBT_Time transport_bbt;
-       bbt_time(transport_frames, transport_bbt);
-       Timecode::Time transport_timecode;
-       timecode_time(transport_frames, transport_timecode);
-       tick (transport_frames, transport_bbt, transport_timecode); /* EMIT SIGNAL */
+       /* deliver MIDI clock. Note that we need to use the transport frame
+        * position at the start of process(), not the value at the end of
+        * it. We may already have ticked() because of a transport state
+        * change, for example.
+        */
 
-       SendFeedback (); /* EMIT SIGNAL */
+       try {
+               if (!_engine.freewheeling() && Config->get_send_midi_clock() && transport_speed() == 1.0f && midi_clock->has_midi_port()) {
+                       midi_clock->tick (transport_at_start);
+               }
+       } catch (...) {
+               /* don't bother with a message */
+       }
 
-       MIDI::Manager::instance()->cycle_end();
+       SendFeedback (); /* EMIT SIGNAL */
 }
 
 int
@@ -97,44 +105,50 @@ Session::fail_roll (pframes_t nframes)
 int
 Session::no_roll (pframes_t nframes)
 {
+       PT_TIMING_CHECK (4);
+       
        framepos_t end_frame = _transport_frame + nframes; // FIXME: varispeed + no_roll ??
        int ret = 0;
-       bool declick = get_transport_declick_required();
+       int declick = get_transport_declick_required();
        boost::shared_ptr<RouteList> r = routes.reader ();
 
        if (_click_io) {
                _click_io->silence (nframes);
        }
 
-       DEBUG_TRACE(DEBUG::Graph,"calling graph/no-roll\n");
-       route_graph->routes_no_roll( nframes, _transport_frame, end_frame, non_realtime_work_pending(), actively_recording(), declick);
-        /*
-       for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
+       if (_process_graph) {
+               DEBUG_TRACE(DEBUG::ProcessThreads,"calling graph/no-roll\n");
+               _process_graph->routes_no_roll( nframes, _transport_frame, end_frame, non_realtime_work_pending(), declick);
+       } else {
+               PT_TIMING_CHECK (10);
+               for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
 
-               if ((*i)->is_hidden()) {
-                       continue;
-               }
+                       if ((*i)->is_hidden()) {
+                               continue;
+                       }
 
-               (*i)->set_pending_declick (declick);
+                       (*i)->set_pending_declick (declick);
 
-               if ((*i)->no_roll (nframes, _transport_frame, end_frame, non_realtime_work_pending(),
-                                  actively_recording(), declick)) {
-                       error << string_compose(_("Session: error in no roll for %1"), (*i)->name()) << endmsg;
-                       ret = -1;
-                       break;
+                       if ((*i)->no_roll (nframes, _transport_frame, end_frame, non_realtime_work_pending())) {
+                               error << string_compose(_("Session: error in no roll for %1"), (*i)->name()) << endmsg;
+                               ret = -1;
+                               break;
+                       }
                }
+               PT_TIMING_CHECK (11);
        }
-        */
 
+       PT_TIMING_CHECK (5);
        return ret;
 }
 
+/** @param need_butler to be set to true by this method if it needs the butler,
+ *  otherwise it must be left alone.
+ */
 int
 Session::process_routes (pframes_t nframes, bool& need_butler)
 {
-       bool record_active;
        int  declick = get_transport_declick_required();
-       bool rec_monitors = get_rec_monitors_input();
        boost::shared_ptr<RouteList> r = routes.reader ();
 
        if (transport_sub_state & StopPendingCapture) {
@@ -142,65 +156,75 @@ Session::process_routes (pframes_t nframes, bool& need_butler)
                declick = -1;
        }
 
-       record_active = actively_recording(); // || (get_record_enabled() && get_punch_in());
-
        const framepos_t start_frame = _transport_frame;
        const framepos_t end_frame = _transport_frame + floor (nframes * _transport_speed);
 
-       DEBUG_TRACE(DEBUG::Graph,"calling graph/process-routes\n");
-       route_graph->process_routes( nframes, start_frame, end_frame, declick, record_active, rec_monitors, need_butler);
-/*
-       for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
+       if (_process_graph) {
+               DEBUG_TRACE(DEBUG::ProcessThreads,"calling graph/process-routes\n");
+               _process_graph->process_routes (nframes, start_frame, end_frame, declick, need_butler);
+       } else {
 
-               int ret;
+               for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
 
-               if ((*i)->is_hidden()) {
-                       continue;
-               }
+                       int ret;
+
+                       if ((*i)->is_hidden()) {
+                               continue;
+                       }
 
-               (*i)->set_pending_declick (declick);
+                       (*i)->set_pending_declick (declick);
 
-               if ((ret = (*i)->roll (nframes, start_frame, end_frame, declick, record_active, rec_monitors, need_butler)) < 0) {
-                       stop_transport ();
-                       return -1;
+                       bool b = false;
+
+                       if ((ret = (*i)->roll (nframes, start_frame, end_frame, declick, b)) < 0) {
+                               stop_transport ();
+                               return -1;
+                       }
+
+                       if (b) {
+                               need_butler = true;
+                       }
                }
        }
-*/
+
        return 0;
 }
 
+/** @param need_butler to be set to true by this method if it needs the butler,
+ *  otherwise it must be left alone.
+ */
 int
 Session::silent_process_routes (pframes_t nframes, bool& need_butler)
 {
-       bool record_active = actively_recording();
-       int  declick = get_transport_declick_required();
-       bool rec_monitors = get_rec_monitors_input();
        boost::shared_ptr<RouteList> r = routes.reader ();
 
-       if (transport_sub_state & StopPendingCapture) {
-               /* force a declick out */
-               declick = -1;
-       }
-
        const framepos_t start_frame = _transport_frame;
        const framepos_t end_frame = _transport_frame + lrintf(nframes * _transport_speed);
 
-       route_graph->silent_process_routes( nframes, start_frame, end_frame, record_active, rec_monitors, need_butler);
-/*
-       for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
+       if (_process_graph) {
+               _process_graph->silent_process_routes (nframes, start_frame, end_frame, need_butler);
+       } else {
+               for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
 
-               int ret;
+                       int ret;
 
-               if ((*i)->is_hidden()) {
-                       continue;
-               }
+                       if ((*i)->is_hidden()) {
+                               continue;
+                       }
 
-               if ((ret = (*i)->silent_roll (nframes, start_frame, end_frame, record_active, rec_monitors, need_butler)) < 0) {
-                       stop_transport ();
-                       return -1;
+                       bool b = false;
+
+                       if ((ret = (*i)->silent_roll (nframes, start_frame, end_frame, b)) < 0) {
+                               stop_transport ();
+                               return -1;
+                       }
+
+                       if (b) {
+                               need_butler = true;
+                       }
                }
        }
-*/
+
        return 0;
 }
 
@@ -235,11 +259,12 @@ Session::get_track_statistics ()
 void
 Session::process_with_events (pframes_t nframes)
 {
+       PT_TIMING_CHECK (3);
+       
        SessionEvent*  ev;
        pframes_t      this_nframes;
        framepos_t     end_frame;
        bool           session_needs_butler = false;
-       framepos_t     stop_limit;
        framecnt_t     frames_moved;
 
        /* make sure the auditioner is silent */
@@ -265,9 +290,39 @@ Session::process_with_events (pframes_t nframes)
                process_event (ev);
        }
 
-       /* Events caused a transport change, send an MTC Full Frame (Timecode) message.
-        * This is sent whether rolling or not, to give slaves an idea of ardour time
-        * on locates (and allow slow slaves to position and prepare for rolling)
+       /* Decide on what to do with quarter-frame MTC during this cycle */
+
+       bool const was_sending_qf_mtc = _send_qf_mtc;
+       double const tolerance = Config->get_mtc_qf_speed_tolerance() / 100.0;
+
+       if (_transport_speed != 0) {
+               _send_qf_mtc = (
+                       Config->get_send_mtc () &&
+                       _transport_speed >= (1 - tolerance) &&
+                       _transport_speed <= (1 + tolerance)
+                       );
+
+               if (_send_qf_mtc && !was_sending_qf_mtc) {
+                       /* we will re-start quarter-frame MTC this cycle, so send a full update to set things up */
+                       _send_timecode_update = true;
+               }
+
+               if (Config->get_send_mtc() && !_send_qf_mtc && _pframes_since_last_mtc > (frame_rate () / 4)) {
+                       /* we're sending MTC, but we're not sending QF MTC at the moment, and it's been
+                          a quarter of a second since we sent anything at all, so send a full MTC update
+                          this cycle.
+                       */
+                       _send_timecode_update = true;
+               }
+
+               _pframes_since_last_mtc += nframes;
+       }
+
+       /* Events caused a transport change (or we re-started sending
+        * MTC), so send an MTC Full Frame (Timecode) message.  This
+        * is sent whether rolling or not, to give slaves an idea of
+        * ardour time on locates (and allow slow slaves to position
+        * and prepare for rolling)
         */
        if (_send_timecode_update) {
                send_full_time_code (_transport_frame);
@@ -314,19 +369,10 @@ Session::process_with_events (pframes_t nframes)
                }
 
                if (!_exporting && !timecode_transmission_suspended()) {
-                       send_midi_time_code_for_cycle (nframes);
+                       send_midi_time_code_for_cycle (_transport_frame, end_frame, nframes);
                }
 
-               if (actively_recording()) {
-                       stop_limit = max_framepos;
-               } else {
-
-                       if (Config->get_stop_at_session_end()) {
-                               stop_limit = current_end_frame();
-                       } else {
-                               stop_limit = max_framepos;
-                       }
-               }
+               framepos_t stop_limit = compute_stop_limit ();
 
                if (maybe_stop (stop_limit)) {
                        no_roll (nframes);
@@ -400,7 +446,6 @@ Session::process_with_events (pframes_t nframes)
 
                        /* this is necessary to handle the case of seamless looping */
                        end_frame = _transport_frame + floor (nframes * _transport_speed);
-
                }
 
                set_next_event ();
@@ -494,7 +539,7 @@ Session::follow_slave (pframes_t nframes)
 
        DEBUG_TRACE (DEBUG::Slave, string_compose ("slave state %1 @ %2 speed %3 cur delta %4 avg delta %5\n",
                                                   _slave_state, slave_transport_frame, slave_speed, this_delta, average_slave_delta));
-                    
+
 
        if (_slave_state == Running && !_slave->is_always_synced() && !config.get_timecode_source_is_synced()) {
 
@@ -521,11 +566,11 @@ Session::follow_slave (pframes_t nframes)
                                                                           slave_speed,
                                                                           _transport_speed,
                                                                           _transport_frame,
-                                                                          slave_transport_frame, 
+                                                                          slave_transport_frame,
                                                                           average_slave_delta));
                        }
 #endif
-                       
+
                        if (_slave->give_slave_full_control_over_transport_speed()) {
                                set_transport_speed (slave_speed, false, false);
                                //std::cout << "set speed = " << slave_speed << "\n";
@@ -536,7 +581,7 @@ Session::follow_slave (pframes_t nframes)
                                                                           delta, adjusted_speed, adjusted_speed/slave_speed, _transport_speed,
                                                                           slave_speed));
                        }
-                       
+
 #if 1
                        if ((framecnt_t) abs(average_slave_delta) > _slave->resolution()) {
                                cerr << "average slave delta greater than slave resolution (" << _slave->resolution() << "), going to silent motion\n";
@@ -591,7 +636,7 @@ Session::calculate_moving_average_of_slave_delta (int dir, framecnt_t this_delta
 }
 
 void
-Session::track_slave_state (float slave_speed, framepos_t slave_transport_frame, framecnt_t this_delta)
+Session::track_slave_state (float slave_speed, framepos_t slave_transport_frame, framecnt_t /*this_delta*/)
 {
        if (slave_speed != 0.0f) {
 
@@ -671,7 +716,6 @@ Session::track_slave_state (float slave_speed, framepos_t slave_transport_frame,
 
                                memset (delta_accumulator, 0, sizeof (int32_t) * delta_accumulator_size);
                                average_slave_delta = 0L;
-                               this_delta = 0;
                        }
                }
 
@@ -686,7 +730,7 @@ Session::track_slave_state (float slave_speed, framepos_t slave_transport_frame,
 
                if (_transport_speed != 0.0f) {
                        DEBUG_TRACE (DEBUG::Slave, string_compose ("slave stops transport: %1 frame %2 tf %3\n", slave_speed, slave_transport_frame, _transport_frame));
-                       stop_transport();
+                       stop_transport ();
                }
 
                if (slave_transport_frame != _transport_frame) {
@@ -724,19 +768,8 @@ Session::follow_slave_silently (pframes_t nframes, float slave_speed)
                } else {
                        increment_transport_position (frames_moved);
                }
-                
-               framepos_t stop_limit;
-
-               if (actively_recording()) {
-                       stop_limit = max_framepos;
-               } else {
-                       if (Config->get_stop_at_session_end()) {
-                               stop_limit = current_end_frame();
-                       } else {
-                               stop_limit = max_framepos;
-                       }
-               }
 
+               framepos_t const stop_limit = compute_stop_limit ();
                maybe_stop (stop_limit);
        }
 }
@@ -745,7 +778,6 @@ void
 Session::process_without_events (pframes_t nframes)
 {
        bool session_needs_butler = false;
-       framepos_t stop_limit;
        framecnt_t frames_moved;
 
        if (!process_can_proceed()) {
@@ -764,20 +796,20 @@ Session::process_without_events (pframes_t nframes)
                return;
        }
 
-       if (!_exporting && !timecode_transmission_suspended()) {
-               send_midi_time_code_for_cycle (nframes);
+       if (_transport_speed == 1.0) {
+               frames_moved = (framecnt_t) nframes;
+       } else {
+               interpolation.set_target_speed (fabs(_target_transport_speed));
+               interpolation.set_speed (fabs(_transport_speed));
+               frames_moved = (framecnt_t) interpolation.interpolate (0, nframes, 0, 0);
        }
 
-       if (actively_recording()) {
-               stop_limit = max_framepos;
-       } else {
-               if (Config->get_stop_at_session_end()) {
-                       stop_limit = current_end_frame();
-               } else {
-                       stop_limit = max_framepos;
-               }
+       if (!_exporting && !timecode_transmission_suspended()) {
+               send_midi_time_code_for_cycle (_transport_frame, _transport_frame + frames_moved, nframes);
        }
 
+       framepos_t const stop_limit = compute_stop_limit ();
+
        if (maybe_stop (stop_limit)) {
                fail_roll (nframes);
                return;
@@ -789,14 +821,6 @@ Session::process_without_events (pframes_t nframes)
 
        click (_transport_frame, nframes);
 
-       if (_transport_speed == 1.0) {
-               frames_moved = (framecnt_t) nframes;
-       } else {
-               interpolation.set_target_speed (fabs(_target_transport_speed));
-               interpolation.set_speed (fabs(_transport_speed));
-               frames_moved = (framecnt_t) interpolation.interpolate (0, nframes, 0, 0);
-       }
-
        if (process_routes (nframes, session_needs_butler)) {
                fail_roll (nframes);
                return;
@@ -804,6 +828,16 @@ Session::process_without_events (pframes_t nframes)
 
        get_track_statistics ();
 
+       /* XXX: I'm not sure whether this is correct, but at least it
+          matches process_with_events, so that this new frames_moved
+          is -ve when transport speed is -ve.  This means that the
+          transport position is updated correctly when we are in
+          reverse.  It seems a bit wrong that we're not using the
+          interpolator to compute this.
+       */
+
+       frames_moved = (framecnt_t) floor (_transport_speed * nframes);
+
        if (frames_moved < 0) {
                decrement_transport_position (-frames_moved);
        } else {
@@ -839,12 +873,12 @@ Session::process_audition (pframes_t nframes)
                _butler->summon ();
        }
 
-        /* if using a monitor section, run it because otherwise we don't hear anything */
+       /* if using a monitor section, run it because otherwise we don't hear anything */
+
+       if (auditioner->needs_monitor()) {
+               _monitor_out->passthru (_transport_frame, _transport_frame + nframes, nframes, false);
+       }
 
-        if (auditioner->needs_monitor()) {
-                _monitor_out->passthru (_transport_frame, _transport_frame + nframes, nframes, false);
-        }
-        
        /* handle pending events */
 
        while (pending_events.read (&ev, 1) == 1) {
@@ -886,7 +920,7 @@ Session::maybe_sync_start (pframes_t & nframes)
 
                no_roll (sync_offset);
                nframes -= sync_offset;
-               AudioPort::increment_port_offset (sync_offset);
+               Port::increment_global_port_buffer_offset (sync_offset);
                waiting_for_sync_offset = false;
 
                if (nframes == 0) {
@@ -987,6 +1021,17 @@ Session::process_event (SessionEvent* ev)
                del = false;
                break;
 
+       case SessionEvent::AutoLoopDeclick:
+               if (play_loop) {
+                       /* Request a declick fade-out and a fade-in; the fade-out will happen
+                          at the end of the loop, and the fade-in at the start.
+                       */
+                       transport_sub_state |= (PendingLoopDeclickOut | PendingLoopDeclickIn);
+               }
+               remove = false;
+               del = false;
+               break;
+
        case SessionEvent::Locate:
                if (ev->yes_or_no) {
                        // cerr << "forced locate to " << ev->target_frame << endl;
@@ -1093,13 +1138,13 @@ Session::process_event (SessionEvent* ev)
                del = false; // other side of RT request needs to clean up
                break;
 
-        case SessionEvent::AdjustPlaybackBuffering:
-                schedule_playback_buffering_adjustment ();
-                break;
+       case SessionEvent::AdjustPlaybackBuffering:
+               schedule_playback_buffering_adjustment ();
+               break;
 
-        case SessionEvent::AdjustCaptureBuffering:
-                schedule_capture_buffering_adjustment ();
-                break;
+       case SessionEvent::AdjustCaptureBuffering:
+               schedule_capture_buffering_adjustment ();
+               break;
 
        case SessionEvent::SetTimecodeTransmission:
                g_atomic_int_set (&_suspend_timecode_transmission, ev->yes_or_no ? 0 : 1);
@@ -1120,3 +1165,26 @@ Session::process_event (SessionEvent* ev)
        }
 }
 
+framepos_t
+Session::compute_stop_limit () const
+{
+       if (!Config->get_stop_at_session_end ()) {
+               return max_framepos;
+       }
+       
+       bool const punching_in = (config.get_punch_in () && _locations->auto_punch_location());
+       bool const punching_out = (config.get_punch_out () && _locations->auto_punch_location());
+
+       if (actively_recording ()) {
+               /* permanently recording */
+               return max_framepos;
+       } else if (punching_in && !punching_out) {
+               /* punching in but never out */
+               return max_framepos;
+       } else if (punching_in && punching_out && _locations->auto_punch_location()->end() > current_end_frame()) {
+               /* punching in and punching out after session end */
+               return max_framepos;
+       }
+
+       return current_end_frame ();
+}