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