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 #ifdef WAF_BUILD
  24 #include "libardour-config.h"
  25 #endif
  26
  27 #include <iostream>
  28 #include <list>
  29 #include <set>
  30 #include <cmath>
  31 #include <exception>
  32 #include <string>
  33
  34 #include <glibmm/thread.h>
  35
  36 #include "pbd/rcu.h"
  37 #include "pbd/signals.h"
  38
  39 #include <jack/weakjack.h>
  40 #include <jack/jack.h>
  41 #include <jack/transport.h>
  42 #include <jack/thread.h>
  43
  44 #include "ardour/ardour.h"
  45
  46 #include "ardour/data_type.h"
  47 #include "ardour/session_handle.h"
  48 #include "ardour/types.h"
  49 #include "ardour/chan_count.h"
  50
  51 #ifdef HAVE_JACK_SESSION
  52 #include <jack/session.h>
  53 #endif
  54
  55 namespace ARDOUR {
  56
  57 class InternalPort;
  58 class MidiPort;
  59 class Port;
  60 class Session;
  61 class ProcessThread;
  62
  63 class AudioEngine : public SessionHandlePtr
  64 {
  65 public:
  66         typedef std::set<boost::shared_ptr<Port> > Ports;
  67
  68         AudioEngine (std::string client_name, std::string session_uuid);
  69         virtual ~AudioEngine ();
  70
  71         jack_client_t* jack() const;
  72         bool connected() const { return _jack != 0; }
  73
  74         bool is_realtime () const;
  75
  76         ProcessThread* main_thread() const { return _main_thread; }
  77
  78         std::string client_name() const { return jack_client_name; }
  79
  80         int reconnect_to_jack ();
  81         int disconnect_from_jack();
  82
  83         int stop (bool forever = false);
  84         int start ();
  85         bool running() const { return _running; }
  86
  87         Glib::Mutex& process_lock() { return _process_lock; }
  88
  89         framecnt_t frame_rate () const;
  90         pframes_t frames_per_cycle () const;
  91
  92         size_t raw_buffer_size(DataType t);
  93
  94         int usecs_per_cycle () const { return _usecs_per_cycle; }
  95
  96         bool get_sync_offset (pframes_t & offset) const;
  97
  98         pframes_t frames_since_cycle_start () {
  99                 jack_client_t* _priv_jack = _jack;
 100                 if (!_running || !_priv_jack) {
 101                         return 0;
 102                 }
 103                 return jack_frames_since_cycle_start (_priv_jack);
 104         }
 105
 106         pframes_t frame_time () {
 107                 jack_client_t* _priv_jack = _jack;
 108                 if (!_running || !_priv_jack) {
 109                         return 0;
 110                 }
 111                 return jack_frame_time (_priv_jack);
 112         }
 113
 114         pframes_t frame_time_at_cycle_start () {
 115                 jack_client_t* _priv_jack = _jack;
 116                 if (!_running || !_priv_jack) {
 117                         return 0;
 118                 }
 119                 return jack_last_frame_time (_priv_jack);
 120         }
 121
 122         pframes_t transport_frame () const {
 123                 const jack_client_t* _priv_jack = _jack;
 124                 if (!_running || !_priv_jack) {
 125                         return 0;
 126                 }
 127                 return jack_get_current_transport_frame (_priv_jack);
 128         }
 129
 130         int request_buffer_size (pframes_t);
 131
 132         framecnt_t set_monitor_check_interval (framecnt_t);
 133         framecnt_t processed_frames() const { return _processed_frames; }
 134
 135         float get_cpu_load() {
 136                 jack_client_t* _priv_jack = _jack;
 137                 if (!_running || !_priv_jack) {
 138                         return 0;
 139                 }
 140                 return jack_cpu_load (_priv_jack);
 141         }
 142
 143         void set_session (Session *);
 144         void remove_session (); // not a replacement for SessionHandle::session_going_away()
 145
 146         class PortRegistrationFailure : public std::exception {
 147         public:
 148                 PortRegistrationFailure (std::string const & why = "")
 149                         : reason (why) {}
 150
 151                 ~PortRegistrationFailure () throw () {}
 152
 153                 virtual const char *what() const throw () { return reason.c_str(); }
 154
 155         private:
 156                 std::string reason;
 157         };
 158
 159         class NoBackendAvailable : public std::exception {
 160         public:
 161                 virtual const char *what() const throw() { return "could not connect to engine backend"; }
 162         };
 163
 164         boost::shared_ptr<Port> register_input_port (DataType, const std::string& portname);
 165         boost::shared_ptr<Port> register_output_port (DataType, const std::string& portname);
 166         int unregister_port (boost::shared_ptr<Port>);
 167
 168         bool port_is_physical (const std::string&) const;
 169         void ensure_monitor_input (const std::string&, bool) const;
 170
 171         void split_cycle (pframes_t offset);
 172
 173         int connect (const std::string& source, const std::string& destination);
 174         int disconnect (const std::string& source, const std::string& destination);
 175         int disconnect (boost::shared_ptr<Port>);
 176
 177         const char ** get_ports (const std::string& port_name_pattern, const std::string& type_name_pattern, uint32_t flags);
 178
 179         bool can_request_hardware_monitoring ();
 180
 181         ChanCount n_physical_outputs () const;
 182         ChanCount n_physical_inputs () const;
 183
 184         void get_physical_outputs (DataType type, std::vector<std::string>&);
 185         void get_physical_inputs (DataType type, std::vector<std::string>&);
 186
 187         boost::shared_ptr<Port> get_port_by_name (const std::string &);
 188
 189         enum TransportState {
 190                 TransportStopped = JackTransportStopped,
 191                 TransportRolling = JackTransportRolling,
 192                 TransportLooping = JackTransportLooping,
 193                 TransportStarting = JackTransportStarting
 194         };
 195
 196         void transport_start ();
 197         void transport_stop ();
 198         void transport_locate (framepos_t);
 199         TransportState transport_state ();
 200
 201         int  reset_timebase ();
 202
 203         void update_latencies ();
 204
 205         /* start/stop freewheeling */
 206
 207         int freewheel (bool onoff);
 208         bool freewheeling() const { return _freewheeling; }
 209
 210         /* this signal is sent for every process() cycle while freewheeling.
 211 _          the regular process() call to session->process() is not made.
 212         */
 213
 214         PBD::Signal1<int, pframes_t> Freewheel;
 215
 216         PBD::Signal0<void> Xrun;
 217
 218         /* this signal is if JACK notifies us of a graph order event */
 219
 220         PBD::Signal0<void> GraphReordered;
 221
 222 #ifdef HAVE_JACK_SESSION
 223         PBD::Signal1<void,jack_session_event_t *> JackSessionEvent;
 224 #endif
 225
 226
 227         /* this signal is emitted if the sample rate changes */
 228
 229         PBD::Signal1<void, framecnt_t> SampleRateChanged;
 230
 231         /* this signal is sent if JACK ever disconnects us */
 232
 233         PBD::Signal1<void,const char*> Halted;
 234
 235         /* these two are emitted when the engine itself is
 236            started and stopped
 237         */
 238
 239         PBD::Signal0<void> Running;
 240         PBD::Signal0<void> Stopped;
 241
 242         /** Emitted if a JACK port is registered or unregistered */
 243         PBD::Signal0<void> PortRegisteredOrUnregistered;
 244
 245         /** Emitted if a JACK port is connected or disconnected.
 246          *  The Port parameters are the ports being connected / disconnected, or 0 if they are not known to Ardour.
 247          *  The std::string parameters are the (long) port names.
 248          *  The bool parameter is true if ports were connected, or false for disconnected.
 249          */
 250         PBD::Signal5<void, boost::weak_ptr<Port>, std::string, boost::weak_ptr<Port>, std::string, bool> PortConnectedOrDisconnected;
 251
 252         std::string make_port_name_relative (std::string) const;
 253         std::string make_port_name_non_relative (std::string) const;
 254         bool port_is_mine (const std::string&) const;
 255
 256         static AudioEngine* instance() { return _instance; }
 257         static void destroy();
 258         void died ();
 259
 260         int create_process_thread (boost::function<void()>, pthread_t*, size_t stacksize);
 261
 262 private:
 263         static AudioEngine*       _instance;
 264
 265         jack_client_t* volatile   _jack; /* could be reset to null by SIGPIPE or another thread */
 266         std::string                jack_client_name;
 267         Glib::Mutex               _process_lock;
 268         Glib::Cond                 session_removed;
 269         bool                       session_remove_pending;
 270         bool                      _running;
 271         bool                      _has_run;
 272         mutable framecnt_t        _buffer_size;
 273         std::map<DataType,size_t> _raw_buffer_sizes;
 274         mutable framecnt_t        _frame_rate;
 275         /// number of frames between each check for changes in monitor input
 276         framecnt_t                 monitor_check_interval;
 277         /// time of the last monitor check in frames
 278         framecnt_t                 last_monitor_check;
 279         /// the number of frames processed since start() was called
 280         framecnt_t                _processed_frames;
 281         bool                      _freewheeling;
 282         int                       _usecs_per_cycle;
 283         bool                       port_remove_in_progress;
 284
 285         SerializedRCUManager<Ports> ports;
 286
 287         boost::shared_ptr<Port> register_port (DataType type, const std::string& portname, bool input);
 288
 289         int    process_callback (pframes_t nframes);
 290         void*  process_thread ();
 291         void   remove_all_ports ();
 292
 293         ChanCount n_physical (unsigned long) const;
 294         void get_physical (DataType, unsigned long, std::vector<std::string> &);
 295
 296         void port_registration_failure (const std::string& portname);
 297
 298         static int  _xrun_callback (void *arg);
 299 #ifdef HAVE_JACK_SESSION
 300         static void _session_callback (jack_session_event_t *event, void *arg);
 301 #endif
 302         static int  _graph_order_callback (void *arg);
 303         static int  _process_callback (pframes_t nframes, void *arg);
 304         static void* _process_thread (void *arg);
 305         static int  _sample_rate_callback (pframes_t nframes, void *arg);
 306         static int  _bufsize_callback (pframes_t nframes, void *arg);
 307         static void _jack_timebase_callback (jack_transport_state_t, pframes_t, jack_position_t*, int, void*);
 308         static int  _jack_sync_callback (jack_transport_state_t, jack_position_t*, void *arg);
 309         static void _freewheel_callback (int , void *arg);
 310         static void _registration_callback (jack_port_id_t, int, void *);
 311         static void _connect_callback (jack_port_id_t, jack_port_id_t, int, void *);
 312
 313         void jack_timebase_callback (jack_transport_state_t, pframes_t, jack_position_t*, int);
 314         int  jack_sync_callback (jack_transport_state_t, jack_position_t*);
 315         int  jack_bufsize_callback (pframes_t);
 316         int  jack_sample_rate_callback (pframes_t);
 317
 318         void set_jack_callbacks ();
 319
 320         static void _latency_callback (jack_latency_callback_mode_t, void*);
 321         void jack_latency_callback (jack_latency_callback_mode_t);
 322
 323         int connect_to_jack (std::string client_name, std::string session_uuid);
 324
 325         static void halted (void *);
 326         static void halted_info (jack_status_t,const char*,void *);
 327
 328         void meter_thread ();
 329         void start_metering_thread ();
 330         void stop_metering_thread ();
 331
 332         Glib::Thread*    m_meter_thread;
 333         static gint      m_meter_exit;
 334
 335         ProcessThread* _main_thread;
 336
 337         struct ThreadData {
 338                 AudioEngine* engine;
 339                 boost::function<void()> f;
 340                 size_t stacksize;
 341
 342                 ThreadData (AudioEngine* ae, boost::function<void()> fp, size_t stacksz)
 343                 : engine (ae) , f (fp) , stacksize (stacksz) {}
 344         };
 345
 346         static void* _start_process_thread (void*);
 347 };
 348
 349 } // namespace ARDOUR
 350
 351 #endif /* __ardour_audioengine_h__ */