/*
Copyright (C) 2006 Paul Davis
- Written by Dave Robillard, 2006
+ Author: David Robillard
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
#include <sys/stat.h>
#include <unistd.h>
#include <fcntl.h>
-#include <poll.h>
#include <float.h>
#include <cerrno>
#include <ctime>
#include <iomanip>
#include <algorithm>
-#include <pbd/xml++.h>
-#include <pbd/pthread_utils.h>
+#include <glibmm/fileutils.h>
+#include <glibmm/miscutils.h>
-#include <ardour/midi_source.h>
-#include <ardour/midi_ring_buffer.h>
+#include "pbd/xml++.h"
+#include "pbd/pthread_utils.h"
+#include "pbd/basename.h"
+
+#include "evoral/Control.hpp"
+#include "evoral/EventSink.hpp"
+
+#include "ardour/debug.h"
+#include "ardour/file_source.h"
+#include "ardour/midi_channel_filter.h"
+#include "ardour/midi_model.h"
+#include "ardour/midi_source.h"
+#include "ardour/midi_state_tracker.h"
+#include "ardour/session.h"
+#include "ardour/session_directory.h"
+#include "ardour/source_factory.h"
#include "i18n.h"
+namespace ARDOUR { template <typename T> class MidiRingBuffer; }
+
using namespace std;
using namespace ARDOUR;
using namespace PBD;
-sigc::signal<void,MidiSource *> MidiSource::MidiSourceCreated;
+PBD::Signal1<void,MidiSource*> MidiSource::MidiSourceCreated;
-MidiSource::MidiSource (Session& s, string name)
- : Source (s, name, DataType::MIDI)
+MidiSource::MidiSource (Session& s, string name, Source::Flag flags)
+ : Source(s, DataType::MIDI, name, flags)
+ , _writing(false)
+ , _model_iter_valid(false)
+ , _length_beats(0.0)
+ , _last_read_end(0)
+ , _capture_length(0)
+ , _capture_loop_length(0)
{
- _read_data_count = 0;
- _write_data_count = 0;
}
-MidiSource::MidiSource (Session& s, const XMLNode& node)
- : Source (s, node)
+MidiSource::MidiSource (Session& s, const XMLNode& node)
+ : Source(s, node)
+ , _writing(false)
+ , _model_iter_valid(false)
+ , _length_beats(0.0)
+ , _last_read_end(0)
+ , _capture_length(0)
+ , _capture_loop_length(0)
{
- _read_data_count = 0;
- _write_data_count = 0;
-
- if (set_state (node)) {
+ if (set_state (node, Stateful::loading_state_version)) {
throw failed_constructor();
}
}
node.add_property ("captured-for", _captured_for);
}
+ for (InterpolationStyleMap::const_iterator i = _interpolation_style.begin(); i != _interpolation_style.end(); ++i) {
+ XMLNode* child = node.add_child (X_("InterpolationStyle"));
+ child->add_property (X_("parameter"), EventTypeMap::instance().to_symbol (i->first));
+ child->add_property (X_("style"), enum_2_string (i->second));
+ }
+
+ for (AutomationStateMap::const_iterator i = _automation_state.begin(); i != _automation_state.end(); ++i) {
+ XMLNode* child = node.add_child (X_("AutomationState"));
+ child->add_property (X_("parameter"), EventTypeMap::instance().to_symbol (i->first));
+ child->add_property (X_("state"), enum_2_string (i->second));
+ }
+
return node;
}
int
-MidiSource::set_state (const XMLNode& node)
+MidiSource::set_state (const XMLNode& node, int /*version*/)
{
const XMLProperty* prop;
-
- Source::set_state (node);
-
if ((prop = node.property ("captured-for")) != 0) {
_captured_for = prop->value();
}
+ XMLNodeList children = node.children ();
+ for (XMLNodeConstIterator i = children.begin(); i != children.end(); ++i) {
+ if ((*i)->name() == X_("InterpolationStyle")) {
+ if ((prop = (*i)->property (X_("parameter"))) == 0) {
+ error << _("Missing parameter property on InterpolationStyle") << endmsg;
+ return -1;
+ }
+ Evoral::Parameter p = EventTypeMap::instance().from_symbol (prop->value());
+
+ if ((prop = (*i)->property (X_("style"))) == 0) {
+ error << _("Missing style property on InterpolationStyle") << endmsg;
+ return -1;
+ }
+ Evoral::ControlList::InterpolationStyle s = static_cast<Evoral::ControlList::InterpolationStyle>(
+ string_2_enum (prop->value(), s));
+ set_interpolation_of (p, s);
+
+ } else if ((*i)->name() == X_("AutomationState")) {
+ if ((prop = (*i)->property (X_("parameter"))) == 0) {
+ error << _("Missing parameter property on AutomationState") << endmsg;
+ return -1;
+ }
+ Evoral::Parameter p = EventTypeMap::instance().from_symbol (prop->value());
+
+ if ((prop = (*i)->property (X_("state"))) == 0) {
+ error << _("Missing state property on AutomationState") << endmsg;
+ return -1;
+ }
+ AutoState s = static_cast<AutoState> (string_2_enum (prop->value(), s));
+ set_automation_state_of (p, s);
+ }
+ }
+
return 0;
}
-nframes_t
-MidiSource::read (MidiRingBuffer& dst, nframes_t start, nframes_t cnt, nframes_t stamp_offset) const
+bool
+MidiSource::empty () const
{
- Glib::Mutex::Lock lm (_lock);
- return read_unlocked (dst, start, cnt, stamp_offset);
+ return !_length_beats;
}
-nframes_t
-MidiSource::write (MidiRingBuffer& dst, nframes_t cnt)
+framecnt_t
+MidiSource::length (framepos_t pos) const
{
- Glib::Mutex::Lock lm (_lock);
- return write_unlocked (dst, cnt);
+ if (!_length_beats) {
+ return 0;
+ }
+
+ BeatsFramesConverter converter(_session.tempo_map(), pos);
+ return converter.to(_length_beats);
}
-bool
-MidiSource::file_changed (string path)
+void
+MidiSource::update_length (framecnt_t)
+{
+ // You're not the boss of me!
+}
+
+void
+MidiSource::invalidate (const Lock& lock, std::set<Evoral::Sequence<Evoral::Beats>::WeakNotePtr>* notes)
+{
+ _model_iter_valid = false;
+ _model_iter.invalidate(notes);
+}
+
+framecnt_t
+MidiSource::midi_read (const Lock& lm,
+ Evoral::EventSink<framepos_t>& dst,
+ framepos_t source_start,
+ framepos_t start,
+ framecnt_t cnt,
+ MidiStateTracker* tracker,
+ MidiChannelFilter* filter,
+ const std::set<Evoral::Parameter>& filtered) const
+{
+ BeatsFramesConverter converter(_session.tempo_map(), source_start);
+
+ DEBUG_TRACE (DEBUG::MidiSourceIO,
+ string_compose ("MidiSource::midi_read() %5 sstart %1 start %2 cnt %3 tracker %4\n",
+ source_start, start, cnt, tracker, name()));
+
+ if (_model) {
+ // Find appropriate model iterator
+ Evoral::Sequence<Evoral::Beats>::const_iterator& i = _model_iter;
+ const bool linear_read = _last_read_end != 0 && start == _last_read_end;
+ if (!linear_read || !_model_iter_valid) {
+#if 0
+ // Cached iterator is invalid, search for the first event past start
+ i = _model->begin(converter.from(start), false, filtered,
+ linear_read ? &_model->active_notes() : NULL);
+ _model_iter_valid = true;
+ if (!linear_read) {
+ _model->active_notes().clear();
+ }
+#else
+ /* hot-fix http://tracker.ardour.org/view.php?id=6541
+ * "parallel playback of linked midi regions -> no note-offs"
+ *
+ * A midi source can be used by multiple tracks simultaneously,
+ * in which case midi_read() may be called from different tracks for
+ * overlapping time-ranges.
+ *
+ * However there is only a single iterator for a given midi-source.
+ * This results in every midi_read() performing a seek.
+ *
+ * If seeking is performed with
+ * _model->begin(converter.from(start),...)
+ * the model is used for seeking. That method seeks to the first
+ * *note-on* event after 'start'.
+ *
+ * _model->begin(converter.from( ) ,..) eventually calls
+ * Sequence<Time>::const_iterator() in libs/evoral/src/Sequence.cpp
+ * which looks up the note-event via seq.note_lower_bound(t);
+ * but the sequence 'seq' only contains note-on events(!).
+ * note-off events are implicit in Sequence<Time>::operator++()
+ * via _active_notes.pop(); and not part of seq.
+ *
+ * see also http://tracker.ardour.org/view.php?id=6287#c16671
+ *
+ * The linear search below assures that reading starts at the first
+ * event for the given time, regardless of its event-type.
+ *
+ * The performance of this approach is O(N), while the previous
+ * implementation is O(log(N)). This needs to be optimized:
+ * The model-iterator or event-sequence needs to be re-designed in
+ * some way (maybe keep an iterator per playlist).
+ */
+ for (i = _model->begin(); i != _model->end(); ++i) {
+ const framecnt_t time_frames = converter.to(i->time());
+ if (time_frames >= start) {
+ break;
+ }
+ }
+ _model_iter_valid = true;
+#endif
+ }
+
+ _last_read_end = start + cnt;
+
+ // Copy events in [start, start + cnt) into dst
+ for (; i != _model->end(); ++i) {
+ const framecnt_t time_frames = converter.to(i->time());
+ if (time_frames < start + cnt) {
+ if (filter && filter->filter(i->buffer(), i->size())) {
+ DEBUG_TRACE (DEBUG::MidiSourceIO,
+ string_compose ("%1: filter event @ %2 type %3 size %4\n",
+ _name, time_frames + source_start, i->event_type(), i->size()));
+ continue;
+ }
+
+ // Offset by source start to convert event time to session time
+ dst.write (time_frames + source_start, i->event_type(), i->size(), i->buffer());
+
+ DEBUG_TRACE (DEBUG::MidiSourceIO,
+ string_compose ("%1: add event @ %2 type %3 size %4\n",
+ _name, time_frames + source_start, i->event_type(), i->size()));
+
+ if (tracker) {
+ tracker->track (*i);
+ }
+ } else {
+ DEBUG_TRACE (DEBUG::MidiSourceIO,
+ string_compose ("%1: reached end with event @ %2 vs. %3\n",
+ _name, time_frames, start+cnt));
+ break;
+ }
+ }
+ return cnt;
+ } else {
+ return read_unlocked (lm, dst, source_start, start, cnt, tracker, filter);
+ }
+}
+
+framecnt_t
+MidiSource::midi_write (const Lock& lm,
+ MidiRingBuffer<framepos_t>& source,
+ framepos_t source_start,
+ framecnt_t cnt)
+{
+ const framecnt_t ret = write_unlocked (lm, source, source_start, cnt);
+
+ if (cnt == max_framecnt) {
+ _last_read_end = 0;
+ invalidate(lm);
+ } else {
+ _capture_length += cnt;
+ }
+
+ return ret;
+}
+
+void
+MidiSource::mark_streaming_midi_write_started (const Lock& lock, NoteMode mode)
+{
+ if (_model) {
+ _model->set_note_mode (mode);
+ _model->start_write ();
+ }
+
+ _writing = true;
+}
+
+void
+MidiSource::mark_write_starting_now (framecnt_t position,
+ framecnt_t capture_length,
+ framecnt_t loop_length)
+{
+ /* I'm not sure if this is the best way to approach this, but
+ _capture_length needs to be set up with the transport frame
+ when a record actually starts, as it is used by
+ SMFSource::write_unlocked to decide whether incoming notes
+ are within the correct time range.
+ mark_streaming_midi_write_started (perhaps a more logical
+ place to do this) is not called at exactly the time when
+ record starts, and I don't think it necessarily can be
+ because it is not RT-safe.
+ */
+
+ set_timeline_position(position);
+ _capture_length = capture_length;
+ _capture_loop_length = loop_length;
+
+ BeatsFramesConverter converter(_session.tempo_map(), position);
+ _length_beats = converter.from(capture_length);
+}
+
+void
+MidiSource::mark_streaming_write_started (const Lock& lock)
+{
+ NoteMode note_mode = _model ? _model->note_mode() : Sustained;
+ mark_streaming_midi_write_started (lock, note_mode);
+}
+
+void
+MidiSource::mark_midi_streaming_write_completed (const Lock& lock,
+ Evoral::Sequence<Evoral::Beats>::StuckNoteOption option,
+ Evoral::Beats end)
+{
+ if (_model) {
+ _model->end_write (option, end);
+
+ /* Make captured controls discrete to play back user input exactly. */
+ for (MidiModel::Controls::iterator i = _model->controls().begin(); i != _model->controls().end(); ++i) {
+ if (i->second->list()) {
+ i->second->list()->set_interpolation(Evoral::ControlList::Discrete);
+ _interpolation_style.insert(std::make_pair(i->second->parameter(), Evoral::ControlList::Discrete));
+ }
+ }
+ }
+
+ invalidate(lock);
+ _writing = false;
+}
+
+void
+MidiSource::mark_streaming_write_completed (const Lock& lock)
+{
+ mark_midi_streaming_write_completed (lock, Evoral::Sequence<Evoral::Beats>::DeleteStuckNotes);
+}
+
+int
+MidiSource::write_to (const Lock& lock, boost::shared_ptr<MidiSource> newsrc, Evoral::Beats begin, Evoral::Beats end)
+{
+ Lock newsrc_lock (newsrc->mutex ());
+
+ newsrc->set_timeline_position (_timeline_position);
+ newsrc->copy_interpolation_from (this);
+ newsrc->copy_automation_state_from (this);
+
+ if (_model) {
+ if (begin == Evoral::MinBeats && end == Evoral::MaxBeats) {
+ _model->write_to (newsrc, newsrc_lock);
+ } else {
+ _model->write_section_to (newsrc, newsrc_lock, begin, end);
+ }
+ } else {
+ error << string_compose (_("programming error: %1"), X_("no model for MidiSource during ::clone()"));
+ return -1;
+ }
+
+ newsrc->flush_midi(newsrc_lock);
+
+ /* force a reload of the model if the range is partial */
+
+ if (begin != Evoral::MinBeats || end != Evoral::MaxBeats) {
+ newsrc->load_model (newsrc_lock, true);
+ } else {
+ newsrc->set_model (newsrc_lock, _model);
+ }
+
+ /* this file is not removable (but since it is MIDI, it is mutable) */
+
+ boost::dynamic_pointer_cast<FileSource> (newsrc)->prevent_deletion ();
+
+ return 0;
+}
+
+void
+MidiSource::session_saved()
+{
+ Lock lm (_lock);
+
+ /* this writes a copy of the data to disk.
+ XXX do we need to do this every time?
+ */
+
+ if (_model && _model->edited()) {
+ /* The model is edited, write its contents into the current source
+ file (overwiting previous contents). */
+
+ /* Temporarily drop our reference to the model so that as the model
+ pushes its current state to us, we don't try to update it. */
+ boost::shared_ptr<MidiModel> mm = _model;
+ _model.reset ();
+
+ /* Flush model contents to disk. */
+ mm->sync_to_source (lm);
+
+ /* Reacquire model. */
+ _model = mm;
+
+ } else {
+ flush_midi(lm);
+ }
+}
+
+void
+MidiSource::set_note_mode(const Lock& lock, NoteMode mode)
+{
+ if (_model) {
+ _model->set_note_mode(mode);
+ }
+}
+
+void
+MidiSource::drop_model (const Lock& lock)
+{
+ _model.reset();
+ invalidate(lock);
+ ModelChanged (); /* EMIT SIGNAL */
+}
+
+void
+MidiSource::set_model (const Lock& lock, boost::shared_ptr<MidiModel> m)
+{
+ _model = m;
+ invalidate(lock);
+ ModelChanged (); /* EMIT SIGNAL */
+}
+
+Evoral::ControlList::InterpolationStyle
+MidiSource::interpolation_of (Evoral::Parameter p) const
{
- struct stat stat_file;
+ InterpolationStyleMap::const_iterator i = _interpolation_style.find (p);
+ if (i == _interpolation_style.end()) {
+ return EventTypeMap::instance().interpolation_of (p);
+ }
- int e1 = stat (path.c_str(), &stat_file);
-
- return ( !e1 );
+ return i->second;
}
+AutoState
+MidiSource::automation_state_of (Evoral::Parameter p) const
+{
+ AutomationStateMap::const_iterator i = _automation_state.find (p);
+ if (i == _automation_state.end()) {
+ /* default to `play', otherwise if MIDI is recorded /
+ imported with controllers etc. they are by default
+ not played back, which is a little surprising.
+ */
+ return Play;
+ }
+
+ return i->second;
+}
+
+/** Set interpolation style to be used for a given parameter. This change will be
+ * propagated to anyone who needs to know.
+ */
+void
+MidiSource::set_interpolation_of (Evoral::Parameter p, Evoral::ControlList::InterpolationStyle s)
+{
+ if (interpolation_of (p) == s) {
+ return;
+ }
+
+ if (EventTypeMap::instance().interpolation_of (p) == s) {
+ /* interpolation type is being set to the default, so we don't need a note in our map */
+ _interpolation_style.erase (p);
+ } else {
+ _interpolation_style[p] = s;
+ }
+
+ InterpolationChanged (p, s); /* EMIT SIGNAL */
+}
+
+void
+MidiSource::set_automation_state_of (Evoral::Parameter p, AutoState s)
+{
+ if (automation_state_of (p) == s) {
+ return;
+ }
+
+ if (s == Play) {
+ /* automation state is being set to the default, so we don't need a note in our map */
+ _automation_state.erase (p);
+ } else {
+ _automation_state[p] = s;
+ }
+
+ AutomationStateChanged (p, s); /* EMIT SIGNAL */
+}
+
+void
+MidiSource::copy_interpolation_from (boost::shared_ptr<MidiSource> s)
+{
+ copy_interpolation_from (s.get ());
+}
+
+void
+MidiSource::copy_automation_state_from (boost::shared_ptr<MidiSource> s)
+{
+ copy_automation_state_from (s.get ());
+}
+
+void
+MidiSource::copy_interpolation_from (MidiSource* s)
+{
+ _interpolation_style = s->_interpolation_style;
+
+ /* XXX: should probably emit signals here */
+}
+
+void
+MidiSource::copy_automation_state_from (MidiSource* s)
+{
+ _automation_state = s->_automation_state;
+
+ /* XXX: should probably emit signals here */
+}