2 Copyright (C) 2000-2003 Paul Davis
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.
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.
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.
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 #include "pbd/stacktrace.h"
41 #include "ardour/ardour.h"
42 #include "ardour/audioengine.h"
43 #include "ardour/butler.h"
44 #include "ardour/configuration.h"
45 #include "ardour/cycle_timer.h"
46 #include "ardour/debug.h"
47 #include "ardour/io.h"
48 #include "ardour/midi_diskstream.h"
49 #include "ardour/midi_model.h"
50 #include "ardour/midi_playlist.h"
51 #include "ardour/midi_port.h"
52 #include "ardour/midi_region.h"
53 #include "ardour/playlist_factory.h"
54 #include "ardour/region_factory.h"
55 #include "ardour/route.h"
56 #include "ardour/send.h"
57 #include "ardour/session.h"
58 #include "ardour/session_playlists.h"
59 #include "ardour/smf_source.h"
60 #include "ardour/utils.h"
62 #include "midi++/types.h"
68 using namespace ARDOUR;
71 framecnt_t MidiDiskstream::midi_readahead = 4096;
73 MidiDiskstream::MidiDiskstream (Session &sess, const string &name, Diskstream::Flag flag)
74 : Diskstream(sess, name, flag)
77 , _note_mode(Sustained)
78 , _frames_written_to_ringbuffer(0)
79 , _frames_read_from_ringbuffer(0)
80 , _gui_feed_buffer(AudioEngine::instance()->raw_buffer_size (DataType::MIDI))
86 use_new_write_source (0);
90 assert(!destructive());
93 MidiDiskstream::MidiDiskstream (Session& sess, const XMLNode& node)
94 : Diskstream(sess, node)
97 , _note_mode(Sustained)
98 , _frames_written_to_ringbuffer(0)
99 , _frames_read_from_ringbuffer(0)
100 , _gui_feed_buffer(AudioEngine::instance()->raw_buffer_size (DataType::MIDI))
106 if (set_state (node, Stateful::loading_state_version)) {
107 in_set_state = false;
108 throw failed_constructor();
111 use_new_write_source (0);
113 in_set_state = false;
117 MidiDiskstream::init ()
119 /* there are no channels at this point, so these
120 two calls just get speed_buffer_size and wrap_buffer
121 size setup without duplicating their code.
124 set_block_size (_session.get_block_size());
125 allocate_temporary_buffers ();
127 const size_t size = _session.butler()->midi_diskstream_buffer_size();
128 _playback_buf = new MidiRingBuffer<framepos_t>(size);
129 _capture_buf = new MidiRingBuffer<framepos_t>(size);
131 _n_channels = ChanCount(DataType::MIDI, 1);
133 assert(recordable());
136 MidiDiskstream::~MidiDiskstream ()
138 Glib::Mutex::Lock lm (state_lock);
143 MidiDiskstream::non_realtime_locate (framepos_t position)
146 _write_source->set_timeline_position (position);
148 seek (position, false);
153 MidiDiskstream::non_realtime_input_change ()
156 Glib::Mutex::Lock lm (state_lock);
158 if (input_change_pending.type == IOChange::NoChange) {
162 if (input_change_pending.type & IOChange::ConfigurationChanged) {
163 uint32_t ni = _io->n_ports().n_midi();
165 if (ni != _n_channels.n_midi()) {
166 error << string_compose (_("%1: I/O configuration change %4 requested to use %2, but channel setup is %3"),
169 _n_channels, input_change_pending.type)
174 _source_port.reset ();
176 _source_port = _io->midi(0);
180 if (input_change_pending.type & IOChange::ConnectionsChanged) {
181 set_capture_offset ();
182 set_align_style_from_io ();
185 input_change_pending.type = IOChange::NoChange;
187 /* implicit unlock */
190 /* unlike with audio, there is never any need to reset write sources
191 based on input configuration changes because ... a MIDI track
192 has just 1 MIDI port as input, always.
195 /* now refill channel buffers */
197 if (speed() != 1.0f || speed() != -1.0f) {
198 seek ((framepos_t) (_session.transport_frame() * (double) speed()));
201 seek (_session.transport_frame());
205 _write_source->set_last_write_end (_session.transport_frame());
210 MidiDiskstream::find_and_use_playlist (const string& name)
212 boost::shared_ptr<MidiPlaylist> playlist;
214 if ((playlist = boost::dynamic_pointer_cast<MidiPlaylist> (_session.playlists->by_name (name))) == 0) {
215 playlist = boost::dynamic_pointer_cast<MidiPlaylist> (PlaylistFactory::create (DataType::MIDI, _session, name));
219 error << string_compose(_("MidiDiskstream: Playlist \"%1\" isn't an midi playlist"), name) << endmsg;
223 return use_playlist (playlist);
227 MidiDiskstream::use_playlist (boost::shared_ptr<Playlist> playlist)
229 assert(boost::dynamic_pointer_cast<MidiPlaylist>(playlist));
231 Diskstream::use_playlist(playlist);
237 MidiDiskstream::use_new_playlist ()
240 boost::shared_ptr<MidiPlaylist> playlist;
242 if (!in_set_state && destructive()) {
247 newname = Playlist::bump_name (_playlist->name(), _session);
249 newname = Playlist::bump_name (_name, _session);
252 if ((playlist = boost::dynamic_pointer_cast<MidiPlaylist> (PlaylistFactory::create (
253 DataType::MIDI, _session, newname, hidden()))) != 0) {
255 return use_playlist (playlist);
263 MidiDiskstream::use_copy_playlist ()
265 assert(midi_playlist());
271 if (_playlist == 0) {
272 error << string_compose(_("MidiDiskstream %1: there is no existing playlist to make a copy of!"), _name) << endmsg;
277 boost::shared_ptr<MidiPlaylist> playlist;
279 newname = Playlist::bump_name (_playlist->name(), _session);
281 if ((playlist = boost::dynamic_pointer_cast<MidiPlaylist>(PlaylistFactory::create (midi_playlist(), newname))) != 0) {
282 return use_playlist (playlist);
288 /** Overloaded from parent to die horribly
291 MidiDiskstream::set_destructive (bool yn)
293 yn = 0; // stop pedantic gcc complaints about unused parameter
294 assert( ! destructive());
300 MidiDiskstream::set_note_mode (NoteMode m)
303 midi_playlist()->set_note_mode(m);
304 if (_write_source && _write_source->model())
305 _write_source->model()->set_note_mode(m);
310 trace_midi (ostream& o, MIDI::byte *msg, size_t len)
312 using namespace MIDI;
314 const char trace_prefix = ':';
316 type = (eventType) (msg[0]&0xF0);
323 << " NoteOff NoteNum "
334 << " NoteOn NoteNum "
350 case MIDI::controller:
365 << " Program Change ProgNum "
374 << " Channel Pressure "
379 case MIDI::pitchbend:
384 << ((msg[2]<<7)|msg[1])
423 << "System Exclusive (1 byte : " << hex << (int) *msg << dec << ')'
429 << "System Exclusive (" << len << ") = [ " << hex;
430 for (unsigned int i = 0; i < len; ++i) {
431 o << (int) msg[i] << ' ';
433 o << dec << ']' << endl;
439 o << trace_prefix << "Song" << endl;
443 o << trace_prefix << "Tune" << endl;
447 o << trace_prefix << "End-of-System Exclusive" << endl;
451 o << trace_prefix << "Timing" << endl;
455 o << trace_prefix << "Start" << endl;
459 o << trace_prefix << "Stop" << endl;
463 o << trace_prefix << "Continue" << endl;
467 o << trace_prefix << "Active Sense" << endl;
471 o << trace_prefix << "Unrecognized MIDI message" << endl;
478 MidiDiskstream::process (framepos_t transport_frame, pframes_t nframes, framecnt_t& playback_distance)
480 framecnt_t rec_offset = 0;
481 framecnt_t rec_nframes = 0;
482 bool nominally_recording;
483 bool re = record_enabled ();
484 bool can_record = _session.actively_recording ();
486 playback_distance = 0;
488 check_record_status (transport_frame, can_record);
490 nominally_recording = (can_record && re);
496 boost::shared_ptr<MidiPort> sp = _source_port.lock ();
502 Glib::Mutex::Lock sm (state_lock, Glib::TRY_LOCK);
508 adjust_capture_position = 0;
510 if (nominally_recording || (re && was_recording && _session.get_record_enabled() && _session.config.get_punch_in())) {
511 OverlapType ot = coverage (first_recordable_frame, last_recordable_frame, transport_frame, transport_frame + nframes);
513 calculate_record_range(ot, transport_frame, nframes, rec_nframes, rec_offset);
515 if (rec_nframes && !was_recording) {
516 _write_source->mark_write_starting_now ();
517 capture_captured = 0;
518 was_recording = true;
522 if (can_record && !_last_capture_sources.empty()) {
523 _last_capture_sources.clear ();
526 if (nominally_recording || rec_nframes) {
528 // Pump entire port buffer into the ring buffer (FIXME: split cycles?)
529 MidiBuffer& buf = sp->get_midi_buffer(nframes);
530 for (MidiBuffer::iterator i = buf.begin(); i != buf.end(); ++i) {
531 const Evoral::MIDIEvent<MidiBuffer::TimeType> ev(*i, false);
534 if (DEBUG::MidiIO & PBD::debug_bits) {
535 const uint8_t* __data = ev.buffer();
537 DEBUG_STR_APPEND(a, string_compose ("mididiskstream %1 capture event @ %2 + %3 sz %4 ", this, ev.time(), transport_frame, ev.size()));
538 for (size_t i=0; i < ev.size(); ++i) {
539 DEBUG_STR_APPEND(a,hex);
540 DEBUG_STR_APPEND(a,"0x");
541 DEBUG_STR_APPEND(a,(int)__data[i]);
542 DEBUG_STR_APPEND(a,' ');
544 DEBUG_STR_APPEND(a,'\n');
545 DEBUG_TRACE (DEBUG::MidiIO, DEBUG_STR(a).str());
548 _capture_buf->write(ev.time() + transport_frame, ev.type(), ev.size(), ev.buffer());
551 if (buf.size() != 0) {
552 Glib::Mutex::Lock lm (_gui_feed_buffer_mutex, Glib::TRY_LOCK);
555 /* Copy this data into our GUI feed buffer and tell the GUI
556 that it can read it if it likes.
558 _gui_feed_buffer.clear ();
560 for (MidiBuffer::iterator i = buf.begin(); i != buf.end(); ++i) {
561 /* This may fail if buf is larger than _gui_feed_buffer, but it's not really
562 the end of the world if it does.
564 _gui_feed_buffer.push_back ((*i).time() + transport_frame, (*i).size(), (*i).buffer());
568 DataRecorded (_write_source); /* EMIT SIGNAL */
581 /* data will be written to disk */
583 if (rec_nframes == nframes && rec_offset == 0) {
584 playback_distance = nframes;
587 adjust_capture_position = rec_nframes;
589 } else if (nominally_recording) {
591 /* XXXX do this for MIDI !!!
592 can't do actual capture yet - waiting for latency effects to finish before we start
595 playback_distance = nframes;
599 /* XXX: should be doing varispeed stuff here, similar to the code in AudioDiskstream::process */
601 playback_distance = nframes;
609 MidiDiskstream::commit (framecnt_t playback_distance)
611 bool need_butler = false;
613 if (_actual_speed < 0.0) {
614 playback_sample -= playback_distance;
616 playback_sample += playback_distance;
619 if (adjust_capture_position != 0) {
620 capture_captured += adjust_capture_position;
621 adjust_capture_position = 0;
624 uint32_t frames_read = g_atomic_int_get(&_frames_read_from_ringbuffer);
625 uint32_t frames_written = g_atomic_int_get(&_frames_written_to_ringbuffer);
626 if ((frames_written - frames_read) + playback_distance < midi_readahead) {
630 /*cerr << "MDS written: " << frames_written << " - read: " << frames_read <<
631 " = " << frames_written - frames_read
632 << " + " << nframes << " < " << midi_readahead << " = " << need_butler << ")" << endl;*/
638 MidiDiskstream::set_pending_overwrite (bool yn)
640 /* called from audio thread, so we can use the read ptr and playback sample as we wish */
642 _pending_overwrite = yn;
643 overwrite_frame = playback_sample;
647 MidiDiskstream::overwrite_existing_buffers ()
649 /* This is safe as long as the butler thread is suspended, which it should be */
650 _playback_buf->reset ();
652 g_atomic_int_set (&_frames_read_from_ringbuffer, 0);
653 g_atomic_int_set (&_frames_written_to_ringbuffer, 0);
655 read (overwrite_frame, disk_io_chunk_frames, false);
656 file_frame = overwrite_frame; // it was adjusted by ::read()
657 overwrite_queued = false;
658 _pending_overwrite = false;
664 MidiDiskstream::seek (framepos_t frame, bool complete_refill)
666 Glib::Mutex::Lock lm (state_lock);
669 _playback_buf->reset();
670 _capture_buf->reset();
671 g_atomic_int_set(&_frames_read_from_ringbuffer, 0);
672 g_atomic_int_set(&_frames_written_to_ringbuffer, 0);
674 playback_sample = frame;
677 if (complete_refill) {
678 while ((ret = do_refill_with_alloc ()) > 0) ;
680 ret = do_refill_with_alloc ();
687 MidiDiskstream::can_internal_playback_seek (framecnt_t distance)
689 uint32_t frames_read = g_atomic_int_get(&_frames_read_from_ringbuffer);
690 uint32_t frames_written = g_atomic_int_get(&_frames_written_to_ringbuffer);
691 return ((frames_written - frames_read) < distance);
695 MidiDiskstream::internal_playback_seek (framecnt_t distance)
697 first_recordable_frame += distance;
698 playback_sample += distance;
703 /** @a start is set to the new frame position (TIME) read up to */
705 MidiDiskstream::read (framepos_t& start, framecnt_t dur, bool reversed)
707 framecnt_t this_read = 0;
709 framepos_t loop_end = 0;
710 framepos_t loop_start = 0;
715 framecnt_t loop_length = 0;
717 /* Make the use of a Location atomic for this read operation.
719 Note: Locations don't get deleted, so all we care about
720 when I say "atomic" is that we are always pointing to
721 the same one and using a start/length values obtained
725 if ((loc = loop_location) != 0) {
726 loop_start = loc->start();
727 loop_end = loc->end();
728 loop_length = loop_end - loop_start;
731 /* if we are looping, ensure that the first frame we read is at the correct
732 position within the loop.
735 if (loc && (start >= loop_end)) {
736 //cerr << "start adjusted from " << start;
737 start = loop_start + ((start - loop_start) % loop_length);
738 //cerr << "to " << start << endl;
740 //cerr << "start is " << start << " loopstart: " << loop_start << " loopend: " << loop_end << endl;
745 /* take any loop into account. we can't read past the end of the loop. */
747 if (loc && (loop_end - start < dur)) {
748 this_read = loop_end - start;
749 //cerr << "reloop true: thisread: " << this_read << " dur: " << dur << endl;
756 if (this_read == 0) {
760 this_read = min(dur,this_read);
762 if (midi_playlist()->read (*_playback_buf, start, this_read) != this_read) {
763 error << string_compose(
764 _("MidiDiskstream %1: cannot read %2 from playlist at frame %3"),
765 id(), this_read, start) << endmsg;
769 g_atomic_int_add(&_frames_written_to_ringbuffer, this_read);
773 // Swap note ons with note offs here. etc?
774 // Fully reversing MIDI requires look-ahead (well, behind) to find previous
775 // CC values etc. hard.
779 /* if we read to the end of the loop, go back to the beginning */
782 // Synthesize LoopEvent here, because the next events
783 // written will have non-monotonic timestamps.
784 _playback_buf->write(loop_end - 1, LoopEventType, sizeof (framepos_t), (uint8_t *) &loop_start);
792 //offset += this_read;
799 MidiDiskstream::do_refill_with_alloc ()
805 MidiDiskstream::do_refill ()
808 size_t write_space = _playback_buf->write_space();
809 bool reversed = (_visible_speed * _session.transport_speed()) < 0.0f;
811 if (write_space == 0) {
819 /* at end: nothing to do */
820 if (file_frame == max_framepos) {
824 // At this point we...
825 assert(_playback_buf->write_space() > 0); // ... have something to write to, and
826 assert(file_frame <= max_framepos); // ... something to write
828 // now calculate how much time is in the ringbuffer.
829 // and lets write as much as we need to get this to be midi_readahead;
830 uint32_t frames_read = g_atomic_int_get(&_frames_read_from_ringbuffer);
831 uint32_t frames_written = g_atomic_int_get(&_frames_written_to_ringbuffer);
832 if ((frames_written - frames_read) >= midi_readahead) {
836 framecnt_t to_read = midi_readahead - (frames_written - frames_read);
838 //cout << "MDS read for midi_readahead " << to_read << " rb_contains: "
839 // << frames_written - frames_read << endl;
841 to_read = (framecnt_t) min ((framecnt_t) to_read, (framecnt_t) (max_framepos - file_frame));
843 if (read (file_frame, to_read, reversed)) {
850 /** Flush pending data to disk.
852 * Important note: this function will write *AT MOST* disk_io_chunk_frames
853 * of data to disk. it will never write more than that. If it writes that
854 * much and there is more than that waiting to be written, it will return 1,
855 * otherwise 0 on success or -1 on failure.
857 * If there is less than disk_io_chunk_frames to be written, no data will be
858 * written at all unless @a force_flush is true.
861 MidiDiskstream::do_flush (RunContext /*context*/, bool force_flush)
867 if (!_write_source) {
871 assert (!destructive());
873 total = _session.transport_frame() - _write_source->last_write_end();
876 _capture_buf->read_space() == 0 ||
877 (!force_flush && (total < disk_io_chunk_frames) && was_recording)) {
881 /* if there are 2+ chunks of disk i/o possible for
882 this track, let the caller know so that it can arrange
883 for us to be called again, ASAP.
885 if we are forcing a flush, then if there is* any* extra
886 work, let the caller know.
888 if we are no longer recording and there is any extra work,
889 let the caller know too.
892 if (total >= 2 * disk_io_chunk_frames || ((force_flush || !was_recording) && total > disk_io_chunk_frames)) {
897 /* push out everything we have, right now */
898 to_write = max_framecnt;
900 to_write = disk_io_chunk_frames;
903 if (record_enabled() && ((total > disk_io_chunk_frames) || force_flush)) {
904 if (_write_source->midi_write (*_capture_buf, get_capture_start_frame (0), to_write) != to_write) {
905 error << string_compose(_("MidiDiskstream %1: cannot write to disk"), id()) << endmsg;
915 MidiDiskstream::transport_stopped_wallclock (struct tm& /*when*/, time_t /*twhen*/, bool abort_capture)
917 bool more_work = true;
919 boost::shared_ptr<MidiRegion> region;
920 MidiRegion::SourceList srcs;
921 MidiRegion::SourceList::iterator src;
922 vector<CaptureInfo*>::iterator ci;
926 /* butler is already stopped, but there may be work to do
927 to flush remaining data to disk.
930 while (more_work && !err) {
931 switch (do_flush (TransportContext, true)) {
938 error << string_compose(_("MidiDiskstream \"%1\": cannot flush captured data to disk!"), _name) << endmsg;
943 /* XXX is there anything we can do if err != 0 ? */
944 Glib::Mutex::Lock lm (capture_info_lock);
946 if (capture_info.empty()) {
947 goto no_capture_stuff_to_do;
953 _write_source->mark_for_remove ();
954 _write_source->drop_references ();
955 _write_source.reset();
958 /* new source set up in "out" below */
962 assert(_write_source);
964 framecnt_t total_capture = 0;
965 for (ci = capture_info.begin(); ci != capture_info.end(); ++ci) {
966 total_capture += (*ci)->frames;
969 if (_write_source->length (capture_info.front()->start) != 0) {
971 /* phew, we have data */
973 /* figure out the name for this take */
975 srcs.push_back (_write_source);
977 _write_source->set_timeline_position (capture_info.front()->start);
978 _write_source->set_captured_for (_name);
980 /* set length in beats to entire capture length */
982 BeatsFramesConverter converter (_session.tempo_map(), capture_info.front()->start);
983 const double total_capture_beats = converter.from (total_capture);
984 _write_source->set_length_beats (total_capture_beats);
986 /* flush to disk: this step differs from the audio path,
987 where all the data is already on disk.
990 _write_source->mark_midi_streaming_write_completed (Evoral::Sequence<Evoral::MusicalTime>::ResolveStuckNotes, total_capture_beats);
992 /* we will want to be able to keep (over)writing the source
993 but we don't want it to be removable. this also differs
994 from the audio situation, where the source at this point
995 must be considered immutable. luckily, we can rely on
996 MidiSource::mark_streaming_write_completed() to have
997 already done the necessary work for that.
1000 string whole_file_region_name;
1001 whole_file_region_name = region_name_from_path (_write_source->name(), true);
1003 /* Register a new region with the Session that
1004 describes the entire source. Do this first
1005 so that any sub-regions will obviously be
1006 children of this one (later!)
1012 plist.add (Properties::name, whole_file_region_name);
1013 plist.add (Properties::whole_file, true);
1014 plist.add (Properties::automatic, true);
1015 plist.add (Properties::start, 0);
1016 plist.add (Properties::length, total_capture);
1017 plist.add (Properties::layer, 0);
1019 boost::shared_ptr<Region> rx (RegionFactory::create (srcs, plist));
1021 region = boost::dynamic_pointer_cast<MidiRegion> (rx);
1022 region->special_set_position (capture_info.front()->start);
1026 catch (failed_constructor& err) {
1027 error << string_compose(_("%1: could not create region for complete midi file"), _name) << endmsg;
1031 _last_capture_sources.insert (_last_capture_sources.end(), srcs.begin(), srcs.end());
1033 _playlist->clear_changes ();
1034 _playlist->freeze ();
1036 /* Session frame time of the initial capture in this pass, which is where the source starts */
1037 framepos_t initial_capture = 0;
1038 if (!capture_info.empty()) {
1039 initial_capture = capture_info.front()->start;
1042 for (ci = capture_info.begin(); ci != capture_info.end(); ++ci) {
1046 RegionFactory::region_name (region_name, _write_source->name(), false);
1048 // cerr << _name << ": based on ci of " << (*ci)->start << " for " << (*ci)->frames << " add a region\n";
1053 /* start of this region is the offset between the start of its capture and the start of the whole pass */
1054 plist.add (Properties::start, (*ci)->start - initial_capture);
1055 plist.add (Properties::length, (*ci)->frames);
1056 plist.add (Properties::length_beats, converter.from((*ci)->frames));
1057 plist.add (Properties::name, region_name);
1059 boost::shared_ptr<Region> rx (RegionFactory::create (srcs, plist));
1060 region = boost::dynamic_pointer_cast<MidiRegion> (rx);
1063 catch (failed_constructor& err) {
1064 error << _("MidiDiskstream: could not create region for captured midi!") << endmsg;
1065 continue; /* XXX is this OK? */
1068 // cerr << "add new region, buffer position = " << buffer_position << " @ " << (*ci)->start << endl;
1070 i_am_the_modifier++;
1071 _playlist->add_region (region, (*ci)->start);
1072 i_am_the_modifier--;
1076 _session.add_command (new StatefulDiffCommand(_playlist));
1080 /* No data was recorded, so this capture will
1081 effectively be aborted; do the same as we
1082 do for an explicit abort.
1085 if (_write_source) {
1086 _write_source->mark_for_remove ();
1087 _write_source->drop_references ();
1088 _write_source.reset();
1094 use_new_write_source (0);
1096 for (ci = capture_info.begin(); ci != capture_info.end(); ++ci) {
1100 capture_info.clear ();
1101 capture_start_frame = 0;
1103 no_capture_stuff_to_do:
1106 midi_playlist()->clear_note_trackers ();
1111 MidiDiskstream::transport_looped (framepos_t transport_frame)
1113 if (was_recording) {
1115 // adjust the capture length knowing that the data will be recorded to disk
1116 // only necessary after the first loop where we're recording
1117 if (capture_info.size() == 0) {
1118 capture_captured += _capture_offset;
1120 if (_alignment_style == ExistingMaterial) {
1121 capture_captured += _session.worst_output_latency();
1123 capture_captured += _roll_delay;
1129 // the next region will start recording via the normal mechanism
1130 // we'll set the start position to the current transport pos
1131 // no latency adjustment or capture offset needs to be made, as that already happened the first time
1132 capture_start_frame = transport_frame;
1133 first_recordable_frame = transport_frame; // mild lie
1134 last_recordable_frame = max_framepos;
1135 was_recording = true;
1140 MidiDiskstream::finish_capture ()
1142 was_recording = false;
1144 if (capture_captured == 0) {
1148 // Why must we destroy?
1149 assert(!destructive());
1151 CaptureInfo* ci = new CaptureInfo;
1153 ci->start = capture_start_frame;
1154 ci->frames = capture_captured;
1156 /* XXX theoretical race condition here. Need atomic exchange ?
1157 However, the circumstances when this is called right
1158 now (either on record-disable or transport_stopped)
1159 mean that no actual race exists. I think ...
1160 We now have a capture_info_lock, but it is only to be used
1161 to synchronize in the transport_stop and the capture info
1162 accessors, so that invalidation will not occur (both non-realtime).
1165 // cerr << "Finish capture, add new CI, " << ci->start << '+' << ci->frames << endl;
1167 capture_info.push_back (ci);
1168 capture_captured = 0;
1172 MidiDiskstream::set_record_enabled (bool yn)
1174 if (!recordable() || !_session.record_enabling_legal()) {
1178 assert(!destructive());
1180 /* yes, i know that this not proof against race conditions, but its
1181 good enough. i think.
1184 if (record_enabled() != yn) {
1186 engage_record_enable ();
1188 disengage_record_enable ();
1194 MidiDiskstream::engage_record_enable ()
1196 bool const rolling = _session.transport_speed() != 0.0f;
1198 g_atomic_int_set (&_record_enabled, 1);
1200 boost::shared_ptr<MidiPort> sp = _source_port.lock ();
1202 if (sp && Config->get_monitoring_model() == HardwareMonitoring) {
1203 sp->request_jack_monitors_input (!(_session.config.get_auto_input() && rolling));
1206 RecordEnableChanged (); /* EMIT SIGNAL */
1210 MidiDiskstream::disengage_record_enable ()
1212 g_atomic_int_set (&_record_enabled, 0);
1213 RecordEnableChanged (); /* EMIT SIGNAL */
1217 MidiDiskstream::get_state ()
1219 XMLNode& node (Diskstream::get_state());
1221 LocaleGuard lg (X_("POSIX"));
1223 node.add_property("channel-mode", enum_2_string(get_channel_mode()));
1224 snprintf (buf, sizeof(buf), "0x%x", get_channel_mask());
1225 node.add_property("channel-mask", buf);
1227 if (_write_source && _session.get_record_enabled()) {
1229 XMLNode* cs_child = new XMLNode (X_("CapturingSources"));
1230 XMLNode* cs_grandchild;
1232 cs_grandchild = new XMLNode (X_("file"));
1233 cs_grandchild->add_property (X_("path"), _write_source->path());
1234 cs_child->add_child_nocopy (*cs_grandchild);
1236 /* store the location where capture will start */
1240 if (_session.config.get_punch_in() && ((pi = _session.locations()->auto_punch_location()) != 0)) {
1241 snprintf (buf, sizeof (buf), "%" PRId64, pi->start());
1243 snprintf (buf, sizeof (buf), "%" PRId64, _session.transport_frame());
1246 cs_child->add_property (X_("at"), buf);
1247 node.add_child_nocopy (*cs_child);
1254 MidiDiskstream::set_state (const XMLNode& node, int version)
1256 const XMLProperty* prop;
1257 XMLNodeList nlist = node.children();
1258 XMLNodeIterator niter;
1259 XMLNode* capture_pending_node = 0;
1260 LocaleGuard lg (X_("POSIX"));
1262 /* prevent write sources from being created */
1264 in_set_state = true;
1266 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
1267 assert ((*niter)->name() != IO::state_node_name);
1269 if ((*niter)->name() == X_("CapturingSources")) {
1270 capture_pending_node = *niter;
1274 if (Diskstream::set_state (node, version)) {
1278 ChannelMode channel_mode = AllChannels;
1279 if ((prop = node.property ("channel-mode")) != 0) {
1280 channel_mode = ChannelMode (string_2_enum(prop->value(), channel_mode));
1283 unsigned int channel_mask = 0xFFFF;
1284 if ((prop = node.property ("channel-mask")) != 0) {
1285 sscanf (prop->value().c_str(), "0x%x", &channel_mask);
1286 if (channel_mask & (~0xFFFF)) {
1287 warning << _("MidiDiskstream: XML property channel-mask out of range") << endmsg;
1292 if (capture_pending_node) {
1293 use_pending_capture_data (*capture_pending_node);
1296 set_channel_mode (channel_mode, channel_mask);
1298 in_set_state = false;
1304 MidiDiskstream::use_new_write_source (uint32_t n)
1306 if (!_session.writable() || !recordable()) {
1312 _write_source.reset();
1315 _write_source = boost::dynamic_pointer_cast<SMFSource>(
1316 _session.create_midi_source_for_session (0, name ()));
1318 if (!_write_source) {
1319 throw failed_constructor();
1323 catch (failed_constructor &err) {
1324 error << string_compose (_("%1:%2 new capture file not initialized correctly"), _name, n) << endmsg;
1325 _write_source.reset();
1332 list<boost::shared_ptr<Source> >
1333 MidiDiskstream::steal_write_sources()
1335 list<boost::shared_ptr<Source> > ret;
1337 /* put some data on the disk, even if its just a header for an empty file */
1338 boost::dynamic_pointer_cast<SMFSource> (_write_source)->ensure_disk_file ();
1340 /* never let it go away */
1341 _write_source->mark_nonremovable ();
1343 ret.push_back (_write_source);
1347 use_new_write_source (0);
1353 MidiDiskstream::reset_write_sources (bool mark_write_complete, bool /*force*/)
1355 if (!_session.writable() || !recordable()) {
1359 if (_write_source && mark_write_complete) {
1360 _write_source->mark_streaming_write_completed ();
1362 use_new_write_source (0);
1366 MidiDiskstream::set_block_size (pframes_t /*nframes*/)
1371 MidiDiskstream::allocate_temporary_buffers ()
1376 MidiDiskstream::monitor_input (bool yn)
1378 boost::shared_ptr<MidiPort> sp = _source_port.lock ();
1381 sp->ensure_jack_monitors_input (yn);
1386 MidiDiskstream::set_align_style_from_io ()
1388 if (_alignment_choice != Automatic) {
1392 /* XXX Not sure what, if anything we can do with MIDI
1393 as far as capture alignment etc.
1396 set_align_style (ExistingMaterial);
1401 MidiDiskstream::playback_buffer_load () const
1403 /* For MIDI it's not trivial to differentiate the following two cases:
1405 1. The playback buffer is empty because the system has run out of time to fill it.
1406 2. The playback buffer is empty because there is no more data on the playlist.
1408 If we use a simple buffer load computation, we will report that the MIDI diskstream
1409 cannot keep up when #2 happens, when in fact it can. Since MIDI data rates
1410 are so low compared to audio, just give a pretend answer here.
1417 MidiDiskstream::capture_buffer_load () const
1419 /* We don't report playback buffer load, so don't report capture load either */
1425 MidiDiskstream::use_pending_capture_data (XMLNode& /*node*/)
1430 /** Writes playback events from playback_sample for nframes to dst, translating time stamps
1431 * so that an event at playback_sample has time = 0
1434 MidiDiskstream::get_playback (MidiBuffer& dst, framecnt_t nframes)
1437 assert(dst.size() == 0);
1440 DEBUG_TRACE (DEBUG::MidiDiskstreamIO, string_compose (
1441 "%1 MDS pre-read read %4..%5 from %2 write to %3\n", _name,
1442 _playback_buf->get_read_ptr(), _playback_buf->get_write_ptr(), playback_sample, playback_sample + nframes));
1443 // cerr << "================\n";
1444 // _playback_buf->dump (cerr);
1445 // cerr << "----------------\n";
1447 const size_t events_read = _playback_buf->read (dst, playback_sample, playback_sample + nframes);
1448 DEBUG_TRACE (DEBUG::MidiDiskstreamIO, string_compose (
1449 "%1 MDS events read %2 range %3 .. %4 rspace %5 wspace %6 r@%7 w@%8\n",
1450 _name, events_read, playback_sample, playback_sample + nframes,
1451 _playback_buf->read_space(), _playback_buf->write_space(),
1452 _playback_buf->get_read_ptr(), _playback_buf->get_write_ptr()));
1454 _playback_buf->read (dst, playback_sample, playback_sample + nframes);
1457 g_atomic_int_add (&_frames_read_from_ringbuffer, nframes);
1461 MidiDiskstream::set_name (string const & name)
1463 Diskstream::set_name (name);
1465 /* get a new write source so that its name reflects the new diskstream name */
1466 use_new_write_source (0);
1471 boost::shared_ptr<MidiBuffer>
1472 MidiDiskstream::get_gui_feed_buffer () const
1474 boost::shared_ptr<MidiBuffer> b (new MidiBuffer (AudioEngine::instance()->raw_buffer_size (DataType::MIDI)));
1476 Glib::Mutex::Lock lm (_gui_feed_buffer_mutex);
1477 b->copy (_gui_feed_buffer);