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