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 /** Read the data in a given time range from the MIDI source.
67 * All time stamps in parameters are in audio frames (even if the source has tempo time).
68 * \param dst Ring buffer where read events are written.
69 * \param source_start Start position of the SOURCE in this read context.
70 * \param start Start of range to be read.
71 * \param cnt Length of range to be read (in audio frames).
72 * \param tracker an optional pointer to MidiStateTracker object, for note on/off tracking.
73 * \param filtered Parameters whose MIDI messages will not be returned.
75 virtual framecnt_t midi_read (const Lock& lock,
76 Evoral::EventSink<framepos_t>& dst,
77 framepos_t source_start,
80 MidiStateTracker* tracker,
81 MidiChannelFilter* filter,
82 const std::set<Evoral::Parameter>& filtered) const;
84 /** Write data from a MidiRingBuffer to this source.
85 * @param source Source to read from.
86 * @param source_start This source's start position in session frames.
87 * @param cnt The length of time to write.
89 virtual framecnt_t midi_write (const Lock& lock,
90 MidiRingBuffer<framepos_t>& src,
91 framepos_t source_start,
94 /** Append a single event with a timestamp in beats.
96 * Caller must ensure that the event is later than the last written event.
98 virtual void append_event_beats(const Lock& lock,
99 const Evoral::Event<Evoral::Beats>& ev) = 0;
101 /** Append a single event with a timestamp in frames.
103 * Caller must ensure that the event is later than the last written event.
105 virtual void append_event_frames(const Lock& lock,
106 const Evoral::Event<framepos_t>& ev,
107 framepos_t source_start) = 0;
109 virtual bool empty () const;
110 virtual framecnt_t length (framepos_t pos) const;
111 virtual void update_length (framecnt_t);
113 virtual void mark_streaming_midi_write_started (const Lock& lock, NoteMode mode);
114 virtual void mark_streaming_write_started (const Lock& lock);
115 virtual void mark_streaming_write_completed (const Lock& lock);
117 /** Mark write starting with the given time parameters.
119 * This is called by MidiDiskStream::process before writing to the capture
120 * buffer which will be later read by midi_read().
122 * @param position The timeline position the source now starts at.
123 * @param capture_length The current length of the capture, which may not
124 * be zero if record is armed while rolling.
125 * @param loop_length The loop length if looping, otherwise zero.
127 void mark_write_starting_now (framecnt_t position,
128 framecnt_t capture_length,
129 framecnt_t loop_length);
131 /* like ::mark_streaming_write_completed() but with more arguments to
132 * allow control over MIDI-specific behaviour. Expected to be used only
133 * when recording actual MIDI input, rather then when importing files
136 virtual void mark_midi_streaming_write_completed (
138 Evoral::Sequence<Evoral::Beats>::StuckNoteOption stuck_option,
139 Evoral::Beats when = Evoral::Beats());
141 virtual void session_saved();
143 std::string captured_for() const { return _captured_for; }
144 void set_captured_for (std::string str) { _captured_for = str; }
146 static PBD::Signal1<void,MidiSource*> MidiSourceCreated;
148 XMLNode& get_state ();
149 int set_state (const XMLNode&, int version);
151 bool length_mutable() const { return true; }
153 void set_length_beats(TimeType l) { _length_beats = l; }
154 TimeType length_beats() const { return _length_beats; }
156 virtual void load_model(const Glib::Threads::Mutex::Lock& lock, bool force_reload=false) = 0;
157 virtual void destroy_model(const Glib::Threads::Mutex::Lock& lock) = 0;
159 /** Reset cached information (like iterators) when things have changed.
160 * @param lock Source lock, which must be held by caller.
161 * @param notes If non-NULL, currently active notes are added to this set.
163 void invalidate(const Glib::Threads::Mutex::Lock& lock,
164 std::set<Evoral::Sequence<Evoral::Beats>::WeakNotePtr>* notes=NULL);
166 void set_note_mode(const Glib::Threads::Mutex::Lock& lock, NoteMode mode);
168 boost::shared_ptr<MidiModel> model() { return _model; }
169 void set_model(const Glib::Threads::Mutex::Lock& lock, boost::shared_ptr<MidiModel>);
170 void drop_model(const Glib::Threads::Mutex::Lock& lock);
172 Evoral::ControlList::InterpolationStyle interpolation_of (Evoral::Parameter) const;
173 void set_interpolation_of (Evoral::Parameter, Evoral::ControlList::InterpolationStyle);
174 void copy_interpolation_from (boost::shared_ptr<MidiSource>);
175 void copy_interpolation_from (MidiSource *);
177 AutoState automation_state_of (Evoral::Parameter) const;
178 void set_automation_state_of (Evoral::Parameter, AutoState);
179 void copy_automation_state_from (boost::shared_ptr<MidiSource>);
180 void copy_automation_state_from (MidiSource *);
182 /** Emitted when a different MidiModel is set */
183 PBD::Signal0<void> ModelChanged;
184 /** Emitted when a parameter's interpolation style is changed */
185 PBD::Signal2<void, Evoral::Parameter, Evoral::ControlList::InterpolationStyle> InterpolationChanged;
186 /** Emitted when a parameter's automation state is changed */
187 PBD::Signal2<void, Evoral::Parameter, AutoState> AutomationStateChanged;
190 virtual void flush_midi(const Lock& lock) = 0;
192 virtual framecnt_t read_unlocked (const Lock& lock,
193 Evoral::EventSink<framepos_t>& dst,
197 MidiStateTracker* tracker,
198 MidiChannelFilter* filter) const = 0;
200 /** Write data to this source from a MidiRingBuffer.
201 * @param source Buffer to read from.
202 * @param position This source's start position in session frames.
203 * @param cnt The duration of this block to write for.
205 virtual framecnt_t write_unlocked (const Lock& lock,
206 MidiRingBuffer<framepos_t>& source,
210 std::string _captured_for;
212 boost::shared_ptr<MidiModel> _model;
215 mutable Evoral::Sequence<Evoral::Beats>::const_iterator _model_iter;
216 mutable bool _model_iter_valid;
218 mutable Evoral::Beats _length_beats;
219 mutable framepos_t _last_read_end;
221 /** The total duration of the current capture. */
222 framepos_t _capture_length;
224 /** Length of transport loop during current capture, or zero. */
225 framepos_t _capture_loop_length;
227 /** Map of interpolation styles to use for Parameters; if they are not in this map,
228 * the correct interpolation style can be obtained from EventTypeMap::interpolation_of ()
230 typedef std::map<Evoral::Parameter, Evoral::ControlList::InterpolationStyle> InterpolationStyleMap;
231 InterpolationStyleMap _interpolation_style;
233 /** Map of automation states to use for Parameters; if they are not in this map,
234 * the correct automation state is Off.
236 typedef std::map<Evoral::Parameter, AutoState> AutomationStateMap;
237 AutomationStateMap _automation_state;
242 #endif /* __ardour_midi_source_h__ */