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         virtual void request_transport_speed (double speed)                   {}
 170 };
 171
 172
 173 /// The Session Proxy for use in real Ardour
 174 class SlaveSessionProxy : public ISlaveSessionProxy {
 175         Session&    session;
 176
 177   public:
 178         SlaveSessionProxy(Session &s) : session(s) {};
 179         TempoMap& tempo_map()                 const   { return session.tempo_map();                         }
 180         nframes_t frame_rate()                const   { return session.frame_rate();                        }
 181         nframes_t audible_frame ()            const   { return session.audible_frame();                     }
 182         nframes_t transport_frame ()          const   { return session.transport_frame();                   }
 183         nframes_t frames_since_cycle_start () const   { return session.engine().frames_since_cycle_start(); }
 184         nframes_t frame_time ()               const   { return session.engine().frame_time();               }
 185
 186         void request_locate (nframes_t frame, bool with_roll = false) { session.request_locate(frame, with_roll); }
 187         void request_transport_speed (double speed)                   { session.request_transport_speed(speed);   }
 188 };
 189
 190 struct SafeTime {
 191     int guard1;
 192     nframes_t   position;
 193     nframes_t   timestamp;
 194     int guard2;
 195
 196     SafeTime() {
 197             guard1 = 0;
 198             guard2 = 0;
 199             timestamp = 0;
 200     }
 201 };
 202
 203 class MTC_Slave : public Slave, public sigc::trackable {
 204   public:
 205         MTC_Slave (Session&, MIDI::Port&);
 206         ~MTC_Slave ();
 207
 208         void rebind (MIDI::Port&);
 209         bool speed_and_position (double&, nframes_t&);
 210
 211         bool locked() const;
 212         bool ok() const;
 213         void handle_locate (const MIDI::byte*);
 214
 215         nframes_t resolution() const;
 216         bool requires_seekahead () const { return true; }
 217
 218   private:
 219         Session&    session;
 220         MIDI::Port* port;
 221         std::vector<sigc::connection> connections;
 222         bool        can_notify_on_unknown_rate;
 223
 224         SafeTime    current;
 225         nframes_t   mtc_frame;               /* current time */
 226         nframes_t   last_inbound_frame;      /* when we got it; audio clocked */
 227         MIDI::byte  last_mtc_fps_byte;
 228
 229         double      mtc_speed;
 230         nframes_t   first_mtc_frame;
 231         nframes_t   first_mtc_time;
 232
 233         static const int32_t accumulator_size = 128;
 234         double   accumulator[accumulator_size];
 235         int32_t accumulator_index;
 236         bool    have_first_accumulated_speed;
 237
 238         void reset ();
 239         void update_mtc_qtr (MIDI::Parser&);
 240         void update_mtc_time (const MIDI::byte *, bool);
 241         void update_mtc_status (MIDI::Parser::MTC_Status);
 242         void read_current (SafeTime *) const;
 243 };
 244
 245 class MIDIClock_Slave : public Slave, public sigc::trackable {
 246   public:
 247         MIDIClock_Slave (Session&, MIDI::Port&, int ppqn = 24);
 248
 249         /// Constructor for unit tests
 250         MIDIClock_Slave (ISlaveSessionProxy* session_proxy, int ppqn = 24);
 251         ~MIDIClock_Slave ();
 252
 253         void rebind (MIDI::Port&);
 254         bool speed_and_position (double&, nframes_t&);
 255
 256         bool locked() const;
 257         bool ok() const;
 258         bool starting() const;
 259
 260         nframes_t resolution() const;
 261         bool requires_seekahead () const { return false; }
 262         bool give_slave_full_control_over_transport_speed() const { return true; }
 263
 264         void set_bandwidth (double a_bandwith) { bandwidth = a_bandwith; }
 265
 266   private:
 267         ISlaveSessionProxy* session;
 268         MIDI::Port* port;
 269         std::vector<sigc::connection> connections;
 270
 271         /// pulses per quarter note for one MIDI clock frame (default 24)
 272         int         ppqn;
 273
 274         /// the duration of one ppqn in frame time
 275         double      one_ppqn_in_frames;
 276
 277         /// the timestamp of the first MIDI clock message
 278         nframes_t   first_timestamp;
 279
 280         /// the time stamp and should-be transport position of the last inbound MIDI clock message
 281         nframes_t   last_timestamp;
 282         double      should_be_position;
 283
 284         /// the number of midi clock messages received (zero-based)
 285         /// since start
 286         long midi_clock_count;
 287
 288         //the delay locked loop (DLL), see www.kokkinizita.net/papers/usingdll.pdf
 289
 290         /// time at the beginning of the MIDI clock frame
 291         double t0;
 292
 293         /// calculated end of the MIDI clock frame
 294         double t1;
 295
 296         /// loop error = real value - expected value
 297         double e;
 298
 299         /// second order loop error
 300         double e2;
 301
 302         /// DLL filter bandwidth
 303         double bandwidth;
 304
 305         /// DLL filter coefficients
 306         double b, c, omega;
 307
 308         void reset ();
 309         void start (MIDI::Parser& parser, nframes_t timestamp);
 310         void contineu (MIDI::Parser& parser, nframes_t timestamp);
 311         void stop (MIDI::Parser& parser, nframes_t timestamp);
 312         void position (MIDI::Parser& parser, MIDI::byte* message, size_t size);
 313         // we can't use continue because it is a C++ keyword
 314         void calculate_one_ppqn_in_frames_at(nframes_t time);
 315         nframes_t calculate_song_position(uint16_t song_position_in_sixteenth_notes);
 316         void calculate_filter_coefficients();
 317         void update_midi_clock (MIDI::Parser& parser, nframes_t timestamp);
 318         void read_current (SafeTime *) const;
 319         bool stop_if_no_more_clock_events(nframes_t& pos, nframes_t now);
 320
 321         /// whether transport should be rolling
 322         bool _started;
 323
 324         /// is true if the MIDI Start message has just been received until
 325         /// the first MIDI Clock Event
 326         bool _starting;
 327 };
 328
 329 class ADAT_Slave : public Slave
 330 {
 331   public:
 332         ADAT_Slave () {}
 333         ~ADAT_Slave () {}
 334
 335         bool speed_and_position (double& speed, nframes_t& pos) {
 336                 speed = 0;
 337                 pos = 0;
 338                 return false;
 339         }
 340
 341         bool locked() const { return false; }
 342         bool ok() const { return false; }
 343         nframes_t resolution() const { return 1; }
 344         bool requires_seekahead () const { return true; }
 345 };
 346
 347 class JACK_Slave : public Slave
 348 {
 349   public:
 350         JACK_Slave (jack_client_t*);
 351         ~JACK_Slave ();
 352
 353         bool speed_and_position (double& speed, nframes_t& pos);
 354
 355         bool starting() const { return _starting; }
 356         bool locked() const;
 357         bool ok() const;
 358         nframes_t resolution() const { return 1; }
 359         bool requires_seekahead () const { return false; }
 360         void reset_client (jack_client_t* jack);
 361         bool is_always_synced() const { return true; }
 362
 363   private:
 364         jack_client_t* jack;
 365         double speed;
 366         bool _starting;
 367 };
 368
 369 } /* namespace */
 370
 371 #endif /* __ardour_slave_h__ */