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
  39 #include "ardour/ardour.h"
  40 #include "ardour/audioengine.h"
  41 #include "ardour/butler.h"
  42 #include "ardour/configuration.h"
  43 #include "ardour/cycle_timer.h"
  44 #include "ardour/debug.h"
  45 #include "ardour/io.h"
  46 #include "ardour/midi_diskstream.h"
  47 #include "ardour/midi_playlist.h"
  48 #include "ardour/midi_port.h"
  49 #include "ardour/midi_region.h"
  50 #include "ardour/playlist_factory.h"
  51 #include "ardour/region_factory.h"
  52 #include "ardour/send.h"
  53 #include "ardour/session.h"
  54 #include "ardour/smf_source.h"
  55 #include "ardour/utils.h"
  56
  57 #include "midi++/types.h"
  58
  59 #include "i18n.h"
  60 #include <locale.h>
  61
  62 using namespace std;
  63 using namespace ARDOUR;
  64 using namespace PBD;
  65
  66 nframes_t MidiDiskstream::midi_readahead = 4096;
  67
  68 MidiDiskstream::MidiDiskstream (Session &sess, const string &name, Diskstream::Flag flag)
  69         : Diskstream(sess, name, flag)
  70         , _playback_buf(0)
  71         , _capture_buf(0)
  72         , _source_port(0)
  73         , _last_flush_frame(0)
  74         , _note_mode(Sustained)
  75         , _frames_written_to_ringbuffer(0)
  76         , _frames_read_from_ringbuffer(0)
  77 {
  78         /* prevent any write sources from being created */
  79
  80         in_set_state = true;
  81
  82         init(flag);
  83         use_new_playlist ();
  84
  85         in_set_state = false;
  86
  87         assert(!destructive());
  88 }
  89
  90 MidiDiskstream::MidiDiskstream (Session& sess, const XMLNode& node)
  91         : Diskstream(sess, node)
  92         , _playback_buf(0)
  93         , _capture_buf(0)
  94         , _source_port(0)
  95         , _last_flush_frame(0)
  96         , _note_mode(Sustained)
  97         , _frames_written_to_ringbuffer(0)
  98         , _frames_read_from_ringbuffer(0)
  99 {
 100         in_set_state = true;
 101         init (Recordable);
 102
 103         if (set_state (node, Stateful::loading_state_version)) {
 104                 in_set_state = false;
 105                 throw failed_constructor();
 106         }
 107
 108         in_set_state = false;
 109
 110         if (destructive()) {
 111                 use_destructive_playlist ();
 112         }
 113 }
 114
 115 void
 116 MidiDiskstream::init (Diskstream::Flag f)
 117 {
 118         Diskstream::init(f);
 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 Change 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)
 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         /* if we've already processed the frames corresponding to this call,
 497            just return. this allows multiple routes that are taking input
 498            from this diskstream to call our ::process() method, but have
 499            this stuff only happen once. more commonly, it allows both
 500            the AudioTrack that is using this AudioDiskstream *and* the Session
 501            to call process() without problems.
 502            */
 503
 504         if (_processed) {
 505                 return 0;
 506         }
 507
 508         commit_should_unlock = false;
 509
 510         check_record_status (transport_frame, nframes, can_record);
 511
 512         nominally_recording = (can_record && re);
 513
 514         if (nframes == 0) {
 515                 _processed = true;
 516                 return 0;
 517         }
 518
 519         /* This lock is held until the end of ::commit, so these two functions
 520            must always be called as a pair. The only exception is if this function
 521            returns a non-zero value, in which case, ::commit should not be called.
 522            */
 523
 524         // If we can't take the state lock return.
 525         if (!state_lock.trylock()) {
 526                 return 1;
 527         }
 528         commit_should_unlock = true;
 529         adjust_capture_position = 0;
 530
 531         if (nominally_recording || (_session.get_record_enabled() && _session.config.get_punch_in())) {
 532                 OverlapType ot = coverage (first_recordable_frame, last_recordable_frame, transport_frame, transport_frame + nframes);
 533
 534                 calculate_record_range(ot, transport_frame, nframes, rec_nframes, rec_offset);
 535
 536                 if (rec_nframes && !was_recording) {
 537                         capture_captured = 0;
 538                         was_recording = true;
 539                 }
 540         }
 541
 542
 543         if (can_record && !_last_capture_regions.empty()) {
 544                 _last_capture_regions.clear ();
 545         }
 546
 547         if (nominally_recording || rec_nframes) {
 548
 549                 // Pump entire port buffer into the ring buffer (FIXME: split cycles?)
 550                 MidiBuffer& buf = _source_port->get_midi_buffer(nframes);
 551                 for (MidiBuffer::iterator i = buf.begin(); i != buf.end(); ++i) {
 552                         const Evoral::MIDIEvent<MidiBuffer::TimeType> ev(*i, false);
 553                         assert(ev.buffer());
 554                         _capture_buf->write(ev.time() + transport_frame, ev.type(), ev.size(), ev.buffer());
 555                 }
 556
 557         } else {
 558
 559                 if (was_recording) {
 560                         finish_capture (rec_monitors_input);
 561                 }
 562
 563         }
 564
 565         if (rec_nframes) {
 566
 567                 /* data will be written to disk */
 568
 569                 if (rec_nframes == nframes && rec_offset == 0) {
 570                         playback_distance = nframes;
 571                 }
 572
 573                 adjust_capture_position = rec_nframes;
 574
 575         } else if (nominally_recording) {
 576
 577                 /* XXXX do this for MIDI !!!
 578                    can't do actual capture yet - waiting for latency effects to finish before we start
 579                    */
 580
 581                 playback_distance = nframes;
 582
 583         }
 584
 585         ret = 0;
 586
 587         _processed = true;
 588
 589         if (ret) {
 590
 591                 /* we're exiting with failure, so ::commit will not
 592                    be called. unlock the state lock.
 593                    */
 594
 595                 commit_should_unlock = false;
 596                 state_lock.unlock();
 597         }
 598
 599         return ret;
 600 }
 601
 602 bool
 603 MidiDiskstream::commit (nframes_t nframes)
 604 {
 605         bool need_butler = false;
 606
 607         if (_actual_speed < 0.0) {
 608                 playback_sample -= playback_distance;
 609         } else {
 610                 playback_sample += playback_distance;
 611         }
 612
 613         if (adjust_capture_position != 0) {
 614                 capture_captured += adjust_capture_position;
 615                 adjust_capture_position = 0;
 616         }
 617
 618         uint32_t frames_read = g_atomic_int_get(&_frames_read_from_ringbuffer);
 619         uint32_t frames_written = g_atomic_int_get(&_frames_written_to_ringbuffer);
 620         if ((frames_written - frames_read) + nframes < midi_readahead) {
 621                 need_butler = true;
 622         }
 623
 624         /*cerr << "MDS written: " << frames_written << " - read: " << frames_read <<
 625                 " = " << frames_written - frames_read
 626                 << " + " << nframes << " < " << midi_readahead << " = " << need_butler << ")" << endl;*/
 627
 628         if (commit_should_unlock) {
 629                 state_lock.unlock();
 630         }
 631
 632         _processed = false;
 633
 634         return need_butler;
 635 }
 636
 637 void
 638 MidiDiskstream::set_pending_overwrite (bool yn)
 639 {
 640         /* called from audio thread, so we can use the read ptr and playback sample as we wish */
 641
 642         pending_overwrite = yn;
 643
 644         overwrite_frame = playback_sample;
 645 }
 646
 647 int
 648 MidiDiskstream::overwrite_existing_buffers ()
 649 {
 650         //read(overwrite_frame, disk_io_chunk_frames, false);
 651         overwrite_queued = false;
 652         pending_overwrite = false;
 653
 654         return 0;
 655 }
 656
 657 int
 658 MidiDiskstream::seek (nframes_t frame, bool complete_refill)
 659 {
 660         Glib::Mutex::Lock lm (state_lock);
 661         int ret = -1;
 662
 663         _playback_buf->reset();
 664         _capture_buf->reset();
 665         g_atomic_int_set(&_frames_read_from_ringbuffer, 0);
 666         g_atomic_int_set(&_frames_written_to_ringbuffer, 0);
 667
 668         playback_sample = frame;
 669         file_frame = frame;
 670
 671         if (complete_refill) {
 672                 while ((ret = do_refill_with_alloc ()) > 0) ;
 673         } else {
 674                 ret = do_refill_with_alloc ();
 675         }
 676
 677         return ret;
 678 }
 679
 680 int
 681 MidiDiskstream::can_internal_playback_seek (nframes_t distance)
 682 {
 683         uint32_t frames_read    = g_atomic_int_get(&_frames_read_from_ringbuffer);
 684         uint32_t frames_written = g_atomic_int_get(&_frames_written_to_ringbuffer);
 685         return ((frames_written - frames_read) < distance);
 686 }
 687
 688 int
 689 MidiDiskstream::internal_playback_seek (nframes_t distance)
 690 {
 691         first_recordable_frame += distance;
 692         playback_sample += distance;
 693
 694         return 0;
 695 }
 696
 697 /** @a start is set to the new frame position (TIME) read up to */
 698 int
 699 MidiDiskstream::read (nframes_t& start, nframes_t dur, bool reversed)
 700 {
 701         nframes_t this_read = 0;
 702         bool reloop = false;
 703         nframes_t loop_end = 0;
 704         nframes_t loop_start = 0;
 705         nframes_t loop_length = 0;
 706         Location *loc = 0;
 707
 708         if (!reversed) {
 709                 /* Make the use of a Location atomic for this read operation.
 710
 711                    Note: Locations don't get deleted, so all we care about
 712                    when I say "atomic" is that we are always pointing to
 713                    the same one and using a start/length values obtained
 714                    just once.
 715                 */
 716
 717                 if ((loc = loop_location) != 0) {
 718                         loop_start = loc->start();
 719                         loop_end = loc->end();
 720                         loop_length = loop_end - loop_start;
 721                 }
 722
 723                 /* if we are looping, ensure that the first frame we read is at the correct
 724                    position within the loop.
 725                 */
 726
 727                 if (loc && (start >= loop_end)) {
 728                         //cerr << "start adjusted from " << start;
 729                         start = loop_start + ((start - loop_start) % loop_length);
 730                         //cerr << "to " << start << endl;
 731                 }
 732                 //cerr << "start is " << start << "  loopstart: " << loop_start << "  loopend: " << loop_end << endl;
 733         }
 734
 735         while (dur) {
 736
 737                 /* take any loop into account. we can't read past the end of the loop. */
 738
 739                 if (loc && (loop_end - start < dur)) {
 740                         this_read = loop_end - start;
 741                         //cerr << "reloop true: thisread: " << this_read << "  dur: " << dur << endl;
 742                         reloop = true;
 743                 } else {
 744                         reloop = false;
 745                         this_read = dur;
 746                 }
 747
 748                 if (this_read == 0) {
 749                         break;
 750                 }
 751
 752                 this_read = min(dur,this_read);
 753
 754                 if (midi_playlist()->read (*_playback_buf, start, this_read) != this_read) {
 755                         error << string_compose(
 756                                         _("MidiDiskstream %1: cannot read %2 from playlist at frame %3"),
 757                                         _id, this_read, start) << endmsg;
 758                         return -1;
 759                 }
 760
 761                 g_atomic_int_add(&_frames_written_to_ringbuffer, this_read);
 762
 763                 _read_data_count = _playlist->read_data_count();
 764
 765                 if (reversed) {
 766
 767                         // Swap note ons with note offs here.  etc?
 768                         // Fully reversing MIDI requires look-ahead (well, behind) to find previous
 769                         // CC values etc.  hard.
 770
 771                 } else {
 772
 773                         /* if we read to the end of the loop, go back to the beginning */
 774
 775                         if (reloop) {
 776                                 // Synthesize LoopEvent here, because the next events
 777                                 // written will have non-monotonic timestamps.
 778                                 _playback_buf->write(loop_end - 1, LoopEventType, 0, 0);
 779                                 cout << "Pushing LoopEvent ts=" << loop_end-1
 780                                      << " start+this_read " << start+this_read << endl;
 781
 782                                 start = loop_start;
 783                         } else {
 784                                 start += this_read;
 785                         }
 786                 }
 787
 788                 dur -= this_read;
 789                 //offset += this_read;
 790         }
 791
 792         return 0;
 793 }
 794
 795 int
 796 MidiDiskstream::do_refill_with_alloc ()
 797 {
 798         return do_refill();
 799 }
 800
 801 int
 802 MidiDiskstream::do_refill ()
 803 {
 804         int     ret         = 0;
 805         size_t  write_space = _playback_buf->write_space();
 806         bool    reversed    = (_visible_speed * _session.transport_speed()) < 0.0f;
 807
 808         if (write_space == 0) {
 809                 return 0;
 810         }
 811
 812         if (reversed) {
 813                 return 0;
 814         }
 815
 816         /* at end: nothing to do */
 817         if (file_frame == max_frames) {
 818                 return 0;
 819         }
 820
 821         // At this point we...
 822         assert(_playback_buf->write_space() > 0); // ... have something to write to, and
 823         assert(file_frame <= max_frames); // ... something to write
 824
 825         // now calculate how much time is in the ringbuffer.
 826         // and lets write as much as we need to get this to be midi_readahead;
 827         uint32_t frames_read = g_atomic_int_get(&_frames_read_from_ringbuffer);
 828         uint32_t frames_written = g_atomic_int_get(&_frames_written_to_ringbuffer);
 829         if ((frames_written - frames_read) >= midi_readahead) {
 830                 //cout << "MDS Nothing to do. all fine" << endl;
 831                 return 0;
 832         }
 833
 834         nframes_t to_read = midi_readahead - (frames_written - frames_read);
 835
 836         //cout << "MDS read for midi_readahead " << to_read << "  rb_contains: "
 837         //      << frames_written - frames_read << endl;
 838
 839         to_read = min(to_read, (max_frames - file_frame));
 840
 841         if (read (file_frame, to_read, reversed)) {
 842                 ret = -1;
 843         }
 844
 845         return ret;
 846 }
 847
 848 /** Flush pending data to disk.
 849  *
 850  * Important note: this function will write *AT MOST* disk_io_chunk_frames
 851  * of data to disk. it will never write more than that.  If it writes that
 852  * much and there is more than that waiting to be written, it will return 1,
 853  * otherwise 0 on success or -1 on failure.
 854  *
 855  * If there is less than disk_io_chunk_frames to be written, no data will be
 856  * written at all unless @a force_flush is true.
 857  */
 858 int
 859 MidiDiskstream::do_flush (RunContext /*context*/, bool force_flush)
 860 {
 861         uint32_t to_write;
 862         int32_t ret = 0;
 863         nframes_t total;
 864
 865         _write_data_count = 0;
 866
 867         total = _session.transport_frame() - _last_flush_frame;
 868
 869         if (_last_flush_frame > _session.transport_frame()
 870                         || _last_flush_frame < capture_start_frame) {
 871                 _last_flush_frame = _session.transport_frame();
 872         }
 873
 874         if (total == 0 || _capture_buf->read_space() == 0
 875                         || (!force_flush && (total < disk_io_chunk_frames && was_recording))) {
 876                 goto out;
 877         }
 878
 879         /* if there are 2+ chunks of disk i/o possible for
 880            this track, let the caller know so that it can arrange
 881            for us to be called again, ASAP.
 882
 883            if we are forcing a flush, then if there is* any* extra
 884            work, let the caller know.
 885
 886            if we are no longer recording and there is any extra work,
 887            let the caller know too.
 888            */
 889
 890         if (total >= 2 * disk_io_chunk_frames || ((force_flush || !was_recording) && total > disk_io_chunk_frames)) {
 891                 ret = 1;
 892         }
 893
 894         to_write = disk_io_chunk_frames;
 895
 896         assert(!destructive());
 897
 898         if (record_enabled()
 899                         && (   (_session.transport_frame() - _last_flush_frame > disk_io_chunk_frames)
 900                                 || force_flush)) {
 901                 if ((!_write_source) || _write_source->midi_write (*_capture_buf, capture_start_frame, to_write) != to_write) {
 902                         error << string_compose(_("MidiDiskstream %1: cannot write to disk"), _id) << endmsg;
 903                         return -1;
 904                 } else {
 905                         _last_flush_frame = _session.transport_frame();
 906                 }
 907         }
 908
 909 out:
 910         return ret;
 911 }
 912
 913 void
 914 MidiDiskstream::transport_stopped (struct tm& /*when*/, time_t /*twhen*/, bool abort_capture)
 915 {
 916         uint32_t buffer_position;
 917         bool more_work = true;
 918         int err = 0;
 919         boost::shared_ptr<MidiRegion> region;
 920         nframes_t total_capture;
 921         MidiRegion::SourceList srcs;
 922         MidiRegion::SourceList::iterator src;
 923         vector<CaptureInfo*>::iterator ci;
 924         bool mark_write_completed = false;
 925
 926         finish_capture (true);
 927
 928         /* butler is already stopped, but there may be work to do
 929            to flush remaining data to disk.
 930            */
 931
 932         while (more_work && !err) {
 933                 switch (do_flush (TransportContext, true)) {
 934                         case 0:
 935                                 more_work = false;
 936                                 break;
 937                         case 1:
 938                                 break;
 939                         case -1:
 940                                 error << string_compose(_("MidiDiskstream \"%1\": cannot flush captured data to disk!"), _name) << endmsg;
 941                                 err++;
 942                 }
 943         }
 944
 945         /* XXX is there anything we can do if err != 0 ? */
 946         Glib::Mutex::Lock lm (capture_info_lock);
 947
 948         if (capture_info.empty()) {
 949                 return;
 950         }
 951
 952         if (abort_capture) {
 953
 954                 if (_write_source) {
 955
 956                         _write_source->mark_for_remove ();
 957                         _write_source->drop_references ();
 958                         _write_source.reset();
 959                 }
 960
 961                 /* new source set up in "out" below */
 962
 963         } else {
 964
 965                 assert(_write_source);
 966
 967                 for (total_capture = 0, ci = capture_info.begin(); ci != capture_info.end(); ++ci) {
 968                         total_capture += (*ci)->frames;
 969                 }
 970
 971                 /* figure out the name for this take */
 972
 973                 srcs.push_back (_write_source);
 974                 _write_source->set_timeline_position (capture_info.front()->start);
 975                 _write_source->set_captured_for (_name);
 976
 977                 string whole_file_region_name;
 978                 whole_file_region_name = region_name_from_path (_write_source->name(), true);
 979
 980                 /* Register a new region with the Session that
 981                    describes the entire source. Do this first
 982                    so that any sub-regions will obviously be
 983                    children of this one (later!)
 984                    */
 985
 986                 try {
 987                         boost::shared_ptr<Region> rx (RegionFactory::create (srcs, 0,
 988                                         total_capture, whole_file_region_name, 0,
 989                                         Region::Flag (Region::DefaultFlags|Region::Automatic|Region::WholeFile)));
 990
 991                         region = boost::dynamic_pointer_cast<MidiRegion> (rx);
 992                         region->special_set_position (capture_info.front()->start);
 993                 }
 994
 995
 996                 catch (failed_constructor& err) {
 997                         error << string_compose(_("%1: could not create region for complete midi file"), _name) << endmsg;
 998                         /* XXX what now? */
 999                 }
1000
1001                 _last_capture_regions.push_back (region);
1002
1003                 // cerr << _name << ": there are " << capture_info.size() << " capture_info records\n";
1004
1005                 XMLNode &before = _playlist->get_state();
1006                 _playlist->freeze ();
1007
1008                 for (buffer_position = 0, ci = capture_info.begin(); ci != capture_info.end(); ++ci) {
1009
1010                         string region_name;
1011
1012                         _session.region_name (region_name, _write_source->name(), false);
1013
1014                         // cerr << _name << ": based on ci of " << (*ci)->start << " for " << (*ci)->frames << " add a region\n";
1015
1016                         try {
1017                                 boost::shared_ptr<Region> rx (RegionFactory::create (srcs, buffer_position, (*ci)->frames, region_name));
1018                                 region = boost::dynamic_pointer_cast<MidiRegion> (rx);
1019                         }
1020
1021                         catch (failed_constructor& err) {
1022                                 error << _("MidiDiskstream: could not create region for captured midi!") << endmsg;
1023                                 continue; /* XXX is this OK? */
1024                         }
1025
1026                         region->GoingAway.connect (bind (mem_fun (*this, &Diskstream::remove_region_from_last_capture), boost::weak_ptr<Region>(region)));
1027
1028                         _last_capture_regions.push_back (region);
1029
1030                         // cerr << "add new region, buffer position = " << buffer_position << " @ " << (*ci)->start << endl;
1031
1032                         i_am_the_modifier++;
1033                         _playlist->add_region (region, (*ci)->start);
1034                         i_am_the_modifier--;
1035
1036                         buffer_position += (*ci)->frames;
1037                 }
1038
1039                 _playlist->thaw ();
1040                 XMLNode &after = _playlist->get_state();
1041                 _session.add_command (new MementoCommand<Playlist>(*_playlist, &before, &after));
1042
1043         }
1044
1045         mark_write_completed = true;
1046
1047         reset_write_sources (mark_write_completed);
1048
1049         for (ci = capture_info.begin(); ci != capture_info.end(); ++ci) {
1050                 delete *ci;
1051         }
1052
1053         if (_playlist) {
1054                 midi_playlist()->clear_note_trackers ();
1055         }
1056
1057         capture_info.clear ();
1058         capture_start_frame = 0;
1059 }
1060
1061 void
1062 MidiDiskstream::transport_looped (nframes_t transport_frame)
1063 {
1064         if (was_recording) {
1065
1066                 // adjust the capture length knowing that the data will be recorded to disk
1067                 // only necessary after the first loop where we're recording
1068                 if (capture_info.size() == 0) {
1069                         capture_captured += _capture_offset;
1070
1071                         if (_alignment_style == ExistingMaterial) {
1072                                 capture_captured += _session.worst_output_latency();
1073                         } else {
1074                                 capture_captured += _roll_delay;
1075                         }
1076                 }
1077
1078                 finish_capture (true);
1079
1080                 // the next region will start recording via the normal mechanism
1081                 // we'll set the start position to the current transport pos
1082                 // no latency adjustment or capture offset needs to be made, as that already happened the first time
1083                 capture_start_frame = transport_frame;
1084                 first_recordable_frame = transport_frame; // mild lie
1085                 last_recordable_frame = max_frames;
1086                 was_recording = true;
1087         }
1088 }
1089
1090 void
1091 MidiDiskstream::finish_capture (bool /*rec_monitors_input*/)
1092 {
1093         was_recording = false;
1094
1095         if (capture_captured == 0) {
1096                 return;
1097         }
1098
1099         // Why must we destroy?
1100         assert(!destructive());
1101
1102         CaptureInfo* ci = new CaptureInfo;
1103
1104         ci->start  = capture_start_frame;
1105         ci->frames = capture_captured;
1106
1107         /* XXX theoretical race condition here. Need atomic exchange ?
1108            However, the circumstances when this is called right
1109            now (either on record-disable or transport_stopped)
1110            mean that no actual race exists. I think ...
1111            We now have a capture_info_lock, but it is only to be used
1112            to synchronize in the transport_stop and the capture info
1113            accessors, so that invalidation will not occur (both non-realtime).
1114         */
1115
1116         // cerr << "Finish capture, add new CI, " << ci->start << '+' << ci->frames << endl;
1117
1118         capture_info.push_back (ci);
1119         capture_captured = 0;
1120 }
1121
1122 void
1123 MidiDiskstream::set_record_enabled (bool yn)
1124 {
1125         if (!recordable() || !_session.record_enabling_legal()) {
1126                 return;
1127         }
1128
1129         assert(!destructive());
1130
1131         if (yn && _source_port == 0) {
1132
1133                 /* pick up connections not initiated *from* the IO object
1134                    we're associated with.
1135                 */
1136
1137                 get_input_sources ();
1138         }
1139
1140         /* yes, i know that this not proof against race conditions, but its
1141            good enough. i think.
1142         */
1143
1144         if (record_enabled() != yn) {
1145                 if (yn) {
1146                         engage_record_enable ();
1147                 } else {
1148                         disengage_record_enable ();
1149                 }
1150         }
1151 }
1152
1153 void
1154 MidiDiskstream::engage_record_enable ()
1155 {
1156     bool rolling = _session.transport_speed() != 0.0f;
1157
1158         g_atomic_int_set (&_record_enabled, 1);
1159
1160         if (_source_port && Config->get_monitoring_model() == HardwareMonitoring) {
1161                 _source_port->request_monitor_input (!(_session.config.get_auto_input() && rolling));
1162         }
1163
1164         // FIXME: Why is this necessary?  Isn't needed for AudioDiskstream...
1165         if (!_write_source)
1166                 use_new_write_source();
1167
1168         _write_source->mark_streaming_midi_write_started (_note_mode, _session.transport_frame());
1169
1170         RecordEnableChanged (); /* EMIT SIGNAL */
1171 }
1172
1173 void
1174 MidiDiskstream::disengage_record_enable ()
1175 {
1176         g_atomic_int_set (&_record_enabled, 0);
1177         if (_source_port && Config->get_monitoring_model() == HardwareMonitoring) {
1178                 if (_source_port) {
1179                         _source_port->request_monitor_input (false);
1180                 }
1181         }
1182
1183         RecordEnableChanged (); /* EMIT SIGNAL */
1184 }
1185
1186 XMLNode&
1187 MidiDiskstream::get_state ()
1188 {
1189         XMLNode* node = new XMLNode ("MidiDiskstream");
1190         char buf[64];
1191         LocaleGuard lg (X_("POSIX"));
1192
1193         snprintf (buf, sizeof(buf), "0x%x", _flags);
1194         node->add_property ("flags", buf);
1195
1196         node->add_property("channel-mode", enum_2_string(get_channel_mode()));
1197
1198         snprintf (buf, sizeof(buf), "0x%x", get_channel_mask());
1199         node->add_property("channel-mask", buf);
1200
1201         node->add_property ("playlist", _playlist->name());
1202
1203         snprintf (buf, sizeof(buf), "%f", _visible_speed);
1204         node->add_property ("speed", buf);
1205
1206         node->add_property("name", _name);
1207         id().print(buf, sizeof(buf));
1208         node->add_property("id", buf);
1209
1210         if (_write_source && _session.get_record_enabled()) {
1211
1212                 XMLNode* cs_child = new XMLNode (X_("CapturingSources"));
1213                 XMLNode* cs_grandchild;
1214
1215                 cs_grandchild = new XMLNode (X_("file"));
1216                 cs_grandchild->add_property (X_("path"), _write_source->path());
1217                 cs_child->add_child_nocopy (*cs_grandchild);
1218
1219                 /* store the location where capture will start */
1220
1221                 Location* pi;
1222
1223                 if (_session.config.get_punch_in() && ((pi = _session.locations()->auto_punch_location()) != 0)) {
1224                         snprintf (buf, sizeof (buf), "%" PRId64, pi->start());
1225                 } else {
1226                         snprintf (buf, sizeof (buf), "%" PRId64, _session.transport_frame());
1227                 }
1228
1229                 cs_child->add_property (X_("at"), buf);
1230                 node->add_child_nocopy (*cs_child);
1231         }
1232
1233         if (_extra_xml) {
1234                 node->add_child_copy (*_extra_xml);
1235         }
1236
1237         return* node;
1238 }
1239
1240 int
1241 MidiDiskstream::set_state (const XMLNode& node, int /*version*/)
1242 {
1243         const XMLProperty* prop;
1244         XMLNodeList nlist = node.children();
1245         XMLNodeIterator niter;
1246         uint32_t nchans = 1;
1247         XMLNode* capture_pending_node = 0;
1248         LocaleGuard lg (X_("POSIX"));
1249
1250         in_set_state = true;
1251
1252         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
1253                 /*if ((*niter)->name() == IO::state_node_name) {
1254                         deprecated_io_node = new XMLNode (**niter);
1255                 }*/
1256                 assert ((*niter)->name() != IO::state_node_name);
1257
1258                 if ((*niter)->name() == X_("CapturingSources")) {
1259                         capture_pending_node = *niter;
1260                 }
1261         }
1262
1263         /* prevent write sources from being created */
1264
1265         in_set_state = true;
1266
1267         if ((prop = node.property ("name")) != 0) {
1268                 _name = prop->value();
1269         }
1270
1271         if ((prop = node.property ("id")) != 0) {
1272                 _id = prop->value ();
1273         }
1274
1275         if ((prop = node.property ("flags")) != 0) {
1276                 _flags = Flag (string_2_enum (prop->value(), _flags));
1277         }
1278
1279         ChannelMode channel_mode = AllChannels;
1280         if ((prop = node.property ("channel-mode")) != 0) {
1281                 channel_mode = ChannelMode (string_2_enum(prop->value(), channel_mode));
1282         }
1283
1284         unsigned int channel_mask = 0xFFFF;
1285         if ((prop = node.property ("channel-mask")) != 0) {
1286                 sscanf (prop->value().c_str(), "0x%x", &channel_mask);
1287                 if (channel_mask & (~0xFFFF)) {
1288                         warning << _("MidiDiskstream: XML property channel-mask out of range") << endmsg;
1289                 }
1290         }
1291
1292         set_channel_mode(channel_mode, channel_mask);
1293
1294         if ((prop = node.property ("channels")) != 0) {
1295                 nchans = atoi (prop->value().c_str());
1296         }
1297
1298         if ((prop = node.property ("playlist")) == 0) {
1299                 return -1;
1300         }
1301
1302         {
1303                 bool had_playlist = (_playlist != 0);
1304
1305                 if (find_and_use_playlist (prop->value())) {
1306                         return -1;
1307                 }
1308
1309                 if (!had_playlist) {
1310                         _playlist->set_orig_diskstream_id (_id);
1311                 }
1312
1313                 if (capture_pending_node) {
1314                         use_pending_capture_data (*capture_pending_node);
1315                 }
1316
1317         }
1318
1319         if ((prop = node.property ("speed")) != 0) {
1320                 double sp = atof (prop->value().c_str());
1321
1322                 if (realtime_set_speed (sp, false)) {
1323                         non_realtime_set_speed ();
1324                 }
1325         }
1326
1327         in_set_state = false;
1328
1329         /* make sure this is clear before we do anything else */
1330
1331         // FIXME?
1332         //_capturing_source = 0;
1333
1334         /* write sources are handled when we handle the input set
1335            up of the IO that owns this DS (::non_realtime_input_change())
1336         */
1337
1338         in_set_state = false;
1339
1340         return 0;
1341 }
1342
1343 int
1344 MidiDiskstream::use_new_write_source (uint32_t n)
1345 {
1346         if (!recordable()) {
1347                 return 1;
1348         }
1349
1350         assert(n == 0);
1351
1352         if (_write_source) {
1353
1354                 if (_write_source->is_empty ()) {
1355                         _write_source->mark_for_remove ();
1356                         _write_source.reset();
1357                 } else {
1358                         _write_source.reset();
1359                 }
1360         }
1361
1362         try {
1363                 _write_source = boost::dynamic_pointer_cast<SMFSource>(_session.create_midi_source_for_session (*this));
1364                 if (!_write_source) {
1365                         throw failed_constructor();
1366                 }
1367         }
1368
1369         catch (failed_constructor &err) {
1370                 error << string_compose (_("%1:%2 new capture file not initialized correctly"), _name, n) << endmsg;
1371                 _write_source.reset();
1372                 return -1;
1373         }
1374
1375         _write_source->set_allow_remove_if_empty (true);
1376         _write_source->mark_streaming_midi_write_started (_note_mode, _session.transport_frame());
1377
1378         return 0;
1379 }
1380
1381 void
1382 MidiDiskstream::reset_write_sources (bool mark_write_complete, bool /*force*/)
1383 {
1384         if (!_session.writable() || !recordable()) {
1385                 return;
1386         }
1387
1388         if (_write_source && mark_write_complete) {
1389                 _write_source->mark_streaming_write_completed ();
1390         }
1391
1392         use_new_write_source (0);
1393 }
1394
1395 int
1396 MidiDiskstream::rename_write_sources ()
1397 {
1398         if (_write_source != 0) {
1399                 _write_source->set_source_name (_name, destructive());
1400                 /* XXX what to do if this fails ? */
1401         }
1402         return 0;
1403 }
1404
1405 void
1406 MidiDiskstream::set_block_size (nframes_t /*nframes*/)
1407 {
1408 }
1409
1410 void
1411 MidiDiskstream::allocate_temporary_buffers ()
1412 {
1413 }
1414
1415 void
1416 MidiDiskstream::monitor_input (bool yn)
1417 {
1418         if (_source_port)
1419                 _source_port->ensure_monitor_input (yn);
1420 }
1421
1422 void
1423 MidiDiskstream::set_align_style_from_io ()
1424 {
1425         bool have_physical = false;
1426
1427         if (_io == 0) {
1428                 return;
1429         }
1430
1431         get_input_sources ();
1432
1433         if (_source_port && _source_port->flags() & JackPortIsPhysical) {
1434                 have_physical = true;
1435         }
1436
1437         if (have_physical) {
1438                 set_align_style (ExistingMaterial);
1439         } else {
1440                 set_align_style (CaptureTime);
1441         }
1442 }
1443
1444
1445 float
1446 MidiDiskstream::playback_buffer_load () const
1447 {
1448         return (float) ((double) _playback_buf->read_space()/
1449                         (double) _playback_buf->capacity());
1450 }
1451
1452 float
1453 MidiDiskstream::capture_buffer_load () const
1454 {
1455         return (float) ((double) _capture_buf->write_space()/
1456                         (double) _capture_buf->capacity());
1457 }
1458
1459 int
1460 MidiDiskstream::use_pending_capture_data (XMLNode& /*node*/)
1461 {
1462         return 0;
1463 }
1464
1465 /** Writes playback events in the given range to \a dst, translating time stamps
1466  * so that an event at \a start has time = 0
1467  */
1468 void
1469 MidiDiskstream::get_playback (MidiBuffer& dst, nframes_t start, nframes_t end)
1470 {
1471         dst.clear();
1472         assert(dst.size() == 0);
1473
1474         // Reverse.  ... We just don't do reverse, ok?  Back off.
1475         if (end <= start) {
1476                 return;
1477         }
1478
1479         // Translates stamps to be relative to start
1480
1481
1482 #ifndef NDEBUG
1483         const size_t events_read = _playback_buf->read(dst, start, end);
1484         DEBUG_TRACE (DEBUG::MidiDiskstreamIO, string_compose ("%1 MDS events read %2 range %3 .. %4 rspace %5 wspace %6\n", _name, events_read, start, end,
1485                                                               _playback_buf->read_space(), _playback_buf->write_space()));
1486 #else
1487         _playback_buf->read(dst, start, end);
1488 #endif
1489
1490         gint32 frames_read = end - start;
1491         g_atomic_int_add(&_frames_read_from_ringbuffer, frames_read);
1492 }
1493