libs/ardour/midi_diskstream.cc

   1 /*
   2     Copyright (C) 2000-2003 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 <fstream>
  20 #include <cstdio>
  21 #include <unistd.h>
  22 #include <cmath>
  23 #include <cerrno>
  24 #include <string>
  25 #include <climits>
  26 #include <fcntl.h>
  27 #include <cstdlib>
  28 #include <ctime>
  29 #include <sys/stat.h>
  30 #include <sys/mman.h>
  31
  32 #include "pbd/error.h"
  33 #include "pbd/basename.h"
  34 #include <glibmm/thread.h>
  35 #include "pbd/xml++.h"
  36 #include "pbd/memento_command.h"
  37 #include "pbd/enumwriter.h"
  38 #include "pbd/stateful_diff_command.h"
  39
  40 #include "ardour/ardour.h"
  41 #include "ardour/audioengine.h"
  42 #include "ardour/butler.h"
  43 #include "ardour/configuration.h"
  44 #include "ardour/cycle_timer.h"
  45 #include "ardour/debug.h"
  46 #include "ardour/io.h"
  47 #include "ardour/midi_diskstream.h"
  48 #include "ardour/midi_playlist.h"
  49 #include "ardour/midi_port.h"
  50 #include "ardour/midi_region.h"
  51 #include "ardour/playlist_factory.h"
  52 #include "ardour/region_factory.h"
  53 #include "ardour/send.h"
  54 #include "ardour/session.h"
  55 #include "ardour/smf_source.h"
  56 #include "ardour/utils.h"
  57 #include "ardour/session_playlists.h"
  58
  59 #include "midi++/types.h"
  60
  61 #include "i18n.h"
  62 #include <locale.h>
  63
  64 using namespace std;
  65 using namespace ARDOUR;
  66 using namespace PBD;
  67
  68 nframes_t MidiDiskstream::midi_readahead = 4096;
  69
  70 MidiDiskstream::MidiDiskstream (Session &sess, const string &name, Diskstream::Flag flag)
  71         : Diskstream(sess, name, flag)
  72         , _playback_buf(0)
  73         , _capture_buf(0)
  74         , _source_port(0)
  75         , _last_flush_frame(0)
  76         , _note_mode(Sustained)
  77         , _frames_written_to_ringbuffer(0)
  78         , _frames_read_from_ringbuffer(0)
  79 {
  80         /* prevent any write sources from being created */
  81
  82         in_set_state = true;
  83
  84         init ();
  85         use_new_playlist ();
  86
  87         in_set_state = false;
  88
  89         assert(!destructive());
  90 }
  91
  92 MidiDiskstream::MidiDiskstream (Session& sess, const XMLNode& node)
  93         : Diskstream(sess, node)
  94         , _playback_buf(0)
  95         , _capture_buf(0)
  96         , _source_port(0)
  97         , _last_flush_frame(0)
  98         , _note_mode(Sustained)
  99         , _frames_written_to_ringbuffer(0)
 100         , _frames_read_from_ringbuffer(0)
 101 {
 102         in_set_state = true;
 103         init ();
 104
 105         if (set_state (node, Stateful::loading_state_version)) {
 106                 in_set_state = false;
 107                 throw failed_constructor();
 108         }
 109
 110         in_set_state = false;
 111
 112         if (destructive()) {
 113                 use_destructive_playlist ();
 114         }
 115 }
 116
 117 void
 118 MidiDiskstream::init ()
 119 {
 120         /* there are no channels at this point, so these
 121            two calls just get speed_buffer_size and wrap_buffer
 122            size setup without duplicating their code.
 123         */
 124
 125         set_block_size (_session.get_block_size());
 126         allocate_temporary_buffers ();
 127
 128         const size_t size = _session.butler()->midi_diskstream_buffer_size();
 129         _playback_buf = new MidiRingBuffer<nframes_t>(size);
 130         _capture_buf = new MidiRingBuffer<nframes_t>(size);
 131
 132         _n_channels = ChanCount(DataType::MIDI, 1);
 133
 134         assert(recordable());
 135 }
 136
 137 MidiDiskstream::~MidiDiskstream ()
 138 {
 139         Glib::Mutex::Lock lm (state_lock);
 140 }
 141
 142
 143 void
 144 MidiDiskstream::non_realtime_locate (nframes_t position)
 145 {
 146         if (_write_source) {
 147                 _write_source->set_timeline_position (position);
 148         }
 149         seek(position, false);
 150 }
 151
 152
 153 void
 154 MidiDiskstream::non_realtime_input_change ()
 155 {
 156         {
 157                 Glib::Mutex::Lock lm (state_lock);
 158
 159                 if (input_change_pending == NoChange) {
 160                         return;
 161                 }
 162
 163                 if (input_change_pending & ConfigurationChanged) {
 164                         if (_io->n_ports().n_midi() != _n_channels.n_midi()) {
 165                                 error << "Can not feed IO " << _io->n_ports()
 166                                         << " with diskstream " << _n_channels << endl;
 167                         }
 168                 }
 169
 170                 get_input_sources ();
 171                 set_capture_offset ();
 172
 173                 if (first_input_change) {
 174                         set_align_style (_persistent_alignment_style);
 175                         first_input_change = false;
 176                 } else {
 177                         set_align_style_from_io ();
 178                 }
 179
 180                 input_change_pending = NoChange;
 181
 182                 /* implicit unlock */
 183         }
 184
 185         /* reset capture files */
 186
 187         reset_write_sources (false);
 188
 189         /* now refill channel buffers */
 190
 191         if (speed() != 1.0f || speed() != -1.0f) {
 192                 seek ((nframes_t) (_session.transport_frame() * (double) speed()));
 193         }
 194         else {
 195                 seek (_session.transport_frame());
 196         }
 197
 198         _last_flush_frame = _session.transport_frame();
 199 }
 200
 201 void
 202 MidiDiskstream::get_input_sources ()
 203 {
 204         uint32_t ni = _io->n_ports().n_midi();
 205
 206         if (ni == 0) {
 207                 return;
 208         }
 209
 210         // This is all we do for now at least
 211         assert(ni == 1);
 212
 213         _source_port = _io->midi(0);
 214
 215         // do... stuff?
 216 }
 217
 218 int
 219 MidiDiskstream::find_and_use_playlist (const string& name)
 220 {
 221         boost::shared_ptr<MidiPlaylist> playlist;
 222
 223         if ((playlist = boost::dynamic_pointer_cast<MidiPlaylist> (_session.playlists->by_name (name))) == 0) {
 224                 playlist = boost::dynamic_pointer_cast<MidiPlaylist> (PlaylistFactory::create (DataType::MIDI, _session, name));
 225         }
 226
 227         if (!playlist) {
 228                 error << string_compose(_("MidiDiskstream: Playlist \"%1\" isn't an midi playlist"), name) << endmsg;
 229                 return -1;
 230         }
 231
 232         return use_playlist (playlist);
 233 }
 234
 235 int
 236 MidiDiskstream::use_playlist (boost::shared_ptr<Playlist> playlist)
 237 {
 238         assert(boost::dynamic_pointer_cast<MidiPlaylist>(playlist));
 239
 240         Diskstream::use_playlist(playlist);
 241
 242         return 0;
 243 }
 244
 245 int
 246 MidiDiskstream::use_new_playlist ()
 247 {
 248         string newname;
 249         boost::shared_ptr<MidiPlaylist> playlist;
 250
 251         if (!in_set_state && destructive()) {
 252                 return 0;
 253         }
 254
 255         if (_playlist) {
 256                 newname = Playlist::bump_name (_playlist->name(), _session);
 257         } else {
 258                 newname = Playlist::bump_name (_name, _session);
 259         }
 260
 261         if ((playlist = boost::dynamic_pointer_cast<MidiPlaylist> (PlaylistFactory::create (
 262                         DataType::MIDI, _session, newname, hidden()))) != 0) {
 263
 264                 playlist->set_orig_diskstream_id (id());
 265                 return use_playlist (playlist);
 266
 267         } else {
 268                 return -1;
 269         }
 270 }
 271
 272 int
 273 MidiDiskstream::use_copy_playlist ()
 274 {
 275         assert(midi_playlist());
 276
 277         if (destructive()) {
 278                 return 0;
 279         }
 280
 281         if (_playlist == 0) {
 282                 error << string_compose(_("MidiDiskstream %1: there is no existing playlist to make a copy of!"), _name) << endmsg;
 283                 return -1;
 284         }
 285
 286         string newname;
 287         boost::shared_ptr<MidiPlaylist> playlist;
 288
 289         newname = Playlist::bump_name (_playlist->name(), _session);
 290
 291         if ((playlist  = boost::dynamic_pointer_cast<MidiPlaylist>(PlaylistFactory::create (midi_playlist(), newname))) != 0) {
 292                 playlist->set_orig_diskstream_id (id());
 293                 return use_playlist (playlist);
 294         } else {
 295                 return -1;
 296         }
 297 }
 298
 299 /** Overloaded from parent to die horribly
 300  */
 301 int
 302 MidiDiskstream::set_destructive (bool yn)
 303 {
 304         assert( ! destructive());
 305         assert( ! yn);
 306         return -1;
 307 }
 308
 309 void
 310 MidiDiskstream::set_note_mode (NoteMode m)
 311 {
 312         _note_mode = m;
 313         midi_playlist()->set_note_mode(m);
 314         if (_write_source && _write_source->model())
 315                 _write_source->model()->set_note_mode(m);
 316 }
 317
 318 #if 0
 319 static void
 320 trace_midi (ostream& o, MIDI::byte *msg, size_t len)
 321 {
 322         using namespace MIDI;
 323         eventType type;
 324         const char trace_prefix = ':';
 325
 326         type = (eventType) (msg[0]&0xF0);
 327
 328         switch (type) {
 329         case off:
 330                 o << trace_prefix
 331                    << "Channel "
 332                    << (msg[0]&0xF)+1
 333                    << " NoteOff NoteNum "
 334                    << (int) msg[1]
 335                    << " Vel "
 336                    << (int) msg[2]
 337                    << endl;
 338                 break;
 339
 340         case on:
 341                 o << trace_prefix
 342                    << "Channel "
 343                    << (msg[0]&0xF)+1
 344                    << " NoteOn NoteNum "
 345                    << (int) msg[1]
 346                    << " Vel "
 347                    << (int) msg[2]
 348                    << endl;
 349                 break;
 350
 351         case polypress:
 352                 o << trace_prefix
 353                    << "Channel "
 354                    << (msg[0]&0xF)+1
 355                    << " PolyPressure"
 356                    << (int) msg[1]
 357                    << endl;
 358                 break;
 359
 360         case MIDI::controller:
 361                 o << trace_prefix
 362                    << "Channel "
 363                    << (msg[0]&0xF)+1
 364                    << " Controller "
 365                    << (int) msg[1]
 366                    << " Value "
 367                    << (int) msg[2]
 368                    << endl;
 369                 break;
 370
 371         case program:
 372                 o << trace_prefix
 373                    << "Channel "
 374                    << (msg[0]&0xF)+1
 375                    <<  " Program PropertyChange ProgNum "
 376                    << (int) msg[1]
 377                    << endl;
 378                 break;
 379
 380         case chanpress:
 381                 o << trace_prefix
 382                    << "Channel "
 383                    << (msg[0]&0xF)+1
 384                    << " Channel Pressure "
 385                    << (int) msg[1]
 386                    << endl;
 387                 break;
 388
 389         case MIDI::pitchbend:
 390                 o << trace_prefix
 391                    << "Channel "
 392                    << (msg[0]&0xF)+1
 393                    << " Pitch Bend "
 394                    << ((msg[2]<<7)|msg[1])
 395                    << endl;
 396                 break;
 397
 398         case MIDI::sysex:
 399                 if (len == 1) {
 400                         switch (msg[0]) {
 401                         case 0xf8:
 402                                 o << trace_prefix
 403                                    << "Clock"
 404                                    << endl;
 405                                 break;
 406                         case 0xfa:
 407                                 o << trace_prefix
 408                                    << "Start"
 409                                    << endl;
 410                                 break;
 411                         case 0xfb:
 412                                 o << trace_prefix
 413                                    << "Continue"
 414                                    << endl;
 415                                 break;
 416                         case 0xfc:
 417                                 o << trace_prefix
 418                                    << "Stop"
 419                                    << endl;
 420                                 break;
 421                         case 0xfe:
 422                                 o << trace_prefix
 423                                    << "Active Sense"
 424                                    << endl;
 425                                 break;
 426                         case 0xff:
 427                                 o << trace_prefix
 428                                    << "System Reset"
 429                                    << endl;
 430                                 break;
 431                         default:
 432                                 o << trace_prefix
 433                                    << "System Exclusive (1 byte : " << hex << (int) *msg << dec << ')'
 434                                    << endl;
 435                                 break;
 436                         }
 437                 } else {
 438                         o << trace_prefix
 439                            << "System Exclusive (" << len << ") = [ " << hex;
 440                         for (unsigned int i = 0; i < len; ++i) {
 441                                 o << (int) msg[i] << ' ';
 442                         }
 443                         o << dec << ']' << endl;
 444
 445                 }
 446                 break;
 447
 448         case MIDI::song:
 449                 o << trace_prefix << "Song" << endl;
 450                 break;
 451
 452         case MIDI::tune:
 453                 o << trace_prefix << "Tune" << endl;
 454                 break;
 455
 456         case MIDI::eox:
 457                 o << trace_prefix << "End-of-System Exclusive" << endl;
 458                 break;
 459
 460         case MIDI::timing:
 461                 o << trace_prefix << "Timing" << endl;
 462                 break;
 463
 464         case MIDI::start:
 465                 o << trace_prefix << "Start" << endl;
 466                 break;
 467
 468         case MIDI::stop:
 469                 o << trace_prefix << "Stop" << endl;
 470                 break;
 471
 472         case MIDI::contineu:
 473                 o << trace_prefix << "Continue" << endl;
 474                 break;
 475
 476         case active:
 477                 o << trace_prefix << "Active Sense" << endl;
 478                 break;
 479
 480         default:
 481                 o << trace_prefix << "Unrecognized MIDI message" << endl;
 482                 break;
 483         }
 484 }
 485 #endif
 486
 487 int
 488 MidiDiskstream::process (nframes_t transport_frame, nframes_t nframes, bool can_record, bool rec_monitors_input, bool& need_butler)
 489 {
 490         int       ret = -1;
 491         nframes_t rec_offset = 0;
 492         nframes_t rec_nframes = 0;
 493         bool      nominally_recording;
 494         bool      re = record_enabled ();
 495
 496         playback_distance = 0;
 497
 498         check_record_status (transport_frame, nframes, can_record);
 499
 500         nominally_recording = (can_record && re);
 501
 502         if (nframes == 0) {
 503                 return 0;
 504         }
 505
 506         Glib::Mutex::Lock sm (state_lock, Glib::TRY_LOCK);
 507
 508         if (!sm.locked()) {
 509                 return 1;
 510         }
 511
 512         adjust_capture_position = 0;
 513
 514         if (nominally_recording || (_session.get_record_enabled() && _session.config.get_punch_in())) {
 515                 OverlapType ot = coverage (first_recordable_frame, last_recordable_frame, transport_frame, transport_frame + nframes);
 516
 517                 calculate_record_range(ot, transport_frame, nframes, rec_nframes, rec_offset);
 518
 519                 if (rec_nframes && !was_recording) {
 520                         capture_captured = 0;
 521                         was_recording = true;
 522                 }
 523         }
 524
 525
 526         if (can_record && !_last_capture_regions.empty()) {
 527                 _last_capture_regions.clear ();
 528         }
 529
 530         if (nominally_recording || rec_nframes) {
 531
 532                 // Pump entire port buffer into the ring buffer (FIXME: split cycles?)
 533                 MidiBuffer& buf = _source_port->get_midi_buffer(nframes);
 534                 for (MidiBuffer::iterator i = buf.begin(); i != buf.end(); ++i) {
 535                         const Evoral::MIDIEvent<MidiBuffer::TimeType> ev(*i, false);
 536                         assert(ev.buffer());
 537                         _capture_buf->write(ev.time() + transport_frame, ev.type(), ev.size(), ev.buffer());
 538                 }
 539
 540         } else {
 541
 542                 if (was_recording) {
 543                         finish_capture (rec_monitors_input);
 544                 }
 545
 546         }
 547
 548         if (rec_nframes) {
 549
 550                 /* data will be written to disk */
 551
 552                 if (rec_nframes == nframes && rec_offset == 0) {
 553                         playback_distance = nframes;
 554                 }
 555
 556                 adjust_capture_position = rec_nframes;
 557
 558         } else if (nominally_recording) {
 559
 560                 /* XXXX do this for MIDI !!!
 561                    can't do actual capture yet - waiting for latency effects to finish before we start
 562                    */
 563
 564                 playback_distance = nframes;
 565
 566         }
 567
 568         ret = 0;
 569
 570         if (commit (nframes)) {
 571                 need_butler = true;
 572         }
 573
 574         return ret;
 575 }
 576
 577 bool
 578 MidiDiskstream::commit (nframes_t nframes)
 579 {
 580         bool need_butler = false;
 581
 582         if (_actual_speed < 0.0) {
 583                 playback_sample -= playback_distance;
 584         } else {
 585                 playback_sample += playback_distance;
 586         }
 587
 588         if (adjust_capture_position != 0) {
 589                 capture_captured += adjust_capture_position;
 590                 adjust_capture_position = 0;
 591         }
 592
 593         uint32_t frames_read = g_atomic_int_get(&_frames_read_from_ringbuffer);
 594         uint32_t frames_written = g_atomic_int_get(&_frames_written_to_ringbuffer);
 595         if ((frames_written - frames_read) + nframes < midi_readahead) {
 596                 need_butler = true;
 597         }
 598
 599         /*cerr << "MDS written: " << frames_written << " - read: " << frames_read <<
 600                 " = " << frames_written - frames_read
 601                 << " + " << nframes << " < " << midi_readahead << " = " << need_butler << ")" << endl;*/
 602
 603         return need_butler;
 604 }
 605
 606 void
 607 MidiDiskstream::set_pending_overwrite (bool yn)
 608 {
 609         /* called from audio thread, so we can use the read ptr and playback sample as we wish */
 610
 611         pending_overwrite = yn;
 612
 613         overwrite_frame = playback_sample;
 614 }
 615
 616 int
 617 MidiDiskstream::overwrite_existing_buffers ()
 618 {
 619         //read(overwrite_frame, disk_io_chunk_frames, false);
 620         overwrite_queued = false;
 621         pending_overwrite = false;
 622
 623         return 0;
 624 }
 625
 626 int
 627 MidiDiskstream::seek (nframes_t frame, bool complete_refill)
 628 {
 629         Glib::Mutex::Lock lm (state_lock);
 630         int ret = -1;
 631
 632         _playback_buf->reset();
 633         _capture_buf->reset();
 634         g_atomic_int_set(&_frames_read_from_ringbuffer, 0);
 635         g_atomic_int_set(&_frames_written_to_ringbuffer, 0);
 636
 637         playback_sample = frame;
 638         file_frame = frame;
 639
 640         if (complete_refill) {
 641                 while ((ret = do_refill_with_alloc ()) > 0) ;
 642         } else {
 643                 ret = do_refill_with_alloc ();
 644         }
 645
 646         return ret;
 647 }
 648
 649 int
 650 MidiDiskstream::can_internal_playback_seek (nframes_t distance)
 651 {
 652         uint32_t frames_read    = g_atomic_int_get(&_frames_read_from_ringbuffer);
 653         uint32_t frames_written = g_atomic_int_get(&_frames_written_to_ringbuffer);
 654         return ((frames_written - frames_read) < distance);
 655 }
 656
 657 int
 658 MidiDiskstream::internal_playback_seek (nframes_t distance)
 659 {
 660         first_recordable_frame += distance;
 661         playback_sample += distance;
 662
 663         return 0;
 664 }
 665
 666 /** @a start is set to the new frame position (TIME) read up to */
 667 int
 668 MidiDiskstream::read (nframes_t& start, nframes_t dur, bool reversed)
 669 {
 670         nframes_t this_read = 0;
 671         bool reloop = false;
 672         nframes_t loop_end = 0;
 673         nframes_t loop_start = 0;
 674         Location *loc = 0;
 675
 676         if (!reversed) {
 677
 678                 nframes_t loop_length = 0;
 679
 680                 /* Make the use of a Location atomic for this read operation.
 681
 682                    Note: Locations don't get deleted, so all we care about
 683                    when I say "atomic" is that we are always pointing to
 684                    the same one and using a start/length values obtained
 685                    just once.
 686                 */
 687
 688                 if ((loc = loop_location) != 0) {
 689                         loop_start = loc->start();
 690                         loop_end = loc->end();
 691                         loop_length = loop_end - loop_start;
 692                 }
 693
 694                 /* if we are looping, ensure that the first frame we read is at the correct
 695                    position within the loop.
 696                 */
 697
 698                 if (loc && (start >= loop_end)) {
 699                         //cerr << "start adjusted from " << start;
 700                         start = loop_start + ((start - loop_start) % loop_length);
 701                         //cerr << "to " << start << endl;
 702                 }
 703                 //cerr << "start is " << start << "  loopstart: " << loop_start << "  loopend: " << loop_end << endl;
 704         }
 705
 706         while (dur) {
 707
 708                 /* take any loop into account. we can't read past the end of the loop. */
 709
 710                 if (loc && (loop_end - start < dur)) {
 711                         this_read = loop_end - start;
 712                         //cerr << "reloop true: thisread: " << this_read << "  dur: " << dur << endl;
 713                         reloop = true;
 714                 } else {
 715                         reloop = false;
 716                         this_read = dur;
 717                 }
 718
 719                 if (this_read == 0) {
 720                         break;
 721                 }
 722
 723                 this_read = min(dur,this_read);
 724
 725                 if (midi_playlist()->read (*_playback_buf, start, this_read) != this_read) {
 726                         error << string_compose(
 727                                         _("MidiDiskstream %1: cannot read %2 from playlist at frame %3"),
 728                                         _id, this_read, start) << endmsg;
 729                         return -1;
 730                 }
 731
 732                 g_atomic_int_add(&_frames_written_to_ringbuffer, this_read);
 733
 734                 _read_data_count = _playlist->read_data_count();
 735
 736                 if (reversed) {
 737
 738                         // Swap note ons with note offs here.  etc?
 739                         // Fully reversing MIDI requires look-ahead (well, behind) to find previous
 740                         // CC values etc.  hard.
 741
 742                 } else {
 743
 744                         /* if we read to the end of the loop, go back to the beginning */
 745
 746                         if (reloop) {
 747                                 // Synthesize LoopEvent here, because the next events
 748                                 // written will have non-monotonic timestamps.
 749                                 _playback_buf->write(loop_end - 1, LoopEventType, 0, 0);
 750                                 cout << "Pushing LoopEvent ts=" << loop_end-1
 751                                      << " start+this_read " << start+this_read << endl;
 752
 753                                 start = loop_start;
 754                         } else {
 755                                 start += this_read;
 756                         }
 757                 }
 758
 759                 dur -= this_read;
 760                 //offset += this_read;
 761         }
 762
 763         return 0;
 764 }
 765
 766 int
 767 MidiDiskstream::do_refill_with_alloc ()
 768 {
 769         return do_refill();
 770 }
 771
 772 int
 773 MidiDiskstream::do_refill ()
 774 {
 775         int     ret         = 0;
 776         size_t  write_space = _playback_buf->write_space();
 777         bool    reversed    = (_visible_speed * _session.transport_speed()) < 0.0f;
 778
 779         if (write_space == 0) {
 780                 return 0;
 781         }
 782
 783         if (reversed) {
 784                 return 0;
 785         }
 786
 787         /* at end: nothing to do */
 788         if (file_frame == max_frames) {
 789                 return 0;
 790         }
 791
 792         // At this point we...
 793         assert(_playback_buf->write_space() > 0); // ... have something to write to, and
 794         assert(file_frame <= max_frames); // ... something to write
 795
 796         // now calculate how much time is in the ringbuffer.
 797         // and lets write as much as we need to get this to be midi_readahead;
 798         uint32_t frames_read = g_atomic_int_get(&_frames_read_from_ringbuffer);
 799         uint32_t frames_written = g_atomic_int_get(&_frames_written_to_ringbuffer);
 800         if ((frames_written - frames_read) >= midi_readahead) {
 801                 //cout << "MDS Nothing to do. all fine" << endl;
 802                 return 0;
 803         }
 804
 805         nframes_t to_read = midi_readahead - (frames_written - frames_read);
 806
 807         //cout << "MDS read for midi_readahead " << to_read << "  rb_contains: "
 808         //      << frames_written - frames_read << endl;
 809
 810         to_read = min(to_read, (max_frames - file_frame));
 811
 812         if (read (file_frame, to_read, reversed)) {
 813                 ret = -1;
 814         }
 815
 816         return ret;
 817 }
 818
 819 /** Flush pending data to disk.
 820  *
 821  * Important note: this function will write *AT MOST* disk_io_chunk_frames
 822  * of data to disk. it will never write more than that.  If it writes that
 823  * much and there is more than that waiting to be written, it will return 1,
 824  * otherwise 0 on success or -1 on failure.
 825  *
 826  * If there is less than disk_io_chunk_frames to be written, no data will be
 827  * written at all unless @a force_flush is true.
 828  */
 829 int
 830 MidiDiskstream::do_flush (RunContext /*context*/, bool force_flush)
 831 {
 832         uint32_t to_write;
 833         int32_t ret = 0;
 834         nframes_t total;
 835
 836         _write_data_count = 0;
 837
 838         total = _session.transport_frame() - _last_flush_frame;
 839
 840         if (_last_flush_frame > _session.transport_frame()
 841                         || _last_flush_frame < capture_start_frame) {
 842                 _last_flush_frame = _session.transport_frame();
 843         }
 844
 845         if (total == 0 || _capture_buf->read_space() == 0
 846                         || (!force_flush && (total < disk_io_chunk_frames && was_recording))) {
 847                 goto out;
 848         }
 849
 850         /* if there are 2+ chunks of disk i/o possible for
 851            this track, let the caller know so that it can arrange
 852            for us to be called again, ASAP.
 853
 854            if we are forcing a flush, then if there is* any* extra
 855            work, let the caller know.
 856
 857            if we are no longer recording and there is any extra work,
 858            let the caller know too.
 859            */
 860
 861         if (total >= 2 * disk_io_chunk_frames || ((force_flush || !was_recording) && total > disk_io_chunk_frames)) {
 862                 ret = 1;
 863         }
 864
 865         to_write = disk_io_chunk_frames;
 866
 867         assert(!destructive());
 868
 869         if (record_enabled()
 870                         && (   (_session.transport_frame() - _last_flush_frame > disk_io_chunk_frames)
 871                                 || force_flush)) {
 872                 if ((!_write_source) || _write_source->midi_write (*_capture_buf, capture_start_frame, to_write) != to_write) {
 873                         error << string_compose(_("MidiDiskstream %1: cannot write to disk"), _id) << endmsg;
 874                         return -1;
 875                 } else {
 876                         _last_flush_frame = _session.transport_frame();
 877                 }
 878         }
 879
 880 out:
 881         return ret;
 882 }
 883
 884 void
 885 MidiDiskstream::transport_stopped (struct tm& /*when*/, time_t /*twhen*/, bool abort_capture)
 886 {
 887         bool more_work = true;
 888         int err = 0;
 889         boost::shared_ptr<MidiRegion> region;
 890         MidiRegion::SourceList srcs;
 891         MidiRegion::SourceList::iterator src;
 892         vector<CaptureInfo*>::iterator ci;
 893         bool mark_write_completed = false;
 894
 895         finish_capture (true);
 896
 897         /* butler is already stopped, but there may be work to do
 898            to flush remaining data to disk.
 899            */
 900
 901         while (more_work && !err) {
 902                 switch (do_flush (TransportContext, true)) {
 903                         case 0:
 904                                 more_work = false;
 905                                 break;
 906                         case 1:
 907                                 break;
 908                         case -1:
 909                                 error << string_compose(_("MidiDiskstream \"%1\": cannot flush captured data to disk!"), _name) << endmsg;
 910                                 err++;
 911                 }
 912         }
 913
 914         /* XXX is there anything we can do if err != 0 ? */
 915         Glib::Mutex::Lock lm (capture_info_lock);
 916
 917         if (capture_info.empty()) {
 918                 return;
 919         }
 920
 921         if (abort_capture) {
 922
 923                 if (_write_source) {
 924
 925                         _write_source->mark_for_remove ();
 926                         _write_source->drop_references ();
 927                         _write_source.reset();
 928                 }
 929
 930                 /* new source set up in "out" below */
 931
 932         } else {
 933
 934                 assert(_write_source);
 935
 936                 nframes_t total_capture = 0;
 937                 for (ci = capture_info.begin(); ci != capture_info.end(); ++ci) {
 938                         total_capture += (*ci)->frames;
 939                 }
 940
 941                 /* figure out the name for this take */
 942
 943                 srcs.push_back (_write_source);
 944                 _write_source->set_timeline_position (capture_info.front()->start);
 945                 _write_source->set_captured_for (_name);
 946
 947                 string whole_file_region_name;
 948                 whole_file_region_name = region_name_from_path (_write_source->name(), true);
 949
 950                 /* Register a new region with the Session that
 951                    describes the entire source. Do this first
 952                    so that any sub-regions will obviously be
 953                    children of this one (later!)
 954                    */
 955
 956                 try {
 957                         PropertyList plist;
 958
 959                         plist.add (Properties::name, whole_file_region_name);
 960                         plist.add (Properties::whole_file, true);
 961                         plist.add (Properties::automatic, true);
 962                         plist.add (Properties::start, 0);
 963                         plist.add (Properties::length, total_capture);
 964                         plist.add (Properties::layer, 0);
 965
 966                         boost::shared_ptr<Region> rx (RegionFactory::create (srcs, plist));
 967
 968                         region = boost::dynamic_pointer_cast<MidiRegion> (rx);
 969                         region->special_set_position (capture_info.front()->start);
 970                 }
 971
 972
 973                 catch (failed_constructor& err) {
 974                         error << string_compose(_("%1: could not create region for complete midi file"), _name) << endmsg;
 975                         /* XXX what now? */
 976                 }
 977
 978                 _last_capture_regions.push_back (region);
 979
 980                 // cerr << _name << ": there are " << capture_info.size() << " capture_info records\n";
 981
 982                 _playlist->clear_history ();
 983                 _playlist->freeze ();
 984
 985                 uint32_t buffer_position = 0;
 986                 for (buffer_position = 0, ci = capture_info.begin(); ci != capture_info.end(); ++ci) {
 987
 988                         string region_name;
 989
 990                         RegionFactory::region_name (region_name, _write_source->name(), false);
 991
 992                         // cerr << _name << ": based on ci of " << (*ci)->start << " for " << (*ci)->frames << " add a region\n";
 993
 994                         try {
 995                                 PropertyList plist;
 996
 997                                 plist.add (Properties::start, buffer_position);
 998                                 plist.add (Properties::length, (*ci)->frames);
 999                                 plist.add (Properties::name, region_name);
1000
1001                                 boost::shared_ptr<Region> rx (RegionFactory::create (srcs, plist));
1002                                 region = boost::dynamic_pointer_cast<MidiRegion> (rx);
1003                         }
1004
1005                         catch (failed_constructor& err) {
1006                                 error << _("MidiDiskstream: could not create region for captured midi!") << endmsg;
1007                                 continue; /* XXX is this OK? */
1008                         }
1009
1010                         region->DropReferences.connect_same_thread (*this, boost::bind (&Diskstream::remove_region_from_last_capture, this, boost::weak_ptr<Region>(region)));
1011
1012                         _last_capture_regions.push_back (region);
1013
1014                         // cerr << "add new region, buffer position = " << buffer_position << " @ " << (*ci)->start << endl;
1015
1016                         i_am_the_modifier++;
1017                         _playlist->add_region (region, (*ci)->start);
1018                         i_am_the_modifier--;
1019
1020                         buffer_position += (*ci)->frames;
1021                 }
1022
1023                 _playlist->thaw ();
1024                 _session.add_command (new StatefulDiffCommand(_playlist));
1025
1026         }
1027
1028         mark_write_completed = true;
1029
1030         reset_write_sources (mark_write_completed);
1031
1032         for (ci = capture_info.begin(); ci != capture_info.end(); ++ci) {
1033                 delete *ci;
1034         }
1035
1036         if (_playlist) {
1037                 midi_playlist()->clear_note_trackers ();
1038         }
1039
1040         capture_info.clear ();
1041         capture_start_frame = 0;
1042 }
1043
1044 void
1045 MidiDiskstream::transport_looped (nframes_t transport_frame)
1046 {
1047         if (was_recording) {
1048
1049                 // adjust the capture length knowing that the data will be recorded to disk
1050                 // only necessary after the first loop where we're recording
1051                 if (capture_info.size() == 0) {
1052                         capture_captured += _capture_offset;
1053
1054                         if (_alignment_style == ExistingMaterial) {
1055                                 capture_captured += _session.worst_output_latency();
1056                         } else {
1057                                 capture_captured += _roll_delay;
1058                         }
1059                 }
1060
1061                 finish_capture (true);
1062
1063                 // the next region will start recording via the normal mechanism
1064                 // we'll set the start position to the current transport pos
1065                 // no latency adjustment or capture offset needs to be made, as that already happened the first time
1066                 capture_start_frame = transport_frame;
1067                 first_recordable_frame = transport_frame; // mild lie
1068                 last_recordable_frame = max_frames;
1069                 was_recording = true;
1070         }
1071 }
1072
1073 void
1074 MidiDiskstream::finish_capture (bool /*rec_monitors_input*/)
1075 {
1076         was_recording = false;
1077
1078         if (capture_captured == 0) {
1079                 return;
1080         }
1081
1082         // Why must we destroy?
1083         assert(!destructive());
1084
1085         CaptureInfo* ci = new CaptureInfo;
1086
1087         ci->start  = capture_start_frame;
1088         ci->frames = capture_captured;
1089
1090         /* XXX theoretical race condition here. Need atomic exchange ?
1091            However, the circumstances when this is called right
1092            now (either on record-disable or transport_stopped)
1093            mean that no actual race exists. I think ...
1094            We now have a capture_info_lock, but it is only to be used
1095            to synchronize in the transport_stop and the capture info
1096            accessors, so that invalidation will not occur (both non-realtime).
1097         */
1098
1099         // cerr << "Finish capture, add new CI, " << ci->start << '+' << ci->frames << endl;
1100
1101         capture_info.push_back (ci);
1102         capture_captured = 0;
1103 }
1104
1105 void
1106 MidiDiskstream::set_record_enabled (bool yn)
1107 {
1108         if (!recordable() || !_session.record_enabling_legal()) {
1109                 return;
1110         }
1111
1112         assert(!destructive());
1113
1114         /* yes, i know that this not proof against race conditions, but its
1115            good enough. i think.
1116         */
1117
1118         if (record_enabled() != yn) {
1119                 if (yn) {
1120                         engage_record_enable ();
1121                 } else {
1122                         disengage_record_enable ();
1123                 }
1124         }
1125 }
1126
1127 void
1128 MidiDiskstream::engage_record_enable ()
1129 {
1130     bool rolling = _session.transport_speed() != 0.0f;
1131
1132         g_atomic_int_set (&_record_enabled, 1);
1133
1134         if (_source_port && Config->get_monitoring_model() == HardwareMonitoring) {
1135                 _source_port->request_monitor_input (!(_session.config.get_auto_input() && rolling));
1136         }
1137
1138         // FIXME: Why is this necessary?  Isn't needed for AudioDiskstream...
1139         if (!_write_source)
1140                 use_new_write_source();
1141
1142         _write_source->mark_streaming_midi_write_started (_note_mode, _session.transport_frame());
1143
1144         RecordEnableChanged (); /* EMIT SIGNAL */
1145 }
1146
1147 void
1148 MidiDiskstream::disengage_record_enable ()
1149 {
1150         g_atomic_int_set (&_record_enabled, 0);
1151         if (_source_port && Config->get_monitoring_model() == HardwareMonitoring) {
1152                 if (_source_port) {
1153                         _source_port->request_monitor_input (false);
1154                 }
1155         }
1156
1157         RecordEnableChanged (); /* EMIT SIGNAL */
1158 }
1159
1160 XMLNode&
1161 MidiDiskstream::get_state ()
1162 {
1163         XMLNode* node = new XMLNode ("MidiDiskstream");
1164         char buf[64];
1165         LocaleGuard lg (X_("POSIX"));
1166
1167         snprintf (buf, sizeof(buf), "0x%x", _flags);
1168         node->add_property ("flags", buf);
1169
1170         node->add_property("channel-mode", enum_2_string(get_channel_mode()));
1171
1172         snprintf (buf, sizeof(buf), "0x%x", get_channel_mask());
1173         node->add_property("channel-mask", buf);
1174
1175         node->add_property ("playlist", _playlist->name());
1176
1177         snprintf (buf, sizeof(buf), "%f", _visible_speed);
1178         node->add_property ("speed", buf);
1179
1180         node->add_property("name", _name);
1181         id().print(buf, sizeof(buf));
1182         node->add_property("id", buf);
1183
1184         if (_write_source && _session.get_record_enabled()) {
1185
1186                 XMLNode* cs_child = new XMLNode (X_("CapturingSources"));
1187                 XMLNode* cs_grandchild;
1188
1189                 cs_grandchild = new XMLNode (X_("file"));
1190                 cs_grandchild->add_property (X_("path"), _write_source->path());
1191                 cs_child->add_child_nocopy (*cs_grandchild);
1192
1193                 /* store the location where capture will start */
1194
1195                 Location* pi;
1196
1197                 if (_session.config.get_punch_in() && ((pi = _session.locations()->auto_punch_location()) != 0)) {
1198                         snprintf (buf, sizeof (buf), "%" PRId64, pi->start());
1199                 } else {
1200                         snprintf (buf, sizeof (buf), "%" PRId64, _session.transport_frame());
1201                 }
1202
1203                 cs_child->add_property (X_("at"), buf);
1204                 node->add_child_nocopy (*cs_child);
1205         }
1206
1207         if (_extra_xml) {
1208                 node->add_child_copy (*_extra_xml);
1209         }
1210
1211         return* node;
1212 }
1213
1214 int
1215 MidiDiskstream::set_state (const XMLNode& node, int /*version*/)
1216 {
1217         const XMLProperty* prop;
1218         XMLNodeList nlist = node.children();
1219         XMLNodeIterator niter;
1220         XMLNode* capture_pending_node = 0;
1221         LocaleGuard lg (X_("POSIX"));
1222
1223         in_set_state = true;
1224
1225         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
1226                 /*if ((*niter)->name() == IO::state_node_name) {
1227                         deprecated_io_node = new XMLNode (**niter);
1228                 }*/
1229                 assert ((*niter)->name() != IO::state_node_name);
1230
1231                 if ((*niter)->name() == X_("CapturingSources")) {
1232                         capture_pending_node = *niter;
1233                 }
1234         }
1235
1236         /* prevent write sources from being created */
1237
1238         in_set_state = true;
1239
1240         if ((prop = node.property ("name")) != 0) {
1241                 _name = prop->value();
1242         }
1243
1244         if ((prop = node.property ("id")) != 0) {
1245                 _id = prop->value ();
1246         }
1247
1248         if ((prop = node.property ("flags")) != 0) {
1249                 _flags = Flag (string_2_enum (prop->value(), _flags));
1250         }
1251
1252         ChannelMode channel_mode = AllChannels;
1253         if ((prop = node.property ("channel-mode")) != 0) {
1254                 channel_mode = ChannelMode (string_2_enum(prop->value(), channel_mode));
1255         }
1256
1257         unsigned int channel_mask = 0xFFFF;
1258         if ((prop = node.property ("channel-mask")) != 0) {
1259                 sscanf (prop->value().c_str(), "0x%x", &channel_mask);
1260                 if (channel_mask & (~0xFFFF)) {
1261                         warning << _("MidiDiskstream: XML property channel-mask out of range") << endmsg;
1262                 }
1263         }
1264
1265         set_channel_mode(channel_mode, channel_mask);
1266
1267         if ((prop = node.property ("playlist")) == 0) {
1268                 return -1;
1269         }
1270
1271         {
1272                 bool had_playlist = (_playlist != 0);
1273
1274                 if (find_and_use_playlist (prop->value())) {
1275                         return -1;
1276                 }
1277
1278                 if (!had_playlist) {
1279                         _playlist->set_orig_diskstream_id (_id);
1280                 }
1281
1282                 if (capture_pending_node) {
1283                         use_pending_capture_data (*capture_pending_node);
1284                 }
1285
1286         }
1287
1288         if ((prop = node.property ("speed")) != 0) {
1289                 double sp = atof (prop->value().c_str());
1290
1291                 if (realtime_set_speed (sp, false)) {
1292                         non_realtime_set_speed ();
1293                 }
1294         }
1295
1296         in_set_state = false;
1297
1298         /* make sure this is clear before we do anything else */
1299
1300         // FIXME?
1301         //_capturing_source = 0;
1302
1303         /* write sources are handled when we handle the input set
1304            up of the IO that owns this DS (::non_realtime_input_change())
1305         */
1306
1307         in_set_state = false;
1308
1309         return 0;
1310 }
1311
1312 int
1313 MidiDiskstream::use_new_write_source (uint32_t n)
1314 {
1315         if (!recordable()) {
1316                 return 1;
1317         }
1318
1319         assert(n == 0);
1320
1321         if (_write_source) {
1322
1323                 if (_write_source->is_empty ()) {
1324                         _write_source->mark_for_remove ();
1325                         _write_source.reset();
1326                 } else {
1327                         _write_source.reset();
1328                 }
1329         }
1330
1331         try {
1332                 _write_source = boost::dynamic_pointer_cast<SMFSource>(_session.create_midi_source_for_session (*this));
1333                 if (!_write_source) {
1334                         throw failed_constructor();
1335                 }
1336         }
1337
1338         catch (failed_constructor &err) {
1339                 error << string_compose (_("%1:%2 new capture file not initialized correctly"), _name, n) << endmsg;
1340                 _write_source.reset();
1341                 return -1;
1342         }
1343
1344         _write_source->set_allow_remove_if_empty (true);
1345         _write_source->mark_streaming_midi_write_started (_note_mode, _session.transport_frame());
1346
1347         return 0;
1348 }
1349
1350 void
1351 MidiDiskstream::reset_write_sources (bool mark_write_complete, bool /*force*/)
1352 {
1353         if (!_session.writable() || !recordable()) {
1354                 return;
1355         }
1356
1357         if (_write_source && mark_write_complete) {
1358                 _write_source->mark_streaming_write_completed ();
1359         }
1360
1361         use_new_write_source (0);
1362 }
1363
1364 int
1365 MidiDiskstream::rename_write_sources ()
1366 {
1367         if (_write_source != 0) {
1368                 _write_source->set_source_name (_name.val(), destructive());
1369                 /* XXX what to do if this fails ? */
1370         }
1371         return 0;
1372 }
1373
1374 void
1375 MidiDiskstream::set_block_size (nframes_t /*nframes*/)
1376 {
1377 }
1378
1379 void
1380 MidiDiskstream::allocate_temporary_buffers ()
1381 {
1382 }
1383
1384 void
1385 MidiDiskstream::monitor_input (bool yn)
1386 {
1387         if (_source_port)
1388                 _source_port->ensure_monitor_input (yn);
1389 }
1390
1391 void
1392 MidiDiskstream::set_align_style_from_io ()
1393 {
1394         bool have_physical = false;
1395
1396         if (_io == 0) {
1397                 return;
1398         }
1399
1400         get_input_sources ();
1401
1402         if (_source_port && _source_port->flags() & JackPortIsPhysical) {
1403                 have_physical = true;
1404         }
1405
1406         if (have_physical) {
1407                 set_align_style (ExistingMaterial);
1408         } else {
1409                 set_align_style (CaptureTime);
1410         }
1411 }
1412
1413
1414 float
1415 MidiDiskstream::playback_buffer_load () const
1416 {
1417         return (float) ((double) _playback_buf->read_space()/
1418                         (double) _playback_buf->capacity());
1419 }
1420
1421 float
1422 MidiDiskstream::capture_buffer_load () const
1423 {
1424         return (float) ((double) _capture_buf->write_space()/
1425                         (double) _capture_buf->capacity());
1426 }
1427
1428 int
1429 MidiDiskstream::use_pending_capture_data (XMLNode& /*node*/)
1430 {
1431         return 0;
1432 }
1433
1434 /** Writes playback events in the given range to \a dst, translating time stamps
1435  * so that an event at \a start has time = 0
1436  */
1437 void
1438 MidiDiskstream::get_playback (MidiBuffer& dst, nframes_t start, nframes_t end)
1439 {
1440         dst.clear();
1441         assert(dst.size() == 0);
1442
1443         // Reverse.  ... We just don't do reverse, ok?  Back off.
1444         if (end <= start) {
1445                 return;
1446         }
1447
1448         // Translates stamps to be relative to start
1449
1450
1451 #ifndef NDEBUG
1452         const size_t events_read = _playback_buf->read(dst, start, end);
1453         DEBUG_TRACE (DEBUG::MidiDiskstreamIO, string_compose ("%1 MDS events read %2 range %3 .. %4 rspace %5 wspace %6\n", _name, events_read, start, end,
1454                                                               _playback_buf->read_space(), _playback_buf->write_space()));
1455 #else
1456         _playback_buf->read(dst, start, end);
1457 #endif
1458
1459         gint32 frames_read = end - start;
1460         g_atomic_int_add(&_frames_read_from_ringbuffer, frames_read);
1461 }
1462