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