libs/ardour/session_midi.cc

   1
   2 /*
   3   Copyright (C) 1999-2002 Paul Davis
   4
   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.
   9
  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.
  14
  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.
  18
  19 */
  20
  21 #include <string>
  22 #include <cmath>
  23 #include <cerrno>
  24 #include <cassert>
  25 #include <unistd.h>
  26 #include <fcntl.h>
  27 #include <poll.h>
  28
  29 #include <boost/shared_ptr.hpp>
  30
  31 #include <midi++/mmc.h>
  32 #include <midi++/port.h>
  33 #include <midi++/manager.h>
  34 #include <pbd/error.h>
  35 #include <glibmm/thread.h>
  36 #include <pbd/pthread_utils.h>
  37
  38 #include <ardour/configuration.h>
  39 #include <ardour/audioengine.h>
  40 #include <ardour/session.h>
  41 #include <ardour/audio_track.h>
  42 #include <ardour/midi_track.h>
  43 #include <ardour/audio_diskstream.h>
  44 #include <ardour/slave.h>
  45 #include <ardour/cycles.h>
  46 #include <ardour/smpte.h>
  47
  48 #include "i18n.h"
  49
  50 using namespace std;
  51 using namespace ARDOUR;
  52 using namespace PBD;
  53 using namespace MIDI;
  54
  55 MachineControl::CommandSignature MMC_CommandSignature;
  56 MachineControl::ResponseSignature MMC_ResponseSignature;
  57
  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 int
  75 Session::use_config_midi_ports ()
  76 {
  77         string port_name;
  78
  79         if (default_mmc_port) {
  80                 set_mmc_port (default_mmc_port->name());
  81         } else {
  82                 set_mmc_port ("");
  83         }
  84
  85         if (default_mtc_port) {
  86                 set_mtc_port (default_mtc_port->name());
  87         } else {
  88                 set_mtc_port ("");
  89         }
  90
  91         if (default_midi_port) {
  92                 set_midi_port (default_midi_port->name());
  93         } else {
  94                 set_midi_port ("");
  95         }
  96
  97         if (default_midi_clock_port) {
  98                 set_midi_clock_port (default_midi_clock_port->name());
  99         } else {
 100                 set_midi_clock_port ("");
 101         }
 102
 103         return 0;
 104 }
 105
 106
 107 /***********************************************************************
 108  MTC, MMC, etc.
 109 **********************************************************************/
 110
 111 int
 112 Session::set_mtc_port (string port_tag)
 113 {
 114         MTC_Slave *ms;
 115
 116         if (port_tag.length() == 0) {
 117
 118                 if (_slave && ((ms = dynamic_cast<MTC_Slave*> (_slave)) != 0)) {
 119                         error << _("Ardour is slaved to MTC - port cannot be reset") << endmsg;
 120                         return -1;
 121                 }
 122
 123                 if (_mtc_port == 0) {
 124                         return 0;
 125                 }
 126
 127                 _mtc_port = 0;
 128                 goto out;
 129         }
 130
 131         MIDI::Port* port;
 132
 133         if ((port = MIDI::Manager::instance()->port (port_tag)) == 0) {
 134                 error << string_compose (_("unknown port %1 requested for MTC"), port_tag) << endl;
 135                 return -1;
 136         }
 137
 138         _mtc_port = port;
 139
 140         if (_slave && ((ms = dynamic_cast<MTC_Slave*> (_slave)) != 0)) {
 141                 ms->rebind (*port);
 142         }
 143
 144         Config->set_mtc_port_name (port_tag);
 145
 146   out:
 147         MTC_PortChanged(); /* EMIT SIGNAL */
 148         change_midi_ports ();
 149         set_dirty();
 150         return 0;
 151 }
 152
 153 void
 154 Session::set_mmc_receive_device_id (uint32_t device_id)
 155 {
 156         if (mmc) {
 157                 mmc->set_receive_device_id (device_id);
 158         }
 159 }
 160
 161 void
 162 Session::set_mmc_send_device_id (uint32_t device_id)
 163 {
 164         if (mmc) {
 165                 mmc->set_send_device_id (device_id);
 166         }
 167 }
 168
 169 int
 170 Session::set_mmc_port (string port_tag)
 171 {
 172         MIDI::byte old_recv_device_id = 0;
 173         MIDI::byte old_send_device_id = 0;
 174         bool reset_id = false;
 175
 176         if (port_tag.length() == 0) {
 177                 if (_mmc_port == 0) {
 178                         return 0;
 179                 }
 180                 _mmc_port = 0;
 181                 goto out;
 182         }
 183
 184         MIDI::Port* port;
 185
 186         if ((port = MIDI::Manager::instance()->port (port_tag)) == 0) {
 187                 return -1;
 188         }
 189
 190         _mmc_port = port;
 191
 192         if (mmc) {
 193                 old_recv_device_id = mmc->receive_device_id();
 194                 old_recv_device_id = mmc->send_device_id();
 195                 reset_id = true;
 196                 delete mmc;
 197         }
 198
 199         mmc = new MIDI::MachineControl (*_mmc_port, 1.0,
 200                                         MMC_CommandSignature,
 201                                         MMC_ResponseSignature);
 202
 203         if (reset_id) {
 204                 mmc->set_receive_device_id (old_recv_device_id);
 205                 mmc->set_send_device_id (old_send_device_id);
 206         }
 207
 208         mmc->Play.connect
 209                 (mem_fun (*this, &Session::mmc_deferred_play));
 210         mmc->DeferredPlay.connect
 211                 (mem_fun (*this, &Session::mmc_deferred_play));
 212         mmc->Stop.connect
 213                 (mem_fun (*this, &Session::mmc_stop));
 214         mmc->FastForward.connect
 215                 (mem_fun (*this, &Session::mmc_fast_forward));
 216         mmc->Rewind.connect
 217                 (mem_fun (*this, &Session::mmc_rewind));
 218         mmc->Pause.connect
 219                 (mem_fun (*this, &Session::mmc_pause));
 220         mmc->RecordPause.connect
 221                 (mem_fun (*this, &Session::mmc_record_pause));
 222         mmc->RecordStrobe.connect
 223                 (mem_fun (*this, &Session::mmc_record_strobe));
 224         mmc->RecordExit.connect
 225                 (mem_fun (*this, &Session::mmc_record_exit));
 226         mmc->Locate.connect
 227                 (mem_fun (*this, &Session::mmc_locate));
 228         mmc->Step.connect
 229                 (mem_fun (*this, &Session::mmc_step));
 230         mmc->Shuttle.connect
 231                 (mem_fun (*this, &Session::mmc_shuttle));
 232         mmc->TrackRecordStatusChange.connect
 233                 (mem_fun (*this, &Session::mmc_record_enable));
 234
 235
 236         /* also handle MIDI SPP because its so common */
 237
 238         _mmc_port->input()->start.connect (mem_fun (*this, &Session::spp_start));
 239         _mmc_port->input()->contineu.connect (mem_fun (*this, &Session::spp_continue));
 240         _mmc_port->input()->stop.connect (mem_fun (*this, &Session::spp_stop));
 241
 242         Config->set_mmc_port_name (port_tag);
 243
 244   out:
 245         MMC_PortChanged(); /* EMIT SIGNAL */
 246         change_midi_ports ();
 247         set_dirty();
 248         return 0;
 249 }
 250
 251 int
 252 Session::set_midi_port (string port_tag)
 253 {
 254 #if 0
 255         if (port_tag.length() == 0) {
 256                 if (_midi_port == 0) {
 257                         return 0;
 258                 }
 259                 _midi_port = 0;
 260                 goto out;
 261         }
 262
 263         MIDI::Port* port;
 264
 265         if ((port = MIDI::Manager::instance()->port (port_tag)) == 0) {
 266                 return -1;
 267         }
 268
 269         _midi_port = port;
 270
 271         /* XXX need something to forward this to control protocols ? or just
 272            use the signal below
 273         */
 274
 275         Config->set_midi_port_name (port_tag);
 276
 277   out:
 278 #endif
 279         MIDI_PortChanged(); /* EMIT SIGNAL */
 280         change_midi_ports ();
 281         set_dirty();
 282         return 0;
 283 }
 284
 285 int
 286 Session::set_midi_clock_port (string port_tag)
 287 {
 288         MIDIClock_Slave *ms;
 289
 290         if (port_tag.length() == 0) {
 291
 292                 if (_slave && ((ms = dynamic_cast<MIDIClock_Slave*> (_slave)) != 0)) {
 293                         error << _("Ardour is slaved to MIDI Clock - port cannot be reset") << endmsg;
 294                         return -1;
 295                 }
 296
 297                 if (_midi_clock_port == 0) {
 298                         return 0;
 299                 }
 300
 301                 _midi_clock_port = 0;
 302                 goto out;
 303         }
 304
 305         MIDI::Port* port;
 306
 307         if ((port = MIDI::Manager::instance()->port (port_tag)) == 0) {
 308                 error << string_compose (_("unknown port %1 requested for MIDI Clock"), port_tag) << endl;
 309                 return -1;
 310         }
 311
 312         _midi_clock_port = port;
 313
 314         if (_slave && ((ms = dynamic_cast<MIDIClock_Slave*> (_slave)) != 0)) {
 315                 ms->rebind (*port);
 316         }
 317
 318         Config->set_midi_clock_port_name (port_tag);
 319
 320         _midi_clock_port->input()->start.connect (mem_fun (*this, &Session::midi_clock_start));
 321         _midi_clock_port->input()->contineu.connect (mem_fun (*this, &Session::midi_clock_continue));
 322         _midi_clock_port->input()->stop.connect (mem_fun (*this, &Session::midi_clock_stop));
 323
 324   out:
 325         MIDIClock_PortChanged(); /* EMIT SIGNAL */
 326         change_midi_ports ();
 327         set_dirty();
 328         return 0;
 329 }
 330
 331 void
 332 Session::set_trace_midi_input (bool yn, MIDI::Port* port)
 333 {
 334         MIDI::Parser* input_parser;
 335
 336         cerr << "enabling tracing: " << yn << " for input port " << port->name() << endl;
 337
 338         if (port) {
 339                 if ((input_parser = port->input()) != 0) {
 340                         input_parser->trace (yn, &cout, "input: ");
 341                 }
 342         } else {
 343
 344                 if (_mmc_port) {
 345                         if ((input_parser = _mmc_port->input()) != 0) {
 346                                 input_parser->trace (yn, &cout, "input: ");
 347                         }
 348                 }
 349
 350                 if (_mtc_port && _mtc_port != _mmc_port) {
 351                         if ((input_parser = _mtc_port->input()) != 0) {
 352                                 input_parser->trace (yn, &cout, "input: ");
 353                         }
 354                 }
 355
 356                 if (_midi_port && _midi_port != _mmc_port && _midi_port != _mtc_port  ) {
 357                         if ((input_parser = _midi_port->input()) != 0) {
 358                                 input_parser->trace (yn, &cout, "input: ");
 359                         }
 360                 }
 361
 362                 if (_midi_clock_port
 363                         && _midi_clock_port != _mmc_port
 364                         && _midi_clock_port != _mtc_port
 365                         && _midi_clock_port != _midi_port) {
 366                         if ((input_parser = _midi_clock_port->input()) != 0) {
 367                                 input_parser->trace (yn, &cout, "input: ");
 368                         }
 369                 }
 370         }
 371
 372         Config->set_trace_midi_input (yn);
 373 }
 374
 375 void
 376 Session::set_trace_midi_output (bool yn, MIDI::Port* port)
 377 {
 378         MIDI::Parser* output_parser;
 379
 380         if (port) {
 381                 if ((output_parser = port->output()) != 0) {
 382                         output_parser->trace (yn, &cout, "output: ");
 383                 }
 384         } else {
 385                 if (_mmc_port) {
 386                         if ((output_parser = _mmc_port->output()) != 0) {
 387                                 output_parser->trace (yn, &cout, "output: ");
 388                         }
 389                 }
 390
 391                 if (_mtc_port && _mtc_port != _mmc_port) {
 392                         if ((output_parser = _mtc_port->output()) != 0) {
 393                                 output_parser->trace (yn, &cout, "output: ");
 394                         }
 395                 }
 396
 397                 if (_midi_port && _midi_port != _mmc_port && _midi_port != _mtc_port  ) {
 398                         if ((output_parser = _midi_port->output()) != 0) {
 399                                 output_parser->trace (yn, &cout, "output: ");
 400                         }
 401                 }
 402
 403         }
 404
 405         Config->set_trace_midi_output (yn);
 406 }
 407
 408 bool
 409 Session::get_trace_midi_input(MIDI::Port *port)
 410 {
 411         MIDI::Parser* input_parser;
 412         if (port) {
 413                 if ((input_parser = port->input()) != 0) {
 414                         return input_parser->tracing();
 415                 }
 416         }
 417         else {
 418                 if (_mmc_port) {
 419                         if ((input_parser = _mmc_port->input()) != 0) {
 420                                 return input_parser->tracing();
 421                         }
 422                 }
 423
 424                 if (_mtc_port) {
 425                         if ((input_parser = _mtc_port->input()) != 0) {
 426                                 return input_parser->tracing();
 427                         }
 428                 }
 429
 430                 if (_midi_port) {
 431                         if ((input_parser = _midi_port->input()) != 0) {
 432                                 return input_parser->tracing();
 433                         }
 434                 }
 435         }
 436
 437         return false;
 438 }
 439
 440 bool
 441 Session::get_trace_midi_output(MIDI::Port *port)
 442 {
 443         MIDI::Parser* output_parser;
 444         if (port) {
 445                 if ((output_parser = port->output()) != 0) {
 446                         return output_parser->tracing();
 447                 }
 448         }
 449         else {
 450                 if (_mmc_port) {
 451                         if ((output_parser = _mmc_port->output()) != 0) {
 452                                 return output_parser->tracing();
 453                         }
 454                 }
 455
 456                 if (_mtc_port) {
 457                         if ((output_parser = _mtc_port->output()) != 0) {
 458                                 return output_parser->tracing();
 459                         }
 460                 }
 461
 462                 if (_midi_port) {
 463                         if ((output_parser = _midi_port->output()) != 0) {
 464                                 return output_parser->tracing();
 465                         }
 466                 }
 467         }
 468
 469         return false;
 470
 471 }
 472
 473 void
 474 Session::setup_midi_control ()
 475 {
 476         outbound_mtc_smpte_frame = 0;
 477         next_quarter_frame_to_send = 0;
 478
 479         /* setup the MMC buffer */
 480
 481         mmc_buffer[0] = 0xf0; // SysEx
 482         mmc_buffer[1] = 0x7f; // Real Time SysEx ID for MMC
 483         mmc_buffer[2] = (mmc ? mmc->send_device_id() : 0x7f);
 484         mmc_buffer[3] = 0x6;  // MCC
 485
 486         /* Set up the qtr frame message */
 487
 488         mtc_msg[0] = 0xf1;
 489         mtc_msg[2] = 0xf1;
 490         mtc_msg[4] = 0xf1;
 491         mtc_msg[6] = 0xf1;
 492         mtc_msg[8] = 0xf1;
 493         mtc_msg[10] = 0xf1;
 494         mtc_msg[12] = 0xf1;
 495         mtc_msg[14] = 0xf1;
 496 }
 497
 498 void
 499 Session::spp_start (Parser& ignored)
 500 {
 501         if (Config->get_mmc_control() && (Config->get_slave_source() != MTC)) {
 502                 request_transport_speed (1.0);
 503         }
 504 }
 505
 506 void
 507 Session::spp_continue (Parser& ignored)
 508 {
 509         spp_start (ignored);
 510 }
 511
 512 void
 513 Session::spp_stop (Parser& ignored)
 514 {
 515         if (Config->get_mmc_control()) {
 516                 request_stop ();
 517         }
 518 }
 519
 520 void
 521 Session::midi_clock_start (Parser& ignored)
 522 {
 523         if (Config->get_midi_clock_control() && (Config->get_slave_source() == MIDIClock)) {
 524                 request_transport_speed (1.0);
 525         }
 526 }
 527
 528 void
 529 Session::midi_clock_continue (Parser& ignored)
 530 {
 531         midi_clock_start (ignored);
 532 }
 533
 534 void
 535 Session::midi_clock_stop (Parser& ignored)
 536 {
 537         if (Config->get_midi_clock_control()) {
 538                 request_stop ();
 539         }
 540 }
 541
 542 void
 543 Session::mmc_deferred_play (MIDI::MachineControl &mmc)
 544 {
 545         if (Config->get_mmc_control() && (Config->get_slave_source() != MTC)) {
 546                 request_transport_speed (1.0);
 547         }
 548 }
 549
 550 void
 551 Session::mmc_record_pause (MIDI::MachineControl &mmc)
 552 {
 553         if (Config->get_mmc_control()) {
 554                 maybe_enable_record();
 555         }
 556 }
 557
 558 void
 559 Session::mmc_record_strobe (MIDI::MachineControl &mmc)
 560 {
 561         if (!Config->get_mmc_control())
 562                 return;
 563
 564         /* record strobe does an implicit "Play" command */
 565
 566         if (_transport_speed != 1.0) {
 567
 568                 /* start_transport() will move from Enabled->Recording, so we
 569                    don't need to do anything here except enable recording.
 570                    its not the same as maybe_enable_record() though, because
 571                    that *can* switch to Recording, which we do not want.
 572                 */
 573
 574                 save_state ("", true);
 575                 g_atomic_int_set (&_record_status, Enabled);
 576                 RecordStateChanged (); /* EMIT SIGNAL */
 577
 578                 request_transport_speed (1.0);
 579
 580         } else {
 581
 582                 enable_record ();
 583         }
 584 }
 585
 586 void
 587 Session::mmc_record_exit (MIDI::MachineControl &mmc)
 588 {
 589         if (Config->get_mmc_control()) {
 590                 disable_record (false);
 591         }
 592 }
 593
 594 void
 595 Session::mmc_stop (MIDI::MachineControl &mmc)
 596 {
 597         if (Config->get_mmc_control()) {
 598                 request_stop ();
 599         }
 600 }
 601
 602 void
 603 Session::mmc_pause (MIDI::MachineControl &mmc)
 604 {
 605         if (Config->get_mmc_control()) {
 606
 607                 /* We support RECORD_PAUSE, so the spec says that
 608                    we must interpret PAUSE like RECORD_PAUSE if
 609                    recording.
 610                 */
 611
 612                 if (actively_recording()) {
 613                         maybe_enable_record ();
 614                 } else {
 615                         request_stop ();
 616                 }
 617         }
 618 }
 619
 620 static bool step_queued = false;
 621
 622 void
 623 Session::mmc_step (MIDI::MachineControl &mmc, int steps)
 624 {
 625         if (!Config->get_mmc_control()) {
 626                 return;
 627         }
 628
 629         struct timeval now;
 630         struct timeval diff = { 0, 0 };
 631
 632         gettimeofday (&now, 0);
 633
 634         timersub (&now, &last_mmc_step, &diff);
 635
 636         gettimeofday (&now, 0);
 637         timersub (&now, &last_mmc_step, &diff);
 638
 639         if (last_mmc_step.tv_sec != 0 && (diff.tv_usec + (diff.tv_sec * 1000000)) < _engine.usecs_per_cycle()) {
 640                 return;
 641         }
 642
 643         double diff_secs = diff.tv_sec + (diff.tv_usec / 1000000.0);
 644         double cur_speed = (((steps * 0.5) * smpte_frames_per_second()) / diff_secs) / smpte_frames_per_second();
 645
 646         if (_transport_speed == 0 || cur_speed * _transport_speed < 0) {
 647                 /* change direction */
 648                 step_speed = cur_speed;
 649         } else {
 650                 step_speed = (0.6 * step_speed) + (0.4 * cur_speed);
 651         }
 652
 653         step_speed *= 0.25;
 654
 655 #if 0
 656         cerr << "delta = " << diff_secs
 657              << " ct = " << _transport_speed
 658              << " steps = " << steps
 659              << " new speed = " << cur_speed
 660              << " speed = " << step_speed
 661              << endl;
 662 #endif
 663
 664         request_transport_speed (step_speed);
 665         last_mmc_step = now;
 666
 667         if (!step_queued) {
 668                 midi_timeouts.push_back (mem_fun (*this, &Session::mmc_step_timeout));
 669                 step_queued = true;
 670         }
 671 }
 672
 673 void
 674 Session::mmc_rewind (MIDI::MachineControl &mmc)
 675 {
 676         if (Config->get_mmc_control()) {
 677                 request_transport_speed(-8.0f);
 678         }
 679 }
 680
 681 void
 682 Session::mmc_fast_forward (MIDI::MachineControl &mmc)
 683 {
 684         if (Config->get_mmc_control()) {
 685                 request_transport_speed(8.0f);
 686         }
 687 }
 688
 689 void
 690 Session::mmc_locate (MIDI::MachineControl &mmc, const MIDI::byte* mmc_tc)
 691 {
 692         if (!Config->get_mmc_control()) {
 693                 return;
 694         }
 695
 696         nframes_t target_frame;
 697         SMPTE::Time smpte;
 698
 699         smpte.hours = mmc_tc[0] & 0xf;
 700         smpte.minutes = mmc_tc[1];
 701         smpte.seconds = mmc_tc[2];
 702         smpte.frames = mmc_tc[3];
 703         smpte.rate = smpte_frames_per_second();
 704         smpte.drop = smpte_drop_frames();
 705
 706         // Also takes smpte offset into account:
 707         smpte_to_sample( smpte, target_frame, true /* use_offset */, false /* use_subframes */ );
 708
 709         if (target_frame > max_frames) {
 710                 target_frame = max_frames;
 711         }
 712
 713         /* Some (all?) MTC/MMC devices do not send a full MTC frame
 714            at the end of a locate, instead sending only an MMC
 715            locate command. This causes the current position
 716            of an MTC slave to become out of date. Catch this.
 717         */
 718
 719         MTC_Slave* mtcs = dynamic_cast<MTC_Slave*> (_slave);
 720
 721         if (mtcs != 0) {
 722                 // cerr << "Locate *with* MTC slave\n";
 723                 mtcs->handle_locate (mmc_tc);
 724         } else {
 725                 // cerr << "Locate without MTC slave\n";
 726                 request_locate (target_frame, false);
 727         }
 728 }
 729
 730 void
 731 Session::mmc_shuttle (MIDI::MachineControl &mmc, float speed, bool forw)
 732 {
 733         if (!Config->get_mmc_control()) {
 734                 return;
 735         }
 736
 737         if (Config->get_shuttle_speed_threshold() >= 0 && speed > Config->get_shuttle_speed_threshold()) {
 738                 speed *= Config->get_shuttle_speed_factor();
 739         }
 740
 741         if (forw) {
 742                 request_transport_speed (speed);
 743         } else {
 744                 request_transport_speed (-speed);
 745         }
 746 }
 747
 748 void
 749 Session::mmc_record_enable (MIDI::MachineControl &mmc, size_t trk, bool enabled)
 750 {
 751         if (Config->get_mmc_control()) {
 752
 753                 RouteList::iterator i;
 754                 boost::shared_ptr<RouteList> r = routes.reader();
 755
 756                 for (i = r->begin(); i != r->end(); ++i) {
 757                         AudioTrack *at;
 758
 759                         if ((at = dynamic_cast<AudioTrack*>((*i).get())) != 0) {
 760                                 if (trk == at->remote_control_id()) {
 761                                         at->set_record_enable (enabled, &mmc);
 762                                         break;
 763                                 }
 764                         }
 765                 }
 766         }
 767 }
 768
 769 void
 770 Session::change_midi_ports ()
 771 {
 772         MIDIRequest* request = new MIDIRequest;
 773
 774         request->type = MIDIRequest::PortChange;
 775         midi_requests.write (&request, 1);
 776         poke_midi_thread ();
 777 }
 778
 779 /** Send MTC Full Frame message (complete SMPTE time) for the start of this cycle.
 780  * This resets the MTC code, the next quarter frame message that is sent will be
 781  * the first one with the beginning of this cycle as the new start point.
 782  */
 783
 784 int
 785 Session::send_full_time_code(nframes_t nframes)
 786 {
 787         /* This function could easily send at a given frame offset, but would
 788          * that be useful?  Does ardour do sub-block accurate locating? [DR] */
 789
 790         MIDI::byte msg[10];
 791         SMPTE::Time smpte;
 792
 793         _send_smpte_update = false;
 794
 795         if (_mtc_port == 0 || !session_send_mtc) {
 796                 return 0;
 797         }
 798
 799         // Get smpte time for this transport frame
 800         sample_to_smpte(_transport_frame, smpte, true /* use_offset */, false /* no subframes */);
 801
 802         transmitting_smpte_time = smpte;
 803         outbound_mtc_smpte_frame = _transport_frame;
 804
 805         // I don't understand this bit yet.. [DR]
 806         if (((mtc_smpte_bits >> 5) != MIDI::MTC_25_FPS) && (transmitting_smpte_time.frames % 2)) {
 807                 // start MTC quarter frame transmission on an even frame
 808                 SMPTE::increment( transmitting_smpte_time );
 809                 outbound_mtc_smpte_frame += (nframes_t) _frames_per_smpte_frame;
 810         }
 811
 812         // Compensate for audio latency
 813         outbound_mtc_smpte_frame += _worst_output_latency;
 814
 815         next_quarter_frame_to_send = 0;
 816
 817         // Sync slave to the same SMPTE time as we are on
 818         msg[0] = 0xf0;
 819         msg[1] = 0x7f;
 820         msg[2] = 0x7f;
 821         msg[3] = 0x1;
 822         msg[4] = 0x1;
 823         msg[9] = 0xf7;
 824
 825         msg[5] = mtc_smpte_bits | smpte.hours;
 826         msg[6] = smpte.minutes;
 827         msg[7] = smpte.seconds;
 828         msg[8] = smpte.frames;
 829
 830         cerr << "MTC: Sending full time code at " << outbound_mtc_smpte_frame << endl;
 831
 832         // Send message at offset 0, sent time is for the start of this cycle
 833         if (_mtc_port->midimsg (msg, sizeof (msg), 0)) {
 834                 error << _("Session: could not send full MIDI time code") << endmsg;
 835                 return -1;
 836         }
 837
 838         return 0;
 839 }
 840
 841
 842 /** Sends MTC (quarter-frame) messages for this cycle.
 843  * Must be called exactly once per cycle from the audio thread.  Realtime safe.
 844  * This function assumes the state of full SMPTE is sane, eg. the slave is
 845  * expecting quarter frame messages and has the right frame of reference (any
 846  * full MTC SMPTE time messages that needed to be sent should have been sent
 847  * earlier already this cycle by send_full_time_code)
 848  */
 849 int
 850 Session::send_midi_time_code_for_cycle(nframes_t nframes)
 851 {
 852         assert (next_quarter_frame_to_send >= 0);
 853         assert (next_quarter_frame_to_send <= 7);
 854
 855         if (_mtc_port == 0 || !session_send_mtc || transmitting_smpte_time.negative
 856             /*|| (next_quarter_frame_to_send < 0)*/ ) {
 857                 // cerr << "(MTC) Not sending MTC\n";
 858                 return 0;
 859         }
 860
 861         /* Duration of one quarter frame */
 862         nframes_t quarter_frame_duration = ((long) _frames_per_smpte_frame) >> 2;
 863
 864         // cerr << "(MTC) TR: " << _transport_frame << " - SF: " << outbound_mtc_smpte_frame
 865         // << " - NQ: " << next_quarter_frame_to_send << " - FD" << quarter_frame_duration << endl;
 866
 867         // FIXME: this should always be true
 868         //assert((outbound_mtc_smpte_frame + (next_quarter_frame_to_send * quarter_frame_duration))
 869         //              > _transport_frame);
 870
 871
 872         // Send quarter frames for this cycle
 873         while (_transport_frame + nframes > (outbound_mtc_smpte_frame +
 874                                 (next_quarter_frame_to_send * quarter_frame_duration))) {
 875
 876                 // cerr << "(MTC) Next frame to send: " << next_quarter_frame_to_send << endl;
 877
 878                 switch (next_quarter_frame_to_send) {
 879                         case 0:
 880                                 mtc_msg[1] =  0x00 | (transmitting_smpte_time.frames & 0xf);
 881                                 break;
 882                         case 1:
 883                                 mtc_msg[1] =  0x10 | ((transmitting_smpte_time.frames & 0xf0) >> 4);
 884                                 break;
 885                         case 2:
 886                                 mtc_msg[1] =  0x20 | (transmitting_smpte_time.seconds & 0xf);
 887                                 break;
 888                         case 3:
 889                                 mtc_msg[1] =  0x30 | ((transmitting_smpte_time.seconds & 0xf0) >> 4);
 890                                 break;
 891                         case 4:
 892                                 mtc_msg[1] =  0x40 | (transmitting_smpte_time.minutes & 0xf);
 893                                 break;
 894                         case 5:
 895                                 mtc_msg[1] = 0x50 | ((transmitting_smpte_time.minutes & 0xf0) >> 4);
 896                                 break;
 897                         case 6:
 898                                 mtc_msg[1] = 0x60 | ((mtc_smpte_bits|transmitting_smpte_time.hours) & 0xf);
 899                                 break;
 900                         case 7:
 901                                 mtc_msg[1] = 0x70 | (((mtc_smpte_bits|transmitting_smpte_time.hours) & 0xf0) >> 4);
 902                                 break;
 903                 }
 904
 905                 const nframes_t msg_time = (outbound_mtc_smpte_frame
 906                         + (quarter_frame_duration * next_quarter_frame_to_send));
 907
 908                 // This message must fall within this block or something is broken
 909                 assert(msg_time >= _transport_frame);
 910                 assert(msg_time < _transport_frame + nframes);
 911
 912                 nframes_t out_stamp = msg_time - _transport_frame;
 913                 assert(out_stamp < nframes);
 914
 915                 if (_mtc_port->midimsg (mtc_msg, 2, out_stamp)) {
 916                         error << string_compose(_("Session: cannot send quarter-frame MTC message (%1)"), strerror (errno))
 917                               << endmsg;
 918                         return -1;
 919                 }
 920
 921                 /*cerr << "(MTC) SMPTE: " << transmitting_smpte_time.hours
 922                         << ":" << transmitting_smpte_time.minutes
 923                         << ":" << transmitting_smpte_time.seconds
 924                         << ":" << transmitting_smpte_time.frames
 925                         << ", qfm = " << next_quarter_frame_to_send
 926                         << ", stamp = " << out_stamp
 927                         << ", delta = " << _transport_frame + out_stamp - last_time << endl;*/
 928
 929                 // Increment quarter frame counter
 930                 next_quarter_frame_to_send++;
 931
 932                 if (next_quarter_frame_to_send >= 8) {
 933                         // Wrap quarter frame counter
 934                         next_quarter_frame_to_send = 0;
 935                         // Increment smpte time twice
 936                         SMPTE::increment( transmitting_smpte_time );
 937                         SMPTE::increment( transmitting_smpte_time );
 938                         // Re-calculate timing of first quarter frame
 939                         //smpte_to_sample( transmitting_smpte_time, outbound_mtc_smpte_frame, true /* use_offset */, false );
 940                         outbound_mtc_smpte_frame += 8 * quarter_frame_duration;
 941                         // Compensate for audio latency
 942                         outbound_mtc_smpte_frame += _worst_output_latency;
 943                 }
 944         }
 945
 946         return 0;
 947 }
 948
 949 /***********************************************************************
 950  OUTBOUND MMC STUFF
 951 **********************************************************************/
 952
 953 void
 954 Session::deliver_mmc (MIDI::MachineControl::Command cmd, nframes_t where)
 955 {
 956         using namespace MIDI;
 957         int nbytes = 4;
 958         SMPTE::Time smpte;
 959
 960         if (_mmc_port == 0 || !session_send_mmc) {
 961                 // cerr << "Not delivering MMC " << _mmc_port << " - " << session_send_mmc << endl;
 962                 return;
 963         }
 964
 965         mmc_buffer[nbytes++] = cmd;
 966
 967         // cerr << "delivering MMC, cmd = " << hex << (int) cmd << dec << endl;
 968
 969         switch (cmd) {
 970         case MachineControl::cmdLocate:
 971                 smpte_time_subframes (where, smpte);
 972
 973                 mmc_buffer[nbytes++] = 0x6; // byte count
 974                 mmc_buffer[nbytes++] = 0x1; // "TARGET" subcommand
 975                 mmc_buffer[nbytes++] = smpte.hours;
 976                 mmc_buffer[nbytes++] = smpte.minutes;
 977                 mmc_buffer[nbytes++] = smpte.seconds;
 978                 mmc_buffer[nbytes++] = smpte.frames;
 979                 mmc_buffer[nbytes++] = smpte.subframes;
 980                 break;
 981
 982         case MachineControl::cmdStop:
 983                 break;
 984
 985         case MachineControl::cmdPlay:
 986                 /* always convert Play into Deferred Play */
 987                 /* Why? [DR] */
 988                 mmc_buffer[4] = MachineControl::cmdDeferredPlay;
 989                 break;
 990
 991         case MachineControl::cmdDeferredPlay:
 992                 break;
 993
 994         case MachineControl::cmdRecordStrobe:
 995                 break;
 996
 997         case MachineControl::cmdRecordExit:
 998                 break;
 999
1000         case MachineControl::cmdRecordPause:
1001                 break;
1002
1003         default:
1004                 nbytes = 0;
1005         };
1006
1007         if (nbytes) {
1008
1009                 mmc_buffer[nbytes++] = 0xf7; // terminate SysEx/MMC message
1010
1011                 if (_mmc_port->midimsg (mmc_buffer, nbytes, 0)) {
1012                         error << string_compose(_("MMC: cannot send command %1%2%3"), &hex, cmd, &dec) << endmsg;
1013                 }
1014         }
1015 }
1016
1017 bool
1018 Session::mmc_step_timeout ()
1019 {
1020         struct timeval now;
1021         struct timeval diff;
1022         double diff_usecs;
1023         gettimeofday (&now, 0);
1024
1025         timersub (&now, &last_mmc_step, &diff);
1026         diff_usecs = diff.tv_sec * 1000000 + diff.tv_usec;
1027
1028         if (diff_usecs > 1000000.0 || fabs (_transport_speed) < 0.0000001) {
1029                 /* too long or too slow, stop transport */
1030                 request_transport_speed (0.0);
1031                 step_queued = false;
1032                 return false;
1033         }
1034
1035         if (diff_usecs < 250000.0) {
1036                 /* too short, just keep going */
1037                 return true;
1038         }
1039
1040         /* slow it down */
1041
1042         request_transport_speed (_transport_speed * 0.75);
1043         return true;
1044 }
1045
1046 /*---------------------------------------------------------------------------
1047   MIDI THREAD
1048   ---------------------------------------------------------------------------*/
1049
1050 int
1051 Session::start_midi_thread ()
1052 {
1053         if (pipe (midi_request_pipe)) {
1054                 error << string_compose(_("Cannot create transport request signal pipe (%1)"), strerror (errno)) << endmsg;
1055                 return -1;
1056         }
1057
1058         if (fcntl (midi_request_pipe[0], F_SETFL, O_NONBLOCK)) {
1059                 error << string_compose(_("UI: cannot set O_NONBLOCK on "    "signal read pipe (%1)"), strerror (errno)) << endmsg;
1060                 return -1;
1061         }
1062
1063         if (fcntl (midi_request_pipe[1], F_SETFL, O_NONBLOCK)) {
1064                 error << string_compose(_("UI: cannot set O_NONBLOCK on "    "signal write pipe (%1)"), strerror (errno)) << endmsg;
1065                 return -1;
1066         }
1067
1068         if (pthread_create_and_store ("transport", &midi_thread, 0, _midi_thread_work, this)) {
1069                 error << _("Session: could not create transport thread") << endmsg;
1070                 return -1;
1071         }
1072
1073         return 0;
1074 }
1075
1076 void
1077 Session::terminate_midi_thread ()
1078 {
1079         if (midi_thread) {
1080
1081                 MIDIRequest* request = new MIDIRequest;
1082                 void* status;
1083
1084                 request->type = MIDIRequest::Quit;
1085
1086                 midi_requests.write (&request, 1);
1087                 poke_midi_thread ();
1088
1089                 pthread_join (midi_thread, &status);
1090         }
1091 }
1092
1093 void
1094 Session::poke_midi_thread ()
1095 {
1096         static char c = 0;
1097
1098         if (write (midi_request_pipe[1], &c, 1) != 1) {
1099                 error << string_compose(_("cannot send signal to midi thread! (%1)"), strerror (errno)) << endmsg;
1100         }
1101 }
1102
1103 void *
1104 Session::_midi_thread_work (void* arg)
1105 {
1106         pthread_setcancelstate (PTHREAD_CANCEL_ENABLE, 0);
1107         pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
1108
1109         ((Session *) arg)->midi_thread_work ();
1110         return 0;
1111 }
1112
1113 void
1114 Session::midi_thread_work ()
1115 {
1116         MIDIRequest* request;
1117         struct pollfd pfd[4];
1118         int nfds = 0;
1119         int timeout;
1120         int fds_ready;
1121         struct sched_param rtparam;
1122         int x;
1123         bool restart;
1124         vector<MIDI::Port*> ports;
1125
1126         PBD::ThreadCreatedWithRequestSize (pthread_self(), X_("MIDI"), 2048);
1127
1128         memset (&rtparam, 0, sizeof (rtparam));
1129         rtparam.sched_priority = 9; /* XXX should be relative to audio (JACK) thread */
1130
1131         if ((x = pthread_setschedparam (pthread_self(), SCHED_FIFO, &rtparam)) != 0) {
1132                 // do we care? not particularly.
1133         }
1134
1135         /* set up the port vector; 5 is the largest possible size for now */
1136
1137         ports.assign (5, (MIDI::Port*) 0);
1138
1139         while (1) {
1140
1141                 nfds = 0;
1142
1143                 pfd[nfds].fd = midi_request_pipe[0];
1144                 pfd[nfds].events = POLLIN|POLLHUP|POLLERR;
1145                 nfds++;
1146
1147                 if (Config->get_mmc_control() && _mmc_port && _mmc_port->selectable() >= 0) {
1148                         pfd[nfds].fd = _mmc_port->selectable();
1149                         pfd[nfds].events = POLLIN|POLLHUP|POLLERR;
1150                         ports[nfds] = _mmc_port;
1151                         nfds++;
1152                 }
1153
1154                 /* if MTC is being handled on a different port from MMC
1155                    or we are not handling MMC at all, poll
1156                    the relevant port.
1157                 */
1158
1159                 if (_mtc_port && (_mtc_port != _mmc_port || !Config->get_mmc_control()) && _mtc_port->selectable() >= 0) {
1160                         pfd[nfds].fd = _mtc_port->selectable();
1161                         pfd[nfds].events = POLLIN|POLLHUP|POLLERR;
1162                         ports[nfds] = _mtc_port;
1163                         nfds++;
1164                 }
1165
1166                 if (_midi_clock_port && (_midi_clock_port != _mmc_port || !Config->get_mmc_control()) && _midi_clock_port->selectable() >= 0) {
1167                         pfd[nfds].fd = _midi_clock_port->selectable();
1168                         pfd[nfds].events = POLLIN|POLLHUP|POLLERR;
1169                         ports[nfds] = _midi_clock_port;
1170                         nfds++;
1171                 }
1172
1173                 /* if we are using MMC control, we obviously have to listen
1174                    the relevant port.
1175                 */
1176
1177                 if (_midi_port && (_midi_port != _mmc_port || !Config->get_mmc_control()) && (_midi_port != _mtc_port) && _midi_port->selectable() >= 0) {
1178                         pfd[nfds].fd = _midi_port->selectable();
1179                         pfd[nfds].events = POLLIN|POLLHUP|POLLERR;
1180                         ports[nfds] = _midi_port;
1181                         nfds++;
1182                 }
1183
1184                 if (!midi_timeouts.empty()) {
1185                         timeout = 100; /* 10msecs */
1186                 } else {
1187                         timeout = -1; /* if there is no data, we don't care */
1188                 }
1189
1190           again:
1191                 // cerr << "MIDI poll on " << nfds << " for " << timeout << endl;
1192                 if (poll (pfd, nfds, timeout) < 0) {
1193                         if (errno == EINTR) {
1194                                 /* gdb at work, perhaps */
1195                                 goto again;
1196                         }
1197
1198                         error << string_compose(_("MIDI thread poll failed (%1)"), strerror (errno)) << endmsg;
1199
1200                         break;
1201                 }
1202                 // cerr << "MIDI thread wakes at " << get_cycles () << endl;
1203
1204                 fds_ready = 0;
1205
1206                 /* check the transport request pipe */
1207
1208                 if (pfd[0].revents & ~POLLIN) {
1209                         error << _("Error on transport thread request pipe") << endmsg;
1210                         break;
1211                 }
1212
1213                 if (pfd[0].revents & POLLIN) {
1214
1215                         char foo[16];
1216
1217                         // cerr << "MIDI request FIFO ready\n";
1218                         fds_ready++;
1219
1220                         /* empty the pipe of all current requests */
1221
1222                         while (1) {
1223                                 size_t nread = read (midi_request_pipe[0], &foo, sizeof (foo));
1224
1225                                 if (nread > 0) {
1226                                         if ((size_t) nread < sizeof (foo)) {
1227                                                 break;
1228                                         } else {
1229                                                 continue;
1230                                         }
1231                                 } else if (nread == 0) {
1232                                         break;
1233                                 } else if (errno == EAGAIN) {
1234                                         break;
1235                                 } else {
1236                                         fatal << _("Error reading from transport request pipe") << endmsg;
1237                                         /*NOTREACHED*/
1238                                 }
1239                         }
1240
1241                         while (midi_requests.read (&request, 1) == 1) {
1242
1243                                 switch (request->type) {
1244                                 case MIDIRequest::PortChange:
1245                                         /* restart poll with new ports */
1246                                         // cerr << "rebind\n";
1247                                         restart = true;
1248                                         break;
1249
1250                                 case MIDIRequest::Quit:
1251                                         delete request;
1252                                         pthread_exit_pbd (0);
1253                                         /*NOTREACHED*/
1254                                         break;
1255
1256                                 default:
1257                                         break;
1258                                 }
1259
1260
1261                                 delete request;
1262                         }
1263
1264                 }
1265
1266                 if (restart) {
1267                         continue;
1268                 }
1269
1270                 /* now read the rest of the ports */
1271
1272                 for (int p = 1; p < nfds; ++p) {
1273                         if ((pfd[p].revents & ~POLLIN)) {
1274                                 // error << string_compose(_("Transport: error polling MIDI port %1 (revents =%2%3%4"), p, &hex, pfd[p].revents, &dec) << endmsg;
1275                                 break;
1276                         }
1277
1278                         if (pfd[p].revents & POLLIN) {
1279                                 fds_ready++;
1280                                 ports[p]->parse ();
1281                         }
1282                 }
1283
1284                 /* timeout driven */
1285
1286                 if (fds_ready < 2 && timeout != -1) {
1287
1288                         for (MidiTimeoutList::iterator i = midi_timeouts.begin(); i != midi_timeouts.end(); ) {
1289
1290                                 MidiTimeoutList::iterator tmp;
1291                                 tmp = i;
1292                                 ++tmp;
1293
1294                                 if (!(*i)()) {
1295                                         midi_timeouts.erase (i);
1296                                 }
1297
1298                                 i = tmp;
1299                         }
1300                 }
1301         }
1302 }
1303