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