make 3.0 catch up with transport and other changes in 2.X (hand applied, not merged)
[ardour.git] / libs / ardour / ardour / midi_source.h
index f5c660d9cb1b2ea16b7acf248ee18536cc7a04af..dfbd5ea6a2f1377bed86fba0802099944ed5ab2b 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2006 Paul Davis 
+    Copyright (C) 2006 Paul Davis
        Written by Dave Robillard, 2006
 
     This program is free software; you can redistribute it and/or modify
 #define __ardour_midi_source_h__
 
 #include <string>
-
 #include <time.h>
-
-#include <glibmm/thread.h>
-
 #include <sigc++/signal.h>
-
-#include <ardour/source.h>
-#include <ardour/ardour.h>
-#include <ardour/buffer.h>
-#include <ardour/midi_model.h>
-#include <pbd/stateful.h>
-#include <pbd/xml++.h>
-
-using std::string;
+#include <glibmm/thread.h>
+#include "pbd/stateful.h"
+#include "pbd/xml++.h"
+#include "evoral/Sequence.hpp"
+#include "ardour/ardour.h"
+#include "ardour/buffer.h"
+#include "ardour/source.h"
+#include "ardour/beats_frames_converter.h"
 
 namespace ARDOUR {
 
+class MidiStateTracker;
+class MidiModel;
 template<typename T> class MidiRingBuffer;
 
 /** Source for MIDI data */
-class MidiSource : public Source
+class MidiSource : virtual public Source
 {
   public:
        typedef double TimeType;
 
-       MidiSource (Session& session, string name);
+       MidiSource (Session& session, std::string name, Source::Flag flags = Source::Flag(0));
        MidiSource (Session& session, const XMLNode&);
        virtual ~MidiSource ();
-       
-       /* Stub Readable interface */
-       virtual nframes64_t read (Sample*, nframes64_t pos, nframes64_t cnt, int channel) const { return 0; }
-       virtual nframes64_t readable_length() const { return length(); }
-       virtual uint32_t    n_channels () const { return 1; }
-       
-       // FIXME: integrate this with the Readable::read interface somehow
-       virtual nframes_t midi_read (MidiRingBuffer<nframes_t>& dst, nframes_t start, nframes_t cnt,
-                       nframes_t stamp_offset, nframes_t negative_stamp_offset) const;
-       virtual nframes_t midi_write (MidiRingBuffer<nframes_t>& src, nframes_t cnt);
-
-       virtual void append_event_unlocked_beats(const Evoral::Event<double>& ev) = 0;
-       virtual void append_event_unlocked_frames(const Evoral::Event<nframes_t>& ev) = 0;
-
-       virtual void mark_for_remove() = 0;
-       virtual void mark_streaming_midi_write_started (NoteMode mode, nframes_t start_time);
+
+       /** 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 stamp_offset Offset to add to event times written to dst
+        * \param negative_stamp_offset Offset to subtract from event times written to dst
+        * \param tracker an optional pointer to MidiStateTracker object, for note on/off tracking
+        */
+       virtual nframes_t midi_read (Evoral::EventSink<nframes_t>& dst,
+                                    sframes_t source_start,
+                                    sframes_t start, nframes_t cnt,
+                                    sframes_t stamp_offset, sframes_t negative_stamp_offset, MidiStateTracker*) const;
+
+       virtual nframes_t midi_write (MidiRingBuffer<nframes_t>& src,
+                                     sframes_t source_start,
+                                     nframes_t cnt);
+
+       virtual void append_event_unlocked_beats(const Evoral::Event<Evoral::MusicalTime>& ev) = 0;
+
+       virtual void append_event_unlocked_frames(const Evoral::Event<nframes_t>& ev,
+                       sframes_t source_start) = 0;
+
+       virtual sframes_t length (sframes_t pos) const;
+       virtual void      update_length (sframes_t pos, sframes_t cnt);
+
+       virtual void mark_streaming_midi_write_started (NoteMode mode, sframes_t start_time);
        virtual void mark_streaming_write_started ();
        virtual void mark_streaming_write_completed ();
-       
-       uint64_t timeline_position ()                   { return _timeline_position; }
-       void     set_timeline_position (nframes_t when) { _timeline_position = when; }
-       
+
        virtual void session_saved();
 
-       string captured_for() const { return _captured_for; }
-       void   set_captured_for (string str) { _captured_for = str; }
+       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 sigc::signal<void,MidiSource*> MidiSourceCreated;
-              
+
        // Signal a range of recorded data is available for reading from model()
-       mutable sigc::signal<void,nframes_t,nframes_t> ViewDataRangeReady;
-       
+       mutable sigc::signal<void,sframes_t,nframes_t> ViewDataRangeReady;
+
        XMLNode& get_state ();
-       int set_state (const XMLNode&);
-       
+       int set_state (const XMLNode&, int version);
+
        bool length_mutable() const { return true; }
 
        virtual void load_model(bool lock=true, bool force_reload=false) = 0;
        virtual void destroy_model() = 0;
 
-       void set_note_mode(NoteMode mode) { if (_model) _model->set_note_mode(mode); }
+       /** This must be called with the source lock held whenever the
+        *  source/model contents have been changed (reset iterators/cache/etc).
+        */
+       void invalidate();
+
+       void set_note_mode(NoteMode mode);
 
        boost::shared_ptr<MidiModel> model() { return _model; }
        void set_model(boost::shared_ptr<MidiModel> m) { _model = m; }
@@ -101,24 +113,30 @@ class MidiSource : public Source
 
   protected:
        virtual void flush_midi() = 0;
-       
-       virtual nframes_t read_unlocked (MidiRingBuffer<nframes_t>& dst, nframes_t start, nframes_t cnt, nframes_t stamp_offset, nframes_t negative_stamp_offset) const = 0;
-       virtual nframes_t write_unlocked (MidiRingBuffer<nframes_t>& dst, nframes_t cnt) = 0;
-       
-       mutable Glib::Mutex _lock;
-       string              _captured_for;
-       uint64_t            _timeline_position;
-       mutable uint32_t    _read_data_count;  ///< modified in read()
-       mutable uint32_t    _write_data_count; ///< modified in write()
+
+       virtual nframes_t read_unlocked (Evoral::EventSink<nframes_t>& dst,
+                                        sframes_t position,
+                                        sframes_t start, nframes_t cnt,
+                                        sframes_t stamp_offset, sframes_t negative_stamp_offset,
+                                        MidiStateTracker* tracker) const = 0;
+
+       virtual nframes_t write_unlocked (MidiRingBuffer<nframes_t>& dst,
+                       sframes_t position,
+                       nframes_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()
 
        boost::shared_ptr<MidiModel> _model;
        bool                         _writing;
-       
-       mutable Evoral::Sequence<double>::const_iterator _model_iter;
-       mutable nframes_t                                _last_read_end;
 
-  private:
-       bool file_changed (string path);
+       mutable Evoral::Sequence<Evoral::MusicalTime>::const_iterator _model_iter;
+       mutable bool                                                  _model_iter_valid;
+
+       mutable double    _length_beats;
+       mutable sframes_t _last_read_end;
+       sframes_t         _last_write_end;
 };
 
 }