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_diskstream (boost::shared_ptr<Diskstream> ds)
90 Track::set_diskstream (ds);
92 _diskstream->set_track (this);
93 _diskstream->set_destructive (_mode == Destructive);
95 _diskstream->set_record_enabled (false);
96 //_diskstream->monitor_input (false);
98 DiskstreamChanged (); /* EMIT SIGNAL */
101 boost::shared_ptr<MidiDiskstream>
102 MidiTrack::midi_diskstream() const
104 return boost::dynamic_pointer_cast<MidiDiskstream>(_diskstream);
108 MidiTrack::set_state (const XMLNode& node, int version)
110 return _set_state (node, version, true);
114 MidiTrack::_set_state (const XMLNode& node, int version, bool call_base)
116 const XMLProperty *prop;
117 XMLNodeConstIterator iter;
119 if (Route::_set_state (node, version, call_base)) {
123 // No destructive MIDI tracks (yet?)
126 if ((prop = node.property (X_("note-mode"))) != 0) {
127 _note_mode = NoteMode (string_2_enum (prop->value(), _note_mode));
129 _note_mode = Sustained;
132 if ((prop = node.property ("midi-thru")) != 0) {
133 set_midi_thru (prop->value() == "yes");
136 if ((prop = node.property ("default-channel")) != 0) {
137 set_default_channel ((uint8_t) atoi (prop->value()));
141 XMLNodeConstIterator niter;
144 nlist = node.children();
145 for (niter = nlist.begin(); niter != nlist.end(); ++niter){
148 if (child->name() == X_("recenable")) {
149 _rec_enable_control->set_state (*child, version);
150 _session.add_controllable (_rec_enable_control);
154 if (version >= 3000) {
155 if ((child = find_named_node (node, X_("Diskstream"))) != 0) {
156 boost::shared_ptr<MidiDiskstream> ds (new MidiDiskstream (_session, *child));
157 ds->do_refill_with_alloc ();
162 pending_state = const_cast<XMLNode*> (&node);
164 if (_session.state_of_the_state() & Session::Loading) {
165 _session.StateReady.connect_same_thread (*this, boost::bind (&MidiTrack::set_state_part_two, this));
167 set_state_part_two ();
174 MidiTrack::state(bool full_state)
176 XMLNode& root (Route::state(full_state));
177 XMLNode* freeze_node;
180 if (_freeze_record.playlist) {
183 freeze_node = new XMLNode (X_("freeze-info"));
184 freeze_node->add_property ("playlist", _freeze_record.playlist->name());
185 freeze_node->add_property ("state", enum_2_string (_freeze_record.state));
187 for (vector<FreezeRecordProcessorInfo*>::iterator i = _freeze_record.processor_info.begin(); i != _freeze_record.processor_info.end(); ++i) {
188 inode = new XMLNode (X_("processor"));
189 (*i)->id.print (buf, sizeof(buf));
190 inode->add_property (X_("id"), buf);
191 inode->add_child_copy ((*i)->state);
193 freeze_node->add_child_nocopy (*inode);
196 root.add_child_nocopy (*freeze_node);
199 root.add_property (X_("note-mode"), enum_2_string (_note_mode));
200 root.add_child_nocopy (_rec_enable_control->get_state());
201 root.add_child_nocopy (_diskstream->get_state ());
203 root.add_property ("step-editing", (_step_editing ? "yes" : "no"));
204 root.add_property ("note-mode", enum_2_string (_note_mode));
205 root.add_property ("midi-thru", (_midi_thru ? "yes" : "no"));
206 snprintf (buf, sizeof (buf), "%d", (int) _default_channel);
207 root.add_property ("default-channel", buf);
213 MidiTrack::set_state_part_two ()
217 LocaleGuard lg (X_("POSIX"));
219 /* This is called after all session state has been restored but before
220 have been made ports and connections are established.
223 if (pending_state == 0) {
227 if ((fnode = find_named_node (*pending_state, X_("freeze-info"))) != 0) {
229 _freeze_record.state = Frozen;
231 for (vector<FreezeRecordProcessorInfo*>::iterator i = _freeze_record.processor_info.begin(); i != _freeze_record.processor_info.end(); ++i) {
234 _freeze_record.processor_info.clear ();
236 if ((prop = fnode->property (X_("playlist"))) != 0) {
237 boost::shared_ptr<Playlist> pl = _session.playlists->by_name (prop->value());
239 _freeze_record.playlist = boost::dynamic_pointer_cast<MidiPlaylist> (pl);
241 _freeze_record.playlist.reset();
242 _freeze_record.state = NoFreeze;
247 if ((prop = fnode->property (X_("state"))) != 0) {
248 _freeze_record.state = FreezeState (string_2_enum (prop->value(), _freeze_record.state));
251 XMLNodeConstIterator citer;
252 XMLNodeList clist = fnode->children();
254 for (citer = clist.begin(); citer != clist.end(); ++citer) {
255 if ((*citer)->name() != X_("processor")) {
259 if ((prop = (*citer)->property (X_("id"))) == 0) {
263 FreezeRecordProcessorInfo* frii = new FreezeRecordProcessorInfo (*((*citer)->children().front()),
264 boost::shared_ptr<Processor>());
265 frii->id = prop->value ();
266 _freeze_record.processor_info.push_back (frii);
270 if ((fnode = find_named_node (*pending_state, X_("Diskstream"))) != 0) {
271 boost::shared_ptr<MidiDiskstream> ds (new MidiDiskstream (_session, *fnode));
272 ds->do_refill_with_alloc ();
273 ds->set_block_size (_session.get_block_size ());
281 MidiTrack::roll (nframes_t nframes, framepos_t start_frame, framepos_t end_frame, int declick,
282 bool can_record, bool rec_monitors_input, bool& needs_butler)
284 Glib::RWLock::ReaderLock lm (_processor_lock, Glib::TRY_LOCK);
290 boost::shared_ptr<MidiDiskstream> diskstream = midi_diskstream();
292 automation_snapshot (start_frame);
294 if (n_outputs().n_total() == 0 && _processors.empty()) {
303 nframes_t transport_frame = _session.transport_frame();
306 if ((nframes = check_initial_delay (nframes, transport_frame)) == 0) {
307 /* need to do this so that the diskstream sets its
308 playback distance to zero, thus causing diskstream::commit
311 return diskstream->process (transport_frame, 0, can_record, rec_monitors_input, needs_butler);
316 if ((dret = diskstream->process (transport_frame, nframes, can_record, rec_monitors_input, needs_butler)) != 0) {
321 /* special condition applies */
323 if (_meter_point == MeterInput) {
324 _input->process_input (_meter, start_frame, end_frame, nframes);
327 if (diskstream->record_enabled() && !can_record && !_session.config.get_auto_input()) {
329 /* not actually recording, but we want to hear the input material anyway,
330 at least potentially (depending on monitoring options)
333 passthru (start_frame, end_frame, nframes, 0);
337 XXX is it true that the earlier test on n_outputs()
338 means that we can avoid checking it again here? i think
339 so, because changing the i/o configuration of an IO
340 requires holding the AudioEngine lock, which we hold
341 while in the process() tree.
345 /* copy the diskstream data to all output buffers */
347 //const size_t limit = n_process_buffers().n_audio();
348 BufferSet& bufs = _session.get_scratch_buffers (n_process_buffers());
349 MidiBuffer& mbuf (bufs.get_midi (0));
351 diskstream->get_playback (mbuf, start_frame, end_frame);
353 /* append immediate messages to the first MIDI buffer (thus sending it to the first output port) */
355 write_out_of_band_data (bufs, start_frame, end_frame, nframes);
357 process_output_buffers (bufs, start_frame, end_frame, nframes,
358 (!_session.get_record_enabled() || !Config->get_do_not_record_plugins()), declick);
362 _main_outs->flush (nframes, end_frame - start_frame - 1);
368 MidiTrack::no_roll (nframes_t nframes, sframes_t start_frame, sframes_t end_frame,
369 bool state_changing, bool can_record, bool rec_monitors_input)
371 int ret = Track::no_roll (nframes, start_frame, end_frame, state_changing, can_record, rec_monitors_input);
373 if (ret == 0 && _diskstream->record_enabled() && _step_editing) {
374 push_midi_input_to_step_edit_ringbuffer (nframes);
381 MidiTrack::handle_transport_stopped (bool abort, bool did_locate, bool flush_processors)
384 _main_outs->transport_stopped ();
385 Route::handle_transport_stopped (abort, did_locate, flush_processors);
390 MidiTrack::push_midi_input_to_step_edit_ringbuffer (nframes_t nframes)
392 PortSet& ports (_input->ports());
394 for (PortSet::iterator p = ports.begin(DataType::MIDI); p != ports.end(DataType::MIDI); ++p) {
396 Buffer& b (p->get_buffer (nframes));
397 const MidiBuffer* const mb = dynamic_cast<MidiBuffer*>(&b);
400 for (MidiBuffer::const_iterator e = mb->begin(); e != mb->end(); ++e) {
402 const Evoral::MIDIEvent<nframes_t> ev(*e, false);
404 /* we don't care about the time for this purpose */
406 _step_edit_ring_buffer.write (0, ev.type(), ev.size(), ev.buffer());
412 MidiTrack::write_out_of_band_data (BufferSet& bufs, sframes_t /*start*/, sframes_t /*end*/, nframes_t nframes)
414 // Append immediate events
415 MidiBuffer& buf (bufs.get_midi (0));
416 if (_immediate_events.read_space()) {
417 DEBUG_TRACE (DEBUG::MidiIO, string_compose ("%1 has %2 of immediate events to deliver\n",
418 name(), _immediate_events.read_space()));
420 _immediate_events.read (buf, 0, 1, nframes-1); // all stamps = 0
422 // MIDI thru: send incoming data "through" output
423 if (_midi_thru && _session.transport_speed() != 0.0f && _input->n_ports().n_midi()) {
424 buf.merge_in_place (_input->midi(0)->get_midi_buffer(nframes));
429 MidiTrack::export_stuff (BufferSet& /*bufs*/, nframes_t /*nframes*/, sframes_t /*end_frame*/)
435 MidiTrack::set_latency_delay (nframes_t longest_session_latency)
437 Route::set_latency_delay (longest_session_latency);
438 _diskstream->set_roll_delay (_roll_delay);
441 boost::shared_ptr<Region>
442 MidiTrack::bounce (InterThreadInfo& /*itt*/)
445 // vector<MidiSource*> srcs;
446 // return _session.write_one_track (*this, 0, _session.current_end_frame(), false, srcs, itt);
447 return boost::shared_ptr<Region> ();
451 boost::shared_ptr<Region>
452 MidiTrack::bounce_range (nframes_t /*start*/, nframes_t /*end*/, InterThreadInfo& /*itt*/, bool /*enable_processing*/)
455 //vector<MidiSource*> srcs;
456 //return _session.write_one_track (*this, start, end, false, srcs, itt);
457 return boost::shared_ptr<Region> ();
461 MidiTrack::freeze_me (InterThreadInfo& /*itt*/)
466 MidiTrack::unfreeze ()
468 _freeze_record.state = UnFrozen;
469 FreezeChange (); /* EMIT SIGNAL */
473 MidiTrack::set_note_mode (NoteMode m)
476 midi_diskstream()->set_note_mode(m);
480 MidiTrack::midi_panic()
482 DEBUG_TRACE (DEBUG::MidiIO, string_compose ("%1 delivers panic data\n", name()));
483 for (uint8_t channel = 0; channel <= 0xF; channel++) {
484 uint8_t ev[3] = { MIDI_CMD_CONTROL | channel, MIDI_CTL_SUSTAIN, 0 };
485 write_immediate_event(3, ev);
486 ev[1] = MIDI_CTL_ALL_NOTES_OFF;
487 write_immediate_event(3, ev);
488 ev[1] = MIDI_CTL_RESET_CONTROLLERS;
489 write_immediate_event(3, ev);
493 /** \return true on success, false on failure (no buffer space left)
496 MidiTrack::write_immediate_event(size_t size, const uint8_t* buf)
498 if (!Evoral::midi_event_is_valid(buf, size)) {
499 cerr << "WARNING: Ignoring illegal immediate MIDI event" << endl;
502 const uint32_t type = EventTypeMap::instance().midi_event_type(buf[0]);
503 return (_immediate_events.write(0, type, size, buf) == size);
507 MidiTrack::MidiControl::set_value(float val)
511 cerr << "MIDIControl value is infinity" << endl;
512 } else if (isnan(val)) {
513 cerr << "MIDIControl value is NaN" << endl;
514 } else if (val < _list->parameter().min()) {
515 cerr << "MIDIControl value is < " << _list->parameter().min() << endl;
516 } else if (val > _list->parameter().max()) {
517 cerr << "MIDIControl value is > " << _list->parameter().max() << endl;
526 assert(val <= _list->parameter().max());
527 if ( ! automation_playback()) {
529 uint8_t ev[3] = { _list->parameter().channel(), int(val), 0 };
530 switch(_list->parameter().type()) {
531 case MidiCCAutomation:
532 ev[0] += MIDI_CMD_CONTROL;
533 ev[1] = _list->parameter().id();
537 case MidiPgmChangeAutomation:
539 ev[0] += MIDI_CMD_PGM_CHANGE;
543 case MidiChannelPressureAutomation:
545 ev[0] += MIDI_CMD_CHANNEL_PRESSURE;
549 case MidiPitchBenderAutomation:
550 ev[0] += MIDI_CMD_BENDER;
551 ev[1] = 0x7F & int(val);
552 ev[2] = 0x7F & (int(val) >> 7);
558 _route->write_immediate_event(size, ev);
561 AutomationControl::set_value(val);
565 MidiTrack::set_step_editing (bool yn)
571 MidiTrack::set_default_channel (uint8_t chn)
573 _default_channel = std::min ((unsigned int) chn, 15U);
577 MidiTrack::set_midi_thru (bool yn)
582 boost::shared_ptr<SMFSource>
583 MidiTrack::write_source (uint32_t n)
585 return midi_diskstream()->write_source ();
589 MidiTrack::set_channel_mode (ChannelMode mode, uint16_t mask)
591 midi_diskstream()->set_channel_mode (mode, mask);
595 MidiTrack::get_channel_mode ()
597 return midi_diskstream()->get_channel_mode ();
601 MidiTrack::get_channel_mask ()
603 return midi_diskstream()->get_channel_mask ();
606 boost::shared_ptr<MidiPlaylist>
607 MidiTrack::midi_playlist ()
609 return midi_diskstream()->midi_playlist ();