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
  36 #include <ardour/timestamps.h>
  37
  38 #include "i18n.h"
  39
  40 using namespace std;
  41 using namespace ARDOUR;
  42 using namespace PBD;
  43
  44 gint AudioEngine::m_meter_exit;
  45
  46 static void
  47 ardour_jack_error (const char* msg)
  48 {
  49         // throw JACK errors away - they cause visual clutter
  50         // error << "JACK: " << msg << endmsg;
  51 }
  52
  53 AudioEngine::AudioEngine (string client_name)
  54         : ports (new Ports)
  55 {
  56         session = 0;
  57         session_remove_pending = false;
  58         _running = false;
  59         _has_run = false;
  60         last_monitor_check = 0;
  61         monitor_check_interval = max_frames;
  62         _processed_frames = 0;
  63         _usecs_per_cycle = 0;
  64         _jack = 0;
  65         _frame_rate = 0;
  66         _buffer_size = 0;
  67         _freewheel_thread_registered = false;
  68         _freewheeling = false;
  69
  70         m_meter_thread = 0;
  71         g_atomic_int_set (&m_meter_exit, 0);
  72
  73         if (connect_to_jack (client_name)) {
  74                 throw NoBackendAvailable ();
  75         }
  76 }
  77
  78 AudioEngine::~AudioEngine ()
  79 {
  80         {
  81                 Glib::Mutex::Lock tm (_process_lock);
  82                 session_removed.signal ();
  83
  84                 if (_running) {
  85                         jack_client_close (_jack);
  86                         _jack = 0;
  87                 }
  88
  89                 stop_metering_thread ();
  90         }
  91 }
  92
  93 void
  94 _thread_init_callback (void *arg)
  95 {
  96         /* make sure that anybody who needs to know about this thread
  97            knows about it.
  98         */
  99
 100         PBD::notify_gui_about_thread_creation (pthread_self(), X_("Audioengine"), 4096);
 101 }
 102
 103 int
 104 AudioEngine::start ()
 105 {
 106         if (!_jack) {
 107                 error << _("AudioEngine::start() called while disconnected from JACK") << endmsg;
 108                 return -1;
 109         }
 110
 111         if (!_running) {
 112
 113                 if (session) {
 114                         nframes_t blocksize = jack_get_buffer_size (_jack);
 115
 116                         BootMessage (_("Connect session to engine"));
 117
 118                         session->set_block_size (blocksize);
 119                         session->set_frame_rate (jack_get_sample_rate (_jack));
 120
 121                         /* page in as much of the session process code as we
 122                            can before we really start running.
 123                         */
 124
 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                         session->process (blocksize);
 133                 }
 134
 135                 _processed_frames = 0;
 136                 last_monitor_check = 0;
 137
 138                 jack_on_shutdown (_jack, halted, this);
 139                 jack_set_graph_order_callback (_jack, _graph_order_callback, this);
 140                 jack_set_thread_init_callback (_jack, _thread_init_callback, this);
 141                 jack_set_process_callback (_jack, _process_callback, this);
 142                 jack_set_sample_rate_callback (_jack, _sample_rate_callback, this);
 143                 jack_set_buffer_size_callback (_jack, _bufsize_callback, this);
 144                 jack_set_xrun_callback (_jack, _xrun_callback, this);
 145                 jack_set_sync_callback (_jack, _jack_sync_callback, this);
 146                 jack_set_freewheel_callback (_jack, _freewheel_callback, this);
 147
 148                 if (Config->get_jack_time_master()) {
 149                         jack_set_timebase_callback (_jack, 0, _jack_timebase_callback, this);
 150                 }
 151
 152                 if (jack_activate (_jack) == 0) {
 153                         _running = true;
 154                         _has_run = true;
 155                         Running(); /* EMIT SIGNAL */
 156                 } else {
 157                         // error << _("cannot activate JACK client") << endmsg;
 158                 }
 159
 160                 start_metering_thread();
 161         }
 162
 163         return _running ? 0 : -1;
 164 }
 165
 166 int
 167 AudioEngine::stop (bool forever)
 168 {
 169         if (_jack) {
 170                 if (forever) {
 171                         disconnect_from_jack ();
 172                 } else {
 173                         jack_deactivate (_jack);
 174                         Stopped(); /* EMIT SIGNAL */
 175                 }
 176         }
 177
 178         return _running ? -1 : 0;
 179 }
 180
 181
 182 bool
 183 AudioEngine::get_sync_offset (nframes_t& offset) const
 184 {
 185
 186 #ifdef HAVE_JACK_VIDEO_SUPPORT
 187
 188         jack_position_t pos;
 189
 190         if (_jack) {
 191                 (void) jack_transport_query (_jack, &pos);
 192
 193                 if (pos.valid & JackVideoFrameOffset) {
 194                         offset = pos.video_offset;
 195                         return true;
 196                 }
 197         }
 198
 199 #endif
 200
 201         return false;
 202 }
 203
 204 void
 205 AudioEngine::_jack_timebase_callback (jack_transport_state_t state, nframes_t nframes,
 206                                       jack_position_t* pos, int new_position, void *arg)
 207 {
 208         static_cast<AudioEngine*> (arg)->jack_timebase_callback (state, nframes, pos, new_position);
 209 }
 210
 211 void
 212 AudioEngine::jack_timebase_callback (jack_transport_state_t state, nframes_t nframes,
 213                                      jack_position_t* pos, int new_position)
 214 {
 215         if (_jack && session && session->synced_to_jack()) {
 216                 session->jack_timebase_callback (state, nframes, pos, new_position);
 217         }
 218 }
 219
 220 int
 221 AudioEngine::_jack_sync_callback (jack_transport_state_t state, jack_position_t* pos, void* arg)
 222 {
 223         return static_cast<AudioEngine*> (arg)->jack_sync_callback (state, pos);
 224 }
 225
 226 int
 227 AudioEngine::jack_sync_callback (jack_transport_state_t state, jack_position_t* pos)
 228 {
 229         if (_jack && session) {
 230                 return session->jack_sync_callback (state, pos);
 231         }
 232
 233         return true;
 234 }
 235
 236 int
 237 AudioEngine::_xrun_callback (void *arg)
 238 {
 239         AudioEngine* ae = static_cast<AudioEngine*> (arg);
 240         if (ae->connected()) {
 241                 ae->Xrun (); /* EMIT SIGNAL */
 242         }
 243         return 0;
 244 }
 245
 246 int
 247 AudioEngine::_graph_order_callback (void *arg)
 248 {
 249         AudioEngine* ae = static_cast<AudioEngine*> (arg);
 250         if (ae->connected()) {
 251                 ae->GraphReordered (); /* EMIT SIGNAL */
 252         }
 253         return 0;
 254 }
 255
 256 int
 257 AudioEngine::_process_callback (nframes_t nframes, void *arg)
 258 {
 259         return static_cast<AudioEngine *> (arg)->process_callback (nframes);
 260 }
 261
 262 void
 263 AudioEngine::_freewheel_callback (int onoff, void *arg)
 264 {
 265         static_cast<AudioEngine*>(arg)->_freewheeling = onoff;
 266 }
 267
 268 int
 269 AudioEngine::process_callback (nframes_t nframes)
 270 {
 271         // CycleTimer ct ("AudioEngine::process");
 272         Glib::Mutex::Lock tm (_process_lock, Glib::TRY_LOCK);
 273         nframes_t next_processed_frames;
 274
 275         /* handle wrap around of total frames counter */
 276
 277         if (max_frames - _processed_frames < nframes) {
 278                 next_processed_frames = nframes - (max_frames - _processed_frames);
 279         } else {
 280                 next_processed_frames = _processed_frames + nframes;
 281         }
 282
 283         if (!tm.locked() || session == 0) {
 284                 _processed_frames = next_processed_frames;
 285                 return 0;
 286         }
 287
 288         if (session_remove_pending) {
 289                 session = 0;
 290                 session_remove_pending = false;
 291                 session_removed.signal();
 292                 _processed_frames = next_processed_frames;
 293                 return 0;
 294         }
 295
 296         if (_freewheeling) {
 297                 if (Freewheel (nframes)) {
 298                         jack_set_freewheel (_jack, false);
 299                 }
 300                 return 0;
 301         }
 302
 303         session->process (nframes);
 304
 305         if (!_running) {
 306                 /* we were zombified, maybe because a ladspa plugin took
 307                    too long, or jackd exited, or something like that.
 308                 */
 309
 310                 _processed_frames = next_processed_frames;
 311                 return 0;
 312         }
 313
 314         if (last_monitor_check + monitor_check_interval < next_processed_frames) {
 315
 316                 boost::shared_ptr<Ports> p = ports.reader();
 317
 318                 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
 319
 320                         Port *port = (*i);
 321                         bool x;
 322
 323                         if (port->_last_monitor != (x = port->monitoring_input ())) {
 324                                 port->_last_monitor = x;
 325                                 /* XXX I think this is dangerous, due to
 326                                    a likely mutex in the signal handlers ...
 327                                 */
 328                                  port->MonitorInputChanged (x); /* EMIT SIGNAL */
 329                         }
 330                 }
 331                 last_monitor_check = next_processed_frames;
 332         }
 333
 334         if (session->silent()) {
 335
 336                 boost::shared_ptr<Ports> p = ports.reader();
 337
 338                 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
 339
 340                         Port *port = (*i);
 341
 342                         if (port->sends_output()) {
 343                                 Sample *buf = port->get_buffer(nframes);
 344                                 memset (buf, 0, sizeof(Sample) * nframes);
 345                                 // this should work but doesn't
 346                                 //port->silence(0, nframes);  //need to implement declicking fade
 347                         }
 348                 }
 349         }
 350
 351         _processed_frames = next_processed_frames;
 352         return 0;
 353 }
 354
 355 int
 356 AudioEngine::_sample_rate_callback (nframes_t nframes, void *arg)
 357 {
 358         return static_cast<AudioEngine *> (arg)->jack_sample_rate_callback (nframes);
 359 }
 360
 361 int
 362 AudioEngine::jack_sample_rate_callback (nframes_t nframes)
 363 {
 364         _frame_rate = nframes;
 365         _usecs_per_cycle = (int) floor ((((double) frames_per_cycle() / nframes)) * 1000000.0);
 366
 367         /* check for monitor input change every 1/10th of second */
 368
 369         monitor_check_interval = nframes / 10;
 370         last_monitor_check = 0;
 371
 372         if (session) {
 373                 session->set_frame_rate (nframes);
 374         }
 375
 376         SampleRateChanged (nframes); /* EMIT SIGNAL */
 377
 378         return 0;
 379 }
 380
 381 int
 382 AudioEngine::_bufsize_callback (nframes_t nframes, void *arg)
 383 {
 384         return static_cast<AudioEngine *> (arg)->jack_bufsize_callback (nframes);
 385 }
 386
 387 int
 388 AudioEngine::jack_bufsize_callback (nframes_t nframes)
 389 {
 390         _buffer_size = nframes;
 391         _usecs_per_cycle = (int) floor ((((double) nframes / frame_rate())) * 1000000.0);
 392         last_monitor_check = 0;
 393
 394         boost::shared_ptr<Ports> p = ports.reader();
 395
 396         for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
 397                 (*i)->reset();
 398         }
 399
 400         if (session) {
 401                 session->set_block_size (_buffer_size);
 402         }
 403
 404         return 0;
 405 }
 406
 407 void
 408 AudioEngine::stop_metering_thread ()
 409 {
 410         if (m_meter_thread) {
 411                 g_atomic_int_set (&m_meter_exit, 1);
 412                 m_meter_thread->join ();
 413                 m_meter_thread = 0;
 414         }
 415 }
 416
 417 void
 418 AudioEngine::start_metering_thread ()
 419 {
 420         if (m_meter_thread == 0) {
 421                 g_atomic_int_set (&m_meter_exit, 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 = string_compose (_("a port with the name \"%1\" already exists: check for duplicated track/bus names"), portname);
 497         } else {
 498                 reason = _("No more JACK ports are available. You will need to stop Ardour and restart JACK with ports if you need this many tracks.");
 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->stop_metering_thread ();
 803
 804         ae->_running = false;
 805         ae->_buffer_size = 0;
 806         ae->_frame_rate = 0;
 807
 808         if (was_running) {
 809                 ae->Halted(); /* EMIT SIGNAL */
 810         }
 811 }
 812
 813 bool
 814 AudioEngine::can_request_hardware_monitoring ()
 815 {
 816         const char ** ports;
 817
 818         if (!_jack) {
 819                 return 0;
 820         }
 821
 822         if ((ports = jack_get_ports (_jack, NULL, JACK_DEFAULT_AUDIO_TYPE, JackPortCanMonitor)) == 0) {
 823                 return false;
 824         }
 825
 826         free (ports);
 827
 828         return true;
 829 }
 830
 831
 832 uint32_t
 833 AudioEngine::n_physical_audio_outputs () const
 834 {
 835         const char ** ports;
 836         uint32_t i = 0;
 837
 838         if (!_jack) {
 839                 return 0;
 840         }
 841
 842         if ((ports = jack_get_ports (_jack, NULL, JACK_DEFAULT_AUDIO_TYPE, JackPortIsPhysical|JackPortIsInput)) == 0) {
 843                 return 0;
 844         }
 845
 846         for (i = 0; ports[i]; ++i);
 847         free (ports);
 848
 849         return i;
 850 }
 851
 852 uint32_t
 853 AudioEngine::n_physical_audio_inputs () const
 854 {
 855         const char ** ports;
 856         uint32_t i = 0;
 857
 858         if (!_jack) {
 859                 return 0;
 860         }
 861
 862         if ((ports = jack_get_ports (_jack, NULL, JACK_DEFAULT_AUDIO_TYPE, JackPortIsPhysical|JackPortIsOutput)) == 0) {
 863                 return 0;
 864         }
 865
 866         if (ports) {
 867                 for (i = 0; ports[i]; ++i);
 868                 free (ports);
 869         }
 870         return i;
 871 }
 872
 873 void
 874 AudioEngine::get_physical_audio_inputs (vector<string>& ins)
 875 {
 876         const char ** ports;
 877         uint32_t i = 0;
 878
 879         if (!_jack) {
 880                 return;
 881         }
 882
 883         if ((ports = jack_get_ports (_jack, NULL, JACK_DEFAULT_AUDIO_TYPE, JackPortIsPhysical|JackPortIsOutput)) == 0) {
 884                 return;
 885         }
 886
 887         if (ports) {
 888                 for (i = 0; ports[i]; ++i) {
 889                         ins.push_back (ports[i]);
 890                 }
 891                 free (ports);
 892         }
 893 }
 894
 895 void
 896 AudioEngine::get_physical_audio_outputs (vector<string>& outs)
 897 {
 898         const char ** ports;
 899         uint32_t i = 0;
 900
 901         if (!_jack) {
 902                 return;
 903         }
 904
 905         if ((ports = jack_get_ports (_jack, NULL, JACK_DEFAULT_AUDIO_TYPE, JackPortIsPhysical|JackPortIsInput)) == 0) {
 906                 return;
 907         }
 908
 909         if (ports) {
 910                 for (i = 0; ports[i]; ++i) {
 911                         outs.push_back (ports[i]);
 912                 }
 913                 free (ports);
 914         }
 915 }
 916
 917 string
 918 AudioEngine::get_nth_physical_audio (uint32_t n, int flag)
 919 {
 920         const char ** ports;
 921         uint32_t i;
 922         string ret;
 923
 924         if (!_jack) {
 925                 fatal << _("get_nth_physical called before engine was connected") << endmsg;
 926                 /*NOTREACHED*/
 927         }
 928
 929         ports = jack_get_ports (_jack, NULL, JACK_DEFAULT_AUDIO_TYPE, JackPortIsPhysical|flag);
 930
 931         if (ports == 0) {
 932                 return "";
 933         }
 934
 935         for (i = 0; i < n && ports[i]; ++i);
 936
 937         if (ports[i]) {
 938                 ret = ports[i];
 939         }
 940
 941         free ((char *) ports);
 942
 943         return ret;
 944 }
 945
 946 nframes_t
 947 AudioEngine::get_port_total_latency (const Port& port)
 948 {
 949         if (!_jack) {
 950                 fatal << _("get_port_total_latency() called with no JACK client connection") << endmsg;
 951                 /*NOTREACHED*/
 952         }
 953
 954         return jack_port_get_total_latency (_jack, port._port);
 955 }
 956
 957 void
 958 AudioEngine::transport_stop ()
 959 {
 960         if (_jack) {
 961                 jack_transport_stop (_jack);
 962         }
 963 }
 964
 965 void
 966 AudioEngine::transport_start ()
 967 {
 968         if (_jack) {
 969                 jack_transport_start (_jack);
 970         }
 971 }
 972
 973 void
 974 AudioEngine::transport_locate (nframes_t where)
 975 {
 976         // cerr << "tell JACK to locate to " << where << endl;
 977         if (_jack) {
 978                 jack_transport_locate (_jack, where);
 979         }
 980 }
 981
 982 AudioEngine::TransportState
 983 AudioEngine::transport_state ()
 984 {
 985         if (_jack) {
 986                 jack_position_t pos;
 987                 return (TransportState) jack_transport_query (_jack, &pos);
 988         } else {
 989                 return (TransportState) JackTransportStopped;
 990         }
 991 }
 992
 993 int
 994 AudioEngine::reset_timebase ()
 995 {
 996         if (_jack) {
 997                 if (Config->get_jack_time_master()) {
 998                         return jack_set_timebase_callback (_jack, 0, _jack_timebase_callback, this);
 999                 } else {
1000                         return jack_release_timebase (_jack);
1001                 }
1002         } else {
1003                 return -1;
1004         }
1005 }
1006
1007 int
1008 AudioEngine::freewheel (bool onoff)
1009 {
1010         if (_jack) {
1011
1012                 if (onoff != _freewheeling) {
1013
1014                         if (onoff) {
1015                                 _freewheel_thread_registered = false;
1016                         }
1017
1018                         return jack_set_freewheel (_jack, onoff);
1019
1020                 } else {
1021                         /* already doing what has been asked for */
1022                         return 0;
1023                 }
1024
1025         } else {
1026                 return -1;
1027         }
1028 }
1029
1030 void
1031 AudioEngine::remove_all_ports ()
1032 {
1033         /* process lock MUST be held */
1034
1035         if (_jack) {
1036                 boost::shared_ptr<Ports> p = ports.reader();
1037
1038                 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
1039                         jack_port_unregister (_jack, (*i)->_port);
1040                 }
1041         }
1042
1043         {
1044                 RCUWriter<Ports> writer (ports);
1045                 boost::shared_ptr<Ports> ps = writer.get_copy ();
1046                 ps->clear ();
1047         }
1048
1049         port_connections.clear ();
1050 }
1051
1052 void
1053 AudioEngine::remove_connections_for (Port* port)
1054 {
1055         for (PortConnections::iterator i = port_connections.begin(); i != port_connections.end(); ) {
1056                 PortConnections::iterator tmp;
1057
1058                 tmp = i;
1059                 ++tmp;
1060
1061                 if ((*i).first == port->name()) {
1062                         port_connections.erase (i);
1063                 }
1064
1065                 i = tmp;
1066         }
1067 }
1068
1069 #ifdef HAVE_JACK_CLIENT_OPEN
1070
1071 int
1072 AudioEngine::connect_to_jack (string client_name)
1073 {
1074         jack_options_t options = JackNullOption;
1075         jack_status_t status;
1076         const char *server_name = NULL;
1077
1078         jack_client_name = client_name; /* might be reset below */
1079         _jack = jack_client_open (jack_client_name.c_str(), options, &status, server_name);
1080
1081         if (_jack == NULL) {
1082                 /* just return without an error message. something else will take care of it */
1083                 return -1;
1084         }
1085
1086         if (status & JackNameNotUnique) {
1087                 jack_client_name = jack_get_client_name (_jack);
1088         }
1089
1090         jack_set_error_function (ardour_jack_error);
1091
1092         return 0;
1093 }
1094
1095 #else
1096
1097 int
1098 AudioEngine::connect_to_jack (string client_name)
1099 {
1100         jack_client_name = client_name;
1101
1102         if ((_jack = jack_client_new (client_name.c_str())) == 0) {
1103                 return -1;
1104         }
1105
1106         return 0;
1107 }
1108
1109 #endif /* HAVE_JACK_CLIENT_OPEN */
1110
1111 int
1112 AudioEngine::disconnect_from_jack ()
1113 {
1114         if (!_jack) {
1115                 return 0;
1116         }
1117
1118
1119         if (_running) {
1120                 stop_metering_thread ();
1121         }
1122
1123         {
1124                 Glib::Mutex::Lock lm (_process_lock);
1125                 jack_client_close (_jack);
1126                 _jack = 0;
1127         }
1128
1129         _buffer_size = 0;
1130         _frame_rate = 0;
1131
1132         if (_running) {
1133                 _running = false;
1134                 Stopped(); /* EMIT SIGNAL */
1135         }
1136
1137         return 0;
1138 }
1139
1140 int
1141 AudioEngine::reconnect_to_jack ()
1142 {
1143         if (_running) {
1144                 disconnect_from_jack ();
1145                 /* XXX give jackd a chance */
1146                 Glib::usleep (250000);
1147         }
1148
1149         if (connect_to_jack (jack_client_name)) {
1150                 error << _("failed to connect to JACK") << endmsg;
1151                 return -1;
1152         }
1153
1154         Ports::iterator i;
1155
1156         boost::shared_ptr<Ports> p = ports.reader ();
1157
1158         for (i = p->begin(); i != p->end(); ++i) {
1159
1160                 /* XXX hack hack hack */
1161
1162                 string long_name = (*i)->name();
1163                 string short_name;
1164
1165                 short_name = long_name.substr (long_name.find_last_of (':') + 1);
1166
1167                 if (((*i)->_port = jack_port_register (_jack, short_name.c_str(), (*i)->type(), (*i)->flags(), 0)) == 0) {
1168                         error << string_compose (_("could not reregister %1"), (*i)->name()) << endmsg;
1169                         break;
1170                 } else {
1171                 }
1172
1173                 (*i)->reset ();
1174
1175                 if ((*i)->flags() & JackPortIsOutput) {
1176                         (*i)->silence (jack_get_buffer_size (_jack), 0);
1177                 }
1178         }
1179
1180         if (i != p->end()) {
1181                 /* failed */
1182                 for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
1183                         jack_port_unregister (_jack, (*i)->_port);
1184                 }
1185                 return -1;
1186         }
1187
1188
1189         if (session) {
1190                 session->reset_jack_connection (_jack);
1191                 nframes_t blocksize = jack_get_buffer_size (_jack);
1192                 session->set_block_size (blocksize);
1193                 session->set_frame_rate (jack_get_sample_rate (_jack));
1194         }
1195
1196         last_monitor_check = 0;
1197
1198         jack_on_shutdown (_jack, halted, this);
1199         jack_set_graph_order_callback (_jack, _graph_order_callback, this);
1200         jack_set_thread_init_callback (_jack, _thread_init_callback, this);
1201         jack_set_process_callback (_jack, _process_callback, this);
1202         jack_set_sample_rate_callback (_jack, _sample_rate_callback, this);
1203         jack_set_buffer_size_callback (_jack, _bufsize_callback, this);
1204         jack_set_xrun_callback (_jack, _xrun_callback, this);
1205         jack_set_sync_callback (_jack, _jack_sync_callback, this);
1206         jack_set_freewheel_callback (_jack, _freewheel_callback, this);
1207
1208         if (Config->get_jack_time_master()) {
1209                 jack_set_timebase_callback (_jack, 0, _jack_timebase_callback, this);
1210         }
1211
1212         if (jack_activate (_jack) == 0) {
1213                 _running = true;
1214                 _has_run = true;
1215         } else {
1216                 return -1;
1217         }
1218
1219         /* re-establish connections */
1220
1221         for (PortConnections::iterator i = port_connections.begin(); i != port_connections.end(); ++i) {
1222
1223                 int err;
1224                 jack_client_t* j = _jack;
1225
1226                 /* JACK could have zombified us. */
1227
1228                 if (!j) {
1229                         error << _("Disconnected from JACK while reconnecting. You should quit Ardour now.") << endmsg;
1230                         return -1;
1231                 }
1232
1233                 if ((err = jack_connect (j, (*i).first.c_str(), (*i).second.c_str())) != 0) {
1234                         if (err != EEXIST) {
1235                                 error << string_compose (_("could not reconnect %1 and %2 (err = %3)"),
1236                                                   (*i).first, (*i).second, err)
1237                                       << endmsg;
1238                         }
1239                 }
1240         }
1241
1242         Running (); /* EMIT SIGNAL*/
1243
1244         start_metering_thread ();
1245
1246         return 0;
1247 }
1248
1249 int
1250 AudioEngine::request_buffer_size (nframes_t nframes)
1251 {
1252         if (_jack) {
1253
1254                 if (nframes == jack_get_buffer_size (_jack)) {
1255                         return 0;
1256                 }
1257
1258                 return jack_set_buffer_size (_jack, nframes);
1259
1260         } else {
1261                 return -1;
1262         }
1263 }
1264
1265 void
1266 AudioEngine::update_total_latencies ()
1267 {
1268 #ifdef HAVE_JACK_RECOMPUTE_LATENCIES
1269         if (_jack) {
1270                 jack_recompute_total_latencies (_jack);
1271         }
1272 #endif
1273 }
1274
1275 string
1276 AudioEngine::make_port_name_relative (string portname)
1277 {
1278         string::size_type len;
1279         string::size_type n;
1280
1281         len = portname.length();
1282
1283         for (n = 0; n < len; ++n) {
1284                 if (portname[n] == ':') {
1285                         break;
1286                 }
1287         }
1288
1289         if ((n != len) && (portname.substr (0, n) == jack_client_name)) {
1290                 return portname.substr (n+1);
1291         }
1292
1293         return portname;
1294 }
1295
1296 string
1297 AudioEngine::make_port_name_non_relative (string portname)
1298 {
1299         string str;
1300
1301         if (portname.find_first_of (':') != string::npos) {
1302                 return portname;
1303         }
1304
1305         str  = jack_client_name;
1306         str += ':';
1307         str += portname;
1308
1309         return str;
1310 }
1311
1312 bool
1313 AudioEngine::is_realtime () const
1314 {
1315         if (_jack) {
1316                 return jack_is_realtime (_jack);
1317         } else {
1318                 return false;
1319         }
1320 }