2 Copyright (C) 2006 Paul Davis
3 Written by Dave Robillard, 2006
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.
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.
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.
20 #ifndef __ardour_midi_source_h__
21 #define __ardour_midi_source_h__
25 #include <glibmm/thread.h>
26 #include "pbd/stateful.h"
27 #include "pbd/xml++.h"
28 #include "evoral/Sequence.hpp"
29 #include "ardour/ardour.h"
30 #include "ardour/buffer.h"
31 #include "ardour/source.h"
32 #include "ardour/beats_frames_converter.h"
36 class MidiStateTracker;
38 template<typename T> class MidiRingBuffer;
40 /** Source for MIDI data */
41 class MidiSource : virtual public Source
44 typedef double TimeType;
46 MidiSource (Session& session, std::string name, Source::Flag flags = Source::Flag(0));
47 MidiSource (Session& session, const XMLNode&);
48 virtual ~MidiSource ();
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 * \param tracker an optional pointer to MidiStateTracker object, for note on/off tracking
60 virtual nframes_t midi_read (Evoral::EventSink<nframes_t>& dst,
61 sframes_t source_start,
62 sframes_t start, nframes_t cnt,
63 sframes_t stamp_offset, sframes_t negative_stamp_offset, MidiStateTracker*) const;
65 virtual nframes_t midi_write (MidiRingBuffer<nframes_t>& src,
66 sframes_t source_start,
69 virtual void append_event_unlocked_beats(const Evoral::Event<Evoral::MusicalTime>& ev) = 0;
71 virtual void append_event_unlocked_frames(const Evoral::Event<nframes_t>& ev,
72 sframes_t source_start) = 0;
74 virtual sframes_t length (sframes_t pos) const;
75 virtual void update_length (sframes_t pos, sframes_t cnt);
77 virtual void mark_streaming_midi_write_started (NoteMode mode, sframes_t start_time);
78 virtual void mark_streaming_write_started ();
79 virtual void mark_streaming_write_completed ();
81 virtual void session_saved();
83 std::string captured_for() const { return _captured_for; }
84 void set_captured_for (std::string str) { _captured_for = str; }
86 uint32_t read_data_count() const { return _read_data_count; }
87 uint32_t write_data_count() const { return _write_data_count; }
89 static boost::signals2::signal<void(MidiSource*)> MidiSourceCreated;
91 // Signal a range of recorded data is available for reading from model()
92 mutable boost::signals2::signal<void(sframes_t,nframes_t)> ViewDataRangeReady;
94 XMLNode& get_state ();
95 int set_state (const XMLNode&, int version);
97 bool length_mutable() const { return true; }
99 virtual void load_model(bool lock=true, bool force_reload=false) = 0;
100 virtual void destroy_model() = 0;
102 /** This must be called with the source lock held whenever the
103 * source/model contents have been changed (reset iterators/cache/etc).
107 void set_note_mode(NoteMode mode);
109 boost::shared_ptr<MidiModel> model() { return _model; }
110 void set_model(boost::shared_ptr<MidiModel> m) { _model = m; }
111 void drop_model() { _model.reset(); }
114 virtual void flush_midi() = 0;
116 virtual nframes_t read_unlocked (Evoral::EventSink<nframes_t>& dst,
118 sframes_t start, nframes_t cnt,
119 sframes_t stamp_offset, sframes_t negative_stamp_offset,
120 MidiStateTracker* tracker) const = 0;
122 virtual nframes_t write_unlocked (MidiRingBuffer<nframes_t>& dst,
126 std::string _captured_for;
127 mutable uint32_t _read_data_count; ///< modified in read()
128 mutable uint32_t _write_data_count; ///< modified in write()
130 boost::shared_ptr<MidiModel> _model;
133 mutable Evoral::Sequence<Evoral::MusicalTime>::const_iterator _model_iter;
134 mutable bool _model_iter_valid;
136 mutable double _length_beats;
137 mutable sframes_t _last_read_end;
138 sframes_t _last_write_end;
143 #endif /* __ardour_midi_source_h__ */