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 double 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.
57 * \param begin time of earliest event that can be written.
58 * \param end time of latest event that can be written.
60 * Returns zero on success, non-zero if the write failed for any
64 int write_to (boost::shared_ptr<MidiSource> newsrc,
65 Evoral::MusicalTime begin = Evoral::MinMusicalTime,
66 Evoral::MusicalTime end = Evoral::MaxMusicalTime);
68 /** Read the data in a given time range from the MIDI source.
69 * All time stamps in parameters are in audio frames (even if the source has tempo time).
70 * \param dst Ring buffer where read events are written
71 * \param source_start Start position of the SOURCE in this read context
72 * \param start Start of range to be read
73 * \param cnt Length of range to be read (in audio frames)
74 * \param tracker an optional pointer to MidiStateTracker object, for note on/off tracking
76 virtual framecnt_t midi_read (Evoral::EventSink<framepos_t>& dst,
77 framepos_t source_start,
80 MidiStateTracker* tracker,
81 std::set<Evoral::Parameter> const &) const;
83 /** Write data from a MidiRingBuffer to this source.
84 * @param source Source to read from.
85 * @param source_start This source's start position in session frames.
86 * @param cnt The length of time to write.
88 virtual framecnt_t midi_write (MidiRingBuffer<framepos_t>& src,
89 framepos_t source_start,
92 virtual void append_event_unlocked_beats(const Evoral::Event<Evoral::MusicalTime>& ev) = 0;
94 virtual void append_event_unlocked_frames(const Evoral::Event<framepos_t>& ev,
95 framepos_t source_start) = 0;
97 virtual bool empty () const;
98 virtual framecnt_t length (framepos_t pos) const;
99 virtual void update_length (framecnt_t);
101 virtual void mark_streaming_midi_write_started (NoteMode mode);
102 virtual void mark_streaming_write_started ();
103 virtual void mark_streaming_write_completed ();
105 /** Mark write starting with the given time parameters.
107 * This is called by MidiDiskStream::process before writing to the capture
108 * buffer which will be later read by midi_read().
110 * @param position The timeline position the source now starts at.
111 * @param capture_length The current length of the capture, which may not
112 * be zero if record is armed while rolling.
113 * @param loop_length The loop length if looping, otherwise zero.
115 void mark_write_starting_now (framecnt_t position,
116 framecnt_t capture_length,
117 framecnt_t loop_length);
119 /* like ::mark_streaming_write_completed() but with more arguments to
120 * allow control over MIDI-specific behaviour. Expected to be used only
121 * when recording actual MIDI input, rather then when importing files
124 virtual void mark_midi_streaming_write_completed (
125 Evoral::Sequence<Evoral::MusicalTime>::StuckNoteOption stuck_option,
126 Evoral::MusicalTime when = 0);
128 virtual void session_saved();
130 std::string captured_for() const { return _captured_for; }
131 void set_captured_for (std::string str) { _captured_for = str; }
133 static PBD::Signal1<void,MidiSource*> MidiSourceCreated;
135 XMLNode& get_state ();
136 int set_state (const XMLNode&, int version);
138 bool length_mutable() const { return true; }
140 void set_length_beats(double l) { _length_beats = l; }
141 double length_beats() const { return _length_beats; }
143 virtual void load_model(bool lock=true, bool force_reload=false) = 0;
144 virtual void destroy_model() = 0;
146 /** This must be called with the source lock held whenever the
147 * source/model contents have been changed (reset iterators/cache/etc).
151 void set_note_mode(NoteMode mode);
153 boost::shared_ptr<MidiModel> model() { return _model; }
154 void set_model (boost::shared_ptr<MidiModel>);
157 Evoral::ControlList::InterpolationStyle interpolation_of (Evoral::Parameter) const;
158 void set_interpolation_of (Evoral::Parameter, Evoral::ControlList::InterpolationStyle);
159 void copy_interpolation_from (boost::shared_ptr<MidiSource>);
160 void copy_interpolation_from (MidiSource *);
162 AutoState automation_state_of (Evoral::Parameter) const;
163 void set_automation_state_of (Evoral::Parameter, AutoState);
164 void copy_automation_state_from (boost::shared_ptr<MidiSource>);
165 void copy_automation_state_from (MidiSource *);
167 /** Emitted when a different MidiModel is set */
168 PBD::Signal0<void> ModelChanged;
169 /** Emitted when a parameter's interpolation style is changed */
170 PBD::Signal2<void, Evoral::Parameter, Evoral::ControlList::InterpolationStyle> InterpolationChanged;
171 /** Emitted when a parameter's automation state is changed */
172 PBD::Signal2<void, Evoral::Parameter, AutoState> AutomationStateChanged;
175 virtual void flush_midi() = 0;
177 virtual framecnt_t read_unlocked (Evoral::EventSink<framepos_t>& dst,
181 MidiStateTracker* tracker) const = 0;
183 /** Write data to this source from a MidiRingBuffer.
184 * @param source Buffer to read from.
185 * @param position This source's start position in session frames.
186 * @param cnt The duration of this block to write for.
188 virtual framecnt_t write_unlocked (MidiRingBuffer<framepos_t>& source,
192 std::string _captured_for;
194 boost::shared_ptr<MidiModel> _model;
197 mutable Evoral::Sequence<Evoral::MusicalTime>::const_iterator _model_iter;
198 mutable bool _model_iter_valid;
200 mutable double _length_beats;
201 mutable framepos_t _last_read_end;
203 /** The total duration of the current capture. */
204 framepos_t _capture_length;
206 /** Length of transport loop during current capture, or zero. */
207 framepos_t _capture_loop_length;
209 /** Map of interpolation styles to use for Parameters; if they are not in this map,
210 * the correct interpolation style can be obtained from EventTypeMap::interpolation_of ()
212 typedef std::map<Evoral::Parameter, Evoral::ControlList::InterpolationStyle> InterpolationStyleMap;
213 InterpolationStyleMap _interpolation_style;
215 /** Map of automation states to use for Parameters; if they are not in this map,
216 * the correct automation state is Off.
218 typedef std::map<Evoral::Parameter, AutoState> AutomationStateMap;
219 AutomationStateMap _automation_state;
224 #endif /* __ardour_midi_source_h__ */