path: root/libs/ardour/ticker.cc

/*
    Copyright (C) 2008 Hans Baier

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

#include "pbd/compose.h"
#include "pbd/stacktrace.h"

#include "midi++/port.h"
#include "midi++/jack_midi_port.h"
#include "midi++/manager.h"

#include "evoral/midi_events.h"

#include "ardour/audioengine.h"
#include "ardour/ticker.h"
#include "ardour/session.h"
#include "ardour/tempo.h"
#include "ardour/debug.h"

using namespace ARDOUR;


/** MIDI Clock Position tracking */
class MidiClockTicker::Position : public Timecode::BBT_Time
{
public:

	Position() : speed(0.0f), frame(0) { }
	~Position() { }

	/** Sync timing information taken from the given Session
		@return True if timings differed */
	bool sync (Session* s) {

		bool didit = false;

		double     sp = s->transport_speed();
		framecnt_t fr = s->transport_frame();

		if (speed != sp) {
			speed = sp;
			didit = true;
		}

		if (frame != fr) {

			s->bbt_time (fr, *this);

			const TempoMap& tempo = s->tempo_map();

			const double divisions   = tempo.meter_at(frame).divisions_per_bar();
			const double divisor     = tempo.meter_at(frame).note_divisor();
			const double qnote_scale = divisor * 0.25f;

			frame = fr;

			/* Midi Beats in terms of Song Position Pointer is equivalent to total
			   sixteenth notes at 'time' */

			midi_beats  = (((bars - 1) * divisions) + beats - 1);
			midi_beats += (double)ticks / (double)Position::ticks_per_beat * qnote_scale;
			midi_beats *= 16.0f / divisor;

			midi_clocks = midi_beats * 6.0f;

			didit = true;
		}

		print (std::clog);

		return didit;
	}

	double      speed;
	framecnt_t  frame;
	double      midi_beats;
	double      midi_clocks;

	void print (std::ostream& s) {
		s << "MCLK Position: frames: " << frame << " midi beats: " << midi_beats << " speed: " << speed << std::endl;
	}
};


MidiClockTicker::MidiClockTicker ()
	: _midi_port (0)
	, _ppqn (24)
	, _last_tick (0.0)
{
	_pos = new Position();
}

MidiClockTicker::~MidiClockTicker()
{
	_midi_port = 0;
	if (_pos) {
		delete _pos;
		_pos = 0;
	}
}

void
MidiClockTicker::set_session (Session* s)
{
	SessionHandlePtr::set_session (s);
	
	 if (_session) {
		 _session->TransportStateChange.connect_same_thread (_session_connections, boost::bind (&MidiClockTicker::transport_state_changed, this));
		 _session->PositionChanged.connect_same_thread (_session_connections, boost::bind (&MidiClockTicker::position_changed, this, _1));
		 _session->TransportLooped.connect_same_thread (_session_connections, boost::bind (&MidiClockTicker::transport_looped, this));
		 _session->Located.connect_same_thread (_session_connections, boost::bind (&MidiClockTicker::session_located, this));

		 update_midi_clock_port();
		 _pos->sync (_session);
	 }
}

void
MidiClockTicker::session_located()
{
	if (0 == _session || ! _pos->sync (_session)) {
		return;
	}

	_last_tick = _pos->frame;

	// WIP - Testing code
	if (0 == _pos->frame) {
		std::clog << "zero frame\n";
		if (1.0f == _pos->speed) {
			std::clog << "normal speed:\n";

		}
	}
}

void
MidiClockTicker::session_going_away ()
{
	SessionHandlePtr::session_going_away();
	_midi_port = 0;
}

void
MidiClockTicker::update_midi_clock_port()
{
	_midi_port = MIDI::Manager::instance()->midi_clock_output_port();
}

void
MidiClockTicker::transport_state_changed()
{
	if (_session->exporting()) {
		/* no midi clock during export, for now */
		return;
	}

	if (!_session->engine().running()) {
		/* Engine stopped, we can't do anything */
		return;
	}

	float      speed    = _session->transport_speed();
	framepos_t position = _session->transport_frame();

	DEBUG_TRACE (PBD::DEBUG::MidiClock,
		 string_compose ("Transport state change @ %4, speed: %1 position: %2 play loop: %3\n", speed, position, _session->get_play_loop(), position)
	);

	if (speed == 1.0f) {
		_last_tick = position;

		if (!Config->get_send_midi_clock())
			return;

		if (_session->get_play_loop()) {
			assert(_session->locations()->auto_loop_location());
			if (position == _session->locations()->auto_loop_location()->start()) {
				send_start_event(0);
			} else {
				send_continue_event(0);
			}
		} else if (position == 0) {
			send_start_event(0);
		} else {
			send_continue_event(0);
		}

		send_midi_clock_event(0);

	} else if (speed == 0.0f) {
		if (!Config->get_send_midi_clock())
			return;

		send_stop_event(0);
		send_position_event (position, 0);
	}

	tick (position);
}

void
MidiClockTicker::position_changed (framepos_t position)
{
	const double speed = _session->transport_speed();
	DEBUG_TRACE (PBD::DEBUG::MidiClock, string_compose ("Transport Position Change: %1, speed: %2\n", position, speed));

	if (speed == 0.0f && Config->get_send_midi_clock()) {
		send_position_event (position, 0);
	}

	_last_tick = position;
}

