Merge branch 'master' into windows
[ardour.git] / libs / ardour / ardour / slave.h
index 0ba06b3ba58287b6fdf4b53564674ff554556d5f..ca3f618af1de1ed5363d6f971a12b73cc86a91f5 100644 (file)
@@ -25,6 +25,7 @@
 #include <glibmm/threads.h>
 
 #include <jack/jack.h>
+#include <ltc.h>
 
 #include "pbd/signals.h"
 
 #include "midi++/parser.h"
 #include "midi++/types.h"
 
-#ifdef HAVE_LTC
-#include <ltc.h>
-#endif
 
-namespace MIDI {
-       class Port;
-}
+/* used for approximate_current_delta(): */
+#define PLUSMINUS(A) ( ((A)<0) ? "-" : (((A)>0) ? "+" : "\u00B1") )
+#define LEADINGZERO(A) ( (A)<10 ? "   " : (A)<100 ? "  " : (A)<1000 ? " " : "" )
 
 namespace ARDOUR {
 
 class TempoMap;
 class Session;
+class AudioEngine;
+class MidiPort;
 
 /**
  * @class Slave
@@ -171,6 +171,12 @@ class Slave {
         * @return - whether ARDOUR should use the slave speed without any adjustments
         */
        virtual bool give_slave_full_control_over_transport_speed() const { return false; }
+
+       /**
+        * @return - current time-delta between engine and sync-source
+        */
+       virtual std::string approximate_current_delta() const { return ""; }
+
 };
 
 /// We need this wrapper for testability, it's just too hard to mock up a session class
