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.
30 #include <glibmm/fileutils.h>
31 #include <glibmm/miscutils.h>
33 #include "pbd/xml++.h"
34 #include "pbd/pthread_utils.h"
35 #include "pbd/basename.h"
37 #include "evoral/Control.hpp"
38 #include "evoral/EventSink.hpp"
40 #include "ardour/debug.h"
41 #include "ardour/file_source.h"
42 #include "ardour/midi_channel_filter.h"
43 #include "ardour/midi_model.h"
44 #include "ardour/midi_source.h"
45 #include "ardour/midi_state_tracker.h"
46 #include "ardour/session.h"
47 #include "ardour/session_directory.h"
48 #include "ardour/source_factory.h"
52 namespace ARDOUR { template <typename T> class MidiRingBuffer; }
55 using namespace ARDOUR;
58 PBD::Signal1<void,MidiSource*> MidiSource::MidiSourceCreated;
60 MidiSource::MidiSource (Session& s, string name, Source::Flag flags)
61 : Source(s, DataType::MIDI, name, flags)
63 , _model_iter_valid(false)
67 , _capture_loop_length(0)
71 MidiSource::MidiSource (Session& s, const XMLNode& node)
74 , _model_iter_valid(false)
78 , _capture_loop_length(0)
80 if (set_state (node, Stateful::loading_state_version)) {
81 throw failed_constructor();
85 MidiSource::~MidiSource ()
90 MidiSource::get_state ()
92 XMLNode& node (Source::get_state());
94 if (_captured_for.length()) {
95 node.add_property ("captured-for", _captured_for);
98 for (InterpolationStyleMap::const_iterator i = _interpolation_style.begin(); i != _interpolation_style.end(); ++i) {
99 XMLNode* child = node.add_child (X_("InterpolationStyle"));
100 child->add_property (X_("parameter"), EventTypeMap::instance().to_symbol (i->first));
101 child->add_property (X_("style"), enum_2_string (i->second));
104 for (AutomationStateMap::const_iterator i = _automation_state.begin(); i != _automation_state.end(); ++i) {
105 XMLNode* child = node.add_child (X_("AutomationState"));
106 child->add_property (X_("parameter"), EventTypeMap::instance().to_symbol (i->first));
107 child->add_property (X_("state"), enum_2_string (i->second));
114 MidiSource::set_state (const XMLNode& node, int /*version*/)
116 XMLProperty const * prop;
117 if ((prop = node.property ("captured-for")) != 0) {
118 _captured_for = prop->value();
121 XMLNodeList children = node.children ();
122 for (XMLNodeConstIterator i = children.begin(); i != children.end(); ++i) {
123 if ((*i)->name() == X_("InterpolationStyle")) {
124 if ((prop = (*i)->property (X_("parameter"))) == 0) {
125 error << _("Missing parameter property on InterpolationStyle") << endmsg;
128 Evoral::Parameter p = EventTypeMap::instance().from_symbol (prop->value());
130 if ((prop = (*i)->property (X_("style"))) == 0) {
131 error << _("Missing style property on InterpolationStyle") << endmsg;
134 Evoral::ControlList::InterpolationStyle s = static_cast<Evoral::ControlList::InterpolationStyle>(
135 string_2_enum (prop->value(), s));
136 set_interpolation_of (p, s);
138 } else if ((*i)->name() == X_("AutomationState")) {
139 if ((prop = (*i)->property (X_("parameter"))) == 0) {
140 error << _("Missing parameter property on AutomationState") << endmsg;
143 Evoral::Parameter p = EventTypeMap::instance().from_symbol (prop->value());
145 if ((prop = (*i)->property (X_("state"))) == 0) {
146 error << _("Missing state property on AutomationState") << endmsg;
149 AutoState s = static_cast<AutoState> (string_2_enum (prop->value(), s));
150 set_automation_state_of (p, s);
158 MidiSource::empty () const
160 return !_length_beats;
164 MidiSource::length (framepos_t pos) const
166 if (!_length_beats) {
170 BeatsFramesConverter converter(_session.tempo_map(), pos);
171 return converter.to(_length_beats);
175 MidiSource::update_length (framecnt_t)
177 // You're not the boss of me!
181 MidiSource::invalidate (const Lock& lock, std::set<Evoral::Sequence<Evoral::Beats>::WeakNotePtr>* notes)
183 _model_iter_valid = false;
184 _model_iter.invalidate(notes);
188 MidiSource::midi_read (const Lock& lm,
189 Evoral::EventSink<framepos_t>& dst,
190 framepos_t source_start,
193 MidiStateTracker* tracker,
194 MidiChannelFilter* filter,
195 const std::set<Evoral::Parameter>& filtered) const
197 BeatsFramesConverter converter(_session.tempo_map(), source_start);
199 DEBUG_TRACE (DEBUG::MidiSourceIO,
200 string_compose ("MidiSource::midi_read() %5 sstart %1 start %2 cnt %3 tracker %4\n",
201 source_start, start, cnt, tracker, name()));
204 // Find appropriate model iterator
205 Evoral::Sequence<Evoral::Beats>::const_iterator& i = _model_iter;
206 const bool linear_read = _last_read_end != 0 && start == _last_read_end;
207 if (!linear_read || !_model_iter_valid) {
209 // Cached iterator is invalid, search for the first event past start
210 i = _model->begin(converter.from(start), false, filtered,
211 linear_read ? &_model->active_notes() : NULL);
212 _model_iter_valid = true;
214 _model->active_notes().clear();
217 /* hot-fix http://tracker.ardour.org/view.php?id=6541
218 * "parallel playback of linked midi regions -> no note-offs"
220 * A midi source can be used by multiple tracks simultaneously,
221 * in which case midi_read() may be called from different tracks for
222 * overlapping time-ranges.
224 * However there is only a single iterator for a given midi-source.
225 * This results in every midi_read() performing a seek.
227 * If seeking is performed with
228 * _model->begin(converter.from(start),...)
229 * the model is used for seeking. That method seeks to the first
230 * *note-on* event after 'start'.
232 * _model->begin(converter.from( ) ,..) eventually calls
233 * Sequence<Time>::const_iterator() in libs/evoral/src/Sequence.cpp
234 * which looks up the note-event via seq.note_lower_bound(t);
235 * but the sequence 'seq' only contains note-on events(!).
236 * note-off events are implicit in Sequence<Time>::operator++()
237 * via _active_notes.pop(); and not part of seq.
239 * see also http://tracker.ardour.org/view.php?id=6287#c16671
241 * The linear search below assures that reading starts at the first
242 * event for the given time, regardless of its event-type.
244 * The performance of this approach is O(N), while the previous
245 * implementation is O(log(N)). This needs to be optimized:
246 * The model-iterator or event-sequence needs to be re-designed in
247 * some way (maybe keep an iterator per playlist).
249 for (i = _model->begin(); i != _model->end(); ++i) {
250 const framecnt_t time_frames = converter.to(i->time());
251 if (time_frames >= start) {
255 _model_iter_valid = true;
259 _last_read_end = start + cnt;
261 // Copy events in [start, start + cnt) into dst
262 for (; i != _model->end(); ++i) {
263 const framecnt_t time_frames = converter.to(i->time());
264 if (time_frames < start + cnt) {
265 if (filter && filter->filter(i->buffer(), i->size())) {
266 DEBUG_TRACE (DEBUG::MidiSourceIO,
267 string_compose ("%1: filter event @ %2 type %3 size %4\n",
268 _name, time_frames + source_start, i->event_type(), i->size()));
272 // Offset by source start to convert event time to session time
273 dst.write (time_frames + source_start, i->event_type(), i->size(), i->buffer());
275 DEBUG_TRACE (DEBUG::MidiSourceIO,
276 string_compose ("%1: add event @ %2 type %3 size %4\n",
277 _name, time_frames + source_start, i->event_type(), i->size()));
283 DEBUG_TRACE (DEBUG::MidiSourceIO,
284 string_compose ("%1: reached end with event @ %2 vs. %3\n",
285 _name, time_frames, start+cnt));
291 return read_unlocked (lm, dst, source_start, start, cnt, tracker, filter);
296 MidiSource::midi_write (const Lock& lm,
297 MidiRingBuffer<framepos_t>& source,
298 framepos_t source_start,
301 const framecnt_t ret = write_unlocked (lm, source, source_start, cnt);
303 if (cnt == max_framecnt) {
307 _capture_length += cnt;
314 MidiSource::mark_streaming_midi_write_started (const Lock& lock, NoteMode mode)
317 _model->set_note_mode (mode);
318 _model->start_write ();
325 MidiSource::mark_write_starting_now (framecnt_t position,
326 framecnt_t capture_length,
327 framecnt_t loop_length)
329 /* I'm not sure if this is the best way to approach this, but
330 _capture_length needs to be set up with the transport frame
331 when a record actually starts, as it is used by
332 SMFSource::write_unlocked to decide whether incoming notes
333 are within the correct time range.
334 mark_streaming_midi_write_started (perhaps a more logical
335 place to do this) is not called at exactly the time when
336 record starts, and I don't think it necessarily can be
337 because it is not RT-safe.
340 set_timeline_position(position);
341 _capture_length = capture_length;
342 _capture_loop_length = loop_length;
344 BeatsFramesConverter converter(_session.tempo_map(), position);
345 _length_beats = converter.from(capture_length);
349 MidiSource::mark_streaming_write_started (const Lock& lock)
351 NoteMode note_mode = _model ? _model->note_mode() : Sustained;
352 mark_streaming_midi_write_started (lock, note_mode);
356 MidiSource::mark_midi_streaming_write_completed (const Lock& lock,
357 Evoral::Sequence<Evoral::Beats>::StuckNoteOption option,
361 _model->end_write (option, end);
363 /* Make captured controls discrete to play back user input exactly. */
364 for (MidiModel::Controls::iterator i = _model->controls().begin(); i != _model->controls().end(); ++i) {
365 if (i->second->list()) {
366 i->second->list()->set_interpolation(Evoral::ControlList::Discrete);
367 _interpolation_style.insert(std::make_pair(i->second->parameter(), Evoral::ControlList::Discrete));
377 MidiSource::mark_streaming_write_completed (const Lock& lock)
379 mark_midi_streaming_write_completed (lock, Evoral::Sequence<Evoral::Beats>::DeleteStuckNotes);
383 MidiSource::write_to (const Lock& lock, boost::shared_ptr<MidiSource> newsrc, Evoral::Beats begin, Evoral::Beats end)
385 Lock newsrc_lock (newsrc->mutex ());
387 newsrc->set_timeline_position (_timeline_position);
388 newsrc->copy_interpolation_from (this);
389 newsrc->copy_automation_state_from (this);
392 if (begin == Evoral::MinBeats && end == Evoral::MaxBeats) {
393 _model->write_to (newsrc, newsrc_lock);
395 _model->write_section_to (newsrc, newsrc_lock, begin, end);
398 error << string_compose (_("programming error: %1"), X_("no model for MidiSource during ::clone()"));
402 newsrc->flush_midi(newsrc_lock);
404 /* force a reload of the model if the range is partial */
406 if (begin != Evoral::MinBeats || end != Evoral::MaxBeats) {
407 newsrc->load_model (newsrc_lock, true);
409 newsrc->set_model (newsrc_lock, _model);
412 /* this file is not removable (but since it is MIDI, it is mutable) */
414 boost::dynamic_pointer_cast<FileSource> (newsrc)->prevent_deletion ();
420 MidiSource::session_saved()
424 /* this writes a copy of the data to disk.
425 XXX do we need to do this every time?
428 if (_model && _model->edited()) {
429 /* The model is edited, write its contents into the current source
430 file (overwiting previous contents). */
432 /* Temporarily drop our reference to the model so that as the model
433 pushes its current state to us, we don't try to update it. */
434 boost::shared_ptr<MidiModel> mm = _model;
437 /* Flush model contents to disk. */
438 mm->sync_to_source (lm);
440 /* Reacquire model. */
449 MidiSource::set_note_mode(const Lock& lock, NoteMode mode)
452 _model->set_note_mode(mode);
457 MidiSource::drop_model (const Lock& lock)
461 ModelChanged (); /* EMIT SIGNAL */
465 MidiSource::set_model (const Lock& lock, boost::shared_ptr<MidiModel> m)
469 ModelChanged (); /* EMIT SIGNAL */
472 Evoral::ControlList::InterpolationStyle
473 MidiSource::interpolation_of (Evoral::Parameter p) const
475 InterpolationStyleMap::const_iterator i = _interpolation_style.find (p);
476 if (i == _interpolation_style.end()) {
477 return EventTypeMap::instance().interpolation_of (p);
484 MidiSource::automation_state_of (Evoral::Parameter p) const
486 AutomationStateMap::const_iterator i = _automation_state.find (p);
487 if (i == _automation_state.end()) {
488 /* default to `play', otherwise if MIDI is recorded /
489 imported with controllers etc. they are by default
490 not played back, which is a little surprising.
498 /** Set interpolation style to be used for a given parameter. This change will be
499 * propagated to anyone who needs to know.
502 MidiSource::set_interpolation_of (Evoral::Parameter p, Evoral::ControlList::InterpolationStyle s)
504 if (interpolation_of (p) == s) {
508 if (EventTypeMap::instance().interpolation_of (p) == s) {
509 /* interpolation type is being set to the default, so we don't need a note in our map */
510 _interpolation_style.erase (p);
512 _interpolation_style[p] = s;
515 InterpolationChanged (p, s); /* EMIT SIGNAL */
519 MidiSource::set_automation_state_of (Evoral::Parameter p, AutoState s)
521 if (automation_state_of (p) == s) {
526 /* automation state is being set to the default, so we don't need a note in our map */
527 _automation_state.erase (p);
529 _automation_state[p] = s;
532 AutomationStateChanged (p, s); /* EMIT SIGNAL */
536 MidiSource::copy_interpolation_from (boost::shared_ptr<MidiSource> s)
538 copy_interpolation_from (s.get ());
542 MidiSource::copy_automation_state_from (boost::shared_ptr<MidiSource> s)
544 copy_automation_state_from (s.get ());
548 MidiSource::copy_interpolation_from (MidiSource* s)
550 _interpolation_style = s->_interpolation_style;
552 /* XXX: should probably emit signals here */
556 MidiSource::copy_automation_state_from (MidiSource* s)
558 _automation_state = s->_automation_state;
560 /* XXX: should probably emit signals here */