void
MidiClockTicker::transport_looped()
{
	Location* loop_location = _session->locations()->auto_loop_location();
	assert(loop_location);

	DEBUG_TRACE (PBD::DEBUG::MidiClock,
		     string_compose ("Transport looped, position: %1, loop start: %2, loop end: %3, play loop: %4\n",
				     _session->transport_frame(), loop_location->start(), loop_location->end(), _session->get_play_loop())
		);

	// adjust _last_tick, so that the next MIDI clock message is sent
	// in due time (and the tick interval is still constant)

	framecnt_t elapsed_since_last_tick = loop_location->end() - _last_tick;

	if (loop_location->start() > elapsed_since_last_tick) {
		_last_tick = loop_location->start() - elapsed_since_last_tick;
	} else {
		_last_tick = 0;
	}
}

void
MidiClockTicker::tick (const framepos_t& transport_frame)
{

	if (!Config->get_send_midi_clock() || _session == 0 || _session->transport_speed() != 1.0f || _midi_port == 0) {
		return;
	}

	while (true) {
		double next_tick = _last_tick + one_ppqn_in_frames (transport_frame);
		frameoffset_t next_tick_offset = llrint (next_tick) - transport_frame;


		MIDI::JackMIDIPort* mp = dynamic_cast<MIDI::JackMIDIPort*> (_midi_port);
		

		DEBUG_TRACE (PBD::DEBUG::MidiClock,
			     string_compose ("Transport: %1, last tick time: %2, next tick time: %3, offset: %4, cycle length: %5\n",
					     transport_frame, _last_tick, next_tick, next_tick_offset, mp ? mp->nframes_this_cycle() : 0));


		if (!mp || (next_tick_offset >= mp->nframes_this_cycle())) {
			break;
		}

		if (next_tick_offset >= 0) {
			send_midi_clock_event (next_tick_offset);
		}

		_pos->frame = _last_tick = next_tick;
	}
}

double
MidiClockTicker::one_ppqn_in_frames (framepos_t transport_position)
{
	const Tempo& current_tempo = _session->tempo_map().tempo_at (transport_position);
	double frames_per_beat = current_tempo.frames_per_beat (_session->nominal_frame_rate());

	double quarter_notes_per_beat = 4.0 / current_tempo.note_type();
	double frames_per_quarter_note = frames_per_beat / quarter_notes_per_beat;

	return frames_per_quarter_note / double (_ppqn);
}

void
MidiClockTicker::send_midi_clock_event (pframes_t offset)
{
	if (!_midi_port) {
		return;
	}

	// DEBUG_TRACE (PBD::DEBUG::MidiClock, string_compose ("Tick with offset %1\n", offset));

	static uint8_t _midi_clock_tick[1] = { MIDI_CMD_COMMON_CLOCK };
	_midi_port->write (_midi_clock_tick, 1, offset);
}

void
MidiClockTicker::send_start_event (pframes_t offset)
{
	if (!_midi_port) {
		return;
	}

	DEBUG_TRACE (PBD::DEBUG::MidiClock, string_compose ("Start %1\n", _last_tick));

	static uint8_t _midi_clock_tick[1] = { MIDI_CMD_COMMON_START };
	_midi_port->write (_midi_clock_tick, 1, offset);
}

void
MidiClockTicker::send_continue_event (pframes_t offset)
{
	if (!_midi_port) {
		return;
	}

	DEBUG_TRACE (PBD::DEBUG::MidiClock, string_compose ("Continue %1\n", _last_tick));

	static uint8_t _midi_clock_tick[1] = { MIDI_CMD_COMMON_CONTINUE };
	_midi_port->write (_midi_clock_tick, 1, offset);
}

void
MidiClockTicker::send_stop_event (pframes_t offset)
{
	if (!_midi_port) {
		return;
	}

	DEBUG_TRACE (PBD::DEBUG::MidiClock, string_compose ("Stop %1\n", _last_tick));

	static uint8_t _midi_clock_tick[1] = { MIDI_CMD_COMMON_STOP };
	_midi_port->write (_midi_clock_tick, 1, offset);
}

void
MidiClockTicker::send_position_event (framepos_t transport_position, pframes_t offset)
{
	if (_midi_port == 0 || _session == 0 || _session->engine().freewheeling()) {
		return;
	}

	const TempoMap& tempo = _session->tempo_map();

	Timecode::BBT_Time time;
	_session->bbt_time (transport_position, time);
	const double beats_per_bar = tempo.meter_at(transport_position).divisions_per_bar();

	/* Midi Beats in terms of Song Position Pointer is equivalent to total
	   sixteenth notes at 'time' */
	const uint32_t midi_beats = 4 * (((time.bars - 1) * beats_per_bar) + time.beats - 1);

	/* can only use 14bits worth */
	if (midi_beats > 0x3fff) {
		return;
	}

	/* split midi beats into a 14bit value */
	MIDI::byte msg[3] = {
		MIDI_CMD_COMMON_SONG_POS,
		midi_beats & 0x007f,
		midi_beats & 0x3f80
	};

	DEBUG_TRACE (PBD::DEBUG::MidiClock, string_compose ("Song Position: %1\n", midi_beats));

	_midi_port->midimsg (msg, sizeof (msg), offset);
}