remove InputConfigurationChange from session events, since it is a no-op in this...
[ardour.git] / libs / ardour / session_process.cc
index eb5c0de294f00cfbfe4c81b66949683930a13524..a162303d428980e6f6358962c76fb13feb21c487 100644 (file)
 #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/ticker.h"
 #include "ardour/types.h"
+#include "ardour/vca.h"
+#include "ardour/vca_manager.h"
 
 #include "midi++/mmc.h"
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 using namespace ARDOUR;
 using namespace PBD;
@@ -74,6 +77,29 @@ 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 ();
 
        /* deliver MIDI clock. Note that we need to use the transport frame
@@ -86,6 +112,9 @@ Session::process (pframes_t nframes)
                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 */
        }
@@ -103,10 +132,10 @@ 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;
-       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 (_click_io) {
@@ -115,6 +144,11 @@ Session::no_roll (pframes_t nframes)
 
        ltc_tx_send_time_code_for_cycle (_transport_frame, end_frame, _target_transport_speed, _transport_speed, nframes);
 
+       VCAList v = _vca_manager->vcas ();
+       for (VCAList::const_iterator i = v.begin(); i != v.end(); ++i) {
+               (*i)->automation_run (_transport_frame, 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);
@@ -147,20 +181,23 @@ Session::no_roll (pframes_t nframes)
 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);
-       
+
+       VCAList v = _vca_manager->vcas ();
+       for (VCAList::const_iterator i = v.begin(); i != v.end(); ++i) {
+               (*i)->automation_run (start_frame, nframes);
+       }
+
        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) {
@@ -181,6 +218,7 @@ Session::process_routes (pframes_t nframes, bool& need_butler)
                        }
 
                        if (b) {
+                               DEBUG_TRACE (DEBUG::Butler, string_compose ("%1 rolled and needs butler\n", (*i)->name()));
                                need_butler = true;
                        }
                }
@@ -200,6 +238,11 @@ 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);
 
+       VCAList v = _vca_manager->vcas ();
+       for (VCAList::const_iterator i = v.begin(); i != v.end(); ++i) {
+               (*i)->automation_run (start_frame, nframes);
+       }
+
        if (_process_graph) {
                _process_graph->silent_process_routes (nframes, start_frame, end_frame, need_butler);
        } else {
@@ -259,7 +302,7 @@ void
 Session::process_with_events (pframes_t nframes)
 {
        PT_TIMING_CHECK (3);
-       
+
        SessionEvent*  ev;
        pframes_t      this_nframes;
        framepos_t     end_frame;
@@ -289,6 +332,47 @@ Session::process_with_events (pframes_t nframes)
                process_event (ev);
        }
 
+       /* count in */
+       if (_transport_speed != 1.0 && _count_in_samples > 0) {
+               _count_in_samples = 0;
+       }
+
+       if (_count_in_samples > 0) {
+               framecnt_t ns = std::min ((framecnt_t)nframes, _count_in_samples);
+
+               no_roll (ns);
+               run_click (_transport_frame - _count_in_samples, ns);
+
+               _count_in_samples -= ns;
+               nframes -= ns;
+
+               /* process events.. */
+               if (!events.empty() && next_event != events.end()) {
+                       SessionEvent* this_event = *next_event;
+                       Events::iterator the_next_one = next_event;
+                       ++the_next_one;
+
+                       while (this_event && this_event->action_frame == _transport_frame) {
+                               process_event (this_event);
+                               if (the_next_one == events.end()) {
+                                       this_event = 0;
+                               } else {
+                                       this_event = *the_next_one;
+                                       ++the_next_one;
+                               }
+                       }
+                       set_next_event ();
+               }
+
+               check_declick_out ();
+
+               if (nframes == 0) {
+                       return;
+               } else {
+                       _engine.split_cycle (ns);
+               }
+       }
+
        /* Decide on what to do with quarter-frame MTC during this cycle */
 
        bool const was_sending_qf_mtc = _send_qf_mtc;
@@ -333,8 +417,15 @@ Session::process_with_events (pframes_t nframes)
        }
 
        if (events.empty() || next_event == events.end()) {
-               process_without_events (nframes);
-               return;
+               try_run_lua (nframes); // also during export ?? ->move to process_without_events()
+               /* lua scripts may inject events */
+               while (_n_lua_scripts > 0 && pending_events.read (&ev, 1) == 1) {
+                       merge_event (ev);
+               }
+               if (events.empty() || next_event == events.end()) {
+                       process_without_events (nframes);
+                       return;
+               }
        }
 
        if (_transport_speed == 1.0) {
@@ -371,6 +462,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)) {
@@ -398,6 +491,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);
@@ -454,6 +549,7 @@ Session::process_with_events (pframes_t nframes)
        } /* implicit release of route lock */
 
        if (session_needs_butler) {
+               DEBUG_TRACE (DEBUG::Butler, "p-with-events: session needs butler, call it\n");
                _butler->summon ();
        }
 }
