2 Copyright (C) 2006 Paul Davis
3 By Dave Robillard, 2006
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.
19 #include <pbd/error.h>
20 #include <sigc++/retype.h>
21 #include <sigc++/retype_return.h>
22 #include <sigc++/bind.h>
24 #include <pbd/enumwriter.h>
26 #include <ardour/midi_track.h>
27 #include <ardour/midi_diskstream.h>
28 #include <ardour/session.h>
29 #include <ardour/io_processor.h>
30 #include <ardour/midi_region.h>
31 #include <ardour/midi_source.h>
32 #include <ardour/route_group_specialized.h>
33 #include <ardour/processor.h>
34 #include <ardour/midi_playlist.h>
35 #include <ardour/panner.h>
36 #include <ardour/utils.h>
37 #include <ardour/buffer_set.h>
38 #include <ardour/meter.h>
39 #include <ardour/midi_events.h>
44 using namespace ARDOUR;
47 MidiTrack::MidiTrack (Session& sess, string name, Route::Flag flag, TrackMode mode)
48 : Track (sess, name, flag, mode, DataType::MIDI)
49 , _immediate_events(1024) // FIXME: size?
51 MidiDiskstream::Flag dflags = MidiDiskstream::Flag (0);
53 if (_flags & Hidden) {
54 dflags = MidiDiskstream::Flag (dflags | MidiDiskstream::Hidden);
56 dflags = MidiDiskstream::Flag (dflags | MidiDiskstream::Recordable);
59 assert(mode != Destructive);
61 boost::shared_ptr<MidiDiskstream> ds (new MidiDiskstream (_session, name, dflags));
62 _session.add_diskstream (ds);
64 set_diskstream (boost::dynamic_pointer_cast<MidiDiskstream> (ds));
67 _freeze_record.state = NoFreeze;
68 _saved_meter_point = _meter_point;
71 set_input_minimum(ChanCount(DataType::MIDI, 1));
72 set_input_maximum(ChanCount(DataType::MIDI, 1));
73 set_output_minimum(ChanCount(DataType::MIDI, 1));
74 set_output_maximum(ChanCount(DataType::MIDI, 1));
76 MoreChannels(ChanCount(DataType::MIDI, 2)); /* EMIT SIGNAL */
79 MidiTrack::MidiTrack (Session& sess, const XMLNode& node)
81 , _immediate_events(1024) // FIXME: size?
83 _set_state(node, false);
85 set_input_minimum(ChanCount(DataType::MIDI, 1));
86 set_input_maximum(ChanCount(DataType::MIDI, 1));
87 set_output_minimum(ChanCount(DataType::MIDI, 1));
88 set_output_maximum(ChanCount(DataType::MIDI, 1));
90 MoreChannels(ChanCount(DataType::MIDI, 2)); /* EMIT SIGNAL */
93 MidiTrack::~MidiTrack ()
99 MidiTrack::set_diskstream (boost::shared_ptr<MidiDiskstream> ds)
102 _diskstream->set_io (*this);
103 _diskstream->set_destructive (_mode == Destructive);
105 _diskstream->set_record_enabled (false);
106 //_diskstream->monitor_input (false);
108 ic_connection.disconnect();
109 ic_connection = input_changed.connect (mem_fun (*_diskstream, &MidiDiskstream::handle_input_change));
111 DiskstreamChanged (); /* EMIT SIGNAL */
117 MidiTrack::use_diskstream (string name)
119 boost::shared_ptr<MidiDiskstream> dstream;
121 if ((dstream = boost::dynamic_pointer_cast<MidiDiskstream>(_session.diskstream_by_name (name))) == 0) {
122 error << string_compose(_("MidiTrack: midi diskstream \"%1\" not known by session"), name) << endmsg;
126 return set_diskstream (dstream);
130 MidiTrack::use_diskstream (const PBD::ID& id)
132 boost::shared_ptr<MidiDiskstream> dstream;
134 if ((dstream = boost::dynamic_pointer_cast<MidiDiskstream> (_session.diskstream_by_id (id))) == 0) {
135 error << string_compose(_("MidiTrack: midi diskstream \"%1\" not known by session"), id) << endmsg;
139 return set_diskstream (dstream);
142 boost::shared_ptr<MidiDiskstream>
143 MidiTrack::midi_diskstream() const
145 return boost::dynamic_pointer_cast<MidiDiskstream>(_diskstream);
149 MidiTrack::set_state (const XMLNode& node)
151 return _set_state (node, true);
155 MidiTrack::_set_state (const XMLNode& node, bool call_base)
157 const XMLProperty *prop;
158 XMLNodeConstIterator iter;
160 if (Route::_set_state (node, call_base)) {
164 if ((prop = node.property (X_("mode"))) != 0) {
165 _mode = TrackMode (string_2_enum (prop->value(), _mode));
170 if ((prop = node.property ("diskstream-id")) == 0) {
172 /* some old sessions use the diskstream name rather than the ID */
174 if ((prop = node.property ("diskstream")) == 0) {
175 fatal << _("programming error: MidiTrack given state without diskstream!") << endmsg;
180 if (use_diskstream (prop->value())) {
186 PBD::ID id (prop->value());
188 if (use_diskstream (id)) {
195 XMLNodeConstIterator niter;
198 nlist = node.children();
199 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
202 if (child->name() == X_("recenable")) {
203 _rec_enable_control->set_state (*child);
204 _session.add_controllable (_rec_enable_control);
208 pending_state = const_cast<XMLNode*> (&node);
210 _session.StateReady.connect (mem_fun (*this, &MidiTrack::set_state_part_two));
216 MidiTrack::state(bool full_state)
218 XMLNode& root (Route::state(full_state));
219 XMLNode* freeze_node;
222 if (_freeze_record.playlist) {
225 freeze_node = new XMLNode (X_("freeze-info"));
226 freeze_node->add_property ("playlist", _freeze_record.playlist->name());
227 freeze_node->add_property ("state", enum_2_string (_freeze_record.state));
229 for (vector<FreezeRecordProcessorInfo*>::iterator i = _freeze_record.processor_info.begin(); i != _freeze_record.processor_info.end(); ++i) {
230 inode = new XMLNode (X_("processor"));
231 (*i)->id.print (buf, sizeof(buf));
232 inode->add_property (X_("id"), buf);
233 inode->add_child_copy ((*i)->state);
235 freeze_node->add_child_nocopy (*inode);
238 root.add_child_nocopy (*freeze_node);
241 /* Alignment: act as a proxy for the diskstream */
243 XMLNode* align_node = new XMLNode (X_("alignment"));
244 AlignStyle as = _diskstream->alignment_style ();
245 align_node->add_property (X_("style"), enum_2_string (as));
246 root.add_child_nocopy (*align_node);
248 root.add_property (X_("mode"), enum_2_string (_mode));
250 /* we don't return diskstream state because we don't
251 own the diskstream exclusively. control of the diskstream
252 state is ceded to the Session, even if we create the
256 _diskstream->id().print (buf, sizeof(buf));
257 root.add_property ("diskstream-id", buf);
259 root.add_child_nocopy (_rec_enable_control->get_state());
265 MidiTrack::set_state_part_two ()
269 LocaleGuard lg (X_("POSIX"));
271 /* This is called after all session state has been restored but before
272 have been made ports and connections are established.
275 if (pending_state == 0) {
279 if ((fnode = find_named_node (*pending_state, X_("freeze-info"))) != 0) {
282 _freeze_record.have_mementos = false;
283 _freeze_record.state = Frozen;
285 for (vector<FreezeRecordProcessorInfo*>::iterator i = _freeze_record.processor_info.begin(); i != _freeze_record.processor_info.end(); ++i) {
288 _freeze_record.processor_info.clear ();
290 if ((prop = fnode->property (X_("playlist"))) != 0) {
291 boost::shared_ptr<Playlist> pl = _session.playlist_by_name (prop->value());
293 _freeze_record.playlist = boost::dynamic_pointer_cast<MidiPlaylist> (pl);
295 _freeze_record.playlist.reset();
296 _freeze_record.state = NoFreeze;
301 if ((prop = fnode->property (X_("state"))) != 0) {
302 _freeze_record.state = FreezeState (string_2_enum (prop->value(), _freeze_record.state));
305 XMLNodeConstIterator citer;
306 XMLNodeList clist = fnode->children();
308 for (citer = clist.begin(); citer != clist.end(); ++citer) {
309 if ((*citer)->name() != X_("processor")) {
313 if ((prop = (*citer)->property (X_("id"))) == 0) {
317 FreezeRecordProcessorInfo* frii = new FreezeRecordProcessorInfo (*((*citer)->children().front()),
318 boost::shared_ptr<Processor>());
319 frii->id = prop->value ();
320 _freeze_record.processor_info.push_back (frii);
324 /* Alignment: act as a proxy for the diskstream */
326 if ((fnode = find_named_node (*pending_state, X_("alignment"))) != 0) {
328 if ((prop = fnode->property (X_("style"))) != 0) {
330 /* fix for older sessions from before EnumWriter */
334 if (prop->value() == "capture") {
335 pstr = "CaptureTime";
336 } else if (prop->value() == "existing") {
337 pstr = "ExistingMaterial";
339 pstr = prop->value();
342 AlignStyle as = AlignStyle (string_2_enum (pstr, as));
343 _diskstream->set_persistent_align_style (as);
350 MidiTrack::no_roll (nframes_t nframes, nframes_t start_frame, nframes_t end_frame, nframes_t offset,
351 bool session_state_changing, bool can_record, bool rec_monitors_input)
353 if (n_outputs().n_midi() == 0) {
359 silence (nframes, offset);
363 if (session_state_changing) {
365 /* XXX is this safe to do against transport state changes? */
367 passthru_silence (start_frame, end_frame, nframes, offset, 0, false);
371 midi_diskstream()->check_record_status (start_frame, nframes, can_record);
375 if (_have_internal_generator) {
376 /* since the instrument has no input streams,
377 there is no reason to send any signal
383 if (Config->get_auto_input()) {
384 if (Config->get_monitoring_model() == SoftwareMonitoring) {
385 send_silence = false;
390 if (_diskstream->record_enabled()) {
391 if (Config->get_monitoring_model() == SoftwareMonitoring) {
392 send_silence = false;
402 apply_gain_automation = false;
406 /* if we're sending silence, but we want the meters to show levels for the signal,
410 if (_have_internal_generator) {
411 passthru_silence (start_frame, end_frame, nframes, offset, 0, true);
413 if (_meter_point == MeterInput) {
414 just_meter_input (start_frame, end_frame, nframes, offset);
416 passthru_silence (start_frame, end_frame, nframes, offset, 0, false);
421 /* we're sending signal, but we may still want to meter the input.
424 passthru (start_frame, end_frame, nframes, offset, 0, (_meter_point == MeterInput));
431 MidiTrack::roll (nframes_t nframes, nframes_t start_frame, nframes_t end_frame, nframes_t offset, int declick,
432 bool can_record, bool rec_monitors_input)
435 boost::shared_ptr<MidiDiskstream> diskstream = midi_diskstream();
438 Glib::RWLock::ReaderLock lm (_processor_lock, Glib::TRY_LOCK);
440 // automation snapshot can also be called from the non-rt context
441 // and it uses the redirect list, so we take the lock out here
442 automation_snapshot (start_frame);
446 if (n_outputs().n_total() == 0 && _processors.empty()) {
451 silence (nframes, offset);
455 nframes_t transport_frame = _session.transport_frame();
457 if ((nframes = check_initial_delay (nframes, offset, transport_frame)) == 0) {
458 /* need to do this so that the diskstream sets its
459 playback distance to zero, thus causing diskstream::commit
462 return diskstream->process (transport_frame, 0, 0, can_record, rec_monitors_input);
467 if ((dret = diskstream->process (transport_frame, nframes, offset, can_record, rec_monitors_input)) != 0) {
469 silence (nframes, offset);
474 /* special condition applies */
476 if (_meter_point == MeterInput) {
477 just_meter_input (start_frame, end_frame, nframes, offset);
480 if (diskstream->record_enabled() && !can_record && !Config->get_auto_input()) {
482 /* not actually recording, but we want to hear the input material anyway,
483 at least potentially (depending on monitoring options)
486 passthru (start_frame, end_frame, nframes, offset, 0, true);
490 XXX is it true that the earlier test on n_outputs()
491 means that we can avoid checking it again here? i think
492 so, because changing the i/o configuration of an IO
493 requires holding the AudioEngine lock, which we hold
494 while in the process() tree.
498 /* copy the diskstream data to all output buffers */
500 //const size_t limit = n_process_buffers().n_audio();
501 BufferSet& bufs = _session.get_scratch_buffers (n_process_buffers());
503 diskstream->get_playback(bufs.get_midi(0), start_frame, end_frame);
505 process_output_buffers (bufs, start_frame, end_frame, nframes, offset,
506 (!_session.get_record_enabled() || !Config->get_do_not_record_plugins()), declick, (_meter_point != MeterInput));
514 MidiTrack::silent_roll (nframes_t nframes, nframes_t start_frame, nframes_t end_frame, nframes_t offset,
515 bool can_record, bool rec_monitors_input)
517 if (n_outputs().n_midi() == 0 && _processors.empty()) {
522 silence (nframes, offset);
527 apply_gain_automation = false;
529 silence (nframes, offset);
531 return midi_diskstream()->process (_session.transport_frame() + offset, nframes, offset, can_record, rec_monitors_input);
535 MidiTrack::process_output_buffers (BufferSet& bufs,
536 nframes_t start_frame, nframes_t end_frame,
537 nframes_t nframes, nframes_t offset, bool with_processors, int declick,
540 /* There's no such thing as a MIDI bus for the time being.
541 * We'll do all the MIDI route work here for now, but the long-term goal is to have
542 * Route::process_output_buffers handle everything */
544 if (meter && (_meter_point == MeterInput || _meter_point == MeterPreFader)) {
545 _meter->run(bufs, start_frame, end_frame, nframes, offset);
548 // Run all processors
549 if (with_processors) {
550 Glib::RWLock::ReaderLock rm (_processor_lock, Glib::TRY_LOCK);
552 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
553 (*i)->run_in_place (bufs, start_frame, end_frame, nframes, offset);
558 if (meter && (_meter_point == MeterPostFader)) {
559 _meter->run(bufs, start_frame, end_frame, nframes, offset);
564 IO::silence(nframes, offset);
567 MidiBuffer& output_buf = bufs.get_midi(0);
568 write_controller_messages(output_buf, start_frame, end_frame, nframes, offset);
570 deliver_output(bufs, start_frame, end_frame, nframes, offset);
575 MidiTrack::write_controller_messages(MidiBuffer& output_buf, nframes_t start_frame, nframes_t end_frame,
576 nframes_t nframes, nframes_t offset)
578 BufferSet& mix_buffers = _session.get_mix_buffers(ChanCount(DataType::MIDI, 2));
580 /* FIXME: this could be more realtimey */
582 // Write immediate events (UI controls)
583 MidiBuffer& cc_buf = mix_buffers.get_midi(0);
584 cc_buf.silence(nframes, offset);
586 ev.size = 3; // CC = 3 bytes
588 buf[0] = MIDI_CMD_CONTROL;
591 // Write controller automation
592 if (_session.transport_rolling()) {
593 for (Controls::const_iterator i = _controls.begin(); i != _controls.end(); ++i) {
594 const boost::shared_ptr<AutomationList> list = (*i).second->list();
596 if ( (!list->automation_playback())
597 || (list->parameter().type() != MidiCCAutomation))
600 double start = start_frame;
602 while ((*i).second->list()->rt_safe_earliest_event(start, end_frame, x, y)) {
603 assert(x >= start_frame);
604 assert(x <= end_frame);
606 const nframes_t stamp = (nframes_t)floor(x - start_frame);
607 assert(stamp < nframes);
613 ev.buffer[1] = (Byte)list->parameter().id();
614 ev.buffer[2] = (Byte)y;
616 cc_buf.push_back(ev);
623 /* FIXME: too much copying! */
625 // Merge cc buf into output
626 if (cc_buf.size() > 0) {
628 // Both CC and route, must merge
629 if (output_buf.size() > 0) {
631 MidiBuffer& mix_buf = mix_buffers.get_midi(1);
632 mix_buf.merge(output_buf, cc_buf);
633 output_buf.copy(mix_buf);
636 output_buf.copy(cc_buf);
640 // Append immediate events (UI controls)
641 _immediate_events.read(output_buf, 0, 0, offset + nframes-1); // all stamps = 0
645 MidiTrack::export_stuff (BufferSet& bufs, nframes_t nframes, nframes_t end_frame)
651 MidiTrack::set_latency_delay (nframes_t longest_session_latency)
653 Route::set_latency_delay (longest_session_latency);
654 _diskstream->set_roll_delay (_roll_delay);
658 MidiTrack::bounce (InterThreadInfo& itt)
661 //vector<MidiSource*> srcs;
662 //_session.write_one_midi_track (*this, 0, _session.current_end_frame(), false, srcs, itt);
667 MidiTrack::bounce_range (nframes_t start, nframes_t end, InterThreadInfo& itt)
670 //vector<MidiSource*> srcs;
671 //_session.write_one_midi_track (*this, start, end, false, srcs, itt);
675 MidiTrack::freeze (InterThreadInfo& itt)
680 MidiTrack::unfreeze ()
682 _freeze_record.state = UnFrozen;
683 FreezeChange (); /* EMIT SIGNAL */
687 MidiTrack::set_mode (TrackMode m)
693 if (_diskstream->set_destructive (m == Destructive)) {
699 TrackModeChanged (); /* EMIT SIGNAL */
705 /** \return true on success, false on failure (no buffer space left)
708 MidiTrack::write_immediate_event(size_t size, const Byte* buf)
710 return (_immediate_events.write(0, size, buf) == size);
714 MidiTrack::MidiControl::set_value(float val)
717 assert(val <= 127.0);
719 if ( ! _list->automation_playback()) {
720 Byte ev[3] = { MIDI_CMD_CONTROL, _list->parameter().id(), (int)val };
721 _route->write_immediate_event(3, ev);
724 AutomationControl::set_value(val);