more MTC stuff, including toggleable use of torben's PI controller
[ardour.git] / libs / ardour / ardour / slave.h
index 64e350ae9c12e469b259d9c26f50263555740c02..dae0d80d109b2bbb5cc9919f8f4bf405ec69d50f 100644 (file)
 #include <jack/jack.h>
 
 #include <sigc++/signal.h>
-#include "ardour/ardour.h"
-#include "ardour/session.h"
-#include "ardour/audioengine.h"
+#include "ardour/types.h"
 #include "midi++/parser.h"
 #include "midi++/types.h"
 
+class PIController;
+
 namespace MIDI {
        class Port;
 }
 
 namespace ARDOUR {
+
+class TempoMap;
+class Session;
+
 /**
  * @class Slave
  *
@@ -105,7 +109,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, nframes_t& position) = 0;
+       virtual bool speed_and_position (double& speed, nframes64_t& position) = 0;
 
        /**
         * reports to ARDOUR whether the Slave is currently synced to its external
@@ -138,11 +142,18 @@ class Slave {
        virtual nframes_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 @func requires_seekahead() returns true.
+        */
+
+       virtual nframes64_t seekahead_distance() const { return 0; }
+
        /**
         * @return - when returning true, ARDOUR will use transport speed 1.0 no matter what
         *           the slave returns
@@ -159,13 +170,13 @@ class Slave {
 class ISlaveSessionProxy {
   public:
        virtual TempoMap& tempo_map()                 const   { return *((TempoMap *) 0); }
-       virtual nframes_t frame_rate()                const   { return 0; }
-       virtual nframes_t audible_frame ()            const   { return 0; }
-       virtual nframes_t transport_frame ()          const   { return 0; }
-       virtual nframes_t frames_since_cycle_start () const   { return 0; }
-       virtual nframes_t frame_time ()               const   { return 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 (nframes_t /*frame*/, bool with_roll = false) {
+       virtual void request_locate (nframes64_t /*frame*/, bool with_roll = false) {
                (void) with_roll;
        }
        virtual void request_transport_speed (double /*speed*/)                   {}
@@ -177,29 +188,33 @@ class SlaveSessionProxy : public ISlaveSessionProxy {
        Session&    session;
 
   public:
-       SlaveSessionProxy(Session &s) : session(s) {};
-       TempoMap& tempo_map()                 const   { return session.tempo_map();                         }
-       nframes_t frame_rate()                const   { return session.frame_rate();                        }
-       nframes_t audible_frame ()            const   { return session.audible_frame();                     }
-       nframes_t transport_frame ()          const   { return session.transport_frame();                   }
-       nframes_t frames_since_cycle_start () const   { return session.engine().frames_since_cycle_start(); }
-       nframes_t frame_time ()               const   { return session.engine().frame_time();               }
-
-       void request_locate (nframes_t frame, bool with_roll = false) { session.request_locate(frame, with_roll); }
-       void request_transport_speed (double speed)                   { session.request_transport_speed(speed);   }
+       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;
+
+       void request_locate (nframes64_t frame, bool with_roll = false);
+       void request_transport_speed (double speed);
 };
 
 struct SafeTime {
-    int guard1;
-    nframes_t   position;
-    nframes_t   timestamp;
-    int guard2;
-
-       SafeTime() {
-               guard1 = 0;
-               guard2 = 0;
-               timestamp = 0;
-       }
+    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;
+    }
 };
 
 class MTC_Slave : public Slave, public sigc::trackable {
@@ -208,7 +223,7 @@ class MTC_Slave : public Slave, public sigc::trackable {
        ~MTC_Slave ();
 
        void rebind (MIDI::Port&);
-       bool speed_and_position (double&, nframes_t&);
+       bool speed_and_position (double&, nframes64_t&);
 
        bool locked() const;
        bool ok() const;
@@ -216,32 +231,40 @@ class MTC_Slave : public Slave, public sigc::trackable {
 
        nframes_t resolution() const;
        bool requires_seekahead () const { return true; }
+       nframes64_t seekahead_distance() const;
+       bool give_slave_full_control_over_transport_speed() const;
 
   private:
        Session&    session;
        MIDI::Port* port;
        std::vector<sigc::connection> connections;
        bool        can_notify_on_unknown_rate;
+       PIController* pic;
 
        SafeTime    current;
        nframes_t   mtc_frame;               /* current time */
        nframes_t   last_inbound_frame;      /* when we got it; audio clocked */
        MIDI::byte  last_mtc_fps_byte;
-
-       double      mtc_speed;
-       nframes_t   first_mtc_frame;
-       nframes_t   first_mtc_time;
-
-       static const int32_t accumulator_size = 128;
-       double   accumulator[accumulator_size];
-       int32_t accumulator_index;
-       bool    have_first_accumulated_speed;
+       nframes64_t window_begin;
+       nframes64_t window_end;
+       nframes64_t    last_mtc_timestamp;
+       nframes64_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;
 
        void reset ();
-       void update_mtc_qtr (MIDI::Parser&);
-       void update_mtc_time (const MIDI::byte *, bool);
-       void update_mtc_status (MIDI::Parser::MTC_Status);
+       void update_mtc_qtr (MIDI::Parser&, int, nframes_t);
+       void update_mtc_time (const MIDI::byte *, bool, nframes_t);
+       void update_mtc_status (MIDI::MTC_Status);
        void read_current (SafeTime *) const;
+       void reset_window (nframes64_t);
+       bool outside_window (nframes64_t) const;
+       void process_apparent_speed (double);
 };
 
 class MIDIClock_Slave : public Slave, public sigc::trackable {
@@ -253,7 +276,7 @@ class MIDIClock_Slave : public Slave, public sigc::trackable {
        ~MIDIClock_Slave ();
 
        void rebind (MIDI::Port&);
-       bool speed_and_position (double&, nframes_t&);
+       bool speed_and_position (double&, nframes64_t&);
 
        bool locked() const;
        bool ok() const;
@@ -308,17 +331,17 @@ class MIDIClock_Slave : public Slave, public sigc::trackable {
        double b, c, omega;
 
        void reset ();
-       void start (MIDI::Parser& parser, nframes_t timestamp);
-       void contineu (MIDI::Parser& parser, nframes_t timestamp);
-       void stop (MIDI::Parser& parser, nframes_t timestamp);
+       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 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(nframes_t time);
-       nframes_t calculate_song_position(uint16_t song_position_in_sixteenth_notes);
+       void calculate_one_ppqn_in_frames_at(nframes64_t time);
+       nframes64_t calculate_song_position(uint16_t song_position_in_sixteenth_notes);
        void calculate_filter_coefficients();
-       void update_midi_clock (MIDI::Parser& parser, nframes_t timestamp);
+       void update_midi_clock (MIDI::Parser& parser, nframes64_t timestamp);
        void read_current (SafeTime *) const;
-       bool stop_if_no_more_clock_events(nframes_t& pos, nframes_t now);
+       bool stop_if_no_more_clock_events(nframes64_t& pos, nframes64_t now);
 
        /// whether transport should be rolling
        bool _started;
@@ -328,31 +351,13 @@ 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, nframes_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, nframes_t& pos);
+       bool speed_and_position (double& speed, nframes64_t& pos);
 
        bool starting() const { return _starting; }
        bool locked() const;