split up session code that uses parts of the JACK API (timebase + session event handl...
[ardour.git] / libs / ardour / ardour / audioengine.h
index e53eb8a85e3b7e7770f6ca3abcdbf640fe47e519..f05944797d35fefafaf85c823593a83fd05cf249 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    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/threads.h>
+
+#include "pbd/signals.h"
+#include "pbd/stacktrace.h"
 
-#include <glibmm/thread.h>
+#include "midi++/mmc.h"
 
-#include <pbd/rcu.h>
+#include "ardour/ardour.h"
+#include "ardour/data_type.h"
+#include "ardour/session_handle.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>
+#ifdef HAVE_JACK_SESSION
+#include <jack/session.h>
+#endif
 
 namespace ARDOUR {
 
-class Session;
+class InternalPort;
+class MidiPort;
 class Port;
+class Session;
+class ProcessThread;
+class AudioBackend;
+class AudioBackendInfo;
 
-class AudioEngine : public sigc::trackable
+class AudioEngine : public SessionHandlePtr, public PortManager
 {
-   public:
-       AudioEngine (std::string client_name);
-       virtual ~AudioEngine ();
-       
-       jack_client_t* jack() const { return _jack; }
-       bool connected() const { return _jack != 0; }
-
-       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 start ();
-       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; }
-
-       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);
-       }
-
-       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);
-       }
-
-       void set_session (Session *);
-       void remove_session ();
-
-       class PortRegistrationFailure : public std::exception {
-         public:
-               virtual const char *what() const throw() { return "failed port registration"; }
-       };
-
-       class NoBackendAvailable : public std::exception {
-         public:
-               virtual const char *what() const throw() { return "could not connect to engine backend"; }
-       };
-
-       Port *register_input_port (DataType type, const std::string& portname);
-       Port *register_output_port (DataType type, 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 (uint32_t n) {
-               return get_nth_physical (n, JackPortIsInput);
-       }
-
-       std::string get_nth_physical_input (uint32_t n) {
-               return get_nth_physical (n, JackPortIsOutput);
-       }
-
-       nframes_t get_port_total_latency (const Port&);
-       void update_total_latencies ();
-
-       /* the caller may not delete the object pointed to by 
-          the return value
-       */
-
-       Port *get_port_by_name (const std::string& name, bool keep = true);
-
-       enum TransportState {
-               TransportStopped = JackTransportStopped,
-               TransportRolling = JackTransportRolling,
-               TransportLooping = JackTransportLooping,
-               TransportStarting = JackTransportStarting
-       };
-
-       void transport_start ();
-       void transport_stop ();
-       void transport_locate (nframes_t);
-       TransportState transport_state ();
-
-       int  reset_timebase ();
-
-       /* 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.
-       */
-
-       sigc::signal<int,nframes_t> Freewheel;
-
-       sigc::signal<void> Xrun;
-
-       /* this signal is if JACK notifies us of a graph order event */
-
-       sigc::signal<void> GraphReordered;
-
-       /* this signal is emitted if the sample rate changes */
-
-       sigc::signal<void,nframes_t> SampleRateChanged;
-
-       /* this signal is sent if JACK ever disconnects us */
-
-       sigc::signal<void> 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);
+public:
+
+    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_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 ();
+    int            stop ();
+    int            pause ();
+    int            freewheel (bool start_stop);
+    float          get_cpu_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, pthread_t*, size_t stacksize);
+    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 *);
+
+    MIDI::MachineControl& mmc() { return _mmc; }
 
   private:
-       ARDOUR::Session      *session;
-       jack_client_t       *_jack;
-       std::string           jack_client_name;
-       Glib::Mutex           _process_lock;
-       Glib::Mutex           session_remove_lock;
-    Glib::Cond            session_removed;
-       bool                  session_remove_pending;
-       bool                 _running;
-       bool                 _has_run;
-       nframes_t       _buffer_size;
-       nframes_t       _frame_rate;
-       nframes_t        monitor_check_interval;
-       nframes_t        last_monitor_check;
-       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;
-
-       typedef std::set<Port*> Ports;
-       SerializedRCUManager<Ports> ports;
-
-       int    process_callback (nframes_t nframes);
-       void   remove_all_ports ();
-
-       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 (uint32_t which, 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 ();
-    Glib::Thread*    m_meter_thread;
-    mutable gint     m_meter_exit;
+    AudioEngine ();
+
+    static AudioEngine*       _instance;
+
+    boost::shared_ptr<AudioBackend> _backend;
+
+    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;
+    bool                      _pre_freewheel_mmc_enabled;
+    Glib::Threads::Thread*     m_meter_thread;
+    ProcessThread*            _main_thread;
+    MIDI::MachineControl      _mmc;
+    
+    void meter_thread ();
+    void start_metering_thread ();
+    void stop_metering_thread ();
+    
+    static gint      m_meter_exit;
+    
+    void parameter_changed (const std::string&);
+    PBD::ScopedConnection config_connection;
+
+    typedef std::map<std::string,AudioBackendInfo*> BackendMap;
+    BackendMap _backends;
+    AudioBackendInfo* backend_discover (const std::string&);
+    void drop_backend ();
 };
-
+       
 } // namespace ARDOUR
 
 #endif /* __ardour_audioengine_h__ */