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 <sys/types.h>
  24 #include <unistd.h>
  25 #include "pbd/error.h"
  26 #include "pbd/failed_constructor.h"
  27 #include "pbd/pthread_utils.h"
  28 #include "pbd/convert.h"
  29
  30 #include "midi++/port.h"
  31
  32 #include "ardour/debug.h"
  33 #include "ardour/midi_buffer.h"
  34 #include "ardour/midi_port.h"
  35 #include "ardour/slave.h"
  36 #include "ardour/tempo.h"
  37
  38 #include "pbd/i18n.h"
  39
  40 using namespace std;
  41 using namespace ARDOUR;
  42 using namespace MIDI;
  43 using namespace PBD;
  44
  45 MIDIClock_Slave::MIDIClock_Slave (Session& s, MidiPort& p, int ppqn)
  46         : ppqn (ppqn)
  47         , bandwidth (2.0 / 60.0) // 1 BpM = 1 / 60 Hz
  48 {
  49         session = (ISlaveSessionProxy *) new SlaveSessionProxy(s);
  50         rebind (p);
  51         reset ();
  52 }
  53
  54 MIDIClock_Slave::MIDIClock_Slave (ISlaveSessionProxy* session_proxy, int ppqn)
  55         : session(session_proxy)
  56         , ppqn (ppqn)
  57         , bandwidth (2.0 / 60.0) // 1 BpM = 1 / 60 Hz
  58 {
  59         reset ();
  60 }
  61
  62 MIDIClock_Slave::~MIDIClock_Slave()
  63 {
  64         delete session;
  65 }
  66
  67 void
  68 MIDIClock_Slave::rebind (MidiPort& port)
  69 {
  70         DEBUG_TRACE (DEBUG::MidiClock, string_compose ("MIDIClock_Slave: connecting to port %1\n", port.name()));
  71
  72         port_connections.drop_connections ();
  73
  74         port.self_parser().timing.connect_same_thread (port_connections, boost::bind (&MIDIClock_Slave::update_midi_clock, this, _1, _2));
  75         port.self_parser().start.connect_same_thread (port_connections, boost::bind (&MIDIClock_Slave::start, this, _1, _2));
  76         port.self_parser().contineu.connect_same_thread (port_connections, boost::bind (&MIDIClock_Slave::contineu, this, _1, _2));
  77         port.self_parser().stop.connect_same_thread (port_connections, boost::bind (&MIDIClock_Slave::stop, this, _1, _2));
  78         port.self_parser().position.connect_same_thread (port_connections, boost::bind (&MIDIClock_Slave::position, this, _1, _2, 3));
  79
  80 }
  81
  82 void
  83 MIDIClock_Slave::calculate_one_ppqn_in_frames_at(framepos_t time)
  84 {
  85         const double frames_per_quarter_note = session->tempo_map().frames_per_quarter_note_at (time, session->frame_rate());
  86
  87         one_ppqn_in_frames = frames_per_quarter_note / double (ppqn);
  88         // DEBUG_TRACE (DEBUG::MidiClock, string_compose ("at %1, one ppqn = %2\n", time, one_ppqn_in_frames));
  89 }
  90
  91 ARDOUR::framepos_t
  92 MIDIClock_Slave::calculate_song_position(uint16_t song_position_in_sixteenth_notes)
  93 {
  94         framepos_t song_position_frames = 0;
  95         for (uint16_t i = 1; i <= song_position_in_sixteenth_notes; ++i) {
  96                 // one quarter note contains ppqn pulses, so a sixteenth note is ppqn / 4 pulses
  97                 calculate_one_ppqn_in_frames_at(song_position_frames);
  98                 song_position_frames += one_ppqn_in_frames * (framepos_t)(ppqn / 4);
  99         }
 100
 101         return song_position_frames;
 102 }
 103
 104 void
 105 MIDIClock_Slave::calculate_filter_coefficients()
 106 {
 107         // omega = 2 * PI * Bandwidth / MIDI clock frame frequency in Hz
 108         omega = 2.0 * M_PI * bandwidth * one_ppqn_in_frames / session->frame_rate();
 109         b = 1.4142135623730950488 * omega;
 110         c = omega * omega;
 111 }
 112
 113 void
 114 MIDIClock_Slave::update_midi_clock (Parser& /*parser*/, framepos_t timestamp)
 115 {
 116         // some pieces of hardware send MIDI Clock all the time
 117         if ( (!_starting) && (!_started) ) {
 118                 return;
 119         }
 120
 121         pframes_t cycle_offset = timestamp - session->sample_time_at_cycle_start();
 122
 123         calculate_one_ppqn_in_frames_at(should_be_position);
 124
 125         framepos_t elapsed_since_start = timestamp - first_timestamp;
 126         double error = 0;
 127
 128         if (_starting || last_timestamp == 0) {
 129                 midi_clock_count = 0;
 130
 131                 first_timestamp = timestamp;
 132                 elapsed_since_start = should_be_position;
 133
 134                 DEBUG_TRACE (DEBUG::MidiClock, string_compose ("first clock message after start received @ %1\n", timestamp));
 135
 136                 // calculate filter coefficients
 137                 calculate_filter_coefficients();
 138
 139                 // initialize DLL
 140                 e2 = double(one_ppqn_in_frames) / double(session->frame_rate());
 141                 t0 = double(elapsed_since_start) / double(session->frame_rate());
 142                 t1 = t0 + e2;
 143
 144                 // let ardour go after first MIDI Clock Event
 145                 _starting = false;
 146         } else {
 147                 midi_clock_count++;
 148                 should_be_position  += one_ppqn_in_frames;
 149                 calculate_filter_coefficients();
 150
 151                 // calculate loop error
 152                 // we use session->transport_frame() instead of t1 here
 153                 // because t1 is used to calculate the transport speed,
 154                 // so the loop will compensate for accumulating rounding errors
 155                 error = (double(should_be_position) - (double(session->transport_frame()) + double(cycle_offset)));
 156                 e = error / double(session->frame_rate());
 157                 current_delta = error;
 158
 159                 // update DLL
 160                 t0 = t1;
 161                 t1 += b * e + e2;
 162                 e2 += c * e;
 163         }
 164
 165         DEBUG_TRACE (DEBUG::MidiClock, string_compose ("clock #%1 @ %2 should-be %3 transport %4 error %5 appspeed %6 "
 166                                                        "read-delta %7 should-be delta %8 t1-t0 %9 t0 %10 t1 %11 framerate %12 engine %13\n",
 167                                                        midi_clock_count,                                          // #
 168                                                        elapsed_since_start,                                       // @
 169                                                        should_be_position,                                        // should-be
 170                                                        session->transport_frame(),                                // transport
 171                                                        error,                                                     // error
 172                                                        ((t1 - t0) * session->frame_rate()) / one_ppqn_in_frames, // appspeed
 173                                                        timestamp - last_timestamp,                                // read delta
 174                                                        one_ppqn_in_frames,                                        // should-be delta
 175                                                        (t1 - t0) * session->frame_rate(),                         // t1-t0
 176                                                        t0 * session->frame_rate(),                                // t0
 177                                                        t1 * session->frame_rate(),                                // t1
 178                                                        session->frame_rate(),                                      // framerate
 179                                                        session->frame_time()
 180
 181         ));
 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 transport_frame %3\n", timestamp, session->frame_time(), session->transport_frame()));
 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         DEBUG_TRACE (DEBUG::MidiClock, string_compose ("MidiClock_Slave reset(): calculated filter bandwidth is %1 for period size %2\n", bandwidth, session->frames_per_cycle()));
 205
 206         should_be_position = session->transport_frame();
 207         last_timestamp = 0;
 208
 209         _starting = true;
 210         _started  = true;
 211
 212         // session->request_locate(0, false);
 213         current_delta = 0;
 214 }
 215
 216 void
 217 MIDIClock_Slave::contineu (Parser& /*parser*/, framepos_t /*timestamp*/)
 218 {
 219         DEBUG_TRACE (DEBUG::MidiClock, "MIDIClock_Slave got continue message\n");
 220
 221         if (!_started) {
 222                 _starting = true;
 223                 _started  = true;
 224         }
 225 }
 226
 227
 228 void
 229 MIDIClock_Slave::stop (Parser& /*parser*/, framepos_t /*timestamp*/)
 230 {
 231         DEBUG_TRACE (DEBUG::MidiClock, "MIDIClock_Slave got stop message\n");
 232
 233         if (_started || _starting) {
 234                 _starting = false;
 235                 _started  = false;
 236                 // locate to last MIDI clock position
 237                 session->request_transport_speed(0.0);
 238
 239                 // we need to go back to the last MIDI beat (6 ppqn)
 240                 // and lets hope the tempo didnt change in the meantime :)
 241
 242                 // begin at the should be position, because
 243                 // that is the position of the last MIDI Clock
 244                 // message and that is probably what the master
 245                 // expects where we are right now
 246                 framepos_t stop_position = should_be_position;
 247
 248                 // find out the last MIDI beat: go back #midi_clocks mod 6
 249                 // and lets hope the tempo didnt change in those last 6 beats :)
 250                 stop_position -= (midi_clock_count % 6) * one_ppqn_in_frames;
 251
 252                 session->request_locate(stop_position, false);
 253                 should_be_position = stop_position;
 254                 last_timestamp = 0;
 255         }
 256 }
 257
 258 void
 259 MIDIClock_Slave::position (Parser& /*parser*/, MIDI::byte* message, size_t size)
 260 {
 261         // we are note supposed to get position messages while we are running
 262         // so lets be robust and ignore those
 263         if (_started || _starting) {
 264                 return;
 265         }
 266
 267         assert(size == 3);
 268         MIDI::byte lsb = message[1];
 269         MIDI::byte msb = message[2];
 270         assert((lsb <= 0x7f) && (msb <= 0x7f));
 271
 272         uint16_t position_in_sixteenth_notes = (uint16_t(msb) << 7) | uint16_t(lsb);
 273         framepos_t position_in_frames = calculate_song_position(position_in_sixteenth_notes);
 274
 275         DEBUG_TRACE (DEBUG::MidiClock, string_compose ("Song Position: %1 frames: %2\n", position_in_sixteenth_notes, position_in_frames));
 276
 277         session->request_locate(position_in_frames, false);
 278         should_be_position  = position_in_frames;
 279         last_timestamp = 0;
 280
 281 }
 282
 283 bool
 284 MIDIClock_Slave::locked () const
 285 {
 286         return true;
 287 }
 288
 289 bool
 290 MIDIClock_Slave::ok() const
 291 {
 292         return true;
 293 }
 294
 295 bool
 296 MIDIClock_Slave::starting() const
 297 {
 298         return false;
 299 }
 300
 301 bool
 302 MIDIClock_Slave::stop_if_no_more_clock_events(framepos_t& pos, framepos_t now)
 303 {
 304         /* no timecode for 1/4 second ? conclude that its stopped */
 305         if (last_timestamp &&
 306             now > last_timestamp &&
 307             now - last_timestamp > session->frame_rate() / 4) {
 308                 DEBUG_TRACE (DEBUG::MidiClock, "No MIDI Clock frames received for some time, stopping!\n");
 309                 pos = should_be_position;
 310                 session->request_transport_speed (0);
 311                 session->request_locate (should_be_position, false);
 312                 return true;
 313         } else {
 314                 return false;
 315         }
 316 }
 317
 318 bool
 319 MIDIClock_Slave::speed_and_position (double& speed, framepos_t& pos)
 320 {
 321         if (!_started || _starting) {
 322                 speed = 0.0;
 323                 pos   = should_be_position;
 324                 return true;
 325         }
 326
 327         framepos_t engine_now = session->frame_time();
 328
 329         if (stop_if_no_more_clock_events(pos, engine_now)) {
 330                 return false;
 331         }
 332
 333         // calculate speed
 334         speed = ((t1 - t0) * session->frame_rate()) / one_ppqn_in_frames;
 335
 336         // provide a 0.1% deadzone to lock the speed
 337         if (fabs(speed - 1.0) <= 0.001)
 338                 speed = 1.0;
 339
 340         // calculate position
 341         if (engine_now > last_timestamp) {
 342                 // we are in between MIDI clock messages
 343                 // so we interpolate position according to speed
 344                 framecnt_t elapsed = engine_now - last_timestamp;
 345                 pos = (framepos_t) (should_be_position + double(elapsed) * speed);
 346         } else {
 347                 // A new MIDI clock message has arrived this cycle
 348                 pos = should_be_position;
 349         }
 350
 351         DEBUG_TRACE (DEBUG::MidiClock, string_compose ("speed_and_position: speed %1 should-be %2 transport %3 \n", speed, pos, session->transport_frame()));
 352
 353         return true;
 354 }
 355
 356 ARDOUR::framecnt_t
 357 MIDIClock_Slave::resolution() const
 358 {
 359         // one beat
 360         return (framecnt_t) one_ppqn_in_frames * ppqn;
 361 }
 362
 363 std::string
 364 MIDIClock_Slave::approximate_current_delta() const
 365 {
 366         char delta[80];
 367         if (last_timestamp == 0 || _starting) {
 368                 snprintf(delta, sizeof(delta), "\u2012\u2012\u2012\u2012");
 369         } else {
 370                 snprintf(delta, sizeof(delta), "\u0394<span foreground=\"green\" face=\"monospace\" >%s%s%" PRIi64 "</span>sm",
 371                                 LEADINGZERO(abs(current_delta)), PLUSMINUS(-current_delta), abs(current_delta));
 372         }
 373         return std::string(delta);
 374 }
 375