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     $Id$
  19 */
  20
  21 #ifndef __ardour_audioengine_h__
  22 #define __ardour_audioengine_h__
  23
  24 #include <list>
  25 #include <set>
  26 #include <cmath>
  27 #include <exception>
  28 #include <string>
  29
  30 #include <sigc++/signal.h>
  31
  32 #include <glibmm/thread.h>
  33
  34 #include <ardour/ardour.h>
  35 #include <jack/jack.h>
  36 #include <jack/transport.h>
  37 #include <ardour/types.h>
  38
  39 namespace ARDOUR {
  40
  41 class Session;
  42 class Port;
  43
  44 class AudioEngine : public sigc::trackable
  45 {
  46    public:
  47         AudioEngine (std::string client_name);
  48         virtual ~AudioEngine ();
  49
  50         jack_client_t* jack() const { return _jack; }
  51         bool connected() const { return _jack != 0; }
  52
  53         std::string client_name() const { return jack_client_name; }
  54
  55         int reconnect_to_jack ();
  56         int disconnect_from_jack();
  57
  58         bool will_reconnect_at_halt ();
  59         void set_reconnect_at_halt (bool);
  60
  61         int stop ();
  62         int start ();
  63         bool running() const { return _running; }
  64
  65         Glib::Mutex& process_lock() { return _process_lock; }
  66
  67         jack_nframes_t frame_rate();
  68         jack_nframes_t frames_per_cycle();
  69
  70         int usecs_per_cycle () const { return _usecs_per_cycle; }
  71
  72         jack_nframes_t frames_since_cycle_start () {
  73                 if (!_running || !_jack) return 0;
  74                 return jack_frames_since_cycle_start (_jack);
  75         }
  76         jack_nframes_t frame_time () {
  77                 if (!_running || !_jack) return 0;
  78                 return jack_frame_time (_jack);
  79         }
  80
  81         jack_nframes_t transport_frame () const {
  82                 if (!_running || !_jack) return 0;
  83                 return jack_get_current_transport_frame (_jack);
  84         }
  85
  86         int request_buffer_size (jack_nframes_t);
  87
  88         jack_nframes_t set_monitor_check_interval (jack_nframes_t);
  89
  90         float get_cpu_load() {
  91                 if (!_running || !_jack) return 0;
  92                 return jack_cpu_load (_jack);
  93         }
  94
  95         void set_session (Session *);
  96         void remove_session ();
  97
  98         class PortRegistrationFailure : public std::exception {
  99           public:
 100                 virtual const char *what() const throw() { return "failed port registration"; }
 101         };
 102
 103         class NoBackendAvailable : public std::exception {
 104           public:
 105                 virtual const char *what() const throw() { return "could not connect to engine backend"; }
 106         };
 107
 108         Port *register_input_port (DataType type, const std::string& portname);
 109         Port *register_output_port (DataType type, const std::string& portname);
 110         int   unregister_port (Port *);
 111
 112         int connect (const std::string& source, const std::string& destination);
 113         int disconnect (const std::string& source, const std::string& destination);
 114         int disconnect (Port *);
 115
 116         const char ** get_ports (const std::string& port_name_pattern, const std::string& type_name_pattern, uint32_t flags);
 117
 118         uint32_t n_physical_outputs () const;
 119         uint32_t n_physical_inputs () const;
 120
 121         std::string get_nth_physical_output (uint32_t n) {
 122                 return get_nth_physical (n, JackPortIsInput);
 123         }
 124
 125         std::string get_nth_physical_input (uint32_t n) {
 126                 return get_nth_physical (n, JackPortIsOutput);
 127         }
 128
 129         jack_nframes_t get_port_total_latency (const Port&);
 130         void update_total_latencies ();
 131
 132         /* the caller may not delete the object pointed to by
 133            the return value
 134         */
 135
 136         Port *get_port_by_name (const std::string& name, bool keep = true);
 137
 138         enum TransportState {
 139                 TransportStopped = JackTransportStopped,
 140                 TransportRolling = JackTransportRolling,
 141                 TransportLooping = JackTransportLooping,
 142                 TransportStarting = JackTransportStarting
 143         };
 144
 145         void transport_start ();
 146         void transport_stop ();
 147         void transport_locate (jack_nframes_t);
 148         TransportState transport_state ();
 149
 150         int  reset_timebase ();
 151
 152         /* start/stop freewheeling */
 153
 154         int freewheel (bool onoff);
 155         bool freewheeling() const { return _freewheeling; }
 156
 157         /* this signal is sent for every process() cycle while freewheeling.
 158            the regular process() call to session->process() is not made.
 159         */
 160
 161         sigc::signal<int,jack_nframes_t> Freewheel;
 162
 163         sigc::signal<void> Xrun;
 164
 165         /* this signal is if JACK notifies us of a graph order event */
 166
 167         sigc::signal<void> GraphReordered;
 168
 169         /* this signal is emitted if the sample rate changes */
 170
 171         sigc::signal<void,jack_nframes_t> SampleRateChanged;
 172
 173         /* this signal is sent if JACK ever disconnects us */
 174
 175         sigc::signal<void> Halted;
 176
 177         /* these two are emitted when the engine itself is
 178            started and stopped
 179         */
 180
 181         sigc::signal<void> Running;
 182         sigc::signal<void> Stopped;
 183
 184         std::string make_port_name_relative (std::string);
 185         std::string make_port_name_non_relative (std::string);
 186
 187   private:
 188         ARDOUR::Session      *session;
 189         jack_client_t       *_jack;
 190         std::string           jack_client_name;
 191         Glib::Mutex           port_lock;
 192         Glib::Mutex           _process_lock;
 193         Glib::Mutex           session_remove_lock;
 194     Glib::Cond            session_removed;
 195         bool                  session_remove_pending;
 196         bool                 _running;
 197         bool                 _has_run;
 198         jack_nframes_t       _buffer_size;
 199         jack_nframes_t       _frame_rate;
 200         jack_nframes_t        monitor_check_interval;
 201         jack_nframes_t        last_monitor_check;
 202         jack_nframes_t       _processed_frames;
 203         bool                 _freewheeling;
 204         bool                 _freewheel_thread_registered;
 205         sigc::slot<int,jack_nframes_t>  freewheel_action;
 206         bool                  reconnect_on_halt;
 207         int                  _usecs_per_cycle;
 208
 209         typedef std::set<Port*> Ports;
 210         Ports ports;
 211
 212         int    process_callback (jack_nframes_t nframes);
 213         void   remove_all_ports ();
 214
 215         typedef std::pair<std::string,std::string> PortConnection;
 216         typedef std::list<PortConnection> PortConnections;
 217
 218         PortConnections port_connections;
 219         void   remove_connections_for (Port*);
 220
 221         std::string get_nth_physical (uint32_t which, int flags);
 222
 223         static int  _xrun_callback (void *arg);
 224         static int  _graph_order_callback (void *arg);
 225         static int  _process_callback (jack_nframes_t nframes, void *arg);
 226         static int  _sample_rate_callback (jack_nframes_t nframes, void *arg);
 227         static int  _bufsize_callback (jack_nframes_t nframes, void *arg);
 228         static void _jack_timebase_callback (jack_transport_state_t, jack_nframes_t, jack_position_t*, int, void*);
 229         static int  _jack_sync_callback (jack_transport_state_t, jack_position_t*, void *arg);
 230         static void _freewheel_callback (int , void *arg);
 231
 232         void jack_timebase_callback (jack_transport_state_t, jack_nframes_t, jack_position_t*, int);
 233         int  jack_sync_callback (jack_transport_state_t, jack_position_t*);
 234         int  jack_bufsize_callback (jack_nframes_t);
 235         int  jack_sample_rate_callback (jack_nframes_t);
 236
 237         static void halted (void *);
 238
 239         int connect_to_jack (std::string client_name);
 240
 241         void meter_thread ();
 242         void start_metering_thread ();
 243     Glib::Thread*    m_meter_thread;
 244     mutable gint     m_meter_exit;
 245 };
 246
 247 } // namespace ARDOUR
 248
 249 #endif /* __ardour_audioengine_h__ */