#include <string>
#include <time.h>
-#include <glibmm/thread.h>
+#include <glibmm/threads.h>
#include <boost/enable_shared_from_this.hpp>
#include "pbd/stateful.h"
#include "pbd/xml++.h"
#include "evoral/Sequence.hpp"
+#include "evoral/Range.hpp"
#include "ardour/ardour.h"
#include "ardour/buffer.h"
+#include "ardour/midi_cursor.h"
#include "ardour/source.h"
-#include "ardour/beats_frames_converter.h"
+#include "ardour/beats_samples_converter.h"
namespace ARDOUR {
-class MidiStateTracker;
+class MidiChannelFilter;
class MidiModel;
+class MidiStateTracker;
+
template<typename T> class MidiRingBuffer;
/** Source for MIDI data */
-class MidiSource : virtual public Source, public boost::enable_shared_from_this<MidiSource>
+class LIBARDOUR_API MidiSource : virtual public Source, public boost::enable_shared_from_this<MidiSource>
{
public:
- typedef double TimeType;
+ typedef Temporal::Beats TimeType;
MidiSource (Session& session, std::string name, Source::Flag flags = Source::Flag(0));
MidiSource (Session& session, const XMLNode&);
virtual ~MidiSource ();
- boost::shared_ptr<MidiSource> clone (const std::string& path,
- Evoral::MusicalTime begin = Evoral::MinMusicalTime,
- Evoral::MusicalTime end = Evoral::MaxMusicalTime);
+ /** Write the data in the given time range to another MidiSource
+ * \param newsrc MidiSource to which data will be written. Should be a
+ * new, empty source. If it already has contents, the results are
+ * undefined. Source must be writable.
+ * \param begin time of earliest event that can be written.
+ * \param end time of latest event that can be written.
+ * \return zero on success, non-zero if the write failed for any reason.
+ */
+ int write_to (const Lock& lock,
+ boost::shared_ptr<MidiSource> newsrc,
+ Temporal::Beats begin = Temporal::Beats(),
+ Temporal::Beats end = std::numeric_limits<Temporal::Beats>::max());
+
+ /** Export the midi data in the given time range to another MidiSource
+ * \param newsrc MidiSource to which data will be written. Should be a
+ * new, empty source. If it already has contents, the results are
+ * undefined. Source must be writable.
+ * \param begin time of earliest event that can be written.
+ * \param end time of latest event that can be written.
+ * \return zero on success, non-zero if the write failed for any reason.
+ */
+ int export_write_to (const Lock& lock,
+ boost::shared_ptr<MidiSource> newsrc,
+ Temporal::Beats begin,
+ Temporal::Beats end);
/** Read the data in a given time range from the MIDI source.
- * All time stamps in parameters are in audio frames (even if the source has tempo time).
- * \param dst Ring buffer where read events are written
- * \param source_start Start position of the SOURCE in this read context
- * \param start Start of range to be read
- * \param cnt Length of range to be read (in audio frames)
- * \param tracker an optional pointer to MidiStateTracker object, for note on/off tracking
+ * All time stamps in parameters are in audio samples (even if the source has tempo time).
+ * \param dst Ring buffer where read events are written.
+ * \param source_start Start position of the SOURCE in this read context.
+ * \param start Start of range to be read.
+ * \param cnt Length of range to be read (in audio samples).
+ * \param loop_range If non-null, all event times will be mapped into this loop range.
+ * \param tracker an optional pointer to MidiStateTracker object, for note on/off tracking.
+ * \param filtered Parameters whose MIDI messages will not be returned.
*/
- virtual framecnt_t midi_read (Evoral::EventSink<framepos_t>& dst,
- framepos_t source_start,
- framepos_t start, framecnt_t cnt,
- MidiStateTracker*,
- std::set<Evoral::Parameter> const &) const;
-
- virtual framecnt_t midi_write (MidiRingBuffer<framepos_t>& src,
- framepos_t source_start,
- framecnt_t cnt);
-
- virtual void append_event_unlocked_beats(const Evoral::Event<Evoral::MusicalTime>& ev) = 0;
+ virtual samplecnt_t midi_read (const Lock& lock,
+ Evoral::EventSink<samplepos_t>& dst,
+ samplepos_t source_start,
+ samplepos_t start,
+ samplecnt_t cnt,
+ Evoral::Range<samplepos_t>* loop_range,
+ MidiCursor& cursor,
+ MidiStateTracker* tracker,
+ MidiChannelFilter* filter,
+ const std::set<Evoral::Parameter>& filtered,
+ const double pulse,
+ const double start_beats) const;
+
+ /** Write data from a MidiRingBuffer to this source.
+ * @param source Source to read from.
+ * @param source_start This source's start position in session samples.
+ * @param cnt The length of time to write.
+ */
+ virtual samplecnt_t midi_write (const Lock& lock,
+ MidiRingBuffer<samplepos_t>& src,
+ samplepos_t source_start,
+ samplecnt_t cnt);
+
+ /** Append a single event with a timestamp in beats.
+ *
+ * Caller must ensure that the event is later than the last written event.
+ */
+ virtual void append_event_beats(const Lock& lock,
+ const Evoral::Event<Temporal::Beats>& ev) = 0;
- virtual void append_event_unlocked_frames(const Evoral::Event<framepos_t>& ev,
- framepos_t source_start) = 0;
+ /** Append a single event with a timestamp in samples.
+ *
+ * Caller must ensure that the event is later than the last written event.
+ */
+ virtual void append_event_samples(const Lock& lock,
+ const Evoral::Event<samplepos_t>& ev,
+ samplepos_t source_start) = 0;
virtual bool empty () const;
- virtual framecnt_t length (framepos_t pos) const;
- virtual void update_length (framecnt_t);
-
- virtual void mark_streaming_midi_write_started (NoteMode mode);
- virtual void mark_streaming_write_started ();
- virtual void mark_streaming_write_completed ();
- void mark_write_starting_now ();
+ virtual samplecnt_t length (samplepos_t pos) const;
+ virtual void update_length (samplecnt_t);
+
+ virtual void mark_streaming_midi_write_started (const Lock& lock, NoteMode mode);
+ virtual void mark_streaming_write_started (const Lock& lock);
+ virtual void mark_streaming_write_completed (const Lock& lock);
+
+ /** Mark write starting with the given time parameters.
+ *
+ * This is called by MidiDiskStream::process before writing to the capture
+ * buffer which will be later read by midi_read().
+ *
+ * @param position The timeline position the source now starts at.
+ * @param capture_length The current length of the capture, which may not
+ * be zero if record is armed while rolling.
+ * @param loop_length The loop length if looping, otherwise zero.
+ */
+ void mark_write_starting_now (samplecnt_t position,
+ samplecnt_t capture_length,
+ samplecnt_t loop_length);
/* like ::mark_streaming_write_completed() but with more arguments to
* allow control over MIDI-specific behaviour. Expected to be used only
* when recording actual MIDI input, rather then when importing files
* etc.
*/
- virtual void mark_midi_streaming_write_completed (Evoral::Sequence<Evoral::MusicalTime>::StuckNoteOption, Evoral::MusicalTime when = 0);
+ virtual void mark_midi_streaming_write_completed (
+ const Lock& lock,
+ Evoral::Sequence<Temporal::Beats>::StuckNoteOption stuck_option,
+ Temporal::Beats when = Temporal::Beats());
virtual void session_saved();
std::string captured_for() const { return _captured_for; }
void set_captured_for (std::string str) { _captured_for = str; }
- framepos_t last_write_end() const { return _last_write_end; }
- void set_last_write_end (framepos_t pos) { _last_write_end = pos; }
-
- static PBD::Signal1<void,MidiSource*> MidiSourceCreated;
-
XMLNode& get_state ();
int set_state (const XMLNode&, int version);
bool length_mutable() const { return true; }
- void set_length_beats(double l) { _length_beats = l; }
- double length_beats() const { return _length_beats; }
+ void set_length_beats(TimeType l) { _length_beats = l; }
+ TimeType length_beats() const { return _length_beats; }
- virtual void load_model(bool lock=true, bool force_reload=false) = 0;
- virtual void destroy_model() = 0;
+ virtual void load_model(const Glib::Threads::Mutex::Lock& lock, bool force_reload=false) = 0;
+ virtual void destroy_model(const Glib::Threads::Mutex::Lock& lock) = 0;
- /** This must be called with the source lock held whenever the
- * source/model contents have been changed (reset iterators/cache/etc).
+ /** Reset cached information (like iterators) when things have changed.
+ * @param lock Source lock, which must be held by caller.
*/
- void invalidate();
+ void invalidate(const Glib::Threads::Mutex::Lock& lock);
+
+ /** Thou shalt not emit this directly, use invalidate() instead. */
+ mutable PBD::Signal1<void, bool> Invalidated;
- void set_note_mode(NoteMode mode);
+ void set_note_mode(const Glib::Threads::Mutex::Lock& lock, NoteMode mode);
boost::shared_ptr<MidiModel> model() { return _model; }
- void set_model (boost::shared_ptr<MidiModel>);
- void drop_model();
+ void set_model(const Glib::Threads::Mutex::Lock& lock, boost::shared_ptr<MidiModel>);
+ void drop_model(const Glib::Threads::Mutex::Lock& lock);
Evoral::ControlList::InterpolationStyle interpolation_of (Evoral::Parameter) const;
void set_interpolation_of (Evoral::Parameter, Evoral::ControlList::InterpolationStyle);
PBD::Signal2<void, Evoral::Parameter, AutoState> AutomationStateChanged;
protected:
- virtual void flush_midi() = 0;
-
- virtual framecnt_t read_unlocked (Evoral::EventSink<framepos_t>& dst,
- framepos_t position,
- framepos_t start, framecnt_t cnt,
- MidiStateTracker* tracker) const = 0;
-
- virtual framecnt_t write_unlocked (MidiRingBuffer<framepos_t>& dst,
- framepos_t position,
- framecnt_t cnt) = 0;
+ virtual void flush_midi(const Lock& lock) = 0;
+
+ virtual samplecnt_t read_unlocked (const Lock& lock,
+ Evoral::EventSink<samplepos_t>& dst,
+ samplepos_t position,
+ samplepos_t start,
+ samplecnt_t cnt,
+ Evoral::Range<samplepos_t>* loop_range,
+ MidiStateTracker* tracker,
+ MidiChannelFilter* filter) const = 0;
+
+ /** Write data to this source from a MidiRingBuffer.
+ * @param source Buffer to read from.
+ * @param position This source's start position in session samples.
+ * @param cnt The duration of this block to write for.
+ */
+ virtual samplecnt_t write_unlocked (const Lock& lock,
+ MidiRingBuffer<samplepos_t>& source,
+ samplepos_t position,
+ samplecnt_t cnt) = 0;
- std::string _captured_for;
+ std::string _captured_for;
boost::shared_ptr<MidiModel> _model;
bool _writing;
- mutable Evoral::Sequence<Evoral::MusicalTime>::const_iterator _model_iter;
- mutable bool _model_iter_valid;
+ Temporal::Beats _length_beats;
+
+ /** The total duration of the current capture. */
+ samplepos_t _capture_length;
- mutable double _length_beats;
- mutable framepos_t _last_read_end;
- framepos_t _last_write_end;
+ /** Length of transport loop during current capture, or zero. */
+ samplepos_t _capture_loop_length;
/** Map of interpolation styles to use for Parameters; if they are not in this map,
* the correct interpolation style can be obtained from EventTypeMap::interpolation_of ()