3 Copyright (C) 1999-2002 Paul Davis
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.
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.
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.
29 #include <boost/shared_ptr.hpp>
31 #include <glibmm/main.h>
33 #include "midi++/mmc.h"
34 #include "midi++/port.h"
35 #include "midi++/manager.h"
36 #include "pbd/error.h"
37 #include "pbd/pthread_utils.h"
39 #include "ardour/configuration.h"
40 #include "ardour/debug.h"
41 #include "ardour/audioengine.h"
42 #include "ardour/session.h"
43 #include "ardour/audio_track.h"
44 #include "ardour/midi_track.h"
45 #include "ardour/midi_ui.h"
46 #include "ardour/audio_diskstream.h"
47 #include "ardour/slave.h"
48 #include "ardour/cycles.h"
49 #include "ardour/timecode.h"
54 using namespace ARDOUR;
63 boost::shared_ptr<RouteList> r = routes.reader ();
65 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
66 MidiTrack *track = dynamic_cast<MidiTrack*>((*i).get());
75 Session::use_config_midi_ports ()
79 if (default_mtc_port) {
80 set_mtc_port (default_mtc_port->name());
85 if (default_midi_port) {
86 set_midi_port (default_midi_port->name());
91 if (default_midi_clock_port) {
92 set_midi_clock_port (default_midi_clock_port->name());
94 set_midi_clock_port ("");
101 /***********************************************************************
103 **********************************************************************/
106 Session::set_mtc_port (string port_tag)
110 if (port_tag.length() == 0) {
112 if (_slave && ((ms = dynamic_cast<MTC_Slave*> (_slave)) != 0)) {
113 error << string_compose (_("%1 is slaved to MTC - port cannot be reset"), PROGRAM_NAME) << endmsg;
117 if (_mtc_port == 0) {
127 if ((port = MIDI::Manager::instance()->port (port_tag)) == 0) {
128 error << string_compose (_("unknown port %1 requested for MTC"), port_tag) << endl;
134 if (_slave && ((ms = dynamic_cast<MTC_Slave*> (_slave)) != 0)) {
138 Config->set_mtc_port_name (port_tag);
141 MTC_PortChanged(); /* EMIT SIGNAL */
147 Session::set_midi_port (string /*port_tag*/)
150 if (port_tag.length() == 0) {
151 if (_midi_port == 0) {
160 if ((port = MIDI::Manager::instance()->port (port_tag)) == 0) {
166 /* XXX need something to forward this to control protocols ? or just
170 Config->set_midi_port_name (port_tag);
174 MIDI_PortChanged(); /* EMIT SIGNAL */
180 Session::set_midi_clock_port (string port_tag)
184 if (port_tag.length() == 0) {
186 if (_slave && ((ms = dynamic_cast<MIDIClock_Slave*> (_slave)) != 0)) {
187 error << string_compose (_("%1 is slaved to MIDI Clock - port cannot be reset"), PROGRAM_NAME) << endmsg;
191 if (_midi_clock_port == 0) {
195 _midi_clock_port = 0;
201 if ((port = MIDI::Manager::instance()->port (port_tag)) == 0) {
202 error << string_compose (_("unknown port %1 requested for MIDI Clock"), port_tag) << endl;
206 _midi_clock_port = port;
208 if (_slave && ((ms = dynamic_cast<MIDIClock_Slave*> (_slave)) != 0)) {
212 Config->set_midi_clock_port_name (port_tag);
215 MIDIClock_PortChanged(); /* EMIT SIGNAL */
221 Session::set_trace_midi_input (bool yn, MIDI::Port* port)
223 MIDI::Parser* input_parser;
225 cerr << "enabling tracing: " << yn << " for input port " << port->name() << endl;
228 if ((input_parser = port->input()) != 0) {
229 input_parser->trace (yn, &cout, "input: ");
234 if ((input_parser = _mmc->port()->input()) != 0) {
235 input_parser->trace (yn, &cout, "input: ");
239 if (_mtc_port && _mtc_port != _mmc->port()) {
240 if ((input_parser = _mtc_port->input()) != 0) {
241 input_parser->trace (yn, &cout, "input: ");
245 if (_midi_port && _midi_port != _mmc->port() && _midi_port != _mtc_port ) {
246 if ((input_parser = _midi_port->input()) != 0) {
247 input_parser->trace (yn, &cout, "input: ");
252 && _midi_clock_port != _mmc->port()
253 && _midi_clock_port != _mtc_port
254 && _midi_clock_port != _midi_port) {
255 if ((input_parser = _midi_clock_port->input()) != 0) {
256 input_parser->trace (yn, &cout, "input: ");
261 Config->set_trace_midi_input (yn);
265 Session::set_trace_midi_output (bool yn, MIDI::Port* port)
267 MIDI::Parser* output_parser;
270 if ((output_parser = port->output()) != 0) {
271 output_parser->trace (yn, &cout, "output: ");
275 if ((output_parser = _mmc->port()->output()) != 0) {
276 output_parser->trace (yn, &cout, "output: ");
280 if (_mtc_port && _mtc_port != _mmc->port()) {
281 if ((output_parser = _mtc_port->output()) != 0) {
282 output_parser->trace (yn, &cout, "output: ");
286 if (_midi_port && _midi_port != _mmc->port() && _midi_port != _mtc_port ) {
287 if ((output_parser = _midi_port->output()) != 0) {
288 output_parser->trace (yn, &cout, "output: ");
294 Config->set_trace_midi_output (yn);
298 Session::get_trace_midi_input(MIDI::Port *port)
300 MIDI::Parser* input_parser;
302 if ((input_parser = port->input()) != 0) {
303 return input_parser->tracing();
308 if ((input_parser = _mmc->port()->input()) != 0) {
309 return input_parser->tracing();
314 if ((input_parser = _mtc_port->input()) != 0) {
315 return input_parser->tracing();
320 if ((input_parser = _midi_port->input()) != 0) {
321 return input_parser->tracing();
330 Session::get_trace_midi_output(MIDI::Port *port)
332 MIDI::Parser* output_parser;
334 if ((output_parser = port->output()) != 0) {
335 return output_parser->tracing();
340 if ((output_parser = _mmc->port()->output()) != 0) {
341 return output_parser->tracing();
346 if ((output_parser = _mtc_port->output()) != 0) {
347 return output_parser->tracing();
352 if ((output_parser = _midi_port->output()) != 0) {
353 return output_parser->tracing();
363 Session::setup_midi_control ()
365 outbound_mtc_timecode_frame = 0;
366 next_quarter_frame_to_send = 0;
368 /* Set up the qtr frame message */
381 Session::spp_start (Parser &, nframes_t /*timestamp*/)
383 if (Config->get_mmc_control() && (!config.get_external_sync() || config.get_sync_source() != JACK)) {
384 request_transport_speed (1.0);
389 Session::spp_continue (Parser& ignored, nframes_t timestamp)
391 spp_start (ignored, timestamp);
395 Session::spp_stop (Parser&, nframes_t /*timestamp*/)
397 if (Config->get_mmc_control()) {
403 Session::mmc_deferred_play (MIDI::MachineControl &/*mmc*/)
405 if (Config->get_mmc_control() && (!config.get_external_sync() || (config.get_sync_source() != JACK))) {
406 request_transport_speed (1.0);
411 Session::mmc_record_pause (MIDI::MachineControl &/*mmc*/)
413 if (Config->get_mmc_control()) {
414 maybe_enable_record();
419 Session::mmc_record_strobe (MIDI::MachineControl &/*mmc*/)
421 if (!Config->get_mmc_control())
424 /* record strobe does an implicit "Play" command */
426 if (_transport_speed != 1.0) {
428 /* start_transport() will move from Enabled->Recording, so we
429 don't need to do anything here except enable recording.
430 its not the same as maybe_enable_record() though, because
431 that *can* switch to Recording, which we do not want.
434 save_state ("", true);
435 g_atomic_int_set (&_record_status, Enabled);
436 RecordStateChanged (); /* EMIT SIGNAL */
438 request_transport_speed (1.0);
447 Session::mmc_record_exit (MIDI::MachineControl &/*mmc*/)
449 if (Config->get_mmc_control()) {
450 disable_record (false);
455 Session::mmc_stop (MIDI::MachineControl &/*mmc*/)
457 if (Config->get_mmc_control()) {
463 Session::mmc_pause (MIDI::MachineControl &/*mmc*/)
465 if (Config->get_mmc_control()) {
467 /* We support RECORD_PAUSE, so the spec says that
468 we must interpret PAUSE like RECORD_PAUSE if
472 if (actively_recording()) {
473 maybe_enable_record ();
480 static bool step_queued = false;
483 Session::mmc_step (MIDI::MachineControl &/*mmc*/, int steps)
485 if (!Config->get_mmc_control()) {
490 struct timeval diff = { 0, 0 };
492 gettimeofday (&now, 0);
494 timersub (&now, &last_mmc_step, &diff);
496 gettimeofday (&now, 0);
497 timersub (&now, &last_mmc_step, &diff);
499 if (last_mmc_step.tv_sec != 0 && (diff.tv_usec + (diff.tv_sec * 1000000)) < _engine.usecs_per_cycle()) {
503 double diff_secs = diff.tv_sec + (diff.tv_usec / 1000000.0);
504 double cur_speed = (((steps * 0.5) * timecode_frames_per_second()) / diff_secs) / timecode_frames_per_second();
506 if (_transport_speed == 0 || cur_speed * _transport_speed < 0) {
507 /* change direction */
508 step_speed = cur_speed;
510 step_speed = (0.6 * step_speed) + (0.4 * cur_speed);
516 cerr << "delta = " << diff_secs
517 << " ct = " << _transport_speed
518 << " steps = " << steps
519 << " new speed = " << cur_speed
520 << " speed = " << step_speed
524 request_transport_speed (step_speed);
528 if (midi_control_ui) {
529 RefPtr<TimeoutSource> tsrc = TimeoutSource::create (100);
530 tsrc->connect (sigc::mem_fun (*this, &Session::mmc_step_timeout));
531 tsrc->attach (midi_control_ui->main_loop()->get_context());
538 Session::mmc_rewind (MIDI::MachineControl &/*mmc*/)
540 if (Config->get_mmc_control()) {
541 request_transport_speed(-8.0f);
546 Session::mmc_fast_forward (MIDI::MachineControl &/*mmc*/)
548 if (Config->get_mmc_control()) {
549 request_transport_speed(8.0f);
554 Session::mmc_locate (MIDI::MachineControl &/*mmc*/, const MIDI::byte* mmc_tc)
556 if (!Config->get_mmc_control()) {
560 nframes_t target_frame;
561 Timecode::Time timecode;
563 timecode.hours = mmc_tc[0] & 0xf;
564 timecode.minutes = mmc_tc[1];
565 timecode.seconds = mmc_tc[2];
566 timecode.frames = mmc_tc[3];
567 timecode.rate = timecode_frames_per_second();
568 timecode.drop = timecode_drop_frames();
570 // Also takes timecode offset into account:
571 timecode_to_sample( timecode, target_frame, true /* use_offset */, false /* use_subframes */ );
573 if (target_frame > max_frames) {
574 target_frame = max_frames;
577 /* Some (all?) MTC/MMC devices do not send a full MTC frame
578 at the end of a locate, instead sending only an MMC
579 locate command. This causes the current position
580 of an MTC slave to become out of date. Catch this.
583 MTC_Slave* mtcs = dynamic_cast<MTC_Slave*> (_slave);
586 // cerr << "Locate *with* MTC slave\n";
587 mtcs->handle_locate (mmc_tc);
589 // cerr << "Locate without MTC slave\n";
590 request_locate (target_frame, false);
595 Session::mmc_shuttle (MIDI::MachineControl &/*mmc*/, float speed, bool forw)
597 if (!Config->get_mmc_control()) {
601 if (Config->get_shuttle_speed_threshold() >= 0 && speed > Config->get_shuttle_speed_threshold()) {
602 speed *= Config->get_shuttle_speed_factor();
606 request_transport_speed (speed);
608 request_transport_speed (-speed);
613 Session::mmc_record_enable (MIDI::MachineControl &mmc, size_t trk, bool enabled)
615 if (Config->get_mmc_control()) {
617 RouteList::iterator i;
618 boost::shared_ptr<RouteList> r = routes.reader();
620 for (i = r->begin(); i != r->end(); ++i) {
623 if ((at = dynamic_cast<AudioTrack*>((*i).get())) != 0) {
624 if (trk == at->remote_control_id()) {
625 at->set_record_enable (enabled, &mmc);
633 /** Send MTC Full Frame message (complete Timecode time) for the start of this cycle.
634 * This resets the MTC code, the next quarter frame message that is sent will be
635 * the first one with the beginning of this cycle as the new start point.
638 Session::send_full_time_code(nframes_t /*nframes*/)
640 /* This function could easily send at a given frame offset, but would
641 * that be useful? Does ardour do sub-block accurate locating? [DR] */
644 Timecode::Time timecode;
646 _send_timecode_update = false;
648 if (_mtc_port == 0 || !session_send_mtc || _slave) {
652 // Get timecode time for this transport frame
653 sample_to_timecode(_transport_frame, timecode, true /* use_offset */, false /* no subframes */);
655 transmitting_timecode_time = timecode;
656 outbound_mtc_timecode_frame = _transport_frame;
658 // I don't understand this bit yet.. [DR]
659 if (((mtc_timecode_bits >> 5) != MIDI::MTC_25_FPS) && (transmitting_timecode_time.frames % 2)) {
660 // start MTC quarter frame transmission on an even frame
661 Timecode::increment (transmitting_timecode_time, config.get_subframes_per_frame());
662 outbound_mtc_timecode_frame += (nframes_t) _frames_per_timecode_frame;
665 // Compensate for audio latency
666 outbound_mtc_timecode_frame += _worst_output_latency;
667 next_quarter_frame_to_send = 0;
669 // Sync slave to the same Timecode time as we are on
677 msg[5] = mtc_timecode_bits | timecode.hours;
678 msg[6] = timecode.minutes;
679 msg[7] = timecode.seconds;
680 msg[8] = timecode.frames;
682 // Send message at offset 0, sent time is for the start of this cycle
683 if (_mtc_port->midimsg (msg, sizeof (msg), 0)) {
684 error << _("Session: could not send full MIDI time code") << endmsg;
691 /** Send MTC (quarter-frame) messages for this cycle.
692 * Must be called exactly once per cycle from the audio thread. Realtime safe.
693 * This function assumes the state of full Timecode is sane, eg. the slave is
694 * expecting quarter frame messages and has the right frame of reference (any
695 * full MTC Timecode time messages that needed to be sent should have been sent
696 * earlier already this cycle by send_full_time_code)
699 Session::send_midi_time_code_for_cycle(nframes_t nframes)
701 if (_mtc_port == 0 || _slave || !session_send_mtc || transmitting_timecode_time.negative || (next_quarter_frame_to_send < 0)) {
702 // cerr << "(MTC) Not sending MTC\n";
706 assert (next_quarter_frame_to_send >= 0);
707 assert (next_quarter_frame_to_send <= 7);
709 /* Duration of one quarter frame */
710 nframes_t quarter_frame_duration = ((long) _frames_per_timecode_frame) >> 2;
712 DEBUG_TRACE (DEBUG::MTC, string_compose ("TF %1 SF %2 NQ %3 FD %4\n", _transport_frame, outbound_mtc_timecode_frame,
713 next_quarter_frame_to_send, quarter_frame_duration));
715 assert((outbound_mtc_timecode_frame + (next_quarter_frame_to_send * quarter_frame_duration))
716 >= _transport_frame);
719 // Send quarter frames for this cycle
720 while (_transport_frame + nframes > (outbound_mtc_timecode_frame +
721 (next_quarter_frame_to_send * quarter_frame_duration))) {
723 DEBUG_TRACE (DEBUG::MTC, string_compose ("next frame to send: %1\n", next_quarter_frame_to_send));
725 switch (next_quarter_frame_to_send) {
727 mtc_msg[1] = 0x00 | (transmitting_timecode_time.frames & 0xf);
730 mtc_msg[1] = 0x10 | ((transmitting_timecode_time.frames & 0xf0) >> 4);
733 mtc_msg[1] = 0x20 | (transmitting_timecode_time.seconds & 0xf);
736 mtc_msg[1] = 0x30 | ((transmitting_timecode_time.seconds & 0xf0) >> 4);
739 mtc_msg[1] = 0x40 | (transmitting_timecode_time.minutes & 0xf);
742 mtc_msg[1] = 0x50 | ((transmitting_timecode_time.minutes & 0xf0) >> 4);
745 mtc_msg[1] = 0x60 | ((mtc_timecode_bits|transmitting_timecode_time.hours) & 0xf);
748 mtc_msg[1] = 0x70 | (((mtc_timecode_bits|transmitting_timecode_time.hours) & 0xf0) >> 4);
752 const nframes_t msg_time = (outbound_mtc_timecode_frame
753 + (quarter_frame_duration * next_quarter_frame_to_send));
755 // This message must fall within this block or something is broken
756 assert(msg_time >= _transport_frame);
757 assert(msg_time < _transport_frame + nframes);
759 nframes_t out_stamp = msg_time - _transport_frame;
760 assert(out_stamp < nframes);
762 if (_mtc_port->midimsg (mtc_msg, 2, out_stamp)) {
763 error << string_compose(_("Session: cannot send quarter-frame MTC message (%1)"), strerror (errno))
770 DEBUG_STR_APPEND(foo,"sending ");
771 DEBUG_STR_APPEND(foo, transmitting_timecode_time);
772 DEBUG_TRACE (DEBUG::MTC, string_compose ("%1 qfm = %2, stamp = %3\n", DEBUG_STR(foo).str(), next_quarter_frame_to_send,
776 // Increment quarter frame counter
777 next_quarter_frame_to_send++;
779 if (next_quarter_frame_to_send >= 8) {
780 // Wrap quarter frame counter
781 next_quarter_frame_to_send = 0;
782 // Increment timecode time twice
783 Timecode::increment( transmitting_timecode_time, config.get_subframes_per_frame() );
784 Timecode::increment( transmitting_timecode_time, config.get_subframes_per_frame() );
785 // Re-calculate timing of first quarter frame
786 //timecode_to_sample( transmitting_timecode_time, outbound_mtc_timecode_frame, true /* use_offset */, false );
787 outbound_mtc_timecode_frame += 8 * quarter_frame_duration;
794 /***********************************************************************
796 **********************************************************************/
800 Session::mmc_step_timeout ()
805 gettimeofday (&now, 0);
807 timersub (&now, &last_mmc_step, &diff);
808 diff_usecs = diff.tv_sec * 1000000 + diff.tv_usec;
810 if (diff_usecs > 1000000.0 || fabs (_transport_speed) < 0.0000001) {
811 /* too long or too slow, stop transport */
812 request_transport_speed (0.0);
817 if (diff_usecs < 250000.0) {
818 /* too short, just keep going */
824 request_transport_speed (_transport_speed * 0.75);
828 /*---------------------------------------------------------------------------
830 ---------------------------------------------------------------------------*/
833 Session::start_midi_thread ()
835 midi_control_ui = new MidiControlUI (*this);
836 midi_control_ui->run ();
841 Session::terminate_midi_thread ()
843 if (midi_control_ui) {
844 midi_control_ui->quit ();