libs/ardour/audioengine.cc

   1 /*
   2     Copyright (C) 2002 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #include <unistd.h>
  21 #include <cerrno>
  22 #include <vector>
  23 #include <exception>
  24 #include <stdexcept>
  25 #include <sstream>
  26
  27 #include <glibmm/timer.h>
  28 #include <glibmm/pattern.h>
  29 #include <glibmm/module.h>
  30
  31 #include "pbd/epa.h"
  32 #include "pbd/file_utils.h"
  33 #include "pbd/pthread_utils.h"
  34 #include "pbd/stacktrace.h"
  35 #include "pbd/unknown_type.h"
  36
  37 #include "midi++/port.h"
  38 #include "midi++/mmc.h"
  39
  40 #include "ardour/async_midi_port.h"
  41 #include "ardour/audio_port.h"
  42 #include "ardour/audio_backend.h"
  43 #include "ardour/audioengine.h"
  44 #include "ardour/search_paths.h"
  45 #include "ardour/buffer.h"
  46 #include "ardour/cycle_timer.h"
  47 #include "ardour/internal_send.h"
  48 #include "ardour/meter.h"
  49 #include "ardour/midi_port.h"
  50 #include "ardour/midiport_manager.h"
  51 #include "ardour/mtdm.h"
  52 #include "ardour/port.h"
  53 #include "ardour/process_thread.h"
  54 #include "ardour/session.h"
  55
  56 #include "i18n.h"
  57
  58 using namespace std;
  59 using namespace ARDOUR;
  60 using namespace PBD;
  61
  62 gint AudioEngine::m_meter_exit;
  63 AudioEngine* AudioEngine::_instance = 0;
  64
  65 AudioEngine::AudioEngine ()
  66         : session_remove_pending (false)
  67         , session_removal_countdown (-1)
  68         , _running (false)
  69         , _freewheeling (false)
  70         , monitor_check_interval (INT32_MAX)
  71         , last_monitor_check (0)
  72         , _processed_frames (0)
  73         , m_meter_thread (0)
  74         , _main_thread (0)
  75         , _mtdm (0)
  76         , _measuring_latency (false)
  77         , _latency_input_port (0)
  78         , _latency_output_port (0)
  79         , _latency_flush_frames (0)
  80         , _latency_signal_latency (0)
  81         , _stopped_for_latency (false)
  82         , _in_destructor (false)
  83 {
  84         g_atomic_int_set (&m_meter_exit, 0);
  85         discover_backends ();
  86 }
  87
  88 AudioEngine::~AudioEngine ()
  89 {
  90         _in_destructor = true;
  91         stop_metering_thread ();
  92         drop_backend ();
  93 }
  94
  95 AudioEngine*
  96 AudioEngine::create ()
  97 {
  98         if (_instance) {
  99                 return _instance;
 100         }
 101
 102         _instance = new AudioEngine ();
 103
 104         return _instance;
 105 }
 106
 107 void
 108 _thread_init_callback (void * /*arg*/)
 109 {
 110         /* make sure that anybody who needs to know about this thread
 111            knows about it.
 112         */
 113
 114         pthread_set_name (X_("audioengine"));
 115
 116         PBD::notify_gui_about_thread_creation ("gui", pthread_self(), X_("Audioengine"), 4096);
 117         PBD::notify_gui_about_thread_creation ("midiui", pthread_self(), X_("Audioengine"), 128);
 118
 119         SessionEvent::create_per_thread_pool (X_("Audioengine"), 512);
 120
 121         AsyncMIDIPort::set_process_thread (pthread_self());
 122 }
 123
 124 void
 125 AudioEngine::split_cycle (pframes_t offset)
 126 {
 127         /* caller must hold process lock */
 128
 129         Port::increment_global_port_buffer_offset (offset);
 130
 131         /* tell all Ports that we're going to start a new (split) cycle */
 132
 133         boost::shared_ptr<Ports> p = ports.reader();
 134
 135         for (Ports::iterator i = p->begin(); i != p->end(); ++i) {
 136                 i->second->cycle_split ();
 137         }
 138 }
 139
 140 int
 141 AudioEngine::sample_rate_change (pframes_t nframes)
 142 {
 143         /* check for monitor input change every 1/10th of second */
 144
 145         monitor_check_interval = nframes / 10;
 146         last_monitor_check = 0;
 147
 148         if (_session) {
 149                 _session->set_frame_rate (nframes);
 150         }
 151
 152         SampleRateChanged (nframes); /* EMIT SIGNAL */
 153
 154         return 0;
 155 }
 156
 157 int
 158 AudioEngine::buffer_size_change (pframes_t bufsiz)
 159 {
 160         if (_session) {
 161                 _session->set_block_size (bufsiz);
 162                 last_monitor_check = 0;
 163         }
 164
 165         return 0;
 166 }
 167
 168 /** Method called by our ::process_thread when there is work to be done.
 169  *  @param nframes Number of frames to process.
 170  */
 171 int
 172 AudioEngine::process_callback (pframes_t nframes)
 173 {
 174         Glib::Threads::Mutex::Lock tm (_process_lock, Glib::Threads::TRY_LOCK);
 175
 176         PT_TIMING_REF;
 177         PT_TIMING_CHECK (1);
 178
 179         /// The number of frames that will have been processed when we've finished
 180         pframes_t next_processed_frames;
 181
 182         /* handle wrap around of total frames counter */
 183
 184         if (max_framepos - _processed_frames < nframes) {
 185                 next_processed_frames = nframes - (max_framepos - _processed_frames);
 186         } else {
 187                 next_processed_frames = _processed_frames + nframes;
 188         }
 189
 190         if (!tm.locked()) {
 191                 /* return having done nothing */
 192                 _processed_frames = next_processed_frames;
 193                 return 0;
 194         }
 195
 196         bool return_after_remove_check = false;
 197
 198         if (_measuring_latency && _mtdm) {
 199                 /* run a normal cycle from the perspective of the PortManager
 200                    so that we get silence on all registered ports.
 201
 202                    we overwrite the silence on the two ports used for latency
 203                    measurement.
 204                 */
 205
 206                 PortManager::cycle_start (nframes);
 207                 PortManager::silence (nframes);
 208
 209                 if (_latency_input_port && _latency_output_port) {
 210                         PortEngine& pe (port_engine());
 211
 212                         Sample* in = (Sample*) pe.get_buffer (_latency_input_port, nframes);
 213                         Sample* out = (Sample*) pe.get_buffer (_latency_output_port, nframes);
 214
 215                         _mtdm->process (nframes, in, out);
 216                 }
 217
 218                 PortManager::cycle_end (nframes);
 219                 return_after_remove_check = true;
 220
 221         } else if (_latency_flush_frames) {
 222
 223                 /* wait for the appropriate duration for the MTDM signal to
 224                  * drain from the ports before we revert to normal behaviour.
 225                  */
 226
 227                 PortManager::cycle_start (nframes);
 228                 PortManager::silence (nframes);
 229                 PortManager::cycle_end (nframes);
 230
 231                 if (_latency_flush_frames > nframes) {
 232                         _latency_flush_frames -= nframes;
 233                 } else {
 234                         _latency_flush_frames = 0;
 235                 }
 236
 237                 return_after_remove_check = true;
 238         }
 239
 240         if (session_remove_pending) {
 241
 242                 /* perform the actual session removal */
 243
 244                 if (session_removal_countdown < 0) {
 245
 246                         /* fade out over 1 second */
 247                         session_removal_countdown = sample_rate()/2;
 248                         session_removal_gain = 1.0;
 249                         session_removal_gain_step = 1.0/session_removal_countdown;
 250
 251                 } else if (session_removal_countdown > 0) {
 252
 253                         /* we'll be fading audio out.
 254
 255                            if this is the last time we do this as part
 256                            of session removal, do a MIDI panic now
 257                            to get MIDI stopped. This relies on the fact
 258                            that "immediate data" (aka "out of band data") from
 259                            MIDI tracks is *appended* after any other data,
 260                            so that it emerges after any outbound note ons, etc.
 261                         */
 262
 263                         if (session_removal_countdown <= nframes) {
 264                                 _session->midi_panic ();
 265                         }
 266
 267                 } else {
 268                         /* fade out done */
 269                         _session = 0;
 270                         session_removal_countdown = -1; // reset to "not in progress"
 271                         session_remove_pending = false;
 272                         session_removed.signal(); // wakes up thread that initiated session removal
 273                 }
 274         }
 275
 276         if (return_after_remove_check) {
 277                 return 0;
 278         }
 279
 280         if (_session == 0) {
 281
 282                 if (!_freewheeling) {
 283                         PortManager::cycle_start (nframes);
 284                         PortManager::cycle_end (nframes);
 285                 }
 286
 287                 _processed_frames = next_processed_frames;
 288
 289                 return 0;
 290         }
 291
 292         /* tell all relevant objects that we're starting a new cycle */
 293
 294         InternalSend::CycleStart (nframes);
 295
 296         /* tell all Ports that we're starting a new cycle */
 297
 298         PortManager::cycle_start (nframes);
 299
 300         /* test if we are freewheeling and there are freewheel signals connected.
 301            ardour should act normally even when freewheeling unless /it/ is
 302            exporting (which is what Freewheel.empty() tests for).
 303         */
 304
 305         if (_freewheeling && !Freewheel.empty()) {
 306                 Freewheel (nframes);
 307         } else {
 308                 if (_session) {
 309                         _session->process (nframes);
 310                 }
 311         }
 312
 313         if (_freewheeling) {
 314                 return 0;
 315         }
 316
 317         if (!_running) {
 318                 _processed_frames = next_processed_frames;
 319                 return 0;
 320         }
 321
 322         if (last_monitor_check + monitor_check_interval < next_processed_frames) {
 323
 324                 PortManager::check_monitoring ();
 325                 last_monitor_check = next_processed_frames;
 326         }
 327
 328         if (_session->silent()) {
 329                 PortManager::silence (nframes);
 330         }
 331
 332         if (session_remove_pending && session_removal_countdown) {
 333
 334                 PortManager::fade_out (session_removal_gain, session_removal_gain_step, nframes);
 335
 336                 if (session_removal_countdown > nframes) {
 337                         session_removal_countdown -= nframes;
 338                 } else {
 339                         session_removal_countdown = 0;
 340                 }
 341
 342                 session_removal_gain -= (nframes * session_removal_gain_step);
 343         }
 344
 345         PortManager::cycle_end (nframes);
 346
 347         _processed_frames = next_processed_frames;
 348
 349         PT_TIMING_CHECK (2);
 350
 351         return 0;
 352 }
 353
 354
 355 void
 356 AudioEngine::stop_metering_thread ()
 357 {
 358         if (m_meter_thread) {
 359                 g_atomic_int_set (&m_meter_exit, 1);
 360                 m_meter_thread->join ();
 361                 m_meter_thread = 0;
 362         }
 363 }
 364
 365 void
 366 AudioEngine::start_metering_thread ()
 367 {
 368         if (m_meter_thread == 0) {
 369                 g_atomic_int_set (&m_meter_exit, 0);
 370                 m_meter_thread = Glib::Threads::Thread::create (boost::bind (&AudioEngine::meter_thread, this));
 371         }
 372 }
 373
 374 void
 375 AudioEngine::meter_thread ()
 376 {
 377         pthread_set_name (X_("meter"));
 378
 379         while (true) {
 380                 Glib::usleep (10000); /* 1/100th sec interval */
 381                 if (g_atomic_int_get(&m_meter_exit)) {
 382                         break;
 383                 }
 384                 Metering::Meter ();
 385         }
 386 }
 387
 388 void
 389 AudioEngine::set_session (Session *s)
 390 {
 391         Glib::Threads::Mutex::Lock pl (_process_lock);
 392
 393         SessionHandlePtr::set_session (s);
 394
 395         if (_session) {
 396
 397                 pframes_t blocksize = samples_per_cycle ();
 398
 399                 PortManager::cycle_start (blocksize);
 400
 401                 _session->process (blocksize);
 402                 _session->process (blocksize);
 403                 _session->process (blocksize);
 404                 _session->process (blocksize);
 405                 _session->process (blocksize);
 406                 _session->process (blocksize);
 407                 _session->process (blocksize);
 408                 _session->process (blocksize);
 409
 410                 PortManager::cycle_end (blocksize);
 411         }
 412 }
 413
 414 void
 415 AudioEngine::remove_session ()
 416 {
 417         Glib::Threads::Mutex::Lock lm (_process_lock);
 418
 419         if (_running) {
 420
 421                 if (_session) {
 422                         session_remove_pending = true;
 423                         session_removal_countdown = 0;
 424                         session_removed.wait(_process_lock);
 425                 }
 426
 427         } else {
 428                 SessionHandlePtr::set_session (0);
 429         }
 430
 431         remove_all_ports ();
 432 }
 433
 434
 435 void
 436 AudioEngine::died ()
 437 {
 438         /* called from a signal handler for SIGPIPE */
 439
 440         stop_metering_thread ();
 441
 442         _running = false;
 443 }
 444
 445 int
 446 AudioEngine::reset_timebase ()
 447 {
 448         if (_session) {
 449                 if (_session->config.get_jack_time_master()) {
 450                         _backend->set_time_master (true);
 451                 } else {
 452                         _backend->set_time_master (false);
 453                 }
 454         }
 455         return 0;
 456 }
 457
 458
 459 void
 460 AudioEngine::destroy ()
 461 {
 462         delete _instance;
 463         _instance = 0;
 464 }
 465
 466 int
 467 AudioEngine::discover_backends ()
 468 {
 469         vector<std::string> backend_modules;
 470
 471         _backends.clear ();
 472
 473         Glib::PatternSpec so_extension_pattern("*backend.so");
 474         Glib::PatternSpec dylib_extension_pattern("*backend.dylib");
 475
 476 #if defined(PLATFORM_WINDOWS) && defined(DEBUGGABLE_BACKENDS)
 477         #if defined(DEBUG) || defined(_DEBUG)
 478                 Glib::PatternSpec dll_extension_pattern("*backendD.dll");
 479         #else
 480                 Glib::PatternSpec dll_extension_pattern("*backendRDC.dll");
 481         #endif
 482 #else
 483         Glib::PatternSpec dll_extension_pattern("*backend.dll");
 484 #endif
 485
 486         find_matching_files_in_search_path (backend_search_path (),
 487                                             so_extension_pattern, backend_modules);
 488
 489         find_matching_files_in_search_path (backend_search_path (),
 490                                             dylib_extension_pattern, backend_modules);
 491
 492         find_matching_files_in_search_path (backend_search_path (),
 493                                             dll_extension_pattern, backend_modules);
 494
 495         DEBUG_TRACE (DEBUG::AudioEngine, string_compose ("looking for backends in %1\n", backend_search_path().to_string()));
 496
 497         for (vector<std::string>::iterator i = backend_modules.begin(); i != backend_modules.end(); ++i) {
 498
 499                 AudioBackendInfo* info;
 500
 501                 DEBUG_TRACE (DEBUG::AudioEngine, string_compose ("Checking possible backend in %1\n", *i));
 502
 503                 if ((info = backend_discover (*i)) != 0) {
 504                         _backends.insert (make_pair (info->name, info));
 505                 }
 506         }
 507
 508         DEBUG_TRACE (DEBUG::AudioEngine, string_compose ("Found %1 backends\n", _backends.size()));
 509
 510         return _backends.size();
 511 }
 512
 513 AudioBackendInfo*
 514 AudioEngine::backend_discover (const string& path)
 515 {
 516         Glib::Module module (path);
 517         AudioBackendInfo* info;
 518         AudioBackendInfo* (*dfunc)(void);
 519         void* func = 0;
 520
 521         if (!module) {
 522                 error << string_compose(_("AudioEngine: cannot load module \"%1\" (%2)"), path,
 523                                         Glib::Module::get_last_error()) << endmsg;
 524                 return 0;
 525         }
 526
 527         if (!module.get_symbol ("descriptor", func)) {
 528                 error << string_compose(_("AudioEngine: backend at \"%1\" has no descriptor function."), path) << endmsg;
 529                 error << Glib::Module::get_last_error() << endmsg;
 530                 return 0;
 531         }
 532
 533         module.make_resident ();
 534
 535         dfunc = (AudioBackendInfo* (*)(void))func;
 536         info = dfunc();
 537
 538         return info;
 539 }
 540
 541 vector<const AudioBackendInfo*>
 542 AudioEngine::available_backends() const
 543 {
 544         vector<const AudioBackendInfo*> r;
 545
 546         for (BackendMap::const_iterator i = _backends.begin(); i != _backends.end(); ++i) {
 547                 r.push_back (i->second);
 548         }
 549
 550         return r;
 551 }
 552
 553 string
 554 AudioEngine::current_backend_name() const
 555 {
 556         if (_backend) {
 557                 return _backend->name();
 558         }
 559         return string();
 560 }
 561
 562 void
 563 AudioEngine::drop_backend ()
 564 {
 565         if (_backend) {
 566                 _backend->stop ();
 567                 _backend->drop_device();
 568                 _backend.reset ();
 569                 _running = false;
 570         }
 571 }
 572
 573 boost::shared_ptr<AudioBackend>
 574 AudioEngine::set_default_backend ()
 575 {
 576         if (_backends.empty()) {
 577                 return boost::shared_ptr<AudioBackend>();
 578         }
 579
 580         return set_backend (_backends.begin()->first, "", "");
 581 }
 582
 583 boost::shared_ptr<AudioBackend>
 584 AudioEngine::set_backend (const std::string& name, const std::string& arg1, const std::string& arg2)
 585 {
 586         BackendMap::iterator b = _backends.find (name);
 587
 588         if (b == _backends.end()) {
 589                 return boost::shared_ptr<AudioBackend>();
 590         }
 591
 592         drop_backend ();
 593
 594         try {
 595                 if (b->second->instantiate (arg1, arg2)) {
 596                         throw failed_constructor ();
 597                 }
 598
 599                 _backend = b->second->factory (*this);
 600
 601         } catch (exception& e) {
 602                 error << string_compose (_("Could not create backend for %1: %2"), name, e.what()) << endmsg;
 603                 return boost::shared_ptr<AudioBackend>();
 604         }
 605
 606         return _backend;
 607 }
 608
 609 /* BACKEND PROXY WRAPPERS */
 610
 611 int
 612 AudioEngine::start (bool for_latency)
 613 {
 614         if (!_backend) {
 615                 return -1;
 616         }
 617
 618         if (_running) {
 619                 return 0;
 620         }
 621
 622         _processed_frames = 0;
 623         last_monitor_check = 0;
 624
 625         if (_backend->start (for_latency)) {
 626                 return -1;
 627         }
 628
 629         _running = true;
 630
 631         if (_session) {
 632                 _session->set_frame_rate (_backend->sample_rate());
 633
 634                 if (_session->config.get_jack_time_master()) {
 635                         _backend->set_time_master (true);
 636                 }
 637         }
 638
 639         start_metering_thread ();
 640
 641         if (!for_latency) {
 642                 Running(); /* EMIT SIGNAL */
 643         }
 644
 645         return 0;
 646 }
 647
 648 int
 649 AudioEngine::stop (bool for_latency)
 650 {
 651         if (!_backend) {
 652                 return 0;
 653         }
 654
 655         Glib::Threads::Mutex::Lock lm (_process_lock);
 656
 657         if (_backend->stop ()) {
 658                 return -1;
 659         }
 660
 661         _running = false;
 662         _processed_frames = 0;
 663         _measuring_latency = false;
 664         _latency_output_port = 0;
 665         _latency_input_port = 0;
 666         _started_for_latency = false;
 667         stop_metering_thread ();
 668
 669         Port::PortDrop ();
 670
 671         if (!for_latency) {
 672                 Stopped (); /* EMIT SIGNAL */
 673         }
 674
 675         return 0;
 676 }
 677
 678 int
 679 AudioEngine::freewheel (bool start_stop)
 680 {
 681         if (!_backend) {
 682                 return -1;
 683         }
 684
 685         /* _freewheeling will be set when first Freewheel signal occurs */
 686
 687         return _backend->freewheel (start_stop);
 688 }
 689
 690 float
 691 AudioEngine::get_dsp_load() const
 692 {
 693         if (!_backend) {
 694                 return 0.0;
 695         }
 696         return _backend->dsp_load ();
 697 }
 698
 699 bool
 700 AudioEngine::is_realtime() const
 701 {
 702         if (!_backend) {
 703                 return false;
 704         }
 705
 706         return _backend->is_realtime();
 707 }
 708
 709 bool
 710 AudioEngine::connected() const
 711 {
 712         if (!_backend) {
 713                 return false;
 714         }
 715
 716         return _backend->available();
 717 }
 718
 719 void
 720 AudioEngine::transport_start ()
 721 {
 722         if (!_backend) {
 723                 return;
 724         }
 725         return _backend->transport_start ();
 726 }
 727
 728 void
 729 AudioEngine::transport_stop ()
 730 {
 731         if (!_backend) {
 732                 return;
 733         }
 734         return _backend->transport_stop ();
 735 }
 736
 737 TransportState
 738 AudioEngine::transport_state ()
 739 {
 740         if (!_backend) {
 741                 return TransportStopped;
 742         }
 743         return _backend->transport_state ();
 744 }
 745
 746 void
 747 AudioEngine::transport_locate (framepos_t pos)
 748 {
 749         if (!_backend) {
 750                 return;
 751         }
 752         return _backend->transport_locate (pos);
 753 }
 754
 755 framepos_t
 756 AudioEngine::transport_frame()
 757 {
 758         if (!_backend) {
 759                 return 0;
 760         }
 761         return _backend->transport_frame ();
 762 }
 763
 764 framecnt_t
 765 AudioEngine::sample_rate () const
 766 {
 767         if (!_backend) {
 768                 return 0;
 769         }
 770         return _backend->sample_rate ();
 771 }
 772
 773 pframes_t
 774 AudioEngine::samples_per_cycle () const
 775 {
 776         if (!_backend) {
 777                 return 0;
 778         }
 779         return _backend->buffer_size ();
 780 }
 781
 782 int
 783 AudioEngine::usecs_per_cycle () const
 784 {
 785         if (!_backend) {
 786                 return -1;
 787         }
 788         return _backend->usecs_per_cycle ();
 789 }
 790
 791 size_t
 792 AudioEngine::raw_buffer_size (DataType t)
 793 {
 794         if (!_backend) {
 795                 return -1;
 796         }
 797         return _backend->raw_buffer_size (t);
 798 }
 799
 800 pframes_t
 801 AudioEngine::sample_time ()
 802 {
 803         if (!_backend) {
 804                 return 0;
 805         }
 806         return _backend->sample_time ();
 807 }
 808
 809 pframes_t
 810 AudioEngine::sample_time_at_cycle_start ()
 811 {
 812         if (!_backend) {
 813                 return 0;
 814         }
 815         return _backend->sample_time_at_cycle_start ();
 816 }
 817
 818 pframes_t
 819 AudioEngine::samples_since_cycle_start ()
 820 {
 821         if (!_backend) {
 822                 return 0;
 823         }
 824         return _backend->samples_since_cycle_start ();
 825 }
 826
 827 bool
 828 AudioEngine::get_sync_offset (pframes_t& offset) const
 829 {
 830         if (!_backend) {
 831                 return false;
 832         }
 833         return _backend->get_sync_offset (offset);
 834 }
 835
 836 int
 837 AudioEngine::create_process_thread (boost::function<void()> func)
 838 {
 839         if (!_backend) {
 840                 return -1;
 841         }
 842         return _backend->create_process_thread (func);
 843 }
 844
 845 int
 846 AudioEngine::join_process_threads ()
 847 {
 848         if (!_backend) {
 849                 return -1;
 850         }
 851         return _backend->join_process_threads ();
 852 }
 853
 854 bool
 855 AudioEngine::in_process_thread ()
 856 {
 857         if (!_backend) {
 858                 return false;
 859         }
 860         return _backend->in_process_thread ();
 861 }
 862
 863 uint32_t
 864 AudioEngine::process_thread_count ()
 865 {
 866         if (!_backend) {
 867                 return 0;
 868         }
 869         return _backend->process_thread_count ();
 870 }
 871
 872 int
 873 AudioEngine::set_device_name (const std::string& name)
 874 {
 875         if (!_backend) {
 876                 return -1;
 877         }
 878         return _backend->set_device_name  (name);
 879 }
 880
 881 int
 882 AudioEngine::set_sample_rate (float sr)
 883 {
 884         if (!_backend) {
 885                 return -1;
 886         }
 887         return _backend->set_sample_rate  (sr);
 888 }
 889
 890 int
 891 AudioEngine::set_buffer_size (uint32_t bufsiz)
 892 {
 893         if (!_backend) {
 894                 return -1;
 895         }
 896         return _backend->set_buffer_size  (bufsiz);
 897 }
 898
 899 int
 900 AudioEngine::set_interleaved (bool yn)
 901 {
 902         if (!_backend) {
 903                 return -1;
 904         }
 905         return _backend->set_interleaved  (yn);
 906 }
 907
 908 int
 909 AudioEngine::set_input_channels (uint32_t ic)
 910 {
 911         if (!_backend) {
 912                 return -1;
 913         }
 914         return _backend->set_input_channels  (ic);
 915 }
 916
 917 int
 918 AudioEngine::set_output_channels (uint32_t oc)
 919 {
 920         if (!_backend) {
 921                 return -1;
 922         }
 923         return _backend->set_output_channels (oc);
 924 }
 925
 926 int
 927 AudioEngine::set_systemic_input_latency (uint32_t il)
 928 {
 929         if (!_backend) {
 930                 return -1;
 931         }
 932         return _backend->set_systemic_input_latency  (il);
 933 }
 934
 935 int
 936 AudioEngine::set_systemic_output_latency (uint32_t ol)
 937 {
 938         if (!_backend) {
 939                 return -1;
 940         }
 941         return _backend->set_systemic_output_latency  (ol);
 942 }
 943
 944 /* END OF BACKEND PROXY API */
 945
 946 void
 947 AudioEngine::thread_init_callback (void* arg)
 948 {
 949         /* make sure that anybody who needs to know about this thread
 950            knows about it.
 951         */
 952
 953         pthread_set_name (X_("audioengine"));
 954
 955         PBD::notify_gui_about_thread_creation ("gui", pthread_self(), X_("AudioEngine"), 4096);
 956         PBD::notify_gui_about_thread_creation ("midiui", pthread_self(), X_("AudioEngine"), 128);
 957
 958         SessionEvent::create_per_thread_pool (X_("AudioEngine"), 512);
 959
 960         AsyncMIDIPort::set_process_thread (pthread_self());
 961
 962         if (arg) {
 963                 /* the special thread created/managed by the backend */
 964                 AudioEngine::instance()->_main_thread = new ProcessThread;
 965         }
 966 }
 967
 968 int
 969 AudioEngine::sync_callback (TransportState state, framepos_t position)
 970 {
 971         if (_session) {
 972                 return _session->backend_sync_callback (state, position);
 973         }
 974         return 0;
 975 }
 976
 977 void
 978 AudioEngine::freewheel_callback (bool onoff)
 979 {
 980         _freewheeling = onoff;
 981 }
 982
 983 void
 984 AudioEngine::latency_callback (bool for_playback)
 985 {
 986         if (_session) {
 987                 _session->update_latency (for_playback);
 988         }
 989 }
 990
 991 void
 992 AudioEngine::update_latencies ()
 993 {
 994         if (_backend) {
 995                 _backend->update_latencies ();
 996         }
 997 }
 998
 999 void
