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