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         if (port) {
 337                 if ((input_parser = port->input()) != 0) {
 338                         input_parser->trace (yn, &cout, "input: ");
 339                 }
 340         } else {
 341
 342                 if (_mmc_port) {
 343                         if ((input_parser = _mmc_port->input()) != 0) {
 344                                 input_parser->trace (yn, &cout, "input: ");
 345                         }
 346                 }
 347
 348                 if (_mtc_port && _mtc_port != _mmc_port) {
 349                         if ((input_parser = _mtc_port->input()) != 0) {
 350                                 input_parser->trace (yn, &cout, "input: ");
 351                         }
 352                 }
 353
 354                 if (_midi_port && _midi_port != _mmc_port && _midi_port != _mtc_port  ) {
 355                         if ((input_parser = _midi_port->input()) != 0) {
 356                                 input_parser->trace (yn, &cout, "input: ");
 357                         }
 358                 }
 359         }
 360
 361         Config->set_trace_midi_input (yn);
 362 }
 363
 364 void
 365 Session::set_trace_midi_output (bool yn, MIDI::Port* port)
 366 {
 367         MIDI::Parser* output_parser;
 368
 369         if (port) {
 370                 if ((output_parser = port->output()) != 0) {
 371                         output_parser->trace (yn, &cout, "output: ");
 372                 }
 373         } else {
 374                 if (_mmc_port) {
 375                         if ((output_parser = _mmc_port->output()) != 0) {
 376                                 output_parser->trace (yn, &cout, "output: ");
 377                         }
 378                 }
 379
 380                 if (_mtc_port && _mtc_port != _mmc_port) {
 381                         if ((output_parser = _mtc_port->output()) != 0) {
 382                                 output_parser->trace (yn, &cout, "output: ");
 383                         }
 384                 }
 385
 386                 if (_midi_port && _midi_port != _mmc_port && _midi_port != _mtc_port  ) {
 387                         if ((output_parser = _midi_port->output()) != 0) {
 388                                 output_parser->trace (yn, &cout, "output: ");
 389                         }
 390                 }
 391
 392         }
 393
 394         Config->set_trace_midi_output (yn);
 395 }
 396
 397 bool
 398 Session::get_trace_midi_input(MIDI::Port *port)
 399 {
 400         MIDI::Parser* input_parser;
 401         if (port) {
 402                 if ((input_parser = port->input()) != 0) {
 403                         return input_parser->tracing();
 404                 }
 405         }
 406         else {
 407                 if (_mmc_port) {
 408                         if ((input_parser = _mmc_port->input()) != 0) {
 409                                 return input_parser->tracing();
 410                         }
 411                 }
 412
 413                 if (_mtc_port) {
 414                         if ((input_parser = _mtc_port->input()) != 0) {
 415                                 return input_parser->tracing();
 416                         }
 417                 }
 418
 419                 if (_midi_port) {
 420                         if ((input_parser = _midi_port->input()) != 0) {
 421                                 return input_parser->tracing();
 422                         }
 423                 }
 424         }
 425
 426         return false;
 427 }
 428
 429 bool
 430 Session::get_trace_midi_output(MIDI::Port *port)
 431 {
 432         MIDI::Parser* output_parser;
 433         if (port) {
 434                 if ((output_parser = port->output()) != 0) {
 435                         return output_parser->tracing();
 436                 }
 437         }
 438         else {
 439                 if (_mmc_port) {
 440                         if ((output_parser = _mmc_port->output()) != 0) {
 441                                 return output_parser->tracing();
 442                         }
 443                 }
 444
 445                 if (_mtc_port) {
 446                         if ((output_parser = _mtc_port->output()) != 0) {
 447                                 return output_parser->tracing();
 448                         }
 449                 }
 450
 451                 if (_midi_port) {
 452                         if ((output_parser = _midi_port->output()) != 0) {
 453                                 return output_parser->tracing();
 454                         }
 455                 }
 456         }
 457
 458         return false;
 459
 460 }
 461
 462 void
 463 Session::setup_midi_control ()
 464 {
 465         outbound_mtc_smpte_frame = 0;
 466         next_quarter_frame_to_send = 0;
 467
 468         /* setup the MMC buffer */
 469
 470         mmc_buffer[0] = 0xf0; // SysEx
 471         mmc_buffer[1] = 0x7f; // Real Time SysEx ID for MMC
 472         mmc_buffer[2] = (mmc ? mmc->send_device_id() : 0x7f);
 473         mmc_buffer[3] = 0x6;  // MCC
 474
 475         /* Set up the qtr frame message */
 476
 477         mtc_msg[0] = 0xf1;
 478         mtc_msg[2] = 0xf1;
 479         mtc_msg[4] = 0xf1;
 480         mtc_msg[6] = 0xf1;
 481         mtc_msg[8] = 0xf1;
 482         mtc_msg[10] = 0xf1;
 483         mtc_msg[12] = 0xf1;
 484         mtc_msg[14] = 0xf1;
 485 }
 486
 487 void
 488 Session::spp_start (Parser& ignored)
 489 {
 490         if (Config->get_mmc_control() && (Config->get_slave_source() != MTC)) {
 491                 request_transport_speed (1.0);
 492         }
 493 }
 494
 495 void
 496 Session::spp_continue (Parser& ignored)
 497 {
 498         spp_start (ignored);
 499 }
 500
 501 void
 502 Session::spp_stop (Parser& ignored)
 503 {
 504         if (Config->get_mmc_control()) {
 505                 request_stop ();
 506         }
 507 }
 508
 509 void
 510 Session::midi_clock_start (Parser& ignored)
 511 {
 512         if (Config->get_midi_clock_control() && (Config->get_slave_source() == MIDIClock)) {
 513                 request_transport_speed (1.0);
 514         }
 515 }
 516
 517 void
 518 Session::midi_clock_continue (Parser& ignored)
 519 {
 520         midi_clock_start (ignored);
 521 }
 522
 523 void
 524 Session::midi_clock_stop (Parser& ignored)
 525 {
 526         if (Config->get_midi_clock_control()) {
 527                 request_stop ();
 528         }
 529 }
 530
 531 void
 532 Session::mmc_deferred_play (MIDI::MachineControl &mmc)
 533 {
 534         if (Config->get_mmc_control() && (Config->get_slave_source() != MTC)) {
 535                 request_transport_speed (1.0);
 536         }
 537 }
 538
 539 void
 540 Session::mmc_record_pause (MIDI::MachineControl &mmc)
 541 {
 542         if (Config->get_mmc_control()) {
 543                 maybe_enable_record();
 544         }
 545 }
 546
 547 void
 548 Session::mmc_record_strobe (MIDI::MachineControl &mmc)
 549 {
 550         if (!Config->get_mmc_control())
 551                 return;
 552
 553         /* record strobe does an implicit "Play" command */
 554
 555         if (_transport_speed != 1.0) {
 556
 557                 /* start_transport() will move from Enabled->Recording, so we
 558                    don't need to do anything here except enable recording.
 559                    its not the same as maybe_enable_record() though, because
 560                    that *can* switch to Recording, which we do not want.
 561                 */
 562
 563                 save_state ("", true);
 564                 g_atomic_int_set (&_record_status, Enabled);
 565                 RecordStateChanged (); /* EMIT SIGNAL */
 566
 567                 request_transport_speed (1.0);
 568
 569         } else {
 570
 571                 enable_record ();
 572         }
 573 }
 574
 575 void
 576 Session::mmc_record_exit (MIDI::MachineControl &mmc)
 577 {
 578         if (Config->get_mmc_control()) {
 579                 disable_record (false);
 580         }
 581 }
 582
 583 void
 584 Session::mmc_stop (MIDI::MachineControl &mmc)
 585 {
 586         if (Config->get_mmc_control()) {
 587                 request_stop ();
 588         }
 589 }
 590
 591 void
 592 Session::mmc_pause (MIDI::MachineControl &mmc)
 593 {
 594         if (Config->get_mmc_control()) {
 595
 596                 /* We support RECORD_PAUSE, so the spec says that
 597                    we must interpret PAUSE like RECORD_PAUSE if
 598                    recording.
 599                 */
 600
 601                 if (actively_recording()) {
 602                         maybe_enable_record ();
 603                 } else {
 604                         request_stop ();
 605                 }
 606         }
 607 }
 608
 609 static bool step_queued = false;
 610
 611 void
 612 Session::mmc_step (MIDI::MachineControl &mmc, int steps)
 613 {
 614         if (!Config->get_mmc_control()) {
 615                 return;
 616         }
 617
 618         struct timeval now;
 619         struct timeval diff = { 0, 0 };
 620
 621         gettimeofday (&now, 0);
 622
 623         timersub (&now, &last_mmc_step, &diff);
 624
 625         gettimeofday (&now, 0);
 626         timersub (&now, &last_mmc_step, &diff);
 627
 628         if (last_mmc_step.tv_sec != 0 && (diff.tv_usec + (diff.tv_sec * 1000000)) < _engine.usecs_per_cycle()) {
 629                 return;
 630         }
 631
 632         double diff_secs = diff.tv_sec + (diff.tv_usec / 1000000.0);
 633         double cur_speed = (((steps * 0.5) * smpte_frames_per_second()) / diff_secs) / smpte_frames_per_second();
 634
 635         if (_transport_speed == 0 || cur_speed * _transport_speed < 0) {
 636                 /* change direction */
 637                 step_speed = cur_speed;
 638         } else {
 639                 step_speed = (0.6 * step_speed) + (0.4 * cur_speed);
 640         }
 641
 642         step_speed *= 0.25;
 643
 644 #if 0
 645         cerr << "delta = " << diff_secs
 646              << " ct = " << _transport_speed
 647              << " steps = " << steps
 648              << " new speed = " << cur_speed
 649              << " speed = " << step_speed
 650              << endl;
 651 #endif
 652
 653         request_transport_speed (step_speed);
 654         last_mmc_step = now;
 655
 656         if (!step_queued) {
 657                 midi_timeouts.push_back (mem_fun (*this, &Session::mmc_step_timeout));
 658                 step_queued = true;
 659         }
 660 }
 661
 662 void
 663 Session::mmc_rewind (MIDI::MachineControl &mmc)
 664 {
 665         if (Config->get_mmc_control()) {
 666                 request_transport_speed(-8.0f);
 667         }
 668 }
 669
 670 void
 671 Session::mmc_fast_forward (MIDI::MachineControl &mmc)
 672 {
 673         if (Config->get_mmc_control()) {
 674                 request_transport_speed(8.0f);
 675         }
 676 }
 677
 678 void
 679 Session::mmc_locate (MIDI::MachineControl &mmc, const MIDI::byte* mmc_tc)
 680 {
 681         if (!Config->get_mmc_control()) {
 682                 return;
 683         }
 684
 685         nframes_t target_frame;
 686         SMPTE::Time smpte;
 687
 688         smpte.hours = mmc_tc[0] & 0xf;
 689         smpte.minutes = mmc_tc[1];
 690         smpte.seconds = mmc_tc[2];
 691         smpte.frames = mmc_tc[3];
 692         smpte.rate = smpte_frames_per_second();
 693         smpte.drop = smpte_drop_frames();
 694
 695         // Also takes smpte offset into account:
 696         smpte_to_sample( smpte, target_frame, true /* use_offset */, false /* use_subframes */ );
 697
 698         if (target_frame > max_frames) {
 699                 target_frame = max_frames;
 700         }
 701
 702         /* Some (all?) MTC/MMC devices do not send a full MTC frame
 703            at the end of a locate, instead sending only an MMC
 704            locate command. This causes the current position
 705            of an MTC slave to become out of date. Catch this.
 706         */
 707
 708         MTC_Slave* mtcs = dynamic_cast<MTC_Slave*> (_slave);
 709
 710         if (mtcs != 0) {
 711                 // cerr << "Locate *with* MTC slave\n";
 712                 mtcs->handle_locate (mmc_tc);
 713         } else {
 714                 // cerr << "Locate without MTC slave\n";
 715                 request_locate (target_frame, false);
 716         }
 717 }
 718
 719 void
 720 Session::mmc_shuttle (MIDI::MachineControl &mmc, float speed, bool forw)
 721 {
 722         if (!Config->get_mmc_control()) {
 723                 return;
 724         }
 725
 726         if (Config->get_shuttle_speed_threshold() >= 0 && speed > Config->get_shuttle_speed_threshold()) {
 727                 speed *= Config->get_shuttle_speed_factor();
 728         }
 729
 730         if (forw) {
 731                 request_transport_speed (speed);
 732         } else {
 733                 request_transport_speed (-speed);
 734         }
 735 }
 736
 737 void
 738 Session::mmc_record_enable (MIDI::MachineControl &mmc, size_t trk, bool enabled)
 739 {
 740         if (Config->get_mmc_control()) {
 741
 742                 RouteList::iterator i;
 743                 boost::shared_ptr<RouteList> r = routes.reader();
 744
 745                 for (i = r->begin(); i != r->end(); ++i) {
 746                         AudioTrack *at;
 747
 748                         if ((at = dynamic_cast<AudioTrack*>((*i).get())) != 0) {
 749                                 if (trk == at->remote_control_id()) {
 750                                         at->set_record_enable (enabled, &mmc);
 751                                         break;
 752                                 }
 753                         }
 754                 }
 755         }
 756 }
 757
 758 void
 759 Session::change_midi_ports ()
 760 {
 761         MIDIRequest* request = new MIDIRequest;
 762
 763         request->type = MIDIRequest::PortChange;
 764         midi_requests.write (&request, 1);
 765         poke_midi_thread ();
 766 }
 767
 768 /** Send MTC Full Frame message (complete SMPTE time) for the start of this cycle.
 769  * This resets the MTC code, the next quarter frame message that is sent will be
 770  * the first one with the beginning of this cycle as the new start point.
 771  */
 772
 773 int
 774 Session::send_full_time_code(nframes_t nframes)
 775 {
 776         /* This function could easily send at a given frame offset, but would
 777          * that be useful?  Does ardour do sub-block accurate locating? [DR] */
 778
 779         MIDI::byte msg[10];
 780         SMPTE::Time smpte;
 781
 782         _send_smpte_update = false;
 783
 784         if (_mtc_port == 0 || !session_send_mtc) {
 785                 return 0;
 786         }
 787
 788         // Get smpte time for this transport frame
 789         sample_to_smpte(_transport_frame, smpte, true /* use_offset */, false /* no subframes */);
 790
 791         transmitting_smpte_time = smpte;
 792         outbound_mtc_smpte_frame = _transport_frame;
 793
 794         // I don't understand this bit yet.. [DR]
 795         if (((mtc_smpte_bits >> 5) != MIDI::MTC_25_FPS) && (transmitting_smpte_time.frames % 2)) {
 796                 // start MTC quarter frame transmission on an even frame
 797                 SMPTE::increment( transmitting_smpte_time );
 798                 outbound_mtc_smpte_frame += (nframes_t) _frames_per_smpte_frame;
 799         }
 800
 801         // Compensate for audio latency
 802         outbound_mtc_smpte_frame += _worst_output_latency;
 803
 804         next_quarter_frame_to_send = 0;
 805
 806         // Sync slave to the same SMPTE time as we are on
 807         msg[0] = 0xf0;
 808         msg[1] = 0x7f;
 809         msg[2] = 0x7f;
 810         msg[3] = 0x1;
 811         msg[4] = 0x1;
 812         msg[9] = 0xf7;
 813
 814         msg[5] = mtc_smpte_bits | smpte.hours;
 815         msg[6] = smpte.minutes;
 816         msg[7] = smpte.seconds;
 817         msg[8] = smpte.frames;
 818
 819         cerr << "MTC: Sending full time code at " << outbound_mtc_smpte_frame << endl;
 820
 821         // Send message at offset 0, sent time is for the start of this cycle
 822         if (_mtc_port->midimsg (msg, sizeof (msg), 0)) {
 823                 error << _("Session: could not send full MIDI time code") << endmsg;
 824                 return -1;
 825         }
 826
 827         return 0;
 828 }
 829
 830
 831 /** Sends MTC (quarter-frame) messages for this cycle.
 832  * Must be called exactly once per cycle from the audio thread.  Realtime safe.
 833  * This function assumes the state of full SMPTE is sane, eg. the slave is
 834  * expecting quarter frame messages and has the right frame of reference (any
 835  * full MTC SMPTE time messages that needed to be sent should have been sent
 836  * earlier already this cycle by send_full_time_code)
 837  */
 838 int
 839 Session::send_midi_time_code_for_cycle(nframes_t nframes)
 840 {
 841         assert (next_quarter_frame_to_send >= 0);
 842         assert (next_quarter_frame_to_send <= 7);
 843
 844         if (_mtc_port == 0 || !session_send_mtc || transmitting_smpte_time.negative
 845             /*|| (next_quarter_frame_to_send < 0)*/ ) {
 846                 // cerr << "(MTC) Not sending MTC\n";
 847                 return 0;
 848         }
 849
 850         /* Duration of one quarter frame */
 851         nframes_t quarter_frame_duration = ((long) _frames_per_smpte_frame) >> 2;
 852
 853         // cerr << "(MTC) TR: " << _transport_frame << " - SF: " << outbound_mtc_smpte_frame
 854         // << " - NQ: " << next_quarter_frame_to_send << " - FD" << quarter_frame_duration << endl;
 855
 856         // FIXME: this should always be true
 857         //assert((outbound_mtc_smpte_frame + (next_quarter_frame_to_send * quarter_frame_duration))
 858         //              > _transport_frame);
 859
 860
 861         // Send quarter frames for this cycle
 862         while (_transport_frame + nframes > (outbound_mtc_smpte_frame +
 863                                 (next_quarter_frame_to_send * quarter_frame_duration))) {
 864
 865                 // cerr << "(MTC) Next frame to send: " << next_quarter_frame_to_send << endl;
 866
 867                 switch (next_quarter_frame_to_send) {
 868                         case 0:
 869                                 mtc_msg[1] =  0x00 | (transmitting_smpte_time.frames & 0xf);
 870                                 break;
 871                         case 1:
 872                                 mtc_msg[1] =  0x10 | ((transmitting_smpte_time.frames & 0xf0) >> 4);
 873                                 break;
 874                         case 2:
 875                                 mtc_msg[1] =  0x20 | (transmitting_smpte_time.seconds & 0xf);
 876                                 break;
 877                         case 3:
 878                                 mtc_msg[1] =  0x30 | ((transmitting_smpte_time.seconds & 0xf0) >> 4);
 879                                 break;
 880                         case 4:
 881                                 mtc_msg[1] =  0x40 | (transmitting_smpte_time.minutes & 0xf);
 882                                 break;
 883                         case 5:
 884                                 mtc_msg[1] = 0x50 | ((transmitting_smpte_time.minutes & 0xf0) >> 4);
 885                                 break;
 886                         case 6:
 887                                 mtc_msg[1] = 0x60 | ((mtc_smpte_bits|transmitting_smpte_time.hours) & 0xf);
 888                                 break;
 889                         case 7:
 890                                 mtc_msg[1] = 0x70 | (((mtc_smpte_bits|transmitting_smpte_time.hours) & 0xf0) >> 4);
 891                                 break;
 892                 }
 893
 894                 const nframes_t msg_time = (outbound_mtc_smpte_frame
 895                         + (quarter_frame_duration * next_quarter_frame_to_send));
 896
 897                 // This message must fall within this block or something is broken
 898                 assert(msg_time >= _transport_frame);
 899                 assert(msg_time < _transport_frame + nframes);
 900
 901                 nframes_t out_stamp = msg_time - _transport_frame;
 902                 assert(out_stamp < nframes);
 903
 904                 if (_mtc_port->midimsg (mtc_msg, 2, out_stamp)) {
 905                         error << string_compose(_("Session: cannot send quarter-frame MTC message (%1)"), strerror (errno))
 906                               << endmsg;
 907                         return -1;
 908                 }
 909
 910                 /*cerr << "(MTC) SMPTE: " << transmitting_smpte_time.hours
 911                         << ":" << transmitting_smpte_time.minutes
 912                         << ":" << transmitting_smpte_time.seconds
 913                         << ":" << transmitting_smpte_time.frames
 914                         << ", qfm = " << next_quarter_frame_to_send
 915                         << ", stamp = " << out_stamp
 916                         << ", delta = " << _transport_frame + out_stamp - last_time << endl;*/
 917
 918                 // Increment quarter frame counter
 919                 next_quarter_frame_to_send++;
 920
 921                 if (next_quarter_frame_to_send >= 8) {
 922                         // Wrap quarter frame counter
 923                         next_quarter_frame_to_send = 0;
 924                         // Increment smpte time twice
 925                         SMPTE::increment( transmitting_smpte_time );
 926                         SMPTE::increment( transmitting_smpte_time );
 927                         // Re-calculate timing of first quarter frame
 928                         //smpte_to_sample( transmitting_smpte_time, outbound_mtc_smpte_frame, true /* use_offset */, false );
 929                         outbound_mtc_smpte_frame += 8 * quarter_frame_duration;
 930                         // Compensate for audio latency
 931                         outbound_mtc_smpte_frame += _worst_output_latency;
 932                 }
 933         }
 934
 935         return 0;
 936 }
 937
 938 /***********************************************************************
 939  OUTBOUND MMC STUFF
 940 **********************************************************************/
 941
 942 void
 943 Session::deliver_mmc (MIDI::MachineControl::Command cmd, nframes_t where)
 944 {
 945         using namespace MIDI;
 946         int nbytes = 4;
 947         SMPTE::Time smpte;
 948
 949         if (_mmc_port == 0 || !session_send_mmc) {
 950                 // cerr << "Not delivering MMC " << _mmc_port << " - " << session_send_mmc << endl;
 951                 return;
 952         }
 953
 954         mmc_buffer[nbytes++] = cmd;
 955
 956         // cerr << "delivering MMC, cmd = " << hex << (int) cmd << dec << endl;
 957
 958         switch (cmd) {
 959         case MachineControl::cmdLocate:
 960                 smpte_time_subframes (where, smpte);
 961
 962                 mmc_buffer[nbytes++] = 0x6; // byte count
 963                 mmc_buffer[nbytes++] = 0x1; // "TARGET" subcommand
 964                 mmc_buffer[nbytes++] = smpte.hours;
 965                 mmc_buffer[nbytes++] = smpte.minutes;
 966                 mmc_buffer[nbytes++] = smpte.seconds;
 967                 mmc_buffer[nbytes++] = smpte.frames;
 968                 mmc_buffer[nbytes++] = smpte.subframes;
 969                 break;
 970
 971         case MachineControl::cmdStop:
 972                 break;
 973
 974         case MachineControl::cmdPlay:
 975                 /* always convert Play into Deferred Play */
 976                 /* Why? [DR] */
 977                 mmc_buffer[4] = MachineControl::cmdDeferredPlay;
 978                 break;
 979
 980         case MachineControl::cmdDeferredPlay:
 981                 break;
 982
 983         case MachineControl::cmdRecordStrobe:
 984                 break;
 985
 986         case MachineControl::cmdRecordExit:
 987                 break;
 988
 989         case MachineControl::cmdRecordPause:
 990                 break;
 991
 992         default:
 993                 nbytes = 0;
 994         };
 995
 996         if (nbytes) {
 997
 998                 mmc_buffer[nbytes++] = 0xf7; // terminate SysEx/MMC message
 999
1000                 if (_mmc_port->midimsg (mmc_buffer, nbytes, 0)) {
1001                         error << string_compose(_("MMC: cannot send command %1%2%3"), &hex, cmd, &dec) << endmsg;
1002                 }
1003         }
1004 }
1005
1006 bool
1007 Session::mmc_step_timeout ()
1008 {
1009         struct timeval now;
1010         struct timeval diff;
1011         double diff_usecs;
1012         gettimeofday (&now, 0);
1013
1014         timersub (&now, &last_mmc_step, &diff);
1015         diff_usecs = diff.tv_sec * 1000000 + diff.tv_usec;
1016
1017         if (diff_usecs > 1000000.0 || fabs (_transport_speed) < 0.0000001) {
1018                 /* too long or too slow, stop transport */
1019                 request_transport_speed (0.0);
1020                 step_queued = false;
1021                 return false;
1022         }
1023
1024         if (diff_usecs < 250000.0) {
1025                 /* too short, just keep going */
1026                 return true;
1027         }
1028
1029         /* slow it down */
1030
1031         request_transport_speed (_transport_speed * 0.75);
1032         return true;
1033 }
1034
1035 /*---------------------------------------------------------------------------
1036   MIDI THREAD
1037   ---------------------------------------------------------------------------*/
1038
1039 int
1040 Session::start_midi_thread ()
1041 {
1042         if (pipe (midi_request_pipe)) {
1043                 error << string_compose(_("Cannot create transport request signal pipe (%1)"), strerror (errno)) << endmsg;
1044                 return -1;
1045         }
1046
1047         if (fcntl (midi_request_pipe[0], F_SETFL, O_NONBLOCK)) {
1048                 error << string_compose(_("UI: cannot set O_NONBLOCK on "    "signal read pipe (%1)"), strerror (errno)) << endmsg;
1049                 return -1;
1050         }
1051
1052         if (fcntl (midi_request_pipe[1], F_SETFL, O_NONBLOCK)) {
1053                 error << string_compose(_("UI: cannot set O_NONBLOCK on "    "signal write pipe (%1)"), strerror (errno)) << endmsg;
1054                 return -1;
1055         }
1056
1057         if (pthread_create_and_store ("transport", &midi_thread, 0, _midi_thread_work, this)) {
1058                 error << _("Session: could not create transport thread") << endmsg;
1059                 return -1;
1060         }
1061
1062         return 0;
1063 }
1064
1065 void
1066 Session::terminate_midi_thread ()
1067 {
1068         if (midi_thread) {
1069
1070                 MIDIRequest* request = new MIDIRequest;
1071                 void* status;
1072
1073                 request->type = MIDIRequest::Quit;
1074
1075                 midi_requests.write (&request, 1);
1076                 poke_midi_thread ();
1077
1078                 pthread_join (midi_thread, &status);
1079         }
1080 }
1081
1082 void
1083 Session::poke_midi_thread ()
1084 {
1085         static char c = 0;
1086
1087         if (write (midi_request_pipe[1], &c, 1) != 1) {
1088                 error << string_compose(_("cannot send signal to midi thread! (%1)"), strerror (errno)) << endmsg;
1089         }
1090 }
1091
1092 void *
1093 Session::_midi_thread_work (void* arg)
1094 {
1095         pthread_setcancelstate (PTHREAD_CANCEL_ENABLE, 0);
1096         pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
1097
1098         ((Session *) arg)->midi_thread_work ();
1099         return 0;
1100 }
1101
1102 void
1103 Session::midi_thread_work ()
1104 {
1105         MIDIRequest* request;
1106         struct pollfd pfd[4];
1107         int nfds = 0;
1108         int timeout;
1109         int fds_ready;
1110         struct sched_param rtparam;
1111         int x;
1112         bool restart;
1113         vector<MIDI::Port*> ports;
1114
1115         PBD::ThreadCreatedWithRequestSize (pthread_self(), X_("MIDI"), 2048);
1116
1117         memset (&rtparam, 0, sizeof (rtparam));
1118         rtparam.sched_priority = 9; /* XXX should be relative to audio (JACK) thread */
1119
1120         if ((x = pthread_setschedparam (pthread_self(), SCHED_FIFO, &rtparam)) != 0) {
1121                 // do we care? not particularly.
1122         }
1123
1124         /* set up the port vector; 5 is the largest possible size for now */
1125
1126         ports.assign (5, (MIDI::Port*) 0);
1127
1128         while (1) {
1129
1130                 nfds = 0;
1131
1132                 pfd[nfds].fd = midi_request_pipe[0];
1133                 pfd[nfds].events = POLLIN|POLLHUP|POLLERR;
1134                 nfds++;
1135
1136                 if (Config->get_mmc_control() && _mmc_port && _mmc_port->selectable() >= 0) {
1137                         pfd[nfds].fd = _mmc_port->selectable();
1138                         pfd[nfds].events = POLLIN|POLLHUP|POLLERR;
1139                         ports[nfds] = _mmc_port;
1140                         nfds++;
1141                 }
1142
1143                 /* if MTC is being handled on a different port from MMC
1144                    or we are not handling MMC at all, poll
1145                    the relevant port.
1146                 */
1147
1148                 if (_mtc_port && (_mtc_port != _mmc_port || !Config->get_mmc_control()) && _mtc_port->selectable() >= 0) {
1149                         pfd[nfds].fd = _mtc_port->selectable();
1150                         pfd[nfds].events = POLLIN|POLLHUP|POLLERR;
1151                         ports[nfds] = _mtc_port;
1152                         nfds++;
1153                 }
1154
1155                 cerr << "before handling midi clock port" << endl;
1156                 if (_midi_clock_port && (_midi_clock_port != _mmc_port || !Config->get_mmc_control()) && _midi_clock_port->selectable() >= 0) {
1157                         cerr << "inside handling midi clock port" << endl;
1158                         pfd[nfds].fd = _midi_clock_port->selectable();
1159                         pfd[nfds].events = POLLIN|POLLHUP|POLLERR;
1160                         ports[nfds] = _midi_clock_port;
1161                         nfds++;
1162                 }
1163
1164                 /* if we are using MMC control, we obviously have to listen
1165                    the relevant port.
1166                 */
1167
1168                 if (_midi_port && (_midi_port != _mmc_port || !Config->get_mmc_control()) && (_midi_port != _mtc_port) && _midi_port->selectable() >= 0) {
1169                         pfd[nfds].fd = _midi_port->selectable();
1170                         pfd[nfds].events = POLLIN|POLLHUP|POLLERR;
1171                         ports[nfds] = _midi_port;
1172                         nfds++;
1173                 }
1174
1175                 if (!midi_timeouts.empty()) {
1176                         timeout = 100; /* 10msecs */
1177                 } else {
1178                         timeout = -1; /* if there is no data, we don't care */
1179                 }
1180
1181           again:
1182                 // cerr << "MIDI poll on " << nfds << " for " << timeout << endl;
1183                 if (poll (pfd, nfds, timeout) < 0) {
1184                         if (errno == EINTR) {
1185                                 /* gdb at work, perhaps */
1186                                 goto again;
1187                         }
1188
1189                         error << string_compose(_("MIDI thread poll failed (%1)"), strerror (errno)) << endmsg;
1190
1191                         break;
1192                 }
1193                 // cerr << "MIDI thread wakes at " << get_cycles () << endl;
1194
1195                 fds_ready = 0;
1196
1197                 /* check the transport request pipe */
1198
1199                 if (pfd[0].revents & ~POLLIN) {
1200                         error << _("Error on transport thread request pipe") << endmsg;
1201                         break;
1202                 }
1203
1204                 if (pfd[0].revents & POLLIN) {
1205
1206                         char foo[16];
1207
1208                         // cerr << "MIDI request FIFO ready\n";
1209                         fds_ready++;
1210
1211                         /* empty the pipe of all current requests */
1212
1213                         while (1) {
1214                                 size_t nread = read (midi_request_pipe[0], &foo, sizeof (foo));
1215
1216                                 if (nread > 0) {
1217                                         if ((size_t) nread < sizeof (foo)) {
1218                                                 break;
1219                                         } else {
1220                                                 continue;
1221                                         }
1222                                 } else if (nread == 0) {
1223                                         break;
1224                                 } else if (errno == EAGAIN) {
1225                                         break;
1226                                 } else {
1227                                         fatal << _("Error reading from transport request pipe") << endmsg;
1228                                         /*NOTREACHED*/
1229                                 }
1230                         }
1231
1232                         while (midi_requests.read (&request, 1) == 1) {
1233
1234                                 switch (request->type) {
1235                                 case MIDIRequest::PortChange:
1236                                         /* restart poll with new ports */
1237                                         // cerr << "rebind\n";
1238                                         restart = true;
1239                                         break;
1240
1241                                 case MIDIRequest::Quit:
1242                                         delete request;
1243                                         pthread_exit_pbd (0);
1244                                         /*NOTREACHED*/
1245                                         break;
1246
1247                                 default:
1248                                         break;
1249                                 }
1250
1251
1252                                 delete request;
1253                         }
1254
1255                 }
1256
1257                 if (restart) {
1258                         continue;
1259                 }
1260
1261                 /* now read the rest of the ports */
1262
1263                 for (int p = 1; p < nfds; ++p) {
1264                         if ((pfd[p].revents & ~POLLIN)) {
1265                                 // error << string_compose(_("Transport: error polling MIDI port %1 (revents =%2%3%4"), p, &hex, pfd[p].revents, &dec) << endmsg;
1266                                 break;
1267                         }
1268
1269                         if (pfd[p].revents & POLLIN) {
1270                                 fds_ready++;
1271                                 ports[p]->parse ();
1272                         }
1273                 }
1274
1275                 /* timeout driven */
1276
1277                 if (fds_ready < 2 && timeout != -1) {
1278
1279                         for (MidiTimeoutList::iterator i = midi_timeouts.begin(); i != midi_timeouts.end(); ) {
1280
1281                                 MidiTimeoutList::iterator tmp;
1282                                 tmp = i;
1283                                 ++tmp;
1284
1285                                 if (!(*i)()) {
1286                                         midi_timeouts.erase (i);
1287                                 }
1288
1289                                 i = tmp;
1290                         }
1291                 }
1292         }
1293 }
1294