@@ -232,19 +238,22 @@ class TimecodeSlave : public Slave {
     virtual Timecode::TimecodeFormat apparent_timecode_format() const = 0;
 
     /* this is intended to be used by a UI and polled from a timeout. it should
-       return a string describing the current position of the TC source. it 
+       return a string describing the current position of the TC source. it
        should NOT do any computation, but should use a cached value
        of the TC source position.
     */
     virtual std::string approximate_current_position() const = 0;
+
+    framepos_t        timecode_offset;
+    bool              timecode_negative_offset;
 };
 
 class MTC_Slave : public TimecodeSlave {
   public:
-       MTC_Slave (Session&, MIDI::Port&);
+       MTC_Slave (Session&, MidiPort&);
        ~MTC_Slave ();
 
-       void rebind (MIDI::Port&);
+       void rebind (MidiPort&);
        bool speed_and_position (double&, framepos_t&);
 
        bool locked() const;
@@ -252,23 +261,26 @@ class MTC_Slave : public TimecodeSlave {
        void handle_locate (const MIDI::byte*);
 
        framecnt_t resolution () const;
-       bool requires_seekahead () const { return true; }
+       bool requires_seekahead () const { return false; }
        framecnt_t seekahead_distance() const;
        bool give_slave_full_control_over_transport_speed() const;
 
         Timecode::TimecodeFormat apparent_timecode_format() const;
         std::string approximate_current_position() const;
+       std::string approximate_current_delta() const;
 
   private:
        Session&    session;
-       MIDI::Port* port;
+       MidiPort*   port;
        PBD::ScopedConnectionList port_connections;
+       PBD::ScopedConnection     config_connection;
        bool        can_notify_on_unknown_rate;
 
        static const int frame_tolerance;
 
        SafeTime       current;
        framepos_t     mtc_frame;               /* current time */
+       double         mtc_frame_dll;
        framepos_t     last_inbound_frame;      /* when we got it; audio clocked */
        MIDI::byte     last_mtc_fps_byte;
        framepos_t     window_begin;
@@ -289,6 +301,7 @@ class MTC_Slave : public TimecodeSlave {
        Timecode::TimecodeFormat a3e_timecode;
        Timecode::Time timecode;
        bool           printed_timecode_warning;
+       frameoffset_t  current_delta;
 
        /* DLL - chase MTC */
        double t0; ///< time at the beginning of the MTC quater frame
@@ -315,9 +328,10 @@ class MTC_Slave : public TimecodeSlave {
        bool outside_window (framepos_t) const;
        void init_mtc_dll(framepos_t, double);
        void init_engine_dll (framepos_t, framepos_t);
+       void parse_timecode_offset();
+       void parameter_changed(std::string const & p);
 };
 
-#ifdef HAVE_LTC
 class LTC_Slave : public TimecodeSlave {
 public:
        LTC_Slave (Session&);
@@ -329,47 +343,72 @@ public:
        bool ok() const;
 
        framecnt_t resolution () const;
-       bool requires_seekahead () const { return true; }
-       framecnt_t seekahead_distance() const;
-       bool give_slave_full_control_over_transport_speed() const;
+       bool requires_seekahead () const { return false; }
+       framecnt_t seekahead_distance () const { return 0; }
+       bool give_slave_full_control_over_transport_speed() const { return true; }
 
-        Timecode::TimecodeFormat apparent_timecode_format() const;
-        std::string approximate_current_position() const;
+       Timecode::TimecodeFormat apparent_timecode_format() const;
+       std::string approximate_current_position() const;
+       std::string approximate_current_delta() const;
 
   private:
-       int parse_ltc(const jack_nframes_t, const jack_default_audio_sample_t * const, const framecnt_t);
-       bool process_ltc(framepos_t, framecnt_t);
-       void init_ltc_dll(framepos_t, double);
-
-       Session&    session;
-       bool        did_reset_tc_format;
+       void parse_ltc(const pframes_t, const Sample* const, const framecnt_t);
+       void process_ltc(framepos_t const);
+       void init_engine_dll (framepos_t, int32_t);
+       bool detect_discontinuity(LTCFrameExt *, int, bool);
+       bool detect_ltc_fps(int, bool);
+       bool equal_ltc_frame_time(LTCFrame *a, LTCFrame *b);
+       void reset();
+       void resync_xrun();
+       void resync_latency();
+       void parse_timecode_offset();
+       void parameter_changed(std::string const & p);
+
+       Session&       session;
+       bool           did_reset_tc_format;
        Timecode::TimecodeFormat saved_tc_format;
 
-       LTCDecoder *decoder;
-       double      frames_per_ltc_frame;
+       LTCDecoder *   decoder;
+       double         frames_per_ltc_frame;
+       Timecode::Time timecode;
+       LTCFrameExt    prev_frame;
+       bool           fps_detected;
+
+       framecnt_t     monotonic_cnt;
+       framecnt_t     last_timestamp;
+       framecnt_t     last_ltc_frame;
+       double         ltc_speed;
+       frameoffset_t  current_delta;
+       int            delayedlocked;
+
+       int            ltc_detect_fps_cnt;
+       int            ltc_detect_fps_max;
+       bool           printed_timecode_warning;
+       Timecode::TimecodeFormat ltc_timecode;
+       Timecode::TimecodeFormat a3e_timecode;
 
-       framecnt_t  last_timestamp;
-       framecnt_t  last_ltc_frame;
-       framepos_t  ltc_transport_pos;
-       double      ltc_speed;
+       PBD::ScopedConnectionList port_connections;
+       PBD::ScopedConnection     config_connection;
+        LatencyRange  ltc_slave_latency;
 
-       /* DLL - chase MTC */
+       /* DLL - chase LTC */
+       int    transport_direction;
+       int    engine_dll_initstate;
        double t0; ///< time at the beginning of the MTC quater frame
        double t1; ///< calculated end of the MTC quater frame
        double e2; ///< second order loop error
-       double b, c, omega; ///< DLL filter coefficients
+       double b, c; ///< DLL filter coefficients
 };
-#endif
 
 class MIDIClock_Slave : public Slave {
   public:
-       MIDIClock_Slave (Session&, MIDI::Port&, int ppqn = 24);
+       MIDIClock_Slave (Session&, MidiPort&, int ppqn = 24);
 
        /// Constructor for unit tests
        MIDIClock_Slave (ISlaveSessionProxy* session_proxy = 0, int ppqn = 24);
        ~MIDIClock_Slave ();
 
-       void rebind (MIDI::Port&);
+       void rebind (MidiPort&);
        bool speed_and_position (double&, framepos_t&);
 
        bool locked() const;
@@ -381,10 +420,10 @@ class MIDIClock_Slave : public Slave {
        bool give_slave_full_control_over_transport_speed() const { return true; }
 
        void set_bandwidth (double a_bandwith) { bandwidth = a_bandwith; }
+       std::string approximate_current_delta() const;
 
   protected:
        ISlaveSessionProxy* session;
-       MIDI::Port* port;
        PBD::ScopedConnectionList port_connections;
 
        /// pulses per quarter note for one MIDI clock frame (default 24)
@@ -424,6 +463,8 @@ class MIDIClock_Slave : public Slave {
        /// DLL filter coefficients
        double b, c, omega;
 
+       frameoffset_t  current_delta;
+
        void reset ();
        void start (MIDI::Parser& parser, framepos_t timestamp);
        void contineu (MIDI::Parser& parser, framepos_t timestamp);
@@ -445,11 +486,11 @@ class MIDIClock_Slave : public Slave {
        bool _starting;
 };
 
-class JACK_Slave : public Slave
+class Engine_Slave : public Slave
 {
   public:
-       JACK_Slave (jack_client_t*);
-       ~JACK_Slave ();
+       Engine_Slave (AudioEngine&);
+       ~Engine_Slave ();
 
        bool speed_and_position (double& speed, framepos_t& pos);
 
@@ -458,11 +499,10 @@ class JACK_Slave : public Slave
        bool ok() const;
        framecnt_t resolution () const { return 1; }
        bool requires_seekahead () const { return false; }
-       void reset_client (jack_client_t* jack);
        bool is_always_synced() const { return true; }
 
   private:
-       jack_client_t* jack;
+        AudioEngine& engine;
        double speed;
        bool _starting;
 };