add _locked() variants to new tempo experiment

1 files changed, 580 insertions, 0 deletions

diff --git a/libs/ardour/midi_source.cc.orig b/libs/ardour/midi_source.cc.orig
new file mode 100644
index 0000000000..ea0bd15b0c
--- /dev/null
+++ b/libs/ardour/midi_source.cc.orig
@@ -0,0 +1,580 @@
+/*
+    Copyright (C) 2006 Paul Davis
+    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
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+*/
+
+#include <sys/stat.h>
+#include <unistd.h>
+#include <fcntl.h>
+#include <float.h>
+#include <cerrno>
+#include <ctime>
+#include <cmath>
+#include <iomanip>
+#include <algorithm>
+
+#include <glibmm/fileutils.h>
+#include <glibmm/miscutils.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_cursor.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 "ardour/tempo.h"
+
+#include "pbd/i18n.h"
+
+namespace ARDOUR { template <typename T> class MidiRingBuffer; }
+
+using namespace std;
+using namespace ARDOUR;
+using namespace PBD;
+
+MidiSource::MidiSource (Session& s, string name, Source::Flag flags)
+	: Source(s, DataType::MIDI, name, flags)
+	, _writing(false)
+	, _length_beats(0.0)
+	, _capture_length(0)
+	, _capture_loop_length(0)
+{
+}
+
+MidiSource::MidiSource (Session& s, const XMLNode& node)
+	: Source(s, node)
+	, _writing(false)
+	, _length_beats(0.0)
+	, _capture_length(0)
+	, _capture_loop_length(0)
+{
+	if (set_state (node, Stateful::loading_state_version)) {
+		throw failed_constructor();
+	}
+}
+
+MidiSource::~MidiSource ()
+{
+	/* invalidate any existing iterators */
+	Invalidated (false);
+}
+
+XMLNode&
+MidiSource::get_state ()
+{
+	XMLNode& node (Source::get_state());
+
+	if (_captured_for.length()) {
+		node.set_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->set_property (X_("parameter"), EventTypeMap::instance().to_symbol (i->first));
+		child->set_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->set_property (X_("parameter"), EventTypeMap::instance().to_symbol (i->first));
+		child->set_property (X_("state"), enum_2_string (i->second));
+	}
+
+	return node;
+}
+
+int
+MidiSource::set_state (const XMLNode& node, int /*version*/)
+{
+	node.get_property ("captured-for", _captured_for);
+
+	std::string str;
+	XMLNodeList children = node.children ();
+	for (XMLNodeConstIterator i = children.begin(); i != children.end(); ++i) {
+		if ((*i)->name() == X_("InterpolationStyle")) {
+			if (!(*i)->get_property (X_("parameter"), str)) {
+				error << _("Missing parameter property on InterpolationStyle") << endmsg;
+				return -1;
+			}
+			Evoral::Parameter p = EventTypeMap::instance().from_symbol (str);
+
+			if (!(*i)->get_property (X_("style"), str)) {
+				error << _("Missing style property on InterpolationStyle") << endmsg;
+				return -1;
+			}
+			Evoral::ControlList::InterpolationStyle s =
+			    static_cast<Evoral::ControlList::InterpolationStyle>(string_2_enum (str, s));
+			set_interpolation_of (p, s);
+
+		} else if ((*i)->name() == X_("AutomationState")) {
+			if (!(*i)->get_property (X_("parameter"), str)) {
+				error << _("Missing parameter property on AutomationState") << endmsg;
+				return -1;
+			}
+			Evoral::Parameter p = EventTypeMap::instance().from_symbol (str);
+
+			if (!(*i)->get_property (X_("state"), str)) {
+				error << _("Missing state property on AutomationState") << endmsg;
+				return -1;
+			}
+			AutoState s = static_cast<AutoState>(string_2_enum (str, s));
+			set_automation_state_of (p, s);
+		}
+	}
+
+	return 0;
+}
+
+bool
+MidiSource::empty () const
+{
+	return !_length_beats;
+}
+
+framecnt_t
+MidiSource::length (framepos_t pos) const
+{
+	if (!_length_beats) {
+		return 0;
+	}
+
+	BeatsFramesConverter converter(_session.tempo_map(), pos);
+	return converter.to(_length_beats);
+}
+
+void
+MidiSource::update_length (framecnt_t)
+{
+	// You're not the boss of me!
+}
+
+void
+MidiSource::invalidate (const Lock& lock)
+{
+	Invalidated(_session.transport_rolling());
+}
+
+framecnt_t
+MidiSource::midi_read (const Lock&                        lm,
+                       Evoral::EventSink<framepos_t>&     dst,
+                       framepos_t                         source_start,
+                       framepos_t                         start,
+                       framecnt_t                         cnt,
+                       Evoral::Range<framepos_t>*         loop_range,
+                       MidiCursor&                        cursor,
+                       MidiStateTracker*                  tracker,
+                       MidiChannelFilter*                 filter,
+                       const std::set<Evoral::Parameter>& filtered,
+                       const double                       pos_beats,
+                       const double                       start_beats) const
+{
+	BeatsFramesConverter converter(_session.tempo_map(), source_start);
+
+	const double start_qn = pos_beats - start_beats;
+
+	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) {
+		return read_unlocked (lm, dst, source_start, start, cnt, loop_range, tracker, filter);
+	}
+
+	// Find appropriate model iterator
+	Evoral::Sequence<Evoral::Beats>::const_iterator& i = cursor.iter;
+	const bool linear_read = cursor.last_read_end != 0 && start == cursor.last_read_end;
+	if (!linear_read || !i.valid()) {
+		/* Cached iterator is invalid, search for the first event past start.
+		   Note that multiple tracks can use a MidiSource simultaneously, so
+		   all playback state must be in parameters (the cursor) and must not
+		   be cached in the source of model itself.
+		   See http://tracker.ardour.org/view.php?id=6541
+		*/
+		cursor.connect(Invalidated);
+		cursor.iter = _model->begin(converter.from(start), false, filtered, &cursor.active_notes);
+		cursor.active_notes.clear();
+	}
+
+	cursor.last_read_end = start + cnt;
+
+	// Copy events in [start, start + cnt) into dst
+	for (; i != _model->end(); ++i) {
+
+		// Offset by source start to convert event time to session time
+
+		framepos_t time_frames = _session.tempo_map().frame_at_quarter_note (i->time().to_double() + start_qn);
+
+		if (time_frames < start + source_start) {
+			/* event too early */
+
+			continue;
+
+		} else if (time_frames >= start + cnt + source_start) {
+
+			DEBUG_TRACE (DEBUG::MidiSourceIO,
+			             string_compose ("%1: reached end with event @ %2 vs. %3\n",
+			                             _name, time_frames, start+cnt));
+			break;
+
+		} else {
+
+			/* in range */
+
+			if (loop_range) {
+				time_frames = loop_range->squish (time_frames);
+			}
+
+			const uint8_t status           = i->buffer()[0];
+			const bool    is_channel_event = (0x80 <= (status & 0xF0)) && (status <= 0xE0);
+			if (filter && is_channel_event) {
+				/* Copy event so the filter can modify the channel.  I'm not
+				   sure if this is necessary here (channels are mapped later in
+				   buffers anyway), but it preserves existing behaviour without
+				   destroying events in the model during read. */
+				Evoral::Event<Evoral::Beats> ev(*i, true);
+				if (!filter->filter(ev.buffer(), ev.size())) {
+					dst.write(time_frames, ev.event_type(), ev.size(), ev.buffer());
+				} else {
+					DEBUG_TRACE (DEBUG::MidiSourceIO,
+					             string_compose ("%1: filter event @ %2 type %3 size %4\n",
+					                             _name, time_frames, i->event_type(), i->size()));
+				}
+			} else {
+				dst.write (time_frames, i->event_type(), i->size(), i->buffer());
+			}
+
+#ifndef NDEBUG
+			if (DEBUG_ENABLED(DEBUG::MidiSourceIO)) {
+				DEBUG_STR_DECL(a);
+				DEBUG_STR_APPEND(a, string_compose ("%1 added event @ %2 sz %3 within %4 .. %5 ",
+				                                    _name, time_frames, i->size(),
+				                                    start + source_start, start + cnt + source_start));
+				for (size_t n=0; n < i->size(); ++n) {
+					DEBUG_STR_APPEND(a,hex);
+					DEBUG_STR_APPEND(a,"0x");
+					DEBUG_STR_APPEND(a,(int)i->buffer()[n]);
+					DEBUG_STR_APPEND(a,' ');
+				}
+				DEBUG_STR_APPEND(a,'\n');
+				DEBUG_TRACE (DEBUG::MidiSourceIO, DEBUG_STR(a).str());
+			}
+#endif
+
+			if (tracker) {
+				tracker->track (*i);
+			}
+		}
+	}
+
+	return cnt;
+}
+
+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) {
+		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;
+
+	TempoMap& map (_session.tempo_map());
+	BeatsFramesConverter converter(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::export_write_to (const Lock& lock, boost::shared_ptr<MidiSource> newsrc, Evoral::Beats begin, Evoral::Beats end)
+{
+	Lock newsrc_lock (newsrc->mutex ());
+
+	if (!_model) {
+		error << string_compose (_("programming error: %1"), X_("no model for MidiSource during export"));
+		return -1;
+	}
+
+	_model->write_section_to (newsrc, newsrc_lock, begin, end, true);
+
+	newsrc->flush_midi(newsrc_lock);
+
+	return 0;
+}
+
+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
+{
+	InterpolationStyleMap::const_iterator i = _interpolation_style.find (p);
+	if (i == _interpolation_style.end()) {
+		return EventTypeMap::instance().interpolation_of (p);
+	}
+
+	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 */
+}