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
  25 #include <time.h>
  26
  27 #include <glibmm/thread.h>
  28
  29 #include <sigc++/signal.h>
  30
  31 #include <ardour/source.h>
  32 #include <ardour/ardour.h>
  33 #include <ardour/buffer.h>
  34 #include <ardour/midi_model.h>
  35 #include <pbd/stateful.h>
  36 #include <pbd/xml++.h>
  37
  38 using std::string;
  39
  40 namespace ARDOUR {
  41
  42 template<typename T> class MidiRingBuffer;
  43
  44 /** Source for MIDI data */
  45 class MidiSource : public Source
  46 {
  47   public:
  48         typedef double TimeType;
  49
  50         MidiSource (Session& session, string name);
  51         MidiSource (Session& session, const XMLNode&);
  52         virtual ~MidiSource ();
  53
  54         /* Stub Readable interface */
  55         virtual nframes64_t read (Sample*, nframes64_t pos, nframes64_t cnt, int channel) const { return 0; }
  56         virtual nframes64_t readable_length() const { return length(); }
  57         virtual uint32_t    n_channels () const { return 1; }
  58
  59         // FIXME: integrate this with the Readable::read interface somehow
  60         virtual nframes_t midi_read (MidiRingBuffer<TimeType>& dst, nframes_t start, nframes_t cnt, nframes_t stamp_offset, nframes_t negative_stamp_offset) const;
  61         virtual nframes_t midi_write (MidiRingBuffer<TimeType>& src, nframes_t cnt);
  62
  63         virtual void append_event_unlocked(EventTimeUnit unit, const Evoral::Event<TimeType>& ev) = 0;
  64
  65         virtual void mark_for_remove() = 0;
  66         virtual void mark_streaming_midi_write_started (NoteMode mode, nframes_t start_time);
  67         virtual void mark_streaming_write_started ();
  68         virtual void mark_streaming_write_completed ();
  69
  70         uint64_t timeline_position ()                   { return _timeline_position; }
  71         void     set_timeline_position (nframes_t when) { _timeline_position = when; }
  72
  73         virtual void session_saved();
  74
  75         string captured_for() const { return _captured_for; }
  76         void   set_captured_for (string str) { _captured_for = str; }
  77
  78         uint32_t read_data_count()  const { return _read_data_count; }
  79         uint32_t write_data_count() const { return _write_data_count; }
  80
  81         static sigc::signal<void,MidiSource*> MidiSourceCreated;
  82
  83         // Signal a range of recorded data is available for reading from model()
  84         mutable sigc::signal<void,nframes_t,nframes_t> ViewDataRangeReady;
  85
  86         XMLNode& get_state ();
  87         int set_state (const XMLNode&);
  88
  89         bool length_mutable() const { return true; }
  90
  91         virtual void load_model(bool lock=true, bool force_reload=false) = 0;
  92         virtual void destroy_model() = 0;
  93
  94         void set_note_mode(NoteMode mode) { if (_model) _model->set_note_mode(mode); }
  95
  96         boost::shared_ptr<MidiModel> model() { return _model; }
  97         void set_model(boost::shared_ptr<MidiModel> m) { _model = m; }
  98
  99   protected:
 100         virtual void flush_midi() = 0;
 101         //virtual int flush_header() = 0;
 102         //virtual int flush_footer() = 0;
 103
 104         virtual nframes_t read_unlocked (MidiRingBuffer<TimeType>& dst, nframes_t start, nframes_t cnt, nframes_t stamp_offset, nframes_t negative_stamp_offset) const = 0;
 105         virtual nframes_t write_unlocked (MidiRingBuffer<TimeType>& dst, nframes_t cnt) = 0;
 106
 107         mutable Glib::Mutex _lock;
 108         string              _captured_for;
 109         uint64_t            _timeline_position;
 110         mutable uint32_t    _read_data_count;  ///< modified in read()
 111         mutable uint32_t    _write_data_count; ///< modified in write()
 112
 113         boost::shared_ptr<MidiModel> _model;
 114         bool                         _writing;
 115
 116   private:
 117         bool file_changed (string path);
 118 };
 119
 120 }
 121
 122 #endif /* __ardour_midi_source_h__ */