/*
- Copyright (C) 2002-2004 Paul Davis
-
- This program is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2 of the License, or
- (at your option) any later version.
-
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU General Public License for more details.
-
- You should have received a copy of the GNU General Public License
- along with this program; if not, write to the Free Software
- Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-
-*/
+ * Copyright (C) 2006-2011 David Robillard <d@drobilla.net>
+ * Copyright (C) 2006-2019 Paul Davis <paul@linuxaudiosystems.com>
+ * Copyright (C) 2007-2012 Carl Hetherington <carl@carlh.net>
+ * Copyright (C) 2012-2019 Robin Gareus <robin@gareus.org>
+ * Copyright (C) 2013-2015 Tim Mayberry <mojofunk@gmail.com>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
#ifndef __ardour_audioengine_h__
#define __ardour_audioengine_h__
#include <exception>
#include <string>
-#include <glibmm/thread.h>
+#include <glibmm/threads.h>
-#include "pbd/rcu.h"
#include "pbd/signals.h"
+#include "pbd/stacktrace.h"
#include "ardour/ardour.h"
-#include <jack/jack.h>
-#include <jack/transport.h>
-
#include "ardour/data_type.h"
#include "ardour/session_handle.h"
+#include "ardour/libardour_visibility.h"
#include "ardour/types.h"
#include "ardour/chan_count.h"
+#include "ardour/port_manager.h"
-#ifdef HAVE_JACK_SESSION
-#include <jack/session.h>
-#endif
+class MTDM;
namespace ARDOUR {
class InternalPort;
class MidiPort;
+class MIDIDM;
class Port;
class Session;
class ProcessThread;
+class AudioBackend;
+struct AudioBackendInfo;
-class AudioEngine : public SessionHandlePtr
+class LIBARDOUR_API AudioEngine : public PortManager, public SessionHandlePtr
{
- public:
- typedef std::set<Port*> Ports;
+ public:
- class disconnected_exception : public std::exception {
- public:
- virtual const char *what() const throw() { return "AudioEngine is disconnected"; }
- };
+ static AudioEngine* create ();
- AudioEngine (std::string client_name, std::string session_uuid);
virtual ~AudioEngine ();
- jack_client_t* jack() const;
- bool connected() const { return _jack != 0; }
-
- bool is_realtime () const;
-
- ProcessThread* main_thread() const { return _main_thread; }
+ int discover_backends();
+ std::vector<const AudioBackendInfo*> available_backends() const;
+ std::string current_backend_name () const;
+ boost::shared_ptr<AudioBackend> set_backend (const std::string&, const std::string& arg1, const std::string& arg2);
+ boost::shared_ptr<AudioBackend> current_backend() const { return _backend; }
+ bool setup_required () const;
- std::string client_name() const { return jack_client_name; }
+ ProcessThread* main_thread() const { return _main_thread; }
- int reconnect_to_jack ();
- int disconnect_from_jack();
-
- bool will_reconnect_at_halt ();
- void set_reconnect_at_halt (bool);
+ /* START BACKEND PROXY API
+ *
+ * See audio_backend.h for full documentation and semantics. These wrappers
+ * just forward to a backend implementation.
+ */
- int stop (bool forever = false);
- int start ();
- bool running() const { return _running; }
+ int start (bool for_latency_measurement=false);
+ int stop (bool for_latency_measurement=false);
+ int freewheel (bool start_stop);
+ float get_dsp_load() const ;
+ void transport_start ();
+ void transport_stop ();
+ TransportState transport_state ();
+ void transport_locate (samplepos_t pos);
+ samplepos_t transport_sample();
+ samplecnt_t sample_rate () const;
+ pframes_t samples_per_cycle () const;
+ int usecs_per_cycle () const;
+ size_t raw_buffer_size (DataType t);
+ samplepos_t sample_time ();
+ samplepos_t sample_time_at_cycle_start ();
+ pframes_t samples_since_cycle_start ();
+ bool get_sync_offset (pframes_t& offset) const;
+
+ std::string get_last_backend_error () const { return _last_backend_error_string; }
+
+ int create_process_thread (boost::function<void()> func);
+ int join_process_threads ();
+ bool in_process_thread ();
+ uint32_t process_thread_count ();
+
+ /* internal backends
+ * -20 : main thread
+ * -21 : additional I/O threads e.g. MIDI
+ * -22 : client/process threads
+ *
+ * search for
+ * - pbd_realtime_pthread_create
+ * - pbd_set_thread_priority
+ */
+ virtual int client_real_time_priority () { return -22; }
- Glib::Mutex& process_lock() { return _process_lock; }
+ int backend_reset_requested();
+ void request_backend_reset();
+ void request_device_list_update();
+ void launch_device_control_app();
- framecnt_t frame_rate () const;
- pframes_t frames_per_cycle () const;
+ bool is_realtime() const;
- size_t raw_buffer_size(DataType t);
+ // for the user which hold state_lock to check if reset operation is pending
+ bool is_reset_requested() const { return g_atomic_int_get(const_cast<gint*>(&_hw_reset_request_count)); }
- int usecs_per_cycle () const { return _usecs_per_cycle; }
+ int set_device_name (const std::string&);
+ int set_sample_rate (float);
+ int set_buffer_size (uint32_t);
+ int set_interleaved (bool yn);
+ int set_input_channels (uint32_t);
+ int set_output_channels (uint32_t);
+ int set_systemic_input_latency (uint32_t);
+ int set_systemic_output_latency (uint32_t);
- bool get_sync_offset (pframes_t & offset) const;
+ /* END BACKEND PROXY API */
- pframes_t frames_since_cycle_start () {
- jack_client_t* _priv_jack = _jack;
- if (!_running || !_priv_jack) {
- return 0;
- }
- return jack_frames_since_cycle_start (_priv_jack);
- }
-
- pframes_t frame_time () {
- jack_client_t* _priv_jack = _jack;
- if (!_running || !_priv_jack) {
- return 0;
- }
- return jack_frame_time (_priv_jack);
- }
+ bool freewheeling() const { return _freewheeling; }
+ bool running() const { return _running; }
- pframes_t frame_time_at_cycle_start () {
- jack_client_t* _priv_jack = _jack;
- if (!_running || !_priv_jack) {
- return 0;
- }
- return jack_last_frame_time (_priv_jack);
- }
+ Glib::Threads::Mutex& process_lock() { return _process_lock; }
+ Glib::Threads::RecMutex& state_lock() { return _state_lock; }
- pframes_t transport_frame () const {
- const jack_client_t* _priv_jack = _jack;
- if (!_running || !_priv_jack) {
- return 0;
- }
- return jack_get_current_transport_frame (_priv_jack);
+ int request_buffer_size (pframes_t samples) {
+ return set_buffer_size (samples);
}
- int request_buffer_size (pframes_t);
-
- framecnt_t set_monitor_check_interval (framecnt_t);
- framecnt_t processed_frames() const { return _processed_frames; }
-
- float get_cpu_load() {
- jack_client_t* _priv_jack = _jack;
- if (!_running || !_priv_jack) {
- return 0;
- }
- return jack_cpu_load (_priv_jack);
- }
+ samplecnt_t processed_samples() const { return _processed_samples; }
void set_session (Session *);
void remove_session (); // not a replacement for SessionHandle::session_going_away()
-
- class PortRegistrationFailure : public std::exception {
- public:
- PortRegistrationFailure (std::string const & why = "")
- : reason (why) {}
-
- ~PortRegistrationFailure () throw () {}
-
- virtual const char *what() const throw () { return reason.c_str(); }
-
- private:
- std::string reason;
- };
+ Session* session() const { return _session; }
class NoBackendAvailable : public std::exception {
- public:
+ public:
virtual const char *what() const throw() { return "could not connect to engine backend"; }
};
- Port *register_input_port (DataType, const std::string& portname);
- Port *register_output_port (DataType, const std::string& portname);
- int unregister_port (Port &);
-
void split_cycle (pframes_t offset);
- int connect (const std::string& source, const std::string& destination);
- int disconnect (const std::string& source, const std::string& destination);
- int disconnect (Port &);
-
- const char ** get_ports (const std::string& port_name_pattern, const std::string& type_name_pattern, uint32_t flags);
-
- bool can_request_hardware_monitoring ();
-
- ChanCount n_physical_outputs () const;
- ChanCount n_physical_inputs () const;
-
- void get_physical_outputs (DataType type, std::vector<std::string>&);
- void get_physical_inputs (DataType type, std::vector<std::string>&);
-
- void update_total_latencies ();
- void update_total_latency (const Port&);
-
- Port *get_port_by_name (const std::string &);
-
- enum TransportState {
- TransportStopped = JackTransportStopped,
- TransportRolling = JackTransportRolling,
- TransportLooping = JackTransportLooping,
- TransportStarting = JackTransportStarting
- };
-
- void transport_start ();
- void transport_stop ();
- void transport_locate (framepos_t);
- TransportState transport_state ();
-
int reset_timebase ();
- /* start/stop freewheeling */
-
- int freewheel (bool onoff);
- bool freewheeling() const { return _freewheeling; }
+ void update_latencies ();
/* this signal is sent for every process() cycle while freewheeling.
-_ the regular process() call to session->process() is not made.
+ (the regular process() call to session->process() is not made)
*/
- PBD::Signal1<int, pframes_t> Freewheel;
+ PBD::Signal1<void, pframes_t> Freewheel;
PBD::Signal0<void> Xrun;
- /* this signal is if JACK notifies us of a graph order event */
+ /** this signal is emitted if the sample rate changes */
+ PBD::Signal1<void, samplecnt_t> SampleRateChanged;
- PBD::Signal0<void> GraphReordered;
-
-#ifdef HAVE_JACK_SESSION
- PBD::Signal1<void,jack_session_event_t *> JackSessionEvent;
-#endif
+ /** this signal is emitted if the buffer size changes */
+ PBD::Signal1<void, pframes_t> BufferSizeChanged;
+ /** this signal is emitted if the device cannot operate properly */
+ PBD::Signal0<void> DeviceError;
- /* this signal is emitted if the sample rate changes */
+ /* this signal is emitted if the device list changed */
- PBD::Signal1<void, framecnt_t> SampleRateChanged;
+ PBD::Signal0<void> DeviceListChanged;
- /* this signal is sent if JACK ever disconnects us */
+ /* this signal is sent if the backend ever disconnects us */
PBD::Signal1<void,const char*> Halted;
started and stopped
*/
- PBD::Signal0<void> Running;
+ PBD::Signal1<void,uint32_t> Running;
PBD::Signal0<void> Stopped;
- /** Emitted if a JACK port is registered or unregistered */
- PBD::Signal0<void> PortRegisteredOrUnregistered;
-
- /** Emitted if a JACK port is connected or disconnected.
- * The Port parameters are the ports being connected / disconnected, or 0 if they are not known to Ardour.
- * The bool parameter is true if ports were connected, or false for disconnected.
+ /* these two are emitted when a device reset is initiated/finished
*/
- PBD::Signal3<void, Port *, Port *, bool> PortConnectedOrDisconnected;
- std::string make_port_name_relative (std::string);
- std::string make_port_name_non_relative (std::string);
+ PBD::Signal0<void> DeviceResetStarted;
+ PBD::Signal0<void> DeviceResetFinished;
static AudioEngine* instance() { return _instance; }
+ static void destroy();
void died ();
- int create_process_thread (boost::function<void()>, pthread_t*, size_t stacksize);
+ /* The backend will cause these at the appropriate time(s)
+ */
+ int process_callback (pframes_t nframes);
+ int buffer_size_change (pframes_t nframes);
+ int sample_rate_change (pframes_t nframes);
+ void freewheel_callback (bool);
+ void timebase_callback (TransportState state, pframes_t nframes, samplepos_t pos, int new_position);
+ int sync_callback (TransportState state, samplepos_t position);
+ int port_registration_callback ();
+ void latency_callback (bool for_playback);
+ void halted_callback (const char* reason);
+
+ /* checks if current thread is properly set up for audio processing */
+ static bool thread_initialised_for_audio_processing ();
+
+ /* sets up the process callback thread */
+ static void thread_init_callback (void *);
+
+ /* latency measurement */
+
+ MTDM* mtdm() { return _mtdm; }
+ MIDIDM* mididm() { return _mididm; }
+
+ int prepare_for_latency_measurement ();
+ int start_latency_detection (bool);
+ void stop_latency_detection ();
+ void set_latency_input_port (const std::string&);
+ void set_latency_output_port (const std::string&);
+ uint32_t latency_signal_delay () const { return _latency_signal_latency; }
+
+ enum LatencyMeasurement {
+ MeasureNone,
+ MeasureAudio,
+ MeasureMIDI
+ };
- private:
- static AudioEngine* _instance;
+ LatencyMeasurement measuring_latency () const { return _measuring_latency; }
- jack_client_t* volatile _jack; /* could be reset to null by SIGPIPE or another thread */
- std::string jack_client_name;
- Glib::Mutex _process_lock;
- Glib::Cond session_removed;
- bool session_remove_pending;
- bool _running;
- bool _has_run;
- mutable framecnt_t _buffer_size;
- std::map<DataType,size_t> _raw_buffer_sizes;
- mutable framecnt_t _frame_rate;
- /// number of frames between each check for changes in monitor input
- framecnt_t monitor_check_interval;
- /// time of the last monitor check in frames
- framecnt_t last_monitor_check;
- /// the number of frames processed since start() was called
- framecnt_t _processed_frames;
- bool _freewheeling;
- bool _freewheel_pending;
- boost::function<int(framecnt_t)> freewheel_action;
- bool reconnect_on_halt;
- int _usecs_per_cycle;
-
- SerializedRCUManager<Ports> ports;
+ /* These two are used only in builds where SILENCE_AFTER_SECONDS was
+ * set. BecameSilent will be emitted when the audioengine goes silent.
+ * reset_silence_countdown() can be used to reset the silence
+ * countdown, whose duration will be reduced to half of its previous
+ * value.
+ */
- Port *register_port (DataType type, const std::string& portname, bool input);
+ PBD::Signal0<void> BecameSilent;
+ void reset_silence_countdown ();
- int process_callback (pframes_t nframes);
- void* process_thread ();
- void finish_process_cycle (int status);
- void remove_all_ports ();
+ void add_pending_port_deletion (Port*);
- ChanCount n_physical (unsigned long) const;
- void get_physical (DataType, unsigned long, std::vector<std::string> &);
+ private:
+ AudioEngine ();
- void port_registration_failure (const std::string& portname);
+ static AudioEngine* _instance;
- static int _xrun_callback (void *arg);
-#ifdef HAVE_JACK_SESSION
- static void _session_callback (jack_session_event_t *event, void *arg);
-#endif
- static int _graph_order_callback (void *arg);
- static int _process_callback (pframes_t nframes, void *arg);
- static void* _process_thread (void *arg);
- static int _sample_rate_callback (pframes_t nframes, void *arg);
- static int _bufsize_callback (pframes_t nframes, void *arg);
- static void _jack_timebase_callback (jack_transport_state_t, pframes_t, jack_position_t*, int, void*);
- static int _jack_sync_callback (jack_transport_state_t, jack_position_t*, void *arg);
- static void _freewheel_callback (int , void *arg);
- static void _registration_callback (jack_port_id_t, int, void *);
- static void _connect_callback (jack_port_id_t, jack_port_id_t, int, void *);
-
- void jack_timebase_callback (jack_transport_state_t, pframes_t, jack_position_t*, int);
- int jack_sync_callback (jack_transport_state_t, jack_position_t*);
- int jack_bufsize_callback (pframes_t);
- int jack_sample_rate_callback (pframes_t);
-
-#ifdef HAVE_JACK_NEW_LATENCY
- static void _latency_callback (jack_latency_callback_mode_t, void*);
- void jack_latency_callback (jack_latency_callback_mode_t);
+ Glib::Threads::Mutex _process_lock;
+ Glib::Threads::RecMutex _state_lock;
+ Glib::Threads::Cond session_removed;
+ bool session_remove_pending;
+ sampleoffset_t session_removal_countdown;
+ gain_t session_removal_gain;
+ gain_t session_removal_gain_step;
+ bool _running;
+ bool _freewheeling;
+ /// number of samples between each check for changes in monitor input
+ samplecnt_t monitor_check_interval;
+ /// time of the last monitor check in samples
+ samplecnt_t last_monitor_check;
+ /// the number of samples processed since start() was called
+ samplecnt_t _processed_samples;
+ Glib::Threads::Thread* m_meter_thread;
+ ProcessThread* _main_thread;
+ MTDM* _mtdm;
+ MIDIDM* _mididm;
+ LatencyMeasurement _measuring_latency;
+ PortEngine::PortHandle _latency_input_port;
+ PortEngine::PortHandle _latency_output_port;
+ samplecnt_t _latency_flush_samples;
+ std::string _latency_input_name;
+ std::string _latency_output_name;
+ samplecnt_t _latency_signal_latency;
+ bool _stopped_for_latency;
+ bool _started_for_latency;
+ bool _in_destructor;
+
+ std::string _last_backend_error_string;
+
+ Glib::Threads::Thread* _hw_reset_event_thread;
+ gint _hw_reset_request_count;
+ Glib::Threads::Cond _hw_reset_condition;
+ Glib::Threads::Mutex _reset_request_lock;
+ gint _stop_hw_reset_processing;
+ Glib::Threads::Thread* _hw_devicelist_update_thread;
+ gint _hw_devicelist_update_count;
+ Glib::Threads::Cond _hw_devicelist_update_condition;
+ Glib::Threads::Mutex _devicelist_update_lock;
+ gint _stop_hw_devicelist_processing;
+ uint32_t _start_cnt;
+ uint32_t _init_countdown;
+
+ void start_hw_event_processing();
+ void stop_hw_event_processing();
+ void do_reset_backend();
+ void do_devicelist_update();
+
+ typedef std::map<std::string,AudioBackendInfo*> BackendMap;
+ BackendMap _backends;
+ AudioBackendInfo* backend_discover (const std::string&);
+ void drop_backend ();
+
+#ifdef SILENCE_AFTER
+ samplecnt_t _silence_countdown;
+ uint32_t _silence_hit_cnt;
#endif
- int connect_to_jack (std::string client_name, std::string session_uuid);
-
- static void halted (void *);
- static void halted_info (jack_status_t,const char*,void *);
-
- void meter_thread ();
- void start_metering_thread ();
- void stop_metering_thread ();
-
- Glib::Thread* m_meter_thread;
- static gint m_meter_exit;
-
- ProcessThread* _main_thread;
-
- struct ThreadData {
- AudioEngine* engine;
- boost::function<void()> f;
- size_t stacksize;
-
- ThreadData (AudioEngine* ae, boost::function<void()> fp, size_t stacksz)
- : engine (ae) , f (fp) , stacksize (stacksz) {}
- };
-
- static void* _start_process_thread (void*);
};
} // namespace ARDOUR
projects / ardour.git / blobdiff