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