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;
39 template<typename T> class MidiRingBuffer;
41 /** Source for MIDI data */
42 class MidiSource : virtual public Source, public boost::enable_shared_from_this<MidiSource>
45 typedef double TimeType;
47 MidiSource (Session& session, std::string name, Source::Flag flags = Source::Flag(0));
48 MidiSource (Session& session, const XMLNode&);
49 virtual ~MidiSource ();
51 boost::shared_ptr<MidiSource> clone (const std::string& path,
52 Evoral::MusicalTime begin = Evoral::MinMusicalTime,
53 Evoral::MusicalTime end = Evoral::MaxMusicalTime);
55 /** Read the data in a given time range from the MIDI source.
56 * All time stamps in parameters are in audio frames (even if the source has tempo time).
57 * \param dst Ring buffer where read events are written
58 * \param source_start Start position of the SOURCE in this read context
59 * \param start Start of range to be read
60 * \param cnt Length of range to be read (in audio frames)
61 * \param tracker an optional pointer to MidiStateTracker object, for note on/off tracking
63 virtual framecnt_t midi_read (Evoral::EventSink<framepos_t>& dst,
64 framepos_t source_start,
67 MidiStateTracker* tracker,
68 std::set<Evoral::Parameter> const &) const;
70 /** Write data from a MidiRingBuffer to this source.
71 * @param source Source to read from.
72 * @param source_start This source's start position in session frames.
73 * @param cnt The length of time to write.
75 virtual framecnt_t midi_write (MidiRingBuffer<framepos_t>& src,
76 framepos_t source_start,
79 virtual void append_event_unlocked_beats(const Evoral::Event<Evoral::MusicalTime>& ev) = 0;
81 virtual void append_event_unlocked_frames(const Evoral::Event<framepos_t>& ev,
82 framepos_t source_start) = 0;
84 virtual bool empty () const;
85 virtual framecnt_t length (framepos_t pos) const;
86 virtual void update_length (framecnt_t);
88 virtual void mark_streaming_midi_write_started (NoteMode mode);
89 virtual void mark_streaming_write_started ();
90 virtual void mark_streaming_write_completed ();
91 void mark_write_starting_now ();
93 /* like ::mark_streaming_write_completed() but with more arguments to
94 * allow control over MIDI-specific behaviour. Expected to be used only
95 * when recording actual MIDI input, rather then when importing files
98 virtual void mark_midi_streaming_write_completed (
99 Evoral::Sequence<Evoral::MusicalTime>::StuckNoteOption stuck_option,
100 Evoral::MusicalTime when = 0);
102 virtual void session_saved();
104 std::string captured_for() const { return _captured_for; }
105 void set_captured_for (std::string str) { _captured_for = str; }
107 framepos_t last_write_end() const { return _last_write_end; }
108 void set_last_write_end (framepos_t pos) { _last_write_end = pos; }
110 static PBD::Signal1<void,MidiSource*> MidiSourceCreated;
112 XMLNode& get_state ();
113 int set_state (const XMLNode&, int version);
115 bool length_mutable() const { return true; }
117 void set_length_beats(double l) { _length_beats = l; }
118 double length_beats() const { return _length_beats; }
120 virtual void load_model(bool lock=true, bool force_reload=false) = 0;
121 virtual void destroy_model() = 0;
123 /** This must be called with the source lock held whenever the
124 * source/model contents have been changed (reset iterators/cache/etc).
128 void set_note_mode(NoteMode mode);
130 boost::shared_ptr<MidiModel> model() { return _model; }
131 void set_model (boost::shared_ptr<MidiModel>);
134 Evoral::ControlList::InterpolationStyle interpolation_of (Evoral::Parameter) const;
135 void set_interpolation_of (Evoral::Parameter, Evoral::ControlList::InterpolationStyle);
136 void copy_interpolation_from (boost::shared_ptr<MidiSource>);
137 void copy_interpolation_from (MidiSource *);
139 AutoState automation_state_of (Evoral::Parameter) const;
140 void set_automation_state_of (Evoral::Parameter, AutoState);
141 void copy_automation_state_from (boost::shared_ptr<MidiSource>);
142 void copy_automation_state_from (MidiSource *);
144 /** Emitted when a different MidiModel is set */
145 PBD::Signal0<void> ModelChanged;
146 /** Emitted when a parameter's interpolation style is changed */
147 PBD::Signal2<void, Evoral::Parameter, Evoral::ControlList::InterpolationStyle> InterpolationChanged;
148 /** Emitted when a parameter's automation state is changed */
149 PBD::Signal2<void, Evoral::Parameter, AutoState> AutomationStateChanged;
152 virtual void flush_midi() = 0;
154 virtual framecnt_t read_unlocked (Evoral::EventSink<framepos_t>& dst,
158 MidiStateTracker* tracker) const = 0;
160 virtual framecnt_t write_unlocked (MidiRingBuffer<framepos_t>& dst,
164 std::string _captured_for;
166 boost::shared_ptr<MidiModel> _model;
169 mutable Evoral::Sequence<Evoral::MusicalTime>::const_iterator _model_iter;
170 mutable bool _model_iter_valid;
172 mutable double _length_beats;
173 mutable framepos_t _last_read_end;
174 framepos_t _last_write_end;
176 /** Map of interpolation styles to use for Parameters; if they are not in this map,
177 * the correct interpolation style can be obtained from EventTypeMap::interpolation_of ()
179 typedef std::map<Evoral::Parameter, Evoral::ControlList::InterpolationStyle> InterpolationStyleMap;
180 InterpolationStyleMap _interpolation_style;
182 /** Map of automation states to use for Parameters; if they are not in this map,
183 * the correct automation state is Off.
185 typedef std::map<Evoral::Parameter, AutoState> AutomationStateMap;
186 AutomationStateMap _automation_state;
191 #endif /* __ardour_midi_source_h__ */