libs/ardour/audioengine.cc

   1 /*
   2     Copyright (C) 2002 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #include <unistd.h>
  21 #include <cerrno>
  22 #include <vector>
  23 #include <exception>
  24 #include <stdexcept>
  25
  26 #include <glibmm/timer.h>
  27 #include <pbd/pthread_utils.h>
  28 #include <pbd/stacktrace.h>
  29 #include <pbd/unknown_type.h>
  30
  31 #include <ardour/audioengine.h>
  32 #include <ardour/buffer.h>
  33 #include <ardour/port.h>
  34 #include <ardour/audio_port.h>
  35 #include <ardour/midi_port.h>
  36 #include <ardour/session.h>
  37 #include <ardour/cycle_timer.h>
  38 #include <ardour/utils.h>
  39 #ifdef VST_SUPPORT
  40 #include <fst.h>
  41 #endif
  42
  43 #include <ardour/timestamps.h>
  44
  45 #include "i18n.h"
  46
  47 using namespace std;
  48 using namespace ARDOUR;
  49 using namespace PBD;
  50
  51 gint AudioEngine::m_meter_exit;
  52
  53 static void
  54 ardour_jack_error (const char* msg)
  55 {
  56         error << "JACK: " << msg << endmsg;
  57 }
  58
  59 AudioEngine::AudioEngine (string client_name)
  60         : ports (new Ports)
  61 {
  62         session = 0;
  63         session_remove_pending = false;
  64         _running = false;
  65         _has_run = false;
  66         last_monitor_check = 0;
  67         monitor_check_interval = max_frames;
  68         _processed_frames = 0;
  69         _freewheeling = false;
  70         _usecs_per_cycle = 0;
  71         _jack = 0;
  72         _frame_rate = 0;
  73         _buffer_size = 0;
  74         _freewheeling = false;
  75         _freewheel_thread_registered = false;
  76
  77         m_meter_thread = 0;
  78         g_atomic_int_set (&m_meter_exit, 0);
  79
  80         if (connect_to_jack (client_name)) {
  81                 throw NoBackendAvailable ();
  82         }
  83
  84         start_metering_thread();
  85
  86 }
  87
  88 AudioEngine::~AudioEngine ()
  89 {
  90         {
  91                 Glib::Mutex::Lock tm (_process_lock);
  92                 session_removed.signal ();
  93
  94                 if (_running) {
  95                         jack_client_close (_jack);
  96                 }
  97
  98                 stop_metering_thread ();
  99         }
 100 }
 101
 102 void
 103 _thread_init_callback (void *arg)
 104 {
 105         /* make sure that anybody who needs to know about this thread
 106            knows about it.
 107         */
 108
 109         PBD::ThreadCreatedWithRequestSize (pthread_self(), X_("Audioengine"), 4096);
 110 }
 111
 112 int
 113 AudioEngine::start ()
 114 {
 115         if (!_running) {
 116
 117                 if (session) {
 118                         nframes_t blocksize = jack_get_buffer_size (_jack);
 119
 120                         session->set_block_size (blocksize);
 121                         session->set_frame_rate (jack_get_sample_rate (_jack));
 122
 123                         /* page in as much of the session process code as we
 124                            can before we really start running.
 125                         */
 126
 127                         session->process (blocksize);
 128                         session->process (blocksize);
 129                         session->process (blocksize);
 130                         session->process (blocksize);
 131                         session->process (blocksize);
 132                         session->process (blocksize);
 133                         session->process (blocksize);
 134                         session->process (blocksize);
 135                 }
 136
 137                 _processed_frames = 0;
 138                 last_monitor_check = 0;
 139
 140                 jack_on_shutdown (_jack, halted, this);
 141                 jack_set_graph_order_callback (_jack, _graph_order_callback, this);
 142                 jack_set_thread_init_callback (_jack, _thread_init_callback, this);
 143                 jack_set_process_callback (_jack, _process_callback, this);
 144                 jack_set_sample_rate_callback (_jack, _sample_rate_callback, this);
 145                 jack_set_buffer_size_callback (_jack, _bufsize_callback, this);
 146                 jack_set_xrun_callback (_jack, _xrun_callback, this);
 147                 jack_set_sync_callback (_jack, _jack_sync_callback, this);
 148                 jack_set_freewheel_callback (_jack, _freewheel_callback, this);
 149
 150                 if (Config->get_jack_time_master()) {
 151                         jack_set_timebase_callback (_jack, 0, _jack_timebase_callback, this);
 152                 }
 153
 154                 if (jack_activate (_jack) == 0) {
 155                         _running = true;
 156                         _has_run = true;
 157                         Running(); /* EMIT SIGNAL */
 158                 } else {
 159                         error << _("cannot activate JACK client") << endmsg;
 160                 }
 161         }
 162
 163         return _running ? 0 : -1;
 164 }
 165
 166 int
 167 AudioEngine::stop (bool forever)
 168 {
 169         if (_running) {
 170                 _running = false;
 171                 if (forever) {
 172                         jack_client_t* foo = _jack;
 173                         _jack = 0;
 174                         jack_client_close (foo);
 175                         stop_metering_thread ();
 176                 } else {
 177                         jack_deactivate (_jack);
 178                 }
 179                 Stopped(); /* EMIT SIGNAL */
 180         }
 181
 182         return _running ? -1 : 0;
 183 }
 184
 185
 186 bool
 187 AudioEngine::get_sync_offset (nframes_t& offset) const
 188 {
 189
 190 #ifdef HAVE_JACK_VIDEO_SUPPORT
 191
 192         jack_position_t pos;
 193
 194         (void) jack_transport_query (_jack, &pos);
 195
 196         if (pos.valid & JackVideoFrameOffset) {
 197                 offset = pos.video_offset;
 198                 return true;
 199         }
 200
 201 #endif
 202
 203         return false;
 204 }
 205
 206 void
 207 AudioEngine::_jack_timebase_callback (jack_transport_state_t state, nframes_t nframes,
 208                                       jack_position_t* pos, int new_position, void *arg)
 209 {
 210         static_cast<AudioEngine*> (arg)->jack_timebase_callback (state, nframes, pos, new_position);
 211 }
 212
 213 void
 214 AudioEngine::jack_timebase_callback (jack_transport_state_t state, nframes_t nframes,
 215                                      jack_position_t* pos, int new_position)
 216 {
 217         if (_jack && session && session->synced_to_jack()) {
 218                 session->jack_timebase_callback (state, nframes, pos, new_position);
 219         }
 220 }
 221
 222 int
 223 AudioEngine::_jack_sync_callback (jack_transport_state_t state, jack_position_t* pos, void* arg)
 224 {
 225         return static_cast<AudioEngine*> (arg)->jack_sync_callback (state, pos);
 226 }
 227
 228 int
 229 AudioEngine::jack_sync_callback (jack_transport_state_t state, jack_position_t* pos)
 230 {
 231         if (_jack && session) {
 232                 return session->jack_sync_callback (state, pos);
 233         }
 234
 235         return true;
 236 }
 237
 238 int
 239 AudioEngine::_xrun_callback (void *arg)
 240 {
 241         AudioEngine* ae = static_cast<AudioEngine*> (arg);
 242         if (ae->jack()) {
 243                 ae->Xrun (); /* EMIT SIGNAL */
 244         }
 245         return 0;
 246 }
 247
 248 int
 249 AudioEngine::_graph_order_callback (void *arg)
 250 {
 251         AudioEngine* ae = static_cast<AudioEngine*> (arg);
 252         if (ae->jack()) {
 253                 ae->GraphReordered (); /* EMIT SIGNAL */
 254         }
 255         return 0;
 256 }
 257
 258 int
 259 AudioEngine::_process_callback (nframes_t nframes, void *arg)
 260 {
 261         return static_cast<AudioEngine *> (arg)->process_callback (nframes);
 262 }
 263
 264 void
 265 AudioEngine::_freewheel_callback (int onoff, void *arg)
 266 {
 267         static_cast<AudioEngine*>(arg)->_freewheeling = onoff;
 268 }
 269
 270 int
 271 AudioEngine::process_callback (nframes_t nframes)
 272 {
 273         // CycleTimer ct ("AudioEngine::process");
 274         Glib::Mutex::Lock tm (_process_lock, Glib::TRY_LOCK);
 275         nframes_t next_processed_frames;
 276
 277         /* handle wrap around of total frames counter */
 278
 279         if (max_frames - _processed_frames < nframes) {
 280                 next_processed_frames = nframes - (max_frames - _processed_frames);
 281         } else {
 282                 next_processed_frames = _processed_frames + nframes;
 283         }
 284
 285         if (!tm.locked() || session == 0) {
 286                 _processed_frames = next_processed_frames;
 287                 return 0;
 288         }
 289
 290         if (session_remove_pending) {
 291                 session = 0;
 292                 session_remove_pending = false;
 293                 session_removed.signal();
 294                 _processed_frames = next_processed_frames;
 295                 return 0;
 296         }
 297
 298         if (_freewheeling) {
 299                 if (Freewheel (nframes)) {
 300                         cerr << "Freewheeling returned non-zero!\n";
 301                         _freewheeling = false;
 302                         jack_set_freewheel (_jack, false);
 303                 }
 304                 return 0;
 305         }
 306
 307         boost::shared_ptr<Ports> p = ports.reader();
 308
 309         // Prepare ports (ie read data if necessary)
 310         for (Ports::iterator i = p->begin(); i != p->end(); ++i)
 311                 (*i)->cycle_start(nframes);
 312
 313         session->process (nframes);
 314
 315         if (!_running) {
 316                 /* we were zombified, maybe because a ladspa plugin took
 317                    too long, or jackd exited, or something like that.
 318                 */
 319
 320                 _processed_frames = next_processed_frames;
 321                 return 0;
 322         }
 323
 324         // Finalize ports (ie write data if necessary)
 325         for (Ports::iterator i = p->begin(); i != p->end(); ++i)
 326                 (*i)->cycle_end();
 327
 328         if (last_monitor_check + monitor_check_interval < next_processed_frames) {
 329
 330                 boost::shared_ptr<Ports> p = ports.reader();
 331
 332                 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
 333
 334                         Port *port = (*i);
 335                         bool x;
 336
 337                         if (port->_last_monitor != (x = port->monitoring_input ())) {
 338                                 port->_last_monitor = x;
 339                                 /* XXX I think this is dangerous, due to
 340                                    a likely mutex in the signal handlers ...
 341                                 */
 342                                  port->MonitorInputChanged (x); /* EMIT SIGNAL */
 343                         }
 344                 }
 345                 last_monitor_check = next_processed_frames;
 346         }
 347
 348         _processed_frames = next_processed_frames;
 349         return 0;
 350 }
 351
 352 int
 353 AudioEngine::_sample_rate_callback (nframes_t nframes, void *arg)
 354 {
 355         return static_cast<AudioEngine *> (arg)->jack_sample_rate_callback (nframes);
 356 }
 357
 358 int
 359 AudioEngine::jack_sample_rate_callback (nframes_t nframes)
 360 {
 361         _frame_rate = nframes;
 362         _usecs_per_cycle = (int) floor ((((double) frames_per_cycle() / nframes)) * 1000000.0);
 363
 364         /* check for monitor input change every 1/10th of second */
 365
 366         monitor_check_interval = nframes / 10;
 367         last_monitor_check = 0;
 368
 369         if (session) {
 370                 session->set_frame_rate (nframes);
 371         }
 372
 373         SampleRateChanged (nframes); /* EMIT SIGNAL */
 374
 375         return 0;
 376 }
 377
 378 int
 379 AudioEngine::_bufsize_callback (nframes_t nframes, void *arg)
 380 {
 381         return static_cast<AudioEngine *> (arg)->jack_bufsize_callback (nframes);
 382 }
 383
 384 int
 385 AudioEngine::jack_bufsize_callback (nframes_t nframes)
 386 {
 387         _buffer_size = nframes;
 388         _usecs_per_cycle = (int) floor ((((double) nframes / frame_rate())) * 1000000.0);
 389         last_monitor_check = 0;
 390
 391         boost::shared_ptr<Ports> p = ports.reader();
 392
 393         for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
 394                 (*i)->reset();
 395         }
 396
 397         if (session) {
 398                 session->set_block_size (_buffer_size);
 399         }
 400
 401         return 0;
 402 }
 403
 404 void
 405 AudioEngine::stop_metering_thread ()
 406 {
 407         if (m_meter_thread) {
 408                 g_atomic_int_set (&m_meter_exit, 1);
 409                 m_meter_thread->join ();
 410                 m_meter_thread = 0;
 411         }
 412 }
 413
 414 void
 415 AudioEngine::start_metering_thread ()
 416 {
 417         if (m_meter_thread == 0) {
 418                 m_meter_thread = Glib::Thread::create (sigc::mem_fun(this, &AudioEngine::meter_thread),
 419                                 500000, true, true, Glib::THREAD_PRIORITY_NORMAL);
 420         }
 421 }
 422
 423 void
 424 AudioEngine::meter_thread ()
 425 {
 426         while (true) {
 427                 Glib::usleep (10000); /* 1/100th sec interval */
 428                 if (g_atomic_int_get(&m_meter_exit)) {
 429                         break;
 430                 }
 431                 IO::update_meters ();
 432         }
 433 }
 434
 435 void
 436 AudioEngine::set_session (Session *s)
 437 {
 438         Glib::Mutex::Lock pl (_process_lock);
 439
 440         if (!session) {
 441
 442                 session = s;
 443
 444                 nframes_t blocksize = jack_get_buffer_size (_jack);
 445
 446                 /* page in as much of the session process code as we
 447                    can before we really start running.
 448                 */
 449
 450                 session->process (blocksize);
 451                 session->process (blocksize);
 452                 session->process (blocksize);
 453                 session->process (blocksize);
 454                 session->process (blocksize);
 455                 session->process (blocksize);
 456                 session->process (blocksize);
 457                 session->process (blocksize);
 458         }
 459 }
 460
 461 void
 462 AudioEngine::remove_session ()
 463 {
 464         Glib::Mutex::Lock lm (_process_lock);
 465
 466         if (_running) {
 467
 468                 if (session) {
 469                         session_remove_pending = true;
 470                         session_removed.wait(_process_lock);
 471                 }
 472
 473         } else {
 474                 session = 0;
 475         }
 476
 477         remove_all_ports ();
 478 }
 479
 480 Port *
 481 AudioEngine::register_input_port (DataType type, const string& portname)
 482 {
 483         if (!_running) {
 484                 if (!_has_run) {
 485                         fatal << _("register input port called before engine was started") << endmsg;
 486                         /*NOTREACHED*/
 487                 } else {
 488                         return 0;
 489                 }
 490         }
 491
 492         jack_port_t *p = jack_port_register (_jack, portname.c_str(), type.to_jack_type(), JackPortIsInput, 0);
 493
 494         if (p) {
 495
 496                 Port* newport = 0;
 497
 498                 if (type == DataType::AUDIO)
 499                         newport = new AudioPort (p);
 500                 else if (type == DataType::MIDI)
 501                         newport = new MidiPort (p);
 502                 else
 503                         throw unknown_type();
 504
 505                 if (newport != 0) {
 506                         RCUWriter<Ports> writer (ports);
 507                         boost::shared_ptr<Ports> ps = writer.get_copy ();
 508                         ps->insert (ps->begin(), newport);
 509                         /* writer goes out of scope, forces update */
 510                 }
 511
 512                 return newport;
 513
 514         } else {
 515                 throw PortRegistrationFailure();
 516         }
 517
 518         return 0;
 519 }
 520
 521 Port *
 522 AudioEngine::register_output_port (DataType type, const string& portname)
 523 {
 524         if (!_running) {
 525                 if (!_has_run) {
 526                         fatal << _("register output port called before engine was started") << endmsg;
 527                         /*NOTREACHED*/
 528                 } else {
 529                         return 0;
 530                 }
 531         }
 532
 533         jack_port_t* p = 0;
 534
 535         if ((p = jack_port_register (_jack, portname.c_str(),
 536                         type.to_jack_type(), JackPortIsOutput, 0)) != 0) {
 537
 538                 Port* newport = 0;
 539
 540                 if (type == DataType::AUDIO)
 541                         newport = new AudioPort (p);
 542                 else if (type == DataType::MIDI)
 543                         newport = new MidiPort (p);
 544                 else
 545                         throw unknown_type ();
 546
 547                 if (newport != 0) {
 548                         RCUWriter<Ports> writer (ports);
 549                         boost::shared_ptr<Ports> ps = writer.get_copy ();
 550                         ps->insert (ps->begin(), newport);
 551                         /* writer goes out of scope, forces update */
 552                 }
 553
 554                 return newport;
 555
 556         } else {
 557                 throw PortRegistrationFailure ();
 558         }
 559
 560         return 0;
 561 }
 562
 563
 564 int
 565 AudioEngine::unregister_port (Port& port)
 566 {
 567         if (!_running) {
 568                 /* probably happening when the engine has been halted by JACK,
 569                    in which case, there is nothing we can do here.
 570                    */
 571                 return 0;
 572         }
 573
 574         int ret = jack_port_unregister (_jack, port._port);
 575
 576         if (ret == 0) {
 577
 578                 {
 579
 580                         RCUWriter<Ports> writer (ports);
 581                         boost::shared_ptr<Ports> ps = writer.get_copy ();
 582
 583                         for (Ports::iterator i = ps->begin(); i != ps->end(); ++i) {
 584                                 if ((*i) == &port) {
 585                                         ps->erase (i);
 586                                         break;
 587                                 }
 588                         }
 589
 590                         /* writer goes out of scope, forces update */
 591                 }
 592
 593                 remove_connections_for (port);
 594         }
 595
 596         return ret;
 597 }
 598
 599 int
 600 AudioEngine::connect (const string& source, const string& destination)
 601 {
 602         if (!_running) {
 603                 if (!_has_run) {
 604                         fatal << _("connect called before engine was started") << endmsg;
 605                         /*NOTREACHED*/
 606                 } else {
 607                         return -1;
 608                 }
 609         }
 610
 611         string s = make_port_name_non_relative (source);
 612         string d = make_port_name_non_relative (destination);
 613
 614         int ret = jack_connect (_jack, s.c_str(), d.c_str());
 615
 616         if (ret == 0) {
 617                 pair<string,string> c (s, d);
 618                 port_connections.push_back (c);
 619         } else if (ret == EEXIST) {
 620                 error << string_compose(_("AudioEngine: connection already exists: %1 (%2) to %3 (%4)"),
 621                                  source, s, destination, d)
 622                       << endmsg;
 623         } else {
 624                 error << string_compose(_("AudioEngine: cannot connect %1 (%2) to %3 (%4)"),
 625                                  source, s, destination, d)
 626                       << endmsg;
 627         }
 628
 629         return ret;
 630 }
 631
 632 int
 633 AudioEngine::disconnect (const string& source, const string& destination)
 634 {
 635         if (!_running) {
 636                 if (!_has_run) {
 637                         fatal << _("disconnect called before engine was started") << endmsg;
 638                         /*NOTREACHED*/
 639                 } else {
 640                         return -1;
 641                 }
 642         }
 643
 644         string s = make_port_name_non_relative (source);
 645         string d = make_port_name_non_relative (destination);
 646
 647         int ret = jack_disconnect (_jack, s.c_str(), d.c_str());
 648
 649         if (ret == 0) {
 650                 pair<string,string> c (s, d);
 651                 PortConnections::iterator i;
 652
 653                 if ((i = find (port_connections.begin(), port_connections.end(), c)) != port_connections.end()) {
 654                         port_connections.erase (i);
 655                 }
 656         }
 657
 658         return ret;
 659 }
 660
 661 int
 662 AudioEngine::disconnect (Port& port)
 663 {
 664         if (!_running) {
 665                 if (!_has_run) {
 666                         fatal << _("disconnect called before engine was started") << endmsg;
 667                         /*NOTREACHED*/
 668                 } else {
 669                         return -1;
 670                 }
 671         }
 672
 673         int ret = jack_port_disconnect (_jack, port._port);
 674
 675         if (ret == 0) {
 676                 remove_connections_for (port);
 677         }
 678
 679         return ret;
 680
 681 }
 682
 683 ARDOUR::nframes_t
 684 AudioEngine::frame_rate ()
 685 {
 686         if (_jack) {
 687                 if (_frame_rate == 0) {
 688                         return (_frame_rate = jack_get_sample_rate (_jack));
 689                 } else {
 690                         return _frame_rate;
 691                 }
 692         } else {
 693                 fatal << X_("programming error: AudioEngine::frame_rate() called while disconnected from JACK")
 694                       << endmsg;
 695                 /*NOTREACHED*/
 696                 return 0;
 697         }
 698 }
 699
 700 ARDOUR::nframes_t
 701 AudioEngine::frames_per_cycle ()
 702 {
 703         if (_jack) {
 704                 if (_buffer_size == 0) {
 705                         return (_buffer_size = jack_get_buffer_size (_jack));
 706                 } else {
 707                         return _buffer_size;
 708                 }
 709         } else {
 710                 fatal << X_("programming error: AudioEngine::frame_rate() called while disconnected from JACK")
 711                       << endmsg;
 712                 /*NOTREACHED*/
 713                 return 0;
 714         }
 715 }
 716
 717 /** Get a port by name.
 718  * Note this can return NULL, it will NOT create a port if it is not found (any more).
 719  */
 720 Port *
 721 AudioEngine::get_port_by_name (const string& portname, bool keep)
 722 {
 723         Glib::Mutex::Lock lm (_process_lock);
 724
 725         if (!_running) {
 726                 if (!_has_run) {
 727                         fatal << _("get_port_by_name() called before engine was started") << endmsg;
 728                         /*NOTREACHED*/
 729                 } else {
 730                         return 0;
 731                 }
 732         }
 733
 734         boost::shared_ptr<Ports> pr = ports.reader();
 735
 736         for (Ports::iterator i = pr->begin(); i != pr->end(); ++i) {
 737                 if (portname == (*i)->name()) {
 738                         return (*i);
 739                 }
 740         }
 741
 742         return 0;
 743 }
 744
 745 const char **
 746 AudioEngine::get_ports (const string& port_name_pattern, const string& type_name_pattern, uint32_t flags)
 747 {
 748         if (!_running) {
 749                 if (!_has_run) {
 750                         fatal << _("get_ports called before engine was started") << endmsg;
 751                         /*NOTREACHED*/
 752                 } else {
 753                         return 0;
 754                 }
 755         }
 756         return jack_get_ports (_jack, port_name_pattern.c_str(), type_name_pattern.c_str(), flags);
 757 }
 758
 759 void
 760 AudioEngine::halted (void *arg)
 761 {
 762         AudioEngine* ae = static_cast<AudioEngine *> (arg);
 763
 764         ae->_running = false;
 765         ae->_buffer_size = 0;
 766         ae->_frame_rate = 0;
 767
 768         ae->Halted(); /* EMIT SIGNAL */
 769 }
 770
 771 uint32_t
 772 AudioEngine::n_physical_outputs () const
 773 {
 774         const char ** ports;
 775         uint32_t i = 0;
 776
 777         if (!_jack) {
 778                 return 0;
 779         }
 780
 781         if ((ports = jack_get_ports (_jack, NULL, NULL, JackPortIsPhysical|JackPortIsInput)) == 0) {
 782                 return 0;
 783         }
 784
 785         if (ports) {
 786                 for (i = 0; ports[i]; ++i);
 787                 free (ports);
 788         }
 789         return i;
 790 }
 791
 792 uint32_t
 793 AudioEngine::n_physical_inputs () const
 794 {
 795         const char ** ports;
 796         uint32_t i = 0;
 797
 798         if (!_jack) {
 799                 return 0;
 800         }
 801
 802         if ((ports = jack_get_ports (_jack, NULL, NULL, JackPortIsPhysical|JackPortIsOutput)) == 0) {
 803                 return 0;
 804         }
 805
 806         if (ports) {
 807                 for (i = 0; ports[i]; ++i);
 808                 free (ports);
 809         }
 810         return i;
 811 }
 812
 813 void
 814 AudioEngine::get_physical_inputs (vector<string>& ins)
 815 {
 816         const char ** ports;
 817         uint32_t i = 0;
 818
 819         if (!_jack) {
 820                 return;
 821         }
 822
 823         if ((ports = jack_get_ports (_jack, NULL, NULL, JackPortIsPhysical|JackPortIsOutput)) == 0) {
 824                 return;
 825         }
 826
 827         if (ports) {
 828                 for (i = 0; ports[i]; ++i) {
 829                         ins.push_back (ports[i]);
 830                 }
 831                 free (ports);
 832         }
 833 }
 834
 835 void
 836 AudioEngine::get_physical_outputs (vector<string>& outs)
 837 {
 838         const char ** ports;
 839         uint32_t i = 0;
 840
 841         if (!_jack) {
 842                 return;
 843         }
 844
 845         if ((ports = jack_get_ports (_jack, NULL, NULL, JackPortIsPhysical|JackPortIsInput)) == 0) {
 846                 return;
 847         }
 848
 849         if (ports) {
 850                 for (i = 0; ports[i]; ++i) {
 851                         outs.push_back (ports[i]);
 852                 }
 853                 free (ports);
 854         }
 855 }
 856
 857 string
 858 AudioEngine::get_nth_physical (DataType type, uint32_t n, int flag)
 859 {
 860         const char ** ports;
 861         uint32_t i;
 862         string ret;
 863
 864         assert(type != DataType::NIL);
 865
 866         if (!_running || !_jack) {
 867                 if (!_has_run) {
 868                         fatal << _("get_nth_physical called before engine was started") << endmsg;
 869                         /*NOTREACHED*/
 870                 } else {
 871                         return "";
 872                 }
 873         }
 874
 875         ports = jack_get_ports (_jack, NULL, type.to_jack_type(), JackPortIsPhysical|flag);
 876
 877         if (ports == 0) {
 878                 return "";
 879         }
 880
 881         for (i = 0; i < n && ports[i]; ++i);
 882
 883         if (ports[i]) {
 884                 ret = ports[i];
 885         }
 886
 887         free ((char *) ports);
 888
 889         return ret;
 890 }
 891
 892 ARDOUR::nframes_t
 893 AudioEngine::get_port_total_latency (const Port& port)
 894 {
 895         if (!_jack) {
 896                 fatal << _("get_port_total_latency() called with no JACK client connection") << endmsg;
 897                 /*NOTREACHED*/
 898         }
 899
 900         if (!_running) {
 901                 if (!_has_run) {
 902                         fatal << _("get_port_total_latency() called before engine was started") << endmsg;
 903                         /*NOTREACHED*/
 904                 }
 905         }
 906
 907         return jack_port_get_total_latency (_jack, port._port);
 908 }
 909
 910 void
 911 AudioEngine::transport_stop ()
 912 {
 913         // cerr << "tell JACK to stop\n";
 914         if (_jack) {
 915                 jack_transport_stop (_jack);
 916         }
 917 }
 918
 919 void
 920 AudioEngine::transport_start ()
 921 {
 922         // cerr << "tell JACK to start\n";
 923         if (_jack) {
 924                 jack_transport_start (_jack);
 925         }
 926 }
 927
 928 void
 929 AudioEngine::transport_locate (nframes_t where)
 930 {
 931         // cerr << "tell JACK to locate to " << where << endl;
 932         if (_jack) {
 933                 jack_transport_locate (_jack, where);
 934         }
 935 }
 936
 937 AudioEngine::TransportState
 938 AudioEngine::transport_state ()
 939 {
 940         if (_jack) {
 941                 jack_position_t pos;
 942                 return (TransportState) jack_transport_query (_jack, &pos);
 943         } else {
 944                 return (TransportState) JackTransportStopped;
 945         }
 946 }
 947
 948 int
 949 AudioEngine::reset_timebase ()
 950 {
 951         if (_jack) {
 952                 if (Config->get_jack_time_master()) {
 953                         return jack_set_timebase_callback (_jack, 0, _jack_timebase_callback, this);
 954                 } else {
 955                         return jack_release_timebase (_jack);
 956                 }
 957         } else {
 958                 return -1;
 959         }
 960 }
 961
 962 int
 963 AudioEngine::freewheel (bool onoff)
 964 {
 965         if (_jack) {
 966
 967                 if (onoff) {
 968                         _freewheel_thread_registered = false;
 969                 }
 970
 971                 return jack_set_freewheel (_jack, onoff);
 972
 973         } else {
 974                 return -1;
 975         }
 976 }
 977
 978 void
 979 AudioEngine::remove_all_ports ()
 980 {
 981         /* process lock MUST be held */
 982
 983         if (_jack) {
 984                 boost::shared_ptr<Ports> p = ports.reader();
 985
 986                 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
 987                         jack_port_unregister (_jack, (*i)->_port);
 988                 }
 989         }
 990
 991         {
 992                 RCUWriter<Ports> writer (ports);
 993                 boost::shared_ptr<Ports> ps = writer.get_copy ();
 994                 ps->clear ();
 995         }
 996
 997         port_connections.clear ();
 998 }
 999
