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 <sigc++/bind.h>
28 #include <sigc++/class_slot.h>
30 #include <glibmm/thread.h>
32 #include <pbd/basename.h>
33 #include <pbd/xml++.h>
34 #include <pbd/enumwriter.h>
36 #include <ardour/midi_region.h>
37 #include <ardour/session.h>
38 #include <ardour/gain.h>
39 #include <ardour/dB.h>
40 #include <ardour/playlist.h>
41 #include <ardour/midi_source.h>
42 #include <ardour/types.h>
43 #include <ardour/midi_ring_buffer.h>
49 using namespace ARDOUR;
51 /** Basic MidiRegion constructor (one channel) */
52 MidiRegion::MidiRegion (boost::shared_ptr<MidiSource> src, nframes_t start, nframes_t length)
53 : Region (src, start, length, PBD::basename_nosuffix(src->name()), DataType::MIDI, 0, Region::Flag(Region::DefaultFlags|Region::External))
55 assert(_name.find("/") == string::npos);
56 midi_source(0)->Switched.connect(sigc::mem_fun(this, &MidiRegion::switch_source));
59 /* Basic MidiRegion constructor (one channel) */
60 MidiRegion::MidiRegion (boost::shared_ptr<MidiSource> src, nframes_t start, nframes_t length, const string& name, layer_t layer, Flag flags)
61 : Region (src, start, length, name, DataType::MIDI, layer, flags)
63 assert(_name.find("/") == string::npos);
64 midi_source(0)->Switched.connect(sigc::mem_fun(this, &MidiRegion::switch_source));
67 /* Basic MidiRegion constructor (many channels) */
68 MidiRegion::MidiRegion (const SourceList& srcs, nframes_t start, nframes_t length, const string& name, layer_t layer, Flag flags)
69 : Region (srcs, start, length, name, DataType::MIDI, layer, flags)
71 assert(_name.find("/") == string::npos);
72 midi_source(0)->Switched.connect(sigc::mem_fun(this, &MidiRegion::switch_source));
76 /** Create a new MidiRegion, that is part of an existing one */
77 MidiRegion::MidiRegion (boost::shared_ptr<const MidiRegion> other, nframes_t offset, nframes_t length, const string& name, layer_t layer, Flag flags)
78 : Region (other, offset, length, name, layer, flags)
80 assert(_name.find("/") == string::npos);
81 midi_source(0)->Switched.connect(sigc::mem_fun(this, &MidiRegion::switch_source));
84 MidiRegion::MidiRegion (boost::shared_ptr<const MidiRegion> other)
87 assert(_name.find("/") == string::npos);
88 midi_source(0)->Switched.connect(sigc::mem_fun(this, &MidiRegion::switch_source));
91 MidiRegion::MidiRegion (boost::shared_ptr<MidiSource> src, const XMLNode& node)
94 if (set_state (node)) {
95 throw failed_constructor();
98 midi_source(0)->Switched.connect(sigc::mem_fun(this, &MidiRegion::switch_source));
99 assert(_name.find("/") == string::npos);
100 assert(_type == DataType::MIDI);
103 MidiRegion::MidiRegion (const SourceList& srcs, const XMLNode& node)
104 : Region (srcs, node)
106 if (set_state (node)) {
107 throw failed_constructor();
110 midi_source(0)->Switched.connect(sigc::mem_fun(this, &MidiRegion::switch_source));
111 assert(_name.find("/") == string::npos);
112 assert(_type == DataType::MIDI);
115 MidiRegion::~MidiRegion ()
120 MidiRegion::read_at (MidiRingBuffer<nframes_t>& out, nframes_t position, nframes_t dur, uint32_t chan_n, NoteMode mode) const
122 return _read_at (_sources, out, position, dur, chan_n, mode);
126 MidiRegion::master_read_at (MidiRingBuffer<nframes_t>& out, nframes_t position, nframes_t dur, uint32_t chan_n, NoteMode mode) const
128 return _read_at (_master_sources, out, position, dur, chan_n, mode);
132 MidiRegion::_read_at (const SourceList& srcs, MidiRingBuffer<nframes_t>& dst, nframes_t position, nframes_t dur, uint32_t chan_n, NoteMode mode) const
134 /*cerr << "MidiRegion " << _name << "._read_at(" << position << ") - "
135 << position << " duration: " << dur << endl;*/
137 nframes_t internal_offset = 0;
138 nframes_t src_offset = 0;
139 nframes_t to_read = 0;
141 /* precondition: caller has verified that we cover the desired section */
145 if (position < _position) {
147 src_offset = _position - position;
150 internal_offset = position - _position;
154 if (internal_offset >= _length) {
155 return 0; /* read nothing */
159 if ((to_read = min (dur, _length - internal_offset)) == 0) {
160 return 0; /* read nothing */
163 // FIXME: non-opaque MIDI regions not yet supported
167 return 0; /* read nothing */
170 _read_data_count = 0;
172 boost::shared_ptr<MidiSource> src = midi_source(chan_n);
173 src->set_note_mode(mode);
175 nframes_t output_buffer_position = 0;
176 nframes_t negative_output_buffer_position = 0;
177 if (_position >= _start) {
178 // handle resizing of beginnings of regions correctly
179 output_buffer_position = _position - _start;
181 // when _start is greater than _position, we have to subtract
182 // _start from the note times in the midi source
183 negative_output_buffer_position = _start;
187 dst, // destination buffer
188 _position - _start, // start position of the source in this read context
189 _start + internal_offset, // where to start reading in the region
190 to_read, // read duration in frames
191 output_buffer_position, // the offset in the output buffer
192 negative_output_buffer_position // amount to substract from note times
194 return 0; /* "read nothing" */
197 _read_data_count += src->read_data_count();
203 MidiRegion::state (bool full)
205 XMLNode& node (Region::state (full));
208 LocaleGuard lg (X_("POSIX"));
210 node.add_property ("flags", enum_2_string (_flags));
212 // XXX these should move into Region
214 for (uint32_t n=0; n < _sources.size(); ++n) {
215 snprintf (buf2, sizeof(buf2), "source-%d", n);
216 _sources[n]->id().print (buf, sizeof(buf));
217 node.add_property (buf2, buf);
220 for (uint32_t n=0; n < _master_sources.size(); ++n) {
221 snprintf (buf2, sizeof(buf2), "master-source-%d", n);
222 _master_sources[n]->id().print (buf, sizeof (buf));
223 node.add_property (buf2, buf);
226 if (full && _extra_xml) {
227 node.add_child_copy (*_extra_xml);
234 MidiRegion::set_live_state (const XMLNode& node, Change& what_changed, bool send)
236 const XMLProperty *prop;
237 LocaleGuard lg (X_("POSIX"));
239 Region::set_live_state (node, what_changed, false);
241 uint32_t old_flags = _flags;
243 if ((prop = node.property ("flags")) != 0) {
244 _flags = Flag (string_2_enum (prop->value(), _flags));
246 //_flags = Flag (strtol (prop->value().c_str(), (char **) 0, 16));
248 _flags = Flag (_flags & ~Region::LeftOfSplit);
249 _flags = Flag (_flags & ~Region::RightOfSplit);
252 if ((old_flags ^ _flags) & Muted) {
253 what_changed = Change (what_changed|MuteChanged);
255 if ((old_flags ^ _flags) & Opaque) {
256 what_changed = Change (what_changed|OpacityChanged);
258 if ((old_flags ^ _flags) & Locked) {
259 what_changed = Change (what_changed|LockChanged);
263 send_change (what_changed);
270 MidiRegion::set_state (const XMLNode& node)
272 /* Region::set_state() calls the virtual set_live_state(),
273 which will get us back to AudioRegion::set_live_state()
274 to handle the relevant stuff.
277 return Region::set_state (node);
281 MidiRegion::recompute_at_end ()
283 /* our length has changed
284 * (non destructively) "chop" notes that pass the end boundary, to
285 * prevent stuck notes.
290 MidiRegion::recompute_at_start ()
292 /* as above, but the shift was from the front
293 * maybe bump currently active note's note-ons up so they sound here?
294 * that could be undesireable in certain situations though.. maybe
295 * remove the note entirely, including it's note off? something needs to
296 * be done to keep the played MIDI sane to avoid messing up voices of
297 * polyhonic things etc........
302 MidiRegion::separate_by_channel (ARDOUR::Session&, vector< boost::shared_ptr<Region> >&) const
309 MidiRegion::exportme (ARDOUR::Session&, ARDOUR::ExportSpecification&)
314 boost::shared_ptr<MidiSource>
315 MidiRegion::midi_source (uint32_t n) const
317 // Guaranteed to succeed (use a static cast?)
318 return boost::dynamic_pointer_cast<MidiSource>(source(n));
323 MidiRegion::switch_source(boost::shared_ptr<Source> src)
325 boost::shared_ptr<MidiSource> msrc = boost::dynamic_pointer_cast<MidiSource>(src);
329 // MIDI regions have only one source
331 _sources.push_back(msrc);
333 set_name(msrc->name());