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.
28 #include <boost/shared_ptr.hpp>
30 #include <glibmm/main.h>
32 #include "midi++/mmc.h"
33 #include "midi++/port.h"
35 #include "pbd/error.h"
36 #include "pbd/pthread_utils.h"
38 #include "timecode/time.h"
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/session.h"
47 #include "ardour/slave.h"
48 #include "ardour/ticker.h"
53 using namespace ARDOUR;
62 boost::shared_ptr<RouteList> r = routes.reader ();
64 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
65 MidiTrack *track = dynamic_cast<MidiTrack*>((*i).get());
74 Session::setup_midi_control ()
76 outbound_mtc_timecode_frame = 0;
77 next_quarter_frame_to_send = 0;
79 /* Set up the qtr frame message */
94 if (Config->get_mmc_control ()) {
95 request_transport_speed (1.0);
100 Session::spp_continue ()
108 if (Config->get_mmc_control ()) {
114 Session::mmc_deferred_play (MIDI::MachineControl &/*mmc*/)
116 if (Config->get_mmc_control ()) {
117 request_transport_speed (1.0);
122 Session::mmc_record_pause (MIDI::MachineControl &/*mmc*/)
124 if (Config->get_mmc_control ()) {
125 maybe_enable_record();
130 Session::mmc_record_strobe (MIDI::MachineControl &/*mmc*/)
132 if (!Config->get_mmc_control() || (_step_editors > 0)) {
136 /* record strobe does an implicit "Play" command */
138 if (_transport_speed != 1.0) {
140 /* start_transport() will move from Enabled->Recording, so we
141 don't need to do anything here except enable recording.
142 its not the same as maybe_enable_record() though, because
143 that *can* switch to Recording, which we do not want.
146 save_state ("", true);
147 g_atomic_int_set (&_record_status, Enabled);
148 RecordStateChanged (); /* EMIT SIGNAL */
150 request_transport_speed (1.0);
159 Session::mmc_record_exit (MIDI::MachineControl &/*mmc*/)
161 if (Config->get_mmc_control ()) {
162 disable_record (false);
167 Session::mmc_stop (MIDI::MachineControl &/*mmc*/)
169 if (Config->get_mmc_control ()) {
175 Session::mmc_pause (MIDI::MachineControl &/*mmc*/)
177 if (Config->get_mmc_control ()) {
179 /* We support RECORD_PAUSE, so the spec says that
180 we must interpret PAUSE like RECORD_PAUSE if
184 if (actively_recording()) {
185 maybe_enable_record ();
192 static bool step_queued = false;
195 Session::mmc_step (MIDI::MachineControl &/*mmc*/, int steps)
197 if (!Config->get_mmc_control ()) {
202 struct timeval diff = { 0, 0 };
204 gettimeofday (&now, 0);
206 timersub (&now, &last_mmc_step, &diff);
208 gettimeofday (&now, 0);
209 timersub (&now, &last_mmc_step, &diff);
211 if (last_mmc_step.tv_sec != 0 && (diff.tv_usec + (diff.tv_sec * 1000000)) < _engine.usecs_per_cycle()) {
215 double diff_secs = diff.tv_sec + (diff.tv_usec / 1000000.0);
216 double cur_speed = (((steps * 0.5) * timecode_frames_per_second()) / diff_secs) / timecode_frames_per_second();
218 if (_transport_speed == 0 || cur_speed * _transport_speed < 0) {
219 /* change direction */
220 step_speed = cur_speed;
222 step_speed = (0.6 * step_speed) + (0.4 * cur_speed);
228 cerr << "delta = " << diff_secs
229 << " ct = " << _transport_speed
230 << " steps = " << steps
231 << " new speed = " << cur_speed
232 << " speed = " << step_speed
236 request_transport_speed_nonzero (step_speed);
240 if (midi_control_ui) {
241 RefPtr<TimeoutSource> tsrc = TimeoutSource::create (100);
242 tsrc->connect (sigc::mem_fun (*this, &Session::mmc_step_timeout));
243 tsrc->attach (midi_control_ui->main_loop()->get_context());
250 Session::mmc_rewind (MIDI::MachineControl &/*mmc*/)
252 if (Config->get_mmc_control ()) {
253 request_transport_speed(-8.0f);
258 Session::mmc_fast_forward (MIDI::MachineControl &/*mmc*/)
260 if (Config->get_mmc_control ()) {
261 request_transport_speed(8.0f);
266 Session::mmc_locate (MIDI::MachineControl &/*mmc*/, const MIDI::byte* mmc_tc)
268 if (!Config->get_mmc_control ()) {
272 framepos_t target_frame;
273 Timecode::Time timecode;
275 timecode.hours = mmc_tc[0] & 0xf;
276 timecode.minutes = mmc_tc[1];
277 timecode.seconds = mmc_tc[2];
278 timecode.frames = mmc_tc[3];
279 timecode.rate = timecode_frames_per_second();
280 timecode.drop = timecode_drop_frames();
282 // Also takes timecode offset into account:
283 timecode_to_sample( timecode, target_frame, true /* use_offset */, false /* use_subframes */ );
285 if (target_frame > max_framepos) {
286 target_frame = max_framepos;
289 /* Some (all?) MTC/MMC devices do not send a full MTC frame
290 at the end of a locate, instead sending only an MMC
291 locate command. This causes the current position
292 of an MTC slave to become out of date. Catch this.
295 MTC_Slave* mtcs = dynamic_cast<MTC_Slave*> (_slave);
298 // cerr << "Locate *with* MTC slave\n";
299 mtcs->handle_locate (mmc_tc);
301 // cerr << "Locate without MTC slave\n";
302 request_locate (target_frame, false);
307 Session::mmc_shuttle (MIDI::MachineControl &/*mmc*/, float speed, bool forw)
309 if (!Config->get_mmc_control ()) {
313 if (Config->get_shuttle_speed_threshold() >= 0 && speed > Config->get_shuttle_speed_threshold()) {
314 speed *= Config->get_shuttle_speed_factor();
318 request_transport_speed_nonzero (speed);
320 request_transport_speed_nonzero (-speed);
325 Session::mmc_record_enable (MIDI::MachineControl &mmc, size_t trk, bool enabled)
327 if (!Config->get_mmc_control ()) {
331 RouteList::iterator i;
332 boost::shared_ptr<RouteList> r = routes.reader();
334 for (i = r->begin(); i != r->end(); ++i) {
337 if ((at = dynamic_cast<AudioTrack*>((*i).get())) != 0) {
338 if (trk == at->remote_control_id()) {
339 at->set_record_enabled (enabled, &mmc);
346 /** Send MTC Full Frame message (complete Timecode time) for the start of this cycle.
347 * This resets the MTC code, the next quarter frame message that is sent will be
348 * the first one with the beginning of this cycle as the new start point.
349 * @param t time to send.
352 Session::send_full_time_code (framepos_t const t, pframes_t nframes)
354 /* This function could easily send at a given frame offset, but would
355 * that be useful? Does ardour do sub-block accurate locating? [DR] */
358 Timecode::Time timecode;
360 _send_timecode_update = false;
362 if (_engine.freewheeling() || !Config->get_send_mtc()) {
365 if (_slave && !_slave->locked()) {
369 // Get timecode time for the given time
370 sample_to_timecode (t, timecode, true /* use_offset */, false /* no subframes */);
372 // sample-align outbound to rounded (no subframes) timecode
374 timecode_to_sample(timecode, mtc_tc, true, false);
375 outbound_mtc_timecode_frame = mtc_tc;
377 transmitting_timecode_time = timecode;
379 double const quarter_frame_duration = ((framecnt_t) _frames_per_timecode_frame) / 4.0;
380 if (ceil((t - mtc_tc) / quarter_frame_duration) > 0) {
381 Timecode::increment (transmitting_timecode_time, config.get_subframes_per_frame());
382 outbound_mtc_timecode_frame += _frames_per_timecode_frame;
385 DEBUG_TRACE (DEBUG::MTC, string_compose ("Full MTC TC %1\n", outbound_mtc_timecode_frame));
387 // I don't understand this bit yet.. [DR]
389 // according to MTC spec 24, 30 drop and 30 non-drop TC, the frame-number represented by 8 quarter frames must be even.
390 if (((mtc_timecode_bits >> 5) != MIDI::MTC_25_FPS) && (transmitting_timecode_time.frames % 2)) {
391 // start MTC quarter frame transmission on an even frame
392 Timecode::increment (transmitting_timecode_time, config.get_subframes_per_frame());
393 outbound_mtc_timecode_frame += _frames_per_timecode_frame;
396 #if 0 // compensate for audio latency -- disabled [rg]
397 /* this needs more thought and work.
398 * the proper solution will be to just offset MTC by the MIDI port's latency.
400 * using worst_playback_latency() is wrong when the generated MTC is used to sync
401 * clients which send audio to Ardour for recording.
402 * worst_capture_latency() vs. worst_playback_latency()
404 * NB. similarly to session_ltc, the offset should be subtracted from the timecode to send,
405 * instead of being added to timestamp when to send the timecode.
406 * Otherwise the timestamp may not fall into the jack-cycle of the current _transport frame.
407 * and no MTC QF will be sent.
409 outbound_mtc_timecode_frame += worst_playback_latency();
411 next_quarter_frame_to_send = 0;
413 // Sync slave to the same Timecode time as we are on
421 msg[5] = mtc_timecode_bits | timecode.hours;
422 msg[6] = timecode.minutes;
423 msg[7] = timecode.seconds;
424 msg[8] = timecode.frames;
426 // Send message at offset 0, sent time is for the start of this cycle
428 MidiBuffer& mb (_midi_ports->mtc_output_port()->get_midi_buffer (nframes));
429 mb.push_back (0, sizeof (msg), msg);
431 _pframes_since_last_mtc = 0;
435 /** Send MTC (quarter-frame) messages for this cycle.
436 * Must be called exactly once per cycle from the process thread. Realtime safe.
437 * This function assumes the state of full Timecode is sane, eg. the slave is
438 * expecting quarter frame messages and has the right frame of reference (any
439 * full MTC Timecode time messages that needed to be sent should have been sent
440 * earlier already this cycle by send_full_time_code)
443 Session::send_midi_time_code_for_cycle (framepos_t start_frame, framepos_t end_frame, pframes_t nframes)
445 if (_engine.freewheeling() || !_send_qf_mtc || transmitting_timecode_time.negative || (next_quarter_frame_to_send < 0)) {
446 // cerr << "(MTC) Not sending MTC\n";
449 if (_slave && !_slave->locked()) {
453 /* MTC is max. 30 fps - assert() below will fail
454 * TODO actually limit it to 24,25,29df,30fps
455 * talk to oofus, first.
457 if (Timecode::timecode_to_frames_per_second(config.get_timecode_format()) > 30) {
461 assert (next_quarter_frame_to_send >= 0);
462 assert (next_quarter_frame_to_send <= 7);
464 /* Duration of one quarter frame */
465 double const quarter_frame_duration = _frames_per_timecode_frame / 4.0;
467 DEBUG_TRACE (DEBUG::MTC, string_compose ("TF %1 SF %2 MT %3 QF %4 QD %5\n",
468 _transport_frame, start_frame, outbound_mtc_timecode_frame,
469 next_quarter_frame_to_send, quarter_frame_duration));
471 if (rint(outbound_mtc_timecode_frame + (next_quarter_frame_to_send * quarter_frame_duration)) < _transport_frame) {
472 send_full_time_code (_transport_frame, nframes);
476 /* Send quarter frames for this cycle */
477 while (end_frame > rint(outbound_mtc_timecode_frame + (next_quarter_frame_to_send * quarter_frame_duration))) {
479 DEBUG_TRACE (DEBUG::MTC, string_compose ("next frame to send: %1\n", next_quarter_frame_to_send));
481 switch (next_quarter_frame_to_send) {
483 mtc_msg[1] = 0x00 | (transmitting_timecode_time.frames & 0xf);
486 mtc_msg[1] = 0x10 | ((transmitting_timecode_time.frames & 0xf0) >> 4);
489 mtc_msg[1] = 0x20 | (transmitting_timecode_time.seconds & 0xf);
492 mtc_msg[1] = 0x30 | ((transmitting_timecode_time.seconds & 0xf0) >> 4);
495 mtc_msg[1] = 0x40 | (transmitting_timecode_time.minutes & 0xf);
498 mtc_msg[1] = 0x50 | ((transmitting_timecode_time.minutes & 0xf0) >> 4);
501 mtc_msg[1] = 0x60 | ((mtc_timecode_bits | transmitting_timecode_time.hours) & 0xf);
504 mtc_msg[1] = 0x70 | (((mtc_timecode_bits | transmitting_timecode_time.hours) & 0xf0) >> 4);
508 const framepos_t msg_time = rint(outbound_mtc_timecode_frame + (quarter_frame_duration * next_quarter_frame_to_send));
510 // This message must fall within this block or something is broken
511 assert (msg_time >= start_frame);
512 assert (msg_time < end_frame);
514 /* convert from session frames back to JACK frames using the transport speed */
515 pframes_t const out_stamp = (msg_time - start_frame) / _transport_speed;
516 assert (out_stamp < nframes);
518 MidiBuffer& mb (_midi_ports->mtc_output_port()->get_midi_buffer(nframes));
519 if (!mb.push_back (out_stamp, 2, mtc_msg)) {
520 error << string_compose(_("Session: cannot send quarter-frame MTC message (%1)"), strerror (errno))
527 DEBUG_STR_APPEND(foo,"sending ");
528 DEBUG_STR_APPEND(foo, transmitting_timecode_time);
529 DEBUG_TRACE (DEBUG::MTC, string_compose ("%1 qfm = %2, stamp = %3\n", DEBUG_STR(foo).str(), next_quarter_frame_to_send,
533 // Increment quarter frame counter
534 next_quarter_frame_to_send++;
536 if (next_quarter_frame_to_send >= 8) {
537 // Wrap quarter frame counter
538 next_quarter_frame_to_send = 0;
539 // Increment timecode time twice
540 Timecode::increment (transmitting_timecode_time, config.get_subframes_per_frame());
541 Timecode::increment (transmitting_timecode_time, config.get_subframes_per_frame());
542 // Re-calculate timing of first quarter frame
543 //timecode_to_sample( transmitting_timecode_time, outbound_mtc_timecode_frame, true /* use_offset */, false );
544 outbound_mtc_timecode_frame += 2.0 * _frames_per_timecode_frame;
551 /***********************************************************************
553 **********************************************************************/
557 Session::mmc_step_timeout ()
562 gettimeofday (&now, 0);
564 timersub (&now, &last_mmc_step, &diff);
565 diff_usecs = diff.tv_sec * 1000000 + diff.tv_usec;
567 if (diff_usecs > 1000000.0 || fabs (_transport_speed) < 0.0000001) {
568 /* too long or too slow, stop transport */
569 request_transport_speed (0.0);
574 if (diff_usecs < 250000.0) {
575 /* too short, just keep going */
581 request_transport_speed_nonzero (_transport_speed * 0.75);
585 /***********************************************************************
586 OUTBOUND SYSTEM COMMON STUFF
587 **********************************************************************/
591 Session::send_song_position_pointer (framepos_t)
594 /* Do nothing for the moment */
599 Session::start_midi_thread ()
601 midi_control_ui = new MidiControlUI (*this);
602 midi_control_ui->run ();
607 Session::midi_input_port () const
609 return _midi_ports->midi_input_port ();
612 Session::midi_output_port () const
614 return _midi_ports->midi_output_port ();
616 boost::shared_ptr<MidiPort>
617 Session::midi_clock_output_port () const
619 return _midi_ports->midi_clock_output_port ();
621 boost::shared_ptr<MidiPort>
622 Session::midi_clock_input_port () const
624 return _midi_ports->midi_clock_input_port ();
626 boost::shared_ptr<MidiPort>
627 Session::mtc_output_port () const
629 return _midi_ports->mtc_output_port ();
631 boost::shared_ptr<MidiPort>
632 Session::mtc_input_port () const
634 return _midi_ports->mtc_input_port ();
638 Session::mmc_output_port () const
640 return _midi_ports->mmc_output_port ();
644 Session::mmc_input_port () const
646 return _midi_ports->mmc_input_port ();