2 Copyright (C) 2006 Paul Davis
3 Author: David Robillard
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/threads.h>
26 #include <boost/enable_shared_from_this.hpp>
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"
37 class MidiChannelFilter;
38 class MidiStateTracker;
41 template<typename T> class MidiRingBuffer;
43 /** Source for MIDI data */
44 class LIBARDOUR_API MidiSource : virtual public Source, public boost::enable_shared_from_this<MidiSource>
47 typedef Evoral::Beats TimeType;
49 MidiSource (Session& session, std::string name, Source::Flag flags = Source::Flag(0));
50 MidiSource (Session& session, const XMLNode&);
51 virtual ~MidiSource ();
53 /** Write the data in the given time range to another MidiSource
54 * \param newsrc MidiSource to which data will be written. Should be a
55 * new, empty source. If it already has contents, the results are
56 * undefined. Source must be writable.
57 * \param begin time of earliest event that can be written.
58 * \param end time of latest event that can be written.
59 * \return zero on success, non-zero if the write failed for any reason.
61 int write_to (const Lock& lock,
62 boost::shared_ptr<MidiSource> newsrc,
63 Evoral::Beats begin = Evoral::MinBeats,
64 Evoral::Beats end = Evoral::MaxBeats);
66 /** Export the midi data in the given time range to another MidiSource
67 * \param newsrc MidiSource to which data will be written. Should be a
68 * new, empty source. If it already has contents, the results are
69 * undefined. Source must be writable.
70 * \param begin time of earliest event that can be written.
71 * \param end time of latest event that can be written.
72 * \return zero on success, non-zero if the write failed for any reason.
74 int export_write_to (const Lock& lock,
75 boost::shared_ptr<MidiSource> newsrc,
79 /** Read the data in a given time range from the MIDI source.
80 * All time stamps in parameters are in audio frames (even if the source has tempo time).
81 * \param dst Ring buffer where read events are written.
82 * \param source_start Start position of the SOURCE in this read context.
83 * \param start Start of range to be read.
84 * \param cnt Length of range to be read (in audio frames).
85 * \param tracker an optional pointer to MidiStateTracker object, for note on/off tracking.
86 * \param filtered Parameters whose MIDI messages will not be returned.
88 virtual framecnt_t midi_read (const Lock& lock,
89 Evoral::EventSink<framepos_t>& dst,
90 framepos_t source_start,
93 MidiStateTracker* tracker,
94 MidiChannelFilter* filter,
95 const std::set<Evoral::Parameter>& filtered,
97 const double start_pulse) const;
99 /** Write data from a MidiRingBuffer to this source.
100 * @param source Source to read from.
101 * @param source_start This source's start position in session frames.
102 * @param cnt The length of time to write.
104 virtual framecnt_t midi_write (const Lock& lock,
105 MidiRingBuffer<framepos_t>& src,
106 framepos_t source_start,
109 /** Append a single event with a timestamp in beats.
111 * Caller must ensure that the event is later than the last written event.
113 virtual void append_event_beats(const Lock& lock,
114 const Evoral::Event<Evoral::Beats>& ev) = 0;
116 /** Append a single event with a timestamp in frames.
118 * Caller must ensure that the event is later than the last written event.
120 virtual void append_event_frames(const Lock& lock,
121 const Evoral::Event<framepos_t>& ev,
122 framepos_t source_start) = 0;
124 virtual bool empty () const;
125 virtual framecnt_t length (framepos_t pos) const;
126 virtual void update_length (framecnt_t);
128 virtual void mark_streaming_midi_write_started (const Lock& lock, NoteMode mode);
129 virtual void mark_streaming_write_started (const Lock& lock);
130 virtual void mark_streaming_write_completed (const Lock& lock);
132 /** Mark write starting with the given time parameters.
134 * This is called by MidiDiskStream::process before writing to the capture
135 * buffer which will be later read by midi_read().
137 * @param position The timeline position the source now starts at.
138 * @param capture_length The current length of the capture, which may not
139 * be zero if record is armed while rolling.
140 * @param loop_length The loop length if looping, otherwise zero.
142 void mark_write_starting_now (framecnt_t position,
143 framecnt_t capture_length,
144 framecnt_t loop_length);
146 /* like ::mark_streaming_write_completed() but with more arguments to
147 * allow control over MIDI-specific behaviour. Expected to be used only
148 * when recording actual MIDI input, rather then when importing files
151 virtual void mark_midi_streaming_write_completed (
153 Evoral::Sequence<Evoral::Beats>::StuckNoteOption stuck_option,
154 Evoral::Beats when = Evoral::Beats());
156 virtual void session_saved();
158 std::string captured_for() const { return _captured_for; }
159 void set_captured_for (std::string str) { _captured_for = str; }
161 static PBD::Signal1<void,MidiSource*> MidiSourceCreated;
163 XMLNode& get_state ();
164 int set_state (const XMLNode&, int version);
166 bool length_mutable() const { return true; }
168 void set_length_beats(TimeType l) { _length_beats = l; }
169 TimeType length_beats() const { return _length_beats; }
170 double length_pulse() const { return _length_pulse; }
172 virtual void load_model(const Glib::Threads::Mutex::Lock& lock, bool force_reload=false) = 0;
173 virtual void destroy_model(const Glib::Threads::Mutex::Lock& lock) = 0;
175 /** Reset cached information (like iterators) when things have changed.
176 * @param lock Source lock, which must be held by caller.
177 * @param notes If non-NULL, currently active notes are added to this set.
179 void invalidate(const Glib::Threads::Mutex::Lock& lock,
180 std::set<Evoral::Sequence<Evoral::Beats>::WeakNotePtr>* notes=NULL);
182 void set_note_mode(const Glib::Threads::Mutex::Lock& lock, NoteMode mode);
184 boost::shared_ptr<MidiModel> model() { return _model; }
185 void set_model(const Glib::Threads::Mutex::Lock& lock, boost::shared_ptr<MidiModel>);
186 void drop_model(const Glib::Threads::Mutex::Lock& lock);
188 Evoral::ControlList::InterpolationStyle interpolation_of (Evoral::Parameter) const;
189 void set_interpolation_of (Evoral::Parameter, Evoral::ControlList::InterpolationStyle);
190 void copy_interpolation_from (boost::shared_ptr<MidiSource>);
191 void copy_interpolation_from (MidiSource *);
193 AutoState automation_state_of (Evoral::Parameter) const;
194 void set_automation_state_of (Evoral::Parameter, AutoState);
195 void copy_automation_state_from (boost::shared_ptr<MidiSource>);
196 void copy_automation_state_from (MidiSource *);
198 /** Emitted when a different MidiModel is set */
199 PBD::Signal0<void> ModelChanged;
200 /** Emitted when a parameter's interpolation style is changed */
201 PBD::Signal2<void, Evoral::Parameter, Evoral::ControlList::InterpolationStyle> InterpolationChanged;
202 /** Emitted when a parameter's automation state is changed */
203 PBD::Signal2<void, Evoral::Parameter, AutoState> AutomationStateChanged;
206 virtual void flush_midi(const Lock& lock) = 0;
208 virtual framecnt_t read_unlocked (const Lock& lock,
209 Evoral::EventSink<framepos_t>& dst,
213 MidiStateTracker* tracker,
214 MidiChannelFilter* filter) const = 0;
216 /** Write data to this source from a MidiRingBuffer.
217 * @param source Buffer to read from.
218 * @param position This source's start position in session frames.
219 * @param cnt The duration of this block to write for.
221 virtual framecnt_t write_unlocked (const Lock& lock,
222 MidiRingBuffer<framepos_t>& source,
226 std::string _captured_for;
228 boost::shared_ptr<MidiModel> _model;
231 mutable Evoral::Sequence<Evoral::Beats>::const_iterator _model_iter;
232 mutable bool _model_iter_valid;
234 mutable Evoral::Beats _length_beats;
235 mutable double _length_pulse;
236 mutable framepos_t _last_read_end;
238 /** The total duration of the current capture. */
239 framepos_t _capture_length;
241 /** Length of transport loop during current capture, or zero. */
242 framepos_t _capture_loop_length;
244 /** Map of interpolation styles to use for Parameters; if they are not in this map,
245 * the correct interpolation style can be obtained from EventTypeMap::interpolation_of ()
247 typedef std::map<Evoral::Parameter, Evoral::ControlList::InterpolationStyle> InterpolationStyleMap;
248 InterpolationStyleMap _interpolation_style;
250 /** Map of automation states to use for Parameters; if they are not in this map,
251 * the correct automation state is Off.
253 typedef std::map<Evoral::Parameter, AutoState> AutomationStateMap;
254 AutomationStateMap _automation_state;
259 #endif /* __ardour_midi_source_h__ */