/*
- Copyright (C) 2002-2004 Paul Davis
+ 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 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.
+ 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.
+ 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.
*/
#ifndef __ardour_audioengine_h__
#define __ardour_audioengine_h__
+#ifdef WAF_BUILD
+#include "libardour-config.h"
+#endif
+
+#include <iostream>
#include <list>
#include <set>
#include <cmath>
#include <exception>
#include <string>
-#include <sigc++/signal.h>
+#include <glibmm/threads.h>
-#include <glibmm/thread.h>
+#include "pbd/signals.h"
+#include "pbd/stacktrace.h"
-#include <pbd/rcu.h>
+#include "ardour/ardour.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"
-#include <ardour/ardour.h>
-#include <jack/jack.h>
-#include <jack/transport.h>
-#include <ardour/types.h>
-#include <ardour/data_type.h>
+class MTDM;
namespace ARDOUR {
-class Session;
-class Port;
class InternalPort;
+class MidiPort;
+class MIDIDM;
+class Port;
+class Session;
+class ProcessThread;
+class AudioBackend;
+struct AudioBackendInfo;
-class AudioEngine : public sigc::trackable
+class LIBARDOUR_API AudioEngine : public PortManager, public SessionHandlePtr
{
- public:
- typedef std::set<Port*> Ports;
-
- AudioEngine (std::string client_name);
- virtual ~AudioEngine ();
-
- jack_client_t* jack() const;
- bool connected() const { return _jack != 0; }
+ public:
- bool is_realtime () const;
+ static AudioEngine* create ();
- std::string client_name() const { return jack_client_name; }
-
- int reconnect_to_jack ();
- int disconnect_from_jack();
+ virtual ~AudioEngine ();
- bool will_reconnect_at_halt ();
- void set_reconnect_at_halt (bool);
+ int discover_backends();
+ std::vector<const AudioBackendInfo*> available_backends() const;
+ std::string current_backend_name () const;
+ boost::shared_ptr<AudioBackend> set_default_backend ();
+ 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;
+
+ ProcessThread* main_thread() const { return _main_thread; }
+
+ /* START BACKEND PROXY API
+ *
+ * See audio_backend.h for full documentation and semantics. These wrappers
+ * just forward to a backend implementation.
+ */
+
+ 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 (framepos_t pos);
+ framepos_t transport_frame();
+ framecnt_t sample_rate () const;
+ pframes_t samples_per_cycle () const;
+ int usecs_per_cycle () const;
+ size_t raw_buffer_size (DataType t);
+ framepos_t sample_time ();
+ framepos_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 ();
+
+ int backend_reset_requested();
+ void request_backend_reset();
+ void request_device_list_update();
+ void launch_device_control_app();
+
+ bool is_realtime() const;
+ bool connected() const;
+
+ // 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 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);
+
+ /* END BACKEND PROXY API */
- int stop (bool forever = false);
- int start ();
+ bool freewheeling() const { return _freewheeling; }
bool running() const { return _running; }
- Glib::Mutex& process_lock() { return _process_lock; }
-
- nframes_t frame_rate();
- nframes_t frames_per_cycle();
-
- int usecs_per_cycle () const { return _usecs_per_cycle; }
+ Glib::Threads::Mutex& process_lock() { return _process_lock; }
+ Glib::Threads::RecMutex& state_lock() { return _state_lock; }
- bool get_sync_offset (nframes_t& offset) const;
-
- nframes_t frames_since_cycle_start () {
- if (!_running || !_jack) return 0;
- return jack_frames_since_cycle_start (_jack);
- }
- nframes_t frame_time () {
- if (!_running || !_jack) return 0;
- return jack_frame_time (_jack);
+ int request_buffer_size (pframes_t samples) {
+ return set_buffer_size (samples);
}
- nframes_t transport_frame () const {
- if (!_running || !_jack) return 0;
- return jack_get_current_transport_frame (_jack);
- }
-
- int request_buffer_size (nframes_t);
-
- nframes_t set_monitor_check_interval (nframes_t);
-
- float get_cpu_load() {
- if (!_running || !_jack) return 0;
- return jack_cpu_load (_jack);
- }
+ framecnt_t processed_frames() const { return _processed_frames; }
void set_session (Session *);
- void remove_session ();
+ void remove_session (); // not a replacement for SessionHandle::session_going_away()
+ Session* session() const { return _session; }
- class PortRegistrationFailure : public std::exception {
- public:
- virtual const char *what() const throw() { return "failed port registration"; }
- };
+ void reconnect_session_routes (bool reconnect_inputs = true, bool reconnect_outputs = true);
class NoBackendAvailable : public std::exception {
- public:
+ public:
virtual const char *what() const throw() { return "could not connect to engine backend"; }
};
- Port *register_input_port (PortType, DataType, const std::string& portname);
- Port *register_output_port (PortType, DataType, const std::string& portname);
- int unregister_port (Port &);
-
- 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);
-
- uint32_t n_physical_outputs () const;
- uint32_t n_physical_inputs () const;
-
- void get_physical_outputs (std::vector<std::string>&);
- void get_physical_inputs (std::vector<std::string>&);
-
- std::string get_nth_physical_output (DataType type, uint32_t n) {
- return get_nth_physical (type, n, JackPortIsInput);
- }
-
- std::string get_nth_physical_input (DataType type, uint32_t n) {
- return get_nth_physical (type, n, JackPortIsOutput);
- }
-
- nframes_t get_port_total_latency (const Port&);
- void update_total_latencies ();
- void update_total_latency (const Port&);
-
- /** Caller may not delete the object pointed to by the return value
- */
- Port *get_port_by_name (const std::string& name, bool keep = true) const;
-
- enum TransportState {
- TransportStopped = JackTransportStopped,
- TransportRolling = JackTransportRolling,
- TransportLooping = JackTransportLooping,
- TransportStarting = JackTransportStarting
- };
-
- void transport_start ();
- void transport_stop ();
- void transport_locate (nframes_t);
- TransportState transport_state ();
+ void split_cycle (pframes_t offset);
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)
*/
- sigc::signal<int,nframes_t> Freewheel;
+ PBD::Signal1<void, pframes_t> Freewheel;
+
+ PBD::Signal0<void> Xrun;
- sigc::signal<void> Xrun;
+ /** this signal is emitted if the sample rate changes */
+ PBD::Signal1<void, framecnt_t> SampleRateChanged;
- /* this signal is if JACK notifies us of a graph order event */
+ /** this signal is emitted if the buffer size changes */
+ PBD::Signal1<void, pframes_t> BufferSizeChanged;
- sigc::signal<void> GraphReordered;
+ /** 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 */
- sigc::signal<void,nframes_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 */
- sigc::signal<void> Halted;
+ PBD::Signal1<void,const char*> Halted;
/* these two are emitted when the engine itself is
started and stopped
*/
- sigc::signal<void> Running;
- sigc::signal<void> Stopped;
+ PBD::Signal0<void> Running;
+ PBD::Signal0<void> Stopped;
+
+ /* these two are emitted when a device reset is initiated/finished
+ */
+
+ PBD::Signal0<void> DeviceResetStarted;
+ PBD::Signal0<void> DeviceResetFinished;
+
+ static AudioEngine* instance() { return _instance; }
+ static void destroy();
+ void died ();
+
+ /* 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, framepos_t pos, int new_position);
+ int sync_callback (TransportState state, framepos_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
+ };
+
+ LatencyMeasurement measuring_latency () const { return _measuring_latency; }
+
+ /* 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.
+ */
- std::string make_port_name_relative (std::string);
- std::string make_port_name_non_relative (std::string);
+ PBD::Signal0<void> BecameSilent;
+ void reset_silence_countdown ();
private:
- ARDOUR::Session *session;
- jack_client_t *_jack;
- std::string jack_client_name;
- mutable Glib::Mutex _process_lock;
- Glib::Cond session_removed;
- bool session_remove_pending;
- bool _running;
- bool _has_run;
- nframes_t _buffer_size;
- nframes_t _frame_rate;
+ AudioEngine ();
+
+ static AudioEngine* _instance;
+
+ Glib::Threads::Mutex _process_lock;
+ Glib::Threads::RecMutex _state_lock;
+ Glib::Threads::Cond session_removed;
+ bool session_remove_pending;
+ frameoffset_t session_removal_countdown;
+ gain_t session_removal_gain;
+ gain_t session_removal_gain_step;
+ bool _running;
+ bool _freewheeling;
/// number of frames between each check for changes in monitor input
- nframes_t monitor_check_interval;
+ framecnt_t monitor_check_interval;
/// time of the last monitor check in frames
- nframes_t last_monitor_check;
+ framecnt_t last_monitor_check;
/// the number of frames processed since start() was called
- nframes_t _processed_frames;
- bool _freewheeling;
- bool _freewheel_thread_registered;
- sigc::slot<int,nframes_t> freewheel_action;
- bool reconnect_on_halt;
- int _usecs_per_cycle;
-
- SerializedRCUManager<Ports> ports;
-
- Port *register_port (PortType ptype, DataType type, const std::string& portname, bool input);
-
- int process_callback (nframes_t nframes);
- void remove_all_ports ();
-
- InternalPort* get_internal_port (const std::string& short_name);
-
- typedef std::pair<std::string,std::string> PortConnection;
- typedef std::list<PortConnection> PortConnections;
-
- PortConnections port_connections;
- void remove_connections_for (Port&);
-
- std::string get_nth_physical (DataType type, uint32_t n, int flags);
-
- static int _xrun_callback (void *arg);
- static int _graph_order_callback (void *arg);
- static int _process_callback (nframes_t nframes, void *arg);
- static int _sample_rate_callback (nframes_t nframes, void *arg);
- static int _bufsize_callback (nframes_t nframes, void *arg);
- static void _jack_timebase_callback (jack_transport_state_t, nframes_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);
-
- void jack_timebase_callback (jack_transport_state_t, nframes_t, jack_position_t*, int);
- int jack_sync_callback (jack_transport_state_t, jack_position_t*);
- int jack_bufsize_callback (nframes_t);
- int jack_sample_rate_callback (nframes_t);
-
- static void halted (void *);
-
- int connect_to_jack (std::string client_name);
-
- void meter_thread ();
- void start_metering_thread ();
- void stop_metering_thread ();
+ framecnt_t _processed_frames;
+ 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;
+ framecnt_t _latency_flush_frames;
+ std::string _latency_input_name;
+ std::string _latency_output_name;
+ framecnt_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;
+
+ 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
+ framecnt_t _silence_countdown;
+ uint32_t _silence_hit_cnt;
+#endif
- Glib::Thread* m_meter_thread;
- static gint m_meter_exit;
};
} // namespace ARDOUR
projects / ardour.git / blobdiff