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 PortCountChanged(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 PortCountChanged(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 // No destructive MIDI tracks (yet?)
167 if ((prop = node.property (X_("note-mode"))) != 0) {
168 _note_mode = NoteMode (string_2_enum (prop->value(), _note_mode));
170 _note_mode = Sustained;
173 if ((prop = node.property ("diskstream-id")) == 0) {
175 /* some old sessions use the diskstream name rather than the ID */
177 if ((prop = node.property ("diskstream")) == 0) {
178 fatal << _("programming error: MidiTrack given state without diskstream!") << endmsg;
183 if (use_diskstream (prop->value())) {
189 PBD::ID id (prop->value());
191 if (use_diskstream (id)) {
198 XMLNodeConstIterator niter;
201 nlist = node.children();
202 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
205 if (child->name() == X_("recenable")) {
206 _rec_enable_control->set_state (*child);
207 _session.add_controllable (_rec_enable_control);
211 pending_state = const_cast<XMLNode*> (&node);
213 _session.StateReady.connect (mem_fun (*this, &MidiTrack::set_state_part_two));
219 MidiTrack::state(bool full_state)
221 XMLNode& root (Route::state(full_state));
222 XMLNode* freeze_node;
225 if (_freeze_record.playlist) {
228 freeze_node = new XMLNode (X_("freeze-info"));
229 freeze_node->add_property ("playlist", _freeze_record.playlist->name());
230 freeze_node->add_property ("state", enum_2_string (_freeze_record.state));
232 for (vector<FreezeRecordProcessorInfo*>::iterator i = _freeze_record.processor_info.begin(); i != _freeze_record.processor_info.end(); ++i) {
233 inode = new XMLNode (X_("processor"));
234 (*i)->id.print (buf, sizeof(buf));
235 inode->add_property (X_("id"), buf);
236 inode->add_child_copy ((*i)->state);
238 freeze_node->add_child_nocopy (*inode);
241 root.add_child_nocopy (*freeze_node);
244 /* Alignment: act as a proxy for the diskstream */
246 XMLNode* align_node = new XMLNode (X_("alignment"));
247 AlignStyle as = _diskstream->alignment_style ();
248 align_node->add_property (X_("style"), enum_2_string (as));
249 root.add_child_nocopy (*align_node);
251 root.add_property (X_("note-mode"), enum_2_string (_note_mode));
253 /* we don't return diskstream state because we don't
254 own the diskstream exclusively. control of the diskstream
255 state is ceded to the Session, even if we create the
259 _diskstream->id().print (buf, sizeof(buf));
260 root.add_property ("diskstream-id", buf);
262 root.add_child_nocopy (_rec_enable_control->get_state());
268 MidiTrack::set_state_part_two ()
272 LocaleGuard lg (X_("POSIX"));
274 /* This is called after all session state has been restored but before
275 have been made ports and connections are established.
278 if (pending_state == 0) {
282 if ((fnode = find_named_node (*pending_state, X_("freeze-info"))) != 0) {
285 _freeze_record.have_mementos = false;
286 _freeze_record.state = Frozen;
288 for (vector<FreezeRecordProcessorInfo*>::iterator i = _freeze_record.processor_info.begin(); i != _freeze_record.processor_info.end(); ++i) {
291 _freeze_record.processor_info.clear ();
293 if ((prop = fnode->property (X_("playlist"))) != 0) {
294 boost::shared_ptr<Playlist> pl = _session.playlist_by_name (prop->value());
296 _freeze_record.playlist = boost::dynamic_pointer_cast<MidiPlaylist> (pl);
298 _freeze_record.playlist.reset();
299 _freeze_record.state = NoFreeze;
304 if ((prop = fnode->property (X_("state"))) != 0) {
305 _freeze_record.state = FreezeState (string_2_enum (prop->value(), _freeze_record.state));
308 XMLNodeConstIterator citer;
309 XMLNodeList clist = fnode->children();
311 for (citer = clist.begin(); citer != clist.end(); ++citer) {
312 if ((*citer)->name() != X_("processor")) {
316 if ((prop = (*citer)->property (X_("id"))) == 0) {
320 FreezeRecordProcessorInfo* frii = new FreezeRecordProcessorInfo (*((*citer)->children().front()),
321 boost::shared_ptr<Processor>());
322 frii->id = prop->value ();
323 _freeze_record.processor_info.push_back (frii);
327 /* Alignment: act as a proxy for the diskstream */
329 if ((fnode = find_named_node (*pending_state, X_("alignment"))) != 0) {
331 if ((prop = fnode->property (X_("style"))) != 0) {
333 /* fix for older sessions from before EnumWriter */
337 if (prop->value() == "capture") {
338 pstr = "CaptureTime";
339 } else if (prop->value() == "existing") {
340 pstr = "ExistingMaterial";
342 pstr = prop->value();
345 AlignStyle as = AlignStyle (string_2_enum (pstr, as));
346 _diskstream->set_persistent_align_style (as);
353 MidiTrack::no_roll (nframes_t nframes, nframes_t start_frame, nframes_t end_frame, nframes_t offset,
354 bool session_state_changing, bool can_record, bool rec_monitors_input)
356 if (n_outputs().n_midi() == 0) {
361 silence (nframes, offset);
364 if (session_state_changing) {
366 /* XXX is this safe to do against transport state changes? */
368 passthru_silence (start_frame, end_frame, nframes, offset, 0, false);
372 midi_diskstream()->check_record_status (start_frame, nframes, can_record);
376 if (_have_internal_generator) {
377 /* since the instrument has no input streams,
378 there is no reason to send any signal
384 if (Config->get_auto_input()) {
385 if (Config->get_monitoring_model() == SoftwareMonitoring) {
386 send_silence = false;
391 if (_diskstream->record_enabled()) {
392 if (Config->get_monitoring_model() == SoftwareMonitoring) {
393 send_silence = false;
403 apply_gain_automation = false;
407 /* if we're sending silence, but we want the meters to show levels for the signal,
411 if (_have_internal_generator) {
412 passthru_silence (start_frame, end_frame, nframes, offset, 0, true);
414 if (_meter_point == MeterInput) {
415 just_meter_input (start_frame, end_frame, nframes, offset);
417 passthru_silence (start_frame, end_frame, nframes, offset, 0, false);
422 /* we're sending signal, but we may still want to meter the input.
425 passthru (start_frame, end_frame, nframes, offset, 0, (_meter_point == MeterInput));
432 MidiTrack::roll (nframes_t nframes, nframes_t start_frame, nframes_t end_frame, nframes_t offset, int declick,
433 bool can_record, bool rec_monitors_input)
436 boost::shared_ptr<MidiDiskstream> diskstream = midi_diskstream();
439 Glib::RWLock::ReaderLock lm (_processor_lock, Glib::TRY_LOCK);
441 // automation snapshot can also be called from the non-rt context
442 // and it uses the redirect list, so we take the lock out here
443 automation_snapshot (start_frame);
447 if (n_outputs().n_total() == 0 && _processors.empty()) {
452 silence (nframes, offset);
456 nframes_t transport_frame = _session.transport_frame();
458 if ((nframes = check_initial_delay (nframes, offset, transport_frame)) == 0) {
459 /* need to do this so that the diskstream sets its
460 playback distance to zero, thus causing diskstream::commit
463 return diskstream->process (transport_frame, 0, 0, can_record, rec_monitors_input);
468 if ((dret = diskstream->process (transport_frame, nframes, offset, can_record, rec_monitors_input)) != 0) {
470 silence (nframes, offset);
475 /* special condition applies */
477 if (_meter_point == MeterInput) {
478 just_meter_input (start_frame, end_frame, nframes, offset);
481 if (diskstream->record_enabled() && !can_record && !Config->get_auto_input()) {
483 /* not actually recording, but we want to hear the input material anyway,
484 at least potentially (depending on monitoring options)
487 passthru (start_frame, end_frame, nframes, offset, 0, true);
491 XXX is it true that the earlier test on n_outputs()
492 means that we can avoid checking it again here? i think
493 so, because changing the i/o configuration of an IO
494 requires holding the AudioEngine lock, which we hold
495 while in the process() tree.
499 /* copy the diskstream data to all output buffers */
501 //const size_t limit = n_process_buffers().n_audio();
502 BufferSet& bufs = _session.get_scratch_buffers (n_process_buffers());
504 diskstream->get_playback(bufs.get_midi(0), start_frame, end_frame);
506 process_output_buffers (bufs, start_frame, end_frame, nframes, offset,
507 (!_session.get_record_enabled() || !Config->get_do_not_record_plugins()), declick, (_meter_point != MeterInput));
515 MidiTrack::silent_roll (nframes_t nframes, nframes_t start_frame, nframes_t end_frame, nframes_t offset,
516 bool can_record, bool rec_monitors_input)
518 if (n_outputs().n_midi() == 0 && _processors.empty()) {
523 silence (nframes, offset);
528 apply_gain_automation = false;
530 silence (nframes, offset);
532 return midi_diskstream()->process (_session.transport_frame() + offset, nframes, offset, can_record, rec_monitors_input);
536 MidiTrack::process_output_buffers (BufferSet& bufs,
537 nframes_t start_frame, nframes_t end_frame,
538 nframes_t nframes, nframes_t offset, bool with_processors, int declick,
541 /* There's no such thing as a MIDI bus for the time being.
542 * We'll do all the MIDI route work here for now, but the long-term goal is to have
543 * Route::process_output_buffers handle everything */
545 if (meter && (_meter_point == MeterInput || _meter_point == MeterPreFader)) {
546 _meter->run(bufs, start_frame, end_frame, nframes, offset);
549 // Run all processors
550 if (with_processors) {
551 Glib::RWLock::ReaderLock rm (_processor_lock, Glib::TRY_LOCK);
553 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
554 (*i)->run_in_place (bufs, start_frame, end_frame, nframes, offset);
559 if (meter && (_meter_point == MeterPostFader)) {
560 _meter->run(bufs, start_frame, end_frame, nframes, offset);
565 IO::silence(nframes, offset);
568 MidiBuffer& output_buf = bufs.get_midi(0);
569 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 Byte buf[3]; // CC = 3 bytes
587 buf[0] = MIDI_CMD_CONTROL;
588 MidiEvent ev(0, 3, buf, false);
590 // Write track controller automation
592 // This now lives in MidiModel. Any need for track automation like this?
593 // Relative Velocity?
594 if (_session.transport_rolling()) {
595 for (Controls::const_iterator i = _controls.begin(); i != _controls.end(); ++i) {
596 const boost::shared_ptr<AutomationList> list = (*i).second->list();
598 if ( (!list->automation_playback())
599 || (list->parameter().type() != MidiCCAutomation))
602 double start = start_frame;
604 while ((*i).second->list()->rt_safe_earliest_event(start, end_frame, x, y)) {
605 assert(x >= start_frame);
606 assert(x <= end_frame);
608 const nframes_t stamp = (nframes_t)floor(x - start_frame);
609 assert(stamp < nframes);
615 ev.buffer()[1] = (Byte)list->parameter().id();
616 ev.buffer()[2] = (Byte)y;
618 cc_buf.push_back(ev);
620 start = x + 1; // FIXME? maybe?
625 /* FIXME: too much copying! */
627 // Merge cc buf into output
628 if (cc_buf.size() > 0) {
630 // Both CC and route, must merge
631 if (output_buf.size() > 0) {
633 MidiBuffer& mix_buf = mix_buffers.get_midi(1);
634 mix_buf.merge(output_buf, cc_buf);
635 output_buf.copy(mix_buf);
638 output_buf.copy(cc_buf);
643 // Append immediate events (UI controls)
644 _immediate_events.read(output_buf, 0, 0, offset + nframes-1); // all stamps = 0
648 MidiTrack::export_stuff (BufferSet& bufs, nframes_t nframes, nframes_t end_frame)
654 MidiTrack::set_latency_delay (nframes_t longest_session_latency)
656 Route::set_latency_delay (longest_session_latency);
657 _diskstream->set_roll_delay (_roll_delay);
661 MidiTrack::bounce (InterThreadInfo& itt)
664 //vector<MidiSource*> srcs;
665 //_session.write_one_midi_track (*this, 0, _session.current_end_frame(), false, srcs, itt);
670 MidiTrack::bounce_range (nframes_t start, nframes_t end, InterThreadInfo& itt)
673 //vector<MidiSource*> srcs;
674 //_session.write_one_midi_track (*this, start, end, false, srcs, itt);
678 MidiTrack::freeze (InterThreadInfo& itt)
683 MidiTrack::unfreeze ()
685 _freeze_record.state = UnFrozen;
686 FreezeChange (); /* EMIT SIGNAL */
690 MidiTrack::set_note_mode (NoteMode m)
693 midi_diskstream()->set_note_mode(m);
696 /** \return true on success, false on failure (no buffer space left)
699 MidiTrack::write_immediate_event(size_t size, const Byte* buf)
701 return (_immediate_events.write(0, size, buf) == size);
705 MidiTrack::MidiControl::set_value(float val)
708 assert(val <= 127.0);
710 if ( ! _list->automation_playback()) {
711 Byte ev[3] = { MIDI_CMD_CONTROL, _list->parameter().id(), (int)val };
712 _route->write_immediate_event(3, ev);
715 AutomationControl::set_value(val);