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