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