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>
25 #include <midi++/events.h>
26 #include <evoral/midi_util.h>
28 #include <ardour/midi_track.h>
29 #include <ardour/midi_diskstream.h>
30 #include <ardour/session.h>
31 #include <ardour/io_processor.h>
32 #include <ardour/midi_region.h>
33 #include <ardour/midi_source.h>
34 #include <ardour/route_group_specialized.h>
35 #include <ardour/processor.h>
36 #include <ardour/midi_playlist.h>
37 #include <ardour/panner.h>
38 #include <ardour/utils.h>
39 #include <ardour/buffer_set.h>
40 #include <ardour/meter.h>
46 using namespace ARDOUR;
49 MidiTrack::MidiTrack (Session& sess, string name, Route::Flag flag, TrackMode mode)
50 : Track (sess, name, flag, mode, DataType::MIDI)
51 , _immediate_events(1024) // FIXME: size?
52 , _note_mode(Sustained)
54 MidiDiskstream::Flag dflags = MidiDiskstream::Flag (0);
56 if (_flags & Hidden) {
57 dflags = MidiDiskstream::Flag (dflags | MidiDiskstream::Hidden);
59 dflags = MidiDiskstream::Flag (dflags | MidiDiskstream::Recordable);
62 assert(mode != Destructive);
64 boost::shared_ptr<MidiDiskstream> ds (new MidiDiskstream (_session, name, dflags));
65 _session.add_diskstream (ds);
67 set_diskstream (boost::dynamic_pointer_cast<MidiDiskstream> (ds));
70 _freeze_record.state = NoFreeze;
71 _saved_meter_point = _meter_point;
74 set_input_minimum(ChanCount(DataType::MIDI, 1));
75 set_input_maximum(ChanCount(DataType::MIDI, 1));
76 set_output_minimum(ChanCount(DataType::MIDI, 1));
77 set_output_maximum(ChanCount(DataType::MIDI, 1));
79 PortCountChanged(ChanCount(DataType::MIDI, 2)); /* EMIT SIGNAL */
82 MidiTrack::MidiTrack (Session& sess, const XMLNode& node)
83 : Track (sess, node, DataType::MIDI )
84 , _immediate_events(1024) // FIXME: size?
85 , _note_mode(Sustained)
87 _set_state(node, false);
89 set_input_minimum(ChanCount(DataType::MIDI, 1));
90 set_input_maximum(ChanCount(DataType::MIDI, 1));
91 set_output_minimum(ChanCount(DataType::MIDI, 1));
92 set_output_maximum(ChanCount(DataType::MIDI, 1));
94 PortCountChanged(ChanCount(DataType::MIDI, 2)); /* EMIT SIGNAL */
97 MidiTrack::~MidiTrack ()
103 MidiTrack::set_diskstream (boost::shared_ptr<MidiDiskstream> ds)
106 _diskstream->set_io (*this);
107 _diskstream->set_destructive (_mode == Destructive);
109 _diskstream->set_record_enabled (false);
110 //_diskstream->monitor_input (false);
112 ic_connection.disconnect();
113 ic_connection = input_changed.connect (mem_fun (*_diskstream, &MidiDiskstream::handle_input_change));
115 DiskstreamChanged (); /* EMIT SIGNAL */
121 MidiTrack::use_diskstream (string name)
123 boost::shared_ptr<MidiDiskstream> dstream;
125 if ((dstream = boost::dynamic_pointer_cast<MidiDiskstream>(_session.diskstream_by_name (name))) == 0) {
126 error << string_compose(_("MidiTrack: midi diskstream \"%1\" not known by session"), name) << endmsg;
130 return set_diskstream (dstream);
134 MidiTrack::use_diskstream (const PBD::ID& id)
136 boost::shared_ptr<MidiDiskstream> dstream;
138 if ((dstream = boost::dynamic_pointer_cast<MidiDiskstream> (_session.diskstream_by_id (id))) == 0) {
139 error << string_compose(_("MidiTrack: midi diskstream \"%1\" not known by session"), id) << endmsg;
143 return set_diskstream (dstream);
146 boost::shared_ptr<MidiDiskstream>
147 MidiTrack::midi_diskstream() const
149 return boost::dynamic_pointer_cast<MidiDiskstream>(_diskstream);
153 MidiTrack::set_state (const XMLNode& node)
155 return _set_state (node, true);
159 MidiTrack::_set_state (const XMLNode& node, bool call_base)
161 const XMLProperty *prop;
162 XMLNodeConstIterator iter;
164 if (Route::_set_state (node, call_base)) {
168 // No destructive MIDI tracks (yet?)
171 if ((prop = node.property (X_("note-mode"))) != 0) {
172 _note_mode = NoteMode (string_2_enum (prop->value(), _note_mode));
174 _note_mode = Sustained;
177 if ((prop = node.property ("diskstream-id")) == 0) {
179 /* some old sessions use the diskstream name rather than the ID */
181 if ((prop = node.property ("diskstream")) == 0) {
182 fatal << _("programming error: MidiTrack given state without diskstream!") << endmsg;
187 if (use_diskstream (prop->value())) {
193 PBD::ID id (prop->value());
195 if (use_diskstream (id)) {
202 XMLNodeConstIterator niter;
205 nlist = node.children();
206 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
209 if (child->name() == X_("recenable")) {
210 _rec_enable_control->set_state (*child);
211 _session.add_controllable (_rec_enable_control);
215 pending_state = const_cast<XMLNode*> (&node);
217 _session.StateReady.connect (mem_fun (*this, &MidiTrack::set_state_part_two));
223 MidiTrack::state(bool full_state)
225 XMLNode& root (Route::state(full_state));
226 XMLNode* freeze_node;
229 if (_freeze_record.playlist) {
232 freeze_node = new XMLNode (X_("freeze-info"));
233 freeze_node->add_property ("playlist", _freeze_record.playlist->name());
234 freeze_node->add_property ("state", enum_2_string (_freeze_record.state));
236 for (vector<FreezeRecordProcessorInfo*>::iterator i = _freeze_record.processor_info.begin(); i != _freeze_record.processor_info.end(); ++i) {
237 inode = new XMLNode (X_("processor"));
238 (*i)->id.print (buf, sizeof(buf));
239 inode->add_property (X_("id"), buf);
240 inode->add_child_copy ((*i)->state);
242 freeze_node->add_child_nocopy (*inode);
245 root.add_child_nocopy (*freeze_node);
248 /* Alignment: act as a proxy for the diskstream */
250 XMLNode* align_node = new XMLNode (X_("Alignment"));
251 AlignStyle as = _diskstream->alignment_style ();
252 align_node->add_property (X_("style"), enum_2_string (as));
253 root.add_child_nocopy (*align_node);
255 root.add_property (X_("note-mode"), enum_2_string (_note_mode));
257 /* we don't return diskstream state because we don't
258 own the diskstream exclusively. control of the diskstream
259 state is ceded to the Session, even if we create the
263 _diskstream->id().print (buf, sizeof(buf));
264 root.add_property ("diskstream-id", buf);
266 root.add_child_nocopy (_rec_enable_control->get_state());
272 MidiTrack::set_state_part_two ()
276 LocaleGuard lg (X_("POSIX"));
278 /* This is called after all session state has been restored but before
279 have been made ports and connections are established.
282 if (pending_state == 0) {
286 if ((fnode = find_named_node (*pending_state, X_("freeze-info"))) != 0) {
289 _freeze_record.have_mementos = false;
290 _freeze_record.state = Frozen;
292 for (vector<FreezeRecordProcessorInfo*>::iterator i = _freeze_record.processor_info.begin(); i != _freeze_record.processor_info.end(); ++i) {
295 _freeze_record.processor_info.clear ();
297 if ((prop = fnode->property (X_("playlist"))) != 0) {
298 boost::shared_ptr<Playlist> pl = _session.playlist_by_name (prop->value());
300 _freeze_record.playlist = boost::dynamic_pointer_cast<MidiPlaylist> (pl);
302 _freeze_record.playlist.reset();
303 _freeze_record.state = NoFreeze;
308 if ((prop = fnode->property (X_("state"))) != 0) {
309 _freeze_record.state = FreezeState (string_2_enum (prop->value(), _freeze_record.state));
312 XMLNodeConstIterator citer;
313 XMLNodeList clist = fnode->children();
315 for (citer = clist.begin(); citer != clist.end(); ++citer) {
316 if ((*citer)->name() != X_("processor")) {
320 if ((prop = (*citer)->property (X_("id"))) == 0) {
324 FreezeRecordProcessorInfo* frii = new FreezeRecordProcessorInfo (*((*citer)->children().front()),
325 boost::shared_ptr<Processor>());
326 frii->id = prop->value ();
327 _freeze_record.processor_info.push_back (frii);
331 /* Alignment: act as a proxy for the diskstream */
333 if ((fnode = find_named_node (*pending_state, X_("Alignment"))) != 0) {
335 if ((prop = fnode->property (X_("style"))) != 0) {
337 /* fix for older sessions from before EnumWriter */
341 if (prop->value() == "capture") {
342 pstr = "CaptureTime";
343 } else if (prop->value() == "existing") {
344 pstr = "ExistingMaterial";
346 pstr = prop->value();
349 AlignStyle as = AlignStyle (string_2_enum (pstr, as));
350 _diskstream->set_persistent_align_style (as);
357 MidiTrack::no_roll (nframes_t nframes, nframes_t start_frame, nframes_t end_frame, nframes_t offset,
358 bool session_state_changing, bool can_record, bool rec_monitors_input)
360 if (n_outputs().n_midi() == 0) {
365 silence (nframes, offset);
368 if (session_state_changing) {
370 /* XXX is this safe to do against transport state changes? */
372 passthru_silence (start_frame, end_frame, nframes, offset, 0, false);
376 midi_diskstream()->check_record_status (start_frame, nframes, can_record);
380 if (_have_internal_generator) {
381 /* since the instrument has no input streams,
382 there is no reason to send any signal
388 if (Config->get_auto_input()) {
389 if (Config->get_monitoring_model() == SoftwareMonitoring) {
390 send_silence = false;
395 if (_diskstream->record_enabled()) {
396 if (Config->get_monitoring_model() == SoftwareMonitoring) {
397 send_silence = false;
407 apply_gain_automation = false;
411 /* if we're sending silence, but we want the meters to show levels for the signal,
415 if (_have_internal_generator) {
416 passthru_silence (start_frame, end_frame, nframes, offset, 0, true);
418 if (_meter_point == MeterInput) {
419 just_meter_input (start_frame, end_frame, nframes, offset);
421 passthru_silence (start_frame, end_frame, nframes, offset, 0, false);
426 /* we're sending signal, but we may still want to meter the input.
429 passthru (start_frame, end_frame, nframes, offset, 0, (_meter_point == MeterInput));
432 flush_outputs( nframes, offset );
438 MidiTrack::roll (nframes_t nframes, nframes_t start_frame, nframes_t end_frame, nframes_t offset, int declick,
439 bool can_record, bool rec_monitors_input)
442 boost::shared_ptr<MidiDiskstream> diskstream = midi_diskstream();
444 // I guess this is the right place to call cycle_start for our ports.
445 // but it actually sucks, to directly mess with the IO.... oh well.
447 prepare_inputs( nframes, offset );
450 Glib::RWLock::ReaderLock lm (_processor_lock, Glib::TRY_LOCK);
452 // automation snapshot can also be called from the non-rt context
453 // and it uses the redirect list, so we take the lock out here
454 automation_snapshot (start_frame);
458 if (n_outputs().n_total() == 0 && _processors.empty()) {
463 silence (nframes, offset);
467 nframes_t transport_frame = _session.transport_frame();
470 if ((nframes = check_initial_delay (nframes, offset, transport_frame)) == 0) {
471 /* need to do this so that the diskstream sets its
472 playback distance to zero, thus causing diskstream::commit
475 return diskstream->process (transport_frame, 0, 0, can_record, rec_monitors_input);
480 if ((dret = diskstream->process (transport_frame, nframes, offset, can_record, rec_monitors_input)) != 0) {
482 silence (nframes, offset);
487 /* special condition applies */
489 if (_meter_point == MeterInput) {
490 just_meter_input (start_frame, end_frame, nframes, offset);
493 if (diskstream->record_enabled() && !can_record && !Config->get_auto_input()) {
495 /* not actually recording, but we want to hear the input material anyway,
496 at least potentially (depending on monitoring options)
499 passthru (start_frame, end_frame, nframes, offset, 0, true);
503 XXX is it true that the earlier test on n_outputs()
504 means that we can avoid checking it again here? i think
505 so, because changing the i/o configuration of an IO
506 requires holding the AudioEngine lock, which we hold
507 while in the process() tree.
511 /* copy the diskstream data to all output buffers */
513 //const size_t limit = n_process_buffers().n_audio();
514 BufferSet& bufs = _session.get_scratch_buffers (n_process_buffers());
516 diskstream->get_playback(bufs.get_midi(0), start_frame, end_frame, offset);
518 process_output_buffers (bufs, start_frame, end_frame, nframes, offset,
519 (!_session.get_record_enabled() || !Config->get_do_not_record_plugins()), declick, (_meter_point != MeterInput));
523 flush_outputs( nframes, offset );
529 MidiTrack::silent_roll (nframes_t nframes, nframes_t start_frame, nframes_t end_frame, nframes_t offset,
530 bool can_record, bool rec_monitors_input)
532 if (n_outputs().n_midi() == 0 && _processors.empty()) {
537 silence (nframes, offset);
542 apply_gain_automation = false;
544 silence (nframes, offset);
546 return midi_diskstream()->process (_session.transport_frame() + offset, nframes, offset, can_record, rec_monitors_input);
550 MidiTrack::process_output_buffers (BufferSet& bufs,
551 nframes_t start_frame, nframes_t end_frame,
552 nframes_t nframes, nframes_t offset, bool with_processors, int declick,
555 /* There's no such thing as a MIDI bus for the time being.
556 * We'll do all the MIDI route work here for now, but the long-term goal is to have
557 * Route::process_output_buffers handle everything */
559 if (meter && (_meter_point == MeterInput || _meter_point == MeterPreFader)) {
560 _meter->run_in_place(bufs, start_frame, end_frame, nframes, offset);
563 // Run all processors
564 if (with_processors) {
565 Glib::RWLock::ReaderLock rm (_processor_lock, Glib::TRY_LOCK);
567 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
568 (*i)->run_in_place (bufs, start_frame, end_frame, nframes, offset);
573 if (meter && (_meter_point == MeterPostFader)) {
574 _meter->run_in_place(bufs, start_frame, end_frame, nframes, offset);
579 IO::silence(nframes, offset);
582 // Write 'automation' controllers (e.g. CC events from a UI slider)
583 write_controller_messages(bufs.get_midi(0), start_frame, end_frame, nframes, offset);
585 deliver_output(bufs, start_frame, end_frame, nframes, offset);
590 MidiTrack::write_controller_messages(MidiBuffer& output_buf, nframes_t start, nframes_t end,
591 nframes_t nframes, nframes_t offset)
593 // Append immediate events (UI controls)
594 _immediate_events.read(output_buf, 0, 0, offset + nframes - 1); // all stamps = 0
598 MidiTrack::export_stuff (BufferSet& bufs, nframes_t nframes, nframes_t end_frame)
604 MidiTrack::set_latency_delay (nframes_t longest_session_latency)
606 Route::set_latency_delay (longest_session_latency);
607 _diskstream->set_roll_delay (_roll_delay);
610 boost::shared_ptr<Region>
611 MidiTrack::bounce (InterThreadInfo& itt)
614 // vector<MidiSource*> srcs;
615 // return _session.write_one_track (*this, 0, _session.current_end_frame(), false, srcs, itt);
616 return boost::shared_ptr<Region> ();
620 boost::shared_ptr<Region>
621 MidiTrack::bounce_range (nframes_t start, nframes_t end, InterThreadInfo& itt)
624 //vector<MidiSource*> srcs;
625 //return _session.write_one_track (*this, start, end, false, srcs, itt);
626 return boost::shared_ptr<Region> ();
630 MidiTrack::freeze (InterThreadInfo& itt)
635 MidiTrack::unfreeze ()
637 _freeze_record.state = UnFrozen;
638 FreezeChange (); /* EMIT SIGNAL */
642 MidiTrack::set_note_mode (NoteMode m)
645 midi_diskstream()->set_note_mode(m);
649 MidiTrack::midi_panic()
651 for (uint8_t channel = 0; channel <= 0xF; channel++) {
652 uint8_t ev[3] = { MIDI_CMD_CONTROL | channel, MIDI_CTL_SUSTAIN, 0 };
653 write_immediate_event(3, ev);
654 ev[1] = MIDI_CTL_ALL_NOTES_OFF;
655 write_immediate_event(3, ev);
656 ev[1] = MIDI_CTL_RESET_CONTROLLERS;
657 write_immediate_event(3, ev);
661 /** \return true on success, false on failure (no buffer space left)
664 MidiTrack::write_immediate_event(size_t size, const uint8_t* buf)
666 if (!Evoral::midi_event_is_valid(buf, size)) {
667 cerr << "WARNING: Ignoring illegal immediate MIDI event" << endl;
670 const uint32_t type = EventTypeMap::instance().midi_event_type(buf[0]);
671 return (_immediate_events.write(0, type, size, buf) == size);
675 MidiTrack::MidiControl::set_value(float val)
679 cerr << "MIDIControl value is infinity" << endl;
680 } else if (isnan(val)) {
681 cerr << "MIDIControl value is NaN" << endl;
682 } else if (val < _list->parameter().min()) {
683 cerr << "MIDIControl value is < " << _list->parameter().min() << endl;
684 } else if (val > _list->parameter().max()) {
685 cerr << "MIDIControl value is > " << _list->parameter().max() << endl;
694 assert(val <= _list->parameter().max());
697 if ( ! automation_playback()) {
698 uint8_t ev[3] = { _list->parameter().channel(), int(val), 0 };
699 switch(_list->parameter().type()) {
700 case MidiCCAutomation:
701 ev[0] += MIDI_CMD_CONTROL;
702 ev[1] = _list->parameter().id();
706 case MidiPgmChangeAutomation:
708 ev[0] += MIDI_CMD_PGM_CHANGE;
712 case MidiChannelPressureAutomation:
714 ev[0] += MIDI_CMD_CHANNEL_PRESSURE;
718 case MidiPitchBenderAutomation:
719 ev[0] += MIDI_CMD_BENDER;
720 ev[1] = 0x7F & int(val);
721 ev[2] = 0x7F & (int(val) >> 7);
727 _route->write_immediate_event(size, ev);
730 AutomationControl::set_value(val);