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 ()) {
  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* 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                                 } else if ((buf[0] & 0xF0) == 0x90 && buf[2] == 0) {
 140                                         /* normalize note on with velocity 0 to proper note off */
 141                                         buf[0] = 0x80 | (buf[0] & 0x0F);  /* note off */
 142                                         buf[2] = 0x40;  /* default velocity */
 143                                 }
 144
 145                                 /* check that the event is in the acceptable time range */
 146
 147                                 if ((timestamp >= (_global_port_buffer_offset + _port_buffer_offset)) &&
 148                                     (timestamp < (_global_port_buffer_offset + _port_buffer_offset + nframes))) {
 149                                         _buffer->push_back (timestamp, size, buf);
 150                                 } else {
 151                                         cerr << "Dropping incoming MIDI at time " << timestamp << "; offset="
 152                                              << _global_port_buffer_offset << " limit="
 153                                              << (_global_port_buffer_offset + _port_buffer_offset + nframes) << "\n";
 154                                 }
 155                         }
 156
 157                 } else {
 158                         _buffer->silence (nframes);
 159                 }
 160
 161         } else {
 162                 _buffer->silence (nframes);
 163         }
 164
 165         if (nframes) {
 166                 _has_been_mixed_down = true;
 167         }
 168
 169         return *_buffer;
 170 }
 171
 172 void
 173 MidiPort::cycle_end (pframes_t /*nframes*/)
 174 {
 175         _has_been_mixed_down = false;
 176 }
 177
 178 void
 179 MidiPort::cycle_split ()
 180 {
 181         _has_been_mixed_down = false;
 182 }
 183
 184 void
 185 MidiPort::resolve_notes (void* port_buffer, MidiBuffer::TimeType when)
 186 {
 187         for (uint8_t channel = 0; channel <= 0xF; channel++) {
 188
 189                 uint8_t ev[3] = { ((uint8_t) (MIDI_CMD_CONTROL | channel)), MIDI_CTL_SUSTAIN, 0 };
 190
 191                 /* we need to send all notes off AND turn the
 192                  * sustain/damper pedal off to handle synths
 193                  * that prioritize sustain over AllNotesOff
 194                  */
 195
 196                 if (port_engine.midi_event_put (port_buffer, when, ev, 3) != 0) {
 197                         cerr << "failed to deliver sustain-zero on channel " << (int)channel << " on port " << name() << endl;
 198                 }
 199
 200                 ev[1] = MIDI_CTL_ALL_NOTES_OFF;
 201
 202                 if (port_engine.midi_event_put (port_buffer, when, ev, 3) != 0) {
 203                         cerr << "failed to deliver ALL NOTES OFF on channel " << (int)channel << " on port " << name() << endl;
 204                 }
 205         }
 206 }
 207
 208 void
 209 MidiPort::flush_buffers (pframes_t nframes)
 210 {
 211         if (sends_output ()) {
 212
 213                 void* port_buffer = 0;
 214
 215                 if (_resolve_required) {
 216                         port_buffer = port_engine.get_buffer (_port_handle, nframes);
 217                         /* resolve all notes at the start of the buffer */
 218                         resolve_notes (port_buffer, _global_port_buffer_offset);
 219                         _resolve_required = false;
 220                 }
 221
 222                 if (_buffer->empty()) {
 223                         return;
 224                 }
 225
 226                 if (!port_buffer) {
 227                         port_buffer = port_engine.get_buffer (_port_handle, nframes);
 228                 }
 229
 230
 231                 for (MidiBuffer::iterator i = _buffer->begin(); i != _buffer->end(); ++i) {
 232
 233                         const Evoral::MIDIEvent<MidiBuffer::TimeType> ev (*i, false);
 234
 235
 236                         if (sends_output() && _trace_on) {
 237                                 uint8_t const * const buf = ev.buffer();
 238                                 const framepos_t now = AudioEngine::instance()->sample_time_at_cycle_start();
 239
 240                                 _self_parser.set_timestamp (now + ev.time());
 241
 242                                 uint32_t limit = ev.size();
 243
 244                                 for (size_t n = 0; n < limit; ++n) {
 245                                         _self_parser.scanner (buf[n]);
 246                                 }
 247                         }
 248
 249
 250                         // event times are in frames, relative to cycle start
 251
 252 #ifndef NDEBUG
 253                         if (DEBUG_ENABLED (DEBUG::MidiIO)) {
 254                                 const Session* s = AudioEngine::instance()->session();
 255                                 const framepos_t now = (s ? s->transport_frame() : 0);
 256                                 DEBUG_STR_DECL(a);
 257                                 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(),
 258                                                                     now + ev.time(), nframes, _global_port_buffer_offset, _port_buffer_offset, name()));
 259                                 for (size_t i=0; i < ev.size(); ++i) {
 260                                         DEBUG_STR_APPEND(a,hex);
 261                                         DEBUG_STR_APPEND(a,"0x");
 262                                         DEBUG_STR_APPEND(a,(int)(ev.buffer()[i]));
 263                                         DEBUG_STR_APPEND(a,' ');
 264                                 }
 265                                 DEBUG_STR_APPEND(a,'\n');
 266                                 DEBUG_TRACE (DEBUG::MidiIO, DEBUG_STR(a).str());
 267                         }
 268 #endif
 269
 270                         assert (ev.time() < (nframes + _global_port_buffer_offset + _port_buffer_offset));
 271
 272                         if (ev.time() >= _global_port_buffer_offset + _port_buffer_offset) {
 273                                 if (port_engine.midi_event_put (port_buffer, (pframes_t) ev.time(), ev.buffer(), ev.size()) != 0) {
 274                                         cerr << "write failed, drop flushed note off on the floor, time "
 275                                              << ev.time() << " > " << _global_port_buffer_offset + _port_buffer_offset << endl;
 276                                 }
 277                         } else {
 278                                 cerr << "drop flushed event on the floor, time " << ev.time()
 279                                      << " too early for " << _global_port_buffer_offset
 280                                      << " + " << _port_buffer_offset;
 281                                 for (size_t xx = 0; xx < ev.size(); ++xx) {
 282                                         cerr << ' ' << hex << (int) ev.buffer()[xx];
 283                                 }
 284                                 cerr << dec << endl;
 285                         }
 286                 }
 287
 288                 /* done.. the data has moved to the port buffer, mark it so
 289                  */
 290
 291                 _buffer->clear ();
 292         }
 293 }
 294
 295 void
 296 MidiPort::require_resolve ()
 297 {
 298         _resolve_required = true;
 299 }
 300
 301 void
 302 MidiPort::transport_stopped ()
 303 {
 304         _resolve_required = true;
 305 }
 306
 307 void
 308 MidiPort::realtime_locate ()
 309 {
 310         _resolve_required = true;
 311 }
 312
 313 void
 314 MidiPort::reset ()
 315 {
 316         Port::reset ();
 317         delete _buffer;
 318         cerr << name() << " new MIDI buffer of size " << AudioEngine::instance()->raw_buffer_size (DataType::MIDI) << endl;
 319         _buffer = new MidiBuffer (AudioEngine::instance()->raw_buffer_size (DataType::MIDI));
 320 }
 321
 322 void
 323 MidiPort::set_input_active (bool yn)
 324 {
 325         _input_active = yn;
 326 }
 327
 328 void
 329 MidiPort::set_always_parse (bool yn)
 330 {
 331         _always_parse = yn;
 332 }
 333
 334 void
 335 MidiPort::set_trace_on (bool yn)
 336 {
 337         _trace_on = yn;
 338 }
 339
 340 int
 341 MidiPort::add_shadow_port (string const & name, MidiFilter mf)
 342 {
 343         if (!ARDOUR::Port::receives_input()) {
 344                 return -1;
 345         }
 346
 347         if (_shadow_port) {
 348                 return -2;
 349         }
 350
 351         shadow_midi_filter = mf;
 352
 353         if (!(_shadow_port = boost::dynamic_pointer_cast<MidiPort> (AudioEngine::instance()->register_output_port (DataType::MIDI, name, false, PortFlags (Shadow|IsTerminal))))) {
 354                 return -3;
 355         }
 356
 357         /* forward on our port latency to the shadow port.
 358
 359            XXX: need to capture latency changes and forward them too.
 360         */
 361
 362         LatencyRange latency = private_latency_range (false);
 363         _shadow_port->set_private_latency_range (latency, false);
 364
 365         return 0;
 366 }