1000 AudioEngine::halted_callback (const char* why)
1001 {
1002         if (_in_destructor) {
1003                 /* everything is under control */
1004                 return;
1005         }
1006
1007         stop_metering_thread ();
1008         _running = false;
1009
1010         Port::PortDrop (); /* EMIT SIGNAL */
1011
1012         if (!_started_for_latency) {
1013                 Halted (why);      /* EMIT SIGNAL */
1014         }
1015 }
1016
1017 bool
1018 AudioEngine::setup_required () const
1019 {
1020         if (_backend) {
1021                 if (_backend->info().already_configured())
1022                         return false;
1023         } else {
1024                 if (_backends.size() == 1 && _backends.begin()->second->already_configured()) {
1025                         return false;
1026                 }
1027         }
1028
1029         return true;
1030 }
1031
1032 MTDM*
1033 AudioEngine::mtdm()
1034 {
1035         return _mtdm;
1036 }
1037
1038 int
1039 AudioEngine::prepare_for_latency_measurement ()
1040 {
1041         if (running()) {
1042                 _stopped_for_latency = true;
1043                 stop (true);
1044         }
1045
1046         if (start (true)) {
1047                 _started_for_latency = true;
1048                 return -1;
1049         }
1050
1051         return 0;
1052 }
1053
1054 int
1055 AudioEngine::start_latency_detection ()
1056 {
1057         if (!running()) {
1058                 if (prepare_for_latency_measurement ()) {
1059                         return -1;
1060                 }
1061         }
1062
1063         PortEngine& pe (port_engine());
1064
1065         delete _mtdm;
1066         _mtdm = 0;
1067
1068         /* find the ports we will connect to */
1069
1070         PortEngine::PortHandle out = pe.get_port_by_name (_latency_output_name);
1071         PortEngine::PortHandle in = pe.get_port_by_name (_latency_input_name);
1072
1073         if (!out || !in) {
1074                 stop (true);
1075                 return -1;
1076         }
1077
1078         /* create the ports we will use to read/write data */
1079
1080         if ((_latency_output_port = pe.register_port ("latency_out", DataType::AUDIO, IsOutput)) == 0) {
1081                 stop (true);
1082                 return -1;
1083         }
1084         if (pe.connect (_latency_output_port, _latency_output_name)) {
1085                 pe.unregister_port (_latency_output_port);
1086                 stop (true);
1087                 return -1;
1088         }
1089
1090         const string portname ("latency_in");
1091         if ((_latency_input_port = pe.register_port (portname, DataType::AUDIO, IsInput)) == 0) {
1092                 pe.unregister_port (_latency_output_port);
1093                 stop (true);
1094                 return -1;
1095         }
1096         if (pe.connect (_latency_input_name, make_port_name_non_relative (portname))) {
1097                 pe.unregister_port (_latency_output_port);
1098                 stop (true);
1099                 return -1;
1100         }
1101
1102         LatencyRange lr;
1103         _latency_signal_latency = 0;
1104         lr = pe.get_latency_range (in, false);
1105         _latency_signal_latency = lr.max;
1106         lr = pe.get_latency_range (out, true);
1107         _latency_signal_latency += lr.max;
1108
1109         /* all created and connected, lets go */
1110
1111         _mtdm = new MTDM (sample_rate());
1112         _measuring_latency = true;
1113         _latency_flush_frames = samples_per_cycle();
1114
1115         return 0;
1116 }
1117
1118 void
1119 AudioEngine::stop_latency_detection ()
1120 {
1121         _measuring_latency = false;
1122
1123         if (_latency_output_port) {
1124                 port_engine().unregister_port (_latency_output_port);
1125                 _latency_output_port = 0;
1126         }
1127         if (_latency_input_port) {
1128                 port_engine().unregister_port (_latency_input_port);
1129                 _latency_input_port = 0;
1130         }
1131
1132         stop (true);
1133
1134         if (_stopped_for_latency) {
1135                 start ();
1136         }
1137
1138         _stopped_for_latency = false;
1139         _started_for_latency = false;
1140 }
1141
1142 void
1143 AudioEngine::set_latency_output_port (const string& name)
1144 {
1145         _latency_output_name = name;
1146 }
1147
1148 void
1149 AudioEngine::set_latency_input_port (const string& name)
1150 {
1151         _latency_input_name = name;
1152 }