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