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