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