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 "ardour/debug.h"
38 #include "ardour/midi_model.h"
39 #include "ardour/midi_state_tracker.h"
40 #include "ardour/midi_source.h"
41 #include "ardour/file_source.h"
42 #include "ardour/session.h"
43 #include "ardour/session_directory.h"
44 #include "ardour/source_factory.h"
48 namespace ARDOUR { template <typename T> class MidiRingBuffer; }
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)
63 , _capture_loop_length(0)
67 MidiSource::MidiSource (Session& s, const XMLNode& node)
70 , _model_iter_valid(false)
74 , _capture_loop_length(0)
76 if (set_state (node, Stateful::loading_state_version)) {
77 throw failed_constructor();
82 MidiSource::~MidiSource ()
87 MidiSource::get_state ()
89 XMLNode& node (Source::get_state());
91 if (_captured_for.length()) {
92 node.add_property ("captured-for", _captured_for);
95 for (InterpolationStyleMap::const_iterator i = _interpolation_style.begin(); i != _interpolation_style.end(); ++i) {
96 XMLNode* child = node.add_child (X_("InterpolationStyle"));
97 child->add_property (X_("parameter"), EventTypeMap::instance().to_symbol (i->first));
98 child->add_property (X_("style"), enum_2_string (i->second));
101 for (AutomationStateMap::const_iterator i = _automation_state.begin(); i != _automation_state.end(); ++i) {
102 XMLNode* child = node.add_child (X_("AutomationState"));
103 child->add_property (X_("parameter"), EventTypeMap::instance().to_symbol (i->first));
104 child->add_property (X_("state"), enum_2_string (i->second));
111 MidiSource::set_state (const XMLNode& node, int /*version*/)
113 const XMLProperty* prop;
115 if ((prop = node.property ("captured-for")) != 0) {
116 _captured_for = prop->value();
119 XMLNodeList children = node.children ();
120 for (XMLNodeConstIterator i = children.begin(); i != children.end(); ++i) {
121 if ((*i)->name() == X_("InterpolationStyle")) {
124 if ((prop = (*i)->property (X_("parameter"))) == 0) {
125 error << _("Missing parameter property on InterpolationStyle") << endmsg;
129 Evoral::Parameter p = EventTypeMap::instance().new_parameter (prop->value());
131 if ((prop = (*i)->property (X_("style"))) == 0) {
132 error << _("Missing style property on InterpolationStyle") << endmsg;
136 Evoral::ControlList::InterpolationStyle s = static_cast<Evoral::ControlList::InterpolationStyle> (string_2_enum (prop->value(), s));
137 set_interpolation_of (p, s);
139 } else if ((*i)->name() == X_("AutomationState")) {
143 if ((prop = (*i)->property (X_("parameter"))) == 0) {
144 error << _("Missing parameter property on AutomationState") << endmsg;
148 Evoral::Parameter p = EventTypeMap::instance().new_parameter (prop->value());
150 if ((prop = (*i)->property (X_("state"))) == 0) {
151 error << _("Missing state property on AutomationState") << endmsg;
155 AutoState s = static_cast<AutoState> (string_2_enum (prop->value(), s));
156 set_automation_state_of (p, s);
164 MidiSource::empty () const
166 return _length_beats == 0;
170 MidiSource::length (framepos_t pos) const
172 if (_length_beats == 0) {
176 BeatsFramesConverter converter(_session.tempo_map(), pos);
177 return converter.to(_length_beats);
181 MidiSource::update_length (framecnt_t)
183 // You're not the boss of me!
187 MidiSource::invalidate ()
189 _model_iter_valid = false;
190 _model_iter.invalidate();
193 /** @param filtered A set of parameters whose MIDI messages will not be returned */
195 MidiSource::midi_read (Evoral::EventSink<framepos_t>& dst, framepos_t source_start,
196 framepos_t start, framecnt_t cnt,
197 MidiStateTracker* tracker,
198 std::set<Evoral::Parameter> const & filtered) const
200 Glib::Threads::Mutex::Lock lm (_lock);
202 BeatsFramesConverter converter(_session.tempo_map(), source_start);
204 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("MidiSource::midi-read() %5 sstart %1 start %2 cnt %3 tracker %4\n",
205 source_start, start, cnt, tracker, name()));
208 Evoral::Sequence<double>::const_iterator& i = _model_iter;
210 // If the cached iterator is invalid, search for the first event past start
211 if (_last_read_end == 0 || start != _last_read_end || !_model_iter_valid) {
212 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("*** %1 search for relevant iterator for %1 / %2\n", _name, source_start, start));
213 for (i = _model->begin(0, false, filtered); i != _model->end(); ++i) {
214 if (converter.to(i->time()) >= start) {
215 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("***\tstop iterator search @ %1\n", i->time()));
219 _model_iter_valid = true;
221 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("*** %1 use cachediterator for %1 / %2\n", _name, source_start, start));
224 _last_read_end = start + cnt;
226 // Read events up to end
227 for (; i != _model->end(); ++i) {
228 const framecnt_t time_frames = converter.to(i->time());
229 if (time_frames < start + cnt) {
230 /* convert event times to session frames by adding on the source start position in session frames */
231 dst.write (time_frames + source_start, i->event_type(), i->size(), i->buffer());
233 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("%1: add event @ %2 type %3 size = %4\n",
234 _name, time_frames + source_start, i->event_type(), i->size()));
237 Evoral::MIDIEvent<Evoral::MusicalTime>& ev (*(reinterpret_cast<Evoral::MIDIEvent<Evoral::MusicalTime>*>
238 (const_cast<Evoral::Event<Evoral::MusicalTime>*> (&(*i)))));
239 if (ev.is_note_on()) {
240 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()));
241 tracker->add (ev.note(), ev.channel());
242 } else if (ev.is_note_off()) {
243 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("\t%1 track note off %2 @ %3\n", _name, (int) ev.note(), time_frames));
244 tracker->remove (ev.note(), ev.channel());
248 DEBUG_TRACE (DEBUG::MidiSourceIO, string_compose ("%1: reached end with event @ %2 vs. %3\n",
249 _name, time_frames, start+cnt));
255 return read_unlocked (dst, source_start, start, cnt, tracker);
260 MidiSource::midi_write (MidiRingBuffer<framepos_t>& source,
261 framepos_t source_start,
264 Glib::Threads::Mutex::Lock lm (_lock);
266 const framecnt_t ret = write_unlocked (source, source_start, cnt);
268 if (cnt == max_framecnt) {
271 _capture_length += cnt;
278 MidiSource::mark_streaming_midi_write_started (NoteMode mode)
281 _model->set_note_mode (mode);
282 _model->start_write ();
289 MidiSource::mark_write_starting_now (framecnt_t position,
290 framecnt_t capture_length,
291 framecnt_t loop_length)
293 /* I'm not sure if this is the best way to approach this, but
294 _capture_length needs to be set up with the transport frame
295 when a record actually starts, as it is used by
296 SMFSource::write_unlocked to decide whether incoming notes
297 are within the correct time range.
298 mark_streaming_midi_write_started (perhaps a more logical
299 place to do this) is not called at exactly the time when
300 record starts, and I don't think it necessarily can be
301 because it is not RT-safe.
304 set_timeline_position(position);
305 _capture_length = capture_length;
306 _capture_loop_length = loop_length;
308 BeatsFramesConverter converter(_session.tempo_map(), position);
309 _length_beats = converter.from(capture_length);
313 MidiSource::mark_streaming_write_started ()
315 NoteMode note_mode = _model ? _model->note_mode() : Sustained;
316 mark_streaming_midi_write_started (note_mode);
320 MidiSource::mark_midi_streaming_write_completed (Evoral::Sequence<Evoral::MusicalTime>::StuckNoteOption option, Evoral::MusicalTime end)
323 _model->end_write (option, end);
330 MidiSource::mark_streaming_write_completed ()
332 mark_midi_streaming_write_completed (Evoral::Sequence<Evoral::MusicalTime>::DeleteStuckNotes);
335 boost::shared_ptr<MidiSource>
336 MidiSource::clone (const string& path, Evoral::MusicalTime begin, Evoral::MusicalTime end)
340 /* get a new name for the MIDI file we're going to write to
344 string newname = PBD::basename_nosuffix(_name.val());
345 newname = bump_name_once (newname, '-');
347 newpath = _session.new_source_path_from_name (DataType::MIDI, newname);
349 /* caller must check for pre-existing file */
350 assert (!Glib::file_test (path, Glib::FILE_TEST_EXISTS));
354 boost::shared_ptr<MidiSource> newsrc = boost::dynamic_pointer_cast<MidiSource>(
355 SourceFactory::createWritable(DataType::MIDI, _session,
356 newpath, false, _session.frame_rate()));
358 newsrc->set_timeline_position(_timeline_position);
359 newsrc->copy_interpolation_from (this);
360 newsrc->copy_automation_state_from (this);
363 if (begin == Evoral::MinMusicalTime && end == Evoral::MaxMusicalTime) {
364 _model->write_to (newsrc);
366 _model->write_section_to (newsrc, begin, end);
369 error << string_compose (_("programming error: %1"), X_("no model for MidiSource during ::clone()"));
370 return boost::shared_ptr<MidiSource>();
373 newsrc->flush_midi();
375 /* force a reload of the model if the range is partial */
377 if (begin != Evoral::MinMusicalTime || end != Evoral::MaxMusicalTime) {
378 newsrc->load_model (true, true);
380 newsrc->set_model (_model);
383 /* this file is not removable (but since it is MIDI, it is mutable) */
385 boost::dynamic_pointer_cast<FileSource> (newsrc)->prevent_deletion ();
391 MidiSource::session_saved()
393 /* this writes a copy of the data to disk.
394 XXX do we need to do this every time?
397 if (_model && _model->edited()) {
399 // if the model is edited, write its contents into
400 // the current source file (overwiting previous contents.
402 /* temporarily drop our reference to the model so that
403 as the model pushes its current state to us, we don't
407 boost::shared_ptr<MidiModel> mm = _model;
410 /* flush model contents to disk
413 mm->sync_to_source ();
415 /* reacquire model */
425 MidiSource::set_note_mode(NoteMode mode)
428 _model->set_note_mode(mode);
433 MidiSource::drop_model ()
436 ModelChanged (); /* EMIT SIGNAL */
440 MidiSource::set_model (boost::shared_ptr<MidiModel> m)
443 ModelChanged (); /* EMIT SIGNAL */
446 /** @return Interpolation style that should be used for control parameter \a p */
447 Evoral::ControlList::InterpolationStyle
448 MidiSource::interpolation_of (Evoral::Parameter p) const
450 InterpolationStyleMap::const_iterator i = _interpolation_style.find (p);
451 if (i == _interpolation_style.end()) {
452 return EventTypeMap::instance().interpolation_of (p);
459 MidiSource::automation_state_of (Evoral::Parameter p) const
461 AutomationStateMap::const_iterator i = _automation_state.find (p);
462 if (i == _automation_state.end()) {
463 /* default to `play', otherwise if MIDI is recorded /
464 imported with controllers etc. they are by default
465 not played back, which is a little surprising.
473 /** Set interpolation style to be used for a given parameter. This change will be
474 * propagated to anyone who needs to know.
477 MidiSource::set_interpolation_of (Evoral::Parameter p, Evoral::ControlList::InterpolationStyle s)
479 if (interpolation_of (p) == s) {
483 if (EventTypeMap::instance().interpolation_of (p) == s) {
484 /* interpolation type is being set to the default, so we don't need a note in our map */
485 _interpolation_style.erase (p);
487 _interpolation_style[p] = s;
490 InterpolationChanged (p, s); /* EMIT SIGNAL */
494 MidiSource::set_automation_state_of (Evoral::Parameter p, AutoState s)
496 if (automation_state_of (p) == s) {
501 /* automation state is being set to the default, so we don't need a note in our map */
502 _automation_state.erase (p);
504 _automation_state[p] = s;
507 AutomationStateChanged (p, s); /* EMIT SIGNAL */
511 MidiSource::copy_interpolation_from (boost::shared_ptr<MidiSource> s)
513 copy_interpolation_from (s.get ());
517 MidiSource::copy_automation_state_from (boost::shared_ptr<MidiSource> s)
519 copy_automation_state_from (s.get ());
523 MidiSource::copy_interpolation_from (MidiSource* s)
525 _interpolation_style = s->_interpolation_style;
527 /* XXX: should probably emit signals here */
531 MidiSource::copy_automation_state_from (MidiSource* s)
533 _automation_state = s->_automation_state;
535 /* XXX: should probably emit signals here */