Merge branch 'master' into cairocanvas
[ardour.git] / libs / ardour / ardour / audioengine.h
index 10400c41d759c5acef966c2647d72a4fc31fe616..75954e6ca9eb58337f3018611ff49e4facd8ed5e 100644 (file)
 
 #include <glibmm/threads.h>
 
-#include "pbd/rcu.h"
 #include "pbd/signals.h"
 #include "pbd/stacktrace.h"
 
-#ifndef WIN32
-#include <jack/weakjack.h>
-#endif
-
-#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/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;
@@ -63,300 +57,194 @@ class MidiPort;
 class Port;
 class Session;
 class ProcessThread;
+class AudioBackend;
+class AudioBackendInfo;
 
-class AudioEngine : public SessionHandlePtr
+class LIBARDOUR_API AudioEngine : public SessionHandlePtr, public PortManager
 {
 public:
-       typedef std::map<std::string,boost::shared_ptr<Port> > Ports;
-
-       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; }
-
-       std::string client_name() const { return jack_client_name; }
-
-       int reconnect_to_jack ();
-       int disconnect_from_jack();
-
-       int stop (bool forever = false);
-       int start ();
-       bool running() const { return _running; }
-
-       Glib::Threads::Mutex& process_lock() { return _process_lock; }
-
-       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; }
-
-       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);
-       }
-
-       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);
-       }
-
-       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);
-
-       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 (); // 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;
-       };
-
-       class NoBackendAvailable : public std::exception {
-       public:
-               virtual const char *what() const throw() { return "could not connect to engine backend"; }
-       };
-
-       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 request_jack_monitors_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 (boost::shared_ptr<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>&);
 
-       boost::shared_ptr<Port> get_port_by_name (const std::string &);
-       void port_renamed (const std::string&, 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 ();
-
-        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.
-       */
-
-       PBD::Signal1<int, pframes_t> Freewheel;
-
-       PBD::Signal0<void> Xrun;
-
-       /* this signal is if JACK notifies us of a graph order event */
-
-       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 */
-
-       PBD::Signal1<void, framecnt_t> SampleRateChanged;
-
-       /* this signal is sent if JACK ever disconnects us */
-
-       PBD::Signal1<void,const char*> Halted;
-
-       /* these two are emitted when the engine itself is
-          started and stopped
-       */
-
-       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()>, jack_native_thread_t*, size_t stacksize);
-       bool stop_process_thread (jack_native_thread_t);
-
-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::Threads::Mutex      _process_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                      _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                      _pre_freewheel_mmc_enabled;
-       int                       _usecs_per_cycle;
-       bool                       port_remove_in_progress;
-        Glib::Threads::Thread*     m_meter_thread;
-       ProcessThread*            _main_thread;
-
-       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 ();
-
-       ChanCount n_physical (unsigned long) const;
-       void get_physical (DataType, unsigned long, std::vector<std::string> &);
-
-       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 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);
-       void freewheel_callback (int);
-        void connect_callback (jack_port_id_t, jack_port_id_t, int);
-
-       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, 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 ();
-
-       static gint      m_meter_exit;
-
-       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*);
-        void parameter_changed (const std::string&);
-        PBD::ScopedConnection config_connection;
+    static AudioEngine* create ();
+
+    virtual ~AudioEngine ();
+
+    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);
+    pframes_t      sample_time ();
+    pframes_t      sample_time_at_cycle_start ();
+    pframes_t      samples_since_cycle_start ();
+    bool           get_sync_offset (pframes_t& offset) const;
+
+    int            create_process_thread (boost::function<void()> func);
+    int            join_process_threads ();
+    bool           in_process_thread ();
+    uint32_t       process_thread_count ();
+
+    bool           is_realtime() const;
+    bool           connected() const;
+
+    int set_device_name (const std::string&);
+    int set_sample_rate (float);
+    int set_buffer_size (uint32_t);
+    int set_sample_format (SampleFormat);
+    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 */
+
+    bool freewheeling() const { return _freewheeling; }
+    bool running() const { return _running; }
+
+    Glib::Threads::Mutex& process_lock() { return _process_lock; }
+
+    int request_buffer_size (pframes_t samples) {
+           return set_buffer_size (samples);
+    }
+
+    framecnt_t processed_frames() const { return _processed_frames; }
+    
+    void set_session (Session *);
+    void remove_session (); // not a replacement for SessionHandle::session_going_away()
+    Session* session() const { return _session; }
+
+    class NoBackendAvailable : public std::exception {
+      public:
+       virtual const char *what() const throw() { return "could not connect to engine backend"; }
+    };
+    
+    void split_cycle (pframes_t offset);
+    
+    int  reset_timebase ();
+    
+    void update_latencies ();
+    
+    /* this signal is sent for every process() cycle while freewheeling.
+       (the regular process() call to session->process() is not made)
+    */
+    
+    PBD::Signal1<int, pframes_t> Freewheel;
+    
+    PBD::Signal0<void> Xrun;
+
+    /* this signal is emitted if the sample rate changes */
+    
+    PBD::Signal1<void, framecnt_t> SampleRateChanged;
+    
+    /* this signal is sent if the backend ever disconnects us */
+    
+    PBD::Signal1<void,const char*> Halted;
+    
+    /* these two are emitted when the engine itself is
+       started and stopped
+    */
+    
+    PBD::Signal0<void> Running;
+    PBD::Signal0<void> Stopped;
+
+    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);
+
+    /* sets up the process callback thread */
+    static void thread_init_callback (void *);
+
+    /* latency measurement */
+
+    MTDM* mtdm();
+    int  prepare_for_latency_measurement ();
+    int  start_latency_detection ();
+    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; }
+
+  private:
+    AudioEngine ();
+
+    static AudioEngine*       _instance;
+
+    Glib::Threads::Mutex      _process_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
+    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;
+    Glib::Threads::Thread*     m_meter_thread;
+    ProcessThread*            _main_thread;
+    MTDM*                     _mtdm;
+    bool                      _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;
+
+    void meter_thread ();
+    void start_metering_thread ();
+    void stop_metering_thread ();
+    
+    static gint      m_meter_exit;
+    
+    typedef std::map<std::string,AudioBackendInfo*> BackendMap;
+    BackendMap _backends;
+    AudioBackendInfo* backend_discover (const std::string&);
+    void drop_backend ();
 };
-
+       
 } // namespace ARDOUR
 
 #endif /* __ardour_audioengine_h__ */