libs/ardour/ticker.cc

   1 /*
   2     Copyright (C) 2008 Hans Baier
   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 #include "pbd/compose.h"
  20 #include "pbd/stacktrace.h"
  21
  22 #include "midi++/port.h"
  23 #include "midi++/jack_midi_port.h"
  24 #include "midi++/manager.h"
  25
  26 #include "evoral/midi_events.h"
  27
  28 #include "ardour/audioengine.h"
  29 #include "ardour/ticker.h"
  30 #include "ardour/session.h"
  31 #include "ardour/tempo.h"
  32 #include "ardour/debug.h"
  33
  34 using namespace ARDOUR;
  35
  36 MidiClockTicker::MidiClockTicker ()
  37         : _midi_port (0)
  38         , _ppqn (24)
  39         , _last_tick (0.0)
  40 {
  41 }
  42
  43 void MidiClockTicker::set_session (Session* s)
  44 {
  45         SessionHandlePtr::set_session (s);
  46
  47          if (_session) {
  48                  _session->TransportStateChange.connect_same_thread (_session_connections, boost::bind (&MidiClockTicker::transport_state_changed, this));
  49                  _session->PositionChanged.connect_same_thread (_session_connections, boost::bind (&MidiClockTicker::position_changed, this, _1));
  50                  _session->TransportLooped.connect_same_thread (_session_connections, boost::bind (&MidiClockTicker::transport_looped, this));
  51                  update_midi_clock_port();
  52          }
  53 }
  54
  55 void
  56 MidiClockTicker::session_going_away ()
  57 {
  58         SessionHandlePtr::session_going_away();
  59         _midi_port = 0;
  60 }
  61
  62 void MidiClockTicker::update_midi_clock_port()
  63 {
  64         _midi_port = MIDI::Manager::instance()->midi_clock_output_port();
  65 }
  66
  67 void MidiClockTicker::transport_state_changed()
  68 {
  69         if (_session->exporting()) {
  70                 /* no midi clock during export, for now */
  71                 return;
  72         }
  73
  74         if (!_session->engine().running()) {
  75                 /* Engine stopped, we can't do anything */
  76                 return;
  77         }
  78
  79         float      speed    = _session->transport_speed();
  80         framepos_t position = _session->transport_frame();
  81
  82         DEBUG_TRACE (PBD::DEBUG::MidiClock,
  83                  string_compose ("Transport state change @ %4, speed: %1 position: %2 play loop: %3\n", speed, position, _session->get_play_loop(), position)
  84         );
  85
  86         if (speed == 1.0f) {
  87                 _last_tick = position;
  88
  89                 if (!Config->get_send_midi_clock())
  90                         return;
  91
  92                 if (_session->get_play_loop()) {
  93                         assert(_session->locations()->auto_loop_location());
  94                         if (position == _session->locations()->auto_loop_location()->start()) {
  95                                 send_start_event(0);
  96                         } else {
  97                                 send_continue_event(0);
  98                         }
  99                 } else if (position == 0) {
 100                         send_start_event(0);
 101                 } else {
 102                         send_continue_event(0);
 103                 }
 104
 105                 send_midi_clock_event(0);
 106
 107         } else if (speed == 0.0f) {
 108                 if (!Config->get_send_midi_clock())
 109                         return;
 110
 111                 send_stop_event(0);
 112                 send_position_event (position, 0);
 113         }
 114
 115         tick (position);
 116 }
 117
 118 void MidiClockTicker::position_changed (framepos_t position)
 119 {
 120         const double speed = _session->transport_speed();
 121         DEBUG_TRACE (PBD::DEBUG::MidiClock, string_compose ("Transport Position Change: %1, speed: %2\n", position, speed));
 122
 123         if (speed == 0.0f && Config->get_send_midi_clock()) {
 124                 send_position_event (position, 0);
 125         }
 126
 127         _last_tick = position;
 128 }
 129
 130 void MidiClockTicker::transport_looped()
 131 {
 132         Location* loop_location = _session->locations()->auto_loop_location();
 133         assert(loop_location);
 134
 135         DEBUG_TRACE (PBD::DEBUG::MidiClock,
 136                      string_compose ("Transport looped, position: %1, loop start: %2, loop end: %3, play loop: %4\n",
 137                                      _session->transport_frame(), loop_location->start(), loop_location->end(), _session->get_play_loop())
 138                 );
 139
 140         // adjust _last_tick, so that the next MIDI clock message is sent
 141         // in due time (and the tick interval is still constant)
 142
 143         framecnt_t elapsed_since_last_tick = loop_location->end() - _last_tick;
 144
 145         if (loop_location->start() > elapsed_since_last_tick) {
 146                 _last_tick = loop_location->start() - elapsed_since_last_tick;
 147         } else {
 148                 _last_tick = 0;
 149         }
 150 }
 151
 152 void MidiClockTicker::tick (const framepos_t& transport_frame)
 153 {
 154         if (!Config->get_send_midi_clock() || _session == 0 || _session->transport_speed() != 1.0f || _midi_port == 0) {
 155                 return;
 156         }
 157
 158         while (true) {
 159                 double next_tick = _last_tick + one_ppqn_in_frames (transport_frame);
 160                 frameoffset_t next_tick_offset = llrint (next_tick) - transport_frame;
 161
 162                 MIDI::JackMIDIPort* mp = dynamic_cast<MIDI::JackMIDIPort*> (_midi_port);
 163
 164                 /*
 165                 DEBUG_TRACE (PBD::DEBUG::MidiClock,
 166                              string_compose ("Transport: %1, last tick time: %2, next tick time: %3, offset: %4, cycle length: %5\n",
 167                                              transport_frame, _last_tick, next_tick, next_tick_offset, mp ? mp->nframes_this_cycle() : 0));
 168                 */
 169
 170                 if (!mp || (next_tick_offset >= mp->nframes_this_cycle())) {
 171                         break;
 172                 }
 173
 174                 if (next_tick_offset >= 0) {
 175                         send_midi_clock_event (next_tick_offset);
 176                 }
 177
 178                 _last_tick = next_tick;
 179         }
 180 }
 181
 182 double MidiClockTicker::one_ppqn_in_frames (framepos_t transport_position)
 183 {
 184         const Tempo& current_tempo = _session->tempo_map().tempo_at (transport_position);
 185         double frames_per_beat = current_tempo.frames_per_beat (_session->nominal_frame_rate());
 186
 187         double quarter_notes_per_beat = 4.0 / current_tempo.note_type();
 188         double frames_per_quarter_note = frames_per_beat / quarter_notes_per_beat;
 189
 190         return frames_per_quarter_note / double (_ppqn);
 191 }
 192
 193 void MidiClockTicker::send_midi_clock_event (pframes_t offset)
 194 {
 195         if (!_midi_port) {
 196                 return;
 197         }
 198
 199         // DEBUG_TRACE (PBD::DEBUG::MidiClock, string_compose ("Tick with offset %1\n", offset));
 200
 201         static uint8_t _midi_clock_tick[1] = { MIDI_CMD_COMMON_CLOCK };
 202         _midi_port->write (_midi_clock_tick, 1, offset);
 203 }
 204
 205 void MidiClockTicker::send_start_event (pframes_t offset)
 206 {
 207         if (!_midi_port) {
 208                 return;
 209         }
 210
 211         DEBUG_TRACE (PBD::DEBUG::MidiClock, string_compose ("Start %1\n", _last_tick));
 212
 213         static uint8_t _midi_clock_tick[1] = { MIDI_CMD_COMMON_START };
 214         _midi_port->write (_midi_clock_tick, 1, offset);
 215 }
 216
 217 void MidiClockTicker::send_continue_event (pframes_t offset)
 218 {
 219         if (!_midi_port) {
 220                 return;
 221         }
 222
 223         DEBUG_TRACE (PBD::DEBUG::MidiClock, string_compose ("Continue %1\n", _last_tick));
 224
 225         static uint8_t _midi_clock_tick[1] = { MIDI_CMD_COMMON_CONTINUE };
 226         _midi_port->write (_midi_clock_tick, 1, offset);
 227 }
 228
 229 void MidiClockTicker::send_stop_event (pframes_t offset)
 230 {
 231         if (!_midi_port) {
 232                 return;
 233         }
 234
 235         DEBUG_TRACE (PBD::DEBUG::MidiClock, string_compose ("Stop %1\n", _last_tick));
 236
 237         static uint8_t _midi_clock_tick[1] = { MIDI_CMD_COMMON_STOP };
 238         _midi_port->write (_midi_clock_tick, 1, offset);
 239 }
 240
 241 void
 242 MidiClockTicker::send_position_event (framepos_t transport_position, pframes_t offset)
 243 {
 244         if (_midi_port == 0 || _session == 0 || _session->engine().freewheeling()) {
 245                 return;
 246         }
 247
 248         const TempoMap& tempo = _session->tempo_map();
 249
 250         Timecode::BBT_Time time;
 251         _session->bbt_time (transport_position, time);
 252         const double beats_per_bar = tempo.meter_at(transport_position).divisions_per_bar();
 253
 254         /* Midi Beats in terms of Song Position Pointer is equivalent to total
 255            sixteenth notes at 'time' */
 256         const uint32_t midi_beats = 4 * (((time.bars - 1) * beats_per_bar) + time.beats - 1);
 257
 258         /* can only use 14bits worth */
 259         if (midi_beats > 0x3fff) {
 260                 return;
 261         }
 262
 263         /* split midi beats into a 14bit value */
 264         MIDI::byte msg[3] = {
 265                 MIDI_CMD_COMMON_SONG_POS,
 266                 midi_beats & 0x007f,
 267                 midi_beats & 0x3f80
 268         };
 269
 270         DEBUG_TRACE (PBD::DEBUG::MidiClock, string_compose ("Song Position: %1\n", midi_beats));
 271
 272         _midi_port->midimsg (msg, sizeof (msg), offset);
 273 }