libs/ardour/midi_port.cc

   1 /*
   2     Copyright (C) 2006 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 #include <cassert>
  20 #include <iostream>
  21
  22 #include "pbd/compose.h"
  23 #include "pbd/debug.h"
  24
  25 #include "ardour/audioengine.h"
  26 #include "ardour/data_type.h"
  27 #include "ardour/debug.h"
  28 #include "ardour/midi_buffer.h"
  29 #include "ardour/midi_port.h"
  30 #include "ardour/session.h"
  31
  32 using namespace std;
  33 using namespace ARDOUR;
  34 using namespace PBD;
  35
  36 #define port_engine AudioEngine::instance()->port_engine()
  37
  38 MidiPort::MidiPort (const std::string& name, PortFlags flags)
  39         : Port (name, DataType::MIDI, flags)
  40         , _has_been_mixed_down (false)
  41         , _resolve_required (false)
  42         , _input_active (true)
  43         , _always_parse (false)
  44         , _trace_on (false)
  45 {
  46         _buffer = new MidiBuffer (AudioEngine::instance()->raw_buffer_size (DataType::MIDI));
  47 }
  48
  49 MidiPort::~MidiPort()
  50 {
  51         if (_shadow_port) {
  52                 AudioEngine::instance()->unregister_port (_shadow_port);
  53                 _shadow_port.reset ();
  54         }
  55
  56         delete _buffer;
  57 }
  58
  59 void
  60 MidiPort::cycle_start (pframes_t nframes)
  61 {
  62         framepos_t now = AudioEngine::instance()->sample_time_at_cycle_start();
  63
  64         Port::cycle_start (nframes);
  65
  66         _buffer->clear ();
  67
  68         if (sends_output () && _port_handle) {
  69                 port_engine.midi_clear (port_engine.get_buffer (_port_handle, nframes));
  70         }
  71
  72         if (_always_parse || (receives_input() && _trace_on)) {
  73                 MidiBuffer& mb (get_midi_buffer (nframes));
  74
  75                 /* dump incoming MIDI to parser */
  76
  77                 for (MidiBuffer::iterator b = mb.begin(); b != mb.end(); ++b) {
  78                         uint8_t* buf = (*b).buffer();
  79
  80                         _self_parser.set_timestamp (now + (*b).time());
  81
  82                         uint32_t limit = (*b).size();
  83
  84                         for (size_t n = 0; n < limit; ++n) {
  85                                 _self_parser.scanner (buf[n]);
  86                         }
  87                 }
  88         }
  89
  90         if (inbound_midi_filter) {
  91                 MidiBuffer& mb (get_midi_buffer (nframes));
  92                 inbound_midi_filter (mb, mb);
  93         }
  94
  95         if (_shadow_port) {
  96                 MidiBuffer& mb (get_midi_buffer (nframes));
  97                 if (shadow_midi_filter (mb, _shadow_port->get_midi_buffer (nframes))) {
  98                         _shadow_port->flush_buffers (nframes);
  99                 }
 100         }
 101
 102 }
 103
 104 Buffer&
 105 MidiPort::get_buffer (pframes_t nframes)
 106 {
 107         return get_midi_buffer (nframes);
 108 }
 109
 110 MidiBuffer &
 111 MidiPort::get_midi_buffer (pframes_t nframes)
 112 {
 113         if (_has_been_mixed_down) {
 114                 return *_buffer;
 115         }
 116
 117         if (receives_input ()) {
 118
 119                 if (_input_active) {
 120
 121                         void* buffer = port_engine.get_buffer (_port_handle, nframes);
 122                         const pframes_t event_count = port_engine.get_midi_event_count (buffer);
 123
 124                         /* suck all relevant MIDI events from the MIDI port buffer
 125                            into our MidiBuffer
 126                         */
 127
 128                         for (pframes_t i = 0; i < event_count; ++i) {
 129
 130                                 pframes_t timestamp;
 131                                 size_t size;
 132                                 uint8_t const* buf;
 133
 134                                 port_engine.midi_event_get (timestamp, size, &buf, buffer, i);
 135
 136                                 if (buf[0] == 0xfe) {
 137                                         /* throw away active sensing */
 138                                         continue;
 139                                 }
 140
 141                                 /* check that the event is in the acceptable time range */
 142                                 if ((timestamp <  (_global_port_buffer_offset + _port_buffer_offset)) ||
 143                                     (timestamp >= (_global_port_buffer_offset + _port_buffer_offset + nframes))) {
 144                                         cerr << "Dropping incoming MIDI at time " << timestamp << "; offset="
 145                                                 << _global_port_buffer_offset << " limit="
 146                                                 << (_global_port_buffer_offset + _port_buffer_offset + nframes) << "\n";
 147                                         continue;
 148                                 }
 149
 150                                 if ((buf[0] & 0xF0) == 0x90 && buf[2] == 0) {
 151                                         /* normalize note on with velocity 0 to proper note off */
 152                                         uint8_t ev[3];
 153                                         ev[0] = 0x80 | (buf[0] & 0x0F);  /* note off */
 154                                         ev[1] = buf[1];
 155                                         ev[2] = 0x40;  /* default velocity */
 156                                         _buffer->push_back (timestamp, size, ev);
 157                                 } else {
 158                                         _buffer->push_back (timestamp, size, buf);
 159                                 }
 160                         }
 161
 162                 } else {
 163                         _buffer->silence (nframes);
 164                 }
 165
 166         } else {
 167                 _buffer->silence (nframes);
 168         }
 169
 170         if (nframes) {
 171                 _has_been_mixed_down = true;
 172         }
 173
 174         return *_buffer;
 175 }
 176
 177 void
 178 MidiPort::cycle_end (pframes_t /*nframes*/)
 179 {
 180         _has_been_mixed_down = false;
 181 }
 182
 183 void
 184 MidiPort::cycle_split ()
 185 {
 186         _has_been_mixed_down = false;
 187 }
 188
 189 void
 190 MidiPort::resolve_notes (void* port_buffer, MidiBuffer::TimeType when)
 191 {
 192         for (uint8_t channel = 0; channel <= 0xF; channel++) {
 193
 194                 uint8_t ev[3] = { ((uint8_t) (MIDI_CMD_CONTROL | channel)), MIDI_CTL_SUSTAIN, 0 };
 195
 196                 /* we need to send all notes off AND turn the
 197                  * sustain/damper pedal off to handle synths
 198                  * that prioritize sustain over AllNotesOff
 199                  */
 200
 201                 if (port_engine.midi_event_put (port_buffer, when, ev, 3) != 0) {
 202                         cerr << "failed to deliver sustain-zero on channel " << (int)channel << " on port " << name() << endl;
 203                 }
 204
 205                 ev[1] = MIDI_CTL_ALL_NOTES_OFF;
 206
 207                 if (port_engine.midi_event_put (port_buffer, when, ev, 3) != 0) {
 208                         cerr << "failed to deliver ALL NOTES OFF on channel " << (int)channel << " on port " << name() << endl;
 209                 }
 210         }
 211 }
 212
 213 void
 214 MidiPort::flush_buffers (pframes_t nframes)
 215 {
 216         if (sends_output ()) {
 217
 218                 void* port_buffer = 0;
 219
 220                 if (_resolve_required) {
 221                         port_buffer = port_engine.get_buffer (_port_handle, nframes);
 222                         /* resolve all notes at the start of the buffer */
 223                         resolve_notes (port_buffer, _global_port_buffer_offset);
 224                         _resolve_required = false;
 225                 }
 226
 227                 if (_buffer->empty()) {
 228                         return;
 229                 }
 230
 231                 if (!port_buffer) {
 232                         port_buffer = port_engine.get_buffer (_port_handle, nframes);
 233                 }
 234
 235
 236                 for (MidiBuffer::iterator i = _buffer->begin(); i != _buffer->end(); ++i) {
 237
 238                         const Evoral::Event<MidiBuffer::TimeType> ev (*i, false);
 239
 240
 241                         if (sends_output() && _trace_on) {
 242                                 uint8_t const * const buf = ev.buffer();
 243                                 const framepos_t now = AudioEngine::instance()->sample_time_at_cycle_start();
 244
 245                                 _self_parser.set_timestamp (now + ev.time());
 246
 247                                 uint32_t limit = ev.size();
 248
 249                                 for (size_t n = 0; n < limit; ++n) {
 250                                         _self_parser.scanner (buf[n]);
 251                                 }
 252                         }
 253
 254
 255                         // event times are in frames, relative to cycle start
 256
 257 #ifndef NDEBUG
 258                         if (DEBUG_ENABLED (DEBUG::MidiIO)) {
 259                                 const Session* s = AudioEngine::instance()->session();
 260                                 const framepos_t now = (s ? s->transport_frame() : 0);
 261                                 DEBUG_STR_DECL(a);
 262                                 DEBUG_STR_APPEND(a, string_compose ("MidiPort %8 %1 pop event    @ %2 (global %4, within %5 gpbo %6 pbo %7 sz %3 ", _buffer, ev.time(), ev.size(),
 263                                                                     now + ev.time(), nframes, _global_port_buffer_offset, _port_buffer_offset, name()));
 264                                 for (size_t i=0; i < ev.size(); ++i) {
 265                                         DEBUG_STR_APPEND(a,hex);
 266                                         DEBUG_STR_APPEND(a,"0x");
 267                                         DEBUG_STR_APPEND(a,(int)(ev.buffer()[i]));
 268                                         DEBUG_STR_APPEND(a,' ');
 269                                 }
 270                                 DEBUG_STR_APPEND(a,'\n');
 271                                 DEBUG_TRACE (DEBUG::MidiIO, DEBUG_STR(a).str());
 272                         }
 273 #endif
 274
 275                         assert (ev.time() < (nframes + _global_port_buffer_offset + _port_buffer_offset));
 276
 277                         if (ev.time() >= _global_port_buffer_offset + _port_buffer_offset) {
 278                                 if (port_engine.midi_event_put (port_buffer, (pframes_t) ev.time(), ev.buffer(), ev.size()) != 0) {
 279                                         cerr << "write failed, drop flushed note off on the floor, time "
 280                                              << ev.time() << " > " << _global_port_buffer_offset + _port_buffer_offset << endl;
 281                                 }
 282                         } else {
 283                                 cerr << "drop flushed event on the floor, time " << ev.time()
 284                                      << " too early for " << _global_port_buffer_offset
 285                                      << " + " << _port_buffer_offset;
 286                                 for (size_t xx = 0; xx < ev.size(); ++xx) {
 287                                         cerr << ' ' << hex << (int) ev.buffer()[xx];
 288                                 }
 289                                 cerr << dec << endl;
 290                         }
 291                 }
 292
 293                 /* done.. the data has moved to the port buffer, mark it so
 294                  */
 295
 296                 _buffer->clear ();
 297         }
 298 }
 299
 300 void
 301 MidiPort::require_resolve ()
 302 {
 303         _resolve_required = true;
 304 }
 305
 306 void
 307 MidiPort::transport_stopped ()
 308 {
 309         _resolve_required = true;
 310 }
 311
 312 void
 313 MidiPort::realtime_locate ()
 314 {
 315         _resolve_required = true;
 316 }
 317
 318 void
 319 MidiPort::reset ()
 320 {
 321         Port::reset ();
 322         delete _buffer;
 323         cerr << name() << " new MIDI buffer of size " << AudioEngine::instance()->raw_buffer_size (DataType::MIDI) << endl;
 324         _buffer = new MidiBuffer (AudioEngine::instance()->raw_buffer_size (DataType::MIDI));
 325 }
 326
 327 void
 328 MidiPort::set_input_active (bool yn)
 329 {
 330         _input_active = yn;
 331 }
 332
 333 void
 334 MidiPort::set_always_parse (bool yn)
 335 {
 336         _always_parse = yn;
 337 }
 338
 339 void
 340 MidiPort::set_trace_on (bool yn)
 341 {
 342         _trace_on = yn;
 343 }
 344
 345 int
 346 MidiPort::add_shadow_port (string const & name, MidiFilter mf)
 347 {
 348         if (!ARDOUR::Port::receives_input()) {
 349                 return -1;
 350         }
 351
 352         if (_shadow_port) {
 353                 return -2;
 354         }
 355
 356         shadow_midi_filter = mf;
 357
 358         if (!(_shadow_port = boost::dynamic_pointer_cast<MidiPort> (AudioEngine::instance()->register_output_port (DataType::MIDI, name, false, PortFlags (Shadow|IsTerminal))))) {
 359                 return -3;
 360         }
 361
 362         /* forward on our port latency to the shadow port.
 363
 364            XXX: need to capture latency changes and forward them too.
 365         */
 366
 367         LatencyRange latency = private_latency_range (false);
 368         _shadow_port->set_private_latency_range (latency, false);
 369
 370         return 0;
 371 }