2 Copyright (C) 2000-2006 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
18 $Id: midiregion.cc 746 2006-08-02 02:44:23Z drobilla $
27 #include <glibmm/thread.h>
29 #include "pbd/basename.h"
30 #include "pbd/xml++.h"
31 #include "pbd/enumwriter.h"
33 #include "ardour/automation_control.h"
34 #include "ardour/dB.h"
35 #include "ardour/gain.h"
36 #include "ardour/midi_model.h"
37 #include "ardour/midi_region.h"
38 #include "ardour/midi_ring_buffer.h"
39 #include "ardour/midi_source.h"
40 #include "ardour/playlist.h"
41 #include "ardour/region_factory.h"
42 #include "ardour/session.h"
43 #include "ardour/types.h"
49 using namespace ARDOUR;
53 namespace Properties {
54 PBD::PropertyDescriptor<void*> midi_data;
55 PBD::PropertyDescriptor<Evoral::MusicalTime> length_beats;
60 MidiRegion::make_property_quarks ()
62 Properties::midi_data.property_id = g_quark_from_static_string (X_("midi-data"));
63 DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for midi-data = %1\n", Properties::midi_data.property_id));
64 Properties::length_beats.property_id = g_quark_from_static_string (X_("length-beats"));
65 DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for length-beats = %1\n", Properties::length_beats.property_id));
69 MidiRegion::register_properties ()
71 add_property (_length_beats);
74 /* Basic MidiRegion constructor (many channels) */
75 MidiRegion::MidiRegion (const SourceList& srcs)
77 , _length_beats (Properties::length_beats, midi_source(0)->length_beats())
79 register_properties ();
81 midi_source(0)->ModelChanged.connect_same_thread (_source_connection, boost::bind (&MidiRegion::model_changed, this));
83 assert(_name.val().find("/") == string::npos);
84 assert(_type == DataType::MIDI);
87 MidiRegion::MidiRegion (boost::shared_ptr<const MidiRegion> other)
89 , _length_beats (Properties::length_beats, (Evoral::MusicalTime) 0)
91 update_length_beats ();
92 register_properties ();
94 assert(_name.val().find("/") == string::npos);
95 midi_source(0)->ModelChanged.connect_same_thread (_source_connection, boost::bind (&MidiRegion::model_changed, this));
99 /** Create a new MidiRegion, that is part of an existing one */
100 MidiRegion::MidiRegion (boost::shared_ptr<const MidiRegion> other, frameoffset_t offset)
101 : Region (other, offset)
102 , _length_beats (Properties::length_beats, (Evoral::MusicalTime) 0)
104 BeatsFramesConverter bfc (_session.tempo_map(), _position);
105 Evoral::MusicalTime const offset_beats = bfc.from (offset);
107 _length_beats = other->_length_beats - offset_beats;
109 register_properties ();
111 assert(_name.val().find("/") == string::npos);
112 midi_source(0)->ModelChanged.connect_same_thread (_source_connection, boost::bind (&MidiRegion::model_changed, this));
116 MidiRegion::~MidiRegion ()
120 /** Create a new MidiRegion that has its own version of some/all of the Source used by another.
122 boost::shared_ptr<MidiRegion>
123 MidiRegion::clone () const
125 BeatsFramesConverter bfc (_session.tempo_map(), _position);
126 Evoral::MusicalTime const bbegin = bfc.from (_start);
127 Evoral::MusicalTime const bend = bfc.from (_start + _length);
129 boost::shared_ptr<MidiSource> ms = midi_source(0)->clone (bbegin, bend);
133 plist.add (Properties::name, ms->name());
134 plist.add (Properties::whole_file, true);
135 plist.add (Properties::start, _start);
136 plist.add (Properties::length, _length);
137 plist.add (Properties::length_beats, _length_beats);
138 plist.add (Properties::layer, 0);
140 return boost::dynamic_pointer_cast<MidiRegion> (RegionFactory::create (ms, plist, true));
144 MidiRegion::post_set (const PropertyChange& pc)
146 if (pc.contains (Properties::length) && !pc.contains (Properties::length_beats)) {
147 update_length_beats ();
152 MidiRegion::set_length_internal (framecnt_t len)
154 Region::set_length_internal (len);
155 update_length_beats ();
159 MidiRegion::update_length_beats ()
161 BeatsFramesConverter converter (_session.tempo_map(), _position);
162 _length_beats = converter.from (_length);
166 MidiRegion::set_position_internal (framepos_t pos, bool allow_bbt_recompute)
168 Region::set_position_internal (pos, allow_bbt_recompute);
169 /* zero length regions don't exist - so if _length_beats is zero, this object
170 is under construction.
173 /* leave _length_beats alone, and change _length to reflect the state of things
174 at the new position (tempo map may dictate a different number of frames
176 BeatsFramesConverter converter (_session.tempo_map(), _position);
177 Region::set_length_internal (converter.to (_length_beats));
182 MidiRegion::read_at (Evoral::EventSink<framepos_t>& out, framepos_t position, framecnt_t dur, uint32_t chan_n, NoteMode mode, MidiStateTracker* tracker) const
184 return _read_at (_sources, out, position, dur, chan_n, mode, tracker);
188 MidiRegion::master_read_at (MidiRingBuffer<framepos_t>& out, framepos_t position, framecnt_t dur, uint32_t chan_n, NoteMode mode) const
190 return _read_at (_master_sources, out, position, dur, chan_n, mode); /* no tracker */
194 MidiRegion::_read_at (const SourceList& /*srcs*/, Evoral::EventSink<framepos_t>& dst, framepos_t position, framecnt_t dur, uint32_t chan_n,
195 NoteMode mode, MidiStateTracker* tracker) const
197 frameoffset_t internal_offset = 0;
198 framecnt_t to_read = 0;
200 /* precondition: caller has verified that we cover the desired section */
205 return 0; /* read nothing */
208 if (position < _position) {
209 /* we are starting the read from before the start of the region */
211 dur -= _position - position;
213 /* we are starting the read from after the start of the region */
214 internal_offset = position - _position;
217 if (internal_offset >= _length) {
218 return 0; /* read nothing */
221 if ((to_read = min (dur, _length - internal_offset)) == 0) {
222 return 0; /* read nothing */
225 boost::shared_ptr<MidiSource> src = midi_source(chan_n);
226 src->set_note_mode(mode);
229 cerr << "MR read @ " << position << " * " << to_read
230 << " _position = " << _position
231 << " _start = " << _start
232 << " intoffset = " << internal_offset
236 /* This call reads events from a source and writes them to `dst' timed in session frames */
239 dst, // destination buffer
240 _position - _start, // start position of the source in session frames
241 _start + internal_offset, // where to start reading in the source
242 to_read, // read duration in frames
246 return 0; /* "read nothing" */
255 return Region::state ();
259 MidiRegion::set_state (const XMLNode& node, int version)
261 int ret = Region::set_state (node, version);
264 update_length_beats ();
271 MidiRegion::recompute_at_end ()
273 /* our length has changed
274 * so what? stuck notes are dealt with via a note state tracker
279 MidiRegion::recompute_at_start ()
281 /* as above, but the shift was from the front
282 * maybe bump currently active note's note-ons up so they sound here?
283 * that could be undesireable in certain situations though.. maybe
284 * remove the note entirely, including it's note off? something needs to
285 * be done to keep the played MIDI sane to avoid messing up voices of
286 * polyhonic things etc........
291 MidiRegion::separate_by_channel (ARDOUR::Session&, vector< boost::shared_ptr<Region> >&) const
297 boost::shared_ptr<Evoral::Control>
298 MidiRegion::control (const Evoral::Parameter& id, bool create)
300 return model()->control(id, create);
303 boost::shared_ptr<const Evoral::Control>
304 MidiRegion::control (const Evoral::Parameter& id) const
306 return model()->control(id);
309 boost::shared_ptr<MidiModel>
312 return midi_source()->model();
315 boost::shared_ptr<const MidiModel>
316 MidiRegion::model() const
318 return midi_source()->model();
322 MidiRegion::exportme (ARDOUR::Session&, ARDOUR::ExportSpecification&)
327 boost::shared_ptr<MidiSource>
328 MidiRegion::midi_source (uint32_t n) const
330 // Guaranteed to succeed (use a static cast?)
331 return boost::dynamic_pointer_cast<MidiSource>(source(n));
335 MidiRegion::model_changed ()
341 /* build list of filtered Parameters, being those whose automation state is not `Play' */
343 _filtered_parameters.clear ();
345 Automatable::Controls const & c = model()->controls();
347 for (Automatable::Controls::const_iterator i = c.begin(); i != c.end(); ++i) {
348 boost::shared_ptr<AutomationControl> ac = boost::dynamic_pointer_cast<AutomationControl> (i->second);
350 if (ac->alist()->automation_state() != Play) {
351 _filtered_parameters.insert (ac->parameter ());
355 /* watch for changes to controls' AutoState */
356 midi_source()->AutomationStateChanged.connect_same_thread (
357 _model_connection, boost::bind (&MidiRegion::model_automation_state_changed, this, _1)
360 model()->ContentsChanged.connect_same_thread (
361 _model_contents_connection, boost::bind (&MidiRegion::model_contents_changed, this));
365 MidiRegion::model_contents_changed ()
367 send_change (PropertyChange (Properties::midi_data));
371 MidiRegion::model_automation_state_changed (Evoral::Parameter const & p)
373 /* Update our filtered parameters list after a change to a parameter's AutoState */
375 boost::shared_ptr<AutomationControl> ac = model()->automation_control (p);
378 if (ac->alist()->automation_state() == Play) {
379 _filtered_parameters.erase (p);
381 _filtered_parameters.insert (p);
384 /* the source will have an iterator into the model, and that iterator will have been set up
385 for a given set of filtered_parameters, so now that we've changed that list we must invalidate
388 Glib::Mutex::Lock lm (midi_source(0)->mutex());
389 midi_source(0)->invalidate ();
392 /** This is called when a trim drag has resulted in a -ve _start time for this region.
393 * Fix it up by adding some empty space to the source.
396 MidiRegion::fix_negative_start ()
398 BeatsFramesConverter c (_session.tempo_map(), _position);
400 model()->insert_silence_at_start (c.from (-_start));
404 /** Transpose the notes in this region by a given number of semitones */
406 MidiRegion::transpose (int semitones)
408 BeatsFramesConverter c (_session.tempo_map(), _start);
409 model()->transpose (c.from (_start), c.from (_start + _length), semitones);