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