hotfix process-graph: include internal-send -> internal return
[ardour.git] / libs / ardour / ltc_slave.cc
index 9153facb8c151fe293663bfa5dc3ed6cd9febe81..ab84cf6201b11aa4153b82561a019446d7f7af70 100644 (file)
 */
 #include <iostream>
 #include <errno.h>
-#include <poll.h>
 #include <sys/types.h>
 #include <unistd.h>
 
 #include "pbd/error.h"
+#include "pbd/pthread_utils.h"
 
 #include "ardour/debug.h"
+#include "ardour/profile.h"
 #include "ardour/slave.h"
 #include "ardour/session.h"
 #include "ardour/audioengine.h"
@@ -51,18 +52,30 @@ LTC_Slave::LTC_Slave (Session& s)
        did_reset_tc_format = false;
        delayedlocked = 10;
        monotonic_cnt = 0;
+       fps_detected=false;
+       sync_lock_broken = false;
 
-       ltc_timecode = timecode_60; // track changes of LTC timecode
-       a3e_timecode = timecode_60; // track canges of Ardour's timecode
+       ltc_timecode = session.config.get_timecode_format();
+       a3e_timecode = session.config.get_timecode_format();
        printed_timecode_warning = false;
        ltc_detect_fps_cnt = ltc_detect_fps_max = 0;
+       memset(&prev_frame, 0, sizeof(LTCFrameExt));
 
        decoder = ltc_decoder_create((int) frames_per_ltc_frame, 128 /*queue size*/);
+
+       session.config.ParameterChanged.connect_same_thread (config_connection, boost::bind (&LTC_Slave::parameter_changed, this, _1));
+       parse_timecode_offset();
        reset();
+       resync_latency();
+       session.Xrun.connect_same_thread (port_connections, boost::bind (&LTC_Slave::resync_xrun, this));
+       session.engine().GraphReordered.connect_same_thread (port_connections, boost::bind (&LTC_Slave::resync_latency, this));
 }
 
 LTC_Slave::~LTC_Slave()
 {
+       port_connections.drop_connections();
+       config_connection.disconnect();
+
        if (did_reset_tc_format) {
                session.config.set_timecode_format (saved_tc_format);
        }
@@ -70,10 +83,30 @@ LTC_Slave::~LTC_Slave()
        ltc_decoder_free(decoder);
 }
 
+void
+LTC_Slave::parse_timecode_offset() {
+       Timecode::Time offset_tc;
+       Timecode::parse_timecode_format(session.config.get_slave_timecode_offset(), offset_tc);
+       offset_tc.rate = session.timecode_frames_per_second();
+       offset_tc.drop = session.timecode_drop_frames();
+       session.timecode_to_sample(offset_tc, timecode_offset, false, false);
+       timecode_negative_offset = offset_tc.negative;
+}
+
+void
+LTC_Slave::parameter_changed (std::string const & p)
+{
+       if (p == "slave-timecode-offset"
+                       || p == "timecode-format"
+                       ) {
+               parse_timecode_offset();
+       }
+}
+
 ARDOUR::framecnt_t
 LTC_Slave::resolution () const
 {
-       return (framecnt_t) (frames_per_ltc_frame);
+       return (framecnt_t) (session.frame_rate() / 1000);
 }
 
 bool
@@ -88,6 +121,27 @@ LTC_Slave::ok() const
        return true;
 }
 
+void
+LTC_Slave::resync_xrun()
+{
+       DEBUG_TRACE (DEBUG::LTC, "LTC resync_xrun()\n");
+       engine_dll_initstate = 0;
+       sync_lock_broken = false;
+}
+
+void
+LTC_Slave::resync_latency()
+{
+       DEBUG_TRACE (DEBUG::LTC, "LTC resync_latency()\n");
+       engine_dll_initstate = 0;
+       sync_lock_broken = false;
+
+       if (!session.deletion_in_progress() && session.ltc_output_io()) { /* check if Port exits */
+               boost::shared_ptr<Port> ltcport = session.ltc_input_port();
+               ltcport->get_connected_latency_range (ltc_slave_latency, false);
+       }
+}
+
 void
 LTC_Slave::reset()
 {
@@ -97,16 +151,19 @@ LTC_Slave::reset()
        transport_direction = 0;
        ltc_speed = 0;
        engine_dll_initstate = 0;
+       sync_lock_broken = false;
+
+       ActiveChanged (false); /* EMIT SIGNAL */
 }
 
 void
