2 Copyright (C) 2006 Paul Davis
3 Author: David Robillard
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.
20 #include "pbd/error.h"
22 #include "pbd/enumwriter.h"
23 #include "pbd/convert.h"
24 #include "midi++/events.h"
25 #include "evoral/midi_util.h"
27 #include "ardour/amp.h"
28 #include "ardour/buffer_set.h"
29 #include "ardour/debug.h"
30 #include "ardour/delivery.h"
31 #include "ardour/io_processor.h"
32 #include "ardour/meter.h"
33 #include "ardour/midi_diskstream.h"
34 #include "ardour/midi_playlist.h"
35 #include "ardour/midi_port.h"
36 #include "ardour/midi_region.h"
37 #include "ardour/midi_source.h"
38 #include "ardour/midi_track.h"
39 #include "ardour/panner.h"
40 #include "ardour/port.h"
41 #include "ardour/processor.h"
42 #include "ardour/route_group_specialized.h"
43 #include "ardour/session.h"
44 #include "ardour/session_playlists.h"
45 #include "ardour/utils.h"
50 using namespace ARDOUR;
53 MidiTrack::MidiTrack (Session& sess, string name, Route::Flag flag, TrackMode mode)
54 : Track (sess, name, flag, mode, DataType::MIDI)
55 , _immediate_events(1024) // FIXME: size?
56 , _step_edit_ring_buffer(64) // FIXME: size?
57 , _note_mode(Sustained)
58 , _step_editing (false)
60 , _input_active (true)
64 MidiTrack::~MidiTrack ()
75 _input->changed.connect_same_thread (*this, boost::bind (&MidiTrack::track_input_active, this, _1, _2));
81 MidiTrack::use_new_diskstream ()
83 MidiDiskstream::Flag dflags = MidiDiskstream::Flag (0);
85 if (_flags & Hidden) {
86 dflags = MidiDiskstream::Flag (dflags | MidiDiskstream::Hidden);
88 dflags = MidiDiskstream::Flag (dflags | MidiDiskstream::Recordable);
91 assert(_mode != Destructive);
93 boost::shared_ptr<MidiDiskstream> ds (new MidiDiskstream (_session, name(), dflags));
94 ds->do_refill_with_alloc ();
95 ds->set_block_size (_session.get_block_size ());
101 MidiTrack::set_record_enabled (bool yn, void *src)
107 Track::set_record_enabled (yn, src);
111 MidiTrack::set_diskstream (boost::shared_ptr<Diskstream> ds)
113 Track::set_diskstream (ds);
115 _diskstream->set_track (this);
116 _diskstream->set_destructive (_mode == Destructive);
118 _diskstream->set_record_enabled (false);
119 //_diskstream->monitor_input (false);
121 _diskstream_data_recorded_connection.disconnect ();
122 boost::shared_ptr<MidiDiskstream> mds = boost::dynamic_pointer_cast<MidiDiskstream> (ds);
123 mds->DataRecorded.connect_same_thread (
124 _diskstream_data_recorded_connection,
125 boost::bind (&MidiTrack::diskstream_data_recorded, this, _1, _2));
127 DiskstreamChanged (); /* EMIT SIGNAL */
130 boost::shared_ptr<MidiDiskstream>
131 MidiTrack::midi_diskstream() const
133 return boost::dynamic_pointer_cast<MidiDiskstream>(_diskstream);
137 MidiTrack::set_state (const XMLNode& node, int version)
139 return _set_state (node, version, true);
143 MidiTrack::_set_state (const XMLNode& node, int version, bool call_base)
145 const XMLProperty *prop;
146 XMLNodeConstIterator iter;
148 if (Route::_set_state (node, version, call_base)) {
152 // No destructive MIDI tracks (yet?)
155 if ((prop = node.property (X_("note-mode"))) != 0) {
156 _note_mode = NoteMode (string_2_enum (prop->value(), _note_mode));
158 _note_mode = Sustained;
161 if ((prop = node.property ("midi-thru")) != 0) {
162 set_midi_thru (string_is_affirmative (prop->value()));
165 if ((prop = node.property ("input-active")) != 0) {
166 set_input_active (string_is_affirmative (prop->value()));
170 XMLNodeConstIterator niter;
173 nlist = node.children();
175 if (version >= 3000) {
176 if ((child = find_named_node (node, X_("Diskstream"))) != 0) {
177 boost::shared_ptr<MidiDiskstream> ds (new MidiDiskstream (_session, *child));
178 ds->do_refill_with_alloc ();
183 /* set rec-enable control *AFTER* setting up diskstream, because it may
184 want to operate on the diskstream as it sets its own state
187 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
190 if (child->name() == Controllable::xml_node_name && (prop = child->property ("name")) != 0) {
191 if (prop->value() == X_("recenable")) {
192 _rec_enable_control->set_state (*child, version);
197 pending_state = const_cast<XMLNode*> (&node);
199 if (_session.state_of_the_state() & Session::Loading) {
200 _session.StateReady.connect_same_thread (
201 *this, boost::bind (&MidiTrack::set_state_part_two, this));
203 set_state_part_two ();
210 MidiTrack::state(bool full_state)
212 XMLNode& root (Route::state(full_state));
213 XMLNode* freeze_node;
216 if (_freeze_record.playlist) {
219 freeze_node = new XMLNode (X_("freeze-info"));
220 freeze_node->add_property ("playlist", _freeze_record.playlist->name());
221 freeze_node->add_property ("state", enum_2_string (_freeze_record.state));
223 for (vector<FreezeRecordProcessorInfo*>::iterator i = _freeze_record.processor_info.begin(); i != _freeze_record.processor_info.end(); ++i) {
224 inode = new XMLNode (X_("processor"));
225 (*i)->id.print (buf, sizeof(buf));
226 inode->add_property (X_("id"), buf);
227 inode->add_child_copy ((*i)->state);
229 freeze_node->add_child_nocopy (*inode);
232 root.add_child_nocopy (*freeze_node);
235 root.add_property (X_("note-mode"), enum_2_string (_note_mode));
236 root.add_child_nocopy (_rec_enable_control->get_state());
237 root.add_child_nocopy (_diskstream->get_state ());
239 root.add_property ("step-editing", (_step_editing ? "yes" : "no"));
240 root.add_property ("note-mode", enum_2_string (_note_mode));
241 root.add_property ("midi-thru", (_midi_thru ? "yes" : "no"));
242 root.add_property ("input-active", (_input_active ? "yes" : "no"));
248 MidiTrack::set_state_part_two ()
252 LocaleGuard lg (X_("POSIX"));
254 /* This is called after all session state has been restored but before
255 have been made ports and connections are established.
258 if (pending_state == 0) {
262 if ((fnode = find_named_node (*pending_state, X_("freeze-info"))) != 0) {
264 _freeze_record.state = Frozen;
266 for (vector<FreezeRecordProcessorInfo*>::iterator i = _freeze_record.processor_info.begin(); i != _freeze_record.processor_info.end(); ++i) {
269 _freeze_record.processor_info.clear ();
271 if ((prop = fnode->property (X_("playlist"))) != 0) {
272 boost::shared_ptr<Playlist> pl = _session.playlists->by_name (prop->value());
274 _freeze_record.playlist = boost::dynamic_pointer_cast<MidiPlaylist> (pl);
276 _freeze_record.playlist.reset();
277 _freeze_record.state = NoFreeze;
282 if ((prop = fnode->property (X_("state"))) != 0) {
283 _freeze_record.state = FreezeState (string_2_enum (prop->value(), _freeze_record.state));
286 XMLNodeConstIterator citer;
287 XMLNodeList clist = fnode->children();
289 for (citer = clist.begin(); citer != clist.end(); ++citer) {
290 if ((*citer)->name() != X_("processor")) {
294 if ((prop = (*citer)->property (X_("id"))) == 0) {
298 FreezeRecordProcessorInfo* frii = new FreezeRecordProcessorInfo (*((*citer)->children().front()),
299 boost::shared_ptr<Processor>());
300 frii->id = prop->value ();
301 _freeze_record.processor_info.push_back (frii);
305 if (midi_diskstream ()) {
306 midi_diskstream()->set_block_size (_session.get_block_size ());
313 MidiTrack::roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame, int declick,
314 bool can_record, bool& needs_butler)
316 Glib::RWLock::ReaderLock lm (_processor_lock, Glib::TRY_LOCK);
322 boost::shared_ptr<MidiDiskstream> diskstream = midi_diskstream();
324 automation_snapshot (start_frame);
326 if (n_outputs().n_total() == 0 && _processors.empty()) {
335 framepos_t transport_frame = _session.transport_frame();
337 if ((nframes = check_initial_delay (nframes, transport_frame)) == 0) {
338 /* need to do this so that the diskstream sets its
339 playback distance to zero, thus causing diskstream::commit
342 return diskstream->process (transport_frame, 0, can_record, needs_butler);
347 if ((dret = diskstream->process (transport_frame, nframes, can_record, needs_butler)) != 0) {
352 /* special condition applies */
354 if (_meter_point == MeterInput) {
355 _input->process_input (_meter, start_frame, end_frame, nframes);
358 if (diskstream->record_enabled() && !can_record && !_session.config.get_auto_input()) {
360 /* not actually recording, but we want to hear the input material anyway,
361 at least potentially (depending on monitoring options)
364 passthru (start_frame, end_frame, nframes, 0);
368 XXX is it true that the earlier test on n_outputs()
369 means that we can avoid checking it again here? i think
370 so, because changing the i/o configuration of an IO
371 requires holding the AudioEngine lock, which we hold
372 while in the process() tree.
376 /* copy the diskstream data to all output buffers */
378 //const size_t limit = n_process_buffers().n_audio();
379 BufferSet& bufs = _session.get_scratch_buffers (n_process_buffers());
380 MidiBuffer& mbuf (bufs.get_midi (0));
382 /* we are a MIDI track, so we always start the chain with a single-channel diskstream */
388 diskstream->get_playback (mbuf, start_frame, end_frame);
390 /* append immediate messages to the first MIDI buffer (thus sending it to the first output port) */
392 write_out_of_band_data (bufs, start_frame, end_frame, nframes);
394 /* final argument: don't waste time with automation if we're recording or we've just stopped (yes it can happen) */
396 process_output_buffers (bufs, start_frame, end_frame, nframes,
397 (!_session.get_record_enabled() || !Config->get_do_not_record_plugins()), declick,
398 (!diskstream->record_enabled() && !_session.transport_stopped()));
401 _main_outs->flush_buffers (nframes, end_frame - start_frame - 1);
407 MidiTrack::no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
408 bool state_changing, bool can_record)
410 int ret = Track::no_roll (nframes, start_frame, end_frame, state_changing, can_record);
412 if (ret == 0 && _step_editing) {
413 push_midi_input_to_step_edit_ringbuffer (nframes);
420 MidiTrack::realtime_locate ()
422 Glib::RWLock::ReaderLock lm (_processor_lock, Glib::TRY_LOCK);
427 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
428 (*i)->realtime_locate ();
433 MidiTrack::realtime_handle_transport_stopped ()
435 Glib::RWLock::ReaderLock lm (_processor_lock, Glib::TRY_LOCK);
440 for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
441 (*i)->realtime_handle_transport_stopped ();
446 MidiTrack::push_midi_input_to_step_edit_ringbuffer (framecnt_t nframes)
448 PortSet& ports (_input->ports());
450 for (PortSet::iterator p = ports.begin(DataType::MIDI); p != ports.end(DataType::MIDI); ++p) {
452 Buffer& b (p->get_buffer (nframes));
453 const MidiBuffer* const mb = dynamic_cast<MidiBuffer*>(&b);
456 for (MidiBuffer::const_iterator e = mb->begin(); e != mb->end(); ++e) {
458 const Evoral::MIDIEvent<framepos_t> ev(*e, false);
460 /* note on, since for step edit, note length is determined
464 if (ev.is_note_on()) {
465 /* we don't care about the time for this purpose */
466 _step_edit_ring_buffer.write (0, ev.type(), ev.size(), ev.buffer());
473 MidiTrack::write_out_of_band_data (BufferSet& bufs, framepos_t /*start*/, framepos_t /*end*/, framecnt_t nframes)
475 MidiBuffer& buf (bufs.get_midi (0));
477 // Append immediate events
479 if (_immediate_events.read_space()) {
481 DEBUG_TRACE (DEBUG::MidiIO, string_compose ("%1 has %2 of immediate events to deliver\n",
482 name(), _immediate_events.read_space()));
484 /* write as many of the immediate events as we can, but give "true" as
485 * the last argument ("stop on overflow in destination") so that we'll
486 * ship the rest out next time.
488 * the (nframes-1) argument puts all these events at the last
489 * possible position of the output buffer, so that we do not
490 * violate monotonicity when writing.
493 _immediate_events.read (buf, 0, 1, nframes-1, true);
496 // MIDI thru: send incoming data "through" output
497 if (_midi_thru && _session.transport_speed() != 0.0f && _input->n_ports().n_midi()) {
498 buf.merge_in_place (_input->midi(0)->get_midi_buffer(nframes));
503 MidiTrack::export_stuff (BufferSet& /*bufs*/, framecnt_t /*nframes*/, framepos_t /*end_frame*/)
508 boost::shared_ptr<Region>
509 MidiTrack::bounce (InterThreadInfo& /*itt*/)
511 std::cerr << "MIDI bounce currently unsupported" << std::endl;
512 return boost::shared_ptr<Region> ();
516 boost::shared_ptr<Region>
517 MidiTrack::bounce_range (framepos_t /*start*/, framepos_t /*end*/, InterThreadInfo& /*itt*/, bool /*enable_processing*/)
519 std::cerr << "MIDI bounce range currently unsupported" << std::endl;
520 return boost::shared_ptr<Region> ();
524 MidiTrack::freeze_me (InterThreadInfo& /*itt*/)
526 std::cerr << "MIDI freeze currently unsupported" << std::endl;
530 MidiTrack::unfreeze ()
532 _freeze_record.state = UnFrozen;
533 FreezeChange (); /* EMIT SIGNAL */
537 MidiTrack::set_note_mode (NoteMode m)
540 midi_diskstream()->set_note_mode(m);
544 MidiTrack::midi_panic()
546 DEBUG_TRACE (DEBUG::MidiIO, string_compose ("%1 delivers panic data\n", name()));
547 for (uint8_t channel = 0; channel <= 0xF; channel++) {
548 uint8_t ev[3] = { MIDI_CMD_CONTROL | channel, MIDI_CTL_SUSTAIN, 0 };
549 write_immediate_event(3, ev);
550 ev[1] = MIDI_CTL_ALL_NOTES_OFF;
551 write_immediate_event(3, ev);
552 ev[1] = MIDI_CTL_RESET_CONTROLLERS;
553 write_immediate_event(3, ev);
557 /** \return true on success, false on failure (no buffer space left)
560 MidiTrack::write_immediate_event(size_t size, const uint8_t* buf)
562 if (!Evoral::midi_event_is_valid(buf, size)) {
563 cerr << "WARNING: Ignoring illegal immediate MIDI event" << endl;
566 const uint32_t type = EventTypeMap::instance().midi_event_type(buf[0]);
567 return (_immediate_events.write(0, type, size, buf) == size);
571 MidiTrack::MidiControl::set_value(double val)
575 cerr << "MIDIControl value is infinity" << endl;
576 } else if (isnan(val)) {
577 cerr << "MIDIControl value is NaN" << endl;
578 } else if (val < _list->parameter().min()) {
579 cerr << "MIDIControl value is < " << _list->parameter().min() << endl;
580 } else if (val > _list->parameter().max()) {
581 cerr << "MIDIControl value is > " << _list->parameter().max() << endl;
590 assert(val <= _list->parameter().max());
591 if ( ! automation_playback()) {
593 uint8_t ev[3] = { _list->parameter().channel(), int(val), 0 };
594 switch(_list->parameter().type()) {
595 case MidiCCAutomation:
596 ev[0] += MIDI_CMD_CONTROL;
597 ev[1] = _list->parameter().id();
601 case MidiPgmChangeAutomation:
603 ev[0] += MIDI_CMD_PGM_CHANGE;
607 case MidiChannelPressureAutomation:
609 ev[0] += MIDI_CMD_CHANNEL_PRESSURE;
613 case MidiPitchBenderAutomation:
614 ev[0] += MIDI_CMD_BENDER;
615 ev[1] = 0x7F & int(val);
616 ev[2] = 0x7F & (int(val) >> 7);
622 _route->write_immediate_event(size, ev);
625 AutomationControl::set_value(val);
629 MidiTrack::set_step_editing (bool yn)
631 if (_session.record_status() != Session::Disabled) {
635 if (yn != _step_editing) {
637 StepEditStatusChange (yn);
642 MidiTrack::set_midi_thru (bool yn)
647 boost::shared_ptr<SMFSource>
648 MidiTrack::write_source (uint32_t)
650 return midi_diskstream()->write_source ();
654 MidiTrack::set_channel_mode (ChannelMode mode, uint16_t mask)
656 midi_diskstream()->set_channel_mode (mode, mask);
660 MidiTrack::get_channel_mode ()
662 return midi_diskstream()->get_channel_mode ();
666 MidiTrack::get_channel_mask ()
668 return midi_diskstream()->get_channel_mask ();
671 boost::shared_ptr<MidiPlaylist>
672 MidiTrack::midi_playlist ()
674 return midi_diskstream()->midi_playlist ();
678 MidiTrack::diskstream_data_recorded (boost::shared_ptr<MidiBuffer> buf, boost::weak_ptr<MidiSource> src)
680 DataRecorded (buf, src); /* EMIT SIGNAL */
684 MidiTrack::should_monitor () const
690 MidiTrack::send_silence () const
696 MidiTrack::input_active () const
698 return _input_active;
702 MidiTrack::set_input_active (bool yn)
704 if (yn != _input_active) {
706 map_input_active (yn);
707 InputActiveChanged (); /* EMIT SIGNAL */
712 MidiTrack::map_input_active (bool yn)
718 PortSet& ports (_input->ports());
720 for (PortSet::iterator p = ports.begin(DataType::MIDI); p != ports.end(DataType::MIDI); ++p) {
721 MidiPort* mp = dynamic_cast<MidiPort*> (&*p);
722 if (yn != mp->input_active()) {
723 mp->set_input_active (yn);
729 MidiTrack::track_input_active (IOChange change, void* /* src */)
731 if (change.type & IOChange::ConfigurationChanged) {
732 map_input_active (_input_active);