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 MidiStateTracker;
40 template<typename T> class MidiRingBuffer;
42 /** Source for MIDI data */
43 class LIBARDOUR_API MidiSource : virtual public Source, public boost::enable_shared_from_this<MidiSource>
46 typedef Evoral::MusicalTime TimeType;
48 MidiSource (Session& session, std::string name, Source::Flag flags = Source::Flag(0));
49 MidiSource (Session& session, const XMLNode&);
50 virtual ~MidiSource ();
52 /** Write the data in the given time range to another MidiSource
53 * \param newsrc MidiSource to which data will be written. Should be a
54 * new, empty source. If it already has contents, the results are
55 * undefined. Source must be writable.
56 * \param begin time of earliest event that can be written.
57 * \param end time of latest event that can be written.
58 * \return zero on success, non-zero if the write failed for any reason.
60 int write_to (const Lock& lock,
61 boost::shared_ptr<MidiSource> newsrc,
62 Evoral::MusicalTime begin = Evoral::MinMusicalTime,
63 Evoral::MusicalTime end = Evoral::MaxMusicalTime);
65 /** Read the data in a given time range from the MIDI source.
66 * All time stamps in parameters are in audio frames (even if the source has tempo time).
67 * \param dst Ring buffer where read events are written.
68 * \param source_start Start position of the SOURCE in this read context.
69 * \param start Start of range to be read.
70 * \param cnt Length of range to be read (in audio frames).
71 * \param tracker an optional pointer to MidiStateTracker object, for note on/off tracking.
72 * \param filtered Parameters whose MIDI messages will not be returned.
74 virtual framecnt_t midi_read (const Lock& lock,
75 Evoral::EventSink<framepos_t>& dst,
76 framepos_t source_start,
79 MidiStateTracker* tracker,
80 const std::set<Evoral::Parameter>& filtered) const;
82 /** Write data from a MidiRingBuffer to this source.
83 * @param source Source to read from.
84 * @param source_start This source's start position in session frames.
85 * @param cnt The length of time to write.
87 virtual framecnt_t midi_write (const Lock& lock,
88 MidiRingBuffer<framepos_t>& src,
89 framepos_t source_start,
92 /** Append a single event with a timestamp in beats.
94 * Caller must ensure that the event is later than the last written event.
96 virtual void append_event_beats(const Lock& lock,
97 const Evoral::Event<Evoral::MusicalTime>& ev) = 0;
99 /** Append a single event with a timestamp in frames.
101 * Caller must ensure that the event is later than the last written event.
103 virtual void append_event_frames(const Lock& lock,
104 const Evoral::Event<framepos_t>& ev,
105 framepos_t source_start) = 0;
107 virtual bool empty () const;
108 virtual framecnt_t length (framepos_t pos) const;
109 virtual void update_length (framecnt_t);
111 virtual void mark_streaming_midi_write_started (const Lock& lock, NoteMode mode);
112 virtual void mark_streaming_write_started (const Lock& lock);
113 virtual void mark_streaming_write_completed (const Lock& lock);
115 /** Mark write starting with the given time parameters.
117 * This is called by MidiDiskStream::process before writing to the capture
118 * buffer which will be later read by midi_read().
120 * @param position The timeline position the source now starts at.
121 * @param capture_length The current length of the capture, which may not
122 * be zero if record is armed while rolling.
123 * @param loop_length The loop length if looping, otherwise zero.
125 void mark_write_starting_now (framecnt_t position,
126 framecnt_t capture_length,
127 framecnt_t loop_length);
129 /* like ::mark_streaming_write_completed() but with more arguments to
130 * allow control over MIDI-specific behaviour. Expected to be used only
131 * when recording actual MIDI input, rather then when importing files
134 virtual void mark_midi_streaming_write_completed (
136 Evoral::Sequence<Evoral::MusicalTime>::StuckNoteOption stuck_option,
137 Evoral::MusicalTime when = Evoral::MusicalTime());
139 virtual void session_saved();
141 std::string captured_for() const { return _captured_for; }
142 void set_captured_for (std::string str) { _captured_for = str; }
144 static PBD::Signal1<void,MidiSource*> MidiSourceCreated;
146 XMLNode& get_state ();
147 int set_state (const XMLNode&, int version);
149 bool length_mutable() const { return true; }
151 void set_length_beats(TimeType l) { _length_beats = l; }
152 TimeType length_beats() const { return _length_beats; }
154 virtual void load_model(const Glib::Threads::Mutex::Lock& lock, bool force_reload=false) = 0;
155 virtual void destroy_model(const Glib::Threads::Mutex::Lock& lock) = 0;
157 /** Reset cached information (like iterators) when things have changed. */
158 void invalidate(const Glib::Threads::Mutex::Lock& lock);
160 void set_note_mode(const Glib::Threads::Mutex::Lock& lock, NoteMode mode);
162 boost::shared_ptr<MidiModel> model() { return _model; }
163 void set_model(const Glib::Threads::Mutex::Lock& lock, boost::shared_ptr<MidiModel>);
164 void drop_model(const Glib::Threads::Mutex::Lock& lock);
166 Evoral::ControlList::InterpolationStyle interpolation_of (Evoral::Parameter) const;
167 void set_interpolation_of (Evoral::Parameter, Evoral::ControlList::InterpolationStyle);
168 void copy_interpolation_from (boost::shared_ptr<MidiSource>);
169 void copy_interpolation_from (MidiSource *);
171 AutoState automation_state_of (Evoral::Parameter) const;
172 void set_automation_state_of (Evoral::Parameter, AutoState);
173 void copy_automation_state_from (boost::shared_ptr<MidiSource>);
174 void copy_automation_state_from (MidiSource *);
176 /** Emitted when a different MidiModel is set */
177 PBD::Signal0<void> ModelChanged;
178 /** Emitted when a parameter's interpolation style is changed */
179 PBD::Signal2<void, Evoral::Parameter, Evoral::ControlList::InterpolationStyle> InterpolationChanged;
180 /** Emitted when a parameter's automation state is changed */
181 PBD::Signal2<void, Evoral::Parameter, AutoState> AutomationStateChanged;
184 virtual void flush_midi(const Lock& lock) = 0;
186 virtual framecnt_t read_unlocked (const Lock& lock,
187 Evoral::EventSink<framepos_t>& dst,
191 MidiStateTracker* tracker) const = 0;
193 /** Write data to this source from a MidiRingBuffer.
194 * @param source Buffer to read from.
195 * @param position This source's start position in session frames.
196 * @param cnt The duration of this block to write for.
198 virtual framecnt_t write_unlocked (const Lock& lock,
199 MidiRingBuffer<framepos_t>& source,
203 std::string _captured_for;
205 boost::shared_ptr<MidiModel> _model;
208 mutable Evoral::Sequence<Evoral::MusicalTime>::const_iterator _model_iter;
209 mutable bool _model_iter_valid;
211 mutable Evoral::MusicalTime _length_beats;
212 mutable framepos_t _last_read_end;
214 /** The total duration of the current capture. */
215 framepos_t _capture_length;
217 /** Length of transport loop during current capture, or zero. */
218 framepos_t _capture_loop_length;
220 /** Map of interpolation styles to use for Parameters; if they are not in this map,
221 * the correct interpolation style can be obtained from EventTypeMap::interpolation_of ()
223 typedef std::map<Evoral::Parameter, Evoral::ControlList::InterpolationStyle> InterpolationStyleMap;
224 InterpolationStyleMap _interpolation_style;
226 /** Map of automation states to use for Parameters; if they are not in this map,
227 * the correct automation state is Off.
229 typedef std::map<Evoral::Parameter, AutoState> AutomationStateMap;
230 AutomationStateMap _automation_state;
235 #endif /* __ardour_midi_source_h__ */