libs/ardour/midi_diskstream.cc

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