X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=libs%2Fardour%2Fardour%2Fslave.h;h=ca3f618af1de1ed5363d6f971a12b73cc86a91f5;hb=848e75aaeaa04a81883ed30bcd04abd862f9d1fd;hp=dae0d80d109b2bbb5cc9919f8f4bf405ec69d50f;hpb=9dddffcc8ff4e7747c86844194f4041f8733a189;p=ardour.git diff --git a/libs/ardour/ardour/slave.h b/libs/ardour/ardour/slave.h index dae0d80d10..ca3f618af1 100644 --- a/libs/ardour/ardour/slave.h +++ b/libs/ardour/ardour/slave.h @@ -22,23 +22,30 @@ #include +#include + #include +#include + +#include "pbd/signals.h" + +#include "timecode/time.h" -#include #include "ardour/types.h" #include "midi++/parser.h" #include "midi++/types.h" -class PIController; -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 @@ -63,7 +70,7 @@ class Slave { * and after the method call they should * * Session::follow_slave will then try to follow the given - * position using a delay locked loop (DLL), + * position 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. @@ -109,7 +116,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 @@ -139,7 +146,7 @@ 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 seekahead_distance() before transport @@ -149,10 +156,10 @@ class Slave { /** * @return the number of frames that this slave wants to seek ahead. Relevant - * only if @func requires_seekahead() returns true. + * only if requires_seekahead() returns true. */ - virtual nframes64_t seekahead_distance() const { return 0; } + virtual framecnt_t seekahead_distance() const { return 0; } /** * @return - when returning true, ARDOUR will use transport speed 1.0 no matter what @@ -164,19 +171,26 @@ 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 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*/) {} @@ -190,108 +204,227 @@ 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 TimecodeSlave : public Slave { + public: + TimecodeSlave () {} + + 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 + 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 Slave, public sigc::trackable { +class MTC_Slave : public TimecodeSlave { public: - MTC_Slave (Session&, MIDI::Port&); + MTC_Slave (Session&, MidiPort&); ~MTC_Slave (); - void rebind (MIDI::Port&); - bool speed_and_position (double&, nframes64_t&); + void rebind (MidiPort&); + bool speed_and_position (double&, framepos_t&); bool locked() const; bool ok() const; void handle_locate (const MIDI::byte*); - nframes_t resolution() const; - bool requires_seekahead () const { return true; } - nframes64_t seekahead_distance() const; + framecnt_t resolution () const; + 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; - std::vector connections; + MidiPort* port; + PBD::ScopedConnectionList port_connections; + PBD::ScopedConnection config_connection; 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; - 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&, int, nframes_t); - void update_mtc_time (const MIDI::byte *, bool, nframes_t); + 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; + framepos_t window_end; + framepos_t first_mtc_timestamp; + bool did_reset_tc_format; + Timecode::TimecodeFormat saved_tc_format; + Glib::Threads::Mutex reset_lock; + uint32_t reset_pending; + bool reset_position; + int transport_direction; + int busy_guard1; + int busy_guard2; + + double speedup_due_to_tc_mismatch; + double quarter_frame_duration; + Timecode::TimecodeFormat mtc_timecode; + 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 + double t1; ///< calculated end of the MTC quater frame + double e2; ///< second order loop error + double b, c, omega; ///< DLL filter coefficients + + /* DLL - sync engine */ + int engine_dll_initstate; + double te0; ///< time at the beginning of the engine process + double te1; ///< calculated sync time + double ee2; ///< second order loop error + double be, ce, oe; ///< DLL filter coefficients + + 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; - void reset_window (nframes64_t); - bool outside_window (nframes64_t) const; - void process_apparent_speed (double); + void reset_window (framepos_t); + 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); }; -class MIDIClock_Slave : public Slave, public sigc::trackable { +class LTC_Slave : public TimecodeSlave { +public: + LTC_Slave (Session&); + ~LTC_Slave (); + + bool speed_and_position (double&, framepos_t&); + + bool locked() const; + bool ok() const; + + framecnt_t resolution () 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; + std::string approximate_current_delta() const; + + private: + 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; + 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; + + PBD::ScopedConnectionList port_connections; + PBD::ScopedConnection config_connection; + LatencyRange ltc_slave_latency; + + /* 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; ///< DLL filter coefficients +}; + +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, 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&); + void rebind (MidiPort&); + 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; } + std::string approximate_current_delta() const; - private: + protected: ISlaveSessionProxy* session; - MIDI::Port* port; - std::vector connections; + PBD::ScopedConnectionList port_connections; /// pulses per quarter note for one MIDI clock frame (default 24) int ppqn; @@ -300,10 +433,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) @@ -330,18 +463,20 @@ class MIDIClock_Slave : public Slave, public sigc::trackable { /// DLL filter coefficients double b, c, omega; + frameoffset_t current_delta; + 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; @@ -351,24 +486,23 @@ class MIDIClock_Slave : public Slave, public sigc::trackable { 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, 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; } private: - jack_client_t* jack; + AudioEngine& engine; double speed; bool _starting; };