fix crash when copy'ing latent plugins
[ardour.git] / libs / ardour / session_midi.cc
1 /*
2   Copyright (C) 1999-2002 Paul Davis
3
4   This program is free software; you can redistribute it and/or modify
5   it under the terms of the GNU General Public License as published by
6   the Free Software Foundation; either version 2 of the License, or
7   (at your option) any later version.
8
9   This program is distributed in the hope that it will be useful,
10   but WITHOUT ANY WARRANTY; without even the implied warranty of
11   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12   GNU General Public License for more details.
13
14   You should have received a copy of the GNU General Public License
15   along with this program; if not, write to the Free Software
16   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17
18 */
19
20 #include <string>
21 #include <cmath>
22 #include <cerrno>
23 #include <cassert>
24 #include <unistd.h>
25
26 #include <boost/shared_ptr.hpp>
27
28 #include <glibmm/main.h>
29
30 #include "midi++/mmc.h"
31 #include "midi++/port.h"
32
33 #include "pbd/error.h"
34 #include "pbd/pthread_utils.h"
35 #include "pbd/timersub.h"
36 #include "pbd/stacktrace.h"
37
38 #include "timecode/time.h"
39
40 #include "ardour/audio_track.h"
41 #include "ardour/audioengine.h"
42 #include "ardour/debug.h"
43 #include "ardour/midi_port.h"
44 #include "ardour/midi_track.h"
45 #include "ardour/midi_ui.h"
46 #include "ardour/profile.h"
47 #include "ardour/session.h"
48 #include "ardour/slave.h"
49 #include "ardour/ticker.h"
50
51 #include "pbd/i18n.h"
52
53 using namespace std;
54 using namespace ARDOUR;
55 using namespace PBD;
56 using namespace MIDI;
57 using namespace Glib;
58
59 void
60 Session::midi_panic()
61 {
62         {
63                 boost::shared_ptr<RouteList> r = routes.reader ();
64
65                 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
66                         MidiTrack *track = dynamic_cast<MidiTrack*>((*i).get());
67                         if (track != 0) {
68                                 track->midi_panic();
69                         }
70                 }
71         }
72 }
73
74 void
75 Session::setup_midi_control ()
76 {
77         outbound_mtc_timecode_frame = 0;
78         next_quarter_frame_to_send = 0;
79
80         /* Set up the qtr frame message */
81
82         mtc_msg[0] = 0xf1;
83         mtc_msg[2] = 0xf1;
84         mtc_msg[4] = 0xf1;
85         mtc_msg[6] = 0xf1;
86         mtc_msg[8] = 0xf1;
87         mtc_msg[10] = 0xf1;
88         mtc_msg[12] = 0xf1;
89         mtc_msg[14] = 0xf1;
90 }
91
92 void
93 Session::spp_start ()
94 {
95         if (Config->get_mmc_control ()) {
96                 request_transport_speed (1.0);
97         }
98 }
99
100 void
101 Session::spp_continue ()
102 {
103         spp_start ();
104 }
105
106 void
107 Session::spp_stop ()
108 {
109         if (Config->get_mmc_control ()) {
110                 request_stop ();
111         }
112 }
113
114 void
115 Session::mmc_deferred_play (MIDI::MachineControl &/*mmc*/)
116 {
117         if (Config->get_mmc_control ()) {
118                 request_transport_speed (1.0);
119         }
120 }
121
122 void
123 Session::mmc_record_pause (MIDI::MachineControl &/*mmc*/)
124 {
125         if (Config->get_mmc_control ()) {
126                 maybe_enable_record();
127         }
128 }
129
130 void
131 Session::mmc_record_strobe (MIDI::MachineControl &/*mmc*/)
132 {
133         if (Profile->get_trx()) {
134
135                 /* In Tracks Live, there is no concept of punch, so we just
136                    treat RecordStrobe like RecordPause. This violates the MMC
137                    specification.
138                 */
139
140                 if (Config->get_mmc_control()) {
141                         maybe_enable_record();
142                 }
143                 return;
144         }
145
146         if (!Config->get_mmc_control() || (_step_editors > 0)) {
147                 return;
148         }
149
150         /* record strobe does an implicit "Play" command */
151
152         if (_transport_speed != 1.0) {
153
154                 /* start_transport() will move from Enabled->Recording, so we
155                    don't need to do anything here except enable recording.
156                    its not the same as maybe_enable_record() though, because
157                    that *can* switch to Recording, which we do not want.
158                 */
159
160                 save_state ("", true);
161                 g_atomic_int_set (&_record_status, Enabled);
162                 RecordStateChanged (); /* EMIT SIGNAL */
163
164                 request_transport_speed (1.0);
165
166         } else {
167
168                 enable_record ();
169         }
170 }
171
172 void
173 Session::mmc_record_exit (MIDI::MachineControl &/*mmc*/)
174 {
175         if (Config->get_mmc_control ()) {
176                 disable_record (false);
177         }
178 }
179
180 void
181 Session::mmc_stop (MIDI::MachineControl &/*mmc*/)
182 {
183         if (Config->get_mmc_control ()) {
184                 request_stop ();
185         }
186 }
187
188 void
189 Session::mmc_pause (MIDI::MachineControl &/*mmc*/)
190 {
191         if (Config->get_mmc_control ()) {
192
193                 /* We support RECORD_PAUSE, so the spec says that
194                    we must interpret PAUSE like RECORD_PAUSE if
195                    recording.
196                 */
197
198                 if (actively_recording()) {
199                         maybe_enable_record ();
200                 } else {
201                         request_stop ();
202                 }
203         }
204 }
205
206 static bool step_queued = false;
207
208 void
209 Session::mmc_step (MIDI::MachineControl &/*mmc*/, int steps)
210 {
211         if (!Config->get_mmc_control ()) {
212                 return;
213         }
214
215         struct timeval now;
216         struct timeval diff = { 0, 0 };
217
218         gettimeofday (&now, 0);
219
220         timersub (&now, &last_mmc_step, &diff);
221
222         gettimeofday (&now, 0);
223         timersub (&now, &last_mmc_step, &diff);
224
225         if (last_mmc_step.tv_sec != 0 && (diff.tv_usec + (diff.tv_sec * 1000000)) < _engine.usecs_per_cycle()) {
226                 return;
227         }
228
229         double diff_secs = diff.tv_sec + (diff.tv_usec / 1000000.0);
230         double cur_speed = (((steps * 0.5) * timecode_frames_per_second()) / diff_secs) / timecode_frames_per_second();
231
232         if (_transport_speed == 0 || cur_speed * _transport_speed < 0) {
233                 /* change direction */
234                 step_speed = cur_speed;
235         } else {
236                 step_speed = (0.6 * step_speed) + (0.4 * cur_speed);
237         }
238
239         step_speed *= 0.25;
240
241 #if 0
242         cerr << "delta = " << diff_secs
243              << " ct = " << _transport_speed
244              << " steps = " << steps
245              << " new speed = " << cur_speed
246              << " speed = " << step_speed
247              << endl;
248 #endif
249
250         request_transport_speed_nonzero (step_speed);
251         last_mmc_step = now;
252
253         if (!step_queued) {
254                 if (midi_control_ui) {
255                         RefPtr<TimeoutSource> tsrc = TimeoutSource::create (100);
256                         tsrc->connect (sigc::mem_fun (*this, &Session::mmc_step_timeout));
257                         tsrc->attach (midi_control_ui->main_loop()->get_context());
258                         step_queued = true;
259                 }
260         }
261 }
262
263 void
264 Session::mmc_rewind (MIDI::MachineControl &/*mmc*/)
265 {
266         if (Config->get_mmc_control ()) {
267                 request_transport_speed(-8.0f);
268         }
269 }
270
271 void
272 Session::mmc_fast_forward (MIDI::MachineControl &/*mmc*/)
273 {
274         if (Config->get_mmc_control ()) {
275                 request_transport_speed(8.0f);
276         }
277 }
278
279 void
280 Session::mmc_locate (MIDI::MachineControl &/*mmc*/, const MIDI::byte* mmc_tc)
281 {
282         if (!Config->get_mmc_control ()) {
283                 return;
284         }
285
286         framepos_t target_frame;
287         Timecode::Time timecode;
288
289         timecode.hours = mmc_tc[0] & 0xf;
290         timecode.minutes = mmc_tc[1];
291         timecode.seconds = mmc_tc[2];
292         timecode.frames = mmc_tc[3];
293         timecode.rate = timecode_frames_per_second();
294         timecode.drop = timecode_drop_frames();
295
296         // Also takes timecode offset into account:
297         timecode_to_sample( timecode, target_frame, true /* use_offset */, false /* use_subframes */ );
298
299         if (target_frame > max_framepos) {
300                 target_frame = max_framepos;
301         }
302
303         /* Some (all?) MTC/MMC devices do not send a full MTC frame
304            at the end of a locate, instead sending only an MMC
305            locate command. This causes the current position
306            of an MTC slave to become out of date. Catch this.
307         */
308
309         MTC_Slave* mtcs = dynamic_cast<MTC_Slave*> (_slave);
310
311         if (mtcs != 0) {
312                 // cerr << "Locate *with* MTC slave\n";
313                 mtcs->handle_locate (mmc_tc);
314         } else {
315                 // cerr << "Locate without MTC slave\n";
316                 request_locate (target_frame, false);
317         }
318 }
319
320 void
321 Session::mmc_shuttle (MIDI::MachineControl &/*mmc*/, float speed, bool forw)
322 {
323         if (!Config->get_mmc_control ()) {
324                 return;
325         }
326
327         if (Config->get_shuttle_speed_threshold() >= 0 && speed > Config->get_shuttle_speed_threshold()) {
328                 speed *= Config->get_shuttle_speed_factor();
329         }
330
331         if (forw) {
332                 request_transport_speed_nonzero (speed);
333         } else {
334                 request_transport_speed_nonzero (-speed);
335         }
336 }
337
338 boost::shared_ptr<Route>
339 Session::get_midi_nth_route_by_id (PresentationInfo::order_t n) const
340 {
341         PresentationInfo::Flag f;
342
343         /* These numbers are defined by the MMC specification.
344          */
345
346         if (n == 318) {
347                 f = PresentationInfo::MasterOut;
348         } else if (n == 319) {
349                 f = PresentationInfo::MonitorOut;
350         } else {
351                 f = PresentationInfo::Route;
352         }
353
354         boost::shared_ptr<RouteList> r = routes.reader ();
355         PresentationInfo::order_t match_cnt = 0;
356
357         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
358                 if ((*i)->presentation_info().flag_match (f)) {
359                         if (match_cnt++ == n) {
360                                 return *i;
361                         }
362                 }
363         }
364
365         return boost::shared_ptr<Route>();
366 }
367
368 void
369 Session::mmc_record_enable (MIDI::MachineControl &mmc, size_t trk, bool enabled)
370 {
371         if (!Config->get_mmc_control ()) {
372                 return;
373         }
374
375         boost::shared_ptr<Route> r = get_midi_nth_route_by_id (trk);
376
377         if (r) {
378                 boost::shared_ptr<AudioTrack> at;
379
380                 if ((at = boost::dynamic_pointer_cast<AudioTrack> (r))) {
381                         at->rec_enable_control()->set_value (enabled, Controllable::UseGroup);
382                 }
383         }
384 }
385
386 /** Send MTC Full Frame message (complete Timecode time) for the start of this cycle.
387  * This resets the MTC code, the next quarter frame message that is sent will be
388  * the first one with the beginning of this cycle as the new start point.
389  * @param t time to send.
390  */
391 int
392 Session::send_full_time_code (framepos_t const t, MIDI::pframes_t nframes)
393 {
394         /* This function could easily send at a given frame offset, but would
395          * that be useful?  Does ardour do sub-block accurate locating? [DR] */
396
397         MIDI::byte msg[10];
398         Timecode::Time timecode;
399
400         _send_timecode_update = false;
401
402         if (_engine.freewheeling() || !Config->get_send_mtc()) {
403                 return 0;
404         }
405         if (_slave && !_slave->locked()) {
406                 return 0;
407         }
408
409         // Get timecode time for the given time
410         sample_to_timecode (t, timecode, true /* use_offset */, false /* no subframes */);
411
412         // sample-align outbound to rounded (no subframes) timecode
413         framepos_t mtc_tc;
414         timecode_to_sample(timecode, mtc_tc, true, false);
415         outbound_mtc_timecode_frame = mtc_tc;
416         transmitting_timecode_time = timecode;
417
418         LatencyRange mtc_out_latency = {0, 0}; // TODO cache this, update on engine().GraphReordered()
419         _midi_ports->mtc_output_port ()->get_connected_latency_range (ltc_out_latency, true);
420         frameoffset_t mtc_offset = worst_playback_latency() - mtc_out_latency.max;
421
422         // only if rolling.. ?
423         outbound_mtc_timecode_frame += mtc_offset;
424
425         // outbound_mtc_timecode_frame needs to be >= _transport_frame
426         // or a new full timecode will be queued next cycle.
427         while (outbound_mtc_timecode_frame < t) {
428                 Timecode::increment (transmitting_timecode_time, config.get_subframes_per_frame());
429                 outbound_mtc_timecode_frame += _frames_per_timecode_frame;
430         }
431
432         double const quarter_frame_duration = ((framecnt_t) _frames_per_timecode_frame) / 4.0;
433         if (ceil((t - mtc_tc) / quarter_frame_duration) > 0) {
434                 Timecode::increment (transmitting_timecode_time, config.get_subframes_per_frame());
435                 outbound_mtc_timecode_frame += _frames_per_timecode_frame;
436         }
437
438         DEBUG_TRACE (DEBUG::MTC, string_compose ("Full MTC TC %1 (off %2)\n", outbound_mtc_timecode_frame, mtc_offset));
439
440         // I don't understand this bit yet.. [DR]
441         // I do [rg]:
442         // according to MTC spec 24, 30 drop and 30 non-drop TC, the frame-number represented by 8 quarter frames must be even.
443         if (((mtc_timecode_bits >> 5) != MIDI::MTC_25_FPS) && (transmitting_timecode_time.frames % 2)) {
444                 // start MTC quarter frame transmission on an even frame
445                 Timecode::increment (transmitting_timecode_time, config.get_subframes_per_frame());
446                 outbound_mtc_timecode_frame += _frames_per_timecode_frame;
447         }
448
449         next_quarter_frame_to_send = 0;
450
451         // Sync slave to the same Timecode time as we are on
452         msg[0] = 0xf0;
453         msg[1] = 0x7f;
454         msg[2] = 0x7f;
455         msg[3] = 0x1;
456         msg[4] = 0x1;
457         msg[9] = 0xf7;
458
459         msg[5] = mtc_timecode_bits | (timecode.hours % 24);
460         msg[6] = timecode.minutes;
461         msg[7] = timecode.seconds;
462         msg[8] = timecode.frames;
463
464         // Send message at offset 0, sent time is for the start of this cycle
465
466         MidiBuffer& mb (_midi_ports->mtc_output_port()->get_midi_buffer (nframes));
467         mb.push_back (Port::port_offset(), sizeof (msg), msg);
468
469         _pframes_since_last_mtc = 0;
470         return 0;
471 }
472
473 /** Send MTC (quarter-frame) messages for this cycle.
474  * Must be called exactly once per cycle from the process thread.  Realtime safe.
475  * This function assumes the state of full Timecode is sane, eg. the slave is
476  * expecting quarter frame messages and has the right frame of reference (any
477  * full MTC Timecode time messages that needed to be sent should have been sent
478  * earlier already this cycle by send_full_time_code)
479  */
480 int
481 Session::send_midi_time_code_for_cycle (framepos_t start_frame, framepos_t end_frame, ARDOUR::pframes_t nframes)
482 {
483         // start_frame == start_frame  for normal cycles
484         // start_frame > _transport_frame  for split cycles
485         if (_engine.freewheeling() || !_send_qf_mtc || transmitting_timecode_time.negative || (next_quarter_frame_to_send < 0)) {
486                 // cerr << "(MTC) Not sending MTC\n";
487                 return 0;
488         }
489         if (_slave && !_slave->locked()) {
490                 return 0;
491         }
492
493         if (_transport_speed < 0) {
494                 // we don't support rolling backwards
495                 return 0;
496         }
497
498         /* MTC is max. 30 fps - assert() below will fail
499          * TODO actually limit it to 24,25,29df,30fps
500          * talk to oofus, first.
501          */
502         if (Timecode::timecode_to_frames_per_second(config.get_timecode_format()) > 30) {
503                 return 0;
504         }
505
506         assert (next_quarter_frame_to_send >= 0);
507         assert (next_quarter_frame_to_send <= 7);
508
509         /* Duration of one quarter frame */
510         double const quarter_frame_duration = _frames_per_timecode_frame / 4.0;
511
512         DEBUG_TRACE (DEBUG::MTC, string_compose ("TF %1 SF %2 MT %3 QF %4 QD %5\n",
513                                 _transport_frame, start_frame, outbound_mtc_timecode_frame,
514                                 next_quarter_frame_to_send, quarter_frame_duration));
515
516         if (rint(outbound_mtc_timecode_frame + (next_quarter_frame_to_send * quarter_frame_duration)) < _transport_frame) {
517                 // send full timecode and set outbound_mtc_timecode_frame, next_quarter_frame_to_send
518                 send_full_time_code (_transport_frame, nframes);
519         }
520
521         if (rint(outbound_mtc_timecode_frame + (next_quarter_frame_to_send * quarter_frame_duration)) < start_frame) {
522                 // no QF for this cycle
523                 return 0;
524         }
525
526         /* Send quarter frames for this cycle */
527         while (end_frame > rint(outbound_mtc_timecode_frame + (next_quarter_frame_to_send * quarter_frame_duration))) {
528
529                 DEBUG_TRACE (DEBUG::MTC, string_compose ("next frame to send: %1\n", next_quarter_frame_to_send));
530
531                 switch (next_quarter_frame_to_send) {
532                         case 0:
533                                 mtc_msg[1] = 0x00 | (transmitting_timecode_time.frames & 0xf);
534                                 break;
535                         case 1:
536                                 mtc_msg[1] = 0x10 | ((transmitting_timecode_time.frames & 0xf0) >> 4);
537                                 break;
538                         case 2:
539                                 mtc_msg[1] = 0x20 | (transmitting_timecode_time.seconds & 0xf);
540                                 break;
541                         case 3:
542                                 mtc_msg[1] = 0x30 | ((transmitting_timecode_time.seconds & 0xf0) >> 4);
543                                 break;
544                         case 4:
545                                 mtc_msg[1] = 0x40 | (transmitting_timecode_time.minutes & 0xf);
546                                 break;
547                         case 5:
548                                 mtc_msg[1] = 0x50 | ((transmitting_timecode_time.minutes & 0xf0) >> 4);
549                                 break;
550                         case 6:
551                                 mtc_msg[1] = 0x60 | ((mtc_timecode_bits | transmitting_timecode_time.hours) & 0xf);
552                                 break;
553                         case 7:
554                                 mtc_msg[1] = 0x70 | (((mtc_timecode_bits | transmitting_timecode_time.hours) & 0xf0) >> 4);
555                                 break;
556                 }
557
558                 const framepos_t msg_time = rint(outbound_mtc_timecode_frame    + (quarter_frame_duration * next_quarter_frame_to_send));
559
560                 // This message must fall within this block or something is broken
561                 assert (msg_time >= start_frame);
562                 assert (msg_time < end_frame);
563
564                 /* convert from session frames back to JACK frames using the transport speed */
565                 ARDOUR::pframes_t const out_stamp = (msg_time - start_frame) / _transport_speed;
566                 assert (out_stamp < nframes);
567
568                 MidiBuffer& mb (_midi_ports->mtc_output_port()->get_midi_buffer(nframes));
569                 if (!mb.push_back (out_stamp, 2, mtc_msg)) {
570                         error << string_compose(_("Session: cannot send quarter-frame MTC message (%1)"), strerror (errno))
571                               << endmsg;
572                         return -1;
573                 }
574
575 #ifndef NDEBUG
576                 if (DEBUG_ENABLED(DEBUG::MTC)) {
577                         DEBUG_STR_DECL(foo)
578                         DEBUG_STR_APPEND(foo,"sending ");
579                         DEBUG_STR_APPEND(foo, transmitting_timecode_time);
580                         DEBUG_TRACE (DEBUG::MTC, string_compose ("%1 qfm = %2, stamp = %3\n", DEBUG_STR(foo).str(), next_quarter_frame_to_send,
581                                                                  out_stamp));
582                 }
583 #endif
584
585                 // Increment quarter frame counter
586                 next_quarter_frame_to_send++;
587
588                 if (next_quarter_frame_to_send >= 8) {
589                         // Wrap quarter frame counter
590                         next_quarter_frame_to_send = 0;
591                         // Increment timecode time twice
592                         Timecode::increment (transmitting_timecode_time, config.get_subframes_per_frame());
593                         Timecode::increment (transmitting_timecode_time, config.get_subframes_per_frame());
594                         // Increment timing of first quarter frame
595                         outbound_mtc_timecode_frame += 2.0 * _frames_per_timecode_frame;
596                 }
597         }
598
599         return 0;
600 }
601
602 /***********************************************************************
603  OUTBOUND MMC STUFF
604 **********************************************************************/
605
606 void
607 Session::send_immediate_mmc (MachineControlCommand c)
608 {
609         if (AudioEngine::instance()->in_process_thread()) {
610                 _mmc->send (c, Port::port_offset());
611         } else {
612                 _mmc->send (c, 0);
613         }
614
615 }
616
617 bool
618 Session::mmc_step_timeout ()
619 {
620         struct timeval now;
621         struct timeval diff;
622         double diff_usecs;
623         gettimeofday (&now, 0);
624
625         timersub (&now, &last_mmc_step, &diff);
626         diff_usecs = diff.tv_sec * 1000000 + diff.tv_usec;
627
628         if (diff_usecs > 1000000.0 || fabs (_transport_speed) < 0.0000001) {
629                 /* too long or too slow, stop transport */
630                 request_transport_speed (0.0);
631                 step_queued = false;
632                 return false;
633         }
634
635         if (diff_usecs < 250000.0) {
636                 /* too short, just keep going */
637                 return true;
638         }
639
640         /* slow it down */
641
642         request_transport_speed_nonzero (_transport_speed * 0.75);
643         return true;
644 }
645
646 /***********************************************************************
647  OUTBOUND SYSTEM COMMON STUFF
648 **********************************************************************/
649
650
651 void
652 Session::send_song_position_pointer (framepos_t)
653 {
654         if (midi_clock) {
655                 /* Do nothing for the moment */
656         }
657 }
658
659 int
660 Session::start_midi_thread ()
661 {
662         if (midi_control_ui) { return 0; }
663         midi_control_ui = new MidiControlUI (*this);
664         midi_control_ui->run ();
665         return 0;
666 }
667
668 boost::shared_ptr<ARDOUR::Port>
669 Session::midi_input_port () const
670 {
671         return _midi_ports->midi_input_port ();
672 }
673
674 boost::shared_ptr<ARDOUR::Port>
675 Session::midi_output_port () const
676 {
677         return _midi_ports->midi_output_port ();
678 }
679
680 boost::shared_ptr<ARDOUR::Port>
681 Session::mmc_output_port () const
682 {
683         return _midi_ports->mmc_output_port ();
684 }
685
686 boost::shared_ptr<ARDOUR::Port>
687 Session::mmc_input_port () const
688 {
689         return _midi_ports->mmc_input_port ();
690 }
691
692 boost::shared_ptr<ARDOUR::Port>
693 Session::scene_output_port () const
694 {
695         return _midi_ports->scene_output_port ();
696 }
697
698 boost::shared_ptr<ARDOUR::Port>
699 Session::scene_input_port () const
700 {
701         return _midi_ports->scene_input_port ();
702 }
703
704 boost::shared_ptr<MidiPort>
705 Session::midi_clock_output_port () const
706 {
707         return _midi_ports->midi_clock_output_port ();
708 }
709
710 boost::shared_ptr<MidiPort>
711 Session::midi_clock_input_port () const
712 {
713         return _midi_ports->midi_clock_input_port ();
714 }
715 boost::shared_ptr<MidiPort>
716 Session::mtc_output_port () const
717 {
718         return _midi_ports->mtc_output_port ();
719 }
720 boost::shared_ptr<MidiPort>
721 Session::mtc_input_port () const
722 {
723         return _midi_ports->mtc_input_port ();
724 }