-LTC_Slave::parse_ltc(const jack_nframes_t nframes, const jack_default_audio_sample_t * const in, const framecnt_t posinfo)
+LTC_Slave::parse_ltc(const ARDOUR::pframes_t nframes, const Sample* const in, const ARDOUR::framecnt_t posinfo)
 {
-       jack_nframes_t i;
+       pframes_t i;
        unsigned char sound[8192];
        if (nframes > 8192) {
                /* TODO warn once or wrap, loop conversion below
-                * does A3 support > 8192 spp anyway?
+                * does jack/A3 support > 8192 spp anyway?
                 */
                return;
        }
@@ -119,9 +176,52 @@ LTC_Slave::parse_ltc(const jack_nframes_t nframes, const jack_default_audio_samp
        return;
 }
 
+bool
+LTC_Slave::equal_ltc_frame_time(LTCFrame *a, LTCFrame *b) {
+       if (       a->frame_units != b->frame_units
+               || a->frame_tens  != b->frame_tens
+               || a->dfbit       != b->dfbit
+               || a->secs_units  != b->secs_units
+               || a->secs_tens   != b->secs_tens
+               || a->mins_units  != b->mins_units
+               || a->mins_tens   != b->mins_tens
+               || a->hours_units != b->hours_units
+               || a->hours_tens  != b->hours_tens
+            ) {
+               return false;
+       }
+       return true;
+}
+
+bool
+LTC_Slave::detect_discontinuity(LTCFrameExt *frame, int fps, bool fuzzy) {
+       bool discontinuity_detected = false;
+
+       if (fuzzy && (
+                 ( frame->reverse && prev_frame.ltc.frame_units == 0)
+               ||(!frame->reverse && frame->ltc.frame_units == 0)
+               )) {
+               memcpy(&prev_frame, frame, sizeof(LTCFrameExt));
+               return false;
+       }
+
+       if (frame->reverse) {
+               ltc_frame_decrement(&prev_frame.ltc, fps, LTC_TV_525_60, 0);
+       } else {
+               ltc_frame_increment(&prev_frame.ltc, fps, LTC_TV_525_60, 0);
+       }
+       if (!equal_ltc_frame_time(&prev_frame.ltc, &frame->ltc)) {
+               discontinuity_detected = true;
+       }
+
+    memcpy(&prev_frame, frame, sizeof(LTCFrameExt));
+    return discontinuity_detected;
+}
+
 bool
 LTC_Slave::detect_ltc_fps(int frameno, bool df)
 {
+       bool fps_changed = false;
        double detected_fps = 0;
        if (frameno > ltc_detect_fps_max)
        {
@@ -129,22 +229,23 @@ LTC_Slave::detect_ltc_fps(int frameno, bool df)
        }
        ltc_detect_fps_cnt++;
 
-       if (ltc_detect_fps_cnt > 40)
-       {
-               if (ltc_detect_fps_cnt > ltc_detect_fps_max
-                   && (   ceil(timecode.rate) != (ltc_detect_fps_max + 1)
-                       || timecode.drop != df
-                       )
-                   )
-               {
-                       DEBUG_TRACE (DEBUG::LTC, string_compose ("LTC detected FPS %1%2",
-                                       ltc_detect_fps_max + 1, timecode.drop ? "df" : ""));
+       if (ltc_detect_fps_cnt > 40) {
+               if (ltc_detect_fps_cnt > ltc_detect_fps_max) {
                        detected_fps = ltc_detect_fps_max + 1;
                        if (df) {
                                /* LTC df -> indicates fractional framerate */
-                               detected_fps = detected_fps * 1000.0 / 1001.0;
+                               if (Config->get_timecode_source_2997()) {
+                                       detected_fps = detected_fps * 999.0 / 1000.0;
+                               } else {
+                                       detected_fps = detected_fps * 1000.0 / 1001.0;
+                               }
+                       }
+
+                       if (timecode.rate != detected_fps || timecode.drop != df) {
+                               DEBUG_TRACE (DEBUG::LTC, string_compose ("LTC detected FPS: %1%2\n", detected_fps, df?"df":"ndf"));
+                       } else {
+                               detected_fps = 0; /* no cange */
                        }
-                       DEBUG_TRACE (DEBUG::LTC, string_compose ("LTC detected FPS: %1%2\n", detected_fps, df?"df":"ndf"));
                }
                ltc_detect_fps_cnt = ltc_detect_fps_max = 0;
        }
@@ -156,49 +257,54 @@ LTC_Slave::detect_ltc_fps(int frameno, bool df)
                frames_per_ltc_frame = double(session.frame_rate()) / timecode.rate;
                DEBUG_TRACE (DEBUG::LTC, string_compose ("LTC reset to FPS: %1%2 ; audio-frames per LTC: %3\n",
                                detected_fps, df?"df":"ndf", frames_per_ltc_frame));
-               return true; // reset()
+               fps_changed=true;
        }
 
        /* poll and check session TC */
-       if (1) {
-               TimecodeFormat tc_format = apparent_timecode_format();
-               TimecodeFormat cur_timecode = session.config.get_timecode_format();
-               if (Config->get_timecode_sync_frame_rate()) {
-                       /* enforce time-code */
-                       if (!did_reset_tc_format) {
-                               saved_tc_format = cur_timecode;
-                               did_reset_tc_format = true;
-                       }
-                       if (cur_timecode != tc_format) {
-                               warning << string_compose(_("Session framerate adjusted from %1 TO: LTC's %2."),
+       TimecodeFormat tc_format = apparent_timecode_format();
+       TimecodeFormat cur_timecode = session.config.get_timecode_format();
+
+       if (Config->get_timecode_sync_frame_rate()) {
+               /* enforce time-code */
+               if (!did_reset_tc_format) {
+                       saved_tc_format = cur_timecode;
+                       did_reset_tc_format = true;
+               }
+               if (cur_timecode != tc_format) {
+                       if (ceil(Timecode::timecode_to_frames_per_second(cur_timecode)) != ceil(Timecode::timecode_to_frames_per_second(tc_format))) {
+                               warning << string_compose(_("Session framerate adjusted from %1 to LTC's %2."),
                                                Timecode::timecode_format_name(cur_timecode),
                                                Timecode::timecode_format_name(tc_format))
                                        << endmsg;
-                               session.config.set_timecode_format (tc_format);
                        }
-               } else {
-                       /* only warn about TC mismatch */
-                       if (ltc_timecode != tc_format) printed_timecode_warning = false;
-                       if (a3e_timecode != cur_timecode) printed_timecode_warning = false;
+                       session.config.set_timecode_format (tc_format);
+               }
+       } else {
+               /* only warn about TC mismatch */
+               if (ltc_timecode != tc_format) printed_timecode_warning = false;
+               if (a3e_timecode != cur_timecode) printed_timecode_warning = false;
 
-                       if (cur_timecode != tc_format && ! printed_timecode_warning) {
+               if (cur_timecode != tc_format && ! printed_timecode_warning) {
+                       if (ceil(Timecode::timecode_to_frames_per_second(cur_timecode)) != ceil(Timecode::timecode_to_frames_per_second(tc_format))) {
                                warning << string_compose(_("Session and LTC framerate mismatch: LTC:%1 Session:%2."),
                                                Timecode::timecode_format_name(tc_format),
                                                Timecode::timecode_format_name(cur_timecode))
                                        << endmsg;
-                               printed_timecode_warning = true;
                        }
+                       printed_timecode_warning = true;
                }
-               ltc_timecode = tc_format;
-               a3e_timecode = cur_timecode;
        }
-       return false;
+       ltc_timecode = tc_format;
+       a3e_timecode = cur_timecode;
+
+       return fps_changed;
 }
 
 void
-LTC_Slave::process_ltc(framepos_t const now)
+LTC_Slave::process_ltc(framepos_t const /*now*/)
 {
        LTCFrameExt frame;
+       enum LTC_TV_STANDARD tv_standard = LTC_TV_625_50;
        while (ltc_decoder_read(decoder, &frame)) {
                SMPTETimecode stime;
 
@@ -207,9 +313,16 @@ LTC_Slave::process_ltc(framepos_t const now)
                timecode.subframes  = 0;
 
                /* set timecode.rate and timecode.drop: */
-               if (detect_ltc_fps(stime.frame, (frame.ltc.dfbit)? true : false)) {
+               bool ltc_is_static = equal_ltc_frame_time(&prev_frame.ltc, &frame.ltc);
+
+               if (detect_discontinuity(&frame, ceil(timecode.rate), !fps_detected)) {
+                       if (fps_detected) { ltc_detect_fps_cnt = ltc_detect_fps_max = 0; }
+                       fps_detected=false;
+               }
+
+               if (!ltc_is_static && detect_ltc_fps(stime.frame, (frame.ltc.dfbit)? true : false)) {
                        reset();
-                       last_timestamp = 0;
+                       fps_detected=true;
                }
 
 #if 0 // Devel/Debug
@@ -231,15 +344,34 @@ LTC_Slave::process_ltc(framepos_t const now)
                 * is expected to start at the end of the current frame
                 */
                int fps_i = ceil(timecode.rate);
+
+               switch(fps_i) {
+                       case 30:
+                               if (timecode.drop) {
+                                       tv_standard = LTC_TV_525_60;
+                               } else {
+                                       tv_standard = LTC_TV_1125_60;
+                               }
+                               break;
+                       case 25:
+                               tv_standard = LTC_TV_625_50;
+                               break;
+                       default:
+                               tv_standard = LTC_TV_FILM_24; /* == LTC_TV_1125_60 == no offset, 24,30fps BGF */
+                               break;
+               }
+
                if (!frame.reverse) {
-                       ltc_frame_increment(&frame.ltc, fps_i , 0);
+                       ltc_frame_increment(&frame.ltc, fps_i, tv_standard, 0);
                        ltc_frame_to_time(&stime, &frame.ltc, 0);
                        transport_direction = 1;
+                       frame.off_start -= ltc_frame_alignment(session.frames_per_timecode_frame(), tv_standard);
+                       frame.off_end -= ltc_frame_alignment(session.frames_per_timecode_frame(), tv_standard);
                } else {
-                       ltc_frame_decrement(&frame.ltc, fps_i , 0);
+                       ltc_frame_decrement(&frame.ltc, fps_i, tv_standard, 0);
                        int off = frame.off_end - frame.off_start;
-                       frame.off_start += off;
-                       frame.off_end += off;
+                       frame.off_start += off - ltc_frame_alignment(session.frames_per_timecode_frame(), tv_standard);
+                       frame.off_end += off - ltc_frame_alignment(session.frames_per_timecode_frame(), tv_standard);
                        transport_direction = -1;
                }
 
@@ -253,9 +385,11 @@ LTC_Slave::process_ltc(framepos_t const now)
                Timecode::timecode_to_sample (timecode, ltc_frame, true, false,
                        double(session.frame_rate()),
                        session.config.get_subframes_per_frame(),
-                       session.config.get_timecode_offset_negative(), session.config.get_timecode_offset()
+                       timecode_negative_offset, timecode_offset
                        );
 
+               ltc_frame += ltc_slave_latency.max + session.worst_playback_latency();
+
                framepos_t cur_timestamp = frame.off_end + 1;
                DEBUG_TRACE (DEBUG::LTC, string_compose ("LTC F: %1 LF: %2  N: %3 L: %4\n", ltc_frame, last_ltc_frame, cur_timestamp, last_timestamp));
                if (frame.off_end + 1 <= last_timestamp || last_timestamp == 0) {
@@ -288,36 +422,37 @@ LTC_Slave::init_engine_dll (framepos_t pos, int32_t inc)
 }
 
 /* main entry point from session_process.cc
- * called from jack_process callback context
- * so it is OK to use jack_port_get_buffer()
+ * called from process callback context
+ * so it is OK to use get_buffer()
  */
 bool
 LTC_Slave::speed_and_position (double& speed, framepos_t& pos)
 {
        bool engine_init_called = false;
-       framepos_t now = session.engine().frame_time_at_cycle_start();
+       framepos_t now = session.engine().sample_time_at_cycle_start();
        framepos_t sess_pos = session.transport_frame(); // corresponds to now
-       framecnt_t nframes = session.engine().frames_per_cycle();
+       framecnt_t nframes = session.engine().samples_per_cycle();
 
-       jack_default_audio_sample_t *in;
-       jack_latency_range_t ltc_latency;
+       Sample* in;
 
-       boost::shared_ptr<Port> ltcport = session.engine().ltc_input_port();
-       ltcport->get_connected_latency_range(ltc_latency, false);
-       in = (jack_default_audio_sample_t*) jack_port_get_buffer (ltcport->jack_port(), nframes);
+       boost::shared_ptr<Port> ltcport = session.ltc_input_port();
+
+       in = (Sample*) AudioEngine::instance()->port_engine().get_buffer (ltcport->port_handle(), nframes);
 
        frameoffset_t skip = now - (monotonic_cnt + nframes);
        monotonic_cnt = now;
-       DEBUG_TRACE (DEBUG::LTC, string_compose ("speed_and_position - TID:%1 | latency: %2 | skip %3\n", ::pthread_self(), ltc_latency.max, skip));
+       DEBUG_TRACE (DEBUG::LTC, string_compose ("speed_and_position - TID:%1 | latency: %2 | skip %3\n", pthread_name(), ltc_slave_latency.max, skip));
 
        if (last_timestamp == 0) {
                engine_dll_initstate = 0;
-               delayedlocked++;
-       }
-       else if (engine_dll_initstate != transport_direction && ltc_speed != 0) {
+               if (delayedlocked < 10) ++delayedlocked;
+       } else if (engine_dll_initstate != transport_direction && ltc_speed != 0) {
+
+               ActiveChanged (true); /* EMIT SIGNAL */
+
                engine_dll_initstate = transport_direction;
                init_engine_dll(last_ltc_frame + rint(ltc_speed * double(2 * nframes + now - last_timestamp)),
-                               session.engine().frames_per_cycle());
+                               session.engine().samples_per_cycle());
                engine_init_called = true;
        }
 
@@ -339,7 +474,7 @@ LTC_Slave::speed_and_position (double& speed, framepos_t& pos)
                        reset();
                }
 
-               parse_ltc(nframes, in, now + ltc_latency.max );
+               parse_ltc(nframes, in, now);
                process_ltc(now);
        }
 
@@ -349,7 +484,8 @@ LTC_Slave::speed_and_position (double& speed, framepos_t& pos)
                pos = session.transport_frame();
                return true;
        } else if (ltc_speed != 0) {
-               delayedlocked = 0;
+               if (delayedlocked > 1) delayedlocked--;
+               else if (current_delta == 0) delayedlocked = 0;
        }
 
        if (abs(now - last_timestamp) > FLYWHEEL_TIMEOUT) {
@@ -357,12 +493,13 @@ LTC_Slave::speed_and_position (double& speed, framepos_t& pos)
                reset();
                speed = 0;
                pos = session.transport_frame();
+               ActiveChanged (false); /* EMIT SIGNAL */
                return true;
        }
 
        /* it take 2 cycles from naught to rolling.
         * during these to initial cycles the speed == 0
-        * 
+        *
         * the first cycle:
         * DEBUG::Slave: slave stopped, move to NNN
         * DEBUG::Transport: Request forced locate to NNN
@@ -397,8 +534,8 @@ LTC_Slave::speed_and_position (double& speed, framepos_t& pos)
                t0 = t1;
                t1 += b * e + e2;
                e2 += c * e;
-               speed_flt = (t1 - t0) / double(session.engine().frames_per_cycle());
-               DEBUG_TRACE (DEBUG::LTC, string_compose ("LTC engine DLL t0:%1 t1:%2 err:%3 spd:%4 ddt:%5\n", t0, t1, e, speed_flt, e2 - session.engine().frames_per_cycle() ));
+               speed_flt = (t1 - t0) / double(session.engine().samples_per_cycle());
+               DEBUG_TRACE (DEBUG::LTC, string_compose ("LTC engine DLL t0:%1 t1:%2 err:%3 spd:%4 ddt:%5\n", t0, t1, e, speed_flt, e2 - session.engine().samples_per_cycle() ));
        } else {
                DEBUG_TRACE (DEBUG::LTC, string_compose ("LTC adjusting elapsed (no DLL) from %1 by %2\n", elapsed, (2 * nframes * ltc_speed)));
                speed_flt = 0;
@@ -420,10 +557,15 @@ LTC_Slave::speed_and_position (double& speed, framepos_t& pos)
        DEBUG_TRACE (DEBUG::LTC, string_compose ("LTCsync spd: %1 pos: %2 | last-pos: %3 elapsed: %4 delta: %5\n",
                                                 speed, pos, last_ltc_frame, elapsed, current_delta));
 
-#if 1 /* provide a .1% deadzone to lock the speed */
-       if (fabs(speed - 1.0) <= 0.001)
+       /* provide a .1% deadzone to lock the speed */
+       if (fabs(speed - 1.0) <= 0.001) {
                speed = 1.0;
-#endif
+       }
+
+       if (speed != 0 && delayedlocked == 0 && fabs(speed) != 1.0) {
+               sync_lock_broken = true;
+               DEBUG_TRACE (DEBUG::LTC, string_compose ("LTC speed not locked %1 %2\n", speed, ltc_speed));
+       }
 
        return true;
 }
@@ -436,9 +578,9 @@ LTC_Slave::apparent_timecode_format () const
        else if (timecode.rate == 25 && !timecode.drop)
                return timecode_25;
        else if (rint(timecode.rate * 100) == 2997 && !timecode.drop)
-               return timecode_2997;
+               return (Config->get_timecode_source_2997() ? timecode_2997000 : timecode_2997);
        else if (rint(timecode.rate * 100) == 2997 &&  timecode.drop)
-               return timecode_2997drop;
+               return (Config->get_timecode_source_2997() ? timecode_2997000drop : timecode_2997drop);
        else if (timecode.rate == 30 &&  timecode.drop)
                return timecode_2997drop; // timecode_30drop; // LTC counting to 30 frames w/DF *means* 29.97 df
        else if (timecode.rate == 30 && !timecode.drop)
@@ -460,14 +602,15 @@ LTC_Slave::approximate_current_position() const
 std::string
 LTC_Slave::approximate_current_delta() const
 {
-       char delta[24];
+       char delta[80];
        if (last_timestamp == 0 || engine_dll_initstate == 0) {
                snprintf(delta, sizeof(delta), "\u2012\u2012\u2012\u2012");
        } else if ((monotonic_cnt - last_timestamp) > 2 * frames_per_ltc_frame) {
-               snprintf(delta, sizeof(delta), "flywheel");
+               snprintf(delta, sizeof(delta), "%s", _("flywheel"));
        } else {
-               snprintf(delta, sizeof(delta), "%s%4" PRIi64 " sm",
-                               PLUSMINUS(-current_delta), abs(current_delta));
+               snprintf(delta, sizeof(delta), "\u0394<span foreground=\"%s\" face=\"monospace\" >%s%s%lld</span>sm",
+                               sync_lock_broken ? "red" : "green",
+                               LEADINGZERO(::llabs(current_delta)), PLUSMINUS(-current_delta), ::llabs(current_delta));
        }
        return std::string(delta);
 }