/*
- 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
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- $Id$
*/
#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/thread.h>
-#include <ardour/ardour.h>
+#include "pbd/rcu.h"
+#include "pbd/signals.h"
+
+#include <jack/weakjack.h>
#include <jack/jack.h>
#include <jack/transport.h>
+#include <jack/thread.h>
+
+#include "ardour/ardour.h"
+
+#include "ardour/data_type.h"
+#include "ardour/session_handle.h"
+#include "ardour/types.h"
+#include "ardour/chan_count.h"
+
+#ifdef HAVE_JACK_SESSION
+#include <jack/session.h>
+#endif
namespace ARDOUR {
-class Session;
+class InternalPort;
+class MidiPort;
class Port;
+class Session;
+class ProcessThread;
-class AudioEngine : public sigc::trackable
+class AudioEngine : public SessionHandlePtr
{
- public:
- AudioEngine (std::string client_name);
+public:
+ typedef std::set<boost::shared_ptr<Port> > Ports;
+
+ AudioEngine (std::string client_name, std::string session_uuid);
virtual ~AudioEngine ();
-
- jack_client_t* jack() const { return _jack; }
+
+ jack_client_t* jack() const;
bool connected() const { return _jack != 0; }
+ bool is_realtime () const;
+
+ ProcessThread* main_thread() const { return _main_thread; }
+
std::string client_name() const { return jack_client_name; }
int reconnect_to_jack ();
int disconnect_from_jack();
- bool will_reconnect_at_halt ();
- void set_reconnect_at_halt (bool);
-
- int stop ();
+ int stop (bool forever = false);
int start ();
bool running() const { return _running; }
Glib::Mutex& process_lock() { return _process_lock; }
- jack_nframes_t frame_rate();
- jack_nframes_t frames_per_cycle();
+ framecnt_t frame_rate () const;
+ pframes_t frames_per_cycle () const;
+
+ size_t raw_buffer_size(DataType t);
int usecs_per_cycle () const { return _usecs_per_cycle; }
- jack_nframes_t frames_since_cycle_start () {
- if (!_running || !_jack) return 0;
- return jack_frames_since_cycle_start (_jack);
+ bool get_sync_offset (pframes_t & offset) const;
+
+ 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);
}
- jack_nframes_t frame_time () {
- if (!_running || !_jack) return 0;
- return jack_frame_time (_jack);
+
+ pframes_t frame_time () {
+ jack_client_t* _priv_jack = _jack;
+ if (!_running || !_priv_jack) {
+ return 0;
+ }
+ return jack_frame_time (_priv_jack);
+ }
+
+ 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);
}
- jack_nframes_t transport_frame () const {
- if (!_running || !_jack) return 0;
- return jack_get_current_transport_frame (_jack);
+ 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 (jack_nframes_t);
-
- jack_nframes_t set_monitor_check_interval (jack_nframes_t);
-
- float get_cpu_load() {
- if (!_running || !_jack) return 0;
- return jack_cpu_load (_jack);
+
+ 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);
}
void set_session (Session *);
- void remove_session ();
+ void remove_session (); // not a replacement for SessionHandle::session_going_away()
class PortRegistrationFailure : public std::exception {
- public:
- virtual const char *what() const throw() { return "failed port registration"; }
+ public:
+ PortRegistrationFailure (std::string const & why = "")
+ : reason (why) {}
+
+ ~PortRegistrationFailure () throw () {}
+
+ virtual const char *what() const throw () { return reason.c_str(); }
+
+ private:
+ std::string reason;
};
class NoBackendAvailable : public std::exception {
- public:
+ public:
virtual const char *what() const throw() { return "could not connect to engine backend"; }
};
- Port *register_audio_input_port (const std::string& portname);
- Port *register_audio_output_port (const std::string& portname);
- int unregister_port (Port *);
-
+ boost::shared_ptr<Port> register_input_port (DataType, const std::string& portname);
+ boost::shared_ptr<Port> register_output_port (DataType, const std::string& portname);
+ int unregister_port (boost::shared_ptr<Port>);
+
+ bool port_is_physical (const std::string&) const;
+ void ensure_monitor_input (const std::string&, bool) const;
+
+ 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);
-
- uint32_t n_physical_outputs () const;
- uint32_t n_physical_inputs () const;
+ int disconnect (boost::shared_ptr<Port>);
- std::string get_nth_physical_output (uint32_t n) {
- return get_nth_physical (n, JackPortIsInput);
- }
+ const char ** get_ports (const std::string& port_name_pattern, const std::string& type_name_pattern, uint32_t flags);
- std::string get_nth_physical_input (uint32_t n) {
- return get_nth_physical (n, JackPortIsOutput);
- }
+ bool can_request_hardware_monitoring ();
- jack_nframes_t get_port_total_latency (const Port&);
- void update_total_latencies ();
+ ChanCount n_physical_outputs () const;
+ ChanCount n_physical_inputs () const;
- /* the caller may not delete the object pointed to by
- the return value
- */
+ void get_physical_outputs (DataType type, std::vector<std::string>&);
+ void get_physical_inputs (DataType type, std::vector<std::string>&);
- Port *get_port_by_name (const std::string& name, bool keep = true);
+ boost::shared_ptr<Port> get_port_by_name (const std::string &);
enum TransportState {
TransportStopped = JackTransportStopped,
void transport_start ();
void transport_stop ();
- void transport_locate (jack_nframes_t);
+ void transport_locate (framepos_t);
TransportState transport_state ();
int reset_timebase ();
+ void update_latencies ();
+
/* start/stop freewheeling */
int freewheel (bool onoff);
bool freewheeling() const { return _freewheeling; }
/* 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,jack_nframes_t> Freewheel;
+ PBD::Signal1<int, pframes_t> Freewheel;
- sigc::signal<void> Xrun;
+ PBD::Signal0<void> Xrun;
/* this signal is if JACK notifies us of a graph order event */
- sigc::signal<void> GraphReordered;
+ PBD::Signal0<void> GraphReordered;
+
+#ifdef HAVE_JACK_SESSION
+ PBD::Signal1<void,jack_session_event_t *> JackSessionEvent;
+#endif
+
/* this signal is emitted if the sample rate changes */
- sigc::signal<void,jack_nframes_t> SampleRateChanged;
+ PBD::Signal1<void, framecnt_t> SampleRateChanged;
/* this signal is sent if JACK 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;
-
- std::string make_port_name_relative (std::string);
- std::string make_port_name_non_relative (std::string);
-
- private:
- ARDOUR::Session *session;
- jack_client_t *_jack;
- std::string jack_client_name;
- Glib::Mutex port_lock;
- Glib::Mutex _process_lock;
- Glib::Mutex session_remove_lock;
- Glib::Cond session_removed;
- bool session_remove_pending;
- bool _running;
- bool _has_run;
- jack_nframes_t _buffer_size;
- jack_nframes_t _frame_rate;
- jack_nframes_t monitor_check_interval;
- jack_nframes_t last_monitor_check;
- jack_nframes_t _processed_frames;
- bool _freewheeling;
- bool _freewheel_thread_registered;
- sigc::slot<int,jack_nframes_t> freewheel_action;
- bool reconnect_on_halt;
- int _usecs_per_cycle;
-
- typedef std::set<Port*> Ports;
- Ports ports;
-
- int process_callback (jack_nframes_t nframes);
+ PBD::Signal0<void> 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 std::string parameters are the (long) port names.
+ * The bool parameter is true if ports were connected, or false for disconnected.
+ */
+ PBD::Signal5<void, boost::weak_ptr<Port>, std::string, boost::weak_ptr<Port>, std::string, bool> PortConnectedOrDisconnected;
+
+ std::string make_port_name_relative (std::string) const;
+ std::string make_port_name_non_relative (std::string) const;
+ bool port_is_mine (const std::string&) const;
+
+ static AudioEngine* instance() { return _instance; }
+ static void destroy();
+ void died ();
+
+ int create_process_thread (boost::function<void()>, pthread_t*, size_t stacksize);
+
+private:
+ static AudioEngine* _instance;
+
+ 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;
+ int _usecs_per_cycle;
+ bool port_remove_in_progress;
+
+ SerializedRCUManager<Ports> ports;
+
+ boost::shared_ptr<Port> register_port (DataType type, const std::string& portname, bool input);
+
+ int process_callback (pframes_t nframes);
+ void* process_thread ();
void remove_all_ports ();
- typedef std::pair<std::string,std::string> PortConnection;
- typedef std::list<PortConnection> PortConnections;
+ ChanCount n_physical (unsigned long) const;
+ void get_physical (DataType, unsigned long, std::vector<std::string> &);
- PortConnections port_connections;
- void remove_connections_for (Port*);
-
- std::string get_nth_physical (uint32_t which, int flags);
+ void port_registration_failure (const std::string& portname);
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 (jack_nframes_t nframes, void *arg);
- static int _sample_rate_callback (jack_nframes_t nframes, void *arg);
- static int _bufsize_callback (jack_nframes_t nframes, void *arg);
- static void _jack_timebase_callback (jack_transport_state_t, jack_nframes_t, jack_position_t*, int, void*);
+ 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, jack_nframes_t, jack_position_t*, int);
+ 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 (jack_nframes_t);
- int jack_sample_rate_callback (jack_nframes_t);
+ int jack_bufsize_callback (pframes_t);
+ int jack_sample_rate_callback (pframes_t);
- static void halted (void *);
+ void set_jack_callbacks ();
+
+ static void _latency_callback (jack_latency_callback_mode_t, void*);
+ void jack_latency_callback (jack_latency_callback_mode_t);
- int connect_to_jack (std::string client_name);
+ 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 ();
- Glib::Thread* m_meter_thread;
- mutable gint m_meter_exit;
+ 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 */
+} // namespace ARDOUR
#endif /* __ardour_audioengine_h__ */
projects / ardour.git / blobdiff