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 #include <fcntl.h>
  26 #include <poll.h>
  27
  28 #include <boost/shared_ptr.hpp>
  29
  30 #include <glibmm/main.h>
  31
  32 #include "midi++/mmc.h"
  33 #include "midi++/port.h"
  34 #include "midi++/manager.h"
  35 #include "pbd/error.h"
  36 #include "pbd/pthread_utils.h"
  37
  38 #include "ardour/configuration.h"
  39 #include "ardour/debug.h"
  40 #include "ardour/audioengine.h"
  41 #include "ardour/session.h"
  42 #include "ardour/audio_track.h"
  43 #include "ardour/midi_track.h"
  44 #include "ardour/midi_ui.h"
  45 #include "ardour/audio_diskstream.h"
  46 #include "ardour/slave.h"
  47 #include "ardour/cycles.h"
  48 #include "ardour/timecode.h"
  49
  50 #include "i18n.h"
  51
  52 using namespace std;
  53 using namespace ARDOUR;
  54 using namespace PBD;
  55 using namespace MIDI;
  56 using namespace Glib;
  57
  58 void
  59 Session::midi_panic()
  60 {
  61         {
  62                 boost::shared_ptr<RouteList> r = routes.reader ();
  63
  64                 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
  65                         MidiTrack *track = dynamic_cast<MidiTrack*>((*i).get());
  66                         if (track != 0) {
  67                                 track->midi_panic();
  68                         }
  69                 }
  70         }
  71 }
  72
  73 void
  74 Session::setup_midi_control ()
  75 {
  76         outbound_mtc_timecode_frame = 0;
  77         next_quarter_frame_to_send = 0;
  78
  79         /* Set up the qtr frame message */
  80
  81         mtc_msg[0] = 0xf1;
  82         mtc_msg[2] = 0xf1;
  83         mtc_msg[4] = 0xf1;
  84         mtc_msg[6] = 0xf1;
  85         mtc_msg[8] = 0xf1;
  86         mtc_msg[10] = 0xf1;
  87         mtc_msg[12] = 0xf1;
  88         mtc_msg[14] = 0xf1;
  89 }
  90
  91 void
  92 Session::spp_start (Parser &, framepos_t /*timestamp*/)
  93 {
  94         if (Config->get_mmc_control() && (!config.get_external_sync() || config.get_sync_source() != JACK)) {
  95                 request_transport_speed (1.0);
  96         }
  97 }
  98
  99 void
 100 Session::spp_continue (Parser& ignored, framepos_t timestamp)
 101 {
 102         spp_start (ignored, timestamp);
 103 }
 104
 105 void
 106 Session::spp_stop (Parser&, framepos_t /*timestamp*/)
 107 {
 108         if (Config->get_mmc_control()) {
 109                 request_stop ();
 110         }
 111 }
 112
 113 void
 114 Session::mmc_deferred_play (MIDI::MachineControl &/*mmc*/)
 115 {
 116         if (Config->get_mmc_control() && (!config.get_external_sync() || (config.get_sync_source() != JACK))) {
 117                 request_transport_speed (1.0);
 118         }
 119 }
 120
 121 void
 122 Session::mmc_record_pause (MIDI::MachineControl &/*mmc*/)
 123 {
 124         if (Config->get_mmc_control()) {
 125                 maybe_enable_record();
 126         }
 127 }
 128
 129 void
 130 Session::mmc_record_strobe (MIDI::MachineControl &/*mmc*/)
 131 {
 132         if (!Config->get_mmc_control() || (_step_editors > 0)) {
 133                 return;
 134         }
 135
 136         /* record strobe does an implicit "Play" command */
 137
 138         if (_transport_speed != 1.0) {
 139
 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.
 144                 */
 145
 146                 save_state ("", true);
 147                 g_atomic_int_set (&_record_status, Enabled);
 148                 RecordStateChanged (); /* EMIT SIGNAL */
 149
 150                 request_transport_speed (1.0);
 151
 152         } else {
 153
 154                 enable_record ();
 155         }
 156 }
 157
 158 void
 159 Session::mmc_record_exit (MIDI::MachineControl &/*mmc*/)
 160 {
 161         if (Config->get_mmc_control()) {
 162                 disable_record (false);
 163         }
 164 }
 165
 166 void
 167 Session::mmc_stop (MIDI::MachineControl &/*mmc*/)
 168 {
 169         if (Config->get_mmc_control()) {
 170                 request_stop ();
 171         }
 172 }
 173
 174 void
 175 Session::mmc_pause (MIDI::MachineControl &/*mmc*/)
 176 {
 177         if (Config->get_mmc_control()) {
 178
 179                 /* We support RECORD_PAUSE, so the spec says that
 180                    we must interpret PAUSE like RECORD_PAUSE if
 181                    recording.
 182                 */
 183
 184                 if (actively_recording()) {
 185                         maybe_enable_record ();
 186                 } else {
 187                         request_stop ();
 188                 }
 189         }
 190 }
 191
 192 static bool step_queued = false;
 193
 194 void
 195 Session::mmc_step (MIDI::MachineControl &/*mmc*/, int steps)
 196 {
 197         if (!Config->get_mmc_control()) {
 198                 return;
 199         }
 200
 201         struct timeval now;
 202         struct timeval diff = { 0, 0 };
 203
 204         gettimeofday (&now, 0);
 205
 206         timersub (&now, &last_mmc_step, &diff);
 207
 208         gettimeofday (&now, 0);
 209         timersub (&now, &last_mmc_step, &diff);
 210
 211         if (last_mmc_step.tv_sec != 0 && (diff.tv_usec + (diff.tv_sec * 1000000)) < _engine.usecs_per_cycle()) {
 212                 return;
 213         }
 214
 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();
 217
 218         if (_transport_speed == 0 || cur_speed * _transport_speed < 0) {
 219                 /* change direction */
 220                 step_speed = cur_speed;
 221         } else {
 222                 step_speed = (0.6 * step_speed) + (0.4 * cur_speed);
 223         }
 224
 225         step_speed *= 0.25;
 226
 227 #if 0
 228         cerr << "delta = " << diff_secs
 229              << " ct = " << _transport_speed
 230              << " steps = " << steps
 231              << " new speed = " << cur_speed
 232              << " speed = " << step_speed
 233              << endl;
 234 #endif
 235
 236         request_transport_speed (step_speed);
 237         last_mmc_step = now;
 238
 239         if (!step_queued) {
 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());
 244                         step_queued = true;
 245                 }
 246         }
 247 }
 248
 249 void
 250 Session::mmc_rewind (MIDI::MachineControl &/*mmc*/)
 251 {
 252         if (Config->get_mmc_control()) {
 253                 request_transport_speed(-8.0f);
 254         }
 255 }
 256
 257 void
 258 Session::mmc_fast_forward (MIDI::MachineControl &/*mmc*/)
 259 {
 260         if (Config->get_mmc_control()) {
 261                 request_transport_speed(8.0f);
 262         }
 263 }
 264
 265 void
 266 Session::mmc_locate (MIDI::MachineControl &/*mmc*/, const MIDI::byte* mmc_tc)
 267 {
 268         if (!Config->get_mmc_control()) {
 269                 return;
 270         }
 271
 272         framepos_t target_frame;
 273         Timecode::Time timecode;
 274
 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();
 281
 282         // Also takes timecode offset into account:
 283         timecode_to_sample( timecode, target_frame, true /* use_offset */, false /* use_subframes */ );
 284
 285         if (target_frame > max_framepos) {
 286                 target_frame = max_framepos;
 287         }
 288
 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.
 293         */
 294
 295         MTC_Slave* mtcs = dynamic_cast<MTC_Slave*> (_slave);
 296
 297         if (mtcs != 0) {
 298                 // cerr << "Locate *with* MTC slave\n";
 299                 mtcs->handle_locate (mmc_tc);
 300         } else {
 301                 // cerr << "Locate without MTC slave\n";
 302                 request_locate (target_frame, false);
 303         }
 304 }
 305
 306 void
 307 Session::mmc_shuttle (MIDI::MachineControl &/*mmc*/, float speed, bool forw)
 308 {
 309         if (!Config->get_mmc_control()) {
 310                 return;
 311         }
 312
 313         if (Config->get_shuttle_speed_threshold() >= 0 && speed > Config->get_shuttle_speed_threshold()) {
 314                 speed *= Config->get_shuttle_speed_factor();
 315         }
 316
 317         if (forw) {
 318                 request_transport_speed (speed);
 319         } else {
 320                 request_transport_speed (-speed);
 321         }
 322 }
 323
 324 void
 325 Session::mmc_record_enable (MIDI::MachineControl &mmc, size_t trk, bool enabled)
 326 {
 327         if (Config->get_mmc_control()) {
 328
 329                 RouteList::iterator i;
 330                 boost::shared_ptr<RouteList> r = routes.reader();
 331
 332                 for (i = r->begin(); i != r->end(); ++i) {
 333                         AudioTrack *at;
 334
 335                         if ((at = dynamic_cast<AudioTrack*>((*i).get())) != 0) {
 336                                 if (trk == at->remote_control_id()) {
 337                                         at->set_record_enabled (enabled, &mmc);
 338                                         break;
 339                                 }
 340                         }
 341                 }
 342         }
 343 }
 344
 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.
 349  */
 350 int
 351 Session::send_full_time_code (framepos_t const t)
 352 {
 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] */
 355
 356         MIDI::byte msg[10];
 357         Timecode::Time timecode;
 358
 359         _send_timecode_update = false;
 360
 361         if (!session_send_mtc || _slave) {
 362                 return 0;
 363         }
 364
 365         // Get timecode time for the given time
 366         sample_to_timecode (t, timecode, true /* use_offset */, false /* no subframes */);
 367
 368         transmitting_timecode_time = timecode;
 369         outbound_mtc_timecode_frame = t;
 370
 371         // I don't understand this bit yet.. [DR]
 372         if (((mtc_timecode_bits >> 5) != MIDI::MTC_25_FPS) && (transmitting_timecode_time.frames % 2)) {
 373                 // start MTC quarter frame transmission on an even frame
 374                 Timecode::increment (transmitting_timecode_time, config.get_subframes_per_frame());
 375                 outbound_mtc_timecode_frame += _frames_per_timecode_frame;
 376         }
 377
 378         // Compensate for audio latency
 379         outbound_mtc_timecode_frame += _worst_output_latency;
 380         next_quarter_frame_to_send = 0;
 381
 382         // Sync slave to the same Timecode time as we are on
 383         msg[0] = 0xf0;
 384         msg[1] = 0x7f;
 385         msg[2] = 0x7f;
 386         msg[3] = 0x1;
 387         msg[4] = 0x1;
 388         msg[9] = 0xf7;
 389
 390         msg[5] = mtc_timecode_bits | timecode.hours;
 391         msg[6] = timecode.minutes;
 392         msg[7] = timecode.seconds;
 393         msg[8] = timecode.frames;
 394
 395         // Send message at offset 0, sent time is for the start of this cycle
 396         if (MIDI::Manager::instance()->mtc_output_port()->midimsg (msg, sizeof (msg), 0)) {
 397                 error << _("Session: could not send full MIDI time code") << endmsg;
 398                 return -1;
 399         }
 400
 401         return 0;
 402 }
 403
 404 /** Send MTC (quarter-frame) messages for this cycle.
 405  * Must be called exactly once per cycle from the process thread.  Realtime safe.
 406  * This function assumes the state of full Timecode is sane, eg. the slave is
 407  * expecting quarter frame messages and has the right frame of reference (any
 408  * full MTC Timecode time messages that needed to be sent should have been sent
 409  * earlier already this cycle by send_full_time_code)
 410  */
 411 int
 412 Session::send_midi_time_code_for_cycle (pframes_t nframes)
 413 {
 414         if (_slave || !session_send_mtc || transmitting_timecode_time.negative || (next_quarter_frame_to_send < 0)) {
 415                 // cerr << "(MTC) Not sending MTC\n";
 416                 return 0;
 417         }
 418
 419         assert (next_quarter_frame_to_send >= 0);
 420         assert (next_quarter_frame_to_send <= 7);
 421
 422         /* Duration of one quarter frame */
 423         framecnt_t quarter_frame_duration = ((framecnt_t) _frames_per_timecode_frame) >> 2;
 424
 425         DEBUG_TRACE (DEBUG::MTC, string_compose ("TF %1 SF %2 NQ %3 FD %4\n",  _transport_frame, outbound_mtc_timecode_frame,
 426                                                  next_quarter_frame_to_send, quarter_frame_duration));
 427
 428         assert((outbound_mtc_timecode_frame + (next_quarter_frame_to_send * quarter_frame_duration))
 429                         >= _transport_frame);
 430
 431
 432         // Send quarter frames for this cycle
 433         while (_transport_frame + nframes > (outbound_mtc_timecode_frame +
 434                                 (next_quarter_frame_to_send * quarter_frame_duration))) {
 435
 436                 DEBUG_TRACE (DEBUG::MTC, string_compose ("next frame to send: %1\n", next_quarter_frame_to_send));
 437
 438                 switch (next_quarter_frame_to_send) {
 439                         case 0:
 440                                 mtc_msg[1] =  0x00 | (transmitting_timecode_time.frames & 0xf);
 441                                 break;
 442                         case 1:
 443                                 mtc_msg[1] =  0x10 | ((transmitting_timecode_time.frames & 0xf0) >> 4);
 444                                 break;
 445                         case 2:
 446                                 mtc_msg[1] =  0x20 | (transmitting_timecode_time.seconds & 0xf);
 447                                 break;
 448                         case 3:
 449                                 mtc_msg[1] =  0x30 | ((transmitting_timecode_time.seconds & 0xf0) >> 4);
 450                                 break;
 451                         case 4:
 452                                 mtc_msg[1] =  0x40 | (transmitting_timecode_time.minutes & 0xf);
 453                                 break;
 454                         case 5:
 455                                 mtc_msg[1] = 0x50 | ((transmitting_timecode_time.minutes & 0xf0) >> 4);
 456                                 break;
 457                         case 6:
 458                                 mtc_msg[1] = 0x60 | ((mtc_timecode_bits|transmitting_timecode_time.hours) & 0xf);
 459                                 break;
 460                         case 7:
 461                                 mtc_msg[1] = 0x70 | (((mtc_timecode_bits|transmitting_timecode_time.hours) & 0xf0) >> 4);
 462                                 break;
 463                 }
 464
 465                 const framepos_t msg_time = (outbound_mtc_timecode_frame
 466                         + (quarter_frame_duration * next_quarter_frame_to_send));
 467
 468                 // This message must fall within this block or something is broken
 469                 assert(msg_time >= _transport_frame);
 470                 assert(msg_time < _transport_frame + nframes);
 471
 472                 framepos_t out_stamp = msg_time - _transport_frame;
 473                 assert(out_stamp < nframes);
 474
 475                 if (MIDI::Manager::instance()->mtc_output_port()->midimsg (mtc_msg, 2, out_stamp)) {
 476                         error << string_compose(_("Session: cannot send quarter-frame MTC message (%1)"), strerror (errno))
 477                               << endmsg;
 478                         return -1;
 479                 }
 480
 481 #ifndef NDEBUG
 482                 DEBUG_STR_DECL(foo)
 483                 DEBUG_STR_APPEND(foo,"sending ");
 484                 DEBUG_STR_APPEND(foo, transmitting_timecode_time);
 485                 DEBUG_TRACE (DEBUG::MTC, string_compose ("%1 qfm = %2, stamp = %3\n", DEBUG_STR(foo).str(), next_quarter_frame_to_send,
 486                                                          out_stamp));
 487 #endif
 488
 489                 // Increment quarter frame counter
 490                 next_quarter_frame_to_send++;
 491
 492                 if (next_quarter_frame_to_send >= 8) {
 493                         // Wrap quarter frame counter
 494                         next_quarter_frame_to_send = 0;
 495                         // Increment timecode time twice
 496                         Timecode::increment( transmitting_timecode_time, config.get_subframes_per_frame() );
 497                         Timecode::increment( transmitting_timecode_time, config.get_subframes_per_frame() );
 498                         // Re-calculate timing of first quarter frame
 499                         //timecode_to_sample( transmitting_timecode_time, outbound_mtc_timecode_frame, true /* use_offset */, false );
 500                         outbound_mtc_timecode_frame += 8 * quarter_frame_duration;
 501                 }
 502         }
 503
 504         return 0;
 505 }
 506
 507 /***********************************************************************
 508  OUTBOUND MMC STUFF
 509 **********************************************************************/
 510
 511
 512 bool
 513 Session::mmc_step_timeout ()
 514 {
 515         struct timeval now;
 516         struct timeval diff;
 517         double diff_usecs;
 518         gettimeofday (&now, 0);
 519
 520         timersub (&now, &last_mmc_step, &diff);
 521         diff_usecs = diff.tv_sec * 1000000 + diff.tv_usec;
 522
 523         if (diff_usecs > 1000000.0 || fabs (_transport_speed) < 0.0000001) {
 524                 /* too long or too slow, stop transport */
 525                 request_transport_speed (0.0);
 526                 step_queued = false;
 527                 return false;
 528         }
 529
 530         if (diff_usecs < 250000.0) {
 531                 /* too short, just keep going */
 532                 return true;
 533         }
 534
 535         /* slow it down */
 536
 537         request_transport_speed (_transport_speed * 0.75);
 538         return true;
 539 }
 540
 541 /*---------------------------------------------------------------------------
 542   MIDI THREAD
 543   ---------------------------------------------------------------------------*/
 544
 545 int
 546 Session::start_midi_thread ()
 547 {
 548         midi_control_ui = new MidiControlUI (*this);
 549         midi_control_ui->run ();
 550         return 0;
 551 }
 552
 553 void
 554 Session::terminate_midi_thread ()
 555 {
 556         if (midi_control_ui) {
 557                 midi_control_ui->quit ();
 558         }
 559 }
 560
 561