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/midi_region.h"
34 #include "ardour/session.h"
35 #include "ardour/gain.h"
36 #include "ardour/dB.h"
37 #include "ardour/playlist.h"
38 #include "ardour/midi_source.h"
39 #include "ardour/region_factory.h"
40 #include "ardour/types.h"
41 #include "ardour/midi_ring_buffer.h"
47 using namespace ARDOUR;
51 namespace Properties {
52 PBD::PropertyDescriptor<void*> midi_data;
53 PBD::PropertyDescriptor<Evoral::MusicalTime> length_beats;
58 MidiRegion::make_property_quarks ()
60 Properties::midi_data.property_id = g_quark_from_static_string (X_("midi-data"));
61 DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for midi-data = %1\n", Properties::midi_data.property_id));
62 Properties::length_beats.property_id = g_quark_from_static_string (X_("length-beats"));
63 DEBUG_TRACE (DEBUG::Properties, string_compose ("quark for length-beats = %1\n", Properties::length_beats.property_id));
67 MidiRegion::register_properties ()
69 add_property (_length_beats);
72 /* Basic MidiRegion constructor (many channels) */
73 MidiRegion::MidiRegion (const SourceList& srcs)
75 , _length_beats (Properties::length_beats, (Evoral::MusicalTime) 0)
77 update_length_beats ();
78 register_properties ();
80 midi_source(0)->ModelChanged.connect_same_thread (_source_connection, boost::bind (&MidiRegion::model_changed, this));
82 assert(_name.val().find("/") == string::npos);
83 assert(_type == DataType::MIDI);
86 /** Create a new MidiRegion, that is part of an existing one */
87 MidiRegion::MidiRegion (boost::shared_ptr<const MidiRegion> other, frameoffset_t offset, bool offset_relative)
88 : Region (other, offset, offset_relative)
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 MidiRegion::~MidiRegion ()
103 /** Create a new MidiRegion that has its own version of some/all of the Source used by another.
105 boost::shared_ptr<MidiRegion>
108 BeatsFramesConverter bfc (_session.tempo_map(), _position);
109 Evoral::MusicalTime const bbegin = bfc.from (_start);
110 Evoral::MusicalTime const bend = bfc.from (_start + _length);
112 boost::shared_ptr<MidiSource> ms = midi_source(0)->clone (bbegin, bend);
116 plist.add (Properties::name, ms->name());
117 plist.add (Properties::whole_file, true);
118 plist.add (Properties::start, _start);
119 plist.add (Properties::length, _length);
120 plist.add (Properties::length_beats, _length_beats);
121 plist.add (Properties::layer, 0);
123 return boost::dynamic_pointer_cast<MidiRegion> (RegionFactory::create (ms, plist, true));
127 MidiRegion::set_length_internal (framecnt_t len)
129 Region::set_length_internal (len);
130 update_length_beats ();
134 MidiRegion::update_length_beats ()
136 cerr << name() << " Updating length beats, currently = " << _length_beats << " w/length = " << _length << endl;
137 BeatsFramesConverter converter (_session.tempo_map(), _position - _start);
138 _length_beats = converter.from (_length);
139 cerr << "\tnew value: " << _length_beats << endl;
143 MidiRegion::set_position_internal (framepos_t pos, bool allow_bbt_recompute)
145 Region::set_position_internal (pos, allow_bbt_recompute);
146 /* zero length regions don't exist - so if _length_beats is zero, this object
147 is under construction.
150 /* leave _length_beats alone, and change _length to reflect the state of things
151 at the new position (tempo map may dictate a different number of frames
153 BeatsFramesConverter converter (_session.tempo_map(), _position - _start);
154 cerr << name() << " change frame length to " << converter.to (_length_beats) << endl;
155 Region::set_length_internal (converter.to (_length_beats));
160 MidiRegion::read_at (Evoral::EventSink<framepos_t>& out, framepos_t position, framecnt_t dur, uint32_t chan_n, NoteMode mode, MidiStateTracker* tracker) const
162 return _read_at (_sources, out, position, dur, chan_n, mode, tracker);
166 MidiRegion::master_read_at (MidiRingBuffer<framepos_t>& out, framepos_t position, framecnt_t dur, uint32_t chan_n, NoteMode mode) const
168 return _read_at (_master_sources, out, position, dur, chan_n, mode); /* no tracker */
172 MidiRegion::_read_at (const SourceList& /*srcs*/, Evoral::EventSink<framepos_t>& dst, framepos_t position, framecnt_t dur, uint32_t chan_n,
173 NoteMode mode, MidiStateTracker* tracker) const
175 frameoffset_t internal_offset = 0;
176 framecnt_t to_read = 0;
178 /* precondition: caller has verified that we cover the desired section */
183 return 0; /* read nothing */
186 if (position < _position) {
187 /* we are starting the read from before the start of the region */
189 dur -= _position - position;
191 /* we are starting the read from after the start of the region */
192 internal_offset = position - _position;
195 if (internal_offset >= _length) {
196 return 0; /* read nothing */
199 if ((to_read = min (dur, _length - internal_offset)) == 0) {
200 return 0; /* read nothing */
203 _read_data_count = 0;
205 boost::shared_ptr<MidiSource> src = midi_source(chan_n);
206 src->set_note_mode(mode);
209 cerr << "MR read @ " << position << " * " << to_read
210 << " _position = " << _position
211 << " _start = " << _start
212 << " intoffset = " << internal_offset
216 /* This call reads events from a source and writes them to `dst' timed in session frames */
219 dst, // destination buffer
220 _position - _start, // start position of the source in session frames
221 _start + internal_offset, // where to start reading in the source
222 to_read, // read duration in frames
226 return 0; /* "read nothing" */
229 _read_data_count += src->read_data_count();
237 return Region::state ();
241 MidiRegion::set_state (const XMLNode& node, int version)
243 int ret = Region::set_state (node, version);
246 update_length_beats ();
253 MidiRegion::recompute_at_end ()
255 /* our length has changed
256 * so what? stuck notes are dealt with via a note state tracker
261 MidiRegion::recompute_at_start ()
263 /* as above, but the shift was from the front
264 * maybe bump currently active note's note-ons up so they sound here?
265 * that could be undesireable in certain situations though.. maybe
266 * remove the note entirely, including it's note off? something needs to
267 * be done to keep the played MIDI sane to avoid messing up voices of
268 * polyhonic things etc........
273 MidiRegion::separate_by_channel (ARDOUR::Session&, vector< boost::shared_ptr<Region> >&) const
280 MidiRegion::exportme (ARDOUR::Session&, ARDOUR::ExportSpecification&)
285 boost::shared_ptr<MidiSource>
286 MidiRegion::midi_source (uint32_t n) const
288 // Guaranteed to succeed (use a static cast?)
289 return boost::dynamic_pointer_cast<MidiSource>(source(n));
293 MidiRegion::model_changed ()
299 /* build list of filtered Parameters, being those whose automation state is not `Play' */
301 _filtered_parameters.clear ();
303 Automatable::Controls const & c = model()->controls();
305 for (Automatable::Controls::const_iterator i = c.begin(); i != c.end(); ++i) {
306 boost::shared_ptr<AutomationControl> ac = boost::dynamic_pointer_cast<AutomationControl> (i->second);
308 if (ac->alist()->automation_state() != Play) {
309 _filtered_parameters.insert (ac->parameter ());
313 /* watch for changes to controls' AutoState */
314 midi_source()->AutomationStateChanged.connect_same_thread (
315 _model_connection, boost::bind (&MidiRegion::model_automation_state_changed, this, _1)
318 model()->ContentsChanged.connect_same_thread (
319 _model_contents_connection, boost::bind (&MidiRegion::model_contents_changed, this));
323 MidiRegion::model_contents_changed ()
325 send_change (PropertyChange (Properties::midi_data));
329 MidiRegion::model_automation_state_changed (Evoral::Parameter const & p)
331 /* Update our filtered parameters list after a change to a parameter's AutoState */
333 boost::shared_ptr<AutomationControl> ac = model()->automation_control (p);
336 if (ac->alist()->automation_state() == Play) {
337 _filtered_parameters.erase (p);
339 _filtered_parameters.insert (p);
342 /* the source will have an iterator into the model, and that iterator will have been set up
343 for a given set of filtered_parameters, so now that we've changed that list we must invalidate
346 Glib::Mutex::Lock lm (midi_source(0)->mutex());
347 midi_source(0)->invalidate ();
350 /** This is called when a trim drag has resulted in a -ve _start time for this region.
351 * Fix it up by adding some empty space to the source.
354 MidiRegion::fix_negative_start ()
356 BeatsFramesConverter c (_session.tempo_map(), _position);
358 model()->insert_silence_at_start (c.from (-_start));