#include <jack/jack.h>
#include <sigc++/signal.h>
-#include <ardour/ardour.h>
-#include <midi++/parser.h>
-#include <midi++/types.h>
+#include "ardour/types.h"
+#include "midi++/parser.h"
+#include "midi++/types.h"
namespace MIDI {
class Port;
}
namespace ARDOUR {
+
+class TempoMap;
class Session;
+/**
+ * @class Slave
+ *
+ * @brief The Slave interface can be used to sync ARDOURs tempo to an external source
+ * like MTC, MIDI Clock, etc.
+ *
+ * The name of the interface may be a bit misleading: A subclass of Slave actually
+ * acts as a time master for ARDOUR, that means ARDOUR will try to follow the
+ * speed and transport position of the implementation of Slave.
+ * Therefore it is rather that class, that makes ARDOUR a slave by connecting it
+ * to its external time master.
+ */
class Slave {
public:
Slave() { }
virtual ~Slave() {}
- virtual bool speed_and_position (float&, nframes_t&) = 0;
+ /**
+ * This is the most important function to implement:
+ * Each process cycle, Session::follow_slave will call this method.
+ * 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),
+ * 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.
+ * Although, a correct speed is important so that ARDOUR
+ * can sync to the master time source quickly.
+ *
+ * For background information on delay locked loops,
+ * see http://www.kokkinizita.net/papers/usingdll.pdf
+ *
+ * The method has the following precondition:
+ * <ul>
+ * <li>
+ * Slave::ok() should return true, otherwise playback will stop
+ * immediately and the method will not be called
+ * </li>
+ * <li>
+ * when the references speed and position are passed into the Slave
+ * they are uninitialized
+ * </li>
+ * </ul>
+ *
+ * After the method call the following postconditions should be met:
+ * <ul>
+ * <li>
+ * The first position value on transport start should be 0,
+ * otherwise ARDOUR will try to locate to the new position
+ * rather than move to it
+ * </li>
+ * <li>
+ * the references speed and position should be assigned
+ * to the Slaves current requested transport speed
+ * and transport position.
+ * </li>
+ * <li>
+ * Slave::resolution() should be greater than the maximum distance of
+ * ARDOURs transport position to the slaves requested transport position.
+ * </li>
+ * <li>Slave::locked() should return true, otherwise Session::no_roll will be called</li>
+ * <li>Slave::starting() should be false, otherwise the transport will not move until it becomes true</li> *
+ * </ul>
+ *
+ * @param speed - The transport speed requested
+ * @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;
+
+ /**
+ * reports to ARDOUR whether the Slave is currently synced to its external
+ * time source.
+ *
+ * @return - when returning false, the transport will stop rolling
+ */
virtual bool locked() const = 0;
+
+ /**
+ * reports to ARDOUR whether the slave is in a sane state
+ *
+ * @return - when returning false, the transport will be stopped and the slave
+ * disconnected from ARDOUR.
+ */
virtual bool ok() const = 0;
+
+ /**
+ * reports to ARDOUR whether the slave is in the process of starting
+ * to roll
+ *
+ * @return - when returning false, transport will not move until this method returns true
+ */
virtual bool starting() const { return false; }
+
+ /**
+ * @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;
+
+ /**
+ * @return - when returning true, ARDOUR will wait for one second before transport
+ * starts rolling
+ */
virtual bool requires_seekahead () const = 0;
+
+ /**
+ * @return - when returning true, ARDOUR will use transport speed 1.0 no matter what
+ * the slave returns
+ */
virtual bool is_always_synced() const { return false; }
+
+ /**
+ * @return - whether ARDOUR should use the slave speed without any adjustments
+ */
+ virtual bool give_slave_full_control_over_transport_speed() const { return false; }
+};
+
+/// 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 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 void request_locate (nframes_t /*frame*/, bool with_roll = false) {
+ (void) with_roll;
+ }
+ virtual void request_transport_speed (double /*speed*/) {}
+};
+
+
+/// The Session Proxy for use in real Ardour
+class SlaveSessionProxy : public ISlaveSessionProxy {
+ Session& session;
+
+ public:
+ SlaveSessionProxy(Session &s) : session(s) {}
+
+ TempoMap& tempo_map() const;
+ nframes_t frame_rate() const;
+ nframes_t audible_frame () const;
+ nframes_t transport_frame () const;
+ nframes_t frames_since_cycle_start () const;
+ nframes_t frame_time () const;
+
+ void request_locate (nframes_t frame, bool with_roll = false);
+ void request_transport_speed (double speed);
};
struct SafeTime {
nframes_t timestamp;
int guard2;
- SafeTime() {
- guard1 = 0;
- guard2 = 0;
- timestamp = 0;
- }
+ SafeTime() {
+ guard1 = 0;
+ guard2 = 0;
+ timestamp = 0;
+ }
};
class MTC_Slave : public Slave, public sigc::trackable {
~MTC_Slave ();
void rebind (MIDI::Port&);
- bool speed_and_position (float&, nframes_t&);
+ bool speed_and_position (double&, nframes_t&);
bool locked() const;
bool ok() const;
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;
- float mtc_speed;
+ double mtc_speed;
nframes_t first_mtc_frame;
nframes_t first_mtc_time;
static const int32_t accumulator_size = 128;
- float accumulator[accumulator_size];
+ double accumulator[accumulator_size];
int32_t accumulator_index;
bool have_first_accumulated_speed;
class MIDIClock_Slave : public Slave, public sigc::trackable {
public:
MIDIClock_Slave (Session&, MIDI::Port&, int ppqn = 24);
+
+ /// Constructor for unit tests
+ MIDIClock_Slave (ISlaveSessionProxy* session_proxy, int ppqn = 24);
~MIDIClock_Slave ();
void rebind (MIDI::Port&);
- bool speed_and_position (float&, nframes_t&);
+ bool speed_and_position (double&, nframes_t&);
bool locked() const;
bool ok() const;
- bool starting() const { return _starting; }
+ bool starting() const;
nframes_t resolution() const;
- bool requires_seekahead () const { return true; }
+ 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:
- Session& session;
+ ISlaveSessionProxy* session;
MIDI::Port* port;
std::vector<sigc::connection> connections;
+ /// pulses per quarter note for one MIDI clock frame (default 24)
int ppqn;
+
+ /// the duration of one ppqn in frame time
double one_ppqn_in_frames;
- SafeTime current;
- nframes_t midi_clock_frame; /* current time */
- nframes_t last_inbound_frame; /* when we got it; audio clocked */
+ /// the timestamp of the first MIDI clock message
+ nframes_t first_timestamp;
- float midi_clock_speed;
- nframes_t first_midi_clock_frame;
- nframes_t first_midi_clock_time;
+ /// the time stamp and should-be transport position of the last inbound MIDI clock message
+ nframes_t last_timestamp;
+ double should_be_position;
- static const int32_t accumulator_size = 128;
- float accumulator[accumulator_size];
- int32_t accumulator_index;
- bool have_first_accumulated_speed;
+ /// the number of midi clock messages received (zero-based)
+ /// since start
+ long midi_clock_count;
+
+ //the delay locked loop (DLL), see www.kokkinizita.net/papers/usingdll.pdf
+
+ /// time at the beginning of the MIDI clock frame
+ double t0;
+
+ /// calculated end of the MIDI clock frame
+ double t1;
+
+ /// loop error = real value - expected value
+ double e;
+
+ /// second order loop error
+ double e2;
+
+ /// DLL filter bandwidth
+ double bandwidth;
+
+ /// DLL filter coefficients
+ double b, c, omega;
void reset ();
- void start (MIDI::Parser& parser);
- void stop (MIDI::Parser& parser);
- void update_midi_clock (MIDI::Parser& parser);
+ 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 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_filter_coefficients();
+ void update_midi_clock (MIDI::Parser& parser, nframes_t timestamp);
void read_current (SafeTime *) const;
- bool _starting;
+ bool stop_if_no_more_clock_events(nframes_t& pos, nframes_t now);
+
+ /// whether transport should be rolling
bool _started;
+
+ /// is true if the MIDI Start message has just been received until
+ /// the first MIDI Clock Event
+ bool _starting;
};
class ADAT_Slave : public Slave
ADAT_Slave () {}
~ADAT_Slave () {}
- bool speed_and_position (float& speed, nframes_t& pos) {
+ bool speed_and_position (double& speed, nframes_t& pos) {
speed = 0;
pos = 0;
return false;
JACK_Slave (jack_client_t*);
~JACK_Slave ();
- bool speed_and_position (float& speed, nframes_t& pos);
+ bool speed_and_position (double& speed, nframes_t& pos);
bool starting() const { return _starting; }
bool locked() const;
private:
jack_client_t* jack;
- float speed;
+ double speed;
bool _starting;
};
projects / ardour.git / blobdiff