X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=libs%2Fardour%2Fardour%2Fmidi_source.h;h=6a55398ca9a2afbacb5c21c5a238b3cc23a682fb;hb=5c32fc3babdd3ed7d715b6aeb24a72f3a0f550a0;hp=a7b47efe21fe01b0ecf390a98a220a828e48a6bb;hpb=a473d630eb165272992e90f8d854b1d66ec0be63;p=ardour.git diff --git a/libs/ardour/ardour/midi_source.h b/libs/ardour/ardour/midi_source.h index a7b47efe21..6a55398ca9 100644 --- a/libs/ardour/ardour/midi_source.h +++ b/libs/ardour/ardour/midi_source.h @@ -22,7 +22,7 @@ #include #include -#include +#include #include #include "pbd/stateful.h" #include "pbd/xml++.h" @@ -34,63 +34,115 @@ namespace ARDOUR { +class MidiChannelFilter; class MidiStateTracker; class MidiModel; + template class MidiRingBuffer; /** Source for MIDI data */ -class MidiSource : virtual public Source, public boost::enable_shared_from_this +class LIBARDOUR_API MidiSource : virtual public Source, public boost::enable_shared_from_this { public: - typedef double TimeType; + typedef Evoral::Beats TimeType; MidiSource (Session& session, std::string name, Source::Flag flags = Source::Flag(0)); MidiSource (Session& session, const XMLNode&); virtual ~MidiSource (); - boost::shared_ptr clone (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 newsrc, + Evoral::Beats begin = Evoral::MinBeats, + Evoral::Beats end = Evoral::MaxBeats); /** 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 + * \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. + * \param filtered Parameters whose MIDI messages will not be returned. */ - virtual framecnt_t midi_read (Evoral::EventSink& dst, - framepos_t source_start, - framepos_t start, framecnt_t cnt, - MidiStateTracker*, - std::set const &) const; - - virtual framecnt_t midi_write (MidiRingBuffer& src, - framepos_t source_start, - framecnt_t cnt); - - virtual void append_event_unlocked_beats(const Evoral::Event& ev) = 0; + virtual framecnt_t midi_read (const Lock& lock, + Evoral::EventSink& dst, + framepos_t source_start, + framepos_t start, + framecnt_t cnt, + MidiStateTracker* tracker, + MidiChannelFilter* filter, + const std::set& filtered) 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 frames. + * @param cnt The length of time to write. + */ + virtual framecnt_t midi_write (const Lock& lock, + MidiRingBuffer& src, + framepos_t source_start, + framecnt_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& ev) = 0; - virtual void append_event_unlocked_frames(const Evoral::Event& ev, - framepos_t source_start) = 0; + /** Append a single event with a timestamp in frames. + * + * Caller must ensure that the event is later than the last written event. + */ + virtual void append_event_frames(const Lock& lock, + const Evoral::Event& ev, + framepos_t source_start) = 0; virtual bool empty () const; virtual framecnt_t length (framepos_t pos) const; - virtual void update_length (framepos_t pos, framecnt_t cnt); - - 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 void update_length (framecnt_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 (framecnt_t position, + framecnt_t capture_length, + framecnt_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 ( + const Lock& lock, + Evoral::Sequence::StuckNoteOption stuck_option, + Evoral::Beats when = Evoral::Beats()); virtual void session_saved(); std::string captured_for() const { return _captured_for; } void set_captured_for (std::string str) { _captured_for = str; } - uint32_t read_data_count() const { return _read_data_count; } - uint32_t write_data_count() const { return _write_data_count; } - static PBD::Signal1 MidiSourceCreated; XMLNode& get_state (); @@ -98,22 +150,24 @@ class MidiSource : virtual public Source, public boost::enable_shared_from_this< 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. + * @param notes If non-NULL, currently active notes are added to this set. */ - void invalidate(); + void invalidate(const Glib::Threads::Mutex::Lock& lock, + std::set::WeakNotePtr>* notes=NULL); - void set_note_mode(NoteMode mode); + void set_note_mode(const Glib::Threads::Mutex::Lock& lock, NoteMode mode); boost::shared_ptr model() { return _model; } - void set_model (boost::shared_ptr); - void drop_model(); + void set_model(const Glib::Threads::Mutex::Lock& lock, boost::shared_ptr); + 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); @@ -133,30 +187,42 @@ class MidiSource : virtual public Source, public boost::enable_shared_from_this< PBD::Signal2 AutomationStateChanged; protected: - virtual void flush_midi() = 0; - - virtual framepos_t read_unlocked (Evoral::EventSink& dst, - framepos_t position, - framepos_t start, framecnt_t cnt, - MidiStateTracker* tracker) const = 0; - - virtual framepos_t write_unlocked (MidiRingBuffer& dst, - framepos_t position, - framecnt_t cnt) = 0; + virtual void flush_midi(const Lock& lock) = 0; + + virtual framecnt_t read_unlocked (const Lock& lock, + Evoral::EventSink& dst, + framepos_t position, + framepos_t start, + framecnt_t cnt, + 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 frames. + * @param cnt The duration of this block to write for. + */ + virtual framecnt_t write_unlocked (const Lock& lock, + MidiRingBuffer& source, + framepos_t position, + framecnt_t cnt) = 0; - std::string _captured_for; - mutable uint32_t _read_data_count; ///< modified in read() - mutable uint32_t _write_data_count; ///< modified in write() + std::string _captured_for; boost::shared_ptr _model; bool _writing; - mutable Evoral::Sequence::const_iterator _model_iter; - mutable bool _model_iter_valid; + mutable Evoral::Sequence::const_iterator _model_iter; + mutable bool _model_iter_valid; + + mutable Evoral::Beats _length_beats; + mutable framepos_t _last_read_end; + + /** The total duration of the current capture. */ + framepos_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. */ + framepos_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 ()