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_playlist.h"
50 #include "ardour/midi_port.h"
51 #include "ardour/midi_region.h"
52 #include "ardour/playlist_factory.h"
53 #include "ardour/region_factory.h"
54 #include "ardour/send.h"
55 #include "ardour/session.h"
56 #include "ardour/smf_source.h"
57 #include "ardour/utils.h"
58 #include "ardour/session_playlists.h"
59 #include "ardour/route.h"
61 #include "midi++/types.h"
67 using namespace ARDOUR;
70 framecnt_t MidiDiskstream::midi_readahead = 4096;
72 MidiDiskstream::MidiDiskstream (Session &sess, const string &name, Diskstream::Flag flag)
73 : Diskstream(sess, name, flag)
77 , _last_flush_frame(0)
78 , _note_mode(Sustained)
79 , _frames_written_to_ringbuffer(0)
80 , _frames_read_from_ringbuffer(0)
86 use_new_write_source (0);
90 assert(!destructive());
93 MidiDiskstream::MidiDiskstream (Session& sess, const XMLNode& node)
94 : Diskstream(sess, node)
98 , _last_flush_frame(0)
99 , _note_mode(Sustained)
100 , _frames_written_to_ringbuffer(0)
101 , _frames_read_from_ringbuffer(0)
107 if (set_state (node, Stateful::loading_state_version)) {
108 in_set_state = false;
109 throw failed_constructor();
112 use_new_write_source (0);
114 in_set_state = false;
118 MidiDiskstream::init ()
120 /* there are no channels at this point, so these
121 two calls just get speed_buffer_size and wrap_buffer
122 size setup without duplicating their code.
125 set_block_size (_session.get_block_size());
126 allocate_temporary_buffers ();
128 const size_t size = _session.butler()->midi_diskstream_buffer_size();
129 _playback_buf = new MidiRingBuffer<framepos_t>(size);
130 _capture_buf = new MidiRingBuffer<framepos_t>(size);
132 _n_channels = ChanCount(DataType::MIDI, 1);
134 assert(recordable());
137 MidiDiskstream::~MidiDiskstream ()
139 Glib::Mutex::Lock lm (state_lock);
144 MidiDiskstream::non_realtime_locate (framepos_t position)
147 _write_source->set_timeline_position (position);
149 cerr << name() << " Seeking to " << position << endl;
150 seek (position, false);
155 MidiDiskstream::non_realtime_input_change ()
158 Glib::Mutex::Lock lm (state_lock);
160 if (input_change_pending.type == IOChange::NoChange) {
164 if (input_change_pending.type & IOChange::ConfigurationChanged) {
165 uint32_t ni = _io->n_ports().n_midi();
167 if (ni != _n_channels.n_midi()) {
168 error << string_compose (_("%1: I/O configuration change %4 requested to use %2, but channel setup is %3"),
171 _n_channels, input_change_pending.type)
178 _source_port = _io->midi(0);
182 if (input_change_pending.type & IOChange::ConnectionsChanged) {
183 set_capture_offset ();
184 set_align_style_from_io ();
187 input_change_pending.type = IOChange::NoChange;
189 /* implicit unlock */
192 /* unlike with audio, there is never any need to reset write sources
193 based on input configuration changes because ... a MIDI track
194 has just 1 MIDI port as input, always.
197 /* now refill channel buffers */
199 if (speed() != 1.0f || speed() != -1.0f) {
200 seek ((framepos_t) (_session.transport_frame() * (double) speed()));
203 seek (_session.transport_frame());
206 _last_flush_frame = _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 playlist->set_orig_diskstream_id (id());
256 return use_playlist (playlist);
264 MidiDiskstream::use_copy_playlist ()
266 assert(midi_playlist());
272 if (_playlist == 0) {
273 error << string_compose(_("MidiDiskstream %1: there is no existing playlist to make a copy of!"), _name) << endmsg;
278 boost::shared_ptr<MidiPlaylist> playlist;
280 newname = Playlist::bump_name (_playlist->name(), _session);
282 if ((playlist = boost::dynamic_pointer_cast<MidiPlaylist>(PlaylistFactory::create (midi_playlist(), newname))) != 0) {
283 playlist->set_orig_diskstream_id (id());
284 return use_playlist (playlist);
290 /** Overloaded from parent to die horribly
293 MidiDiskstream::set_destructive (bool yn)
295 assert( ! destructive());
301 MidiDiskstream::set_note_mode (NoteMode m)
304 midi_playlist()->set_note_mode(m);
305 if (_write_source && _write_source->model())
306 _write_source->model()->set_note_mode(m);
311 trace_midi (ostream& o, MIDI::byte *msg, size_t len)
313 using namespace MIDI;
315 const char trace_prefix = ':';
317 type = (eventType) (msg[0]&0xF0);
324 << " NoteOff NoteNum "
335 << " NoteOn NoteNum "
351 case MIDI::controller:
366 << " Program Change ProgNum "
375 << " Channel Pressure "
380 case MIDI::pitchbend:
385 << ((msg[2]<<7)|msg[1])
424 << "System Exclusive (1 byte : " << hex << (int) *msg << dec << ')'
430 << "System Exclusive (" << len << ") = [ " << hex;
431 for (unsigned int i = 0; i < len; ++i) {
432 o << (int) msg[i] << ' ';
434 o << dec << ']' << endl;
440 o << trace_prefix << "Song" << endl;
444 o << trace_prefix << "Tune" << endl;
448 o << trace_prefix << "End-of-System Exclusive" << endl;
452 o << trace_prefix << "Timing" << endl;
456 o << trace_prefix << "Start" << endl;
460 o << trace_prefix << "Stop" << endl;
464 o << trace_prefix << "Continue" << endl;
468 o << trace_prefix << "Active Sense" << endl;
472 o << trace_prefix << "Unrecognized MIDI message" << endl;
479 MidiDiskstream::process (framepos_t transport_frame, pframes_t nframes, bool can_record, bool rec_monitors_input, bool& need_butler)
482 framecnt_t rec_offset = 0;
483 framecnt_t rec_nframes = 0;
484 bool nominally_recording;
485 bool re = record_enabled ();
487 playback_distance = 0;
489 check_record_status (transport_frame, can_record);
491 nominally_recording = (can_record && re);
497 if (_source_port == 0) {
501 Glib::Mutex::Lock sm (state_lock, Glib::TRY_LOCK);
507 adjust_capture_position = 0;
509 if (nominally_recording || (re && was_recording && _session.get_record_enabled() && _session.config.get_punch_in())) {
510 OverlapType ot = coverage (first_recordable_frame, last_recordable_frame, transport_frame, transport_frame + nframes);
512 calculate_record_range(ot, transport_frame, nframes, rec_nframes, rec_offset);
514 if (rec_nframes && !was_recording) {
515 _write_source->mark_write_starting_now ();
516 capture_captured = 0;
517 was_recording = true;
521 if (can_record && !_last_capture_sources.empty()) {
522 _last_capture_sources.clear ();
525 if (nominally_recording || rec_nframes) {
527 // Pump entire port buffer into the ring buffer (FIXME: split cycles?)
528 MidiBuffer& buf = _source_port->get_midi_buffer(nframes);
529 for (MidiBuffer::iterator i = buf.begin(); i != buf.end(); ++i) {
530 const Evoral::MIDIEvent<MidiBuffer::TimeType> ev(*i, false);
533 if (DEBUG::MidiIO & PBD::debug_bits) {
534 const uint8_t* __data = ev.buffer();
536 DEBUG_STR_APPEND(a, string_compose ("mididiskstream %1 capture event @ %2 + %3 sz %4 ", this, ev.time(), transport_frame, ev.size()));
537 for (size_t i=0; i < ev.size(); ++i) {
538 DEBUG_STR_APPEND(a,hex);
539 DEBUG_STR_APPEND(a,"0x");
540 DEBUG_STR_APPEND(a,(int)__data[i]);
541 DEBUG_STR_APPEND(a,' ');
543 DEBUG_STR_APPEND(a,'\n');
544 DEBUG_TRACE (DEBUG::MidiIO, DEBUG_STR(a).str());
547 _capture_buf->write(ev.time() + transport_frame, ev.type(), ev.size(), ev.buffer());
550 if (buf.size() != 0) {
551 /* XXX this needs fixing - realtime new() call for
552 every time we get MIDI data in a process callback!
555 /* Make a copy of this data and emit it for the GUI to see */
556 boost::shared_ptr<MidiBuffer> copy (new MidiBuffer (buf.capacity ()));
557 for (MidiBuffer::iterator i = buf.begin(); i != buf.end(); ++i) {
558 copy->push_back ((*i).time() + transport_frame, (*i).size(), (*i).buffer());
561 DataRecorded (copy, _write_source); /* EMIT SIGNAL */
567 finish_capture (rec_monitors_input);
574 /* data will be written to disk */
576 if (rec_nframes == nframes && rec_offset == 0) {
577 playback_distance = nframes;
580 adjust_capture_position = rec_nframes;
582 } else if (nominally_recording) {
584 /* XXXX do this for MIDI !!!
585 can't do actual capture yet - waiting for latency effects to finish before we start
588 playback_distance = nframes;
592 /* XXX: should be doing varispeed stuff here, similar to the code in AudioDiskstream::process */
594 playback_distance = nframes;
600 if (commit (nframes)) {
608 MidiDiskstream::commit (framecnt_t nframes)
610 bool need_butler = false;
612 if (_actual_speed < 0.0) {
613 playback_sample -= playback_distance;
615 playback_sample += playback_distance;
618 if (adjust_capture_position != 0) {
619 capture_captured += adjust_capture_position;
620 adjust_capture_position = 0;
623 uint32_t frames_read = g_atomic_int_get(&_frames_read_from_ringbuffer);
624 uint32_t frames_written = g_atomic_int_get(&_frames_written_to_ringbuffer);
625 if ((frames_written - frames_read) + nframes < midi_readahead) {
629 /*cerr << "MDS written: " << frames_written << " - read: " << frames_read <<
630 " = " << frames_written - frames_read
631 << " + " << nframes << " < " << midi_readahead << " = " << need_butler << ")" << endl;*/
637 MidiDiskstream::set_pending_overwrite (bool yn)
639 /* called from audio thread, so we can use the read ptr and playback sample as we wish */
641 _pending_overwrite = yn;
642 overwrite_frame = playback_sample;
646 MidiDiskstream::overwrite_existing_buffers ()
648 /* This is safe as long as the butler thread is suspended, which it should be */
649 _playback_buf->reset ();
651 g_atomic_int_set (&_frames_read_from_ringbuffer, 0);
652 g_atomic_int_set (&_frames_written_to_ringbuffer, 0);
654 read (overwrite_frame, disk_io_chunk_frames, false);
655 file_frame = overwrite_frame; // it was adjusted by ::read()
656 overwrite_queued = false;
657 _pending_overwrite = false;
663 MidiDiskstream::seek (framepos_t frame, bool complete_refill)
665 Glib::Mutex::Lock lm (state_lock);
668 _playback_buf->reset();
669 _capture_buf->reset();
670 g_atomic_int_set(&_frames_read_from_ringbuffer, 0);
671 g_atomic_int_set(&_frames_written_to_ringbuffer, 0);
673 playback_sample = frame;
676 if (complete_refill) {
677 while ((ret = do_refill_with_alloc ()) > 0) ;
679 ret = do_refill_with_alloc ();
686 MidiDiskstream::can_internal_playback_seek (framecnt_t distance)
688 uint32_t frames_read = g_atomic_int_get(&_frames_read_from_ringbuffer);
689 uint32_t frames_written = g_atomic_int_get(&_frames_written_to_ringbuffer);
690 return ((frames_written - frames_read) < distance);
694 MidiDiskstream::internal_playback_seek (framecnt_t distance)
696 first_recordable_frame += distance;
697 playback_sample += distance;
702 /** @a start is set to the new frame position (TIME) read up to */
704 MidiDiskstream::read (framepos_t& start, framecnt_t dur, bool reversed)
706 framecnt_t this_read = 0;
708 framepos_t loop_end = 0;
709 framepos_t loop_start = 0;
714 framecnt_t loop_length = 0;
716 /* Make the use of a Location atomic for this read operation.
718 Note: Locations don't get deleted, so all we care about
719 when I say "atomic" is that we are always pointing to
720 the same one and using a start/length values obtained
724 if ((loc = loop_location) != 0) {
725 loop_start = loc->start();
726 loop_end = loc->end();
727 loop_length = loop_end - loop_start;
730 /* if we are looping, ensure that the first frame we read is at the correct
731 position within the loop.
734 if (loc && (start >= loop_end)) {
735 //cerr << "start adjusted from " << start;
736 start = loop_start + ((start - loop_start) % loop_length);
737 //cerr << "to " << start << endl;
739 //cerr << "start is " << start << " loopstart: " << loop_start << " loopend: " << loop_end << endl;
744 /* take any loop into account. we can't read past the end of the loop. */
746 if (loc && (loop_end - start < dur)) {
747 this_read = loop_end - start;
748 //cerr << "reloop true: thisread: " << this_read << " dur: " << dur << endl;
755 if (this_read == 0) {
759 this_read = min(dur,this_read);
761 if (midi_playlist()->read (*_playback_buf, start, this_read) != this_read) {
762 error << string_compose(
763 _("MidiDiskstream %1: cannot read %2 from playlist at frame %3"),
764 _id, this_read, start) << endmsg;
768 g_atomic_int_add(&_frames_written_to_ringbuffer, this_read);
770 _read_data_count = _playlist->read_data_count();
774 // Swap note ons with note offs here. etc?
775 // Fully reversing MIDI requires look-ahead (well, behind) to find previous
776 // CC values etc. hard.
780 /* if we read to the end of the loop, go back to the beginning */
783 // Synthesize LoopEvent here, because the next events
784 // written will have non-monotonic timestamps.
785 _playback_buf->write(loop_end - 1, LoopEventType, sizeof (framepos_t), (uint8_t *) &loop_start);
793 //offset += this_read;
800 MidiDiskstream::do_refill_with_alloc ()
806 MidiDiskstream::do_refill ()
809 size_t write_space = _playback_buf->write_space();
810 bool reversed = (_visible_speed * _session.transport_speed()) < 0.0f;
812 if (write_space == 0) {
820 /* at end: nothing to do */
821 if (file_frame == max_framepos) {
825 // At this point we...
826 assert(_playback_buf->write_space() > 0); // ... have something to write to, and
827 assert(file_frame <= max_framepos); // ... something to write
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) {
837 framecnt_t to_read = midi_readahead - (frames_written - frames_read);
839 //cout << "MDS read for midi_readahead " << to_read << " rb_contains: "
840 // << frames_written - frames_read << endl;
842 to_read = (framecnt_t) min ((framecnt_t) to_read, (framecnt_t) (max_framepos - file_frame));
844 if (read (file_frame, to_read, reversed)) {
851 /** Flush pending data to disk.
853 * Important note: this function will write *AT MOST* disk_io_chunk_frames
854 * of data to disk. it will never write more than that. If it writes that
855 * much and there is more than that waiting to be written, it will return 1,
856 * otherwise 0 on success or -1 on failure.
858 * If there is less than disk_io_chunk_frames to be written, no data will be
859 * written at all unless @a force_flush is true.
862 MidiDiskstream::do_flush (RunContext /*context*/, bool force_flush)
868 cerr << name() << " flushing to disk, bufspace = " << _capture_buf->read_space()
869 << " transport @ " << _session.transport_frame() << " last flush @ " << _last_flush_frame
872 _write_data_count = 0;
874 total = _session.transport_frame() - _last_flush_frame;
876 if (total == 0 || _capture_buf->read_space() == 0
877 || (!force_flush && (total < disk_io_chunk_frames && was_recording))) {
878 cerr << "\tFlush shortcut because total = " << total
879 << " capture read space = " << _capture_buf->read_space()
880 << " force flush = " << force_flush
881 << " was recording = " << was_recording
886 /* if there are 2+ chunks of disk i/o possible for
887 this track, let the caller know so that it can arrange
888 for us to be called again, ASAP.
890 if we are forcing a flush, then if there is* any* extra
891 work, let the caller know.
893 if we are no longer recording and there is any extra work,
894 let the caller know too.
897 if (total >= 2 * disk_io_chunk_frames || ((force_flush || !was_recording) && total > disk_io_chunk_frames)) {
901 to_write = disk_io_chunk_frames;
903 assert(!destructive());
905 if (record_enabled() &&
906 ((_session.transport_frame() - _last_flush_frame > disk_io_chunk_frames) ||
908 if ((!_write_source) || _write_source->midi_write (*_capture_buf, get_capture_start_frame (0), to_write) != to_write) {
909 error << string_compose(_("MidiDiskstream %1: cannot write to disk"), _id) << endmsg;
912 cerr << "didn't write, _write_source = " << _write_source << endl;
913 _last_flush_frame = _session.transport_frame();
916 cerr << "\tdidn't write to disk because recenabled = " << record_enabled()
917 << " last flush @ " << _last_flush_frame << " disk io " << disk_io_chunk_frames << " TF @ " << _session.transport_frame()
918 << " force = " << force_flush << endl;
924 if (_last_flush_frame > _session.transport_frame() || _last_flush_frame < capture_start_frame) {
925 _last_flush_frame = _session.transport_frame();
926 cerr << name() << " set last flush frame to " << _last_flush_frame << endl;
934 MidiDiskstream::transport_stopped_wallclock (struct tm& /*when*/, time_t /*twhen*/, bool abort_capture)
936 bool more_work = true;
938 boost::shared_ptr<MidiRegion> region;
939 MidiRegion::SourceList srcs;
940 MidiRegion::SourceList::iterator src;
941 vector<CaptureInfo*>::iterator ci;
943 finish_capture (true);
945 /* butler is already stopped, but there may be work to do
946 to flush remaining data to disk.
949 while (more_work && !err) {
950 switch (do_flush (TransportContext, true)) {
957 error << string_compose(_("MidiDiskstream \"%1\": cannot flush captured data to disk!"), _name) << endmsg;
962 /* XXX is there anything we can do if err != 0 ? */
963 Glib::Mutex::Lock lm (capture_info_lock);
965 if (capture_info.empty()) {
972 _write_source->mark_for_remove ();
973 _write_source->drop_references ();
974 _write_source.reset();
977 /* new source set up in "out" below */
981 assert(_write_source);
983 framecnt_t total_capture = 0;
984 for (ci = capture_info.begin(); ci != capture_info.end(); ++ci) {
985 total_capture += (*ci)->frames;
988 if (_write_source->length (capture_info.front()->start) != 0) {
990 /* phew, we have data */
992 /* figure out the name for this take */
994 srcs.push_back (_write_source);
996 _write_source->set_timeline_position (capture_info.front()->start);
997 _write_source->set_captured_for (_name);
999 /* flush to disk: this step differs from the audio path,
1000 where all the data is already on disk.
1003 _write_source->mark_streaming_write_completed ();
1005 /* set length in beats to entire capture length */
1007 BeatsFramesConverter converter (_session.tempo_map(), capture_info.front()->start);
1008 const double total_capture_beats = converter.from(total_capture);
1009 _write_source->set_length_beats(total_capture_beats);
1011 /* we will want to be able to keep (over)writing the source
1012 but we don't want it to be removable. this also differs
1013 from the audio situation, where the source at this point
1014 must be considered immutable. luckily, we can rely on
1015 MidiSource::mark_streaming_write_completed() to have
1016 already done the necessary work for that.
1019 string whole_file_region_name;
1020 whole_file_region_name = region_name_from_path (_write_source->name(), true);
1022 /* Register a new region with the Session that
1023 describes the entire source. Do this first
1024 so that any sub-regions will obviously be
1025 children of this one (later!)
1031 plist.add (Properties::name, whole_file_region_name);
1032 plist.add (Properties::whole_file, true);
1033 plist.add (Properties::automatic, true);
1034 plist.add (Properties::start, 0);
1035 plist.add (Properties::length, total_capture);
1036 plist.add (Properties::layer, 0);
1038 boost::shared_ptr<Region> rx (RegionFactory::create (srcs, plist));
1040 region = boost::dynamic_pointer_cast<MidiRegion> (rx);
1041 region->special_set_position (capture_info.front()->start);
1045 catch (failed_constructor& err) {
1046 error << string_compose(_("%1: could not create region for complete midi file"), _name) << endmsg;
1050 _last_capture_sources.insert (_last_capture_sources.end(), srcs.begin(), srcs.end());
1052 _playlist->clear_changes ();
1053 _playlist->freeze ();
1055 /* Session frame time of the initial capture in this pass, which is where the source starts */
1056 framepos_t initial_capture = 0;
1057 if (!capture_info.empty()) {
1058 initial_capture = capture_info.front()->start;
1061 for (ci = capture_info.begin(); ci != capture_info.end(); ++ci) {
1065 RegionFactory::region_name (region_name, _write_source->name(), false);
1067 // cerr << _name << ": based on ci of " << (*ci)->start << " for " << (*ci)->frames << " add a region\n";
1072 /* start of this region is the offset between the start of its capture and the start of the whole pass */
1073 plist.add (Properties::start, (*ci)->start - initial_capture);
1074 plist.add (Properties::length, (*ci)->frames);
1075 plist.add (Properties::length_beats, converter.from((*ci)->frames));
1076 plist.add (Properties::name, region_name);
1078 boost::shared_ptr<Region> rx (RegionFactory::create (srcs, plist));
1079 region = boost::dynamic_pointer_cast<MidiRegion> (rx);
1082 catch (failed_constructor& err) {
1083 error << _("MidiDiskstream: could not create region for captured midi!") << endmsg;
1084 continue; /* XXX is this OK? */
1087 // cerr << "add new region, buffer position = " << buffer_position << " @ " << (*ci)->start << endl;
1089 i_am_the_modifier++;
1090 _playlist->add_region (region, (*ci)->start);
1091 i_am_the_modifier--;
1095 _session.add_command (new StatefulDiffCommand(_playlist));
1099 /* No data was recorded, so this capture will
1100 effectively be aborted; do the same as we
1101 do for an explicit abort.
1104 if (_write_source) {
1105 _write_source->mark_for_remove ();
1106 _write_source->drop_references ();
1107 _write_source.reset();
1113 use_new_write_source (0);
1115 for (ci = capture_info.begin(); ci != capture_info.end(); ++ci) {
1120 midi_playlist()->clear_note_trackers ();
1123 capture_info.clear ();
1124 capture_start_frame = 0;
1128 MidiDiskstream::transport_looped (framepos_t transport_frame)
1130 if (was_recording) {
1132 // adjust the capture length knowing that the data will be recorded to disk
1133 // only necessary after the first loop where we're recording
1134 if (capture_info.size() == 0) {
1135 capture_captured += _capture_offset;
1137 if (_alignment_style == ExistingMaterial) {
1138 capture_captured += _session.worst_output_latency();
1140 capture_captured += _roll_delay;
1144 finish_capture (true);
1146 // the next region will start recording via the normal mechanism
1147 // we'll set the start position to the current transport pos
1148 // no latency adjustment or capture offset needs to be made, as that already happened the first time
1149 capture_start_frame = transport_frame;
1150 first_recordable_frame = transport_frame; // mild lie
1151 last_recordable_frame = max_framepos;
1152 was_recording = true;
1157 MidiDiskstream::finish_capture (bool /*rec_monitors_input*/)
1159 was_recording = false;
1161 if (capture_captured == 0) {
1165 // Why must we destroy?
1166 assert(!destructive());
1168 CaptureInfo* ci = new CaptureInfo;
1170 ci->start = capture_start_frame;
1171 ci->frames = capture_captured;
1173 /* XXX theoretical race condition here. Need atomic exchange ?
1174 However, the circumstances when this is called right
1175 now (either on record-disable or transport_stopped)
1176 mean that no actual race exists. I think ...
1177 We now have a capture_info_lock, but it is only to be used
1178 to synchronize in the transport_stop and the capture info
1179 accessors, so that invalidation will not occur (both non-realtime).
1182 // cerr << "Finish capture, add new CI, " << ci->start << '+' << ci->frames << endl;
1184 capture_info.push_back (ci);
1185 capture_captured = 0;
1189 MidiDiskstream::set_record_enabled (bool yn)
1191 if (!recordable() || !_session.record_enabling_legal()) {
1195 assert(!destructive());
1197 /* yes, i know that this not proof against race conditions, but its
1198 good enough. i think.
1201 if (record_enabled() != yn) {
1203 engage_record_enable ();
1205 disengage_record_enable ();
1211 MidiDiskstream::engage_record_enable ()
1213 bool const rolling = _session.transport_speed() != 0.0f;
1215 g_atomic_int_set (&_record_enabled, 1);
1217 if (_source_port && Config->get_monitoring_model() == HardwareMonitoring) {
1218 _source_port->request_monitor_input (!(_session.config.get_auto_input() && rolling));
1221 RecordEnableChanged (); /* EMIT SIGNAL */
1225 MidiDiskstream::disengage_record_enable ()
1227 g_atomic_int_set (&_record_enabled, 0);
1228 RecordEnableChanged (); /* EMIT SIGNAL */
1232 MidiDiskstream::get_state ()
1234 XMLNode& node (Diskstream::get_state());
1236 LocaleGuard lg (X_("POSIX"));
1238 node.add_property("channel-mode", enum_2_string(get_channel_mode()));
1239 snprintf (buf, sizeof(buf), "0x%x", get_channel_mask());
1240 node.add_property("channel-mask", buf);
1242 if (_write_source && _session.get_record_enabled()) {
1244 XMLNode* cs_child = new XMLNode (X_("CapturingSources"));
1245 XMLNode* cs_grandchild;
1247 cs_grandchild = new XMLNode (X_("file"));
1248 cs_grandchild->add_property (X_("path"), _write_source->path());
1249 cs_child->add_child_nocopy (*cs_grandchild);
1251 /* store the location where capture will start */
1255 if (_session.config.get_punch_in() && ((pi = _session.locations()->auto_punch_location()) != 0)) {
1256 snprintf (buf, sizeof (buf), "%" PRId64, pi->start());
1258 snprintf (buf, sizeof (buf), "%" PRId64, _session.transport_frame());
1261 cs_child->add_property (X_("at"), buf);
1262 node.add_child_nocopy (*cs_child);
1269 MidiDiskstream::set_state (const XMLNode& node, int version)
1271 const XMLProperty* prop;
1272 XMLNodeList nlist = node.children();
1273 XMLNodeIterator niter;
1274 XMLNode* capture_pending_node = 0;
1275 LocaleGuard lg (X_("POSIX"));
1277 /* prevent write sources from being created */
1279 in_set_state = true;
1281 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
1282 assert ((*niter)->name() != IO::state_node_name);
1284 if ((*niter)->name() == X_("CapturingSources")) {
1285 capture_pending_node = *niter;
1289 if (Diskstream::set_state (node, version)) {
1293 ChannelMode channel_mode = AllChannels;
1294 if ((prop = node.property ("channel-mode")) != 0) {
1295 channel_mode = ChannelMode (string_2_enum(prop->value(), channel_mode));
1298 unsigned int channel_mask = 0xFFFF;
1299 if ((prop = node.property ("channel-mask")) != 0) {
1300 sscanf (prop->value().c_str(), "0x%x", &channel_mask);
1301 if (channel_mask & (~0xFFFF)) {
1302 warning << _("MidiDiskstream: XML property channel-mask out of range") << endmsg;
1307 if (capture_pending_node) {
1308 use_pending_capture_data (*capture_pending_node);
1311 set_channel_mode (channel_mode, channel_mask);
1313 in_set_state = false;
1319 MidiDiskstream::use_new_write_source (uint32_t n)
1321 if (!_session.writable() || !recordable()) {
1327 _write_source.reset();
1330 _write_source = boost::dynamic_pointer_cast<SMFSource>(
1331 _session.create_midi_source_for_session (0, name ()));
1333 if (!_write_source) {
1334 throw failed_constructor();
1338 catch (failed_constructor &err) {
1339 error << string_compose (_("%1:%2 new capture file not initialized correctly"), _name, n) << endmsg;
1340 _write_source.reset();
1347 list<boost::shared_ptr<Source> >
1348 MidiDiskstream::steal_write_sources()
1350 list<boost::shared_ptr<Source> > ret;
1352 /* put some data on the disk, even if its just a header for an empty file */
1353 boost::dynamic_pointer_cast<SMFSource> (_write_source)->ensure_disk_file ();
1355 /* never let it go away */
1356 _write_source->mark_nonremovable ();
1358 ret.push_back (_write_source);
1362 use_new_write_source (0);
1368 MidiDiskstream::reset_write_sources (bool mark_write_complete, bool /*force*/)
1370 if (!_session.writable() || !recordable()) {
1374 if (_write_source && mark_write_complete) {
1375 _write_source->mark_streaming_write_completed ();
1377 use_new_write_source (0);
1381 MidiDiskstream::set_block_size (pframes_t /*nframes*/)
1386 MidiDiskstream::allocate_temporary_buffers ()
1391 MidiDiskstream::monitor_input (bool yn)
1394 _source_port->ensure_monitor_input (yn);
1398 MidiDiskstream::set_align_style_from_io ()
1400 if (_alignment_choice != Automatic) {
1404 /* XXX Not sure what, if anything we can do with MIDI
1405 as far as capture alignment etc.
1408 set_align_style (ExistingMaterial);
1413 MidiDiskstream::playback_buffer_load () const
1415 return (float) ((double) _playback_buf->read_space()/
1416 (double) _playback_buf->capacity());
1420 MidiDiskstream::capture_buffer_load () const
1422 return (float) ((double) _capture_buf->write_space()/
1423 (double) _capture_buf->capacity());
1427 MidiDiskstream::use_pending_capture_data (XMLNode& /*node*/)
1432 /** Writes playback events in the given range to \a dst, translating time stamps
1433 * so that an event at \a start has time = 0
1436 MidiDiskstream::get_playback (MidiBuffer& dst, framepos_t start, framepos_t end)
1439 assert(dst.size() == 0);
1441 // Reverse. ... We just don't do reverse, ok? Back off.
1446 // Translate stamps to be relative to start
1450 DEBUG_TRACE (DEBUG::MidiDiskstreamIO, string_compose (
1451 "%1 MDS pre-read read %4..%5 from %2 write to %3\n", _name,
1452 _playback_buf->get_read_ptr(), _playback_buf->get_write_ptr(), start, end));
1453 // cerr << "================\n";
1454 // _playback_buf->dump (cerr);
1455 // cerr << "----------------\n";
1457 const size_t events_read = _playback_buf->read(dst, start, end);
1458 DEBUG_TRACE (DEBUG::MidiDiskstreamIO, string_compose (
1459 "%1 MDS events read %2 range %3 .. %4 rspace %5 wspace %6 r@%7 w@%8\n",
1460 _name, events_read, start, end,
1461 _playback_buf->read_space(), _playback_buf->write_space(),
1462 _playback_buf->get_read_ptr(), _playback_buf->get_write_ptr()));
1464 _playback_buf->read(dst, start, end);
1467 gint32 frames_read = end - start;
1468 g_atomic_int_add(&_frames_read_from_ringbuffer, frames_read);
1472 MidiDiskstream::set_name (string const & name)
1474 Diskstream::set_name (name);
1476 /* get a new write source so that its name reflects the new diskstream name */
1477 use_new_write_source (0);