fix crash when copy'ing latent plugins
[ardour.git] / libs / ardour / session_process.cc
index 80f922117da4e4bf29deec16f1afc9a155ef4be6..eaa1d055038cf48b610933f40b3ca48da356f29e 100644 (file)
 #include "pbd/error.h"
 #include "pbd/enumwriter.h"
 
-#include <glibmm/thread.h>
+#include <glibmm/threads.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/scene_changer.h"
 #include "ardour/session.h"
 #include "ardour/slave.h"
-#include "ardour/timestamps.h"
-#include "ardour/graph.h"
-#include "ardour/audio_port.h"
-#include "ardour/tempo.h"
-#include "ardour/cycle_timer.h"
+#include "ardour/ticker.h"
+#include "ardour/types.h"
 
-#include "midi++/manager.h"
 #include "midi++/mmc.h"
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 using namespace ARDOUR;
 using namespace PBD;
@@ -57,7 +56,7 @@ using namespace std;
 void
 Session::process (pframes_t nframes)
 {
-       MIDI::Manager::instance()->cycle_start(nframes);
+       framepos_t transport_at_start = _transport_frame;
 
        _silent = false;
 
@@ -76,23 +75,49 @@ Session::process (pframes_t nframes)
 
        (this->*process_function) (nframes);
 
+       /* realtime-safe meter-position and processor-order changes
+        *
+        * ideally this would be done in
+        * Route::process_output_buffers() but various functions
+        * callig it hold a _processor_lock reader-lock
+        */
+       boost::shared_ptr<RouteList> r = routes.reader ();
+       for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
+               if ((*i)->apply_processor_changes_rt()) {
+                       _rt_emit_pending = true;
+               }
+       }
+       if (_rt_emit_pending) {
+               if (!_rt_thread_active) {
+                       emit_route_signals ();
+               }
+               if (pthread_mutex_trylock (&_rt_emit_mutex) == 0) {
+                       pthread_cond_signal (&_rt_emit_cond);
+                       pthread_mutex_unlock (&_rt_emit_mutex);
+                       _rt_emit_pending = false;
+               }
+       }
+
        _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;
+       /* 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.
+        */
+
        try {
-               _tempo_map->bbt_time_rt (transport_frames, transport_bbt);
-               Timecode::Time transport_timecode;
-               timecode_time(transport_frames, transport_timecode);
-               tick (transport_frames, transport_bbt, transport_timecode); /* EMIT SIGNAL */
+               if (!_silent && !_engine.freewheeling() && Config->get_send_midi_clock() && (transport_speed() == 1.0f || transport_speed() == 0.0f) && midi_clock->has_midi_port()) {
+                       midi_clock->tick (transport_at_start, nframes);
+               }
+
+               _scene_changer->run (transport_at_start, transport_at_start + nframes);
+
        } catch (...) {
                /* don't bother with a message */
        }
 
        SendFeedback (); /* EMIT SIGNAL */
-
-       MIDI::Manager::instance()->cycle_end();
 }
 
 int
@@ -105,24 +130,26 @@ 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 = (config.get_use_transport_fades() ? get_transport_declick_required() : false);
        boost::shared_ptr<RouteList> r = routes.reader ();
 
        if (_click_io) {
                _click_io->silence (nframes);
        }
 
