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"
21 #include "pbd/enumwriter.h"
22 #include "pbd/convert.h"
23 #include "midi++/events.h"
24 #include "evoral/midi_util.h"
26 #include "ardour/amp.h"
27 #include "ardour/buffer_set.h"
28 #include "ardour/debug.h"
29 #include "ardour/delivery.h"
30 #include "ardour/io_processor.h"
31 #include "ardour/meter.h"
32 #include "ardour/midi_diskstream.h"
33 #include "ardour/midi_playlist.h"
34 #include "ardour/midi_port.h"
35 #include "ardour/midi_region.h"
36 #include "ardour/midi_source.h"
37 #include "ardour/midi_track.h"
38 #include "ardour/panner.h"
39 #include "ardour/port.h"
40 #include "ardour/processor.h"
41 #include "ardour/route_group_specialized.h"
42 #include "ardour/session.h"
43 #include "ardour/session_playlists.h"
44 #include "ardour/utils.h"
49 using namespace ARDOUR;
52 MidiTrack::MidiTrack (Session& sess, string name, Route::Flag flag, TrackMode mode)
53 : Track (sess, name, flag, mode, DataType::MIDI)
54 , _immediate_events(1024) // FIXME: size?
55 , _step_edit_ring_buffer(64) // FIXME: size?
56 , _note_mode(Sustained)
57 , _step_editing (false)
58 , _default_channel (0)
63 MidiTrack::~MidiTrack ()
68 MidiTrack::use_new_diskstream ()
70 MidiDiskstream::Flag dflags = MidiDiskstream::Flag (0);
72 if (_flags & Hidden) {
73 dflags = MidiDiskstream::Flag (dflags | MidiDiskstream::Hidden);
75 dflags = MidiDiskstream::Flag (dflags | MidiDiskstream::Recordable);
78 assert(_mode != Destructive);
80 boost::shared_ptr<MidiDiskstream> ds (new MidiDiskstream (_session, name(), dflags));
81 ds->do_refill_with_alloc ();
82 ds->set_block_size (_session.get_block_size ());
88 MidiTrack::set_record_enabled (bool yn, void *src)
94 Track::set_record_enabled (yn, src);
98 MidiTrack::set_diskstream (boost::shared_ptr<Diskstream> ds)
100 Track::set_diskstream (ds);
102 _diskstream->set_track (this);
103 _diskstream->set_destructive (_mode == Destructive);
105 _diskstream->set_record_enabled (false);
106 //_diskstream->monitor_input (false);
108 _diskstream_data_recorded_connection.disconnect ();
109 boost::shared_ptr<MidiDiskstream> mds = boost::dynamic_pointer_cast<MidiDiskstream> (ds);
110 mds->DataRecorded.connect_same_thread (_diskstream_data_recorded_connection, boost::bind (&MidiTrack::diskstream_data_recorded, this, _1, _2));
112 DiskstreamChanged (); /* EMIT SIGNAL */
115 boost::shared_ptr<MidiDiskstream>
116 MidiTrack::midi_diskstream() const
118 return boost::dynamic_pointer_cast<MidiDiskstream>(_diskstream);
122 MidiTrack::set_state (const XMLNode& node, int version)
124 return _set_state (node, version, true);
128 MidiTrack::_set_state (const XMLNode& node, int version, bool call_base)
130 const XMLProperty *prop;
131 XMLNodeConstIterator iter;
133 if (Route::_set_state (node, version, call_base)) {
137 // No destructive MIDI tracks (yet?)
140 if ((prop = node.property (X_("note-mode"))) != 0) {
141 _note_mode = NoteMode (string_2_enum (prop->value(), _note_mode));
143 _note_mode = Sustained;
146 if ((prop = node.property ("midi-thru")) != 0) {
147 set_midi_thru (prop->value() == "yes");
150 if ((prop = node.property ("default-channel")) != 0) {
151 set_default_channel ((uint8_t) atoi (prop->value()));
155 XMLNodeConstIterator niter;
158 nlist = node.children();
160 if (version >= 3000) {
161 if ((child = find_named_node (node, X_("Diskstream"))) != 0) {
162 boost::shared_ptr<MidiDiskstream> ds (new MidiDiskstream (_session, *child));
163 ds->do_refill_with_alloc ();
168 /* set rec-enable control *AFTER* setting up diskstream, because it may want to operate
169 on the diskstream as it sets its own state
172 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
175 if (child->name() == Controllable::xml_node_name && (prop = child->property ("name")) != 0) {
176 if (prop->value() == X_("recenable")) {
177 _rec_enable_control->set_state (*child, version);
182 pending_state = const_cast<XMLNode*> (&node);
184 if (_session.state_of_the_state() & Session::Loading) {
185 _session.StateReady.connect_same_thread (*this, boost::bind (&MidiTrack::set_state_part_two, this));
187 set_state_part_two ();
194 MidiTrack::state(bool full_state)
196 XMLNode& root (Route::state(full_state));
197 XMLNode* freeze_node;
200 if (_freeze_record.playlist) {
203 freeze_node = new XMLNode (X_("freeze-info"));
204 freeze_node->add_property ("playlist", _freeze_record.playlist->name());
205 freeze_node->add_property ("state", enum_2_string (_freeze_record.state));
207 for (vector<FreezeRecordProcessorInfo*>::iterator i = _freeze_record.processor_info.begin(); i != _freeze_record.processor_info.end(); ++i) {
208 inode = new XMLNode (X_("processor"));
209 (*i)->id.print (buf, sizeof(buf));
210 inode->add_property (X_("id"), buf);
211 inode->add_child_copy ((*i)->state);
213 freeze_node->add_child_nocopy (*inode);
216 root.add_child_nocopy (*freeze_node);
219 root.add_property (X_("note-mode"), enum_2_string (_note_mode));
220 root.add_child_nocopy (_rec_enable_control->get_state());
221 root.add_child_nocopy (_diskstream->get_state ());
223 root.add_property ("step-editing", (_step_editing ? "yes" : "no"));
224 root.add_property ("note-mode", enum_2_string (_note_mode));
225 root.add_property ("midi-thru", (_midi_thru ? "yes" : "no"));
226 snprintf (buf, sizeof (buf), "%d", (int) _default_channel);
227 root.add_property ("default-channel", buf);
233 MidiTrack::set_state_part_two ()
237 LocaleGuard lg (X_("POSIX"));
239 /* This is called after all session state has been restored but before
240 have been made ports and connections are established.
243 if (pending_state == 0) {
247 if ((fnode = find_named_node (*pending_state, X_("freeze-info"))) != 0) {
249 _freeze_record.state = Frozen;
251 for (vector<FreezeRecordProcessorInfo*>::iterator i = _freeze_record.processor_info.begin(); i != _freeze_record.processor_info.end(); ++i) {
254 _freeze_record.processor_info.clear ();
256 if ((prop = fnode->property (X_("playlist"))) != 0) {
257 boost::shared_ptr<Playlist> pl = _session.playlists->by_name (prop->value());
259 _freeze_record.playlist = boost::dynamic_pointer_cast<MidiPlaylist> (pl);
261 _freeze_record.playlist.reset();
262 _freeze_record.state = NoFreeze;
267 if ((prop = fnode->property (X_("state"))) != 0) {
268 _freeze_record.state = FreezeState (string_2_enum (prop->value(), _freeze_record.state));
271 XMLNodeConstIterator citer;
272 XMLNodeList clist = fnode->children();
274 for (citer = clist.begin(); citer != clist.end(); ++citer) {
275 if ((*citer)->name() != X_("processor")) {
279 if ((prop = (*citer)->property (X_("id"))) == 0) {
283 FreezeRecordProcessorInfo* frii = new FreezeRecordProcessorInfo (*((*citer)->children().front()),
284 boost::shared_ptr<Processor>());
285 frii->id = prop->value ();
286 _freeze_record.processor_info.push_back (frii);
290 if ((fnode = find_named_node (*pending_state, X_("Diskstream"))) != 0) {
291 boost::shared_ptr<MidiDiskstream> ds (new MidiDiskstream (_session, *fnode));
292 ds->do_refill_with_alloc ();
293 ds->set_block_size (_session.get_block_size ());
301 MidiTrack::roll (nframes_t nframes, framepos_t start_frame, framepos_t end_frame, int declick,
302 bool can_record, bool rec_monitors_input, bool& needs_butler)
304 Glib::RWLock::ReaderLock lm (_processor_lock, Glib::TRY_LOCK);
310 boost::shared_ptr<MidiDiskstream> diskstream = midi_diskstream();
312 automation_snapshot (start_frame);
314 if (n_outputs().n_total() == 0 && _processors.empty()) {
323 nframes_t transport_frame = _session.transport_frame();
326 if ((nframes = check_initial_delay (nframes, transport_frame)) == 0) {
327 /* need to do this so that the diskstream sets its
328 playback distance to zero, thus causing diskstream::commit
331 return diskstream->process (transport_frame, 0, can_record, rec_monitors_input, needs_butler);
336 if ((dret = diskstream->process (transport_frame, nframes, can_record, rec_monitors_input, needs_butler)) != 0) {
341 /* special condition applies */
343 if (_meter_point == MeterInput) {
344 _input->process_input (_meter, start_frame, end_frame, nframes);
347 if (diskstream->record_enabled() && !can_record && !_session.config.get_auto_input()) {
349 /* not actually recording, but we want to hear the input material anyway,
350 at least potentially (depending on monitoring options)
353 passthru (start_frame, end_frame, nframes, 0);
357 XXX is it true that the earlier test on n_outputs()
358 means that we can avoid checking it again here? i think
359 so, because changing the i/o configuration of an IO
360 requires holding the AudioEngine lock, which we hold
361 while in the process() tree.
365 /* copy the diskstream data to all output buffers */
367 //const size_t limit = n_process_buffers().n_audio();
368 BufferSet& bufs = _session.get_scratch_buffers (n_process_buffers());
369 MidiBuffer& mbuf (bufs.get_midi (0));
371 /* we are a MIDI track, so we always start the chain with a single-channel diskstream */
377 diskstream->get_playback (mbuf, start_frame, end_frame);
379 /* append immediate messages to the first MIDI buffer (thus sending it to the first output port) */
381 write_out_of_band_data (bufs, start_frame, end_frame, nframes);
383 process_output_buffers (bufs, start_frame, end_frame, nframes,
384 (!_session.get_record_enabled() || !Config->get_do_not_record_plugins()), declick);
388 _main_outs->flush_buffers (nframes, end_frame - start_frame - 1);
394 MidiTrack::no_roll (nframes_t nframes, framepos_t start_frame, framepos_t end_frame,
395 bool state_changing, bool can_record, bool rec_monitors_input)
397 int ret = Track::no_roll (nframes, start_frame, end_frame, state_changing, can_record, rec_monitors_input);
399 if (ret == 0 && _step_editing) {
400 push_midi_input_to_step_edit_ringbuffer (nframes);
407 MidiTrack::handle_transport_stopped (bool abort, bool did_locate, bool flush_processors)
409 Route::handle_transport_stopped (abort, did_locate, flush_processors);
413 MidiTrack::push_midi_input_to_step_edit_ringbuffer (nframes_t nframes)
415 PortSet& ports (_input->ports());
417 for (PortSet::iterator p = ports.begin(DataType::MIDI); p != ports.end(DataType::MIDI); ++p) {
419 Buffer& b (p->get_buffer (nframes));
420 const MidiBuffer* const mb = dynamic_cast<MidiBuffer*>(&b);
423 for (MidiBuffer::const_iterator e = mb->begin(); e != mb->end(); ++e) {
425 const Evoral::MIDIEvent<nframes_t> ev(*e, false);
427 /* note on, since for step edit, note length is determined
431 if (ev.is_note_on()) {
432 /* we don't care about the time for this purpose */
433 _step_edit_ring_buffer.write (0, ev.type(), ev.size(), ev.buffer());
440 MidiTrack::write_out_of_band_data (BufferSet& bufs, framepos_t /*start*/, framepos_t /*end*/, nframes_t nframes)
442 // Append immediate events
443 MidiBuffer& buf (bufs.get_midi (0));
444 if (_immediate_events.read_space()) {
445 DEBUG_TRACE (DEBUG::MidiIO, string_compose ("%1 has %2 of immediate events to deliver\n",
446 name(), _immediate_events.read_space()));
448 _immediate_events.read (buf, 0, 1, nframes-1); // all stamps = 0
450 // MIDI thru: send incoming data "through" output
451 if (_midi_thru && _session.transport_speed() != 0.0f && _input->n_ports().n_midi()) {
452 buf.merge_in_place (_input->midi(0)->get_midi_buffer(nframes));
457 MidiTrack::export_stuff (BufferSet& /*bufs*/, nframes_t /*nframes*/, framepos_t /*end_frame*/)
463 MidiTrack::set_latency_delay (nframes_t longest_session_latency)
465 Route::set_latency_delay (longest_session_latency);
466 _diskstream->set_roll_delay (_roll_delay);
469 boost::shared_ptr<Region>
470 MidiTrack::bounce (InterThreadInfo& /*itt*/)
473 // vector<MidiSource*> srcs;
474 // return _session.write_one_track (*this, 0, _session.current_end_frame(), false, srcs, itt);
475 return boost::shared_ptr<Region> ();
479 boost::shared_ptr<Region>
480 MidiTrack::bounce_range (nframes_t /*start*/, nframes_t /*end*/, InterThreadInfo& /*itt*/, bool /*enable_processing*/)
483 //vector<MidiSource*> srcs;
484 //return _session.write_one_track (*this, start, end, false, srcs, itt);
485 return boost::shared_ptr<Region> ();
489 MidiTrack::freeze_me (InterThreadInfo& /*itt*/)
494 MidiTrack::unfreeze ()
496 _freeze_record.state = UnFrozen;
497 FreezeChange (); /* EMIT SIGNAL */
501 MidiTrack::set_note_mode (NoteMode m)
504 midi_diskstream()->set_note_mode(m);
508 MidiTrack::midi_panic()
510 DEBUG_TRACE (DEBUG::MidiIO, string_compose ("%1 delivers panic data\n", name()));
511 for (uint8_t channel = 0; channel <= 0xF; channel++) {
512 uint8_t ev[3] = { MIDI_CMD_CONTROL | channel, MIDI_CTL_SUSTAIN, 0 };
513 write_immediate_event(3, ev);
514 ev[1] = MIDI_CTL_ALL_NOTES_OFF;
515 write_immediate_event(3, ev);
516 ev[1] = MIDI_CTL_RESET_CONTROLLERS;
517 write_immediate_event(3, ev);
521 /** \return true on success, false on failure (no buffer space left)
524 MidiTrack::write_immediate_event(size_t size, const uint8_t* buf)
526 if (!Evoral::midi_event_is_valid(buf, size)) {
527 cerr << "WARNING: Ignoring illegal immediate MIDI event" << endl;
530 const uint32_t type = EventTypeMap::instance().midi_event_type(buf[0]);
531 return (_immediate_events.write(0, type, size, buf) == size);
535 MidiTrack::MidiControl::set_value(double val)
539 cerr << "MIDIControl value is infinity" << endl;
540 } else if (isnan(val)) {
541 cerr << "MIDIControl value is NaN" << endl;
542 } else if (val < _list->parameter().min()) {
543 cerr << "MIDIControl value is < " << _list->parameter().min() << endl;
544 } else if (val > _list->parameter().max()) {
545 cerr << "MIDIControl value is > " << _list->parameter().max() << endl;
554 assert(val <= _list->parameter().max());
555 if ( ! automation_playback()) {
557 uint8_t ev[3] = { _list->parameter().channel(), int(val), 0 };
558 switch(_list->parameter().type()) {
559 case MidiCCAutomation:
560 ev[0] += MIDI_CMD_CONTROL;
561 ev[1] = _list->parameter().id();
565 case MidiPgmChangeAutomation:
567 ev[0] += MIDI_CMD_PGM_CHANGE;
571 case MidiChannelPressureAutomation:
573 ev[0] += MIDI_CMD_CHANNEL_PRESSURE;
577 case MidiPitchBenderAutomation:
578 ev[0] += MIDI_CMD_BENDER;
579 ev[1] = 0x7F & int(val);
580 ev[2] = 0x7F & (int(val) >> 7);
586 _route->write_immediate_event(size, ev);
589 AutomationControl::set_value(val);
593 MidiTrack::set_step_editing (bool yn)
595 if (_session.record_status() != Session::Disabled) {
599 if (yn != _step_editing) {
601 StepEditStatusChange (yn);
606 MidiTrack::set_default_channel (uint8_t chn)
608 _default_channel = std::min ((unsigned int) chn, 15U);
612 MidiTrack::set_midi_thru (bool yn)
617 boost::shared_ptr<SMFSource>
618 MidiTrack::write_source (uint32_t)
620 return midi_diskstream()->write_source ();
624 MidiTrack::set_channel_mode (ChannelMode mode, uint16_t mask)
626 midi_diskstream()->set_channel_mode (mode, mask);
630 MidiTrack::get_channel_mode ()
632 return midi_diskstream()->get_channel_mode ();
636 MidiTrack::get_channel_mask ()
638 return midi_diskstream()->get_channel_mask ();
641 boost::shared_ptr<MidiPlaylist>
642 MidiTrack::midi_playlist ()
644 return midi_diskstream()->midi_playlist ();
648 MidiTrack::diskstream_data_recorded (boost::shared_ptr<MidiBuffer> buf, boost::weak_ptr<MidiSource> src)
650 DataRecorded (buf, src); /* EMIT SIGNAL */