libs/ardour/midi_clock_slave.cc

   1 /*
   2     Copyright (C) 2008 Paul Davis
   3     Author: Hans Baier
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with this program; if not, write to the Free Software
  17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18
  19 */
  20
  21 #include <cmath>
  22 #include <errno.h>
  23 #include <poll.h>
  24 #include <sys/types.h>
  25 #include <unistd.h>
  26 #include "pbd/error.h"
  27 #include "pbd/failed_constructor.h"
  28 #include "pbd/pthread_utils.h"
  29
  30 #include "midi++/port.h"
  31
  32 #include "ardour/debug.h"
  33 #include "ardour/slave.h"
  34 #include "ardour/session.h"
  35 #include "ardour/audioengine.h"
  36 #include "ardour/cycles.h"
  37 #include "ardour/tempo.h"
  38
  39
  40 #include "i18n.h"
  41
  42 using namespace std;
  43 using namespace ARDOUR;
  44 using namespace MIDI;
  45 using namespace PBD;
  46
  47 MIDIClock_Slave::MIDIClock_Slave (Session& s, MIDI::Port& p, int ppqn)
  48         : ppqn (ppqn)
  49         , bandwidth (1.0 / 60.0) // 1 BpM = 1 / 60 Hz
  50 {
  51         session = (ISlaveSessionProxy *) new SlaveSessionProxy(s);
  52         rebind (p);
  53         reset ();
  54 }
  55
  56 MIDIClock_Slave::MIDIClock_Slave (ISlaveSessionProxy* session_proxy, int ppqn)
  57         : session(session_proxy)
  58         , ppqn (ppqn)
  59         , bandwidth (1.0 / 60.0) // 1 BpM = 1 / 60 Hz
  60 {
  61         reset ();
  62 }
  63
  64 MIDIClock_Slave::~MIDIClock_Slave()
  65 {
  66         delete session;
  67 }
  68
  69 void
  70 MIDIClock_Slave::rebind (MIDI::Port& p)
  71 {
  72         port_connections.drop_connections();
  73
  74         port = &p;
  75
  76         DEBUG_TRACE (DEBUG::MidiClock, string_compose ("MIDIClock_Slave: connecting to port %1\n", port->name()));
  77
  78         port->parser()->timing.connect_same_thread (port_connections, boost::bind (&MIDIClock_Slave::update_midi_clock, this, _1, _2));
  79         port->parser()->start.connect_same_thread (port_connections, boost::bind (&MIDIClock_Slave::start, this, _1, _2));
  80         port->parser()->contineu.connect_same_thread (port_connections, boost::bind (&MIDIClock_Slave::contineu, this, _1, _2));
  81         port->parser()->stop.connect_same_thread (port_connections, boost::bind (&MIDIClock_Slave::stop, this, _1, _2));
  82         port->parser()->position.connect_same_thread (port_connections, boost::bind (&MIDIClock_Slave::position, this, _1, _2, 3));
  83 }
  84
  85 void
  86 MIDIClock_Slave::calculate_one_ppqn_in_frames_at(framepos_t time)
  87 {
  88         const Tempo& current_tempo = session->tempo_map().tempo_at(time);
  89         double frames_per_beat = current_tempo.frames_per_beat(session->frame_rate());
  90
  91         double quarter_notes_per_beat = 4.0 / current_tempo.note_type();
  92         double frames_per_quarter_note = frames_per_beat / quarter_notes_per_beat;
  93
  94         one_ppqn_in_frames = frames_per_quarter_note / double (ppqn);
  95         // DEBUG_TRACE (DEBUG::MidiClock, string_compose ("at %1, one ppqn = %2\n", time, one_ppqn_in_frames));
  96 }
  97
  98 ARDOUR::framepos_t
  99 MIDIClock_Slave::calculate_song_position(uint16_t song_position_in_sixteenth_notes)
 100 {
 101         framepos_t song_position_frames = 0;
 102         for (uint16_t i = 1; i <= song_position_in_sixteenth_notes; ++i) {
 103                 // one quarter note contains ppqn pulses, so a sixteenth note is ppqn / 4 pulses
 104                 calculate_one_ppqn_in_frames_at(song_position_frames);
 105                 song_position_frames += one_ppqn_in_frames * (framepos_t)(ppqn / 4);
 106         }
 107
 108         return song_position_frames;
 109 }
 110
 111 void
 112 MIDIClock_Slave::calculate_filter_coefficients()
 113 {
 114         // omega = 2 * PI * Bandwidth / MIDI clock frame frequency in Hz
 115         omega = 2.0 * M_PI * bandwidth * one_ppqn_in_frames / session->frame_rate();
 116         b = 1.4142135623730950488 * omega;
 117         c = omega * omega;
 118 }
 119
 120 void
 121 MIDIClock_Slave::update_midi_clock (Parser& /*parser*/, framepos_t timestamp)
 122 {
 123         // some pieces of hardware send MIDI Clock all the time
 124         if ( (!_starting) && (!_started) ) {
 125                 return;
 126         }
 127
 128         calculate_one_ppqn_in_frames_at(should_be_position);
 129
 130         framepos_t elapsed_since_start = timestamp - first_timestamp;
 131         double error = 0;
 132
 133         if (_starting || last_timestamp == 0) {
 134                 midi_clock_count = 0;
 135
 136                 first_timestamp = timestamp;
 137                 elapsed_since_start = should_be_position;
 138
 139                 // calculate filter coefficients
 140                 calculate_filter_coefficients();
 141
 142                 // initialize DLL
 143                 e2 = double(one_ppqn_in_frames) / double(session->frame_rate());
 144                 t0 = double(elapsed_since_start) / double(session->frame_rate());
 145                 t1 = t0 + e2;
 146
 147                 // let ardour go after first MIDI Clock Event
 148                 _starting = false;
 149         } else {
 150                 midi_clock_count++;
 151                 should_be_position  += one_ppqn_in_frames;
 152                 calculate_filter_coefficients();
 153
 154                 // calculate loop error
 155                 // we use session->audible_frame() instead of t1 here
 156                 // because t1 is used to calculate the transport speed,
 157                 // so the loop will compensate for accumulating rounding errors
 158                 error = (double(should_be_position) - double(session->audible_frame()));
 159                 e = error / double(session->frame_rate());
 160
 161                 // update DLL
 162                 t0 = t1;
 163                 t1 += b * e + e2;
 164                 e2 += c * e;
 165         }
 166
 167         DEBUG_TRACE (DEBUG::MidiClock, string_compose ("clock #%1 @ %2 arrived %3 (theoretical) audible %4 transport %5 error %6 "
 168                                                        "read delta %7 should-be delta %8 t1-t0 %9 t0 %10 t1 %11 framerate %12 appspeed %13\n",
 169                                                        midi_clock_count,
 170                                                        elapsed_since_start,
 171                                                        should_be_position,
 172                                                        session->audible_frame(),
 173                                                        session->transport_frame(),
 174                                                        error,
 175                                                        timestamp - last_timestamp,
 176                                                        one_ppqn_in_frames,
 177                                                        (t1 -t0) * session->frame_rate(),
 178                                                        t0 * session->frame_rate(),
 179                                                        t1 * session->frame_rate(),
 180                                                        session->frame_rate(),
 181                                                        ((t1 - t0) * session->frame_rate()) / one_ppqn_in_frames));
 182
 183         last_timestamp = timestamp;
 184 }
 185
 186 void
 187 MIDIClock_Slave::start (Parser& /*parser*/, framepos_t timestamp)
 188 {
 189         DEBUG_TRACE (DEBUG::MidiClock, string_compose ("MIDIClock_Slave got start message at time %1 engine time %2\n", timestamp, session->frame_time()));
 190
 191         if (!_started) {
 192                 reset();
 193
 194                 _started = true;
 195                 _starting = true;
 196
 197                 should_be_position = session->transport_frame();
 198         }
 199 }
 200
 201 void
 202 MIDIClock_Slave::reset ()
 203 {
 204         should_be_position = session->transport_frame();
 205         last_timestamp = 0;
 206
 207         _starting = true;
 208         _started  = true;
 209
 210         // session->request_locate(0, false);
 211 }
 212
 213 void
 214 MIDIClock_Slave::contineu (Parser& /*parser*/, framepos_t /*timestamp*/)
 215 {
 216         DEBUG_TRACE (DEBUG::MidiClock, "MIDIClock_Slave got continue message\n");
 217
 218         if (!_started) {
 219                 _starting = true;
 220                 _started  = true;
 221         }
 222 }
 223
 224
 225 void
 226 MIDIClock_Slave::stop (Parser& /*parser*/, framepos_t /*timestamp*/)
 227 {
 228         DEBUG_TRACE (DEBUG::MidiClock, "MIDIClock_Slave got stop message\n");
 229
 230         if (_started || _starting) {
 231                 _starting = false;
 232                 _started  = false;
 233                 // locate to last MIDI clock position
 234                 session->request_transport_speed(0.0);
 235
 236                 // we need to go back to the last MIDI beat (6 ppqn)
 237                 // and lets hope the tempo didnt change in the meantime :)
 238
 239                 // begin at the should be position, because
 240                 // that is the position of the last MIDI Clock
 241                 // message and that is probably what the master
 242                 // expects where we are right now
 243                 framepos_t stop_position = should_be_position;
 244
 245                 // find out the last MIDI beat: go back #midi_clocks mod 6
 246                 // and lets hope the tempo didnt change in those last 6 beats :)
 247                 stop_position -= (midi_clock_count % 6) * one_ppqn_in_frames;
 248
 249                 session->request_locate(stop_position, false);
 250                 should_be_position = stop_position;
 251                 last_timestamp = 0;
 252         }
 253 }
 254
 255 void
 256 MIDIClock_Slave::position (Parser& /*parser*/, byte* message, size_t size)
 257 {
 258         // we are note supposed to get position messages while we are running
 259         // so lets be robust and ignore those
 260         if (_started || _starting) {
 261                 return;
 262         }
 263
 264         assert(size == 3);
 265         byte lsb = message[1];
 266         byte msb = message[2];
 267         assert((lsb <= 0x7f) && (msb <= 0x7f));
 268
 269         uint16_t position_in_sixteenth_notes = (uint16_t(msb) << 7) | uint16_t(lsb);
 270         framepos_t position_in_frames = calculate_song_position(position_in_sixteenth_notes);
 271
 272         DEBUG_TRACE (DEBUG::MidiClock, string_compose ("Song Position: %1 frames: %2\n", position_in_sixteenth_notes, position_in_frames));
 273
 274         session->request_locate(position_in_frames, false);
 275         should_be_position  = position_in_frames;
 276         last_timestamp = 0;
 277
 278 }
 279
 280 bool
 281 MIDIClock_Slave::locked () const
 282 {
 283         return true;
 284 }
 285
 286 bool
 287 MIDIClock_Slave::ok() const
 288 {
 289         return true;
 290 }
 291
 292 bool
 293 MIDIClock_Slave::starting() const
 294 {
 295         return false;
 296 }
 297
 298 bool
 299 MIDIClock_Slave::stop_if_no_more_clock_events(framepos_t& pos, framepos_t now)
 300 {
 301         /* no timecode for 1/4 second ? conclude that its stopped */
 302         if (last_timestamp &&
 303             now > last_timestamp &&
 304             now - last_timestamp > session->frame_rate() / 4) {
 305                 DEBUG_TRACE (DEBUG::MidiClock, "No MIDI Clock frames received for some time, stopping!\n");
 306                 pos = should_be_position;
 307                 session->request_transport_speed (0);
 308                 session->request_locate (should_be_position, false);
 309                 return true;
 310         } else {
 311                 return false;
 312         }
 313 }
 314
 315 bool
 316 MIDIClock_Slave::speed_and_position (double& speed, framepos_t& pos)
 317 {
 318         if (!_started || _starting) {
 319                 speed = 0.0;
 320                 pos   = should_be_position;
 321                 return true;
 322         }
 323
 324         framepos_t engine_now = session->frame_time();
 325
 326         if (stop_if_no_more_clock_events(pos, engine_now)) {
 327                 return false;
 328         }
 329
 330         // calculate speed
 331         speed = ((t1 - t0) * session->frame_rate()) / one_ppqn_in_frames;
 332
 333         // provide a 3% deadzone to lock the speed
 334         if (fabs(speed - 1.0) <= 0.03)
 335                 speed = 1.0;
 336
 337         // calculate position
 338         if (engine_now > last_timestamp) {
 339                 // we are in between MIDI clock messages
 340                 // so we interpolate position according to speed
 341                 framecnt_t elapsed = engine_now - last_timestamp;
 342                 pos = (framepos_t) (should_be_position + double(elapsed) * speed);
 343         } else {
 344                 // A new MIDI clock message has arrived this cycle
 345                 pos = should_be_position;
 346         }
 347
 348         DEBUG_TRACE (DEBUG::MidiClock, string_compose ("speed_and_position: %1 & %2 <-> %3 (transport)\n", speed, pos, session->transport_frame()));
 349
 350         return true;
 351 }
 352
 353 ARDOUR::framecnt_t
 354 MIDIClock_Slave::resolution() const
 355 {
 356         // one beat
 357         return (framecnt_t) one_ppqn_in_frames * ppqn;
 358 }
 359