libs/ardour/ardour/slave.h

   1 /*
   2     Copyright (C) 2002 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef __ardour_slave_h__
  21 #define __ardour_slave_h__
  22
  23 #include <vector>
  24
  25 #include <glibmm/threads.h>
  26
  27 #include <jack/jack.h>
  28
  29 #include "pbd/signals.h"
  30
  31 #include "timecode/time.h"
  32
  33 #include "ardour/types.h"
  34 #include "midi++/parser.h"
  35 #include "midi++/types.h"
  36
  37 #ifdef HAVE_LTC
  38 #include <ltc.h>
  39 #endif
  40
  41 // used for approximate_current_delta():
  42 #define PLUSMINUS(A) ( ((A)<0) ? "\u2012" : (((A)>0) ? "+" : "\u00B1") )
  43
  44 namespace MIDI {
  45         class Port;
  46 }
  47
  48 namespace ARDOUR {
  49
  50 class TempoMap;
  51 class Session;
  52
  53 /**
  54  * @class Slave
  55  *
  56  * @brief The Slave interface can be used to sync ARDOURs tempo to an external source
  57  * like MTC, MIDI Clock, etc.
  58  *
  59  * The name of the interface may be a bit misleading: A subclass of Slave actually
  60  * acts as a time master for ARDOUR, that means ARDOUR will try to follow the
  61  * speed and transport position of the implementation of Slave.
  62  * Therefore it is rather that class, that makes ARDOUR a slave by connecting it
  63  * to its external time master.
  64  */
  65 class Slave {
  66   public:
  67         Slave() { }
  68         virtual ~Slave() {}
  69
  70         /**
  71          * This is the most important function to implement:
  72          * Each process cycle, Session::follow_slave will call this method.
  73          *  and after the method call they should
  74          *
  75          * Session::follow_slave will then try to follow the given
  76          * <em>position</em> using a delay locked loop (DLL),
  77          * starting with the first given transport speed.
  78          * If the values of speed and position contradict each other,
  79          * ARDOUR will always follow the position and disregard the speed.
  80          * Although, a correct speed is important so that ARDOUR
  81          * can sync to the master time source quickly.
  82          *
  83          * For background information on delay locked loops,
  84          * see http://www.kokkinizita.net/papers/usingdll.pdf
  85          *
  86          * The method has the following precondition:
  87          * <ul>
  88          *   <li>
  89          *       Slave::ok() should return true, otherwise playback will stop
  90          *       immediately and the method will not be called
  91          *   </li>
  92          *   <li>
  93          *     when the references speed and position are passed into the Slave
  94          *     they are uninitialized
  95          *   </li>
  96          * </ul>
  97          *
  98          * After the method call the following postconditions should be met:
  99          * <ul>
 100          *    <li>
 101          *       The first position value on transport start should be 0,
 102          *       otherwise ARDOUR will try to locate to the new position
 103          *       rather than move to it
 104          *    </li>
 105          *    <li>
 106          *      the references speed and position should be assigned
 107          *      to the Slaves current requested transport speed
 108          *      and transport position.
 109          *    </li>
 110          *   <li>
 111          *     Slave::resolution() should be greater than the maximum distance of
 112          *     ARDOURs transport position to the slaves requested transport position.
 113          *   </li>
 114          *   <li>Slave::locked() should return true, otherwise Session::no_roll will be called</li>
 115          *   <li>Slave::starting() should be false, otherwise the transport will not move until it becomes true</li>     *
 116          * </ul>
 117          *
 118          * @param speed - The transport speed requested
 119          * @param position - The transport position requested
 120          * @return - The return value is currently ignored (see Session::follow_slave)
 121          */
 122         virtual bool speed_and_position (double& speed, framepos_t& position) = 0;
 123
 124         /**
 125          * reports to ARDOUR whether the Slave is currently synced to its external
 126          * time source.
 127          *
 128          * @return - when returning false, the transport will stop rolling
 129          */
 130         virtual bool locked() const = 0;
 131
 132         /**
 133          * reports to ARDOUR whether the slave is in a sane state
 134          *
 135          * @return - when returning false, the transport will be stopped and the slave
 136          * disconnected from ARDOUR.
 137          */
 138         virtual bool ok() const = 0;
 139
 140         /**
 141          * reports to ARDOUR whether the slave is in the process of starting
 142          * to roll
 143          *
 144          * @return - when returning false, transport will not move until this method returns true
 145          */
 146         virtual bool starting() const { return false; }
 147
 148         /**
 149          * @return - the timing resolution of the Slave - If the distance of ARDOURs transport
 150          * to the slave becomes greater than the resolution, sound will stop
 151          */
 152         virtual framecnt_t resolution() const = 0;
 153
 154         /**
 155          * @return - when returning true, ARDOUR will wait for seekahead_distance() before transport
 156          * starts rolling
 157          */
 158         virtual bool requires_seekahead () const = 0;
 159
 160         /**
 161          * @return the number of frames that this slave wants to seek ahead. Relevant
 162          * only if requires_seekahead() returns true.
 163          */
 164
 165         virtual framecnt_t seekahead_distance() const { return 0; }
 166
 167         /**
 168          * @return - when returning true, ARDOUR will use transport speed 1.0 no matter what
 169          *           the slave returns
 170          */
 171         virtual bool is_always_synced() const { return false; }
 172
 173         /**
 174          * @return - whether ARDOUR should use the slave speed without any adjustments
 175          */
 176         virtual bool give_slave_full_control_over_transport_speed() const { return false; }
 177
 178         /**
 179          * @return - current time-delta between engine and sync-source
 180          */
 181         virtual std::string approximate_current_delta() const { return ""; }
 182
 183 };
 184
 185 /// We need this wrapper for testability, it's just too hard to mock up a session class
 186 class ISlaveSessionProxy {
 187   public:
 188         virtual ~ISlaveSessionProxy() {}
 189         virtual TempoMap&  tempo_map()                 const   { return *((TempoMap *) 0); }
 190         virtual framecnt_t frame_rate()                const   { return 0; }
 191         virtual framepos_t audible_frame ()            const   { return 0; }
 192         virtual framepos_t transport_frame ()          const   { return 0; }
 193         virtual pframes_t  frames_since_cycle_start () const   { return 0; }
 194         virtual framepos_t frame_time ()               const   { return 0; }
 195
 196         virtual void request_locate (framepos_t /*frame*/, bool with_roll = false) {
 197                 (void) with_roll;
 198         }
 199         virtual void request_transport_speed (double /*speed*/)                   {}
 200 };
 201
 202
 203 /// The Session Proxy for use in real Ardour
 204 class SlaveSessionProxy : public ISlaveSessionProxy {
 205         Session&    session;
 206
 207   public:
 208         SlaveSessionProxy(Session &s) : session(s) {}
 209
 210         TempoMap&  tempo_map()                 const;
 211         framecnt_t frame_rate()                const;
 212         framepos_t audible_frame ()            const;
 213         framepos_t transport_frame ()          const;
 214         pframes_t  frames_since_cycle_start () const;
 215         framepos_t frame_time ()               const;
 216
 217         void request_locate (framepos_t frame, bool with_roll = false);
 218         void request_transport_speed (double speed);
 219 };
 220
 221 struct SafeTime {
 222         volatile int guard1;
 223         framepos_t   position;
 224         framepos_t   timestamp;
 225         double       speed;
 226         volatile int guard2;
 227
 228         SafeTime() {
 229                 guard1 = 0;
 230                 position = 0;
 231                 timestamp = 0;
 232                 speed = 0;
 233                 guard2 = 0;
 234         }
 235 };
 236
 237 class TimecodeSlave : public Slave {
 238   public:
 239     TimecodeSlave () {}
 240
 241     virtual Timecode::TimecodeFormat apparent_timecode_format() const = 0;
 242
 243     /* this is intended to be used by a UI and polled from a timeout. it should
 244        return a string describing the current position of the TC source. it
 245        should NOT do any computation, but should use a cached value
 246        of the TC source position.
 247     */
 248     virtual std::string approximate_current_position() const = 0;
 249 };
 250
 251 class MTC_Slave : public TimecodeSlave {
 252   public:
 253         MTC_Slave (Session&, MIDI::Port&);
 254         ~MTC_Slave ();
 255
 256         void rebind (MIDI::Port&);
 257         bool speed_and_position (double&, framepos_t&);
 258
 259         bool locked() const;
 260         bool ok() const;
 261         void handle_locate (const MIDI::byte*);
 262
 263         framecnt_t resolution () const;
 264         bool requires_seekahead () const { return true; }
 265         framecnt_t seekahead_distance() const;
 266         bool give_slave_full_control_over_transport_speed() const;
 267
 268         Timecode::TimecodeFormat apparent_timecode_format() const;
 269         std::string approximate_current_position() const;
 270         std::string approximate_current_delta() const;
 271
 272   private:
 273         Session&    session;
 274         MIDI::Port* port;
 275         PBD::ScopedConnectionList port_connections;
 276         bool        can_notify_on_unknown_rate;
 277
 278         static const int frame_tolerance;
 279
 280         SafeTime       current;
 281         framepos_t     mtc_frame;               /* current time */
 282         framepos_t     last_inbound_frame;      /* when we got it; audio clocked */
 283         MIDI::byte     last_mtc_fps_byte;
 284         framepos_t     window_begin;
 285         framepos_t     window_end;
 286         framepos_t     first_mtc_timestamp;
 287         bool           did_reset_tc_format;
 288         Timecode::TimecodeFormat saved_tc_format;
 289         Glib::Threads::Mutex    reset_lock;
 290         uint32_t       reset_pending;
 291         bool           reset_position;
 292         int            transport_direction;
 293         int            busy_guard1;
 294         int            busy_guard2;
 295
 296         double         speedup_due_to_tc_mismatch;
 297         double         quarter_frame_duration;
 298         Timecode::TimecodeFormat mtc_timecode;
 299         Timecode::TimecodeFormat a3e_timecode;
 300         Timecode::Time timecode;
 301         bool           printed_timecode_warning;
 302         frameoffset_t  current_delta;
 303
 304         /* DLL - chase MTC */
 305         double t0; ///< time at the beginning of the MTC quater frame
 306         double t1; ///< calculated end of the MTC quater frame
 307         double e2; ///< second order loop error
 308         double b, c, omega; ///< DLL filter coefficients
 309
 310         /* DLL - sync engine */
 311         int    engine_dll_initstate;
 312         double te0; ///< time at the beginning of the engine process
 313         double te1; ///< calculated sync time
 314         double ee2; ///< second order loop error
 315         double be, ce, oe; ///< DLL filter coefficients
 316
 317         void reset (bool with_pos);
 318         void queue_reset (bool with_pos);
 319         void maybe_reset ();
 320
 321         void update_mtc_qtr (MIDI::Parser&, int, framepos_t);
 322         void update_mtc_time (const MIDI::byte *, bool, framepos_t);
 323         void update_mtc_status (MIDI::MTC_Status);
 324         void read_current (SafeTime *) const;
 325         void reset_window (framepos_t);
 326         bool outside_window (framepos_t) const;
 327         void init_mtc_dll(framepos_t, double);
 328         void init_engine_dll (framepos_t, framepos_t);
 329 };
 330
 331 #ifdef HAVE_LTC
 332 class LTC_Slave : public TimecodeSlave {
 333 public:
 334         LTC_Slave (Session&);
 335         ~LTC_Slave ();
 336
 337         bool speed_and_position (double&, framepos_t&);
 338
 339         bool locked() const;
 340         bool ok() const;
 341
 342         framecnt_t resolution () const;
 343         bool requires_seekahead () const { return false; }
 344         framecnt_t seekahead_distance () const { return 0; }
 345         bool give_slave_full_control_over_transport_speed() const { return true; }
 346
 347         Timecode::TimecodeFormat apparent_timecode_format() const;
 348         std::string approximate_current_position() const;
 349         std::string approximate_current_delta() const;
 350
 351   private:
 352         void parse_ltc(const jack_nframes_t, const jack_default_audio_sample_t * const, const framecnt_t);
 353         void process_ltc(framepos_t const);
 354         void init_engine_dll (framepos_t, int32_t);
 355         bool detect_discontinuity(LTCFrameExt *, int, bool);
 356         bool detect_ltc_fps(int, bool);
 357         bool equal_ltc_frame_time(LTCFrame *a, LTCFrame *b);
 358         void reset();
 359
 360         Session&       session;
 361         bool           did_reset_tc_format;
 362         Timecode::TimecodeFormat saved_tc_format;
 363
 364         LTCDecoder *   decoder;
 365         double         frames_per_ltc_frame;
 366         Timecode::Time timecode;
 367         LTCFrameExt    prev_frame;
 368         bool           fps_detected;
 369
 370         framecnt_t     monotonic_cnt;
 371         framecnt_t     last_timestamp;
 372         framecnt_t     last_ltc_frame;
 373         double         ltc_speed;
 374         frameoffset_t  current_delta;
 375         int            delayedlocked;
 376
 377         int            ltc_detect_fps_cnt;
 378         int            ltc_detect_fps_max;
 379         bool           printed_timecode_warning;
 380         Timecode::TimecodeFormat ltc_timecode;
 381         Timecode::TimecodeFormat a3e_timecode;
 382
 383         /* DLL - chase LTC */
 384         int    transport_direction;
 385         int    engine_dll_initstate;
 386         double t0; ///< time at the beginning of the MTC quater frame
 387         double t1; ///< calculated end of the MTC quater frame
 388         double e2; ///< second order loop error
 389         double b, c; ///< DLL filter coefficients
 390 };
 391 #endif
 392
 393 class MIDIClock_Slave : public Slave {
 394   public:
 395         MIDIClock_Slave (Session&, MIDI::Port&, int ppqn = 24);
 396
 397         /// Constructor for unit tests
 398         MIDIClock_Slave (ISlaveSessionProxy* session_proxy = 0, int ppqn = 24);
 399         ~MIDIClock_Slave ();
 400
 401         void rebind (MIDI::Port&);
 402         bool speed_and_position (double&, framepos_t&);
 403
 404         bool locked() const;
 405         bool ok() const;
 406         bool starting() const;
 407
 408         framecnt_t resolution () const;
 409         bool requires_seekahead () const { return false; }
 410         bool give_slave_full_control_over_transport_speed() const { return true; }
 411
 412         void set_bandwidth (double a_bandwith) { bandwidth = a_bandwith; }
 413         std::string approximate_current_delta() const;
 414
 415   protected:
 416         ISlaveSessionProxy* session;
 417         MIDI::Port* port;
 418         PBD::ScopedConnectionList port_connections;
 419
 420         /// pulses per quarter note for one MIDI clock frame (default 24)
 421         int         ppqn;
 422
 423         /// the duration of one ppqn in frame time
 424         double      one_ppqn_in_frames;
 425
 426         /// the timestamp of the first MIDI clock message
 427         framepos_t  first_timestamp;
 428
 429         /// the time stamp and should-be transport position of the last inbound MIDI clock message
 430         framepos_t  last_timestamp;
 431         double      should_be_position;
 432
 433         /// the number of midi clock messages received (zero-based)
 434         /// since start
 435         long midi_clock_count;
 436
 437         //the delay locked loop (DLL), see www.kokkinizita.net/papers/usingdll.pdf
 438
 439         /// time at the beginning of the MIDI clock frame
 440         double t0;
 441
 442         /// calculated end of the MIDI clock frame
 443         double t1;
 444
 445         /// loop error = real value - expected value
 446         double e;
 447
 448         /// second order loop error
 449         double e2;
 450
 451         /// DLL filter bandwidth
 452         double bandwidth;
 453
 454         /// DLL filter coefficients
 455         double b, c, omega;
 456
 457         frameoffset_t  current_delta;
 458
 459         void reset ();
 460         void start (MIDI::Parser& parser, framepos_t timestamp);
 461         void contineu (MIDI::Parser& parser, framepos_t timestamp);
 462         void stop (MIDI::Parser& parser, framepos_t timestamp);
 463         void position (MIDI::Parser& parser, MIDI::byte* message, size_t size);
 464         // we can't use continue because it is a C++ keyword
 465         void calculate_one_ppqn_in_frames_at(framepos_t time);
 466         framepos_t calculate_song_position(uint16_t song_position_in_sixteenth_notes);
 467         void calculate_filter_coefficients();
 468         void update_midi_clock (MIDI::Parser& parser, framepos_t timestamp);
 469         void read_current (SafeTime *) const;
 470         bool stop_if_no_more_clock_events(framepos_t& pos, framepos_t now);
 471
 472         /// whether transport should be rolling
 473         bool _started;
 474
 475         /// is true if the MIDI Start message has just been received until
 476         /// the first MIDI Clock Event
 477         bool _starting;
 478 };
 479
 480 class JACK_Slave : public Slave
 481 {
 482   public:
 483         JACK_Slave (jack_client_t*);
 484         ~JACK_Slave ();
 485
 486         bool speed_and_position (double& speed, framepos_t& pos);
 487
 488         bool starting() const { return _starting; }
 489         bool locked() const;
 490         bool ok() const;
 491         framecnt_t resolution () const { return 1; }
 492         bool requires_seekahead () const { return false; }
 493         void reset_client (jack_client_t* jack);
 494         bool is_always_synced() const { return true; }
 495
 496   private:
 497         jack_client_t* jack;
 498         double speed;
 499         bool _starting;
 500 };
 501
 502 } /* namespace */
 503
 504 #endif /* __ardour_slave_h__ */