gtk2_ardour/midi_tracer.cc

   1 /*
   2     Copyright (C) 2010 Paul Davis
   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
  20 #include <stdint.h>
  21
  22 #include <sstream>
  23 #include <sys/time.h>
  24 #include <time.h>
  25
  26 #include "pbd/localtime_r.h"
  27 #include "pbd/timersub.h"
  28
  29 #include "midi++/parser.h"
  30
  31 #include "ardour/async_midi_port.h"
  32 #include "ardour/midi_port.h"
  33 #include "ardour/audioengine.h"
  34
  35 #include "midi_tracer.h"
  36 #include "gui_thread.h"
  37 #include "pbd/i18n.h"
  38
  39 using namespace Gtk;
  40 using namespace std;
  41 using namespace MIDI;
  42 using namespace Glib;
  43
  44 MidiTracer::MidiTracer ()
  45         : ArdourWindow (_("MIDI Tracer"))
  46         , line_count_adjustment (200, 1, 2000, 1, 10)
  47         , line_count_spinner (line_count_adjustment)
  48         , line_count_label (_("Line history: "))
  49         , _last_receipt (0)
  50         , autoscroll (true)
  51         , show_hex (true)
  52         , show_delta_time (false)
  53         , _update_queued (0)
  54         , fifo (1024)
  55         , buffer_pool ("miditracer", buffer_size, 1024) // 1024 256 byte buffers
  56         , autoscroll_button (_("Auto-Scroll"))
  57         , base_button (_("Decimal"))
  58         , collect_button (_("Enabled"))
  59         , delta_time_button (_("Delta times"))
  60 {
  61         ARDOUR::AudioEngine::instance()->PortRegisteredOrUnregistered.connect
  62                 (_manager_connection, invalidator (*this), boost::bind (&MidiTracer::ports_changed, this), gui_context());
  63
  64         VBox* vbox = manage (new VBox);
  65         vbox->set_spacing (4);
  66
  67         HBox* pbox = manage (new HBox);
  68         pbox->set_spacing (6);
  69         pbox->pack_start (*manage (new Label (_("Port:"))), false, false);
  70
  71         _port_combo.signal_changed().connect (sigc::mem_fun (*this, &MidiTracer::port_changed));
  72         pbox->pack_start (_port_combo);
  73         pbox->show_all ();
  74         vbox->pack_start (*pbox, false, false);
  75
  76         scroller.add (text);
  77         vbox->set_border_width (12);
  78         vbox->pack_start (scroller, true, true);
  79
  80         text.show ();
  81         text.set_name ("MidiTracerTextView");
  82         scroller.show ();
  83         scroller.set_size_request (400, 400);
  84
  85         collect_button.set_active (true);
  86         base_button.set_active (false);
  87         autoscroll_button.set_active (true);
  88
  89         line_count_box.set_spacing (6);
  90         line_count_box.pack_start (line_count_label, false, false);
  91         line_count_box.pack_start (line_count_spinner, false, false);
  92
  93         line_count_spinner.show ();
  94         line_count_label.show ();
  95         line_count_box.show ();
  96
  97         HBox* bbox = manage (new HBox);
  98         bbox->add (line_count_box);
  99         bbox->add (delta_time_button);
 100         bbox->add (base_button);
 101         bbox->add (collect_button);
 102         bbox->add (autoscroll_button);
 103         bbox->show ();
 104
 105         vbox->pack_start (*bbox, false, false);
 106
 107         add (*vbox);
 108
 109         base_button.signal_toggled().connect (sigc::mem_fun (*this, &MidiTracer::base_toggle));
 110         collect_button.signal_toggled().connect (sigc::mem_fun (*this, &MidiTracer::collect_toggle));
 111         autoscroll_button.signal_toggled().connect (sigc::mem_fun (*this, &MidiTracer::autoscroll_toggle));
 112         delta_time_button.signal_toggled().connect (sigc::mem_fun (*this, &MidiTracer::delta_toggle));
 113
 114         base_button.show ();
 115         collect_button.show ();
 116         autoscroll_button.show ();
 117
 118         ports_changed ();
 119         port_changed ();
 120 }
 121
 122 MidiTracer::~MidiTracer()
 123 {
 124 }
 125
 126 void
 127 MidiTracer::ports_changed ()
 128 {
 129         string const c = _port_combo.get_active_text ();
 130         _port_combo.clear ();
 131
 132         ARDOUR::PortManager::PortList pl;
 133         ARDOUR::AudioEngine::instance()->get_ports (ARDOUR::DataType::MIDI, pl);
 134
 135         if (pl.empty()) {
 136                 _port_combo.set_active_text ("");
 137                 return;
 138         }
 139
 140         for (ARDOUR::PortManager::PortList::const_iterator i = pl.begin(); i != pl.end(); ++i) {
 141                 _port_combo.append_text ((*i)->name());
 142         }
 143
 144         if (c.empty()) {
 145                 _port_combo.set_active_text (pl.front()->name());
 146         } else {
 147                 _port_combo.set_active_text (c);
 148         }
 149 }
 150
 151 void
 152 MidiTracer::port_changed ()
 153 {
 154         using namespace ARDOUR;
 155
 156         disconnect ();
 157
 158         boost::shared_ptr<ARDOUR::Port> p = AudioEngine::instance()->get_port_by_name (_port_combo.get_active_text());
 159
 160         if (!p) {
 161                 std::cerr << "port not found\n";
 162                 return;
 163         }
 164
 165         /* The inheritance heirarchy makes this messy. AsyncMIDIPort has two
 166          * available MIDI::Parsers what we could connect to, ::self_parser()
 167          * (from ARDOUR::MidiPort) and ::parser() from MIDI::Port. One day,
 168          * this mess will all go away ...
 169          */
 170
 171         boost::shared_ptr<AsyncMIDIPort> async = boost::dynamic_pointer_cast<AsyncMIDIPort> (p);
 172
 173         if (!async) {
 174
 175                 boost::shared_ptr<ARDOUR::MidiPort> mp = boost::dynamic_pointer_cast<ARDOUR::MidiPort> (p);
 176
 177                 if (mp) {
 178                         my_parser.any.connect_same_thread (_parser_connection, boost::bind (&MidiTracer::tracer, this, _1, _2, _3, _4));
 179                         mp->set_trace (&my_parser);
 180                         traced_port = mp;
 181                 }
 182
 183         } else {
 184                 async->parser()->any.connect_same_thread (_parser_connection, boost::bind (&MidiTracer::tracer, this, _1, _2, _3, _4));
 185         }
 186 }
 187
 188 void
 189 MidiTracer::disconnect ()
 190 {
 191         _parser_connection.disconnect ();
 192
 193         if (traced_port) {
 194                 traced_port->set_trace (0);
 195                 traced_port.reset ();
 196         }
 197 }
 198
 199 void
 200 MidiTracer::tracer (Parser&, byte* msg, size_t len, samplecnt_t now)
 201 {
 202         stringstream ss;
 203         char* buf;
 204         size_t bufsize;
 205         size_t s;
 206
 207         std::cerr << "tracer msg " << len << " bytes, first = " << hex << (int) msg[0] << dec << std::endl;
 208
 209         buf = (char *) buffer_pool.alloc ();
 210         bufsize = buffer_size;
 211
 212         if (_last_receipt != 0 && show_delta_time) {
 213                 s = snprintf (buf, bufsize, "+%12ld", now - _last_receipt);
 214                 bufsize -= s;
 215         } else {
 216                 s = snprintf (buf, bufsize, "%12ld", now);
 217                 bufsize -= s;
 218         }
 219
 220         _last_receipt = now;
 221
 222         switch ((eventType) msg[0]&0xf0) {
 223         case off:
 224                 if (show_hex) {
 225                         s += snprintf (&buf[s], bufsize, "%16s chn %2d %02x %02x\n", "NoteOff", (msg[0]&0xf)+1, (int) msg[1], (int) msg[2]);
 226                 } else {
 227                         s += snprintf (&buf[s], bufsize, "%16s chn %2d %-3d %-3d\n", "NoteOff", (msg[0]&0xf)+1, (int) msg[1], (int) msg[2]);
 228                 }
 229                 break;
 230
 231         case on:
 232                 if (show_hex) {
 233                         s += snprintf (&buf[s], bufsize, "%16s chn %2d %02x %02x\n", "NoteOn", (msg[0]&0xf)+1, (int) msg[1], (int) msg[2]);
 234                 } else {
 235                         s += snprintf (&buf[s], bufsize, "%16s chn %2d %-3d %-3d\n", "NoteOn", (msg[0]&0xf)+1, (int) msg[1], (int) msg[2]);
 236                 }
 237                 break;
 238
 239         case polypress:
 240                 if (show_hex) {
 241                         s += snprintf (&buf[s], bufsize, "%16s chn %2d %02x\n", "PolyPressure", (msg[0]&0xf)+1, (int) msg[1]);
 242                 } else {
 243                         s += snprintf (&buf[s], bufsize, "%16s chn %2d %-3d\n", "PolyPressure", (msg[0]&0xf)+1, (int) msg[1]);
 244                 }
 245                 break;
 246
 247         case MIDI::controller:
 248                 if (show_hex) {
 249                         s += snprintf (&buf[s], bufsize, "%16s chn %2d %02x %02x\n", "Controller", (msg[0]&0xf)+1, (int) msg[1], (int) msg[2]);
 250                 } else {
 251                         s += snprintf (&buf[s], bufsize, "%16s chn %2d %2d %-3d\n", "Controller", (msg[0]&0xf)+1, (int) msg[1], (int) msg[2]);
 252                 }
 253                 break;
 254
 255         case program:
 256                 if (show_hex) {
 257                         s += snprintf (&buf[s], bufsize, "%16s chn %2d %02x\n", "Program Change", (msg[0]&0xf)+1, (int) msg[1]);
 258                 } else {
 259                         s += snprintf (&buf[s], bufsize, "%16s chn %2d %-3d\n", "Program Change", (msg[0]&0xf)+1, (int) msg[1]);
 260                 }
 261                 break;
 262
 263         case chanpress:
 264                 if (show_hex) {
 265                         s += snprintf (&buf[s], bufsize, "%16s chn %2d %02x/%-3d\n", "Channel Pressure", (msg[0]&0xf)+1, (int) msg[1], (int) msg[1]);
 266                 } else {
 267                         s += snprintf (&buf[s], bufsize, "%16s chn %2d %02x/%-3d\n", "Channel Pressure", (msg[0]&0xf)+1, (int) msg[1], (int) msg[1]);
 268                 }
 269                 break;
 270
 271         case MIDI::pitchbend:
 272                 if (show_hex) {
 273                         s += snprintf (&buf[s], bufsize, "%16s chn %2d %02x %02x\n", "Pitch Bend", (msg[0]&0xf)+1, (int) msg[1], (int) msg[2]);
 274                 } else {
 275                         s += snprintf (&buf[s], bufsize, "%16s chn %2d %-3d %-3d\n", "Pitch Bend", (msg[0]&0xf)+1, (int) msg[1], (int) msg[2]);
 276                 }
 277                 break;
 278
 279         case MIDI::sysex:
 280                 if (len == 1) {
 281                         switch (msg[0]) {
 282                         case 0xf8:
 283                                 s += snprintf (&buf[s], bufsize, "%16s\n", "Clock");
 284                                 break;
 285                         case 0xfa:
 286                                 s += snprintf (&buf[s], bufsize, "%16s\n", "Start");
 287                                 break;
 288                         case 0xfb:
 289                                 s += snprintf (&buf[s], bufsize, "%16s\n", "Continue");
 290                                 break;
 291                         case 0xfc:
 292                                 s += snprintf (&buf[s], bufsize, "%16s\n", "Stop");
 293                                 break;
 294                         case 0xfe:
 295                                 s += snprintf (&buf[s], bufsize, "%16s\n", "Active Sense");
 296                                 break;
 297                         case 0xff:
 298                                 s += snprintf (&buf[s], bufsize, "%16s\n", "Reset");
 299                                 break;
 300                         default:
 301                                 s += snprintf (&buf[s], bufsize, "%16s %02x\n", "Sysex", (int) msg[1]);
 302                                 break;
 303                         }
 304
 305                 } else if (len > 5 && msg[0] == 0xf0 && msg[1] == 0x7f && msg[3] == 0x06) {
 306                         /* MMC */
 307                         int cmd = msg[4];
 308                         if (cmd == 0x44 && msg[5] == 0x06 && msg[6] == 0x01) {
 309                                 s += snprintf (
 310                                         &buf[s], bufsize, " MMC locate to %02d:%02d:%02d:%02d.%02d\n",
 311                                         msg[7], msg[8], msg[9], msg[10], msg[11]
 312                                         );
 313                         } else {
 314                                 std::string name;
 315                                 if (cmd == 0x1) {
 316                                         name = "STOP";
 317                                 } else if (cmd == 0x3) {
 318                                         name = "DEFERRED PLAY";
 319                                 } else if (cmd == 0x6) {
 320                                         name = "RECORD STROBE";
 321                                 } else if (cmd == 0x7) {
 322                                         name = "RECORD EXIT";
 323                                 } else if (cmd == 0x8) {
 324                                         name = "RECORD PAUSE";
 325                                 }
 326                                 if (!name.empty()) {
 327                                         s += snprintf (&buf[s], bufsize, " MMC command %s\n", name.c_str());
 328                                 } else {
 329                                         s += snprintf (&buf[s], bufsize, " MMC command %02x\n", cmd);
 330                                 }
 331                         }
 332
 333                 } else if (len == 10 && msg[0] == 0xf0 && msg[1] == 0x7f && msg[9] == 0xf7)  {
 334
 335                         /* MTC full sample */
 336                         s += snprintf (
 337                                 &buf[s], bufsize, " MTC full sample to %02d:%02d:%02d:%02d\n", msg[5] & 0x1f, msg[6], msg[7], msg[8]
 338                                 );
 339                 } else if (len == 3 && msg[0] == MIDI::position) {
 340
 341                         /* MIDI Song Position */
 342                         int midi_beats = (msg[2] << 7) | msg[1];
 343                         s += snprintf (&buf[s], bufsize, "%16s %d\n", "Position", (int) midi_beats);
 344                 } else {
 345
 346                         /* other sys-ex */
 347
 348                         s += snprintf (&buf[s], bufsize, "%16s (%d) = [", "Sysex", (int) len);
 349                         bufsize -= s;
 350
 351                         for (unsigned int i = 0; i < len && bufsize > 3; ++i) {
 352                                 if (i > 0) {
 353                                         s += snprintf (&buf[s], bufsize, " %02x", msg[i]);
 354                                 } else {
 355                                         s += snprintf (&buf[s], bufsize, "%02x", msg[i]);
 356                                 }
 357                                 bufsize -= s;
 358                         }
 359                         s += snprintf (&buf[s], bufsize, "]\n");
 360                 }
 361                 break;
 362
 363         case MIDI::song:
 364                 s += snprintf (&buf[s], bufsize, "%16s\n", "Song");
 365                 break;
 366
 367         case MIDI::tune:
 368                 s += snprintf (&buf[s], bufsize, "%16s\n", "Tune");
 369                 break;
 370
 371         case MIDI::eox:
 372                 s += snprintf (&buf[s], bufsize, "%16s\n", "EOX");
 373                 break;
 374
 375         case MIDI::timing:
 376                 s += snprintf (&buf[s], bufsize, "%16s\n", "Timing");
 377                 break;
 378
 379         case MIDI::start:
 380                 s += snprintf (&buf[s], bufsize, "%16s\n", "Start");
 381                 break;
 382
 383         case MIDI::stop:
 384                 s += snprintf (&buf[s], bufsize, "%16s\n", "Stop");
 385                 break;
 386
 387         case MIDI::contineu:
 388                 s += snprintf (&buf[s], bufsize, "%16s\n", "Continue");
 389                 break;
 390
 391         case active:
 392                 s += snprintf (&buf[s], bufsize, "%16s\n", "Active Sense");
 393                 break;
 394
 395         default:
 396                 s += snprintf (&buf[s], bufsize, "%16s\n", "Unknown");
 397                 break;
 398         }
 399
 400         // If you want to append more to the line, uncomment this first
 401         // bufsize -= s;
 402
 403         assert(s <= buffer_size); // clang dead-assignment
 404
 405         fifo.write (&buf, 1);
 406
 407         if (g_atomic_int_get (const_cast<gint*> (&_update_queued)) == 0) {
 408                 gui_context()->call_slot (invalidator (*this), boost::bind (&MidiTracer::update, this));
 409                 g_atomic_int_inc (const_cast<gint*> (&_update_queued));
 410         }
 411 }
 412
 413 void
 414 MidiTracer::update ()
 415 {
 416         bool updated = false;
 417         g_atomic_int_dec_and_test (const_cast<gint*> (&_update_queued));
 418
 419         RefPtr<TextBuffer> buf (text.get_buffer());
 420
 421         int excess = buf->get_line_count() - line_count_adjustment.get_value();
 422
 423         if (excess > 0) {
 424                 buf->erase (buf->begin(), buf->get_iter_at_line (excess));
 425         }
 426
 427         char *str;
 428
 429         while (fifo.read (&str, 1)) {
 430                 buf->insert (buf->end(), string (str));
 431                 buffer_pool.release (str);
 432                 updated = true;
 433         }
 434
 435         if (updated && autoscroll) {
 436                 scroller.get_vadjustment()->set_value (scroller.get_vadjustment()->get_upper());
 437         }
 438 }
 439
 440 void
 441 MidiTracer::base_toggle ()
 442 {
 443         show_hex = !base_button.get_active();
 444 }
 445
 446 void
 447 MidiTracer::delta_toggle ()
 448 {
 449         show_delta_time = delta_time_button.get_active();
 450 }
 451
 452 void
 453 MidiTracer::collect_toggle ()
 454 {
 455         if (collect_button.get_active ()) {
 456                 port_changed ();
 457         } else {
 458                 disconnect ();
 459         }
 460 }
 461
 462 void
 463 MidiTracer::autoscroll_toggle ()
 464 {
 465         autoscroll = autoscroll_button.get_active ();
 466 }