libs/ardour/ardour/audioengine.h

   1 /*
   2     Copyright (C) 2002-2004 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef __ardour_audioengine_h__
  21 #define __ardour_audioengine_h__
  22
  23 #include <list>
  24 #include <set>
  25 #include <cmath>
  26 #include <exception>
  27 #include <string>
  28
  29 #include <sigc++/signal.h>
  30
  31 #include <glibmm/thread.h>
  32
  33 #include <pbd/rcu.h>
  34
  35 #include <ardour/ardour.h>
  36 #include <jack/jack.h>
  37 #include <jack/transport.h>
  38 #include <ardour/types.h>
  39 #include <ardour/data_type.h>
  40
  41 namespace ARDOUR {
  42
  43 class Session;
  44 class Port;
  45
  46 class AudioEngine : public sigc::trackable
  47 {
  48    public:
  49         typedef std::set<Port*> Ports;
  50
  51         AudioEngine (std::string client_name);
  52         virtual ~AudioEngine ();
  53
  54         jack_client_t* jack() const { return _jack; }
  55         bool connected() const { return _jack != 0; }
  56
  57         bool is_realtime () const;
  58
  59         std::string client_name() const { return jack_client_name; }
  60
  61         int reconnect_to_jack ();
  62         int disconnect_from_jack();
  63
  64         bool will_reconnect_at_halt ();
  65         void set_reconnect_at_halt (bool);
  66
  67         int stop (bool forever = false);
  68         int start ();
  69         bool running() const { return _running; }
  70
  71         int run_process_cycle (ARDOUR::Session*, jack_nframes_t nframes);
  72
  73         Glib::Mutex& process_lock() { return _process_lock; }
  74
  75         nframes_t frame_rate();
  76         nframes_t frames_per_cycle();
  77
  78         int usecs_per_cycle () const { return _usecs_per_cycle; }
  79
  80         bool get_sync_offset (nframes_t& offset) const;
  81
  82         nframes_t frames_since_cycle_start () {
  83                 if (!_running || !_jack) return 0;
  84                 return jack_frames_since_cycle_start (_jack);
  85         }
  86         nframes_t frame_time () {
  87                 if (!_running || !_jack) return 0;
  88                 return jack_frame_time (_jack);
  89         }
  90
  91         nframes_t transport_frame () const {
  92                 if (!_running || !_jack) return 0;
  93                 return jack_get_current_transport_frame (_jack);
  94         }
  95
  96         int request_buffer_size (nframes_t);
  97
  98         nframes_t set_monitor_check_interval (nframes_t);
  99
 100         float get_cpu_load() {
 101                 if (!_running || !_jack) return 0;
 102                 return jack_cpu_load (_jack);
 103         }
 104
 105         void set_session (Session *);
 106         void remove_session ();
 107
 108         class PortRegistrationFailure : public std::exception {
 109           public:
 110                 virtual const char *what() const throw() { return "failed port registration"; }
 111         };
 112
 113         class NoBackendAvailable : public std::exception {
 114           public:
 115                 virtual const char *what() const throw() { return "could not connect to engine backend"; }
 116         };
 117
 118         Port *register_input_port (DataType type, const std::string& portname);
 119         Port *register_output_port (DataType type, const std::string& portname);
 120         int   unregister_port (Port &);
 121
 122         int connect (const std::string& source, const std::string& destination);
 123         int disconnect (const std::string& source, const std::string& destination);
 124         int disconnect (Port &);
 125
 126         const char ** get_ports (const std::string& port_name_pattern, const std::string& type_name_pattern, uint32_t flags);
 127
 128         uint32_t n_physical_outputs () const;
 129         uint32_t n_physical_inputs () const;
 130
 131         void get_physical_outputs (std::vector<std::string>&);
 132         void get_physical_inputs (std::vector<std::string>&);
 133
 134         std::string get_nth_physical_output (DataType type, uint32_t n) {
 135                 return get_nth_physical (type, n, JackPortIsInput);
 136         }
 137
 138         std::string get_nth_physical_input (DataType type, uint32_t n) {
 139                 return get_nth_physical (type, n, JackPortIsOutput);
 140         }
 141
 142         nframes_t get_port_total_latency (const Port&);
 143         void update_total_latencies ();
 144
 145         /** Caller may not delete the object pointed to by the return value
 146         */
 147         Port *get_port_by_name (const std::string& name, bool keep = true);
 148
 149         enum TransportState {
 150                 TransportStopped = JackTransportStopped,
 151                 TransportRolling = JackTransportRolling,
 152                 TransportLooping = JackTransportLooping,
 153                 TransportStarting = JackTransportStarting
 154         };
 155
 156         void transport_start ();
 157         void transport_stop ();
 158         void transport_locate (nframes_t);
 159         TransportState transport_state ();
 160
 161         int  reset_timebase ();
 162
 163         /* start/stop freewheeling */
 164
 165         int freewheel (bool onoff);
 166         bool freewheeling() const { return _freewheeling; }
 167
 168         /* this signal is sent for every process() cycle while freewheeling.
 169            the regular process() call to session->process() is not made.
 170         */
 171
 172         sigc::signal<int,nframes_t> Freewheel;
 173
 174         sigc::signal<void> Xrun;
 175
 176         /* this signal is if JACK notifies us of a graph order event */
 177
 178         sigc::signal<void> GraphReordered;
 179
 180         /* this signal is emitted if the sample rate changes */
 181
 182         sigc::signal<void,nframes_t> SampleRateChanged;
 183
 184         /* this signal is sent if JACK ever disconnects us */
 185
 186         sigc::signal<void> Halted;
 187
 188         /* these two are emitted when the engine itself is
 189            started and stopped
 190         */
 191
 192         sigc::signal<void> Running;
 193         sigc::signal<void> Stopped;
 194
 195         std::string make_port_name_relative (std::string);
 196         std::string make_port_name_non_relative (std::string);
 197
 198   private:
 199         ARDOUR::Session      *session;
 200         jack_client_t       *_jack;
 201         std::string           jack_client_name;
 202         Glib::Mutex           _process_lock;
 203         Glib::Cond            session_removed;
 204         bool                  session_remove_pending;
 205         bool                 _running;
 206         bool                 _has_run;
 207         nframes_t       _buffer_size;
 208         nframes_t       _frame_rate;
 209         nframes_t        monitor_check_interval;
 210         nframes_t        last_monitor_check;
 211         nframes_t       _processed_frames;
 212         bool                 _freewheeling;
 213         bool                 _freewheel_thread_registered;
 214         sigc::slot<int,nframes_t>  freewheel_action;
 215         bool                  reconnect_on_halt;
 216         int                  _usecs_per_cycle;
 217
 218         SerializedRCUManager<Ports> ports;
 219
 220         int    process_callback (nframes_t nframes);
 221         void   remove_all_ports ();
 222
 223         typedef std::pair<std::string,std::string> PortConnection;
 224         typedef std::list<PortConnection> PortConnections;
 225
 226         PortConnections port_connections;
 227         void   remove_connections_for (Port&);
 228
 229         std::string get_nth_physical (DataType type, uint32_t n, int flags);
 230
 231         static int  _xrun_callback (void *arg);
 232         static int  _graph_order_callback (void *arg);
 233         static int  _process_callback (nframes_t nframes, void *arg);
 234         static int  _sample_rate_callback (nframes_t nframes, void *arg);
 235         static int  _bufsize_callback (nframes_t nframes, void *arg);
 236         static void _jack_timebase_callback (jack_transport_state_t, nframes_t, jack_position_t*, int, void*);
 237         static int  _jack_sync_callback (jack_transport_state_t, jack_position_t*, void *arg);
 238         static void _freewheel_callback (int , void *arg);
 239
 240         void jack_timebase_callback (jack_transport_state_t, nframes_t, jack_position_t*, int);
 241         int  jack_sync_callback (jack_transport_state_t, jack_position_t*);
 242         int  jack_bufsize_callback (nframes_t);
 243         int  jack_sample_rate_callback (nframes_t);
 244
 245         static void halted (void *);
 246
 247         int connect_to_jack (std::string client_name);
 248
 249         void meter_thread ();
 250         void start_metering_thread ();
 251         void stop_metering_thread ();
 252
 253         Glib::Thread*    m_meter_thread;
 254         static gint      m_meter_exit;
 255 };
 256
 257 } // namespace ARDOUR
 258
 259 #endif /* __ardour_audioengine_h__ */