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"
39 #include "ardour/ardour.h"
40 #include "ardour/audioengine.h"
41 #include "ardour/configuration.h"
42 #include "ardour/cycle_timer.h"
43 #include "ardour/io.h"
44 #include "ardour/midi_diskstream.h"
45 #include "ardour/midi_playlist.h"
46 #include "ardour/midi_port.h"
47 #include "ardour/midi_region.h"
48 #include "ardour/playlist_factory.h"
49 #include "ardour/region_factory.h"
50 #include "ardour/send.h"
51 #include "ardour/session.h"
52 #include "ardour/smf_source.h"
53 #include "ardour/utils.h"
55 #include "midi++/types.h"
61 using namespace ARDOUR;
64 nframes_t MidiDiskstream::midi_readahead = 4096;
66 MidiDiskstream::MidiDiskstream (Session &sess, const string &name, Diskstream::Flag flag)
67 : Diskstream(sess, name, flag)
71 , _last_flush_frame(0)
72 , _note_mode(Sustained)
73 , _frames_written_to_ringbuffer(0)
74 , _frames_read_from_ringbuffer(0)
76 /* prevent any write sources from being created */
85 assert(!destructive());
88 MidiDiskstream::MidiDiskstream (Session& sess, const XMLNode& node)
89 : Diskstream(sess, node)
93 , _last_flush_frame(0)
94 , _note_mode(Sustained)
95 , _frames_written_to_ringbuffer(0)
96 , _frames_read_from_ringbuffer(0)
101 if (set_state (node)) {
102 in_set_state = false;
103 throw failed_constructor();
106 in_set_state = false;
109 use_destructive_playlist ();
114 MidiDiskstream::init (Diskstream::Flag f)
118 /* there are no channels at this point, so these
119 two calls just get speed_buffer_size and wrap_buffer
120 size setup without duplicating their code.
123 set_block_size (_session.get_block_size());
124 allocate_temporary_buffers ();
126 const size_t size = _session.midi_diskstream_buffer_size();
127 _playback_buf = new MidiRingBuffer<nframes_t>(size);
128 _capture_buf = new MidiRingBuffer<nframes_t>(size);
130 _n_channels = ChanCount(DataType::MIDI, 1);
132 assert(recordable());
135 MidiDiskstream::~MidiDiskstream ()
137 Glib::Mutex::Lock lm (state_lock);
142 MidiDiskstream::non_realtime_locate (nframes_t position)
145 _write_source->set_timeline_position (position);
147 seek(position, false);
152 MidiDiskstream::non_realtime_input_change ()
155 Glib::Mutex::Lock lm (state_lock);
157 if (input_change_pending == NoChange) {
161 if (input_change_pending & ConfigurationChanged) {
162 if (_io->n_inputs().n_midi() != _n_channels.n_midi()) {
163 error << "Can not feed IO " << _io->n_inputs()
164 << " with diskstream " << _n_channels << endl;
168 get_input_sources ();
169 set_capture_offset ();
171 if (first_input_change) {
172 set_align_style (_persistent_alignment_style);
173 first_input_change = false;
175 set_align_style_from_io ();
178 input_change_pending = NoChange;
180 /* implicit unlock */
183 /* reset capture files */
185 reset_write_sources (false);
187 /* now refill channel buffers */
189 if (speed() != 1.0f || speed() != -1.0f) {
190 seek ((nframes_t) (_session.transport_frame() * (double) speed()));
193 seek (_session.transport_frame());
196 _last_flush_frame = _session.transport_frame();
200 MidiDiskstream::get_input_sources ()
202 uint32_t ni = _io->n_inputs().n_midi();
208 // This is all we do for now at least
211 _source_port = _io->midi_input(0);
217 MidiDiskstream::find_and_use_playlist (const string& name)
219 boost::shared_ptr<MidiPlaylist> playlist;
221 if ((playlist = boost::dynamic_pointer_cast<MidiPlaylist> (_session.playlist_by_name (name))) == 0) {
222 playlist = boost::dynamic_pointer_cast<MidiPlaylist> (PlaylistFactory::create (DataType::MIDI, _session, name));
226 error << string_compose(_("MidiDiskstream: Playlist \"%1\" isn't an midi playlist"), name) << endmsg;
230 return use_playlist (playlist);
234 MidiDiskstream::use_playlist (boost::shared_ptr<Playlist> playlist)
236 assert(boost::dynamic_pointer_cast<MidiPlaylist>(playlist));
238 Diskstream::use_playlist(playlist);
244 MidiDiskstream::use_new_playlist ()
247 boost::shared_ptr<MidiPlaylist> playlist;
249 if (!in_set_state && destructive()) {
254 newname = Playlist::bump_name (_playlist->name(), _session);
256 newname = Playlist::bump_name (_name, _session);
259 if ((playlist = boost::dynamic_pointer_cast<MidiPlaylist> (PlaylistFactory::create (
260 DataType::MIDI, _session, newname, hidden()))) != 0) {
262 playlist->set_orig_diskstream_id (id());
263 return use_playlist (playlist);
271 MidiDiskstream::use_copy_playlist ()
273 assert(midi_playlist());
279 if (_playlist == 0) {
280 error << string_compose(_("MidiDiskstream %1: there is no existing playlist to make a copy of!"), _name) << endmsg;
285 boost::shared_ptr<MidiPlaylist> playlist;
287 newname = Playlist::bump_name (_playlist->name(), _session);
289 if ((playlist = boost::dynamic_pointer_cast<MidiPlaylist>(PlaylistFactory::create (midi_playlist(), newname))) != 0) {
290 playlist->set_orig_diskstream_id (id());
291 return use_playlist (playlist);
297 /** Overloaded from parent to die horribly
300 MidiDiskstream::set_destructive (bool yn)
302 assert( ! destructive());
308 MidiDiskstream::set_note_mode (NoteMode m)
311 midi_playlist()->set_note_mode(m);
312 if (_write_source && _write_source->model())
313 _write_source->model()->set_note_mode(m);
317 MidiDiskstream::check_record_status (nframes_t transport_frame, nframes_t nframes, bool can_record)
319 // FIXME: waaay too much code to duplicate (AudioDiskstream)
321 int possibly_recording;
324 const int transport_rolling = 0x4;
325 const int track_rec_enabled = 0x2;
326 const int global_rec_enabled = 0x1;
328 /* merge together the 3 factors that affect record status, and compute
332 rolling = _session.transport_speed() != 0.0f;
333 possibly_recording = (rolling << 2) | (record_enabled() << 1) | can_record;
334 change = possibly_recording ^ last_possibly_recording;
336 if (possibly_recording == last_possibly_recording) {
342 /* if per-track or global rec-enable turned on while the other was already on, we've started recording */
344 if (((change & track_rec_enabled) && record_enabled() && (!(change & global_rec_enabled) && can_record)) ||
345 ((change & global_rec_enabled) && can_record && (!(change & track_rec_enabled) && record_enabled()))) {
347 /* starting to record: compute first+last frames */
349 first_recordable_frame = transport_frame + _capture_offset;
350 last_recordable_frame = max_frames;
351 capture_start_frame = transport_frame;
353 if (!(last_possibly_recording & transport_rolling) && (possibly_recording & transport_rolling)) {
355 /* was stopped, now rolling (and recording) */
357 if (_alignment_style == ExistingMaterial) {
358 first_recordable_frame += _session.worst_output_latency();
360 first_recordable_frame += _roll_delay;
365 /* was rolling, but record state changed */
367 if (_alignment_style == ExistingMaterial) {
370 if (!Config->get_punch_in()) {
372 /* manual punch in happens at the correct transport frame
373 because the user hit a button. but to get alignment correct
374 we have to back up the position of the new region to the
375 appropriate spot given the roll delay.
378 capture_start_frame -= _roll_delay;
380 /* XXX paul notes (august 2005): i don't know why
384 first_recordable_frame += _capture_offset;
388 /* autopunch toggles recording at the precise
389 transport frame, and then the DS waits
390 to start recording for a time that depends
391 on the output latency.
394 first_recordable_frame += _session.worst_output_latency();
399 if (Config->get_punch_in()) {
400 first_recordable_frame += _roll_delay;
402 capture_start_frame -= _roll_delay;
408 } else if (!record_enabled() || !can_record) {
412 last_recordable_frame = transport_frame + _capture_offset;
414 if (_alignment_style == ExistingMaterial) {
415 last_recordable_frame += _session.worst_output_latency();
417 last_recordable_frame += _roll_delay;
421 last_possibly_recording = possibly_recording;
425 trace_midi (ostream& o, MIDI::byte *msg, size_t len)
427 using namespace MIDI;
429 const char trace_prefix = ':';
431 type = (eventType) (msg[0]&0xF0);
438 << " NoteOff NoteNum "
449 << " NoteOn NoteNum "
465 case MIDI::controller:
480 << " Program Change ProgNum "
489 << " Channel Pressure "
494 case MIDI::pitchbend:
499 << ((msg[2]<<7)|msg[1])
538 << "System Exclusive (1 byte : " << hex << (int) *msg << dec << ')'
544 << "System Exclusive (" << len << ") = [ " << hex;
545 for (unsigned int i = 0; i < len; ++i) {
546 o << (int) msg[i] << ' ';
548 o << dec << ']' << endl;
554 o << trace_prefix << "Song" << endl;
558 o << trace_prefix << "Tune" << endl;
562 o << trace_prefix << "End-of-System Exclusive" << endl;
566 o << trace_prefix << "Timing" << endl;
570 o << trace_prefix << "Start" << endl;
574 o << trace_prefix << "Stop" << endl;
578 o << trace_prefix << "Continue" << endl;
582 o << trace_prefix << "Active Sense" << endl;
586 o << trace_prefix << "Unrecognized MIDI message" << endl;
592 MidiDiskstream::process (nframes_t transport_frame, nframes_t nframes, bool can_record, bool rec_monitors_input)
594 // FIXME: waay too much code to duplicate (AudioDiskstream::process)
596 nframes_t rec_offset = 0;
597 nframes_t rec_nframes = 0;
598 bool nominally_recording;
599 bool re = record_enabled ();
600 bool collect_playback = true;
602 /* if we've already processed the frames corresponding to this call,
603 just return. this allows multiple routes that are taking input
604 from this diskstream to call our ::process() method, but have
605 this stuff only happen once. more commonly, it allows both
606 the AudioTrack that is using this AudioDiskstream *and* the Session
607 to call process() without problems.
614 commit_should_unlock = false;
616 check_record_status (transport_frame, nframes, can_record);
618 nominally_recording = (can_record && re);
625 /* This lock is held until the end of ::commit, so these two functions
626 must always be called as a pair. The only exception is if this function
627 returns a non-zero value, in which case, ::commit should not be called.
630 // If we can't take the state lock return.
631 if (!state_lock.trylock()) {
634 commit_should_unlock = true;
635 adjust_capture_position = 0;
637 if (nominally_recording || (_session.get_record_enabled() && Config->get_punch_in())) {
640 ot = coverage (first_recordable_frame, last_recordable_frame, transport_frame, transport_frame + nframes);
647 case OverlapInternal:
648 /* ---------- recrange
651 rec_nframes = nframes;
656 /* |--------| recrange
659 rec_nframes = transport_frame + nframes - first_recordable_frame;
661 rec_offset = first_recordable_frame - transport_frame;
666 /* |--------| recrange
669 rec_nframes = last_recordable_frame - transport_frame;
673 case OverlapExternal:
674 /* |--------| recrange
675 -------------- transrange
677 rec_nframes = last_recordable_frame - last_recordable_frame;
678 rec_offset = first_recordable_frame - transport_frame;
682 if (rec_nframes && !was_recording) {
683 capture_captured = 0;
684 was_recording = true;
689 if (can_record && !_last_capture_regions.empty()) {
690 _last_capture_regions.clear ();
693 if (nominally_recording || rec_nframes) {
695 // Pump entire port buffer into the ring buffer (FIXME: split cycles?)
696 MidiBuffer& buf = _source_port->get_midi_buffer(nframes);
697 for (MidiBuffer::iterator i = buf.begin(); i != buf.end(); ++i) {
698 const Evoral::MIDIEvent<MidiBuffer::TimeType> ev(*i, false);
700 _capture_buf->write(ev.time() + transport_frame, ev.type(), ev.size(), ev.buffer());
706 finish_capture (rec_monitors_input);
713 /* data will be written to disk */
715 if (rec_nframes == nframes && rec_offset == 0) {
716 playback_distance = nframes;
719 adjust_capture_position = rec_nframes;
721 } else if (nominally_recording) {
723 /* can't do actual capture yet - waiting for latency effects to finish before we start*/
725 playback_distance = nframes;
726 collect_playback = false;
730 if (collect_playback) {
732 /* we're doing playback */
734 nframes_t necessary_samples;
736 /* no varispeed playback if we're recording, because the output .... TBD */
738 if (rec_nframes == 0 && _actual_speed != 1.0f) {
739 necessary_samples = (nframes_t) floor ((nframes * fabs (_actual_speed))) + 1;
741 necessary_samples = nframes;
744 // Pump entire port buffer into playback buffer (FIXME: split cycles?)
745 MidiBuffer& buf = _source_port->get_midi_buffer(nframes);
746 for (MidiBuffer::iterator i = buf.begin(); i != buf.end(); ++i) {
747 const Evoral::MIDIEvent<MidiBuffer::TimeType> ev(*i, false);
749 _playback_buf->write(ev.time() + transport_frame, ev.type(), ev.size(), ev.buffer());
759 /* we're exiting with failure, so ::commit will not
760 be called. unlock the state lock.
763 commit_should_unlock = false;
771 MidiDiskstream::commit (nframes_t nframes)
773 bool need_butler = false;
775 if (_actual_speed < 0.0) {
776 playback_sample -= playback_distance;
778 playback_sample += playback_distance;
781 if (adjust_capture_position != 0) {
782 capture_captured += adjust_capture_position;
783 adjust_capture_position = 0;
786 uint32_t frames_read = g_atomic_int_get(&_frames_read_from_ringbuffer);
787 uint32_t frames_written = g_atomic_int_get(&_frames_written_to_ringbuffer);
788 if ((frames_written - frames_read) + nframes < midi_readahead) {
792 /*cerr << "MDS written: " << frames_written << " - read: " << frames_read <<
793 " = " << frames_written - frames_read
794 << " + " << nframes << " < " << midi_readahead << " = " << need_butler << ")" << endl;*/
796 if (commit_should_unlock) {
806 MidiDiskstream::set_pending_overwrite (bool yn)
808 /* called from audio thread, so we can use the read ptr and playback sample as we wish */
810 pending_overwrite = yn;
812 overwrite_frame = playback_sample;
816 MidiDiskstream::overwrite_existing_buffers ()
818 //read(overwrite_frame, disk_io_chunk_frames, false);
819 overwrite_queued = false;
820 pending_overwrite = false;
826 MidiDiskstream::seek (nframes_t frame, bool complete_refill)
828 Glib::Mutex::Lock lm (state_lock);
831 _playback_buf->reset();
832 _capture_buf->reset();
833 g_atomic_int_set(&_frames_read_from_ringbuffer, 0);
834 g_atomic_int_set(&_frames_written_to_ringbuffer, 0);
836 playback_sample = frame;
839 if (complete_refill) {
840 while ((ret = do_refill_with_alloc ()) > 0) ;
842 ret = do_refill_with_alloc ();
849 MidiDiskstream::can_internal_playback_seek (nframes_t distance)
851 uint32_t frames_read = g_atomic_int_get(&_frames_read_from_ringbuffer);
852 uint32_t frames_written = g_atomic_int_get(&_frames_written_to_ringbuffer);
853 return ((frames_written - frames_read) < distance);
857 MidiDiskstream::internal_playback_seek (nframes_t distance)
859 cerr << "MDS: internal_playback_seek " << distance << endl;
861 first_recordable_frame += distance;
862 playback_sample += distance;
867 /** @a start is set to the new frame position (TIME) read up to */
869 MidiDiskstream::read (nframes_t& start, nframes_t dur, bool reversed)
871 nframes_t this_read = 0;
873 nframes_t loop_end = 0;
874 nframes_t loop_start = 0;
875 nframes_t loop_length = 0;
879 /* Make the use of a Location atomic for this read operation.
881 Note: Locations don't get deleted, so all we care about
882 when I say "atomic" is that we are always pointing to
883 the same one and using a start/length values obtained
887 if ((loc = loop_location) != 0) {
888 loop_start = loc->start();
889 loop_end = loc->end();
890 loop_length = loop_end - loop_start;
893 /* if we are looping, ensure that the first frame we read is at the correct
894 position within the loop.
897 if (loc && (start >= loop_end)) {
898 //cerr << "start adjusted from " << start;
899 start = loop_start + ((start - loop_start) % loop_length);
900 //cerr << "to " << start << endl;
902 //cerr << "start is " << start << " loopstart: " << loop_start << " loopend: " << loop_end << endl;
907 /* take any loop into account. we can't read past the end of the loop. */
909 if (loc && (loop_end - start < dur)) {
910 this_read = loop_end - start;
911 //cerr << "reloop true: thisread: " << this_read << " dur: " << dur << endl;
918 if (this_read == 0) {
922 this_read = min(dur,this_read);
924 if (midi_playlist()->read (*_playback_buf, start, this_read) != this_read) {
925 error << string_compose(
926 _("MidiDiskstream %1: cannot read %2 from playlist at frame %3"),
927 _id, this_read, start) << endmsg;
931 //cout << "MDS this read " << this_read << " start = " << start << endl;
932 g_atomic_int_add(&_frames_written_to_ringbuffer, this_read);
934 _read_data_count = _playlist->read_data_count();
938 // Swap note ons with note offs here. etc?
939 // Fully reversing MIDI requires look-ahead (well, behind) to find previous
940 // CC values etc. hard.
944 /* if we read to the end of the loop, go back to the beginning */
947 // Synthesize LoopEvent here, because the next events
948 // written will have non-monotonic timestamps.
949 _playback_buf->write(loop_end - 1, LoopEventType, 0, 0);
950 //cout << "Pushing LoopEvent ts=" << loop_end-1
951 // << " start+this_read " << start+this_read << endl;
960 //offset += this_read;
967 MidiDiskstream::do_refill_with_alloc ()
973 MidiDiskstream::do_refill ()
976 size_t write_space = _playback_buf->write_space();
977 bool reversed = (_visible_speed * _session.transport_speed()) < 0.0f;
979 if (write_space == 0) {
987 /* at end: nothing to do */
988 if (file_frame == max_frames) {
992 // At this point we...
993 assert(_playback_buf->write_space() > 0); // ... have something to write to, and
994 assert(file_frame <= max_frames); // ... something to write
996 // now calculate how much time is in the ringbuffer.
997 // and lets write as much as we need to get this to be midi_readahead;
998 uint32_t frames_read = g_atomic_int_get(&_frames_read_from_ringbuffer);
999 uint32_t frames_written = g_atomic_int_get(&_frames_written_to_ringbuffer);
1000 if ((frames_written - frames_read) >= midi_readahead) {
1001 //cout << "MDS Nothing to do. all fine" << endl;
1005 nframes_t to_read = midi_readahead - (frames_written - frames_read);
1007 //cout << "MDS read for midi_readahead " << to_read << " rb_contains: "
1008 // << frames_written - frames_read << endl;
1010 to_read = min(to_read, (max_frames - file_frame));
1012 if (read (file_frame, to_read, reversed)) {
1019 /** Flush pending data to disk.
1021 * Important note: this function will write *AT MOST* disk_io_chunk_frames
1022 * of data to disk. it will never write more than that. If it writes that
1023 * much and there is more than that waiting to be written, it will return 1,
1024 * otherwise 0 on success or -1 on failure.
1026 * If there is less than disk_io_chunk_frames to be written, no data will be
1027 * written at all unless @a force_flush is true.
1030 MidiDiskstream::do_flush (RunContext context, bool force_flush)
1036 _write_data_count = 0;
1038 total = _session.transport_frame() - _last_flush_frame;
1040 if (_last_flush_frame > _session.transport_frame()
1041 || _last_flush_frame < capture_start_frame) {
1042 _last_flush_frame = _session.transport_frame();
1045 if (total == 0 || _capture_buf->read_space() == 0
1046 || (!force_flush && (total < disk_io_chunk_frames && was_recording))) {
1050 /* if there are 2+ chunks of disk i/o possible for
1051 this track, let the caller know so that it can arrange
1052 for us to be called again, ASAP.
1054 if we are forcing a flush, then if there is* any* extra
1055 work, let the caller know.
1057 if we are no longer recording and there is any extra work,
1058 let the caller know too.
1061 if (total >= 2 * disk_io_chunk_frames || ((force_flush || !was_recording) && total > disk_io_chunk_frames)) {
1065 to_write = disk_io_chunk_frames;
1067 assert(!destructive());
1069 if (record_enabled()
1070 && ( (_session.transport_frame() - _last_flush_frame > disk_io_chunk_frames)
1072 if ((!_write_source) || _write_source->midi_write (*_capture_buf, capture_start_frame, to_write) != to_write) {
1073 error << string_compose(_("MidiDiskstream %1: cannot write to disk"), _id) << endmsg;
1076 _last_flush_frame = _session.transport_frame();
1085 MidiDiskstream::transport_stopped (struct tm& when, time_t twhen, bool abort_capture)
1087 uint32_t buffer_position;
1088 bool more_work = true;
1090 boost::shared_ptr<MidiRegion> region;
1091 nframes_t total_capture;
1092 MidiRegion::SourceList srcs;
1093 MidiRegion::SourceList::iterator src;
1094 vector<CaptureInfo*>::iterator ci;
1095 bool mark_write_completed = false;
1097 finish_capture (true);
1099 /* butler is already stopped, but there may be work to do
1100 to flush remaining data to disk.
1103 while (more_work && !err) {
1104 switch (do_flush (TransportContext, true)) {
1111 error << string_compose(_("MidiDiskstream \"%1\": cannot flush captured data to disk!"), _name) << endmsg;
1116 /* XXX is there anything we can do if err != 0 ? */
1117 Glib::Mutex::Lock lm (capture_info_lock);
1119 if (capture_info.empty()) {
1123 if (abort_capture) {
1125 if (_write_source) {
1127 _write_source->mark_for_remove ();
1128 _write_source->drop_references ();
1129 _write_source.reset();
1132 /* new source set up in "out" below */
1136 assert(_write_source);
1138 for (total_capture = 0, ci = capture_info.begin(); ci != capture_info.end(); ++ci) {
1139 total_capture += (*ci)->frames;
1142 /* figure out the name for this take */
1144 srcs.push_back (_write_source);
1145 _write_source->set_timeline_position (capture_info.front()->start);
1146 _write_source->set_captured_for (_name);
1148 string whole_file_region_name;
1149 whole_file_region_name = region_name_from_path (_write_source->name(), true);
1151 /* Register a new region with the Session that
1152 describes the entire source. Do this first
1153 so that any sub-regions will obviously be
1154 children of this one (later!)
1158 boost::shared_ptr<Region> rx (RegionFactory::create (srcs, 0,
1159 total_capture, whole_file_region_name, 0,
1160 Region::Flag (Region::DefaultFlags|Region::Automatic|Region::WholeFile)));
1162 region = boost::dynamic_pointer_cast<MidiRegion> (rx);
1163 region->special_set_position (capture_info.front()->start);
1167 catch (failed_constructor& err) {
1168 error << string_compose(_("%1: could not create region for complete midi file"), _name) << endmsg;
1172 _last_capture_regions.push_back (region);
1174 // cerr << _name << ": there are " << capture_info.size() << " capture_info records\n";
1176 XMLNode &before = _playlist->get_state();
1177 _playlist->freeze ();
1179 for (buffer_position = 0, ci = capture_info.begin(); ci != capture_info.end(); ++ci) {
1183 _session.region_name (region_name, _write_source->name(), false);
1185 // cerr << _name << ": based on ci of " << (*ci)->start << " for " << (*ci)->frames << " add a region\n";
1188 boost::shared_ptr<Region> rx (RegionFactory::create (srcs, buffer_position, (*ci)->frames, region_name));
1189 region = boost::dynamic_pointer_cast<MidiRegion> (rx);
1192 catch (failed_constructor& err) {
1193 error << _("MidiDiskstream: could not create region for captured midi!") << endmsg;
1194 continue; /* XXX is this OK? */
1197 region->GoingAway.connect (bind (mem_fun (*this, &Diskstream::remove_region_from_last_capture), boost::weak_ptr<Region>(region)));
1199 _last_capture_regions.push_back (region);
1201 // cerr << "add new region, buffer position = " << buffer_position << " @ " << (*ci)->start << endl;
1203 i_am_the_modifier++;
1204 _playlist->add_region (region, (*ci)->start);
1205 i_am_the_modifier--;
1207 buffer_position += (*ci)->frames;
1211 XMLNode &after = _playlist->get_state();
1212 _session.add_command (new MementoCommand<Playlist>(*_playlist, &before, &after));
1216 mark_write_completed = true;
1218 reset_write_sources (mark_write_completed);
1220 for (ci = capture_info.begin(); ci != capture_info.end(); ++ci) {
1224 capture_info.clear ();
1225 capture_start_frame = 0;
1229 MidiDiskstream::transport_looped (nframes_t transport_frame)
1231 if (was_recording) {
1233 // adjust the capture length knowing that the data will be recorded to disk
1234 // only necessary after the first loop where we're recording
1235 if (capture_info.size() == 0) {
1236 capture_captured += _capture_offset;
1238 if (_alignment_style == ExistingMaterial) {
1239 capture_captured += _session.worst_output_latency();
1241 capture_captured += _roll_delay;
1245 finish_capture (true);
1247 // the next region will start recording via the normal mechanism
1248 // we'll set the start position to the current transport pos
1249 // no latency adjustment or capture offset needs to be made, as that already happened the first time
1250 capture_start_frame = transport_frame;
1251 first_recordable_frame = transport_frame; // mild lie
1252 last_recordable_frame = max_frames;
1253 was_recording = true;
1258 MidiDiskstream::finish_capture (bool rec_monitors_input)
1260 was_recording = false;
1262 if (capture_captured == 0) {
1266 // Why must we destroy?
1267 assert(!destructive());
1269 CaptureInfo* ci = new CaptureInfo;
1271 ci->start = capture_start_frame;
1272 ci->frames = capture_captured;
1274 /* XXX theoretical race condition here. Need atomic exchange ?
1275 However, the circumstances when this is called right
1276 now (either on record-disable or transport_stopped)
1277 mean that no actual race exists. I think ...
1278 We now have a capture_info_lock, but it is only to be used
1279 to synchronize in the transport_stop and the capture info
1280 accessors, so that invalidation will not occur (both non-realtime).
1283 // cerr << "Finish capture, add new CI, " << ci->start << '+' << ci->frames << endl;
1285 capture_info.push_back (ci);
1286 capture_captured = 0;
1290 MidiDiskstream::set_record_enabled (bool yn)
1292 if (!recordable() || !_session.record_enabling_legal()) {
1296 assert(!destructive());
1298 if (yn && _source_port == 0) {
1300 /* pick up connections not initiated *from* the IO object
1301 we're associated with.
1304 get_input_sources ();
1307 /* yes, i know that this not proof against race conditions, but its
1308 good enough. i think.
1311 if (record_enabled() != yn) {
1313 engage_record_enable ();
1315 disengage_record_enable ();
1321 MidiDiskstream::engage_record_enable ()
1323 bool rolling = _session.transport_speed() != 0.0f;
1325 g_atomic_int_set (&_record_enabled, 1);
1327 if (_source_port && Config->get_monitoring_model() == HardwareMonitoring) {
1328 _source_port->request_monitor_input (!(Config->get_auto_input() && rolling));
1331 // FIXME: Why is this necessary? Isn't needed for AudioDiskstream...
1333 use_new_write_source();
1335 _write_source->mark_streaming_midi_write_started (_note_mode, _session.transport_frame());
1337 RecordEnableChanged (); /* EMIT SIGNAL */
1341 MidiDiskstream::disengage_record_enable ()
1343 g_atomic_int_set (&_record_enabled, 0);
1344 if (_source_port && Config->get_monitoring_model() == HardwareMonitoring) {
1346 _source_port->request_monitor_input (false);
1350 RecordEnableChanged (); /* EMIT SIGNAL */
1354 MidiDiskstream::get_state ()
1356 XMLNode* node = new XMLNode ("MidiDiskstream");
1358 LocaleGuard lg (X_("POSIX"));
1360 snprintf (buf, sizeof(buf), "0x%x", _flags);
1361 node->add_property ("flags", buf);
1363 node->add_property("channel-mode", enum_2_string(get_channel_mode()));
1365 snprintf (buf, sizeof(buf), "0x%x", get_channel_mask());
1366 node->add_property("channel-mask", buf);
1368 node->add_property ("playlist", _playlist->name());
1370 snprintf (buf, sizeof(buf), "%f", _visible_speed);
1371 node->add_property ("speed", buf);
1373 node->add_property("name", _name);
1374 id().print(buf, sizeof(buf));
1375 node->add_property("id", buf);
1377 if (_write_source && _session.get_record_enabled()) {
1379 XMLNode* cs_child = new XMLNode (X_("CapturingSources"));
1380 XMLNode* cs_grandchild;
1382 cs_grandchild = new XMLNode (X_("file"));
1383 cs_grandchild->add_property (X_("path"), _write_source->path());
1384 cs_child->add_child_nocopy (*cs_grandchild);
1386 /* store the location where capture will start */
1390 if (Config->get_punch_in() && ((pi = _session.locations()->auto_punch_location()) != 0)) {
1391 snprintf (buf, sizeof (buf), "%" PRIu32, pi->start());
1393 snprintf (buf, sizeof (buf), "%" PRIu32, _session.transport_frame());
1396 cs_child->add_property (X_("at"), buf);
1397 node->add_child_nocopy (*cs_child);
1401 node->add_child_copy (*_extra_xml);
1408 MidiDiskstream::set_state (const XMLNode& node)
1410 const XMLProperty* prop;
1411 XMLNodeList nlist = node.children();
1412 XMLNodeIterator niter;
1413 uint32_t nchans = 1;
1414 XMLNode* capture_pending_node = 0;
1415 LocaleGuard lg (X_("POSIX"));
1417 in_set_state = true;
1419 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
1420 /*if ((*niter)->name() == IO::state_node_name) {
1421 deprecated_io_node = new XMLNode (**niter);
1423 assert ((*niter)->name() != IO::state_node_name);
1425 if ((*niter)->name() == X_("CapturingSources")) {
1426 capture_pending_node = *niter;
1430 /* prevent write sources from being created */
1432 in_set_state = true;
1434 if ((prop = node.property ("name")) != 0) {
1435 _name = prop->value();
1438 if ((prop = node.property ("id")) != 0) {
1439 _id = prop->value ();
1442 if ((prop = node.property ("flags")) != 0) {
1443 _flags = Flag (string_2_enum (prop->value(), _flags));
1446 ChannelMode channel_mode = AllChannels;
1447 if ((prop = node.property ("channel-mode")) != 0) {
1448 channel_mode = ChannelMode (string_2_enum(prop->value(), channel_mode));
1451 unsigned int channel_mask = 0xFFFF;
1452 if ((prop = node.property ("channel-mask")) != 0) {
1453 sscanf (prop->value().c_str(), "0x%x", &channel_mask);
1454 if (channel_mask & (~0xFFFF)) {
1455 warning << _("MidiDiskstream: XML property channel-mask out of range") << endmsg;
1459 set_channel_mode(channel_mode, channel_mask);
1461 if ((prop = node.property ("channels")) != 0) {
1462 nchans = atoi (prop->value().c_str());
1465 if ((prop = node.property ("playlist")) == 0) {
1470 bool had_playlist = (_playlist != 0);
1472 if (find_and_use_playlist (prop->value())) {
1476 if (!had_playlist) {
1477 _playlist->set_orig_diskstream_id (_id);
1480 if (capture_pending_node) {
1481 use_pending_capture_data (*capture_pending_node);
1486 if ((prop = node.property ("speed")) != 0) {
1487 double sp = atof (prop->value().c_str());
1489 if (realtime_set_speed (sp, false)) {
1490 non_realtime_set_speed ();
1494 in_set_state = false;
1496 /* make sure this is clear before we do anything else */
1499 //_capturing_source = 0;
1501 /* write sources are handled when we handle the input set
1502 up of the IO that owns this DS (::non_realtime_input_change())
1505 in_set_state = false;
1511 MidiDiskstream::use_new_write_source (uint32_t n)
1513 if (!recordable()) {
1519 if (_write_source) {
1521 if (_write_source->is_empty ()) {
1522 _write_source->mark_for_remove ();
1523 _write_source.reset();
1525 _write_source.reset();
1530 _write_source = boost::dynamic_pointer_cast<SMFSource>(_session.create_midi_source_for_session (*this));
1531 if (!_write_source) {
1532 throw failed_constructor();
1536 catch (failed_constructor &err) {
1537 error << string_compose (_("%1:%2 new capture file not initialized correctly"), _name, n) << endmsg;
1538 _write_source.reset();
1542 _write_source->set_allow_remove_if_empty (true);
1548 MidiDiskstream::reset_write_sources (bool mark_write_complete, bool force)
1550 if (!recordable()) {
1554 if (_write_source && mark_write_complete) {
1555 _write_source->mark_streaming_write_completed ();
1558 use_new_write_source (0);
1560 if (record_enabled()) {
1561 //_capturing_sources.push_back (_write_source);
1566 MidiDiskstream::rename_write_sources ()
1568 if (_write_source != 0) {
1569 _write_source->set_source_name (_name, destructive());
1570 /* XXX what to do if this fails ? */
1576 MidiDiskstream::set_block_size (nframes_t nframes)
1581 MidiDiskstream::allocate_temporary_buffers ()
1586 MidiDiskstream::monitor_input (bool yn)
1589 _source_port->ensure_monitor_input (yn);
1593 MidiDiskstream::set_align_style_from_io ()
1595 bool have_physical = false;
1601 get_input_sources ();
1603 if (_source_port && _source_port->flags() & JackPortIsPhysical) {
1604 have_physical = true;
1607 if (have_physical) {
1608 set_align_style (ExistingMaterial);
1610 set_align_style (CaptureTime);
1616 MidiDiskstream::playback_buffer_load () const
1618 return (float) ((double) _playback_buf->read_space()/
1619 (double) _playback_buf->capacity());
1623 MidiDiskstream::capture_buffer_load () const
1625 return (float) ((double) _capture_buf->write_space()/
1626 (double) _capture_buf->capacity());
1630 MidiDiskstream::use_pending_capture_data (XMLNode& node)
1635 /** Writes playback events in the given range to \a dst, translating time stamps
1636 * so that an event at \a start has time = 0
1639 MidiDiskstream::get_playback (MidiBuffer& dst, nframes_t start, nframes_t end)
1642 assert(dst.size() == 0);
1644 // Reverse. ... We just don't do reverse, ok? Back off.
1649 // Check only events added this offset cycle
1650 MidiBuffer::iterator this_cycle_start = dst.end();
1652 // Translates stamps to be relative to start
1654 _playback_buf->read(dst, start, end);
1656 const size_t events_read = _playback_buf->read(dst, start, end);
1657 cout << "MDS events read = " << events_read
1658 << " start = " << start << " end = " << end
1659 << " readspace " << _playback_buf->read_space()
1660 << " writespace " << _playback_buf->write_space() << endl;
1663 gint32 frames_read = end - start;
1664 g_atomic_int_add(&_frames_read_from_ringbuffer, frames_read);
1666 // Feed the data through the MidiStateTracker
1667 // If it detects a LoopEvent it will add necessary note offs
1668 if (_midi_state_tracker.track(this_cycle_start, dst.end())) {
1669 _midi_state_tracker.resolve_notes(dst, end-start - 1);