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