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