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>
33 #include "pbd/xml++.h"
34 #include "pbd/pthread_utils.h"
35 #include "pbd/basename.h"
37 #include "ardour/audioengine.h"
38 #include "ardour/debug.h"
39 #include "ardour/midi_model.h"
40 #include "ardour/midi_ring_buffer.h"
41 #include "ardour/midi_state_tracker.h"
42 #include "ardour/midi_source.h"
43 #include "ardour/session.h"
44 #include "ardour/session_directory.h"
45 #include "ardour/source_factory.h"
46 #include "ardour/tempo.h"
51 using namespace ARDOUR;
54 PBD::Signal1<void,MidiSource*> MidiSource::MidiSourceCreated;
56 MidiSource::MidiSource (Session& s, string name, Source::Flag flags)
57 : Source(s, DataType::MIDI, name, flags)
59 , _model_iter_valid(false)
66 MidiSource::MidiSource (Session& s, const XMLNode& node)
69 , _model_iter_valid(false)
74 if (set_state (node, Stateful::loading_state_version)) {
75 throw failed_constructor();
80 MidiSource::~MidiSource ()
85 MidiSource::get_state ()
87 XMLNode& node (Source::get_state());
89 if (_captured_for.length()) {
90 node.add_property ("captured-for", _captured_for);
93 for (InterpolationStyleMap::const_iterator i = _interpolation_style.begin(); i != _interpolation_style.end(); ++i) {
94 XMLNode* child = node.add_child (X_("InterpolationStyle"));
95 child->add_property (X_("parameter"), EventTypeMap::instance().to_symbol (i->first));
96 child->add_property (X_("style"), enum_2_string (i->second));
99 for (AutomationStateMap::const_iterator i = _automation_state.begin(); i != _automation_state.end(); ++i) {
100 XMLNode* child = node.add_child (X_("AutomationState"));
101 child->add_property (X_("parameter"), EventTypeMap::instance().to_symbol (i->first));
102 child->add_property (X_("state"), enum_2_string (i->second));
109 MidiSource::set_state (const XMLNode& node, int /*version*/)
111 const XMLProperty* prop;
113 if ((prop = node.property ("captured-for")) != 0) {
114 _captured_for = prop->value();
117 XMLNodeList children = node.children ();
118 for (XMLNodeConstIterator i = children.begin(); i != children.end(); ++i) {
119 if ((*i)->name() == X_("InterpolationStyle")) {
122 if ((prop = (*i)->property (X_("parameter"))) == 0) {
123 error << _("Missing parameter property on InterpolationStyle") << endmsg;
127 Evoral::Parameter p = EventTypeMap::instance().new_parameter (prop->value());
129 if ((prop = (*i)->property (X_("style"))) == 0) {
130 error << _("Missing style property on InterpolationStyle") << endmsg;
134 Evoral::ControlList::InterpolationStyle s = static_cast<Evoral::ControlList::InterpolationStyle> (string_2_enum (prop->value(), s));
135 set_interpolation_of (p, s);
137 } else if ((*i)->name() == X_("AutomationState")) {
141 if ((prop = (*i)->property (X_("parameter"))) == 0) {
142 error << _("Missing parameter property on AutomationState") << endmsg;
146 Evoral::Parameter p = EventTypeMap::instance().new_parameter (prop->value());
148 if ((prop = (*i)->property (X_("state"))) == 0) {
149 error << _("Missing state property on AutomationState") << endmsg;
153 AutoState s = static_cast<AutoState> (string_2_enum (prop->value(), s));
154 set_automation_state_of (p, s);
162 MidiSource::empty () const
164 return _length_beats == 0;
168 MidiSource::length (framepos_t pos) const
170 if (_length_beats == 0) {
174 BeatsFramesConverter converter(_session.tempo_map(), pos);
175 return converter.to(_length_beats);
179 MidiSource::update_length (framepos_t /*pos*/, framecnt_t /*cnt*/)
181 // You're not the boss of me!
185 MidiSource::invalidate ()
187 _model_iter_valid = false;
188 _model_iter.invalidate();
191 /** @param filtered A set of parameters whose MIDI messages will not be returned */
193 MidiSource::midi_read (Evoral::EventSink<framepos_t>& dst, framepos_t source_start,
194 framepos_t start, framecnt_t cnt,
195 MidiStateTracker* tracker,
196 std::set<Evoral::Parameter> const & filtered) const
198 Glib::Mutex::Lock lm (_lock);
200 BeatsFramesConverter converter(_session.tempo_map(), source_start);
202 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("MidiSource::midi-read() sstart %1 start %2 cnt %3 tracker %4\n",
203 source_start, start, cnt, tracker));
206 Evoral::Sequence<double>::const_iterator& i = _model_iter;
208 // If the cached iterator is invalid, search for the first event past start
209 if (_last_read_end == 0 || start != _last_read_end || !_model_iter_valid) {
210 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("*** %1 search for relevant iterator for %1 / %2\n", _name, source_start, start));
211 for (i = _model->begin(0, false, filtered); i != _model->end(); ++i) {
212 if (converter.to(i->time()) >= start) {
216 _model_iter_valid = true;
218 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("*** %1 use cachediterator for %1 / %2\n", _name, source_start, start));
221 _last_read_end = start + cnt;
223 // Read events up to end
224 for (; i != _model->end(); ++i) {
225 const framecnt_t time_frames = converter.to(i->time());
226 if (time_frames < start + cnt) {
227 /* convert event times to session frames by adding on the source start position in session frames */
228 dst.write (time_frames + source_start, i->event_type(), i->size(), i->buffer());
230 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("%1: add event @ %2 type %3 size = %4\n",
231 _name, time_frames + source_start, i->event_type(), i->size()));
234 Evoral::MIDIEvent<Evoral::MusicalTime>& ev (*(Evoral::MIDIEvent<Evoral::MusicalTime>*) (&(*i)));
235 if (ev.is_note_on()) {
236 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()));
237 tracker->add (ev.note(), ev.channel());
238 } else if (ev.is_note_off()) {
239 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("\t%1 track note off %2 @ %3\n", _name, (int) ev.note(), time_frames));
240 tracker->remove (ev.note(), ev.channel());
244 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("%1: reached end with event @ %2 vs. %3\n",
245 _name, time_frames, start+cnt));
251 return read_unlocked (dst, source_start, start, cnt, tracker);
255 /** Write data from a MidiRingBuffer to this source.
256 * @param source Source to read from.
257 * @param source_start This source's start position in session frames.
260 MidiSource::midi_write (MidiRingBuffer<framepos_t>& source, framepos_t source_start, framecnt_t duration)
262 Glib::Mutex::Lock lm (_lock);
264 const framecnt_t ret = write_unlocked (source, source_start, duration);
266 if (duration == max_framecnt) {
269 _last_write_end += duration;
276 MidiSource::mark_streaming_midi_write_started (NoteMode mode)
279 _model->set_note_mode (mode);
280 _model->start_write ();
287 MidiSource::mark_write_starting_now ()
289 /* I'm not sure if this is the best way to approach this, but
290 _last_write_end needs to be set up with the transport frame
291 when a record actually starts, as it is used by
292 SMFSource::write_unlocked to decide whether incoming notes
293 are within the correct time range.
294 mark_streaming_midi_write_started (perhaps a more logical
295 place to do this) is not called at exactly the time when
296 record starts, and I don't think it necessarily can be
297 because it is not RT-safe.
300 set_timeline_position (_session.transport_frame ());
301 _last_write_end = _session.transport_frame ();
302 cerr << name() << " last write set to " << _last_write_end << endl;
307 MidiSource::mark_streaming_write_started ()
309 NoteMode note_mode = _model ? _model->note_mode() : Sustained;
310 mark_streaming_midi_write_started (note_mode);
314 MidiSource::mark_midi_streaming_write_completed (Evoral::Sequence<Evoral::MusicalTime>::StuckNoteOption option, Evoral::MusicalTime end)
317 _model->end_write (option, end);
324 MidiSource::mark_streaming_write_completed ()
326 mark_midi_streaming_write_completed (Evoral::Sequence<Evoral::MusicalTime>::DeleteStuckNotes);
329 boost::shared_ptr<MidiSource>
330 MidiSource::clone (Evoral::MusicalTime begin, Evoral::MusicalTime end)
332 string newname = PBD::basename_nosuffix(_name.val());
335 /* get a new name for the MIDI file we're going to write to
340 newname = bump_name_once (newname, '-');
341 /* XXX build path safely */
342 newpath = _session.session_directory().midi_path().to_string() +"/"+ newname + ".mid";
344 } while (Glib::file_test (newpath, Glib::FILE_TEST_EXISTS));
346 boost::shared_ptr<MidiSource> newsrc = boost::dynamic_pointer_cast<MidiSource>(
347 SourceFactory::createWritable(DataType::MIDI, _session,
348 newpath, string(), false, _session.frame_rate()));
350 newsrc->set_timeline_position(_timeline_position);
351 newsrc->copy_interpolation_from (this);
352 newsrc->copy_automation_state_from (this);
355 if (begin == Evoral::MinMusicalTime && end == Evoral::MaxMusicalTime) {
356 _model->write_to (newsrc);
358 _model->write_section_to (newsrc, begin, end);
361 error << string_compose (_("programming error: %1"), X_("no model for MidiSource during ::clone()"));
362 return boost::shared_ptr<MidiSource>();
365 newsrc->flush_midi();
367 /* force a reload of the model if the range is partial */
369 if (begin != Evoral::MinMusicalTime || end != Evoral::MaxMusicalTime) {
370 newsrc->load_model (true, true);
372 newsrc->set_model (_model);
379 MidiSource::session_saved()
381 /* this writes a copy of the data to disk.
382 XXX do we need to do this every time?
385 if (_model && _model->edited()) {
387 // if the model is edited, write its contents into
388 // the current source file (overwiting previous contents.
390 /* temporarily drop our reference to the model so that
391 as the model pushes its current state to us, we don't
395 boost::shared_ptr<MidiModel> mm = _model;
398 /* flush model contents to disk
401 mm->sync_to_source ();
403 /* reacquire model */
413 MidiSource::set_note_mode(NoteMode mode)
416 _model->set_note_mode(mode);
421 MidiSource::drop_model ()
424 ModelChanged (); /* EMIT SIGNAL */
428 MidiSource::set_model (boost::shared_ptr<MidiModel> m)
431 ModelChanged (); /* EMIT SIGNAL */
434 /** @return Interpolation style that should be used for control parameter \a p */
435 Evoral::ControlList::InterpolationStyle
436 MidiSource::interpolation_of (Evoral::Parameter p) const
438 InterpolationStyleMap::const_iterator i = _interpolation_style.find (p);
439 if (i == _interpolation_style.end()) {
440 return EventTypeMap::instance().interpolation_of (p);
447 MidiSource::automation_state_of (Evoral::Parameter p) const
449 AutomationStateMap::const_iterator i = _automation_state.find (p);
450 if (i == _automation_state.end()) {
451 /* default to `play', otherwise if MIDI is recorded /
452 imported with controllers etc. they are by default
453 not played back, which is a little surprising.
461 /** Set interpolation style to be used for a given parameter. This change will be
462 * propagated to anyone who needs to know.
465 MidiSource::set_interpolation_of (Evoral::Parameter p, Evoral::ControlList::InterpolationStyle s)
467 if (interpolation_of (p) == s) {
471 if (EventTypeMap::instance().interpolation_of (p) == s) {
472 /* interpolation type is being set to the default, so we don't need a note in our map */
473 _interpolation_style.erase (p);
475 _interpolation_style[p] = s;
478 InterpolationChanged (p, s); /* EMIT SIGNAL */
482 MidiSource::set_automation_state_of (Evoral::Parameter p, AutoState s)
484 if (automation_state_of (p) == s) {
489 /* automation state is being set to the default, so we don't need a note in our map */
490 _automation_state.erase (p);
492 _automation_state[p] = s;
495 AutomationStateChanged (p, s); /* EMIT SIGNAL */
499 MidiSource::copy_interpolation_from (boost::shared_ptr<MidiSource> s)
501 copy_interpolation_from (s.get ());
505 MidiSource::copy_automation_state_from (boost::shared_ptr<MidiSource> s)
507 copy_automation_state_from (s.get ());
511 MidiSource::copy_interpolation_from (MidiSource* s)
513 _interpolation_style = s->_interpolation_style;
515 /* XXX: should probably emit signals here */
519 MidiSource::copy_automation_state_from (MidiSource* s)
521 _automation_state = s->_automation_state;
523 /* XXX: should probably emit signals here */