2 Copyright (C) 2008 Hans Baier
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.
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.
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.
19 #include "pbd/compose.h"
20 #include "pbd/stacktrace.h"
22 #include "evoral/midi_events.h"
24 #include "ardour/async_midi_port.h"
25 #include "ardour/audioengine.h"
26 #include "ardour/midi_buffer.h"
27 #include "ardour/midi_port.h"
28 #include "ardour/lmath.h"
29 #include "ardour/ticker.h"
30 #include "ardour/session.h"
31 #include "ardour/tempo.h"
32 #include "ardour/debug.h"
34 using namespace ARDOUR;
37 /** MIDI Clock Position tracking */
38 class MidiClockTicker::Position : public Timecode::BBT_Time
42 Position() : speed(0.0f), frame(0), midi_beats(0) { }
45 /** Sync timing information taken from the given Session
46 * @return True if timings differed
49 bool sync (Session* s) {
53 double sp = s->transport_speed();
54 framecnt_t fr = s->transport_frame();
66 /* Midi beats and clocks always gets updated for now */
68 s->bbt_time (this->frame, *this);
70 const TempoMap& tempo = s->tempo_map();
72 const double divisions = tempo.meter_at(frame).divisions_per_bar();
73 const double divisor = tempo.meter_at(frame).note_divisor();
74 const double qnote_scale = divisor * 0.25f;
77 /** Midi Beats in terms of Song Position Pointer is equivalent to total
78 * sixteenth notes at 'time'
81 mb = (((bars - 1) * divisions) + beats - 1);
82 mb += (double)ticks / (double)Position::ticks_per_beat * qnote_scale;
83 mb *= 16.0f / divisor;
85 if (mb != midi_beats) {
87 midi_clocks = midi_beats * 6.0f;
99 void print (std::ostream& s) {
100 s << "frames: " << frame << " midi beats: " << midi_beats << " speed: " << speed;
105 MidiClockTicker::MidiClockTicker ()
109 , _send_state (false)
111 _pos.reset (new Position());
114 MidiClockTicker::~MidiClockTicker()
120 MidiClockTicker::set_session (Session* s)
122 SessionHandlePtr::set_session (s);
125 _session->TransportStateChange.connect_same_thread (_session_connections, boost::bind (&MidiClockTicker::transport_state_changed, this));
126 _session->TransportLooped.connect_same_thread (_session_connections, boost::bind (&MidiClockTicker::transport_looped, this));
127 _session->Located.connect_same_thread (_session_connections, boost::bind (&MidiClockTicker::session_located, this));
129 update_midi_clock_port();
130 _pos->sync (_session);
135 MidiClockTicker::session_located()
137 DEBUG_TRACE (DEBUG::MidiClock, string_compose ("Session Located: %1, speed: %2\n", _session->transport_frame(), _session->transport_speed()));
139 if (!_session || !_pos->sync (_session)) {
143 _last_tick = _pos->frame;
145 if (!Config->get_send_midi_clock()) {
153 MidiClockTicker::session_going_away ()
155 SessionHandlePtr::session_going_away();
160 MidiClockTicker::update_midi_clock_port()
162 _midi_port = _session->midi_clock_output_port();
166 MidiClockTicker::transport_state_changed()
168 if (_session->exporting()) {
169 /* no midi clock during export, for now */
173 if (!_session->engine().running()) {
174 /* Engine stopped, we can't do anything */
178 if (! _pos->sync (_session)) {
182 DEBUG_TRACE (DEBUG::MidiClock,
183 string_compose ("Transport state change @ %4, speed: %1 position: %2 play loop: %3\n",
184 _pos->speed, _pos->frame, _session->get_play_loop(), _pos->frame)
187 _last_tick = _pos->frame;
189 if (! Config->get_send_midi_clock()) {
195 // tick (_pos->frame);
199 MidiClockTicker::transport_looped()
201 Location* loop_location = _session->locations()->auto_loop_location();
202 assert(loop_location);
204 DEBUG_TRACE (DEBUG::MidiClock,
205 string_compose ("Transport looped, position: %1, loop start: %2, loop end: %3, play loop: %4\n",
206 _session->transport_frame(), loop_location->start(), loop_location->end(), _session->get_play_loop())
209 // adjust _last_tick, so that the next MIDI clock message is sent
210 // in due time (and the tick interval is still constant)
212 framecnt_t elapsed_since_last_tick = loop_location->end() - _last_tick;
214 if (loop_location->start() > elapsed_since_last_tick) {
215 _last_tick = loop_location->start() - elapsed_since_last_tick;
222 MidiClockTicker::tick (const framepos_t& /* transport_frame */, pframes_t nframes)
224 if (!Config->get_send_midi_clock() || _session == 0 || _midi_port == 0) {
229 if (_pos->speed == 0.0f) {
230 send_position_event (llrint (_pos->midi_beats), 0, nframes);
231 } else if (_pos->speed == 1.0f) {
232 send_stop_event (0, nframes);
234 if (_pos->frame == 0) {
235 send_start_event (0, nframes);
237 send_position_event (llrint (_pos->midi_beats), 0, nframes);
238 send_continue_event (0, nframes);
241 /* Varispeed not supported */
249 if (_pos->speed == 1.0f) {
250 if (_session->get_play_loop()) {
251 assert(_session->locations()->auto_loop_location());
253 if (_pos->frame == _session->locations()->auto_loop_location()->start()) {
254 send_start_event (0, nframes);
256 send_continue_event (0, nframes);
259 } else if (_pos->frame == 0) {
260 send_start_event (0, nframes);
262 send_continue_event (0, nframes);
265 // send_midi_clock_event (0);
267 } else if (_pos->speed == 0.0f) {
268 send_stop_event (0, nframes);
269 send_position_event (llrint (_pos->midi_beats), 0, nframes);
275 if (_session->transport_speed() != 1.0f) {
276 /* no varispeed support and nothing to do after this if stopped */
280 const framepos_t end = _pos->frame + nframes;
281 double iter = _last_tick;
284 double clock_delta = one_ppqn_in_frames (llrint (iter));
285 double next_tick = iter + clock_delta;
286 frameoffset_t next_tick_offset = llrint (next_tick) - end;
288 DEBUG_TRACE (DEBUG::MidiClock,
289 string_compose ("Tick: iter: %1, last tick time: %2, next tick time: %3, offset: %4, cycle length: %5\n",
290 iter, _last_tick, next_tick, next_tick_offset, nframes));
292 if (next_tick_offset >= nframes) {
296 if (next_tick_offset >= 0) {
297 send_midi_clock_event (next_tick_offset, nframes);
308 MidiClockTicker::one_ppqn_in_frames (framepos_t transport_position)
310 const Tempo& current_tempo = _session->tempo_map().tempo_at (transport_position);
311 double frames_per_beat = _session->tempo_map().frames_per_beat_at (transport_position, _session->nominal_frame_rate());
313 double quarter_notes_per_beat = 4.0 / current_tempo.note_type();
314 double frames_per_quarter_note = frames_per_beat / quarter_notes_per_beat;
316 return frames_per_quarter_note / double (_ppqn);
320 MidiClockTicker::send_midi_clock_event (pframes_t offset, pframes_t nframes)
326 static uint8_t msg = MIDI_CMD_COMMON_CLOCK;
328 MidiBuffer& mb (_midi_port->get_midi_buffer (nframes));
329 mb.push_back (offset, 1, &msg);
331 DEBUG_TRACE (DEBUG::MidiClock, string_compose ("Tick with offset %1\n", offset));
335 MidiClockTicker::send_start_event (pframes_t offset, pframes_t nframes)
341 static uint8_t msg = { MIDI_CMD_COMMON_START };
342 MidiBuffer& mb (_midi_port->get_midi_buffer (nframes));
343 mb.push_back (offset, 1, &msg);
345 DEBUG_TRACE (DEBUG::MidiClock, string_compose ("Start %1\n", _last_tick));
349 MidiClockTicker::send_continue_event (pframes_t offset, pframes_t nframes)
355 static uint8_t msg = { MIDI_CMD_COMMON_CONTINUE };
356 MidiBuffer& mb (_midi_port->get_midi_buffer (nframes));
357 mb.push_back (offset, 1, &msg);
359 DEBUG_TRACE (DEBUG::MidiClock, string_compose ("Continue %1\n", _last_tick));
363 MidiClockTicker::send_stop_event (pframes_t offset, pframes_t nframes)
369 static uint8_t msg = MIDI_CMD_COMMON_STOP;
370 MidiBuffer& mb (_midi_port->get_midi_buffer (nframes));
371 mb.push_back (offset, 1, &msg);
373 DEBUG_TRACE (DEBUG::MidiClock, string_compose ("Stop %1\n", _last_tick));
377 MidiClockTicker::send_position_event (uint32_t midi_beats, pframes_t offset, pframes_t nframes)
383 /* can only use 14bits worth */
384 if (midi_beats > 0x3fff) {
388 /* split midi beats into a 14bit value */
390 msg[0] = MIDI_CMD_COMMON_SONG_POS;
391 msg[1] = midi_beats & 0x007f;
392 msg[2] = midi_beats >> 7;
394 MidiBuffer& mb (_midi_port->get_midi_buffer (nframes));
395 mb.push_back (offset, 3, &msg[0]);
397 DEBUG_TRACE (DEBUG::MidiClock, string_compose ("Song Position Sent: %1 to %2 (events now %3, buf = %4)\n", midi_beats, _midi_port->name(),