2 Copyright (C) 2006 Paul Davis
3 Author: David Robillard
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
31 #include <glibmm/fileutils.h>
32 #include <glibmm/miscutils.h>
34 #include "pbd/xml++.h"
35 #include "pbd/pthread_utils.h"
36 #include "pbd/basename.h"
38 #include "ardour/debug.h"
39 #include "ardour/midi_model.h"
40 #include "ardour/midi_state_tracker.h"
41 #include "ardour/midi_source.h"
42 #include "ardour/file_source.h"
43 #include "ardour/session.h"
44 #include "ardour/session_directory.h"
45 #include "ardour/source_factory.h"
49 namespace ARDOUR { template <typename T> class MidiRingBuffer; }
52 using namespace ARDOUR;
55 PBD::Signal1<void,MidiSource*> MidiSource::MidiSourceCreated;
57 MidiSource::MidiSource (Session& s, string name, Source::Flag flags)
58 : Source(s, DataType::MIDI, name, flags)
60 , _model_iter_valid(false)
64 , _capture_loop_length(0)
68 MidiSource::MidiSource (Session& s, const XMLNode& node)
71 , _model_iter_valid(false)
75 , _capture_loop_length(0)
77 if (set_state (node, Stateful::loading_state_version)) {
78 throw failed_constructor();
83 MidiSource::~MidiSource ()
88 MidiSource::get_state ()
90 XMLNode& node (Source::get_state());
92 if (_captured_for.length()) {
93 node.add_property ("captured-for", _captured_for);
96 for (InterpolationStyleMap::const_iterator i = _interpolation_style.begin(); i != _interpolation_style.end(); ++i) {
97 XMLNode* child = node.add_child (X_("InterpolationStyle"));
98 child->add_property (X_("parameter"), EventTypeMap::instance().to_symbol (i->first));
99 child->add_property (X_("style"), enum_2_string (i->second));
102 for (AutomationStateMap::const_iterator i = _automation_state.begin(); i != _automation_state.end(); ++i) {
103 XMLNode* child = node.add_child (X_("AutomationState"));
104 child->add_property (X_("parameter"), EventTypeMap::instance().to_symbol (i->first));
105 child->add_property (X_("state"), enum_2_string (i->second));
112 MidiSource::set_state (const XMLNode& node, int /*version*/)
114 const XMLProperty* prop;
116 if ((prop = node.property ("captured-for")) != 0) {
117 _captured_for = prop->value();
120 XMLNodeList children = node.children ();
121 for (XMLNodeConstIterator i = children.begin(); i != children.end(); ++i) {
122 if ((*i)->name() == X_("InterpolationStyle")) {
125 if ((prop = (*i)->property (X_("parameter"))) == 0) {
126 error << _("Missing parameter property on InterpolationStyle") << endmsg;
130 Evoral::Parameter p = EventTypeMap::instance().new_parameter (prop->value());
132 if ((prop = (*i)->property (X_("style"))) == 0) {
133 error << _("Missing style property on InterpolationStyle") << endmsg;
137 Evoral::ControlList::InterpolationStyle s = static_cast<Evoral::ControlList::InterpolationStyle> (string_2_enum (prop->value(), s));
138 set_interpolation_of (p, s);
140 } else if ((*i)->name() == X_("AutomationState")) {
144 if ((prop = (*i)->property (X_("parameter"))) == 0) {
145 error << _("Missing parameter property on AutomationState") << endmsg;
149 Evoral::Parameter p = EventTypeMap::instance().new_parameter (prop->value());
151 if ((prop = (*i)->property (X_("state"))) == 0) {
152 error << _("Missing state property on AutomationState") << endmsg;
156 AutoState s = static_cast<AutoState> (string_2_enum (prop->value(), s));
157 set_automation_state_of (p, s);
165 MidiSource::empty () const
167 return _length_beats == 0;
171 MidiSource::length (framepos_t pos) const
173 if (_length_beats == 0) {
177 BeatsFramesConverter converter(_session.tempo_map(), pos);
178 return converter.to(_length_beats);
182 MidiSource::update_length (framecnt_t)
184 // You're not the boss of me!
188 MidiSource::invalidate ()
190 _model_iter_valid = false;
191 _model_iter.invalidate();
194 /** @param filtered A set of parameters whose MIDI messages will not be returned */
196 MidiSource::midi_read (Evoral::EventSink<framepos_t>& dst, framepos_t source_start,
197 framepos_t start, framecnt_t cnt,
198 MidiStateTracker* tracker,
199 std::set<Evoral::Parameter> const & filtered) const
201 Glib::Threads::Mutex::Lock lm (_lock);
203 BeatsFramesConverter converter(_session.tempo_map(), source_start);
205 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("MidiSource::midi-read() %5 sstart %1 start %2 cnt %3 tracker %4\n",
206 source_start, start, cnt, tracker, name()));
209 Evoral::Sequence<double>::const_iterator& i = _model_iter;
211 // If the cached iterator is invalid, search for the first event past start
212 if (_last_read_end == 0 || start != _last_read_end || !_model_iter_valid) {
213 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("*** %1 search for relevant iterator for %1 / %2\n", _name, source_start, start));
214 for (i = _model->begin(0, false, filtered); i != _model->end(); ++i) {
215 if (converter.to(i->time()) >= start) {
216 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("***\tstop iterator search @ %1\n", i->time()));
220 _model_iter_valid = true;
222 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("*** %1 use cachediterator for %1 / %2\n", _name, source_start, start));
225 _last_read_end = start + cnt;
227 // Read events up to end
228 for (; i != _model->end(); ++i) {
229 const framecnt_t time_frames = converter.to(i->time());
230 if (time_frames < start + cnt) {
231 /* convert event times to session frames by adding on the source start position in session frames */
232 dst.write (time_frames + source_start, i->event_type(), i->size(), i->buffer());
234 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("%1: add event @ %2 type %3 size = %4\n",
235 _name, time_frames + source_start, i->event_type(), i->size()));
238 Evoral::MIDIEvent<Evoral::MusicalTime>& ev (*(reinterpret_cast<Evoral::MIDIEvent<Evoral::MusicalTime>*>
239 (const_cast<Evoral::Event<Evoral::MusicalTime>*> (&(*i)))));
240 if (ev.is_note_on()) {
241 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("\t%1 track note on %2 @ %3 velocity %4\n", _name, (int) ev.note(), time_frames, (int) ev.velocity()));
242 tracker->add (ev.note(), ev.channel());
243 } else if (ev.is_note_off()) {
244 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("\t%1 track note off %2 @ %3\n", _name, (int) ev.note(), time_frames));
245 tracker->remove (ev.note(), ev.channel());
249 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("%1: reached end with event @ %2 vs. %3\n",
250 _name, time_frames, start+cnt));
256 return read_unlocked (dst, source_start, start, cnt, tracker);
261 MidiSource::midi_write (MidiRingBuffer<framepos_t>& source,
262 framepos_t source_start,
265 Glib::Threads::Mutex::Lock lm (_lock);
267 const framecnt_t ret = write_unlocked (source, source_start, cnt);
269 if (cnt == max_framecnt) {
272 _capture_length += cnt;
279 MidiSource::mark_streaming_midi_write_started (NoteMode mode)
282 _model->set_note_mode (mode);
283 _model->start_write ();
290 MidiSource::mark_write_starting_now (framecnt_t position,
291 framecnt_t capture_length,
292 framecnt_t loop_length)
294 /* I'm not sure if this is the best way to approach this, but
295 _capture_length needs to be set up with the transport frame
296 when a record actually starts, as it is used by
297 SMFSource::write_unlocked to decide whether incoming notes
298 are within the correct time range.
299 mark_streaming_midi_write_started (perhaps a more logical
300 place to do this) is not called at exactly the time when
301 record starts, and I don't think it necessarily can be
302 because it is not RT-safe.
305 set_timeline_position(position);
306 _capture_length = capture_length;
307 _capture_loop_length = loop_length;
309 BeatsFramesConverter converter(_session.tempo_map(), position);
310 _length_beats = converter.from(capture_length);
314 MidiSource::mark_streaming_write_started ()
316 NoteMode note_mode = _model ? _model->note_mode() : Sustained;
317 mark_streaming_midi_write_started (note_mode);
321 MidiSource::mark_midi_streaming_write_completed (Evoral::Sequence<Evoral::MusicalTime>::StuckNoteOption option, Evoral::MusicalTime end)
324 _model->end_write (option, end);
331 MidiSource::mark_streaming_write_completed ()
333 mark_midi_streaming_write_completed (Evoral::Sequence<Evoral::MusicalTime>::DeleteStuckNotes);
337 MidiSource::write_to (boost::shared_ptr<MidiSource> newsrc, Evoral::MusicalTime begin, Evoral::MusicalTime end)
339 newsrc->set_timeline_position(_timeline_position);
340 newsrc->copy_interpolation_from (this);
341 newsrc->copy_automation_state_from (this);
344 if (begin == Evoral::MinMusicalTime && end == Evoral::MaxMusicalTime) {
345 _model->write_to (newsrc);
347 _model->write_section_to (newsrc, begin, end);
350 error << string_compose (_("programming error: %1"), X_("no model for MidiSource during ::clone()"));
354 newsrc->flush_midi();
356 /* force a reload of the model if the range is partial */
358 if (begin != Evoral::MinMusicalTime || end != Evoral::MaxMusicalTime) {
359 newsrc->load_model (true, true);
361 newsrc->set_model (_model);
364 /* this file is not removable (but since it is MIDI, it is mutable) */
366 boost::dynamic_pointer_cast<FileSource> (newsrc)->prevent_deletion ();
372 MidiSource::session_saved()
374 /* this writes a copy of the data to disk.
375 XXX do we need to do this every time?
378 if (_model && _model->edited()) {
380 // if the model is edited, write its contents into
381 // the current source file (overwiting previous contents.
383 /* temporarily drop our reference to the model so that
384 as the model pushes its current state to us, we don't
388 boost::shared_ptr<MidiModel> mm = _model;
391 /* flush model contents to disk
394 mm->sync_to_source ();
396 /* reacquire model */
406 MidiSource::set_note_mode(NoteMode mode)
409 _model->set_note_mode(mode);
414 MidiSource::drop_model ()
417 ModelChanged (); /* EMIT SIGNAL */
421 MidiSource::set_model (boost::shared_ptr<MidiModel> m)
424 ModelChanged (); /* EMIT SIGNAL */
427 /** @return Interpolation style that should be used for control parameter \a p */
428 Evoral::ControlList::InterpolationStyle
429 MidiSource::interpolation_of (Evoral::Parameter p) const
431 InterpolationStyleMap::const_iterator i = _interpolation_style.find (p);
432 if (i == _interpolation_style.end()) {
433 return EventTypeMap::instance().interpolation_of (p);
440 MidiSource::automation_state_of (Evoral::Parameter p) const
442 AutomationStateMap::const_iterator i = _automation_state.find (p);
443 if (i == _automation_state.end()) {
444 /* default to `play', otherwise if MIDI is recorded /
445 imported with controllers etc. they are by default
446 not played back, which is a little surprising.
454 /** Set interpolation style to be used for a given parameter. This change will be
455 * propagated to anyone who needs to know.
458 MidiSource::set_interpolation_of (Evoral::Parameter p, Evoral::ControlList::InterpolationStyle s)
460 if (interpolation_of (p) == s) {
464 if (EventTypeMap::instance().interpolation_of (p) == s) {
465 /* interpolation type is being set to the default, so we don't need a note in our map */
466 _interpolation_style.erase (p);
468 _interpolation_style[p] = s;
471 InterpolationChanged (p, s); /* EMIT SIGNAL */
475 MidiSource::set_automation_state_of (Evoral::Parameter p, AutoState s)
477 if (automation_state_of (p) == s) {
482 /* automation state is being set to the default, so we don't need a note in our map */
483 _automation_state.erase (p);
485 _automation_state[p] = s;
488 AutomationStateChanged (p, s); /* EMIT SIGNAL */
492 MidiSource::copy_interpolation_from (boost::shared_ptr<MidiSource> s)
494 copy_interpolation_from (s.get ());
498 MidiSource::copy_automation_state_from (boost::shared_ptr<MidiSource> s)
500 copy_automation_state_from (s.get ());
504 MidiSource::copy_interpolation_from (MidiSource* s)
506 _interpolation_style = s->_interpolation_style;
508 /* XXX: should probably emit signals here */
512 MidiSource::copy_automation_state_from (MidiSource* s)
514 _automation_state = s->_automation_state;
516 /* XXX: should probably emit signals here */