-       if (1 || _process_graph->threads_in_use() > 0) {
+       ltc_tx_send_time_code_for_cycle (_transport_frame, end_frame, _target_transport_speed, _transport_speed, nframes);
+
+       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()) {
+                       if ((*i)->is_auditioner()) {
                                continue;
                        }
 
@@ -141,49 +168,55 @@ Session::no_roll (pframes_t nframes)
        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)
 {
-       int  declick = get_transport_declick_required();
+       int declick = (config.get_use_transport_fades() ? get_transport_declick_required() : false);
        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 + floor (nframes * _transport_speed);
 
-       /* XXX this is hack to force use of the graph even if we are only
-          using 1 thread. its needed because otherwise when we remove
-          tracks, the graph never gets updated.
-       */
-       if (1 || _process_graph->threads_in_use() > 0) {
+       if (_process_graph) {
                DEBUG_TRACE(DEBUG::ProcessThreads,"calling graph/process-routes\n");
-               _process_graph->process_routes (nframes, start_frame, end_frame, declick, need_butler);
+               if (_process_graph->process_routes (nframes, start_frame, end_frame, declick, need_butler) < 0) {
+                       stop_transport ();
+                       return -1;
+               }
        } else {
 
                for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
 
                        int ret;
 
-                       if ((*i)->is_hidden()) {
+                       if ((*i)->is_auditioner()) {
                                continue;
                        }
 
                        (*i)->set_pending_declick (declick);
 
-                       if ((ret = (*i)->roll (nframes, start_frame, end_frame, declick, need_butler)) < 0) {
+                       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)
 {
@@ -192,25 +225,27 @@ Session::silent_process_routes (pframes_t nframes, bool& need_butler)
        const framepos_t start_frame = _transport_frame;
        const framepos_t end_frame = _transport_frame + lrintf(nframes * _transport_speed);
 
-       /* XXX this is hack to force use of the graph even if we are only
-          using 1 thread. its needed because otherwise when we remove
-          tracks, the graph never gets updated.
-       */
-       if (1 || _process_graph->threads_in_use() > 0) {
+       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;
 
-                       if ((*i)->is_hidden()) {
+                       if ((*i)->is_auditioner()) {
                                continue;
                        }
 
-                       if ((ret = (*i)->silent_roll (nframes, start_frame, end_frame, need_butler)) < 0) {
+                       bool b = false;
+
+                       if ((ret = (*i)->silent_roll (nframes, start_frame, end_frame, b)) < 0) {
                                stop_transport ();
                                return -1;
                        }
+
+                       if (b) {
+                               need_butler = true;
+                       }
                }
        }
 
@@ -249,7 +284,7 @@ void
 Session::process_with_events (pframes_t nframes)
 {
        PT_TIMING_CHECK (3);
-       
+
        SessionEvent*  ev;
        pframes_t      this_nframes;
        framepos_t     end_frame;
@@ -314,7 +349,7 @@ Session::process_with_events (pframes_t nframes)
         * and prepare for rolling)
         */
        if (_send_timecode_update) {
-               send_full_time_code (_transport_frame);
+               send_full_time_code (_transport_frame, nframes);
        }
 
        if (!process_can_proceed()) {
@@ -323,6 +358,7 @@ Session::process_with_events (pframes_t nframes)
        }
 
        if (events.empty() || next_event == events.end()) {
+               try_run_lua (nframes); // also during export ?? ->move to process_without_events()
                process_without_events (nframes);
                return;
        }
@@ -330,8 +366,8 @@ Session::process_with_events (pframes_t 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));
+               interpolation.set_target_speed (_target_transport_speed);
+               interpolation.set_speed (_transport_speed);
                frames_moved = (framecnt_t) interpolation.interpolate (0, nframes, 0, 0);
        }
 
@@ -361,6 +397,8 @@ Session::process_with_events (pframes_t nframes)
                        send_midi_time_code_for_cycle (_transport_frame, end_frame, nframes);
                }
 
+               ltc_tx_send_time_code_for_cycle (_transport_frame, end_frame, _target_transport_speed, _transport_speed, nframes);
+
                framepos_t stop_limit = compute_stop_limit ();
 
                if (maybe_stop (stop_limit)) {
@@ -388,6 +426,8 @@ Session::process_with_events (pframes_t nframes)
                                this_nframes = abs (floor(frames_moved / _transport_speed));
                        }
 
+                       try_run_lua (this_nframes);
+
                        if (this_nframes) {
 
                                click (_transport_frame, this_nframes);
@@ -411,7 +451,9 @@ Session::process_with_events (pframes_t nframes)
                                check_declick_out ();
                        }
 
-                       _engine.split_cycle (this_nframes);
+                       if (nframes > 0) {
+                               _engine.split_cycle (this_nframes);
+                       }
 
                        /* now handle this event and all others scheduled for the same time */
 
@@ -502,7 +544,9 @@ Session::follow_slave (pframes_t nframes)
                slave_speed = 0.0f;
        }
 
-       if (_slave->is_always_synced() || config.get_timecode_source_is_synced()) {
+       if (_slave->is_always_synced() ||
+                       (Config->get_timecode_source_is_synced() && (dynamic_cast<TimecodeSlave*>(_slave)) != 0)
+                       ) {
 
                /* if the TC source is synced, then we assume that its
                   speed is binary: 0.0 or 1.0
@@ -530,7 +574,9 @@ Session::follow_slave (pframes_t nframes)
                                                   _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()) {
+       if (_slave_state == Running && !_slave->is_always_synced() &&
+                       !(Config->get_timecode_source_is_synced() && (dynamic_cast<TimecodeSlave*>(_slave)) != 0)
+                       ) {
 
                if (_transport_speed != 0.0f) {
 
@@ -561,7 +607,7 @@ Session::follow_slave (pframes_t nframes)
 #endif
 
                        if (_slave->give_slave_full_control_over_transport_speed()) {
-                               set_transport_speed (slave_speed, false, false);
+                               set_transport_speed (slave_speed, 0, false, false);
                                //std::cout << "set speed = " << slave_speed << "\n";
                        } else {
                                float adjusted_speed = slave_speed + (1.5 * (delta /  float(_current_frame_rate)));
@@ -572,7 +618,7 @@ Session::follow_slave (pframes_t nframes)
                        }
 
 #if 1
-                       if ((framecnt_t) abs(average_slave_delta) > _slave->resolution()) {
+                       if (!actively_recording() && (framecnt_t) abs(average_slave_delta) > _slave->resolution()) {
                                cerr << "average slave delta greater than slave resolution (" << _slave->resolution() << "), going to silent motion\n";
                                goto silent_motion;
                        }
@@ -642,7 +688,10 @@ Session::track_slave_state (float slave_speed, framepos_t slave_transport_frame,
 
                        } else {
 
-                               _slave_state = Running;
+                               DEBUG_TRACE (DEBUG::Slave, string_compose ("slave stopped -> running at %1\n", slave_transport_frame));
+
+                               memset (delta_accumulator, 0, sizeof (int32_t) * delta_accumulator_size);
+                               average_slave_delta = 0L;
 
                                Location* al = _locations->auto_loop_location();
 
@@ -652,8 +701,10 @@ Session::track_slave_state (float slave_speed, framepos_t slave_transport_frame,
                                }
 
                                if (slave_transport_frame != _transport_frame) {
+                                       DEBUG_TRACE (DEBUG::Slave, string_compose ("require locate to run. eng: %1 -> sl: %2\n", _transport_frame, slave_transport_frame));
                                        locate (slave_transport_frame, false, false);
                                }
+                               _slave_state = Running;
                        }
                        break;
 
@@ -702,9 +753,6 @@ Session::track_slave_state (float slave_speed, framepos_t slave_transport_frame,
                                        cerr << "cannot micro-seek\n";
                                        /* XXX what? */
                                }
-
-                               memset (delta_accumulator, 0, sizeof (int32_t) * delta_accumulator_size);
-                               average_slave_delta = 0L;
                        }
                }
 
@@ -727,7 +775,7 @@ Session::track_slave_state (float slave_speed, framepos_t slave_transport_frame,
                        force_locate (slave_transport_frame, false);
                }
 
-               _slave_state = Stopped;
+               reset_slave_state();
        }
 }
 
