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 <jack/jack.h>
  26
  27 #include <sigc++/signal.h>
  28 #include "ardour/ardour.h"
  29 #include "ardour/session.h"
  30 #include "ardour/audioengine.h"
  31 #include "midi++/parser.h"
  32 #include "midi++/types.h"
  33
  34 namespace MIDI {
  35         class Port;
  36 }
  37
  38 namespace ARDOUR {
  39 /**
  40  * @class Slave
  41  *
  42  * @brief The Slave interface can be used to sync ARDOURs tempo to an external source
  43  * like MTC, MIDI Clock, etc.
  44  *
  45  * The name of the interface may be a bit misleading: A subclass of Slave actually
  46  * acts as a time master for ARDOUR, that means ARDOUR will try to follow the
  47  * speed and transport position of the implementation of Slave.
  48  * Therefore it is rather that class, that makes ARDOUR a slave by connecting it
  49  * to its external time master.
  50  */
  51 class Slave {
  52   public:
  53         Slave() { }
  54         virtual ~Slave() {}
  55
  56         /**
  57          * This is the most important function to implement:
  58          * Each process cycle, Session::follow_slave will call this method.
  59          *  and after the method call they should
  60          *
  61          * Session::follow_slave will then try to follow the given
  62          * <emph>position</emph> using a delay locked loop (DLL),
  63          * starting with the first given transport speed.
  64          * If the values of speed and position contradict each other,
  65          * ARDOUR will always follow the position and disregard the speed.
  66          * Although, a correct speed is important so that ARDOUR
  67          * can sync to the master time source quickly.
  68          *
  69          * For background information on delay locked loops,
  70          * see http://www.kokkinizita.net/papers/usingdll.pdf
  71          *
  72          * The method has the following precondition:
  73          * <ul>
  74          *       <li>
  75          *       Slave::ok() should return true, otherwise playback will stop
  76          *       immediately and the method will not be called
  77          *   </li>
  78          *   <li>
  79          *     when the references speed and position are passed into the Slave
  80          *     they are uninitialized
  81          *   </li>
  82          * </ul>
  83          *
  84          * After the method call the following postconditions should be met:
  85          * <ul>
  86          *        <li>
  87          *       The first position value on transport start should be 0,
  88          *       otherwise ARDOUR will try to locate to the new position
  89          *       rather than move to it
  90          *    </li>
  91          *        <li>
  92          *      the references speed and position should be assigned
  93          *      to the Slaves current requested transport speed
  94          *      and transport position.
  95          *    </li>
  96          *   <li>
  97          *     Slave::resolution() should be greater than the maximum distance of
  98          *     ARDOURs transport position to the slaves requested transport position.
  99          *   </li>
 100          *       <li>Slave::locked() should return true, otherwise Session::no_roll will be called</li>
 101          *       <li>Slave::starting() should be false, otherwise the transport will not move until it becomes true</li>         *
 102          * </ul>
 103          *
 104          * @param speed - The transport speed requested
 105          * @param position - The transport position requested
 106          * @return - The return value is currently ignored (see Session::follow_slave)
 107          */
 108         virtual bool speed_and_position (double& speed, nframes_t& position) = 0;
 109
 110         /**
 111          * reports to ARDOUR whether the Slave is currently synced to its external
 112          * time source.
 113          *
 114          * @return - when returning false, the transport will stop rolling
 115          */
 116         virtual bool locked() const = 0;
 117
 118         /**
 119          * reports to ARDOUR whether the slave is in a sane state
 120          *
 121          * @return - when returning false, the transport will be stopped and the slave
 122          * disconnected from ARDOUR.
 123          */
 124         virtual bool ok() const = 0;
 125
 126         /**
 127          * reports to ARDOUR whether the slave is in the process of starting
 128          * to roll
 129          *
 130          * @return - when returning false, transport will not move until this method returns true
 131          */
 132         virtual bool starting() const { return false; }
 133
 134         /**
 135          * @return - the timing resolution of the Slave - If the distance of ARDOURs transport
 136          * to the slave becomes greater than the resolution, sound will stop
 137          */
 138         virtual nframes_t resolution() const = 0;
 139
 140         /**
 141          * @return - when returning true, ARDOUR will wait for one second before transport
 142          * starts rolling
 143          */
 144         virtual bool requires_seekahead () const = 0;
 145
 146         /**
 147          * @return - when returning true, ARDOUR will use transport speed 1.0 no matter what
 148          *           the slave returns
 149          */
 150         virtual bool is_always_synced() const { return false; }
 151
 152         /**
 153          * @return - whether ARDOUR should use the slave speed without any adjustments
 154          */
 155         virtual bool give_slave_full_control_over_transport_speed() const { return false; }
 156 };
 157
 158 /// We need this wrapper for testability, it's just too hard to mock up a session class
 159 class ISlaveSessionProxy {
 160   public:
 161         virtual TempoMap& tempo_map()                 const   { return *((TempoMap *) 0); }
 162         virtual nframes_t frame_rate()                const   { return 0; }
 163         virtual nframes_t audible_frame ()            const   { return 0; }
 164         virtual nframes_t transport_frame ()          const   { return 0; }
 165         virtual nframes_t frames_since_cycle_start () const   { return 0; }
 166         virtual nframes_t frame_time ()               const   { return 0; }
 167
 168         virtual void request_locate (nframes_t /*frame*/, bool with_roll = false) {
 169                 (void) with_roll;
 170         }
 171         virtual void request_transport_speed (double /*speed*/)                   {}
 172 };
 173
 174
 175 /// The Session Proxy for use in real Ardour
 176 class SlaveSessionProxy : public ISlaveSessionProxy {
 177         Session&    session;
 178
 179   public:
 180         SlaveSessionProxy(Session &s) : session(s) {};
 181         TempoMap& tempo_map()                 const   { return session.tempo_map();                         }
 182         nframes_t frame_rate()                const   { return session.frame_rate();                        }
 183         nframes_t audible_frame ()            const   { return session.audible_frame();                     }
 184         nframes_t transport_frame ()          const   { return session.transport_frame();                   }
 185         nframes_t frames_since_cycle_start () const   { return session.engine().frames_since_cycle_start(); }
 186         nframes_t frame_time ()               const   { return session.engine().frame_time();               }
 187
 188         void request_locate (nframes_t frame, bool with_roll = false) { session.request_locate(frame, with_roll); }
 189         void request_transport_speed (double speed)                   { session.request_transport_speed(speed);   }
 190 };
 191
 192 struct SafeTime {
 193     int guard1;
 194     nframes_t   position;
 195     nframes_t   timestamp;
 196     int guard2;
 197
 198     SafeTime() {
 199             guard1 = 0;
 200             guard2 = 0;
 201             timestamp = 0;
 202     }
 203 };
 204
 205 class MTC_Slave : public Slave, public sigc::trackable {
 206   public:
 207         MTC_Slave (Session&, MIDI::Port&);
 208         ~MTC_Slave ();
 209
 210         void rebind (MIDI::Port&);
 211         bool speed_and_position (double&, nframes_t&);
 212
 213         bool locked() const;
 214         bool ok() const;
 215         void handle_locate (const MIDI::byte*);
 216
 217         nframes_t resolution() const;
 218         bool requires_seekahead () const { return true; }
 219
 220   private:
 221         Session&    session;
 222         MIDI::Port* port;
 223         std::vector<sigc::connection> connections;
 224         bool        can_notify_on_unknown_rate;
 225
 226         SafeTime    current;
 227         nframes_t   mtc_frame;               /* current time */
 228         nframes_t   last_inbound_frame;      /* when we got it; audio clocked */
 229         MIDI::byte  last_mtc_fps_byte;
 230
 231         double      mtc_speed;
 232         nframes_t   first_mtc_frame;
 233         nframes_t   first_mtc_time;
 234
 235         static const int32_t accumulator_size = 128;
 236         double   accumulator[accumulator_size];
 237         int32_t accumulator_index;
 238         bool    have_first_accumulated_speed;
 239
 240         void reset ();
 241         void update_mtc_qtr (MIDI::Parser&);
 242         void update_mtc_time (const MIDI::byte *, bool);
 243         void update_mtc_status (MIDI::Parser::MTC_Status);
 244         void read_current (SafeTime *) const;
 245 };
 246
 247 class MIDIClock_Slave : public Slave, public sigc::trackable {
 248   public:
 249         MIDIClock_Slave (Session&, MIDI::Port&, int ppqn = 24);
 250
 251         /// Constructor for unit tests
 252         MIDIClock_Slave (ISlaveSessionProxy* session_proxy, int ppqn = 24);
 253         ~MIDIClock_Slave ();
 254
 255         void rebind (MIDI::Port&);
 256         bool speed_and_position (double&, nframes_t&);
 257
 258         bool locked() const;
 259         bool ok() const;
 260         bool starting() const;
 261
 262         nframes_t resolution() const;
 263         bool requires_seekahead () const { return false; }
 264         bool give_slave_full_control_over_transport_speed() const { return true; }
 265
 266         void set_bandwidth (double a_bandwith) { bandwidth = a_bandwith; }
 267
 268   private:
 269         ISlaveSessionProxy* session;
 270         MIDI::Port* port;
 271         std::vector<sigc::connection> connections;
 272
 273         /// pulses per quarter note for one MIDI clock frame (default 24)
 274         int         ppqn;
 275
 276         /// the duration of one ppqn in frame time
 277         double      one_ppqn_in_frames;
 278
 279         /// the timestamp of the first MIDI clock message
 280         nframes_t   first_timestamp;
 281
 282         /// the time stamp and should-be transport position of the last inbound MIDI clock message
 283         nframes_t   last_timestamp;
 284         double      should_be_position;
 285
 286         /// the number of midi clock messages received (zero-based)
 287         /// since start
 288         long midi_clock_count;
 289
 290         //the delay locked loop (DLL), see www.kokkinizita.net/papers/usingdll.pdf
 291
 292         /// time at the beginning of the MIDI clock frame
 293         double t0;
 294
 295         /// calculated end of the MIDI clock frame
 296         double t1;
 297
 298         /// loop error = real value - expected value
 299         double e;
 300
 301         /// second order loop error
 302         double e2;
 303
 304         /// DLL filter bandwidth
 305         double bandwidth;
 306
 307         /// DLL filter coefficients
 308         double b, c, omega;
 309
 310         void reset ();
 311         void start (MIDI::Parser& parser, nframes_t timestamp);
 312         void contineu (MIDI::Parser& parser, nframes_t timestamp);
 313         void stop (MIDI::Parser& parser, nframes_t timestamp);
 314         void position (MIDI::Parser& parser, MIDI::byte* message, size_t size);
 315         // we can't use continue because it is a C++ keyword
 316         void calculate_one_ppqn_in_frames_at(nframes_t time);
 317         nframes_t calculate_song_position(uint16_t song_position_in_sixteenth_notes);
 318         void calculate_filter_coefficients();
 319         void update_midi_clock (MIDI::Parser& parser, nframes_t timestamp);
 320         void read_current (SafeTime *) const;
 321         bool stop_if_no_more_clock_events(nframes_t& pos, nframes_t now);
 322
 323         /// whether transport should be rolling
 324         bool _started;
 325
 326         /// is true if the MIDI Start message has just been received until
 327         /// the first MIDI Clock Event
 328         bool _starting;
 329 };
 330
 331 class ADAT_Slave : public Slave
 332 {
 333   public:
 334         ADAT_Slave () {}
 335         ~ADAT_Slave () {}
 336
 337         bool speed_and_position (double& speed, nframes_t& pos) {
 338                 speed = 0;
 339                 pos = 0;
 340                 return false;
 341         }
 342
 343         bool locked() const { return false; }
 344         bool ok() const { return false; }
 345         nframes_t resolution() const { return 1; }
 346         bool requires_seekahead () const { return true; }
 347 };
 348
 349 class JACK_Slave : public Slave
 350 {
 351   public:
 352         JACK_Slave (jack_client_t*);
 353         ~JACK_Slave ();
 354
 355         bool speed_and_position (double& speed, nframes_t& pos);
 356
 357         bool starting() const { return _starting; }
 358         bool locked() const;
 359         bool ok() const;
 360         nframes_t resolution() const { return 1; }
 361         bool requires_seekahead () const { return false; }
 362         void reset_client (jack_client_t* jack);
 363         bool is_always_synced() const { return true; }
 364
 365   private:
 366         jack_client_t* jack;
 367         double speed;
 368         bool _starting;
 369 };
 370
 371 } /* namespace */
 372
 373 #endif /* __ardour_slave_h__ */