Readable is not as generic as its name implies ;)
[ardour.git] / libs / ardour / ardour / midi_source.h
index 1c002890033270706779ff9be583e3273ea8b175..774b3ab37274c6cfef3fb8e91ca2da3bc5934e17 100644 (file)
 #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 <glibmm/thread.h>
 #include <pbd/stateful.h>
 #include <pbd/xml++.h>
-
-using std::string;
+#include <evoral/Sequence.hpp>
+#include <ardour/ardour.h>
+#include <ardour/buffer.h>
+#include <ardour/source.h>
+#include <ardour/beats_frames_converter.h>
 
 namespace ARDOUR {
 
-/** Source for raw MIDI data */
-class MidiSource : public Source
+class MidiModel;
+template<typename T> class MidiRingBuffer;
+
+/** Source for MIDI data */
+class MidiSource : virtual public Source
 {
   public:
-       MidiSource (string name);
-       MidiSource (const XMLNode&);
+       typedef double TimeType;
+
+       MidiSource (Session& session, std::string name, Source::Flag flags = Source::Flag(0));
+       MidiSource (Session& session, const XMLNode&);
        virtual ~MidiSource ();
+       
+       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 jack_nframes_t read (RawMidi *dst, jack_nframes_t start, jack_nframes_t cnt) const;
-       virtual jack_nframes_t write (RawMidi *src, jack_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_write_completed () {}
+       virtual void mark_streaming_midi_write_started (NoteMode mode, nframes_t start_time);
+       virtual void mark_streaming_write_started ();
+       virtual void mark_streaming_write_completed ();
+       
+       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;
               
-       mutable sigc::signal<void>  PeaksReady;
-       mutable sigc::signal<void,jack_nframes_t,jack_nframes_t>  PeakRangeReady;
+       // Signal a range of recorded data is available for reading from model()
+       mutable sigc::signal<void,nframes_t,nframes_t> ViewDataRangeReady;
        
        XMLNode& get_state ();
        int set_state (const XMLNode&);
+       
+       bool length_mutable() const { return true; }
+
+       virtual void load_model(bool lock=true, bool force_reload=false) = 0;
+       virtual void destroy_model() = 0;
+
+       /** 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);
+       
+       void set_timeline_position (int64_t pos);
+
+       boost::shared_ptr<MidiModel> model() { return _model; }
+       void set_model(boost::shared_ptr<MidiModel> m) { _model = m; }
+       void drop_model() { _model.reset(); }
+
+       const Evoral::TimeConverter<double, nframes_t>& time_converter() const {
+               return _converter;
+       }
 
   protected:
-       virtual jack_nframes_t read_unlocked (RawMidi* dst, jack_nframes_t start, jack_nframes_t cn) const = 0;
-       virtual jack_nframes_t write_unlocked (RawMidi* dst, jack_nframes_t cnt) = 0;
+       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;
+       std::string         _captured_for;
        mutable uint32_t    _read_data_count;  ///< modified in read()
        mutable uint32_t    _write_data_count; ///< modified in write()
+       
+       BeatsFramesConverter _converter;
+
+       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);
+       bool file_changed (std::string path);
 };
 
 }