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