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 #include "pbd/convert.h"
  30
  31 #include "midi++/port.h"
  32
  33 #include "ardour/debug.h"
  34 #include "ardour/midi_buffer.h"
  35 #include "ardour/midi_port.h"
  36 #include "ardour/slave.h"
  37 #include "ardour/tempo.h"
  38
  39 #include "i18n.h"
  40
  41 using namespace std;
  42 using namespace ARDOUR;
  43 using namespace MIDI;
  44 using namespace PBD;
  45
  46 MIDIClock_Slave::MIDIClock_Slave (Session& s, MidiPort& p, int ppqn)
  47         : ppqn (ppqn)
  48         , bandwidth (10.0 / 60.0) // 1 BpM = 1 / 60 Hz
  49 {
  50         session = (ISlaveSessionProxy *) new SlaveSessionProxy(s);
  51         rebind (p);
  52         reset ();
  53 }
  54
  55 MIDIClock_Slave::MIDIClock_Slave (ISlaveSessionProxy* session_proxy, int ppqn)
  56         : session(session_proxy)
  57         , ppqn (ppqn)
  58         , bandwidth (10.0 / 60.0) // 1 BpM = 1 / 60 Hz
  59 {
  60         reset ();
  61 }
  62
  63 MIDIClock_Slave::~MIDIClock_Slave()
  64 {
  65         delete session;
  66 }
  67
  68 void
  69 MIDIClock_Slave::rebind (MidiPort& port)
  70 {
  71         DEBUG_TRACE (DEBUG::MidiClock, string_compose ("MIDIClock_Slave: connecting to port %1\n", port.name()));
  72
  73         port_connections.drop_connections ();
  74
  75         port.self_parser().timing.connect_same_thread (port_connections, boost::bind (&MIDIClock_Slave::update_midi_clock, this, _1, _2));
  76         port.self_parser().start.connect_same_thread (port_connections, boost::bind (&MIDIClock_Slave::start, this, _1, _2));
  77         port.self_parser().contineu.connect_same_thread (port_connections, boost::bind (&MIDIClock_Slave::contineu, this, _1, _2));
  78         port.self_parser().stop.connect_same_thread (port_connections, boost::bind (&MIDIClock_Slave::stop, this, _1, _2));
  79         port.self_parser().position.connect_same_thread (port_connections, boost::bind (&MIDIClock_Slave::position, this, _1, _2, 3));
  80
  81 }
  82
  83 void
  84 MIDIClock_Slave::calculate_one_ppqn_in_frames_at(framepos_t time)
  85 {
  86         const Tempo& current_tempo = session->tempo_map().tempo_at(time);
  87         double frames_per_beat = current_tempo.frames_per_beat(session->frame_rate());
  88
  89         double quarter_notes_per_beat = 4.0 / current_tempo.note_type();
  90         double frames_per_quarter_note = frames_per_beat / quarter_notes_per_beat;
  91
  92         one_ppqn_in_frames = frames_per_quarter_note / double (ppqn);
  93         // DEBUG_TRACE (DEBUG::MidiClock, string_compose ("at %1, one ppqn = %2\n", time, one_ppqn_in_frames));
  94 }
  95
  96 ARDOUR::framepos_t
  97 MIDIClock_Slave::calculate_song_position(uint16_t song_position_in_sixteenth_notes)
  98 {
  99         framepos_t song_position_frames = 0;
 100         for (uint16_t i = 1; i <= song_position_in_sixteenth_notes; ++i) {
 101                 // one quarter note contains ppqn pulses, so a sixteenth note is ppqn / 4 pulses
 102                 calculate_one_ppqn_in_frames_at(song_position_frames);
 103                 song_position_frames += one_ppqn_in_frames * (framepos_t)(ppqn / 4);
 104         }
 105
 106         return song_position_frames;
 107 }
 108
 109 void
 110 MIDIClock_Slave::calculate_filter_coefficients()
 111 {
 112         // omega = 2 * PI * Bandwidth / MIDI clock frame frequency in Hz
 113         omega = 2.0 * M_PI * bandwidth * one_ppqn_in_frames / session->frame_rate();
 114         b = 1.4142135623730950488 * omega;
 115         c = omega * omega;
 116 }
 117
 118 void
 119 MIDIClock_Slave::update_midi_clock (Parser& /*parser*/, framepos_t timestamp)
 120 {
 121         // some pieces of hardware send MIDI Clock all the time
 122         if ( (!_starting) && (!_started) ) {
 123                 return;
 124         }
 125
 126         calculate_one_ppqn_in_frames_at(should_be_position);
 127
 128         framepos_t elapsed_since_start = timestamp - first_timestamp;
 129         double error = 0;
 130
 131         if (_starting || last_timestamp == 0) {
 132                 midi_clock_count = 0;
 133
 134                 first_timestamp = timestamp;
 135                 elapsed_since_start = should_be_position;
 136
 137                 // calculate filter coefficients
 138                 calculate_filter_coefficients();
 139
 140                 // initialize DLL
 141                 e2 = double(one_ppqn_in_frames) / double(session->frame_rate());
 142                 t0 = double(elapsed_since_start) / double(session->frame_rate());
 143                 t1 = t0 + e2;
 144
 145                 // let ardour go after first MIDI Clock Event
 146                 _starting = false;
 147         } else {
 148                 midi_clock_count++;
 149                 should_be_position  += one_ppqn_in_frames;
 150                 calculate_filter_coefficients();
 151
 152                 // calculate loop error
 153                 // we use session->transport_frame() instead of t1 here
 154                 // because t1 is used to calculate the transport speed,
 155                 // so the loop will compensate for accumulating rounding errors
 156                 error = (double(should_be_position) - double(session->transport_frame()));
 157                 e = error / double(session->frame_rate());
 158                 current_delta = error;
 159
 160                 // update DLL
 161                 t0 = t1;
 162                 t1 += b * e + e2;
 163                 e2 += c * e;
 164         }
 165
 166         DEBUG_TRACE (DEBUG::MidiClock, string_compose ("clock #%1 @ %2 arrived %3 (theoretical) audible %4 transport %5 error %6 "
 167                                                        "read delta %7 should-be delta %8 t1-t0 %9 t0 %10 t1 %11 framerate %12 appspeed %13\n",
 168                                                        midi_clock_count,
 169                                                        elapsed_since_start,
 170                                                        should_be_position,
 171                                                        session->audible_frame(),
 172                                                        session->transport_frame(),
 173                                                        error,
 174                                                        timestamp - last_timestamp,
 175                                                        one_ppqn_in_frames,
 176                                                        (t1 -t0) * session->frame_rate(),
 177                                                        t0 * session->frame_rate(),
 178                                                        t1 * session->frame_rate(),
 179                                                        session->frame_rate(),
 180                                                        ((t1 - t0) * session->frame_rate()) / one_ppqn_in_frames));
 181
 182         last_timestamp = timestamp;
 183 }
 184
 185 void
 186 MIDIClock_Slave::start (Parser& /*parser*/, framepos_t timestamp)
 187 {
 188         DEBUG_TRACE (DEBUG::MidiClock, string_compose ("MIDIClock_Slave got start message at time %1 engine time %2\n", timestamp, session->frame_time()));
 189
 190         if (!_started) {
 191                 reset();
 192
 193                 _started = true;
 194                 _starting = true;
 195
 196                 should_be_position = session->transport_frame();
 197         }
 198 }
 199
 200 void
 201 MIDIClock_Slave::reset ()
 202 {
 203         should_be_position = session->transport_frame();
 204         last_timestamp = 0;
 205
 206         _starting = true;
 207         _started  = true;
 208
 209         // session->request_locate(0, false);
 210         current_delta = 0;
 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 0.1% deadzone to lock the speed
 334         if (fabs(speed - 1.0) <= 0.001)
 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
 360 std::string
 361 MIDIClock_Slave::approximate_current_delta() const
 362 {
 363         char delta[80];
 364         if (last_timestamp == 0 || _starting) {
 365                 snprintf(delta, sizeof(delta), "\u2012\u2012\u2012\u2012");
 366         } else {
 367                 snprintf(delta, sizeof(delta), "\u0394<span foreground=\"green\" face=\"monospace\" >%s%s%" PRIi64 "</span>sm",
 368                                 LEADINGZERO(abs(current_delta)), PLUSMINUS(-current_delta), abs(current_delta));
 369         }
 370         return std::string(delta);
 371 }
 372