@@ -577,7 +673,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)));
@@ -597,7 +693,7 @@ Session::follow_slave (pframes_t nframes)
        }
 
 
-       if (_slave_state == Running && !non_realtime_work_pending()) {
+       if (_slave_state == Running && 0 == (post_transport_work () & ~PostTransportSpeed)) {
                /* speed is set, we're locked, and good to go */
                return true;
        }
@@ -758,13 +854,14 @@ 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);
 
                get_track_statistics ();
 
                if (need_butler) {
+                       DEBUG_TRACE (DEBUG::Butler, "f-slave-silently: session needs butler, call it\n");
                        _butler->summon ();
                }
 
@@ -848,6 +945,7 @@ Session::process_without_events (pframes_t nframes)
        check_declick_out ();
 
        if (session_needs_butler) {
+               DEBUG_TRACE (DEBUG::Butler, "p-without-events: session needs butler, call it\n");
                _butler->summon ();
        }
 }
@@ -870,6 +968,7 @@ Session::process_audition (pframes_t nframes)
        /* run the auditioner, and if it says we need butler service, ask for it */
 
        if (auditioner->play_audition (nframes) > 0) {
+               DEBUG_TRACE (DEBUG::Butler, "auditioner needs butler, call it\n");
                _butler->summon ();
        }
 
@@ -956,6 +1055,7 @@ Session::queue_event (SessionEvent* ev)
        } else if (_state_of_the_state & Loading) {
                merge_event (ev);
        } else {
+               Glib::Threads::Mutex::Lock lm (rb_write_lock);
                pending_events.write (&ev, 1);
        }
 }
@@ -1057,6 +1157,15 @@ Session::process_event (SessionEvent* ev)
                _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;
@@ -1065,12 +1174,12 @@ Session::process_event (SessionEvent* ev)
 
 
        case SessionEvent::SetTransportSpeed:
-               set_transport_speed (ev->speed, ev->yes_or_no, ev->second_yes_or_no, ev->third_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:
                // cerr << "PunchIN at " << transport_frame() << endl;
-               if (config.get_punch_in() && record_status() == Enabled) {
+               if (config.get_punch_in() && record_status() == Enabled && !preroll_record_punch_enabled()) {
                        enable_record ();
                }
                remove = false;
@@ -1079,17 +1188,25 @@ Session::process_event (SessionEvent* ev)
 
        case SessionEvent::PunchOut:
                // cerr << "PunchOUT at " << transport_frame() << endl;
-               if (config.get_punch_out()) {
+               if (config.get_punch_out() && !preroll_record_punch_enabled()) {
                        step_back_from_record ();
                }
                remove = false;
                del = false;
                break;
 
+       case SessionEvent::RecordStart:
+               if (preroll_record_punch_enabled() && record_status() == Enabled) {
+                       enable_record ();
+               }
+               remove = false;
+               del = false;
+               break;
+
        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;
@@ -1114,10 +1231,6 @@ Session::process_event (SessionEvent* ev)
                overwrite_some_buffers (static_cast<Track*>(ev->ptr));
                break;
 
-       case SessionEvent::SetTrackSpeed:
-               set_track_speed (static_cast<Track*> (ev->ptr), ev->speed);
-               break;
-
        case SessionEvent::SetSyncSource:
                DEBUG_TRACE (DEBUG::Slave, "seen request for new slave\n");
                use_sync_source (ev->slave);
@@ -1129,15 +1242,14 @@ Session::process_event (SessionEvent* ev)
                ev->region.reset ();
                break;
 
-       case SessionEvent::InputConfigurationChange:
-               add_post_transport_work (PostTransportInputChange);
-               _butler->schedule_transport_work ();
-               break;
-
        case SessionEvent::SetPlayAudioRange:
                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
@@ -1157,7 +1269,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;
        };
 
@@ -1181,7 +1293,10 @@ Session::compute_stop_limit () const
                return max_framepos;
        }
 
-       
+       if (preroll_record_punch_enabled ()) {
+               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());
 
@@ -1198,3 +1313,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);
+}