ardour/ardour
ardour
/
ardour
13
1
Fork 0
Code Pull Requests Releases Activity
ardour/gtk2_ardour/midi_tracer.cc

617 lines
17 KiB
C++
Raw Permalink Blame History

/*
* Copyright (C) 2010-2011 Carl Hetherington <carl@carlh.net>
* Copyright (C) 2010-2018 Paul Davis <paul@linuxaudiosystems.com>
* Copyright (C) 2011 David Robillard <d@drobilla.net>
* Copyright (C) 2013 Michael Fisher <mfisher31@gmail.com>
* Copyright (C) 2014-2015 Robin Gareus <robin@gareus.org>
*
* 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.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#include <cstdint>
#include <sstream>
#include <sys/time.h>
#include <time.h>
#include "pbd/localtime_r.h"
#include "pbd/timersub.h"
#include "midi++/parser.h"
#include "ardour/async_midi_port.h"
#include "ardour/midi_port.h"
#include "ardour/audioengine.h"
#include "ardour/transport_master_manager.h"
#include "midi_tracer.h"
#include "gui_thread.h"
#include "pbd/i18n.h"
unsigned int MidiTracer::window_count = 0;
using namespace Gtk;
using namespace std;
using namespace MIDI;
using namespace Glib;
using namespace ARDOUR;
MidiTracer::MidiTracer ()
: ArdourWindow (_("MIDI Tracer"))
, line_count_adjustment (200, 1, 2000, 1, 10)
, line_count_spinner (line_count_adjustment)
, line_count_label (_("Line history: "))
, _last_receipt (0)
, autoscroll (true)
, show_hex (true)
, show_delta_time (false)
, fifo (1024)
, buffer_pool ("miditracer", buffer_size, 1024) // 1024 256 byte buffers
, autoscroll_button (_("Auto-Scroll"))
, base_button (_("Decimal"))
, collect_button (_("Enabled"))
, delta_time_button (_("Delta times"))
{
_update_queued.store (0);
std::string portname (string_compose(X_("x-MIDI-tracer-%1"), ++window_count));
std::shared_ptr<ARDOUR::Port> port = AudioEngine::instance()->register_input_port (DataType::MIDI, portname, false, PortFlags (IsInput | Hidden | IsTerminal));
tracer_port = std::dynamic_pointer_cast<MidiPort> (port);
_midi_port_list = ListStore::create (_midi_port_cols);
_midi_port_combo.set_model (_midi_port_list);
_midi_port_combo.pack_start (_midi_port_cols.pretty_name);
AudioEngine::instance()->PortRegisteredOrUnregistered.connect
(_manager_connection, invalidator (*this), boost::bind (&MidiTracer::ports_changed, this), gui_context());
VBox* vbox = manage (new VBox);
vbox->set_spacing (4);
HBox* pbox = manage (new HBox);
pbox->set_spacing (6);
pbox->pack_start (*manage (new Label (_("Port:"))), false, false);
_midi_port_combo.signal_changed().connect (sigc::mem_fun (*this, &MidiTracer::port_changed));
pbox->pack_start (_midi_port_combo);
pbox->show_all ();
vbox->pack_start (*pbox, false, false);
scroller.add (text);
vbox->set_border_width (12);
vbox->pack_start (scroller, true, true);
text.show ();
text.set_name ("MidiTracerTextView");
scroller.show ();
scroller.set_size_request (400, 400);
collect_button.set_active (true);
base_button.set_active (false);
autoscroll_button.set_active (true);
line_count_box.set_spacing (6);
line_count_box.pack_start (line_count_label, false, false);
line_count_box.pack_start (line_count_spinner, false, false);
line_count_spinner.show ();
line_count_label.show ();
line_count_box.show ();
HBox* bbox = manage (new HBox);
bbox->add (line_count_box);
bbox->add (delta_time_button);
bbox->add (base_button);
bbox->add (collect_button);
bbox->add (autoscroll_button);
bbox->show ();
vbox->pack_start (*bbox, false, false);
add (*vbox);
base_button.signal_toggled().connect (sigc::mem_fun (*this, &MidiTracer::base_toggle));
collect_button.signal_toggled().connect (sigc::mem_fun (*this, &MidiTracer::collect_toggle));
autoscroll_button.signal_toggled().connect (sigc::mem_fun (*this, &MidiTracer::autoscroll_toggle));
delta_time_button.signal_toggled().connect (sigc::mem_fun (*this, &MidiTracer::delta_toggle));
base_button.show ();
collect_button.show ();
autoscroll_button.show ();
ports_changed ();
port_changed ();
}
MidiTracer::~MidiTracer()
{
disconnect ();
AudioEngine::instance ()->unregister_port (tracer_port);
}
void
MidiTracer::on_show ()
{
ArdourWindow::on_show ();
collect_toggle ();
}
void
MidiTracer::on_hide ()
{
ArdourWindow::on_hide ();
disconnect ();
}
void
MidiTracer::ports_changed ()
{
TreeModel::iterator r = _midi_port_combo.get_active ();
string cpn;
if (r) {
cpn = (*r)[_midi_port_cols.port_name];
}
_midi_port_list->clear ();
PortManager::PortList pl;
AudioEngine::instance()->get_ports (DataType::MIDI, pl);
std::vector<std::string> pp;
AudioEngine::instance ()->get_physical_inputs (DataType::MIDI, pp, MidiPortFlags (0), MidiPortFlags (MidiPortControl | MidiPortVirtual));
/* ideally we'd also list external (JACK) ports
* however there is no convenient API
* `PortManager::get_ports (const string& port_name_pattern, DataType type, PortFlags flags, vector<string>& s)`
* lists ALL ports and we'd need to filter any outputs (sinks), except our own sinks (which can be traced).
*/
size_t nth = 0;
size_t act = 0;
/* physical I/Os first */
for (auto const& pn : pp) {
if (!cpn.empty () && pn == cpn) {
act = nth;
}
++nth;
std::string ppn = AudioEngine::instance()->get_pretty_name_by_name (pn);
if (ppn.empty ()) {
ppn = pn.substr (pn.find (':') + 1);
}
TreeModel::Row row = *_midi_port_list->append ();
row[_midi_port_cols.pretty_name] = string_compose (_("HW: %1"), ppn);
row[_midi_port_cols.port_name] = pn;
}
/* Ardour owned ports */
for (auto const& p : pl) {
if (p->flags() & Hidden) {
continue;
}
std::string const& pn = p->name ();
if (!cpn.empty () && pn == cpn) {
act = nth;
}
++nth;
std::string ppn = p->pretty_name (false);
if (ppn.empty ()) {
ppn = pn.substr (pn.find (':') + 1);
}
TreeModel::Row row = *_midi_port_list->append ();
row[_midi_port_cols.pretty_name] = ppn;
row[_midi_port_cols.port_name] = pn;
}
if (nth > 0) {
_midi_port_combo.set_active (act);
}
}
void
MidiTracer::port_changed ()
{
using namespace ARDOUR;
disconnect ();
TreeModel::iterator r = _midi_port_combo.get_active ();
if (!r) {
return;
}
std::string const pn = (*r)[_midi_port_cols.port_name];
std::shared_ptr<ARDOUR::Port> p = AudioEngine::instance()->get_port_by_name (pn);
if (!p) {
/* connect to external port */
if (0 == tracer_port->connect (pn)) {
_midi_parser = std::shared_ptr<MIDI::Parser> (new MIDI::Parser);
_midi_parser->any.connect_same_thread (_parser_connection, boost::bind (&MidiTracer::tracer, this, _1, _2, _3, _4));
tracer_port->set_trace (_midi_parser);
} else {
std::cerr << "CANNOT TRACE PORT " << pn << "\n";
}
return;
}
/* The inheritance hierarchy makes this messy. AsyncMIDIPort has two
* available MIDI::Parsers what we could connect to, ::self_parser()
* (from ARDOUR::MidiPort) and ::parser() from MIDI::Port. One day,
* this mess will all go away ...
*/
/* Some ports have a parser available (Transport Masters and ASYNC ports)
* and some do not. If the port has a parser already, just attach to it.
* If not use our local parser and tell the port that we need it to be called.
*/
std::shared_ptr<AsyncMIDIPort> async = std::dynamic_pointer_cast<AsyncMIDIPort> (p);
if (!async) {
std::shared_ptr<MidiPort> mp = std::dynamic_pointer_cast<MidiPort> (p);
if (mp) {
if (mp->flags() & TransportMasterPort) {
std::shared_ptr<TransportMaster> tm = TransportMasterManager::instance().master_by_port(std::dynamic_pointer_cast<ARDOUR::Port> (p));
std::shared_ptr<TransportMasterViaMIDI> tm_midi = std::dynamic_pointer_cast<TransportMasterViaMIDI> (tm);
if (tm_midi) {
tm_midi->transport_parser().any.connect_same_thread(_parser_connection, boost::bind (&MidiTracer::tracer, this, _1, _2, _3, _4));
}
} else {
_midi_parser = std::shared_ptr<MIDI::Parser> (new MIDI::Parser);
_midi_parser->any.connect_same_thread (_parser_connection, boost::bind (&MidiTracer::tracer, this, _1, _2, _3, _4));
mp->set_trace (_midi_parser);
traced_port = mp;
}
}
} else {
async->parser()->any.connect_same_thread (_parser_connection, boost::bind (&MidiTracer::tracer, this, _1, _2, _3, _4));
}
}
void
MidiTracer::disconnect ()
{
_parser_connection.disconnect ();
tracer_port->disconnect_all ();
tracer_port->set_trace (std::weak_ptr<MIDI::Parser>());
if (traced_port) {
traced_port->set_trace (std::weak_ptr<MIDI::Parser>());
traced_port.reset ();
}
_midi_parser.reset ();
}
void
MidiTracer::tracer (Parser&, MIDI::byte* msg, size_t len, samplecnt_t now)
{
stringstream ss;
char* buf;
size_t bufsize;
size_t s;
buf = (char *) buffer_pool.alloc ();
bufsize = buffer_size;
if (_last_receipt != 0 && show_delta_time) {
s = snprintf (buf, bufsize, "+%12" PRId64, now - _last_receipt);
bufsize -= s;
} else {
s = snprintf (buf, bufsize, "%12" PRId64, now);
bufsize -= s;
}
_last_receipt = now;
switch ((eventType) msg[0]&0xf0) {
case off:
if (show_hex) {
s += snprintf (&buf[s], bufsize, "%16s chn %2d %02x %02x\n", "NoteOff", (msg[0]&0xf)+1, (int) msg[1], (int) msg[2]);
} else {
s += snprintf (&buf[s], bufsize, "%16s chn %2d %-3d %-3d\n", "NoteOff", (msg[0]&0xf)+1, (int) msg[1], (int) msg[2]);
}
break;
case on:
if (show_hex) {
s += snprintf (&buf[s], bufsize, "%16s chn %2d %02x %02x\n", "NoteOn", (msg[0]&0xf)+1, (int) msg[1], (int) msg[2]);
} else {
s += snprintf (&buf[s], bufsize, "%16s chn %2d %-3d %-3d\n", "NoteOn", (msg[0]&0xf)+1, (int) msg[1], (int) msg[2]);
}
break;
case polypress:
if (show_hex) {
s += snprintf (&buf[s], bufsize, "%16s chn %2d %02x\n", "PolyPressure", (msg[0]&0xf)+1, (int) msg[1]);
} else {
s += snprintf (&buf[s], bufsize, "%16s chn %2d %-3d\n", "PolyPressure", (msg[0]&0xf)+1, (int) msg[1]);
}
break;
case MIDI::controller:
if (show_hex) {
s += snprintf (&buf[s], bufsize, "%16s chn %2d %02x %02x\n", "Controller", (msg[0]&0xf)+1, (int) msg[1], (int) msg[2]);
} else {
s += snprintf (&buf[s], bufsize, "%16s chn %2d %2d %-3d\n", "Controller", (msg[0]&0xf)+1, (int) msg[1], (int) msg[2]);
}
break;
case program:
if (show_hex) {
s += snprintf (&buf[s], bufsize, "%16s chn %2d %02x\n", "Program Change", (msg[0]&0xf)+1, (int) msg[1]);
} else {
s += snprintf (&buf[s], bufsize, "%16s chn %2d %-3d\n", "Program Change", (msg[0]&0xf)+1, (int) msg[1]);
}
break;
case chanpress:
if (show_hex) {
s += snprintf (&buf[s], bufsize, "%16s chn %2d %02x/%-3d\n", "Channel Pressure", (msg[0]&0xf)+1, (int) msg[1], (int) msg[1]);
} else {
s += snprintf (&buf[s], bufsize, "%16s chn %2d %02x/%-3d\n", "Channel Pressure", (msg[0]&0xf)+1, (int) msg[1], (int) msg[1]);
}
break;
case MIDI::pitchbend:
if (show_hex) {
s += snprintf (&buf[s], bufsize, "%16s chn %2d %02x %02x\n", "Pitch Bend", (msg[0]&0xf)+1, (int) msg[1], (int) msg[2]);
} else {
s += snprintf (&buf[s], bufsize, "%16s chn %2d %-3d %-3d\n", "Pitch Bend", (msg[0]&0xf)+1, (int) msg[1], (int) msg[2]);
}
break;
case MIDI::sysex:
if (len == 1) {
switch (msg[0]) {
case 0xf8:
s += snprintf (&buf[s], bufsize, "%16s\n", "Clock");
break;
case 0xf9:
s += snprintf (&buf[s], bufsize, "%16s\n", "Tick");
break;
case 0xfa:
s += snprintf (&buf[s], bufsize, "%16s\n", "Start");
break;
case 0xfb:
s += snprintf (&buf[s], bufsize, "%16s\n", "Continue");
break;
case 0xfc:
s += snprintf (&buf[s], bufsize, "%16s\n", "Stop");
break;
case 0xfe:
s += snprintf (&buf[s], bufsize, "%16s\n", "Active Sense");
break;
case 0xff:
s += snprintf (&buf[s], bufsize, "%16s\n", "Reset");
break;
default:
s += snprintf (&buf[s], bufsize, "%16s %02x\n", "Sysex", (int) msg[1]);
break;
}
} else if (len > 5 && msg[0] == 0xf0 && msg[1] == 0x7f && msg[3] == 0x06) {
/* MMC */
int cmd = msg[4];
if (cmd == 0x44 && msg[5] == 0x06 && msg[6] == 0x01) {
s += snprintf (
&buf[s], bufsize, " MMC locate to %02d:%02d:%02d:%02d.%02d\n",
msg[7], msg[8], msg[9], msg[10], msg[11]
);
} else if (cmd == 0x47 && msg[5] == 0x03) {
uint8_t sh = msg[6];
uint8_t sm = msg[7];
uint8_t sl = msg[8];
bool forward = sh & (1<<6) ? false : true;
size_t left_shift = sh & 0x38;
size_t integral = ((sh & 0x7) << left_shift) | (sm >> (7 - left_shift));
size_t fractional = ((sm << left_shift) << 7) | sl;
float shuttle_speed = integral + ((float)fractional / (1 << (14 - left_shift)));
s += snprintf (&buf[s], bufsize, " MMC Shuttle %s%f\n", forward ? "+" : "-", shuttle_speed);
} else {
std::string name;
switch (cmd) {
case 0x01:
name = "Stop";
break;
case 0x02:
name = "Play";
break;
case 0x03:
name = "Deferred Play";
break;
case 0x04:
name = "Fast Forward";
break;
case 0x05:
name = "Rewind";
break;
case 0x06:
name = "Record Strobe";
break;
case 0x07:
name = "Record Exit";
break;
case 0x08:
name = "Record Pause";
break;
case 0x09:
name = "Pause";
break;
case 0x0a:
name = "Eject";
break;
case 0x0b:
name = "Chase";
break;
case 0x40:
name = "Write (ARM Tracks)";
break;
case 0x0d:
name = "MMC Reset";
break;
default:
break;
}
if (!name.empty()) {
s += snprintf (&buf[s], bufsize, " MMC command %s\n", name.c_str());
} else {
s += snprintf (&buf[s], bufsize, " MMC command %02x\n", cmd);
}
}
} else if (len == 10 && msg[0] == 0xf0 && msg[1] == 0x7f && msg[9] == 0xf7) {
/* MTC full sample */
s += snprintf (&buf[s], bufsize, " MTC full sample to %02d:%02d:%02d:%02d\n", msg[5] & 0x1f, msg[6], msg[7], msg[8]);
} else if (len == 3 && msg[0] == MIDI::position) {
/* MIDI Song Position */
int midi_beats = (msg[2] << 7) | msg[1];
s += snprintf (&buf[s], bufsize, "%16s %d\n", "Position", (int) midi_beats);
} else if (len == 2 && msg[0] == MIDI::mtc_quarter) {
s += snprintf (&buf[s], bufsize, "%16s %02x\n", "MTC Quarter", msg[1]);
} else {
/* other sys-ex */
s += snprintf (&buf[s], bufsize, "%16s (%" PRId64 ") = [", "Sysex", len);
bufsize -= s;
for (unsigned int i = 0; i < len && bufsize > 3; ++i) {
if (i > 0) {
s += snprintf (&buf[s], bufsize, " %02x", msg[i]);
} else {
s += snprintf (&buf[s], bufsize, "%02x", msg[i]);
}
bufsize -= s;
}
s += snprintf (&buf[s], bufsize, "]\n");
}
break;
case MIDI::song:
s += snprintf (&buf[s], bufsize, "%16s\n", "Song");
break;
case MIDI::tune:
s += snprintf (&buf[s], bufsize, "%16s\n", "Tune");
break;
case MIDI::eox:
s += snprintf (&buf[s], bufsize, "%16s\n", "EOX");
break;
case MIDI::timing:
s += snprintf (&buf[s], bufsize, "%16s\n", "Timing");
break;
case MIDI::start:
s += snprintf (&buf[s], bufsize, "%16s\n", "Start");
break;
case MIDI::stop:
s += snprintf (&buf[s], bufsize, "%16s\n", "Stop");
break;
case MIDI::contineu:
s += snprintf (&buf[s], bufsize, "%16s\n", "Continue");
break;
case active:
s += snprintf (&buf[s], bufsize, "%16s\n", "Active Sense");
break;
default:
s += snprintf (&buf[s], bufsize, "%16s\n", "Unknown");
break;
}
// If you want to append more to the line, uncomment this first
// bufsize -= s;
assert(s <= buffer_size); // clang dead-assignment
fifo.write (&buf, 1);
int canderef (0);
if (_update_queued.compare_exchange_strong (canderef, 1)) {
gui_context()->call_slot (invalidator (*this), boost::bind (&MidiTracer::update, this));
}
}
void
MidiTracer::update ()
{
bool updated = false;
_update_queued.store (0);
RefPtr<TextBuffer> buf (text.get_buffer());
int excess = buf->get_line_count() - line_count_adjustment.get_value();
if (excess > 0) {
buf->erase (buf->begin(), buf->get_iter_at_line (excess));
}
char *str;
while (fifo.read (&str, 1)) {
buf->insert (buf->end(), string (str));
buffer_pool.release (str);
updated = true;
}
if (updated && autoscroll) {
scroller.get_vadjustment()->set_value (scroller.get_vadjustment()->get_upper());
}
}
void
MidiTracer::base_toggle ()
{
show_hex = !base_button.get_active();
}
void
MidiTracer::delta_toggle ()
{
show_delta_time = delta_time_button.get_active();
}
void
MidiTracer::collect_toggle ()
{
if (collect_button.get_active ()) {
port_changed ();
} else {
disconnect ();
}
}
void
MidiTracer::autoscroll_toggle ()
{
autoscroll = autoscroll_button.get_active ();
}
View Git Blame Copy Permalink