In export format dialog, show preview of generated part of description. Fix to #0004941
[ardour.git] / libs / ardour / ardour / slave.h
index 672d72f7e2f0b3838e119c7595a5206cfbb6c3ed..a487824e519262c6b539049d258d33102e5348e1 100644 (file)
 
 #include <vector>
 
+#include <glibmm/thread.h>
+
 #include <jack/jack.h>
 
-#include <sigc++/signal.h>
+#include "pbd/signals.h"
+
 #include "ardour/types.h"
 #include "midi++/parser.h"
 #include "midi++/types.h"
 
+class PIChaser;
+
 namespace MIDI {
        class Port;
 }
@@ -61,7 +66,7 @@ class Slave {
         *  and after the method call they should
         *
         * Session::follow_slave will then try to follow the given
-        * <emph>position</emph> using a delay locked loop (DLL),
+        * <em>position</em> using a delay locked loop (DLL),
         * starting with the first given transport speed.
         * If the values of speed and position contradict each other,
         * ARDOUR will always follow the position and disregard the speed.
@@ -107,7 +112,7 @@ class Slave {
         * @param position - The transport position requested
         * @return - The return value is currently ignored (see Session::follow_slave)
         */
-       virtual bool speed_and_position (double& speed, nframes64_t& position) = 0;
+       virtual bool speed_and_position (double& speed, framepos_t& position) = 0;
 
        /**
         * reports to ARDOUR whether the Slave is currently synced to its external
@@ -137,14 +142,21 @@ class Slave {
         * @return - the timing resolution of the Slave - If the distance of ARDOURs transport
         * to the slave becomes greater than the resolution, sound will stop
         */
-       virtual nframes_t resolution() const = 0;
+       virtual framecnt_t resolution() const = 0;
 
        /**
-        * @return - when returning true, ARDOUR will wait for one second before transport
+        * @return - when returning true, ARDOUR will wait for seekahead_distance() before transport
         * starts rolling
         */
        virtual bool requires_seekahead () const = 0;
 
+       /**
+        * @return the number of frames that this slave wants to seek ahead. Relevant
+        * only if requires_seekahead() returns true.
+        */
+
+       virtual framecnt_t seekahead_distance() const { return 0; }
+
        /**
         * @return - when returning true, ARDOUR will use transport speed 1.0 no matter what
         *           the slave returns
@@ -160,14 +172,15 @@ class Slave {
 /// We need this wrapper for testability, it's just too hard to mock up a session class
 class ISlaveSessionProxy {
   public:
-       virtual TempoMap& tempo_map()                 const   { return *((TempoMap *) 0); }
-       virtual nframes_t   frame_rate()                const   { return 0; }
-       virtual nframes64_t audible_frame ()            const   { return 0; }
-       virtual nframes64_t transport_frame ()          const   { return 0; }
-       virtual nframes_t   frames_since_cycle_start () const   { return 0; }
-       virtual nframes64_t frame_time ()               const   { return 0; }
-
-       virtual void request_locate (nframes64_t /*frame*/, bool with_roll = false) {
+       virtual ~ISlaveSessionProxy() {}
+       virtual TempoMap&  tempo_map()                 const   { return *((TempoMap *) 0); }
+       virtual framecnt_t frame_rate()                const   { return 0; }
+       virtual framepos_t audible_frame ()            const   { return 0; }
+       virtual framepos_t transport_frame ()          const   { return 0; }
+       virtual pframes_t  frames_since_cycle_start () const   { return 0; }
+       virtual framepos_t frame_time ()               const   { return 0; }
+
+       virtual void request_locate (framepos_t /*frame*/, bool with_roll = false) {
                (void) with_roll;
        }
        virtual void request_transport_speed (double /*speed*/)                   {}
@@ -181,98 +194,116 @@ class SlaveSessionProxy : public ISlaveSessionProxy {
   public:
        SlaveSessionProxy(Session &s) : session(s) {}
 
-       TempoMap&   tempo_map()                 const;
-       nframes_t   frame_rate()                const;
-       nframes64_t audible_frame ()            const;
-       nframes64_t transport_frame ()          const;
-       nframes_t   frames_since_cycle_start () const;
-       nframes64_t frame_time ()               const;
+       TempoMap&  tempo_map()                 const;
+       framecnt_t frame_rate()                const;
+       framepos_t audible_frame ()            const;
+       framepos_t transport_frame ()          const;
+       pframes_t  frames_since_cycle_start () const;
+       framepos_t frame_time ()               const;
 
-       void request_locate (nframes64_t frame, bool with_roll = false);
+       void request_locate (framepos_t frame, bool with_roll = false);
        void request_transport_speed (double speed);
 };
 
 struct SafeTime {
-    volatile int guard1;
-    nframes64_t  position;
-    nframes64_t  timestamp;
-    double       speed;
-    volatile int guard2;
-    
-    SafeTime() {
-           guard1 = 0;
-           position = 0;
-           timestamp = 0;
-           speed = 0;
-           guard2 = 0;
-    }
+       volatile int guard1;
+       framepos_t   position;
+       framepos_t   timestamp;
+       double       speed;
+       volatile int guard2;
+
+       SafeTime() {
+               guard1 = 0;
+               position = 0;
+               timestamp = 0;
+               speed = 0;
+               guard2 = 0;
+       }
 };
 
-class MTC_Slave : public Slave, public sigc::trackable {
+class MTC_Slave : public Slave {
   public:
        MTC_Slave (Session&, MIDI::Port&);
        ~MTC_Slave ();
 
        void rebind (MIDI::Port&);
-       bool speed_and_position (double&, nframes64_t&);
+       bool speed_and_position (double&, framepos_t&);
 
        bool locked() const;
        bool ok() const;
        void handle_locate (const MIDI::byte*);
 
-       nframes_t resolution() 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;
 
   private:
        Session&    session;
        MIDI::Port* port;
-       std::vector<sigc::connection> connections;
+       PBD::ScopedConnectionList port_connections;
        bool        can_notify_on_unknown_rate;
-       
-       SafeTime    current;
-       double      instantaneous_speed;
-       nframes_t   mtc_frame;               /* current time */
-       nframes_t   last_inbound_frame;      /* when we got it; audio clocked */
-       MIDI::byte  last_mtc_fps_byte;
-
-       static const int32_t accumulator_size = 128;
-       double   accumulator[accumulator_size];
-       int32_t accumulator_index;
-       bool    have_first_accumulated_speed;
-
-       void reset ();
-       void update_mtc_qtr (MIDI::Parser&);
-       void update_mtc_time (const MIDI::byte *, bool);
-       void update_mtc_status (MIDI::Parser::MTC_Status);
+       PIChaser* pic;
+
+       static const int frame_tolerance;
+
+       SafeTime       current;
+       framepos_t     mtc_frame;               /* current time */
+       framepos_t     last_inbound_frame;      /* when we got it; audio clocked */
+       MIDI::byte     last_mtc_fps_byte;
+       framepos_t     window_begin;
+       framepos_t     window_end;
+       framepos_t     last_mtc_timestamp;
+       framepos_t     last_mtc_frame;
+       bool           did_reset_tc_format;
+       TimecodeFormat saved_tc_format;
+       size_t         speed_accumulator_size;
+       double*        speed_accumulator;
+       size_t         speed_accumulator_cnt;
+       bool           have_first_speed_accumulator;
+       double         average_speed;
+       Glib::Mutex    reset_lock;
+       uint32_t       reset_pending;
+       bool           reset_position;
+
+       void reset (bool with_pos);
+       void queue_reset (bool with_pos);
+       void maybe_reset ();
+
+       void update_mtc_qtr (MIDI::Parser&, int, framepos_t);
+       void update_mtc_time (const MIDI::byte *, bool, framepos_t);
+       void update_mtc_status (MIDI::MTC_Status);
        void read_current (SafeTime *) const;
-       double compute_apparent_speed (nframes64_t);
+       void reset_window (framepos_t);
+       bool outside_window (framepos_t) const;
+       void process_apparent_speed (double);
 };
 
-class MIDIClock_Slave : public Slave, public sigc::trackable {
+class MIDIClock_Slave : public Slave {
   public:
        MIDIClock_Slave (Session&, MIDI::Port&, int ppqn = 24);
 
        /// Constructor for unit tests
-       MIDIClock_Slave (ISlaveSessionProxy* session_proxy, int ppqn = 24);
+       MIDIClock_Slave (ISlaveSessionProxy* session_proxy = 0, int ppqn = 24);
        ~MIDIClock_Slave ();
 
        void rebind (MIDI::Port&);
-       bool speed_and_position (double&, nframes64_t&);
+       bool speed_and_position (double&, framepos_t&);
 
        bool locked() const;
        bool ok() const;
        bool starting() const;
 
-       nframes_t resolution() const;
+       framecnt_t resolution () const;
        bool requires_seekahead () const { return false; }
        bool give_slave_full_control_over_transport_speed() const { return true; }
 
        void set_bandwidth (double a_bandwith) { bandwidth = a_bandwith; }
 
-  private:
+  protected:
        ISlaveSessionProxy* session;
        MIDI::Port* port;
-       std::vector<sigc::connection> connections;
+       PBD::ScopedConnectionList port_connections;
 
        /// pulses per quarter note for one MIDI clock frame (default 24)
        int         ppqn;
@@ -281,10 +312,10 @@ class MIDIClock_Slave : public Slave, public sigc::trackable {
        double      one_ppqn_in_frames;
 
        /// the timestamp of the first MIDI clock message
-       nframes_t   first_timestamp;
+       framepos_t  first_timestamp;
 
        /// the time stamp and should-be transport position of the last inbound MIDI clock message
-       nframes_t   last_timestamp;
+       framepos_t  last_timestamp;
        double      should_be_position;
 
        /// the number of midi clock messages received (zero-based)
@@ -312,17 +343,17 @@ class MIDIClock_Slave : public Slave, public sigc::trackable {
        double b, c, omega;
 
        void reset ();
-       void start (MIDI::Parser& parser, nframes64_t timestamp);
-       void contineu (MIDI::Parser& parser, nframes64_t timestamp);
-       void stop (MIDI::Parser& parser, nframes64_t timestamp);
+       void start (MIDI::Parser& parser, framepos_t timestamp);
+       void contineu (MIDI::Parser& parser, framepos_t timestamp);
+       void stop (MIDI::Parser& parser, framepos_t timestamp);
        void position (MIDI::Parser& parser, MIDI::byte* message, size_t size);
        // we can't use continue because it is a C++ keyword
-       void calculate_one_ppqn_in_frames_at(nframes64_t time);
-       nframes64_t calculate_song_position(uint16_t song_position_in_sixteenth_notes);
+       void calculate_one_ppqn_in_frames_at(framepos_t time);
+       framepos_t calculate_song_position(uint16_t song_position_in_sixteenth_notes);
        void calculate_filter_coefficients();
-       void update_midi_clock (MIDI::Parser& parser, nframes64_t timestamp);
+       void update_midi_clock (MIDI::Parser& parser, framepos_t timestamp);
        void read_current (SafeTime *) const;
-       bool stop_if_no_more_clock_events(nframes64_t& pos, nframes64_t now);
+       bool stop_if_no_more_clock_events(framepos_t& pos, framepos_t now);
 
        /// whether transport should be rolling
        bool _started;
@@ -332,36 +363,18 @@ class MIDIClock_Slave : public Slave, public sigc::trackable {
        bool _starting;
 };
 
-class ADAT_Slave : public Slave
-{
-  public:
-       ADAT_Slave () {}
-       ~ADAT_Slave () {}
-
-       bool speed_and_position (double& speed, nframes64_t& pos) {
-               speed = 0;
-               pos = 0;
-               return false;
-       }
-
-       bool locked() const { return false; }
-       bool ok() const { return false; }
-       nframes_t resolution() const { return 1; }
-       bool requires_seekahead () const { return true; }
-};
-
 class JACK_Slave : public Slave
 {
   public:
        JACK_Slave (jack_client_t*);
        ~JACK_Slave ();
 
-       bool speed_and_position (double& speed, nframes64_t& pos);
+       bool speed_and_position (double& speed, framepos_t& pos);
 
        bool starting() const { return _starting; }
        bool locked() const;
        bool ok() const;
-       nframes_t resolution() const { return 1; }
+       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; }