2 Copyright (C) 1999-2002 Paul Davis
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.
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.
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.
26 #include <boost/shared_ptr.hpp>
28 #include <glibmm/main.h>
30 #include "midi++/mmc.h"
31 #include "midi++/port.h"
33 #include "pbd/error.h"
34 #include "pbd/pthread_utils.h"
35 #include "pbd/timersub.h"
37 #include "timecode/time.h"
39 #include "ardour/audio_track.h"
40 #include "ardour/audioengine.h"
41 #include "ardour/debug.h"
42 #include "ardour/midi_port.h"
43 #include "ardour/midi_track.h"
44 #include "ardour/midi_ui.h"
45 #include "ardour/session.h"
46 #include "ardour/slave.h"
47 #include "ardour/ticker.h"
52 using namespace ARDOUR;
61 boost::shared_ptr<RouteList> r = routes.reader ();
63 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
64 MidiTrack *track = dynamic_cast<MidiTrack*>((*i).get());
73 Session::setup_midi_control ()
75 outbound_mtc_timecode_frame = 0;
76 next_quarter_frame_to_send = 0;
78 /* Set up the qtr frame message */
93 if (Config->get_mmc_control ()) {
94 request_transport_speed (1.0);
99 Session::spp_continue ()
107 if (Config->get_mmc_control ()) {
113 Session::mmc_deferred_play (MIDI::MachineControl &/*mmc*/)
115 if (Config->get_mmc_control ()) {
116 request_transport_speed (1.0);
121 Session::mmc_record_pause (MIDI::MachineControl &/*mmc*/)
123 if (Config->get_mmc_control ()) {
124 maybe_enable_record();
129 Session::mmc_record_strobe (MIDI::MachineControl &/*mmc*/)
131 if (!Config->get_mmc_control() || (_step_editors > 0)) {
135 /* record strobe does an implicit "Play" command */
137 if (_transport_speed != 1.0) {
139 /* start_transport() will move from Enabled->Recording, so we
140 don't need to do anything here except enable recording.
141 its not the same as maybe_enable_record() though, because
142 that *can* switch to Recording, which we do not want.
145 save_state ("", true);
146 g_atomic_int_set (&_record_status, Enabled);
147 RecordStateChanged (); /* EMIT SIGNAL */
149 request_transport_speed (1.0);
158 Session::mmc_record_exit (MIDI::MachineControl &/*mmc*/)
160 if (Config->get_mmc_control ()) {
161 disable_record (false);
166 Session::mmc_stop (MIDI::MachineControl &/*mmc*/)
168 if (Config->get_mmc_control ()) {
174 Session::mmc_pause (MIDI::MachineControl &/*mmc*/)
176 if (Config->get_mmc_control ()) {
178 /* We support RECORD_PAUSE, so the spec says that
179 we must interpret PAUSE like RECORD_PAUSE if
183 if (actively_recording()) {
184 maybe_enable_record ();
191 static bool step_queued = false;
194 Session::mmc_step (MIDI::MachineControl &/*mmc*/, int steps)
196 if (!Config->get_mmc_control ()) {
201 struct timeval diff = { 0, 0 };
203 gettimeofday (&now, 0);
205 timersub (&now, &last_mmc_step, &diff);
207 gettimeofday (&now, 0);
208 timersub (&now, &last_mmc_step, &diff);
210 if (last_mmc_step.tv_sec != 0 && (diff.tv_usec + (diff.tv_sec * 1000000)) < _engine.usecs_per_cycle()) {
214 double diff_secs = diff.tv_sec + (diff.tv_usec / 1000000.0);
215 double cur_speed = (((steps * 0.5) * timecode_frames_per_second()) / diff_secs) / timecode_frames_per_second();
217 if (_transport_speed == 0 || cur_speed * _transport_speed < 0) {
218 /* change direction */
219 step_speed = cur_speed;
221 step_speed = (0.6 * step_speed) + (0.4 * cur_speed);
227 cerr << "delta = " << diff_secs
228 << " ct = " << _transport_speed
229 << " steps = " << steps
230 << " new speed = " << cur_speed
231 << " speed = " << step_speed
235 request_transport_speed_nonzero (step_speed);
239 if (midi_control_ui) {
240 RefPtr<TimeoutSource> tsrc = TimeoutSource::create (100);
241 tsrc->connect (sigc::mem_fun (*this, &Session::mmc_step_timeout));
242 tsrc->attach (midi_control_ui->main_loop()->get_context());
249 Session::mmc_rewind (MIDI::MachineControl &/*mmc*/)
251 if (Config->get_mmc_control ()) {
252 request_transport_speed(-8.0f);
257 Session::mmc_fast_forward (MIDI::MachineControl &/*mmc*/)
259 if (Config->get_mmc_control ()) {
260 request_transport_speed(8.0f);
265 Session::mmc_locate (MIDI::MachineControl &/*mmc*/, const MIDI::byte* mmc_tc)
267 if (!Config->get_mmc_control ()) {
271 framepos_t target_frame;
272 Timecode::Time timecode;
274 timecode.hours = mmc_tc[0] & 0xf;
275 timecode.minutes = mmc_tc[1];
276 timecode.seconds = mmc_tc[2];
277 timecode.frames = mmc_tc[3];
278 timecode.rate = timecode_frames_per_second();
279 timecode.drop = timecode_drop_frames();
281 // Also takes timecode offset into account:
282 timecode_to_sample( timecode, target_frame, true /* use_offset */, false /* use_subframes */ );
284 if (target_frame > max_framepos) {
285 target_frame = max_framepos;
288 /* Some (all?) MTC/MMC devices do not send a full MTC frame
289 at the end of a locate, instead sending only an MMC
290 locate command. This causes the current position
291 of an MTC slave to become out of date. Catch this.
294 MTC_Slave* mtcs = dynamic_cast<MTC_Slave*> (_slave);
297 // cerr << "Locate *with* MTC slave\n";
298 mtcs->handle_locate (mmc_tc);
300 // cerr << "Locate without MTC slave\n";
301 request_locate (target_frame, false);
306 Session::mmc_shuttle (MIDI::MachineControl &/*mmc*/, float speed, bool forw)
308 if (!Config->get_mmc_control ()) {
312 if (Config->get_shuttle_speed_threshold() >= 0 && speed > Config->get_shuttle_speed_threshold()) {
313 speed *= Config->get_shuttle_speed_factor();
317 request_transport_speed_nonzero (speed);
319 request_transport_speed_nonzero (-speed);
324 Session::mmc_record_enable (MIDI::MachineControl &mmc, size_t trk, bool enabled)
326 if (!Config->get_mmc_control ()) {
330 RouteList::iterator i;
331 boost::shared_ptr<RouteList> r = routes.reader();
333 for (i = r->begin(); i != r->end(); ++i) {
336 if ((at = dynamic_cast<AudioTrack*>((*i).get())) != 0) {
337 if (trk == at->remote_control_id()) {
338 at->set_record_enabled (enabled, &mmc);
345 /** Send MTC Full Frame message (complete Timecode time) for the start of this cycle.
346 * This resets the MTC code, the next quarter frame message that is sent will be
347 * the first one with the beginning of this cycle as the new start point.
348 * @param t time to send.
351 Session::send_full_time_code (framepos_t const t, MIDI::pframes_t nframes)
353 /* This function could easily send at a given frame offset, but would
354 * that be useful? Does ardour do sub-block accurate locating? [DR] */
357 Timecode::Time timecode;
359 _send_timecode_update = false;
361 if (_engine.freewheeling() || !Config->get_send_mtc()) {
364 if (_slave && !_slave->locked()) {
368 // Get timecode time for the given time
369 sample_to_timecode (t, timecode, true /* use_offset */, false /* no subframes */);
371 // sample-align outbound to rounded (no subframes) timecode
373 timecode_to_sample(timecode, mtc_tc, true, false);
374 outbound_mtc_timecode_frame = mtc_tc;
376 transmitting_timecode_time = timecode;
378 double const quarter_frame_duration = ((framecnt_t) _frames_per_timecode_frame) / 4.0;
379 if (ceil((t - mtc_tc) / quarter_frame_duration) > 0) {
380 Timecode::increment (transmitting_timecode_time, config.get_subframes_per_frame());
381 outbound_mtc_timecode_frame += _frames_per_timecode_frame;
384 DEBUG_TRACE (DEBUG::MTC, string_compose ("Full MTC TC %1\n", outbound_mtc_timecode_frame));
386 // I don't understand this bit yet.. [DR]
388 // according to MTC spec 24, 30 drop and 30 non-drop TC, the frame-number represented by 8 quarter frames must be even.
389 if (((mtc_timecode_bits >> 5) != MIDI::MTC_25_FPS) && (transmitting_timecode_time.frames % 2)) {
390 // start MTC quarter frame transmission on an even frame
391 Timecode::increment (transmitting_timecode_time, config.get_subframes_per_frame());
392 outbound_mtc_timecode_frame += _frames_per_timecode_frame;
395 #if 0 // compensate for audio latency -- disabled [rg]
396 /* this needs more thought and work.
397 * the proper solution will be to just offset MTC by the MIDI port's latency.
399 * using worst_playback_latency() is wrong when the generated MTC is used to sync
400 * clients which send audio to Ardour for recording.
401 * worst_capture_latency() vs. worst_playback_latency()
403 * NB. similarly to session_ltc, the offset should be subtracted from the timecode to send,
404 * instead of being added to timestamp when to send the timecode.
405 * Otherwise the timestamp may not fall into the jack-cycle of the current _transport frame.
406 * and no MTC QF will be sent.
408 outbound_mtc_timecode_frame += worst_playback_latency();
410 next_quarter_frame_to_send = 0;
412 // Sync slave to the same Timecode time as we are on
420 msg[5] = mtc_timecode_bits | timecode.hours;
421 msg[6] = timecode.minutes;
422 msg[7] = timecode.seconds;
423 msg[8] = timecode.frames;
425 // Send message at offset 0, sent time is for the start of this cycle
427 MidiBuffer& mb (_midi_ports->mtc_output_port()->get_midi_buffer (nframes));
428 mb.push_back (0, sizeof (msg), msg);
430 _pframes_since_last_mtc = 0;
434 /** Send MTC (quarter-frame) messages for this cycle.
435 * Must be called exactly once per cycle from the process thread. Realtime safe.
436 * This function assumes the state of full Timecode is sane, eg. the slave is
437 * expecting quarter frame messages and has the right frame of reference (any
438 * full MTC Timecode time messages that needed to be sent should have been sent
439 * earlier already this cycle by send_full_time_code)
442 Session::send_midi_time_code_for_cycle (framepos_t start_frame, framepos_t end_frame, ARDOUR::pframes_t nframes)
444 if (_engine.freewheeling() || !_send_qf_mtc || transmitting_timecode_time.negative || (next_quarter_frame_to_send < 0)) {
445 // cerr << "(MTC) Not sending MTC\n";
448 if (_slave && !_slave->locked()) {
452 /* MTC is max. 30 fps - assert() below will fail
453 * TODO actually limit it to 24,25,29df,30fps
454 * talk to oofus, first.
456 if (Timecode::timecode_to_frames_per_second(config.get_timecode_format()) > 30) {
460 assert (next_quarter_frame_to_send >= 0);
461 assert (next_quarter_frame_to_send <= 7);
463 /* Duration of one quarter frame */
464 double const quarter_frame_duration = _frames_per_timecode_frame / 4.0;
466 DEBUG_TRACE (DEBUG::MTC, string_compose ("TF %1 SF %2 MT %3 QF %4 QD %5\n",
467 _transport_frame, start_frame, outbound_mtc_timecode_frame,
468 next_quarter_frame_to_send, quarter_frame_duration));
470 if (rint(outbound_mtc_timecode_frame + (next_quarter_frame_to_send * quarter_frame_duration)) < _transport_frame) {
471 send_full_time_code (_transport_frame, nframes);
475 /* Send quarter frames for this cycle */
476 while (end_frame > rint(outbound_mtc_timecode_frame + (next_quarter_frame_to_send * quarter_frame_duration))) {
478 DEBUG_TRACE (DEBUG::MTC, string_compose ("next frame to send: %1\n", next_quarter_frame_to_send));
480 switch (next_quarter_frame_to_send) {
482 mtc_msg[1] = 0x00 | (transmitting_timecode_time.frames & 0xf);
485 mtc_msg[1] = 0x10 | ((transmitting_timecode_time.frames & 0xf0) >> 4);
488 mtc_msg[1] = 0x20 | (transmitting_timecode_time.seconds & 0xf);
491 mtc_msg[1] = 0x30 | ((transmitting_timecode_time.seconds & 0xf0) >> 4);
494 mtc_msg[1] = 0x40 | (transmitting_timecode_time.minutes & 0xf);
497 mtc_msg[1] = 0x50 | ((transmitting_timecode_time.minutes & 0xf0) >> 4);
500 mtc_msg[1] = 0x60 | ((mtc_timecode_bits | transmitting_timecode_time.hours) & 0xf);
503 mtc_msg[1] = 0x70 | (((mtc_timecode_bits | transmitting_timecode_time.hours) & 0xf0) >> 4);
507 const framepos_t msg_time = rint(outbound_mtc_timecode_frame + (quarter_frame_duration * next_quarter_frame_to_send));
509 // This message must fall within this block or something is broken
510 assert (msg_time >= start_frame);
511 assert (msg_time < end_frame);
513 /* convert from session frames back to JACK frames using the transport speed */
514 ARDOUR::pframes_t const out_stamp = (msg_time - start_frame) / _transport_speed;
515 assert (out_stamp < nframes);
517 MidiBuffer& mb (_midi_ports->mtc_output_port()->get_midi_buffer(nframes));
518 if (!mb.push_back (out_stamp, 2, mtc_msg)) {
519 error << string_compose(_("Session: cannot send quarter-frame MTC message (%1)"), strerror (errno))
526 DEBUG_STR_APPEND(foo,"sending ");
527 DEBUG_STR_APPEND(foo, transmitting_timecode_time);
528 DEBUG_TRACE (DEBUG::MTC, string_compose ("%1 qfm = %2, stamp = %3\n", DEBUG_STR(foo).str(), next_quarter_frame_to_send,
532 // Increment quarter frame counter
533 next_quarter_frame_to_send++;
535 if (next_quarter_frame_to_send >= 8) {
536 // Wrap quarter frame counter
537 next_quarter_frame_to_send = 0;
538 // Increment timecode time twice
539 Timecode::increment (transmitting_timecode_time, config.get_subframes_per_frame());
540 Timecode::increment (transmitting_timecode_time, config.get_subframes_per_frame());
541 // Re-calculate timing of first quarter frame
542 //timecode_to_sample( transmitting_timecode_time, outbound_mtc_timecode_frame, true /* use_offset */, false );
543 outbound_mtc_timecode_frame += 2.0 * _frames_per_timecode_frame;
550 /***********************************************************************
552 **********************************************************************/
556 Session::mmc_step_timeout ()
561 gettimeofday (&now, 0);
563 timersub (&now, &last_mmc_step, &diff);
564 diff_usecs = diff.tv_sec * 1000000 + diff.tv_usec;
566 if (diff_usecs > 1000000.0 || fabs (_transport_speed) < 0.0000001) {
567 /* too long or too slow, stop transport */
568 request_transport_speed (0.0);
573 if (diff_usecs < 250000.0) {
574 /* too short, just keep going */
580 request_transport_speed_nonzero (_transport_speed * 0.75);
584 /***********************************************************************
585 OUTBOUND SYSTEM COMMON STUFF
586 **********************************************************************/
590 Session::send_song_position_pointer (framepos_t)
593 /* Do nothing for the moment */
598 Session::start_midi_thread ()
600 midi_control_ui = new MidiControlUI (*this);
601 midi_control_ui->run ();
606 Session::midi_input_port () const
608 return _midi_ports->midi_input_port ();
611 Session::midi_output_port () const
613 return _midi_ports->midi_output_port ();
615 boost::shared_ptr<MidiPort>
616 Session::midi_clock_output_port () const
618 return _midi_ports->midi_clock_output_port ();
620 boost::shared_ptr<MidiPort>
621 Session::midi_clock_input_port () const
623 return _midi_ports->midi_clock_input_port ();
625 boost::shared_ptr<MidiPort>
626 Session::mtc_output_port () const
628 return _midi_ports->mtc_output_port ();
630 boost::shared_ptr<MidiPort>
631 Session::mtc_input_port () const
633 return _midi_ports->mtc_input_port ();
637 Session::mmc_output_port () const
639 return _midi_ports->mmc_output_port ();
643 Session::mmc_input_port () const
645 return _midi_ports->mmc_input_port ();