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