first vaguely working version using PresentationInfo
[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 "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 id (PresentationInfo::Flag (0));
342
343         if (n == 318) {
344                 id.set_flags (PresentationInfo::MasterOut);
345         } else if (n == 319) {
346                 id.set_flags (PresentationInfo::MonitorOut);
347         } else {
348                 id = PresentationInfo (n, PresentationInfo::Route);
349         }
350
351         boost::shared_ptr<RouteList> r = routes.reader ();
352
353         for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
354                 if ((*i)->presentation_info().match (id)) {
355                         return *i;
356                 }
357         }
358
359         return boost::shared_ptr<Route>();
360 }
361
362 void
363 Session::mmc_record_enable (MIDI::MachineControl &mmc, size_t trk, bool enabled)
364 {
365         if (!Config->get_mmc_control ()) {
366                 return;
367         }
368
369         boost::shared_ptr<Route> r = get_midi_nth_route_by_id (trk);
370
371         if (r) {
372                 boost::shared_ptr<AudioTrack> at;
373
374                 if ((at = boost::dynamic_pointer_cast<AudioTrack> (r))) {
375                         at->rec_enable_control()->set_value (enabled, Controllable::UseGroup);
376                 }
377         }
378 }
379
380 /** Send MTC Full Frame message (complete Timecode time) for the start of this cycle.
381  * This resets the MTC code, the next quarter frame message that is sent will be
382  * the first one with the beginning of this cycle as the new start point.
383  * @param t time to send.
384  */
385 int
386 Session::send_full_time_code (framepos_t const t, MIDI::pframes_t nframes)
387 {
388         /* This function could easily send at a given frame offset, but would
389          * that be useful?  Does ardour do sub-block accurate locating? [DR] */
390
391         MIDI::byte msg[10];
392         Timecode::Time timecode;
393
394         _send_timecode_update = false;
395
396         if (_engine.freewheeling() || !Config->get_send_mtc()) {
397                 return 0;
398         }
399         if (_slave && !_slave->locked()) {
400                 return 0;
401         }
402
403         // Get timecode time for the given time
404         sample_to_timecode (t, timecode, true /* use_offset */, false /* no subframes */);
405
406         // sample-align outbound to rounded (no subframes) timecode
407         framepos_t mtc_tc;
408         timecode_to_sample(timecode, mtc_tc, true, false);
409         outbound_mtc_timecode_frame = mtc_tc;
410         transmitting_timecode_time = timecode;
411
412         LatencyRange mtc_out_latency = {0, 0}; // TODO cache this, update on engine().GraphReordered()
413         _midi_ports->mtc_output_port ()->get_connected_latency_range (ltc_out_latency, true);
414         frameoffset_t mtc_offset = worst_playback_latency() - mtc_out_latency.max;
415
416         // only if rolling.. ?
417         outbound_mtc_timecode_frame += mtc_offset;
418
419         // outbound_mtc_timecode_frame needs to be >= _transport_frame
420         // or a new full timecode will be queued next cycle.
421         while (outbound_mtc_timecode_frame < t) {
422                 Timecode::increment (transmitting_timecode_time, config.get_subframes_per_frame());
423                 outbound_mtc_timecode_frame += _frames_per_timecode_frame;
424         }
425
426         double const quarter_frame_duration = ((framecnt_t) _frames_per_timecode_frame) / 4.0;
427         if (ceil((t - mtc_tc) / quarter_frame_duration) > 0) {
428                 Timecode::increment (transmitting_timecode_time, config.get_subframes_per_frame());
429                 outbound_mtc_timecode_frame += _frames_per_timecode_frame;
430         }
431
432         DEBUG_TRACE (DEBUG::MTC, string_compose ("Full MTC TC %1 (off %2)\n", outbound_mtc_timecode_frame, mtc_offset));
433
434         // I don't understand this bit yet.. [DR]
435         // I do [rg]:
436         // according to MTC spec 24, 30 drop and 30 non-drop TC, the frame-number represented by 8 quarter frames must be even.
437         if (((mtc_timecode_bits >> 5) != MIDI::MTC_25_FPS) && (transmitting_timecode_time.frames % 2)) {
438                 // start MTC quarter frame transmission on an even frame
439                 Timecode::increment (transmitting_timecode_time, config.get_subframes_per_frame());
440                 outbound_mtc_timecode_frame += _frames_per_timecode_frame;
441         }
442
443         next_quarter_frame_to_send = 0;
444
445         // Sync slave to the same Timecode time as we are on
446         msg[0] = 0xf0;
447         msg[1] = 0x7f;
448         msg[2] = 0x7f;
449         msg[3] = 0x1;
450         msg[4] = 0x1;
451         msg[9] = 0xf7;
452
453         msg[5] = mtc_timecode_bits | (timecode.hours % 24);
454         msg[6] = timecode.minutes;
455         msg[7] = timecode.seconds;
456         msg[8] = timecode.frames;
457
458         // Send message at offset 0, sent time is for the start of this cycle
459
460         MidiBuffer& mb (_midi_ports->mtc_output_port()->get_midi_buffer (nframes));
461         mb.push_back (Port::port_offset(), sizeof (msg), msg);
462
463         _pframes_since_last_mtc = 0;
464         return 0;
465 }
466
467 /** Send MTC (quarter-frame) messages for this cycle.
468  * Must be called exactly once per cycle from the process thread.  Realtime safe.
469  * This function assumes the state of full Timecode is sane, eg. the slave is
470  * expecting quarter frame messages and has the right frame of reference (any
471  * full MTC Timecode time messages that needed to be sent should have been sent
472  * earlier already this cycle by send_full_time_code)
473  */
474 int
475 Session::send_midi_time_code_for_cycle (framepos_t start_frame, framepos_t end_frame, ARDOUR::pframes_t nframes)
476 {
477         // start_frame == start_frame  for normal cycles
478         // start_frame > _transport_frame  for split cycles
479         if (_engine.freewheeling() || !_send_qf_mtc || transmitting_timecode_time.negative || (next_quarter_frame_to_send < 0)) {
480                 // cerr << "(MTC) Not sending MTC\n";
481                 return 0;
482         }
483         if (_slave && !_slave->locked()) {
484                 return 0;
485         }
486
487         if (_transport_speed < 0) {
488                 // we don't support rolling backwards
489                 return 0;
490         }
491
492         /* MTC is max. 30 fps - assert() below will fail
493          * TODO actually limit it to 24,25,29df,30fps
494          * talk to oofus, first.
495          */
496         if (Timecode::timecode_to_frames_per_second(config.get_timecode_format()) > 30) {
497                 return 0;
498         }
499
500         assert (next_quarter_frame_to_send >= 0);
501         assert (next_quarter_frame_to_send <= 7);
502
503         /* Duration of one quarter frame */
504         double const quarter_frame_duration = _frames_per_timecode_frame / 4.0;
505
506         DEBUG_TRACE (DEBUG::MTC, string_compose ("TF %1 SF %2 MT %3 QF %4 QD %5\n",
507                                 _transport_frame, start_frame, outbound_mtc_timecode_frame,
508                                 next_quarter_frame_to_send, quarter_frame_duration));
509
510         if (rint(outbound_mtc_timecode_frame + (next_quarter_frame_to_send * quarter_frame_duration)) < _transport_frame) {
511                 // send full timecode and set outbound_mtc_timecode_frame, next_quarter_frame_to_send
512                 send_full_time_code (_transport_frame, nframes);
513         }
514
515         if (rint(outbound_mtc_timecode_frame + (next_quarter_frame_to_send * quarter_frame_duration)) < start_frame) {
516                 // no QF for this cycle
517                 return 0;
518         }
519
520         /* Send quarter frames for this cycle */
521         while (end_frame > rint(outbound_mtc_timecode_frame + (next_quarter_frame_to_send * quarter_frame_duration))) {
522
523                 DEBUG_TRACE (DEBUG::MTC, string_compose ("next frame to send: %1\n", next_quarter_frame_to_send));
524
525                 switch (next_quarter_frame_to_send) {
526                         case 0:
527                                 mtc_msg[1] = 0x00 | (transmitting_timecode_time.frames & 0xf);
528                                 break;
529                         case 1:
530                                 mtc_msg[1] = 0x10 | ((transmitting_timecode_time.frames & 0xf0) >> 4);
531                                 break;
532                         case 2:
533                                 mtc_msg[1] = 0x20 | (transmitting_timecode_time.seconds & 0xf);
534                                 break;
535                         case 3:
536                                 mtc_msg[1] = 0x30 | ((transmitting_timecode_time.seconds & 0xf0) >> 4);
537                                 break;
538                         case 4:
539                                 mtc_msg[1] = 0x40 | (transmitting_timecode_time.minutes & 0xf);
540                                 break;
541                         case 5:
542                                 mtc_msg[1] = 0x50 | ((transmitting_timecode_time.minutes & 0xf0) >> 4);
543                                 break;
544                         case 6:
545                                 mtc_msg[1] = 0x60 | ((mtc_timecode_bits | transmitting_timecode_time.hours) & 0xf);
546                                 break;
547                         case 7:
548                                 mtc_msg[1] = 0x70 | (((mtc_timecode_bits | transmitting_timecode_time.hours) & 0xf0) >> 4);
549                                 break;
550                 }
551
552                 const framepos_t msg_time = rint(outbound_mtc_timecode_frame    + (quarter_frame_duration * next_quarter_frame_to_send));
553
554                 // This message must fall within this block or something is broken
555                 assert (msg_time >= start_frame);
556                 assert (msg_time < end_frame);
557
558                 /* convert from session frames back to JACK frames using the transport speed */
559                 ARDOUR::pframes_t const out_stamp = (msg_time - start_frame) / _transport_speed;
560                 assert (out_stamp < nframes);
561
562                 MidiBuffer& mb (_midi_ports->mtc_output_port()->get_midi_buffer(nframes));
563                 if (!mb.push_back (out_stamp, 2, mtc_msg)) {
564                         error << string_compose(_("Session: cannot send quarter-frame MTC message (%1)"), strerror (errno))
565                               << endmsg;
566                         return -1;
567                 }
568
569 #ifndef NDEBUG
570                 if (DEBUG_ENABLED(DEBUG::MTC)) {
571                         DEBUG_STR_DECL(foo)
572                         DEBUG_STR_APPEND(foo,"sending ");
573                         DEBUG_STR_APPEND(foo, transmitting_timecode_time);
574                         DEBUG_TRACE (DEBUG::MTC, string_compose ("%1 qfm = %2, stamp = %3\n", DEBUG_STR(foo).str(), next_quarter_frame_to_send,
575                                                                  out_stamp));
576                 }
577 #endif
578
579                 // Increment quarter frame counter
580                 next_quarter_frame_to_send++;
581
582                 if (next_quarter_frame_to_send >= 8) {
583                         // Wrap quarter frame counter
584                         next_quarter_frame_to_send = 0;
585                         // Increment timecode time twice
586                         Timecode::increment (transmitting_timecode_time, config.get_subframes_per_frame());
587                         Timecode::increment (transmitting_timecode_time, config.get_subframes_per_frame());
588                         // Increment timing of first quarter frame
589                         outbound_mtc_timecode_frame += 2.0 * _frames_per_timecode_frame;
590                 }
591         }
592
593         return 0;
594 }
595
596 /***********************************************************************
597  OUTBOUND MMC STUFF
598 **********************************************************************/
599
600 void
601 Session::send_immediate_mmc (MachineControlCommand c)
602 {
603         if (AudioEngine::instance()->in_process_thread()) {
604                 _mmc->send (c, Port::port_offset());
605         } else {
606                 _mmc->send (c, 0);
607         }
608
609 }
610
611 bool
612 Session::mmc_step_timeout ()
613 {
614         struct timeval now;
615         struct timeval diff;
616         double diff_usecs;
617         gettimeofday (&now, 0);
618
619         timersub (&now, &last_mmc_step, &diff);
620         diff_usecs = diff.tv_sec * 1000000 + diff.tv_usec;
621
622         if (diff_usecs > 1000000.0 || fabs (_transport_speed) < 0.0000001) {
623                 /* too long or too slow, stop transport */
624                 request_transport_speed (0.0);
625                 step_queued = false;
626                 return false;
627         }
628
629         if (diff_usecs < 250000.0) {
630                 /* too short, just keep going */
631                 return true;
632         }
633
634         /* slow it down */
635
636         request_transport_speed_nonzero (_transport_speed * 0.75);
637         return true;
638 }
639
640 /***********************************************************************
641  OUTBOUND SYSTEM COMMON STUFF
642 **********************************************************************/
643
644
645 void
646 Session::send_song_position_pointer (framepos_t)
647 {
648         if (midi_clock) {
649                 /* Do nothing for the moment */
650         }
651 }
652
653 int
654 Session::start_midi_thread ()
655 {
656         if (midi_control_ui) { return 0; }
657         midi_control_ui = new MidiControlUI (*this);
658         midi_control_ui->run ();
659         return 0;
660 }
661
662 boost::shared_ptr<ARDOUR::Port>
663 Session::midi_input_port () const
664 {
665         return _midi_ports->midi_input_port ();
666 }
667
668 boost::shared_ptr<ARDOUR::Port>
669 Session::midi_output_port () const
670 {
671         return _midi_ports->midi_output_port ();
672 }
673
674 boost::shared_ptr<ARDOUR::Port>
675 Session::mmc_output_port () const
676 {
677         return _midi_ports->mmc_output_port ();
678 }
679
680 boost::shared_ptr<ARDOUR::Port>
681 Session::mmc_input_port () const
682 {
683         return _midi_ports->mmc_input_port ();
684 }
685
686 boost::shared_ptr<ARDOUR::Port>
687 Session::scene_output_port () const
688 {
689         return _midi_ports->scene_output_port ();
690 }
691
692 boost::shared_ptr<ARDOUR::Port>
693 Session::scene_input_port () const
694 {
695         return _midi_ports->scene_input_port ();
696 }
697
698 boost::shared_ptr<MidiPort>
699 Session::midi_clock_output_port () const
700 {
701         return _midi_ports->midi_clock_output_port ();
702 }
703
704 boost::shared_ptr<MidiPort>
705 Session::midi_clock_input_port () const
706 {
707         return _midi_ports->midi_clock_input_port ();
708 }
709 boost::shared_ptr<MidiPort>
710 Session::mtc_output_port () const
711 {
712         return _midi_ports->mtc_output_port ();
713 }
714 boost::shared_ptr<MidiPort>
715 Session::mtc_input_port () const
716 {
717         return _midi_ports->mtc_input_port ();
718 }