1000 void
1001 AudioEngine::remove_connections_for (Port& port)
1002 {
1003         for (PortConnections::iterator i = port_connections.begin(); i != port_connections.end(); ) {
1004                 PortConnections::iterator tmp;
1005
1006                 tmp = i;
1007                 ++tmp;
1008
1009                 if ((*i).first == port.name()) {
1010                         port_connections.erase (i);
1011                 }
1012
1013                 i = tmp;
1014         }
1015 }
1016
1017 #ifdef HAVE_JACK_CLIENT_OPEN
1018
1019 int
1020 AudioEngine::connect_to_jack (string client_name)
1021 {
1022         jack_options_t options = JackNullOption;
1023         jack_status_t status;
1024         const char *server_name = NULL;
1025
1026         jack_client_name = client_name; /* might be reset below */
1027
1028         _jack = jack_client_open (jack_client_name.c_str(), options, &status, server_name);
1029
1030         if (_jack == NULL) {
1031
1032                 if (status & JackServerFailed) {
1033                         error << _("Unable to connect to JACK server") << endmsg;
1034                 }
1035
1036                 error << string_compose (_("Could not connect to JACK server as  \"%1\""), jack_client_name) <<  endmsg;
1037                 return -1;
1038         }
1039
1040         if (status & JackServerStarted) {
1041                 info << _("JACK server started") << endmsg;
1042         }
1043
1044         if (status & JackNameNotUnique) {
1045                 jack_client_name = jack_get_client_name (_jack);
1046         }
1047
1048         jack_set_error_function (ardour_jack_error);
1049
1050         return 0;
1051 }
1052
1053 #else
1054
1055 int
1056 AudioEngine::connect_to_jack (string client_name)
1057 {
1058         jack_client_name = client_name;
1059
1060         if ((_jack = jack_client_new (client_name.c_str())) == NULL) {
1061                 return -1;
1062         }
1063
1064         return 0;
1065 }
1066
1067 #endif /* HAVE_JACK_CLIENT_OPEN */
1068
1069 int
1070 AudioEngine::disconnect_from_jack ()
1071 {
1072         if (_jack == 0) {
1073                 return 0;
1074         }
1075
1076         jack_client_close (_jack);
1077
1078         _buffer_size = 0;
1079         _frame_rate = 0;
1080
1081         if (_running) {
1082                 _running = false;
1083                 Stopped(); /* EMIT SIGNAL */
1084         }
1085
1086         _jack = 0;
1087         return 0;
1088 }
1089
1090 int
1091 AudioEngine::reconnect_to_jack ()
1092 {
1093         if (_jack) {
1094                 disconnect_from_jack ();
1095                 /* XXX give jackd a chance */
1096                 Glib::usleep (250000);
1097         }
1098
1099         if (connect_to_jack (jack_client_name)) {
1100                 error << _("failed to connect to JACK") << endmsg;
1101                 return -1;
1102         }
1103
1104         Ports::iterator i;
1105
1106         boost::shared_ptr<Ports> p = ports.reader ();
1107
1108         for (i = p->begin(); i != p->end(); ++i) {
1109
1110                 /* XXX hack hack hack */
1111
1112                 string long_name = (*i)->name();
1113                 string short_name;
1114
1115                 short_name = long_name.substr (long_name.find_last_of (':') + 1);
1116
1117                 if (((*i)->_port = jack_port_register (_jack, short_name.c_str(), (*i)->type().to_jack_type(), (*i)->flags(), 0)) == 0) {
1118                         error << string_compose (_("could not reregister %1"), (*i)->name()) << endmsg;
1119                         break;
1120                 } else {
1121                 }
1122
1123                 (*i)->reset ();
1124
1125                 if ((*i)->flags() & JackPortIsOutput) {
1126                         (*i)->get_buffer().silence (jack_get_buffer_size (_jack), 0);
1127                 }
1128         }
1129
1130         if (i != p->end()) {
1131                 /* failed */
1132                 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
1133                         jack_port_unregister (_jack, (*i)->_port);
1134                 }
1135                 return -1;
1136         }
1137
1138
1139         if (session) {
1140                 nframes_t blocksize = jack_get_buffer_size (_jack);
1141                 session->set_block_size (blocksize);
1142                 session->set_frame_rate (jack_get_sample_rate (_jack));
1143         }
1144
1145         last_monitor_check = 0;
1146
1147         jack_on_shutdown (_jack, halted, this);
1148         jack_set_graph_order_callback (_jack, _graph_order_callback, this);
1149         jack_set_thread_init_callback (_jack, _thread_init_callback, this);
1150         jack_set_process_callback (_jack, _process_callback, this);
1151         jack_set_sample_rate_callback (_jack, _sample_rate_callback, this);
1152         jack_set_buffer_size_callback (_jack, _bufsize_callback, this);
1153         jack_set_xrun_callback (_jack, _xrun_callback, this);
1154         jack_set_sync_callback (_jack, _jack_sync_callback, this);
1155         jack_set_freewheel_callback (_jack, _freewheel_callback, this);
1156
1157         if (Config->get_jack_time_master()) {
1158                 jack_set_timebase_callback (_jack, 0, _jack_timebase_callback, this);
1159         }
1160
1161         if (jack_activate (_jack) == 0) {
1162                 _running = true;
1163                 _has_run = true;
1164         } else {
1165                 return -1;
1166         }
1167
1168         /* re-establish connections */
1169
1170         for (PortConnections::iterator i = port_connections.begin(); i != port_connections.end(); ++i) {
1171
1172                 int err;
1173
1174                 if ((err = jack_connect (_jack, (*i).first.c_str(), (*i).second.c_str())) != 0) {
1175                         if (err != EEXIST) {
1176                                 error << string_compose (_("could not reconnect %1 and %2 (err = %3)"),
1177                                                   (*i).first, (*i).second, err)
1178                                       << endmsg;
1179                         }
1180                 }
1181         }
1182
1183         Running (); /* EMIT SIGNAL*/
1184
1185         return 0;
1186 }
1187
1188 int
1189 AudioEngine::request_buffer_size (nframes_t nframes)
1190 {
1191         if (_jack) {
1192
1193                 if (nframes == jack_get_buffer_size (_jack)) {
1194                         return 0;
1195                 }
1196
1197                 return jack_set_buffer_size (_jack, nframes);
1198
1199         } else {
1200                 return -1;
1201         }
1202 }
1203
1204 void
1205 AudioEngine::update_total_latencies ()
1206 {
1207 #ifdef HAVE_JACK_RECOMPUTE_LATENCIES
1208         jack_recompute_total_latencies (_jack);
1209 #endif
1210 }
1211
1212 string
1213 AudioEngine::make_port_name_relative (string portname)
1214 {
1215         string::size_type len;
1216         string::size_type n;
1217
1218         len = portname.length();
1219
1220         for (n = 0; n < len; ++n) {
1221                 if (portname[n] == ':') {
1222                         break;
1223                 }
1224         }
1225
1226         if ((n != len) && (portname.substr (0, n) == jack_client_name)) {
1227                 return portname.substr (n+1);
1228         }
1229
1230         return portname;
1231 }
1232
1233 string
1234 AudioEngine::make_port_name_non_relative (string portname)
1235 {
1236         string str;
1237
1238         if (portname.find_first_of (':') != string::npos) {
1239                 return portname;
1240         }
1241
1242         str  = jack_client_name;
1243         str += ':';
1244         str += portname;
1245
1246         return str;
1247 }
1248
1249 bool
1250 AudioEngine::is_realtime () const
1251 {
1252         if (_jack) {
1253                 return jack_is_realtime (_jack);
1254         } else {
1255                 return false;
1256         }
1257 }