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 #include "midi++/manager.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         Manager::instance()->PortsChanged.connect (_manager_connection, invalidator (*this), boost::bind (&MidiTracer::ports_changed, this), gui_context());
  60
  61         _last_receipt.tv_sec = 0;
  62         _last_receipt.tv_usec = 0;
  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
 123 MidiTracer::~MidiTracer()
 124 {
 125 }
 126
 127 void
 128 MidiTracer::ports_changed ()
 129 {
 130         string const c = _port_combo.get_active_text ();
 131         _port_combo.clear ();
 132
 133         boost::shared_ptr<const Manager::PortList> p = Manager::instance()->get_midi_ports ();
 134         for (Manager::PortList::const_iterator i = p->begin(); i != p->end(); ++i) {
 135                 _port_combo.append_text ((*i)->name());
 136         }
 137
 138         _port_combo.set_active_text (c);
 139 }
 140
 141 void
 142 MidiTracer::port_changed ()
 143 {
 144         disconnect ();
 145
 146         Port* p = Manager::instance()->port (_port_combo.get_active_text());
 147
 148         if (p) {
 149                 p->parser()->any.connect_same_thread (_parser_connection, boost::bind (&MidiTracer::tracer, this, _1, _2, _3));
 150         }
 151 }
 152
 153 void
 154 MidiTracer::disconnect ()
 155 {
 156         _parser_connection.disconnect ();
 157 }
 158
 159 void
 160 MidiTracer::tracer (Parser&, byte* msg, size_t len)
 161 {
 162         stringstream ss;
 163         struct timeval tv;
 164         char* buf;
 165         struct tm now;
 166         size_t bufsize;
 167         size_t s;
 168
 169         gettimeofday (&tv, 0);
 170
 171         buf = (char *) buffer_pool.alloc ();
 172         bufsize = buffer_size;
 173
 174         if (_last_receipt.tv_sec != 0 && show_delta_time) {
 175                 struct timeval delta;
 176                 timersub (&tv, &_last_receipt, &delta);
 177                 s = snprintf (buf, bufsize, "+%02" PRId64 ":%06" PRId64, (int64_t) delta.tv_sec, (int64_t) delta.tv_usec);
 178                 bufsize -= s;
 179         } else {
 180                 localtime_r (&tv.tv_sec, &now);
 181                 s = strftime (buf, bufsize, "%H:%M:%S", &now);
 182                 bufsize -= s;
 183                 s += snprintf (&buf[s], bufsize, ".%06" PRId64, (int64_t) tv.tv_usec);
 184                 bufsize -= s;
 185         }
 186
 187         _last_receipt = tv;
 188
 189         switch ((eventType) msg[0]&0xf0) {
 190         case off:
 191                 if (show_hex) {
 192                         s += snprintf (&buf[s], bufsize, "%16s chn %2d %02x %02x\n", "NoteOff", (msg[0]&0xf)+1, (int) msg[1], (int) msg[2]);
 193                 } else {
 194                         s += snprintf (&buf[s], bufsize, "%16s chn %2d %-3d %-3d\n", "NoteOff", (msg[0]&0xf)+1, (int) msg[1], (int) msg[2]);
 195                 }
 196                 break;
 197
 198         case on:
 199                 if (show_hex) {
 200                         s += snprintf (&buf[s], bufsize, "%16s chn %2d %02x %02x\n", "NoteOn", (msg[0]&0xf)+1, (int) msg[1], (int) msg[2]);
 201                 } else {
 202                         s += snprintf (&buf[s], bufsize, "%16s chn %2d %-3d %-3d\n", "NoteOn", (msg[0]&0xf)+1, (int) msg[1], (int) msg[2]);
 203                 }
 204                 break;
 205
 206         case polypress:
 207                 if (show_hex) {
 208                         s += snprintf (&buf[s], bufsize, "%16s chn %2d %02x\n", "PolyPressure", (msg[0]&0xf)+1, (int) msg[1]);
 209                 } else {
 210                         s += snprintf (&buf[s], bufsize, "%16s chn %2d %-3d\n", "PolyPressure", (msg[0]&0xf)+1, (int) msg[1]);
 211                 }
 212                 break;
 213
 214         case MIDI::controller:
 215                 if (show_hex) {
 216                         s += snprintf (&buf[s], bufsize, "%16s chn %2d %02x %02x\n", "Controller", (msg[0]&0xf)+1, (int) msg[1], (int) msg[2]);
 217                 } else {
 218                         s += snprintf (&buf[s], bufsize, "%16s chn %2d %2d %-3d\n", "Controller", (msg[0]&0xf)+1, (int) msg[1], (int) msg[2]);
 219                 }
 220                 break;
 221
 222         case program:
 223                 if (show_hex) {
 224                         s += snprintf (&buf[s], bufsize, "%16s chn %2d %02x\n", "Program Change", (msg[0]&0xf)+1, (int) msg[1]);
 225                 } else {
 226                         s += snprintf (&buf[s], bufsize, "%16s chn %2d %-3d\n", "Program Change", (msg[0]&0xf)+1, (int) msg[1]);
 227                 }
 228                 break;
 229
 230         case chanpress:
 231                 if (show_hex) {
 232                         s += snprintf (&buf[s], bufsize, "%16s chn %2d %02x/%-3d\n", "Channel Pressure", (msg[0]&0xf)+1, (int) msg[1], (int) msg[1]);
 233                 } else {
 234                         s += snprintf (&buf[s], bufsize, "%16s chn %2d %02x/%-3d\n", "Channel Pressure", (msg[0]&0xf)+1, (int) msg[1], (int) msg[1]);
 235                 }
 236                 break;
 237
 238         case MIDI::pitchbend:
 239                 if (show_hex) {
 240                         s += snprintf (&buf[s], bufsize, "%16s chn %2d %02x\n", "Pitch Bend", (msg[0]&0xf)+1, (int) msg[1]);
 241                 } else {
 242                         s += snprintf (&buf[s], bufsize, "%16s chn %2d %-3d\n", "Pitch Bend", (msg[0]&0xf)+1, (int) msg[1]);
 243                 }
 244                 break;
 245
 246         case MIDI::sysex:
 247                 if (len == 1) {
 248                         switch (msg[0]) {
 249                         case 0xf8:
 250                                 s += snprintf (&buf[s], bufsize, "%16s\n", "Clock");
 251                                 break;
 252                         case 0xfa:
 253                                 s += snprintf (&buf[s], bufsize, "%16s\n", "Start");
 254                                 break;
 255                         case 0xfb:
 256                                 s += snprintf (&buf[s], bufsize, "%16s\n", "Continue");
 257                                 break;
 258                         case 0xfc:
 259                                 s += snprintf (&buf[s], bufsize, "%16s\n", "Stop");
 260                                 break;
 261                         case 0xfe:
 262                                 s += snprintf (&buf[s], bufsize, "%16s\n", "Active Sense");
 263                                 break;
 264                         case 0xff:
 265                                 s += snprintf (&buf[s], bufsize, "%16s\n", "Reset");
 266                                 break;
 267                         default:
 268                                 s += snprintf (&buf[s], bufsize, "%16s %02x\n", "Sysex", (int) msg[1]);
 269                                 break;
 270                         }
 271
 272                 } else if (len > 5 && msg[0] == 0xf0 && msg[1] == 0x7f && msg[3] == 0x06) {
 273                         /* MMC */
 274                         int cmd = msg[4];
 275                         if (cmd == 0x44 && msg[5] == 0x06 && msg[6] == 0x01) {
 276                                 s += snprintf (
 277                                         &buf[s], bufsize, " MMC locate to %02d:%02d:%02d:%02d.%02d\n",
 278                                         msg[7], msg[8], msg[9], msg[10], msg[11]
 279                                         );
 280                         } else {
 281                                 std::string name;
 282                                 if (cmd == 0x1) {
 283                                         name = "STOP";
 284                                 } else if (cmd == 0x3) {
 285                                         name = "DEFERRED PLAY";
 286                                 } else if (cmd == 0x6) {
 287                                         name = "RECORD STROBE";
 288                                 } else if (cmd == 0x7) {
 289                                         name = "RECORD EXIT";
 290                                 } else if (cmd == 0x8) {
 291                                         name = "RECORD PAUSE";
 292                                 }
 293                                 if (!name.empty()) {
 294                                         s += snprintf (&buf[s], bufsize, " MMC command %s\n", name.c_str());
 295                                 } else {
 296                                         s += snprintf (&buf[s], bufsize, " MMC command %02x\n", cmd);
 297                                 }
 298                         }
 299
 300                 } else if (len == 10 && msg[0] == 0xf0 && msg[1] == 0x7f && msg[9] == 0xf7)  {
 301
 302                         /* MTC full frame */
 303                         s += snprintf (
 304                                 &buf[s], bufsize, " MTC full frame to %02d:%02d:%02d:%02d\n", msg[5] & 0x1f, msg[6], msg[7], msg[8]
 305                                 );
 306
 307                 } else {
 308
 309                         /* other sys-ex */
 310
 311                         s += snprintf (&buf[s], bufsize, "%16s (%d) = [", "Sysex", (int) len);
 312                         bufsize -= s;
 313
 314                         for (unsigned int i = 0; i < len && bufsize > 3; ++i) {
 315                                 if (i > 0) {
 316                                         s += snprintf (&buf[s], bufsize, " %02x", msg[i]);
 317                                 } else {
 318                                         s += snprintf (&buf[s], bufsize, "%02x", msg[i]);
 319                                 }
 320                                 bufsize -= s;
 321                         }
 322                         s += snprintf (&buf[s], bufsize, "]\n");
 323                 }
 324                 break;
 325
 326         case MIDI::song:
 327                 s += snprintf (&buf[s], bufsize, "%16s\n", "Song");
 328                 break;
 329
 330         case MIDI::tune:
 331                 s += snprintf (&buf[s], bufsize, "%16s\n", "Tune");
 332                 break;
 333
 334         case MIDI::eox:
 335                 s += snprintf (&buf[s], bufsize, "%16s\n", "EOX");
 336                 break;
 337
 338         case MIDI::timing:
 339                 s += snprintf (&buf[s], bufsize, "%16s\n", "Timing");
 340                 break;
 341
 342         case MIDI::start:
 343                 s += snprintf (&buf[s], bufsize, "%16s\n", "Start");
 344                 break;
 345
 346         case MIDI::stop:
 347                 s += snprintf (&buf[s], bufsize, "%16s\n", "Stop");
 348                 break;
 349
 350         case MIDI::contineu:
 351                 s += snprintf (&buf[s], bufsize, "%16s\n", "Continue");
 352                 break;
 353
 354         case active:
 355                 s += snprintf (&buf[s], bufsize, "%16s\n", "Active Sense");
 356                 break;
 357
 358         default:
 359                 s += snprintf (&buf[s], bufsize, "%16s\n", "Unknown");
 360                 break;
 361         }
 362
 363         // If you want to append more to the line, uncomment this first
 364         // bufsize -= s;
 365
 366         fifo.write (&buf, 1);
 367
 368         if (g_atomic_int_get (&_update_queued) == 0) {
 369                 gui_context()->call_slot (invalidator (*this), boost::bind (&MidiTracer::update, this));
 370                 g_atomic_int_inc (&_update_queued);
 371         }
 372 }
 373
 374 void
 375 MidiTracer::update ()
 376 {
 377         bool updated = false;
 378         g_atomic_int_dec_and_test (&_update_queued);
 379
 380         RefPtr<TextBuffer> buf (text.get_buffer());
 381
 382         int excess = buf->get_line_count() - line_count_adjustment.get_value();
 383
 384         if (excess > 0) {
 385                 buf->erase (buf->begin(), buf->get_iter_at_line (excess));
 386         }
 387
 388         char *str;
 389
 390         while (fifo.read (&str, 1)) {
 391                 buf->insert (buf->end(), string (str));
 392                 buffer_pool.release (str);
 393                 updated = true;
 394         }
 395
 396         if (updated && autoscroll) {
 397                 scroller.get_vadjustment()->set_value (scroller.get_vadjustment()->get_upper());
 398         }
 399 }
 400
 401 void
 402 MidiTracer::base_toggle ()
 403 {
 404         show_hex = !base_button.get_active();
 405 }
 406
 407 void
 408 MidiTracer::delta_toggle ()
 409 {
 410         show_delta_time = delta_time_button.get_active();
 411 }
 412
 413 void
 414 MidiTracer::collect_toggle ()
 415 {
 416         if (collect_button.get_active ()) {
 417                 port_changed ();
 418         } else {
 419                 disconnect ();
 420         }
 421 }
 422
 423 void
 424 MidiTracer::autoscroll_toggle ()
 425 {
 426         autoscroll = autoscroll_button.get_active ();
 427 }