From f8ef1e94c30d4db0c8e7a648e5f81c113593e3d3 Mon Sep 17 00:00:00 2001 From: Paul Davis Date: Tue, 23 Jul 2013 22:14:52 -0400 Subject: inch-like progress on defining the API for AudioBackend and separating AudioEngine from this --- libs/ardour/audioengine.cc | 708 ++++----------------------------------------- 1 file changed, 61 insertions(+), 647 deletions(-) (limited to 'libs/ardour/audioengine.cc') diff --git a/libs/ardour/audioengine.cc b/libs/ardour/audioengine.cc index 08de54960c..1166b906f8 100644 --- a/libs/ardour/audioengine.cc +++ b/libs/ardour/audioengine.cc @@ -58,17 +58,9 @@ using namespace PBD; gint AudioEngine::m_meter_exit; AudioEngine* AudioEngine::_instance = 0; -#define GET_PRIVATE_JACK_POINTER(j) jack_client_t* _priv_jack = (jack_client_t*) (j); if (!_priv_jack) { return; } -#define GET_PRIVATE_JACK_POINTER_RET(j,r) jack_client_t* _priv_jack = (jack_client_t*) (j); if (!_priv_jack) { return r; } - -AudioEngine::AudioEngine (string client_name, string session_uuid) - : _jack (0) - , session_remove_pending (false) +AudioEngine::AudioEngine () + : session_remove_pending (false) , session_removal_countdown (-1) - , _running (false) - , _has_run (false) - , _buffer_size (0) - , _frame_rate (0) , monitor_check_interval (INT32_MAX) , last_monitor_check (0) , _processed_frames (0) @@ -80,14 +72,8 @@ AudioEngine::AudioEngine (string client_name, string session_uuid) , _main_thread (0) , ports (new Ports) { - _instance = this; /* singleton */ - g_atomic_int_set (&m_meter_exit, 0); - if (connect_to_jack (client_name, session_uuid)) { - throw NoBackendAvailable (); - } - Port::set_engine (this); } @@ -98,16 +84,19 @@ AudioEngine::~AudioEngine () { Glib::Threads::Mutex::Lock tm (_process_lock); session_removed.signal (); - - if (_running) { - jack_client_close (_jack); - _jack = 0; - } - stop_metering_thread (); } } +AudioEngine* +AudioEngine::create () +{ + if (_instance) { + return _instance; + } + return new AudioEngine; +} + jack_client_t* AudioEngine::jack() const { @@ -131,49 +120,6 @@ _thread_init_callback (void * /*arg*/) MIDI::JackMIDIPort::set_process_thread (pthread_self()); } -static void -ardour_jack_error (const char* msg) -{ - error << "JACK: " << msg << endmsg; -} - -void -AudioEngine::set_jack_callbacks () -{ - GET_PRIVATE_JACK_POINTER (_jack); - - if (jack_on_info_shutdown) { - jack_on_info_shutdown (_priv_jack, halted_info, this); - } else { - jack_on_shutdown (_priv_jack, halted, this); - } - - jack_set_thread_init_callback (_priv_jack, _thread_init_callback, this); - jack_set_process_thread (_priv_jack, _process_thread, this); - jack_set_sample_rate_callback (_priv_jack, _sample_rate_callback, this); - jack_set_buffer_size_callback (_priv_jack, _bufsize_callback, this); - jack_set_graph_order_callback (_priv_jack, _graph_order_callback, this); - jack_set_port_registration_callback (_priv_jack, _registration_callback, this); - jack_set_port_connect_callback (_priv_jack, _connect_callback, this); - jack_set_xrun_callback (_priv_jack, _xrun_callback, this); - jack_set_sync_callback (_priv_jack, _jack_sync_callback, this); - jack_set_freewheel_callback (_priv_jack, _freewheel_callback, this); - - if (_session && _session->config.get_jack_time_master()) { - jack_set_timebase_callback (_priv_jack, 0, _jack_timebase_callback, this); - } - -#ifdef HAVE_JACK_SESSION - if( jack_set_session_callback) - jack_set_session_callback (_priv_jack, _session_callback, this); -#endif - - if (jack_set_latency_callback) { - jack_set_latency_callback (_priv_jack, _latency_callback, this); - } - - jack_set_error_function (ardour_jack_error); -} int AudioEngine::start () @@ -240,180 +186,6 @@ AudioEngine::stop (bool forever) } -bool -AudioEngine::get_sync_offset (pframes_t& offset) const -{ - -#ifdef HAVE_JACK_VIDEO_SUPPORT - - GET_PRIVATE_JACK_POINTER_RET (_jack, false); - - jack_position_t pos; - - if (_priv_jack) { - (void) jack_transport_query (_priv_jack, &pos); - - if (pos.valid & JackVideoFrameOffset) { - offset = pos.video_offset; - return true; - } - } -#else - /* keep gcc happy */ - offset = 0; -#endif - - return false; -} - -void -AudioEngine::_jack_timebase_callback (jack_transport_state_t state, pframes_t nframes, - jack_position_t* pos, int new_position, void *arg) -{ - static_cast (arg)->jack_timebase_callback (state, nframes, pos, new_position); -} - -void -AudioEngine::jack_timebase_callback (jack_transport_state_t state, pframes_t nframes, - jack_position_t* pos, int new_position) -{ - if (_jack && _session && _session->synced_to_jack()) { - _session->jack_timebase_callback (state, nframes, pos, new_position); - } -} - -int -AudioEngine::_jack_sync_callback (jack_transport_state_t state, jack_position_t* pos, void* arg) -{ - return static_cast (arg)->jack_sync_callback (state, pos); -} - -int -AudioEngine::jack_sync_callback (jack_transport_state_t state, jack_position_t* pos) -{ - if (_jack && _session) { - return _session->jack_sync_callback (state, pos); - } - - return true; -} - -int -AudioEngine::_xrun_callback (void *arg) -{ - AudioEngine* ae = static_cast (arg); - if (ae->connected()) { - ae->Xrun (); /* EMIT SIGNAL */ - } - return 0; -} - -#ifdef HAVE_JACK_SESSION -void -AudioEngine::_session_callback (jack_session_event_t *event, void *arg) -{ - AudioEngine* ae = static_cast (arg); - if (ae->connected()) { - ae->JackSessionEvent ( event ); /* EMIT SIGNAL */ - } -} -#endif - -int -AudioEngine::_graph_order_callback (void *arg) -{ - AudioEngine* ae = static_cast (arg); - - if (ae->connected() && !ae->port_remove_in_progress) { - ae->GraphReordered (); /* EMIT SIGNAL */ - } - - return 0; -} - -void* -AudioEngine::_process_thread (void *arg) -{ - return static_cast (arg)->process_thread (); -} - -void -AudioEngine::_freewheel_callback (int onoff, void *arg) -{ - static_cast(arg)->freewheel_callback (onoff); -} - -void -AudioEngine::freewheel_callback (int onoff) -{ - _freewheeling = onoff; - - if (onoff) { - _pre_freewheel_mmc_enabled = MIDI::Manager::instance()->mmc()->send_enabled (); - MIDI::Manager::instance()->mmc()->enable_send (false); - } else { - MIDI::Manager::instance()->mmc()->enable_send (_pre_freewheel_mmc_enabled); - } -} - -void -AudioEngine::_registration_callback (jack_port_id_t /*id*/, int /*reg*/, void* arg) -{ - AudioEngine* ae = static_cast (arg); - - if (!ae->port_remove_in_progress) { - ae->PortRegisteredOrUnregistered (); /* EMIT SIGNAL */ - } -} - -void -AudioEngine::_latency_callback (jack_latency_callback_mode_t mode, void* arg) -{ - return static_cast (arg)->jack_latency_callback (mode); -} - -void -AudioEngine::_connect_callback (jack_port_id_t id_a, jack_port_id_t id_b, int conn, void* arg) -{ - AudioEngine* ae = static_cast (arg); - ae->connect_callback (id_a, id_b, conn); -} - -void -AudioEngine::connect_callback (jack_port_id_t id_a, jack_port_id_t id_b, int conn) -{ - if (port_remove_in_progress) { - return; - } - - GET_PRIVATE_JACK_POINTER (_jack); - - jack_port_t* jack_port_a = jack_port_by_id (_priv_jack, id_a); - jack_port_t* jack_port_b = jack_port_by_id (_priv_jack, id_b); - - boost::shared_ptr port_a; - boost::shared_ptr port_b; - Ports::iterator x; - boost::shared_ptr pr = ports.reader (); - - - x = pr->find (make_port_name_relative (jack_port_name (jack_port_a))); - if (x != pr->end()) { - port_a = x->second; - } - - x = pr->find (make_port_name_relative (jack_port_name (jack_port_b))); - if (x != pr->end()) { - port_b = x->second; - } - - PortConnectedOrDisconnected ( - port_a, jack_port_name (jack_port_a), - port_b, jack_port_name (jack_port_b), - conn == 0 ? false : true - ); /* EMIT SIGNAL */ -} - void AudioEngine::split_cycle (pframes_t offset) { @@ -430,30 +202,6 @@ AudioEngine::split_cycle (pframes_t offset) } } -void* -AudioEngine::process_thread () -{ - /* JACK doesn't do this for us when we use the wait API - */ - - _thread_init_callback (0); - - _main_thread = new ProcessThread; - - while (1) { - GET_PRIVATE_JACK_POINTER_RET(_jack,0); - - pframes_t nframes = jack_cycle_wait (_priv_jack); - - if (process_callback (nframes)) { - return 0; - } - - jack_cycle_signal (_priv_jack, 0); - } - - return 0; -} /** Method called by our ::process_thread when there is work to be done. * @param nframes Number of frames to process. @@ -644,97 +392,6 @@ AudioEngine::process_callback (pframes_t nframes) return 0; } -int -AudioEngine::_sample_rate_callback (pframes_t nframes, void *arg) -{ - return static_cast (arg)->jack_sample_rate_callback (nframes); -} - -int -AudioEngine::jack_sample_rate_callback (pframes_t nframes) -{ - _frame_rate = nframes; - _usecs_per_cycle = (int) floor ((((double) frames_per_cycle() / nframes)) * 1000000.0); - - /* check for monitor input change every 1/10th of second */ - - monitor_check_interval = nframes / 10; - last_monitor_check = 0; - - if (_session) { - _session->set_frame_rate (nframes); - } - - SampleRateChanged (nframes); /* EMIT SIGNAL */ - - return 0; -} - -void -AudioEngine::jack_latency_callback (jack_latency_callback_mode_t mode) -{ - if (_session) { - _session->update_latency (mode == JackPlaybackLatency); - } -} - -int -AudioEngine::_bufsize_callback (pframes_t nframes, void *arg) -{ - return static_cast (arg)->jack_bufsize_callback (nframes); -} - -int -AudioEngine::jack_bufsize_callback (pframes_t nframes) -{ - /* if the size has not changed, this should be a no-op */ - - if (nframes == _buffer_size) { - return 0; - } - - GET_PRIVATE_JACK_POINTER_RET (_jack, 1); - - _buffer_size = nframes; - _usecs_per_cycle = (int) floor ((((double) nframes / frame_rate())) * 1000000.0); - last_monitor_check = 0; - - if (jack_port_type_get_buffer_size) { - _raw_buffer_sizes[DataType::AUDIO] = jack_port_type_get_buffer_size (_priv_jack, JACK_DEFAULT_AUDIO_TYPE); - _raw_buffer_sizes[DataType::MIDI] = jack_port_type_get_buffer_size (_priv_jack, JACK_DEFAULT_MIDI_TYPE); - } else { - - /* Old version of JACK. - - These crude guesses, see below where we try to get the right answers. - - Note that our guess for MIDI deliberatey tries to overestimate - by a little. It would be nicer if we could get the actual - size from a port, but we have to use this estimate in the - event that there are no MIDI ports currently. If there are - the value will be adjusted below. - */ - - _raw_buffer_sizes[DataType::AUDIO] = nframes * sizeof (Sample); - _raw_buffer_sizes[DataType::MIDI] = nframes * 4 - (nframes/2); - } - - { - Glib::Threads::Mutex::Lock lm (_process_lock); - - boost::shared_ptr p = ports.reader(); - - for (Ports::iterator i = p->begin(); i != p->end(); ++i) { - i->second->reset(); - } - } - - if (_session) { - _session->set_block_size (_buffer_size); - } - - return 0; -} void AudioEngine::stop_metering_thread () @@ -759,8 +416,9 @@ void AudioEngine::meter_thread () { pthread_set_name (X_("meter")); + while (true) { - Glib::usleep (10000); + Glib::usleep (10000); /* 1/100th sec interval */ if (g_atomic_int_get(&m_meter_exit)) { break; } @@ -1032,7 +690,7 @@ AudioEngine::raw_buffer_size (DataType t) ARDOUR::pframes_t AudioEngine::frames_per_cycle () const { - GET_PRIVATE_JACK_POINTER_RET (_jack,0); + GET_PRIVATE_JACK_POINTER_RET (_jack,0); if (_buffer_size == 0) { return jack_get_buffer_size (_jack); } else { @@ -1110,60 +768,6 @@ AudioEngine::get_ports (const string& port_name_pattern, const string& type_name return jack_get_ports (_priv_jack, port_name_pattern.c_str(), type_name_pattern.c_str(), flags); } -void -AudioEngine::halted_info (jack_status_t code, const char* reason, void *arg) -{ - /* called from jack shutdown handler */ - - AudioEngine* ae = static_cast (arg); - bool was_running = ae->_running; - - ae->stop_metering_thread (); - - ae->_running = false; - ae->_buffer_size = 0; - ae->_frame_rate = 0; - ae->_jack = 0; - - if (was_running) { - MIDI::JackMIDIPort::JackHalted (); /* EMIT SIGNAL */ -#ifdef HAVE_JACK_ON_INFO_SHUTDOWN - switch (code) { - case JackBackendError: - ae->Halted(reason); /* EMIT SIGNAL */ - break; - default: - ae->Halted(""); /* EMIT SIGNAL */ - } -#else - ae->Halted(""); /* EMIT SIGNAL */ -#endif - } -} - -void -AudioEngine::halted (void *arg) -{ - cerr << "HALTED by JACK\n"; - - /* called from jack shutdown handler */ - - AudioEngine* ae = static_cast (arg); - bool was_running = ae->_running; - - ae->stop_metering_thread (); - - ae->_running = false; - ae->_buffer_size = 0; - ae->_frame_rate = 0; - ae->_jack = 0; - - if (was_running) { - MIDI::JackMIDIPort::JackHalted (); /* EMIT SIGNAL */ - ae->Halted(""); /* EMIT SIGNAL */ - } -} - void AudioEngine::died () { @@ -1267,34 +871,6 @@ AudioEngine::get_physical_outputs (DataType type, vector& outs) get_physical (type, JackPortIsInput, outs); } -void -AudioEngine::transport_stop () -{ - GET_PRIVATE_JACK_POINTER (_jack); - jack_transport_stop (_priv_jack); -} - -void -AudioEngine::transport_start () -{ - GET_PRIVATE_JACK_POINTER (_jack); - jack_transport_start (_priv_jack); -} - -void -AudioEngine::transport_locate (framepos_t where) -{ - GET_PRIVATE_JACK_POINTER (_jack); - jack_transport_locate (_priv_jack, where); -} - -AudioEngine::TransportState -AudioEngine::transport_state () -{ - GET_PRIVATE_JACK_POINTER_RET (_jack, ((TransportState) JackTransportStopped)); - jack_position_t pos; - return (TransportState) jack_transport_query (_priv_jack, &pos); -} int AudioEngine::reset_timebase () @@ -1310,20 +886,6 @@ AudioEngine::reset_timebase () return 0; } -int -AudioEngine::freewheel (bool onoff) -{ - GET_PRIVATE_JACK_POINTER_RET (_jack, -1); - - if (onoff != _freewheeling) { - return jack_set_freewheel (_priv_jack, onoff); - - } else { - /* already doing what has been asked for */ - return 0; - } -} - void AudioEngine::remove_all_ports () { @@ -1349,148 +911,6 @@ AudioEngine::remove_all_ports () port_remove_in_progress = false; } -int -AudioEngine::connect_to_jack (string client_name, string session_uuid) -{ - EnvironmentalProtectionAgency* global_epa = EnvironmentalProtectionAgency::get_global_epa (); - boost::scoped_ptr current_epa; - jack_status_t status; - - /* revert all environment settings back to whatever they were when ardour started - */ - - if (global_epa) { - current_epa.reset (new EnvironmentalProtectionAgency(true)); /* will restore settings when we leave scope */ - global_epa->restore (); - } - - jack_client_name = client_name; /* might be reset below */ -#ifdef HAVE_JACK_SESSION - if (! session_uuid.empty()) - _jack = jack_client_open (jack_client_name.c_str(), JackSessionID, &status, session_uuid.c_str()); - else -#endif - _jack = jack_client_open (jack_client_name.c_str(), JackNullOption, &status, 0); - - if (_jack == NULL) { - // error message is not useful here - return -1; - } - - GET_PRIVATE_JACK_POINTER_RET (_jack, -1); - - if (status & JackNameNotUnique) { - jack_client_name = jack_get_client_name (_priv_jack); - } - - return 0; -} - -int -AudioEngine::disconnect_from_jack () -{ - GET_PRIVATE_JACK_POINTER_RET (_jack, 0); - - if (_running) { - stop_metering_thread (); - } - - { - Glib::Threads::Mutex::Lock lm (_process_lock); - jack_client_close (_priv_jack); - _jack = 0; - } - - _buffer_size = 0; - _frame_rate = 0; - _raw_buffer_sizes.clear(); - - if (_running) { - _running = false; - MIDI::JackMIDIPort::JackHalted (); /* EMIT SIGNAL */ - Stopped(); /* EMIT SIGNAL */ - } - - return 0; -} - -int -AudioEngine::reconnect_to_jack () -{ - if (_running) { - disconnect_from_jack (); - /* XXX give jackd a chance */ - Glib::usleep (250000); - } - - if (connect_to_jack (jack_client_name, "")) { - error << _("failed to connect to JACK") << endmsg; - return -1; - } - - Ports::iterator i; - - boost::shared_ptr p = ports.reader (); - - for (i = p->begin(); i != p->end(); ++i) { - if (i->second->reestablish ()) { - break; - } - } - - if (i != p->end()) { - /* failed */ - remove_all_ports (); - return -1; - } - - GET_PRIVATE_JACK_POINTER_RET (_jack,-1); - - MIDI::Manager::instance()->reestablish (_priv_jack); - - if (_session) { - _session->reset_jack_connection (_priv_jack); - jack_bufsize_callback (jack_get_buffer_size (_priv_jack)); - _session->set_frame_rate (jack_get_sample_rate (_priv_jack)); - } - - last_monitor_check = 0; - - set_jack_callbacks (); - - if (jack_activate (_priv_jack) == 0) { - _running = true; - _has_run = true; - } else { - return -1; - } - - /* re-establish connections */ - - for (i = p->begin(); i != p->end(); ++i) { - i->second->reconnect (); - } - - MIDI::Manager::instance()->reconnect (); - - Running (); /* EMIT SIGNAL*/ - - start_metering_thread (); - - return 0; -} - -int -AudioEngine::request_buffer_size (pframes_t nframes) -{ - GET_PRIVATE_JACK_POINTER_RET (_jack, -1); - - if (nframes == jack_get_buffer_size (_priv_jack)) { - return 0; - } - - return jack_set_buffer_size (_priv_jack, nframes); -} string AudioEngine::make_port_name_relative (string portname) const @@ -1540,39 +960,6 @@ AudioEngine::port_is_mine (const string& portname) const return true; } -bool -AudioEngine::is_realtime () const -{ - GET_PRIVATE_JACK_POINTER_RET (_jack,false); - return jack_is_realtime (_priv_jack); -} - -int -AudioEngine::create_process_thread (boost::function f, pthread_t* thread, size_t stacksize) -{ - GET_PRIVATE_JACK_POINTER_RET (_jack, 0); - ThreadData* td = new ThreadData (this, f, stacksize); - - if (jack_client_create_thread (_priv_jack, thread, jack_client_real_time_priority (_priv_jack), - jack_is_realtime (_priv_jack), _start_process_thread, td)) { - return -1; - } - - return 0; -} - -void* -AudioEngine::_start_process_thread (void* arg) -{ - ThreadData* td = reinterpret_cast (arg); - boost::function f = td->f; - delete td; - - f (); - - return 0; -} - bool AudioEngine::port_is_physical (const std::string& portname) const { @@ -1588,32 +975,59 @@ AudioEngine::port_is_physical (const std::string& portname) const } void -AudioEngine::request_jack_monitors_input (const std::string& portname, bool yn) const +AudioEngine::destroy () { - GET_PRIVATE_JACK_POINTER(_jack); + delete _instance; + _instance = 0; +} - jack_port_t *port = jack_port_by_name (_priv_jack, portname.c_str()); +int +AudioEngine::discover_backends () +{ + vector backend_modules; + AudioBackend* backend; - if (!port) { - return; - } + Glib::PatternSpec so_extension_pattern("*.so"); + Glib::PatternSpec dylib_extension_pattern("*.dylib"); - jack_port_request_monitor (port, yn); -} + find_matching_files_in_search_path (backend_search_path (), + so_extension_pattern, backend_modules); -void -AudioEngine::update_latencies () -{ - if (jack_recompute_total_latencies) { - GET_PRIVATE_JACK_POINTER (_jack); - jack_recompute_total_latencies (_priv_jack); - } + find_matching_files_in_search_path (backend_search_path (), + dylib_extension_pattern, backend_modules); + + DEBUG_TRACE (DEBUG::Panning, string_compose (_("looking for backends in %1"), backend_search_path().to_string())); + + for (vector::iterator i = backend_modules.begin(); i != backend_modules.end(); ++i) { + if ((backend = backend_discover (*i)) != 0) { + _backends.insert (make_pair (backend->name(), backend)); + } + } } -void -AudioEngine::destroy () +AudioBackend* +AudioEngine::backend_discover (string path) { - delete _instance; - _instance = 0; -} + Glib::Module* module = new Glib::Module(path); + AudioBackend* (*dfunc)(void); + void* func = 0; + + if (!module) { + error << string_compose(_("AudioEngine: cannot load module \"%1\" (%2)"), path, + Glib::Module::get_last_error()) << endmsg; + delete module; + return 0; + } + if (!module->get_symbol("backend_factory", func)) { + error << string_compose(_("AudioEngine: module \"%1\" has no factory function."), path) << endmsg; + error << Glib::Module::get_last_error() << endmsg; + delete module; + return 0; + } + + dfunc = (AudioBackend* (*)(void))func; + AudioBackend* backend = dfunc(); + + return backend; +} -- cgit v1.2.3