Little MidiEvent prettification additions, ifdef'd non-realtime aspects (for future...
[ardour.git] / libs / ardour / midi_track.cc
1 /*
2     Copyright (C) 2006 Paul Davis 
3         By Dave Robillard, 2006
4
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.
9
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.
14
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.
18 */
19 #include <pbd/error.h>
20 #include <sigc++/retype.h>
21 #include <sigc++/retype_return.h>
22 #include <sigc++/bind.h>
23
24 #include <pbd/enumwriter.h>
25
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>
40
41 #include "i18n.h"
42
43 using namespace std;
44 using namespace ARDOUR;
45 using namespace PBD;
46
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?
50 {
51         MidiDiskstream::Flag dflags = MidiDiskstream::Flag (0);
52
53         if (_flags & Hidden) {
54                 dflags = MidiDiskstream::Flag (dflags | MidiDiskstream::Hidden);
55         } else {
56                 dflags = MidiDiskstream::Flag (dflags | MidiDiskstream::Recordable);
57         }
58
59         assert(mode != Destructive);
60
61         boost::shared_ptr<MidiDiskstream> ds (new MidiDiskstream (_session, name, dflags));
62         _session.add_diskstream (ds);
63
64         set_diskstream (boost::dynamic_pointer_cast<MidiDiskstream> (ds));
65         
66         _declickable = true;
67         _freeze_record.state = NoFreeze;
68         _saved_meter_point = _meter_point;
69         _mode = mode;
70
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));
75
76         MoreChannels(ChanCount(DataType::MIDI, 2)); /* EMIT SIGNAL */
77 }
78
79 MidiTrack::MidiTrack (Session& sess, const XMLNode& node)
80         : Track (sess, node)
81         , _immediate_events(1024) // FIXME: size?
82 {
83         _set_state(node, false);
84         
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));
89         
90         MoreChannels(ChanCount(DataType::MIDI, 2)); /* EMIT SIGNAL */
91 }
92
93 MidiTrack::~MidiTrack ()
94 {
95 }
96
97
98 int
99 MidiTrack::set_diskstream (boost::shared_ptr<MidiDiskstream> ds)
100 {
101         _diskstream = ds;
102         _diskstream->set_io (*this);
103         _diskstream->set_destructive (_mode == Destructive);
104
105         _diskstream->set_record_enabled (false);
106         //_diskstream->monitor_input (false);
107
108         ic_connection.disconnect();
109         ic_connection = input_changed.connect (mem_fun (*_diskstream, &MidiDiskstream::handle_input_change));
110
111         DiskstreamChanged (); /* EMIT SIGNAL */
112
113         return 0;
114 }       
115
116 int 
117 MidiTrack::use_diskstream (string name)
118 {
119         boost::shared_ptr<MidiDiskstream> dstream;
120
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;
123                 return -1;
124         }
125         
126         return set_diskstream (dstream);
127 }
128
129 int 
130 MidiTrack::use_diskstream (const PBD::ID& id)
131 {
132         boost::shared_ptr<MidiDiskstream> dstream;
133
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;
136                 return -1;
137         }
138         
139         return set_diskstream (dstream);
140 }
141
142 boost::shared_ptr<MidiDiskstream>
143 MidiTrack::midi_diskstream() const
144 {
145         return boost::dynamic_pointer_cast<MidiDiskstream>(_diskstream);
146 }
147
148 int
149 MidiTrack::set_state (const XMLNode& node)
150 {
151         return _set_state (node, true);
152 }
153
154 int
155 MidiTrack::_set_state (const XMLNode& node, bool call_base)
156 {
157         const XMLProperty *prop;
158         XMLNodeConstIterator iter;
159
160         if (Route::_set_state (node, call_base)) {
161                 return -1;
162         }
163         
164         // No destructive MIDI tracks (yet?)
165         _mode = Normal;
166         
167         if ((prop = node.property (X_("note-mode"))) != 0) {
168                 _note_mode = NoteMode (string_2_enum (prop->value(), _note_mode));
169         } else {
170                 _note_mode = Sustained;
171         }
172
173         if ((prop = node.property ("diskstream-id")) == 0) {
174                 
175                 /* some old sessions use the diskstream name rather than the ID */
176
177                 if ((prop = node.property ("diskstream")) == 0) {
178                         fatal << _("programming error: MidiTrack given state without diskstream!") << endmsg;
179                         /*NOTREACHED*/
180                         return -1;
181                 }
182
183                 if (use_diskstream (prop->value())) {
184                         return -1;
185                 }
186
187         } else {
188                 
189                 PBD::ID id (prop->value());
190                 
191                 if (use_diskstream (id)) {
192                         return -1;
193                 }
194         }
195
196
197         XMLNodeList nlist;
198         XMLNodeConstIterator niter;
199         XMLNode *child;
200
201         nlist = node.children();
202         for (niter = nlist.begin(); niter != nlist.end(); ++niter){
203                 child = *niter;
204
205                 if (child->name() == X_("recenable")) {
206                         _rec_enable_control->set_state (*child);
207                         _session.add_controllable (_rec_enable_control);
208                 }
209         }
210
211         pending_state = const_cast<XMLNode*> (&node);
212
213         _session.StateReady.connect (mem_fun (*this, &MidiTrack::set_state_part_two));
214
215         return 0;
216 }
217
218 XMLNode& 
219 MidiTrack::state(bool full_state)
220 {
221         XMLNode& root (Route::state(full_state));
222         XMLNode* freeze_node;
223         char buf[64];
224
225         if (_freeze_record.playlist) {
226                 XMLNode* inode;
227
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));
231
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);
237                 
238                         freeze_node->add_child_nocopy (*inode);
239                 }
240
241                 root.add_child_nocopy (*freeze_node);
242         }
243
244         /* Alignment: act as a proxy for the diskstream */
245         
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);
250
251         root.add_property (X_("note-mode"), enum_2_string (_note_mode));
252         
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
256            diskstream.
257         */
258
259         _diskstream->id().print (buf, sizeof(buf));
260         root.add_property ("diskstream-id", buf);
261         
262         root.add_child_nocopy (_rec_enable_control->get_state());
263
264         return root;
265 }
266
267 void
268 MidiTrack::set_state_part_two ()
269 {
270         XMLNode* fnode;
271         XMLProperty* prop;
272         LocaleGuard lg (X_("POSIX"));
273
274         /* This is called after all session state has been restored but before
275            have been made ports and connections are established.
276         */
277
278         if (pending_state == 0) {
279                 return;
280         }
281
282         if ((fnode = find_named_node (*pending_state, X_("freeze-info"))) != 0) {
283
284                 
285                 _freeze_record.have_mementos = false;
286                 _freeze_record.state = Frozen;
287                 
288                 for (vector<FreezeRecordProcessorInfo*>::iterator i = _freeze_record.processor_info.begin(); i != _freeze_record.processor_info.end(); ++i) {
289                         delete *i;
290                 }
291                 _freeze_record.processor_info.clear ();
292                 
293                 if ((prop = fnode->property (X_("playlist"))) != 0) {
294                         boost::shared_ptr<Playlist> pl = _session.playlist_by_name (prop->value());
295                         if (pl) {
296                                 _freeze_record.playlist = boost::dynamic_pointer_cast<MidiPlaylist> (pl);
297                         } else {
298                                 _freeze_record.playlist.reset();
299                                 _freeze_record.state = NoFreeze;
300                         return;
301                         }
302                 }
303                 
304                 if ((prop = fnode->property (X_("state"))) != 0) {
305                         _freeze_record.state = FreezeState (string_2_enum (prop->value(), _freeze_record.state));
306                 }
307                 
308                 XMLNodeConstIterator citer;
309                 XMLNodeList clist = fnode->children();
310                 
311                 for (citer = clist.begin(); citer != clist.end(); ++citer) {
312                         if ((*citer)->name() != X_("processor")) {
313                                 continue;
314                         }
315                         
316                         if ((prop = (*citer)->property (X_("id"))) == 0) {
317                                 continue;
318                         }
319                         
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);
324                 }
325         }
326
327         /* Alignment: act as a proxy for the diskstream */
328
329         if ((fnode = find_named_node (*pending_state, X_("alignment"))) != 0) {
330
331                 if ((prop = fnode->property (X_("style"))) != 0) {
332
333                         /* fix for older sessions from before EnumWriter */
334
335                         string pstr;
336
337                         if (prop->value() == "capture") {
338                                 pstr = "CaptureTime";
339                         } else if (prop->value() == "existing") {
340                                 pstr = "ExistingMaterial";
341                         } else {
342                                 pstr = prop->value();
343                         }
344
345                         AlignStyle as = AlignStyle (string_2_enum (pstr, as));
346                         _diskstream->set_persistent_align_style (as);
347                 }
348         }
349         return;
350 }       
351
352 int 
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)
355 {
356         if (n_outputs().n_midi() == 0) {
357                 //return 0;
358                 throw; // FIXME
359         }
360
361         if (!_active) {
362                 silence (nframes, offset);
363                 //return 0; // FIXME
364         }
365
366         if (session_state_changing) {
367
368                 /* XXX is this safe to do against transport state changes? */
369
370                 passthru_silence (start_frame, end_frame, nframes, offset, 0, false);
371                 return 0;
372         }
373
374         midi_diskstream()->check_record_status (start_frame, nframes, can_record);
375
376         bool send_silence;
377         
378         if (_have_internal_generator) {
379                 /* since the instrument has no input streams,
380                    there is no reason to send any signal
381                    into the route.
382                 */
383                 send_silence = true;
384         } else {
385
386                 if (Config->get_auto_input()) {
387                         if (Config->get_monitoring_model() == SoftwareMonitoring) {
388                                 send_silence = false;
389                         } else {
390                                 send_silence = true;
391                         }
392                 } else {
393                         if (_diskstream->record_enabled()) {
394                                 if (Config->get_monitoring_model() == SoftwareMonitoring) {
395                                         send_silence = false;
396                                 } else {
397                                         send_silence = true;
398                                 }
399                         } else {
400                                 send_silence = true;
401                         }
402                 }
403         }
404
405         apply_gain_automation = false;
406
407         if (send_silence) {
408                 
409                 /* if we're sending silence, but we want the meters to show levels for the signal,
410                    meter right here.
411                 */
412                 
413                 if (_have_internal_generator) {
414                         passthru_silence (start_frame, end_frame, nframes, offset, 0, true);
415                 } else {
416                         if (_meter_point == MeterInput) {
417                                 just_meter_input (start_frame, end_frame, nframes, offset);
418                         }
419                         passthru_silence (start_frame, end_frame, nframes, offset, 0, false);
420                 }
421
422         } else {
423         
424                 /* we're sending signal, but we may still want to meter the input. 
425                  */
426
427                 passthru (start_frame, end_frame, nframes, offset, 0, (_meter_point == MeterInput));
428         }
429
430         return 0;
431 }
432
433 int
434 MidiTrack::roll (nframes_t nframes, nframes_t start_frame, nframes_t end_frame, nframes_t offset, int declick,
435                   bool can_record, bool rec_monitors_input)
436 {
437         int dret;
438         boost::shared_ptr<MidiDiskstream> diskstream = midi_diskstream();
439         
440         {
441                 Glib::RWLock::ReaderLock lm (_processor_lock, Glib::TRY_LOCK);
442                 if (lm.locked()) {
443                         // automation snapshot can also be called from the non-rt context
444                         // and it uses the redirect list, so we take the lock out here
445                         automation_snapshot (start_frame);
446                 }
447         }
448
449         if (n_outputs().n_total() == 0 && _processors.empty()) {
450                 return 0;
451         }
452
453         if (!_active) {
454                 silence (nframes, offset);
455                 return 0;
456         }
457
458         nframes_t transport_frame = _session.transport_frame();
459
460         if ((nframes = check_initial_delay (nframes, offset, transport_frame)) == 0) {
461                 /* need to do this so that the diskstream sets its
462                    playback distance to zero, thus causing diskstream::commit
463                    to do nothing.
464                    */
465                 return diskstream->process (transport_frame, 0, 0, can_record, rec_monitors_input);
466         } 
467
468         _silent = false;
469
470         if ((dret = diskstream->process (transport_frame, nframes, offset, can_record, rec_monitors_input)) != 0) {
471
472                 silence (nframes, offset);
473
474                 return dret;
475         }
476
477         /* special condition applies */
478
479         if (_meter_point == MeterInput) {
480                 just_meter_input (start_frame, end_frame, nframes, offset);
481         }
482
483         if (diskstream->record_enabled() && !can_record && !Config->get_auto_input()) {
484
485                 /* not actually recording, but we want to hear the input material anyway,
486                    at least potentially (depending on monitoring options)
487                    */
488
489                 passthru (start_frame, end_frame, nframes, offset, 0, true);
490
491         } else {
492                 /*
493                    XXX is it true that the earlier test on n_outputs()
494                    means that we can avoid checking it again here? i think
495                    so, because changing the i/o configuration of an IO
496                    requires holding the AudioEngine lock, which we hold
497                    while in the process() tree.
498                    */
499
500
501                 /* copy the diskstream data to all output buffers */
502
503                 //const size_t limit = n_process_buffers().n_audio();
504                 BufferSet& bufs = _session.get_scratch_buffers (n_process_buffers());
505
506                 diskstream->get_playback(bufs.get_midi(0), start_frame, end_frame);
507
508                 process_output_buffers (bufs, start_frame, end_frame, nframes, offset,
509                                 (!_session.get_record_enabled() || !Config->get_do_not_record_plugins()), declick, (_meter_point != MeterInput));
510         
511         }
512
513         return 0;
514 }
515
516 int
517 MidiTrack::silent_roll (nframes_t nframes, nframes_t start_frame, nframes_t end_frame, nframes_t offset, 
518                          bool can_record, bool rec_monitors_input)
519 {
520         if (n_outputs().n_midi() == 0 && _processors.empty()) {
521                 return 0;
522         }
523
524         if (!_active) {
525                 silence (nframes, offset);
526                 return 0;
527         }
528
529         _silent = true;
530         apply_gain_automation = false;
531
532         silence (nframes, offset);
533
534         return midi_diskstream()->process (_session.transport_frame() + offset, nframes, offset, can_record, rec_monitors_input);
535 }
536
537 void
538 MidiTrack::process_output_buffers (BufferSet& bufs,
539                                nframes_t start_frame, nframes_t end_frame, 
540                                nframes_t nframes, nframes_t offset, bool with_processors, int declick,
541                                bool meter)
542 {
543         /* There's no such thing as a MIDI bus for the time being.
544          * We'll do all the MIDI route work here for now, but the long-term goal is to have
545          * Route::process_output_buffers handle everything */
546         
547         if (meter && (_meter_point == MeterInput || _meter_point == MeterPreFader)) {
548                 _meter->run(bufs, start_frame, end_frame, nframes, offset);
549         }
550
551         // Run all processors
552         if (with_processors) {
553                 Glib::RWLock::ReaderLock rm (_processor_lock, Glib::TRY_LOCK);
554                 if (rm.locked()) {
555                         for (ProcessorList::iterator i = _processors.begin(); i != _processors.end(); ++i) {
556                                 (*i)->run_in_place (bufs, start_frame, end_frame, nframes, offset);
557                         }
558                 } 
559         }
560         
561         if (meter && (_meter_point == MeterPostFader)) {
562                 _meter->run(bufs, start_frame, end_frame, nframes, offset);
563         }
564         
565         // Main output stage
566         if (muted()) {
567                 IO::silence(nframes, offset);
568         } else {
569
570                 MidiBuffer& output_buf = bufs.get_midi(0);
571                 write_controller_messages(output_buf, start_frame, end_frame, nframes, offset);
572                 deliver_output(bufs, start_frame, end_frame, nframes, offset);
573         }
574 }
575
576 void
577 MidiTrack::write_controller_messages(MidiBuffer& output_buf, nframes_t start_frame, nframes_t end_frame, 
578                                nframes_t nframes, nframes_t offset)
579 {
580         BufferSet& mix_buffers = _session.get_mix_buffers(ChanCount(DataType::MIDI, 2));
581
582         /* FIXME: this could be more realtimey */
583
584         // Write immediate events (UI controls)
585         MidiBuffer& cc_buf = mix_buffers.get_midi(0);
586         cc_buf.silence(nframes, offset);
587         
588         Byte buf[3]; // CC = 3 bytes
589         buf[0] = MIDI_CMD_CONTROL;
590         MidiEvent ev(0, 3, buf, false);
591
592         // Write controller automation
593         if (_session.transport_rolling()) {
594                 for (Controls::const_iterator i = _controls.begin(); i != _controls.end(); ++i) {
595                         const boost::shared_ptr<AutomationList> list = (*i).second->list();
596
597                         if ( (!list->automation_playback())
598                                         || (list->parameter().type() != MidiCCAutomation))
599                                 continue;
600
601                         double start = start_frame;
602                         double x, y;
603                         while ((*i).second->list()->rt_safe_earliest_event(start, end_frame, x, y)) {
604                                 assert(x >= start_frame);
605                                 assert(x <= end_frame);
606
607                                 const nframes_t stamp = (nframes_t)floor(x - start_frame);
608                                 assert(stamp < nframes);
609
610                                 assert(y >= 0.0);
611                                 assert(y <= 127.0);
612
613                                 ev.time() = stamp;
614                                 ev.buffer()[1] = (Byte)list->parameter().id();
615                                 ev.buffer()[2] = (Byte)y;
616
617                                 cc_buf.push_back(ev);
618
619                                 start = x + 1; // FIXME?  maybe?
620                         }
621                 }
622         }
623
624         /* FIXME: too much copying! */
625
626         // Merge cc buf into output
627         if (cc_buf.size() > 0) {
628
629                 // Both CC and route, must merge
630                 if (output_buf.size() > 0) {
631
632                         MidiBuffer& mix_buf = mix_buffers.get_midi(1);
633                         mix_buf.merge(output_buf, cc_buf);
634                         output_buf.copy(mix_buf);
635
636                 } else {
637                         output_buf.copy(cc_buf);
638                 }
639         }
640
641         // Append immediate events (UI controls)
642         _immediate_events.read(output_buf, 0, 0, offset + nframes-1); // all stamps = 0
643 }
644
645 int
646 MidiTrack::export_stuff (BufferSet& bufs, nframes_t nframes, nframes_t end_frame)
647 {
648         return -1;
649 }
650
651 void
652 MidiTrack::set_latency_delay (nframes_t longest_session_latency)
653 {
654         Route::set_latency_delay (longest_session_latency);
655         _diskstream->set_roll_delay (_roll_delay);
656 }
657
658 void
659 MidiTrack::bounce (InterThreadInfo& itt)
660 {
661         throw;
662         //vector<MidiSource*> srcs;
663         //_session.write_one_midi_track (*this, 0, _session.current_end_frame(), false, srcs, itt);
664 }
665
666
667 void
668 MidiTrack::bounce_range (nframes_t start, nframes_t end, InterThreadInfo& itt)
669 {
670         throw;
671         //vector<MidiSource*> srcs;
672         //_session.write_one_midi_track (*this, start, end, false, srcs, itt);
673 }
674
675 void
676 MidiTrack::freeze (InterThreadInfo& itt)
677 {
678 }
679
680 void
681 MidiTrack::unfreeze ()
682 {
683         _freeze_record.state = UnFrozen;
684         FreezeChange (); /* EMIT SIGNAL */
685 }
686
687 void
688 MidiTrack::set_note_mode (NoteMode m)
689 {
690         _note_mode = m;
691         midi_diskstream()->set_note_mode(m);
692 }
693
694 /** \return true on success, false on failure (no buffer space left)
695  */
696 bool
697 MidiTrack::write_immediate_event(size_t size, const Byte* buf)
698 {
699         return (_immediate_events.write(0, size, buf) == size);
700 }
701
702 void
703 MidiTrack::MidiControl::set_value(float val)
704 {
705         assert(val >= 0);
706         assert(val <= 127.0);
707
708         if ( ! _list->automation_playback()) {
709                 Byte ev[3] = { MIDI_CMD_CONTROL, _list->parameter().id(), (int)val };
710                 _route->write_immediate_event(3,  ev);
711         }
712
713         AutomationControl::set_value(val);
714
715