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 #include "ardour/beats_frames_converter.h"
  34
  35 namespace ARDOUR {
  36
  37 class MidiModel;
  38 template<typename T> class MidiRingBuffer;
  39
  40 /** Source for MIDI data */
  41 class MidiSource : virtual public Source
  42 {
  43   public:
  44         typedef double TimeType;
  45
  46         MidiSource (Session& session, std::string name, Source::Flag flags = Source::Flag(0));
  47         MidiSource (Session& session, const XMLNode&);
  48         virtual ~MidiSource ();
  49
  50         /** Read the data in a given time range from the MIDI source.
  51          * All time stamps in parameters are in audio frames (even if the source has tempo time).
  52          * \param dst Ring buffer where read events are written
  53          * \param source_start Start position of the SOURCE in this read context
  54          * \param start Start of range to be read
  55          * \param cnt Length of range to be read (in audio frames)
  56          * \param stamp_offset Offset to add to event times written to dst
  57          * \param negative_stamp_offset Offset to subtract from event times written to dst
  58          */
  59         virtual nframes_t midi_read (MidiRingBuffer<nframes_t>& dst,
  60                         sframes_t source_start,
  61                         sframes_t start, nframes_t cnt,
  62                         sframes_t stamp_offset, sframes_t negative_stamp_offset) const;
  63
  64         virtual nframes_t midi_write (MidiRingBuffer<nframes_t>& src,
  65                         sframes_t source_start,
  66                         nframes_t cnt);
  67
  68         virtual void append_event_unlocked_beats(const Evoral::Event<Evoral::MusicalTime>& ev) = 0;
  69
  70         virtual void append_event_unlocked_frames(const Evoral::Event<nframes_t>& ev,
  71                         sframes_t source_start) = 0;
  72
  73         virtual sframes_t length (sframes_t pos) const;
  74         virtual void      update_length (sframes_t pos, sframes_t cnt);
  75
  76         virtual void mark_streaming_midi_write_started (NoteMode mode, sframes_t start_time);
  77         virtual void mark_streaming_write_started ();
  78         virtual void mark_streaming_write_completed ();
  79
  80         virtual void session_saved();
  81
  82         std::string captured_for() const               { return _captured_for; }
  83         void        set_captured_for (std::string str) { _captured_for = str; }
  84
  85         uint32_t read_data_count()  const { return _read_data_count; }
  86         uint32_t write_data_count() const { return _write_data_count; }
  87
  88         static sigc::signal<void,MidiSource*> MidiSourceCreated;
  89
  90         // Signal a range of recorded data is available for reading from model()
  91         mutable sigc::signal<void,sframes_t,nframes_t> ViewDataRangeReady;
  92
  93         XMLNode& get_state ();
  94         int set_state (const XMLNode&, int version = 3000);
  95
  96         bool length_mutable() const { return true; }
  97
  98         virtual void load_model(bool lock=true, bool force_reload=false) = 0;
  99         virtual void destroy_model() = 0;
 100
 101         /** This must be called with the source lock held whenever the
 102          *  source/model contents have been changed (reset iterators/cache/etc).
 103          */
 104         void invalidate();
 105
 106         void set_note_mode(NoteMode mode);
 107
 108         boost::shared_ptr<MidiModel> model() { return _model; }
 109         void set_model(boost::shared_ptr<MidiModel> m) { _model = m; }
 110         void drop_model() { _model.reset(); }
 111
 112   protected:
 113         virtual void flush_midi() = 0;
 114
 115         virtual nframes_t read_unlocked (MidiRingBuffer<nframes_t>& dst,
 116                         sframes_t position,
 117                         sframes_t start, nframes_t cnt,
 118                         sframes_t stamp_offset, sframes_t negative_stamp_offset) const = 0;
 119
 120         virtual nframes_t write_unlocked (MidiRingBuffer<nframes_t>& dst,
 121                         sframes_t position,
 122                         nframes_t cnt) = 0;
 123
 124         std::string      _captured_for;
 125         mutable uint32_t _read_data_count;  ///< modified in read()
 126         mutable uint32_t _write_data_count; ///< modified in write()
 127
 128         boost::shared_ptr<MidiModel> _model;
 129         bool                         _writing;
 130
 131         mutable Evoral::Sequence<Evoral::MusicalTime>::const_iterator _model_iter;
 132
 133         mutable double    _length_beats;
 134         mutable sframes_t _last_read_end;
 135         sframes_t         _last_write_end;
 136
 137   private:
 138         bool file_changed (std::string path);
 139 };
 140
 141 }
 142
 143 #endif /* __ardour_midi_source_h__ */