@@ -740,7 +788,7 @@ Session::follow_slave_silently (pframes_t nframes, float slave_speed)
                   for now.
                */
 
-               bool need_butler;
+               bool need_butler = false;
 
                silent_process_routes (nframes, need_butler);
 
@@ -776,6 +824,7 @@ Session::process_without_events (pframes_t nframes)
 
        if (!_exporting && _slave) {
                if (!follow_slave (nframes)) {
+                       ltc_tx_send_time_code_for_cycle (_transport_frame, _transport_frame, 0, 0 , nframes);
                        return;
                }
        }
@@ -788,8 +837,8 @@ Session::process_without_events (pframes_t 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));
+               interpolation.set_target_speed (_target_transport_speed);
+               interpolation.set_speed (_transport_speed);
                frames_moved = (framecnt_t) interpolation.interpolate (0, nframes, 0, 0);
        }
 
@@ -797,6 +846,8 @@ Session::process_without_events (pframes_t nframes)
                send_midi_time_code_for_cycle (_transport_frame, _transport_frame + frames_moved, nframes);
        }
 
+       ltc_tx_send_time_code_for_cycle (_transport_frame, _transport_frame + frames_moved, _target_transport_speed, _transport_speed, nframes);
+
        framepos_t const stop_limit = compute_stop_limit ();
 
        if (maybe_stop (stop_limit)) {
@@ -817,16 +868,6 @@ 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 {
@@ -851,7 +892,7 @@ Session::process_audition (pframes_t nframes)
        boost::shared_ptr<RouteList> r = routes.reader ();
 
        for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
-               if (!(*i)->is_hidden()) {
+               if (!(*i)->is_auditioner()) {
                        (*i)->silence (nframes);
                }
        }
@@ -864,8 +905,8 @@ Session::process_audition (pframes_t nframes)
 
        /* 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 (_monitor_out && auditioner->needs_monitor()) {
+               _monitor_out->monitor_run (_transport_frame, _transport_frame + nframes, nframes, false);
        }
 
        /* handle pending events */
@@ -999,23 +1040,37 @@ Session::process_event (SessionEvent* ev)
 
        switch (ev->type) {
        case SessionEvent::SetLoop:
-               set_play_loop (ev->yes_or_no);
+               set_play_loop (ev->yes_or_no, ev->speed);
                break;
 
        case SessionEvent::AutoLoop:
                if (play_loop) {
+                       /* roll after locate, do not flush, set "with loop"
+                          true only if we are seamless looping
+                       */
                        start_locate (ev->target_frame, true, false, Config->get_seamless_loop());
                }
                remove = false;
                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;
+                       /* args: do not roll after locate, do flush, not with loop */
                        locate (ev->target_frame, false, true, false);
                } else {
-                       // cerr << "soft locate to " << ev->target_frame << endl;
+                       /* args: do not roll after locate, do flush, not with loop */
                        start_locate (ev->target_frame, false, true, false);
                }
                _send_timecode_update = true;
@@ -1023,15 +1078,24 @@ Session::process_event (SessionEvent* ev)
 
        case SessionEvent::LocateRoll:
                if (ev->yes_or_no) {
-                       // cerr << "forced locate to+roll " << ev->target_frame << endl;
+                       /* args: roll after locate, do flush, not with loop */
                        locate (ev->target_frame, true, true, false);
                } else {
-                       // cerr << "soft locate to+roll " << ev->target_frame << endl;
+                       /* args: roll after locate, do flush, not with loop */
                        start_locate (ev->target_frame, true, true, false);
                }
                _send_timecode_update = true;
                break;
 
+       case SessionEvent::Skip:
+               if (Config->get_skip_playback()) {
+                       start_locate (ev->target_frame, true, true, false);
+                       _send_timecode_update = true;
+               }
+               remove = false;
+               del = false;
+               break;
+
        case SessionEvent::LocateRollLocate:
                // locate is handled by ::request_roll_at_and_return()
                _requested_return_frame = ev->target_frame;
@@ -1040,7 +1104,7 @@ Session::process_event (SessionEvent* ev)
 
 
        case SessionEvent::SetTransportSpeed:
-               set_transport_speed (ev->speed, ev->yes_or_no, ev->second_yes_or_no);
+               set_transport_speed (ev->speed, ev->target_frame, ev->yes_or_no, ev->second_yes_or_no, ev->third_yes_or_no);
                break;
 
        case SessionEvent::PunchIn:
@@ -1063,8 +1127,8 @@ Session::process_event (SessionEvent* ev)
 
        case SessionEvent::StopOnce:
                if (!non_realtime_work_pending()) {
-                       stop_transport (ev->yes_or_no);
                        _clear_event_type (SessionEvent::StopOnce);
+                       stop_transport (ev->yes_or_no);
                }
                remove = false;
                del = false;
@@ -1079,6 +1143,7 @@ Session::process_event (SessionEvent* ev)
                break;
 
        case SessionEvent::RangeLocate:
+               /* args: roll after locate, do flush, not with loop */
                start_locate (ev->target_frame, true, true, false);
                remove = false;
                del = false;
@@ -1093,6 +1158,7 @@ Session::process_event (SessionEvent* ev)
                break;
 
        case SessionEvent::SetSyncSource:
+               DEBUG_TRACE (DEBUG::Slave, "seen request for new slave\n");
                use_sync_source (ev->slave);
                break;
 
@@ -1111,6 +1177,10 @@ Session::process_event (SessionEvent* ev)
                set_play_range (ev->audio_range, (ev->speed == 1.0f));
                break;
 
+       case SessionEvent::CancelPlayAudioRange:
+               unset_play_range();
+               break;
+
        case SessionEvent::RealTimeOperation:
                process_rtop (ev);
                del = false; // other side of RT request needs to clean up
@@ -1130,7 +1200,7 @@ Session::process_event (SessionEvent* ev)
 
        default:
          fatal << string_compose(_("Programming error: illegal event type in process_event (%1)"), ev->type) << endmsg;
-               /*NOTREACHED*/
+               abort(); /*NOTREACHED*/
                break;
        };
 
@@ -1149,7 +1219,12 @@ Session::compute_stop_limit () const
        if (!Config->get_stop_at_session_end ()) {
                return max_framepos;
        }
-       
+
+       if (_slave) {
+               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());
 
@@ -1166,3 +1241,79 @@ Session::compute_stop_limit () const
 
        return current_end_frame ();
 }
