Remove unused punch+preroll API
[ardour.git] / libs / ardour / ardour / midi_source.h
index 29f88773a90f5087bf18dc324fd0117671ae97ab..82e90cec678f6945ddbea70a652c3cab5b8f0e25 100644 (file)
 #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 MidiChannelFilter;
-class MidiStateTracker;
 class MidiModel;
+class MidiStateTracker;
 
 template<typename T> class MidiRingBuffer;
 
@@ -45,7 +46,7 @@ template<typename T> class MidiRingBuffer;
 class LIBARDOUR_API MidiSource : virtual public Source, public boost::enable_shared_from_this<MidiSource>
 {
   public:
-       typedef Evoral::Beats TimeType;
+       typedef Temporal::Beats TimeType;
 
        MidiSource (Session& session, std::string name, Source::Flag flags = Source::Flag(0));
        MidiSource (Session& session, const XMLNode&);
@@ -61,8 +62,8 @@ class LIBARDOUR_API MidiSource : virtual public Source, public boost::enable_sha
         */
        int write_to (const Lock&                   lock,
                      boost::shared_ptr<MidiSource> newsrc,
-                     Evoral::Beats                 begin = Evoral::MinBeats,
-                     Evoral::Beats                 end   = Evoral::MaxBeats);
+                     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
@@ -74,60 +75,60 @@ class LIBARDOUR_API MidiSource : virtual public Source, public boost::enable_sha
         */
        int export_write_to (const Lock&                   lock,
                             boost::shared_ptr<MidiSource> newsrc,
-                            Evoral::Beats                 begin,
-                            Evoral::Beats                 end);
+                            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).
+        * 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 frames).
+        * \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 (const Lock&                        lock,
-                                     Evoral::EventSink<framepos_t>&     dst,
-                                     framepos_t                         source_start,
-                                     framepos_t                         start,
-                                     framecnt_t                         cnt,
-                                     Evoral::Range<framepos_t>*         loop_range,
+       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;
+                                     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 frames.
+        *  @param source_start This source's start position in session samples.
         *  @param cnt The length of time to write.
         */
-       virtual framecnt_t midi_write (const Lock&                 lock,
-                                      MidiRingBuffer<framepos_t>& src,
-                                      framepos_t                  source_start,
-                                      framecnt_t                  cnt);
+       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<Evoral::Beats>& ev) = 0;
+                                       const Evoral::Event<Temporal::Beats>& ev) = 0;
 
-       /** Append a single event with a timestamp in frames.
+       /** 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_frames(const Lock&                      lock,
-                                        const Evoral::Event<framepos_t>& ev,
-                                        framepos_t                       source_start) = 0;
+       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 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);
@@ -143,9 +144,9 @@ class LIBARDOUR_API MidiSource : virtual public Source, public boost::enable_sha
         * 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);
+       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
@@ -154,16 +155,14 @@ class LIBARDOUR_API MidiSource : virtual public Source, public boost::enable_sha
         */
        virtual void mark_midi_streaming_write_completed (
                const Lock&                                      lock,
-               Evoral::Sequence<Evoral::Beats>::StuckNoteOption stuck_option,
-               Evoral::Beats                                    when = Evoral::Beats());
+               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; }
 
-       static PBD::Signal1<void,MidiSource*> MidiSourceCreated;
-
        XMLNode& get_state ();
        int set_state (const XMLNode&, int version);
 
@@ -177,10 +176,11 @@ class LIBARDOUR_API MidiSource : virtual public Source, public boost::enable_sha
 
        /** 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(const Glib::Threads::Mutex::Lock&                       lock,
-                       std::set<Evoral::Sequence<Evoral::Beats>::WeakNotePtr>* notes=NULL);
+       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(const Glib::Threads::Mutex::Lock& lock, NoteMode mode);
 
@@ -208,41 +208,37 @@ class LIBARDOUR_API MidiSource : virtual public Source, public boost::enable_sha
   protected:
        virtual void flush_midi(const Lock& lock) = 0;
 
-       virtual framecnt_t read_unlocked (const Lock&                    lock,
-                                         Evoral::EventSink<framepos_t>& dst,
-                                         framepos_t                     position,
-                                         framepos_t                     start,
-                                         framecnt_t                     cnt,
-                                         Evoral::Range<framepos_t>*     loop_range,
+       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 frames.
+        *  @param position This source's start position in session samples.
         *  @param cnt The duration of this block to write for.
         */
-       virtual framecnt_t write_unlocked (const Lock&                 lock,
-                                          MidiRingBuffer<framepos_t>& source,
-                                          framepos_t                  position,
-                                          framecnt_t                  cnt) = 0;
+       virtual samplecnt_t write_unlocked (const Lock&                 lock,
+                                          MidiRingBuffer<samplepos_t>& source,
+                                          samplepos_t                  position,
+                                          samplecnt_t                  cnt) = 0;
 
        std::string _captured_for;
 
        boost::shared_ptr<MidiModel> _model;
        bool                         _writing;
 
-       mutable Evoral::Sequence<Evoral::Beats>::const_iterator _model_iter;
-       mutable bool                                            _model_iter_valid;
-
-       mutable Evoral::Beats _length_beats;
-       mutable framepos_t    _last_read_end;
+       Temporal::Beats _length_beats;
 
        /** The total duration of the current capture. */
-       framepos_t _capture_length;
+       samplepos_t _capture_length;
 
        /** Length of transport loop during current capture, or zero. */
-       framepos_t _capture_loop_length;
+       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 ()