libs/ardour/ardour/midi_source.h

   1 /*
   2     Copyright (C) 2006 Paul Davis
   3         Written by Dave Robillard, 2006
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with this program; if not, write to the Free Software
  17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18 */
  19
  20 #ifndef __ardour_midi_source_h__
  21 #define __ardour_midi_source_h__
  22
  23 #include <string>
  24 #include <time.h>
  25 #include <sigc++/signal.h>
  26 #include <glibmm/thread.h>
  27 #include <pbd/stateful.h>
  28 #include <pbd/xml++.h>
  29 #include <evoral/Sequence.hpp>
  30 #include <ardour/ardour.h>
  31 #include <ardour/buffer.h>
  32 #include <ardour/source.h>
  33
  34 using std::string;
  35
  36 namespace ARDOUR {
  37
  38 class MidiModel;
  39 template<typename T> class MidiRingBuffer;
  40
  41 /** Source for MIDI data */
  42 class MidiSource : public Source
  43 {
  44   public:
  45         typedef double TimeType;
  46
  47         MidiSource (Session& session, string name);
  48         MidiSource (Session& session, const XMLNode&);
  49         virtual ~MidiSource ();
  50
  51         /* Stub Readable interface */
  52         virtual nframes64_t read (Sample*, nframes64_t pos, nframes64_t cnt, int channel) const { return 0; }
  53         virtual nframes64_t readable_length() const { return length(); }
  54         virtual uint32_t    n_channels () const { return 1; }
  55
  56         // FIXME: integrate this with the Readable::read interface somehow
  57         virtual nframes_t midi_read (MidiRingBuffer<nframes_t>& dst, nframes_t start, nframes_t cnt,
  58                         nframes_t stamp_offset, nframes_t negative_stamp_offset) const;
  59         virtual nframes_t midi_write (MidiRingBuffer<nframes_t>& src, nframes_t cnt);
  60
  61         virtual void append_event_unlocked_beats(const Evoral::Event<double>& ev) = 0;
  62         virtual void append_event_unlocked_frames(const Evoral::Event<nframes_t>& ev) = 0;
  63
  64         virtual void mark_for_remove() = 0;
  65         virtual void mark_streaming_midi_write_started (NoteMode mode, nframes_t start_time);
  66         virtual void mark_streaming_write_started ();
  67         virtual void mark_streaming_write_completed ();
  68
  69         uint64_t timeline_position ()                   { return _timeline_position; }
  70         void     set_timeline_position (nframes_t when) { _timeline_position = when; }
  71
  72         virtual void session_saved();
  73
  74         string captured_for() const { return _captured_for; }
  75         void   set_captured_for (string str) { _captured_for = str; }
  76
  77         uint32_t read_data_count()  const { return _read_data_count; }
  78         uint32_t write_data_count() const { return _write_data_count; }
  79
  80         static sigc::signal<void,MidiSource*> MidiSourceCreated;
  81
  82         // Signal a range of recorded data is available for reading from model()
  83         mutable sigc::signal<void,nframes_t,nframes_t> ViewDataRangeReady;
  84
  85         XMLNode& get_state ();
  86         int set_state (const XMLNode&);
  87
  88         bool length_mutable() const { return true; }
  89
  90         virtual void load_model(bool lock=true, bool force_reload=false) = 0;
  91         virtual void destroy_model() = 0;
  92
  93         void set_note_mode(NoteMode mode);
  94
  95         boost::shared_ptr<MidiModel> model() { return _model; }
  96         void set_model(boost::shared_ptr<MidiModel> m) { _model = m; }
  97         void drop_model() { _model.reset(); }
  98
  99   protected:
 100         virtual void flush_midi() = 0;
 101
 102         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;
 103         virtual nframes_t write_unlocked (MidiRingBuffer<nframes_t>& dst, nframes_t cnt) = 0;
 104
 105         mutable Glib::Mutex _lock;
 106         string              _captured_for;
 107         uint64_t            _timeline_position;
 108         mutable uint32_t    _read_data_count;  ///< modified in read()
 109         mutable uint32_t    _write_data_count; ///< modified in write()
 110
 111         boost::shared_ptr<MidiModel> _model;
 112         bool                         _writing;
 113
 114         mutable Evoral::Sequence<double>::const_iterator _model_iter;
 115         mutable nframes_t                                _last_read_end;
 116
 117   private:
 118         bool file_changed (string path);
 119 };
 120
 121 }
 122
 123 #endif /* __ardour_midi_source_h__ */