+
+
+
+/* dedicated thread for signal emission.
+ *
+ * while sending cross-thread signals from the process thread
+ * is fine in general, PBD::Signal's use of boost::function and
+ * boost:bind can produce a vast overhead which is not
+ * acceptable for low latency.
+ *
+ * This works around the issue by moving the boost overhead
+ * out of the RT thread. The overall load is probably higher but
+ * the realtime thread remains unaffected.
+ */
+
+void
+Session::emit_route_signals ()
+{
+       // TODO use RAII to allow using these signals in other places
+       BatchUpdateStart(); /* EMIT SIGNAL */
+       boost::shared_ptr<RouteList> r = routes.reader ();
+       for (RouteList::const_iterator ci = r->begin(); ci != r->end(); ++ci) {
+               (*ci)->emit_pending_signals ();
+       }
+       BatchUpdateEnd(); /* EMIT SIGNAL */
+}
+
+void
+Session::emit_thread_start ()
+{
+       if (_rt_thread_active) {
+               return;
+       }
+       _rt_thread_active = true;
+
+       if (pthread_create (&_rt_emit_thread, NULL, emit_thread, this)) {
+               _rt_thread_active = false;
+       }
+}
+
+void
+Session::emit_thread_terminate ()
+{
+       if (!_rt_thread_active) {
+               return;
+       }
+       _rt_thread_active = false;
+
+       if (pthread_mutex_lock (&_rt_emit_mutex) == 0) {
+               pthread_cond_signal (&_rt_emit_cond);
+               pthread_mutex_unlock (&_rt_emit_mutex);
+       }
+
+       void *status;
+       pthread_join (_rt_emit_thread, &status);
+}
+
+void *
+Session::emit_thread (void *arg)
+{
+       Session *s = static_cast<Session *>(arg);
+       s->emit_thread_run ();
+       pthread_exit (0);
+       return 0;
+}
+
+void
+Session::emit_thread_run ()
+{
+       pthread_mutex_lock (&_rt_emit_mutex);
+       while (_rt_thread_active) {
+               emit_route_signals();
+               pthread_cond_wait (&_rt_emit_cond, &_rt_emit_mutex);
+       }
+       pthread_mutex_unlock (&_rt_emit_mutex);
+}