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 "midi++/port.h"
23 #include "midi++/jack_midi_port.h"
24 #include "midi++/manager.h"
26 #include "evoral/midi_events.h"
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"
34 using namespace ARDOUR;
37 /** MIDI Clock Position tracking */
38 class MidiClockTicker::Position : public Timecode::BBT_Time
42 Position() : speed(0.0f), frame(0) { }
45 /** Sync timing information taken from the given Session
46 @return True if timings differed */
47 bool sync (Session* s) {
51 double sp = s->transport_speed();
52 framecnt_t fr = s->transport_frame();
64 /* Midi beats and clocks always gets updated for now */
66 s->bbt_time (this->frame, *this);
68 const TempoMap& tempo = s->tempo_map();
70 const double divisions = tempo.meter_at(frame).divisions_per_bar();
71 const double divisor = tempo.meter_at(frame).note_divisor();
72 const double qnote_scale = divisor * 0.25f;
74 /** Midi Beats in terms of Song Position Pointer is equivalent to total
75 sixteenth notes at 'time' */
77 midi_beats = (((bars - 1) * divisions) + beats - 1);
78 midi_beats += (double)ticks / (double)Position::ticks_per_beat * qnote_scale;
79 midi_beats *= 16.0f / divisor;
81 midi_clocks = midi_beats * 6.0f;
91 void print (std::ostream& s) {
92 s << "frames: " << frame << " midi beats: " << midi_beats << " speed: " << speed;
97 MidiClockTicker::MidiClockTicker ()
102 _pos.reset (new Position());
105 MidiClockTicker::~MidiClockTicker()
112 MidiClockTicker::set_session (Session* s)
114 SessionHandlePtr::set_session (s);
117 _session->TransportStateChange.connect_same_thread (_session_connections, boost::bind (&MidiClockTicker::transport_state_changed, this));
118 _session->PositionChanged.connect_same_thread (_session_connections, boost::bind (&MidiClockTicker::position_changed, this, _1));
119 _session->TransportLooped.connect_same_thread (_session_connections, boost::bind (&MidiClockTicker::transport_looped, this));
120 _session->Located.connect_same_thread (_session_connections, boost::bind (&MidiClockTicker::session_located, this));
122 update_midi_clock_port();
123 _pos->sync (_session);
128 MidiClockTicker::session_located()
130 DEBUG_TRACE (DEBUG::MidiClock, string_compose ("Session Located: %1, speed: %2\n", _session->transport_frame(), _session->transport_speed()));
132 if (0 == _session || ! _pos->sync (_session)) {
136 _last_tick = _pos->frame;
138 if (!Config->get_send_midi_clock()) {
142 if (_pos->speed == 0.0f) {
143 uint32_t where = llrint (_pos->midi_beats);
144 send_position_event (where, 0);
145 } else if (_pos->speed == 1.0f) {
147 /* Experimental. To really do this and have accuracy, the
148 stop/locate/continue sequence would need queued to send immediately
149 before the next midi clock. */
153 if (_pos->frame == 0) {
154 send_start_event (0);
156 uint32_t where = llrint (_pos->midi_beats);
157 send_position_event (where, 0);
158 send_continue_event (0);
162 /* Varispeed not supported */
167 MidiClockTicker::session_going_away ()
169 SessionHandlePtr::session_going_away();
174 MidiClockTicker::update_midi_clock_port()
176 _midi_port = MIDI::Manager::instance()->midi_clock_output_port();
180 MidiClockTicker::transport_state_changed()
182 if (_session->exporting()) {
183 /* no midi clock during export, for now */
187 if (!_session->engine().running()) {
188 /* Engine stopped, we can't do anything */
192 if (! _pos->sync (_session)) {
196 DEBUG_TRACE (DEBUG::MidiClock,
197 string_compose ("Transport state change @ %4, speed: %1 position: %2 play loop: %3\n",
198 _pos->speed, _pos->frame, _session->get_play_loop(), _pos->frame)
201 _last_tick = _pos->frame;
203 if (! Config->get_send_midi_clock()) {
207 if (_pos->speed == 1.0f) {
209 if (_session->get_play_loop()) {
210 assert(_session->locations()->auto_loop_location());
212 if (_pos->frame == _session->locations()->auto_loop_location()->start()) {
215 send_continue_event(0);
218 } else if (_pos->frame == 0) {
221 send_continue_event(0);
224 // send_midi_clock_event (0);
226 } else if (_pos->speed == 0.0f) {
228 send_position_event (llrint (_pos->midi_beats), 0);
231 // tick (_pos->frame);
235 MidiClockTicker::position_changed (framepos_t)
238 const double speed = _session->transport_speed();
239 DEBUG_TRACE (DEBUG::MidiClock, string_compose ("Transport Position Change: %1, speed: %2\n", position, speed));
241 if (speed == 0.0f && Config->get_send_midi_clock()) {
242 send_position_event (position, 0);
245 _last_tick = position;
250 MidiClockTicker::transport_looped()
252 Location* loop_location = _session->locations()->auto_loop_location();
253 assert(loop_location);
255 DEBUG_TRACE (DEBUG::MidiClock,
256 string_compose ("Transport looped, position: %1, loop start: %2, loop end: %3, play loop: %4\n",
257 _session->transport_frame(), loop_location->start(), loop_location->end(), _session->get_play_loop())
260 // adjust _last_tick, so that the next MIDI clock message is sent
261 // in due time (and the tick interval is still constant)
263 framecnt_t elapsed_since_last_tick = loop_location->end() - _last_tick;
265 if (loop_location->start() > elapsed_since_last_tick) {
266 _last_tick = loop_location->start() - elapsed_since_last_tick;
273 MidiClockTicker::tick (const framepos_t& /* transport_frame */)
275 if (!Config->get_send_midi_clock() || _session == 0 || _session->transport_speed() != 1.0f || _midi_port == 0) {
279 MIDI::JackMIDIPort* mp = dynamic_cast<MIDI::JackMIDIPort*> (_midi_port);
284 const framepos_t end = _pos->frame + mp->nframes_this_cycle();
285 double iter = _last_tick;
288 double clock_delta = one_ppqn_in_frames (llrint (iter));
289 double next_tick = iter + clock_delta;
290 frameoffset_t next_tick_offset = llrint (next_tick) - end;
292 DEBUG_TRACE (DEBUG::MidiClock,
293 string_compose ("Tick: iter: %1, last tick time: %2, next tick time: %3, offset: %4, cycle length: %5\n",
294 iter, _last_tick, next_tick, next_tick_offset, mp ? mp->nframes_this_cycle() : 0));
296 if (!mp || (next_tick_offset >= mp->nframes_this_cycle())) {
300 if (next_tick_offset >= 0) {
301 send_midi_clock_event (next_tick_offset);
313 MidiClockTicker::one_ppqn_in_frames (framepos_t transport_position)
315 const Tempo& current_tempo = _session->tempo_map().tempo_at (transport_position);
316 double frames_per_beat = current_tempo.frames_per_beat (_session->nominal_frame_rate());
318 double quarter_notes_per_beat = 4.0 / current_tempo.note_type();
319 double frames_per_quarter_note = frames_per_beat / quarter_notes_per_beat;
321 return frames_per_quarter_note / double (_ppqn);
325 MidiClockTicker::send_midi_clock_event (pframes_t offset)
331 DEBUG_TRACE (DEBUG::MidiClock, string_compose ("Tick with offset %1\n", offset));
333 static uint8_t _midi_clock_tick[1] = { MIDI_CMD_COMMON_CLOCK };
334 _midi_port->write (_midi_clock_tick, 1, offset);
338 MidiClockTicker::send_start_event (pframes_t offset)
344 DEBUG_TRACE (DEBUG::MidiClock, string_compose ("Start %1\n", _last_tick));
346 static uint8_t _midi_clock_tick[1] = { MIDI_CMD_COMMON_START };
347 _midi_port->write (_midi_clock_tick, 1, offset);
351 MidiClockTicker::send_continue_event (pframes_t offset)
357 DEBUG_TRACE (DEBUG::MidiClock, string_compose ("Continue %1\n", _last_tick));
359 static uint8_t _midi_clock_tick[1] = { MIDI_CMD_COMMON_CONTINUE };
360 _midi_port->write (_midi_clock_tick, 1, offset);
364 MidiClockTicker::send_stop_event (pframes_t offset)
370 DEBUG_TRACE (DEBUG::MidiClock, string_compose ("Stop %1\n", _last_tick));
372 static uint8_t _midi_clock_tick[1] = { MIDI_CMD_COMMON_STOP };
373 _midi_port->write (_midi_clock_tick, 1, offset);
377 MidiClockTicker::send_position_event (uint32_t midi_beats, pframes_t offset)
383 /* can only use 14bits worth */
384 if (midi_beats > 0x3fff) {
388 /* split midi beats into a 14bit value */
389 MIDI::byte msg[3] = {
390 MIDI_CMD_COMMON_SONG_POS,
395 _midi_port->midimsg (msg, sizeof (msg), offset);
397 DEBUG_TRACE (DEBUG::MidiClock, string_compose ("Song Position Sent: %1\n", midi_beats));