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