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/threads.h>
  35
  36 #include "pbd/signals.h"
  37 #include "pbd/stacktrace.h"
  38
  39 #include "ardour/ardour.h"
  40 #include "ardour/data_type.h"
  41 #include "ardour/session_handle.h"
  42 #include "ardour/libardour_visibility.h"
  43 #include "ardour/types.h"
  44 #include "ardour/chan_count.h"
  45 #include "ardour/port_manager.h"
  46
  47 class MTDM;
  48
  49 namespace ARDOUR {
  50
  51 class InternalPort;
  52 class MidiPort;
  53 class MIDIDM;
  54 class Port;
  55 class Session;
  56 class ProcessThread;
  57 class AudioBackend;
  58 struct AudioBackendInfo;
  59
  60 class LIBARDOUR_API AudioEngine : public SessionHandlePtr, public PortManager
  61 {
  62   public:
  63
  64         static AudioEngine* create ();
  65
  66         virtual ~AudioEngine ();
  67
  68         int discover_backends();
  69         std::vector<const AudioBackendInfo*> available_backends() const;
  70         std::string current_backend_name () const;
  71         boost::shared_ptr<AudioBackend> set_default_backend ();
  72         boost::shared_ptr<AudioBackend> set_backend (const std::string&, const std::string& arg1, const std::string& arg2);
  73         boost::shared_ptr<AudioBackend> current_backend() const { return _backend; }
  74         bool setup_required () const;
  75
  76         ProcessThread* main_thread() const { return _main_thread; }
  77
  78         /* START BACKEND PROXY API
  79          *
  80          * See audio_backend.h for full documentation and semantics. These wrappers
  81          * just forward to a backend implementation.
  82          */
  83
  84         int            start (bool for_latency_measurement=false);
  85         int            stop (bool for_latency_measurement=false);
  86         int            freewheel (bool start_stop);
  87         float          get_dsp_load() const ;
  88         void           transport_start ();
  89         void           transport_stop ();
  90         TransportState transport_state ();
  91         void           transport_locate (framepos_t pos);
  92         framepos_t     transport_frame();
  93         framecnt_t     sample_rate () const;
  94         pframes_t      samples_per_cycle () const;
  95         int            usecs_per_cycle () const;
  96         size_t         raw_buffer_size (DataType t);
  97         framepos_t     sample_time ();
  98         framepos_t     sample_time_at_cycle_start ();
  99         pframes_t      samples_since_cycle_start ();
 100         bool           get_sync_offset (pframes_t& offset) const;
 101
 102         int            create_process_thread (boost::function<void()> func);
 103         int            join_process_threads ();
 104         bool           in_process_thread ();
 105         uint32_t       process_thread_count ();
 106
 107         int            backend_reset_requested();
 108         void           request_backend_reset();
 109         void           request_device_list_update();
 110         void           launch_device_control_app();
 111
 112         bool           is_realtime() const;
 113         bool           connected() const;
 114
 115         // for the user which hold state_lock to check if reset operation is pending
 116         bool           is_reset_requested() const { return g_atomic_int_get(const_cast<gint*>(&_hw_reset_request_count)); }
 117
 118         int set_device_name (const std::string&);
 119         int set_sample_rate (float);
 120         int set_buffer_size (uint32_t);
 121         int set_interleaved (bool yn);
 122         int set_input_channels (uint32_t);
 123         int set_output_channels (uint32_t);
 124         int set_systemic_input_latency (uint32_t);
 125         int set_systemic_output_latency (uint32_t);
 126
 127         /* END BACKEND PROXY API */
 128
 129         bool freewheeling() const { return _freewheeling; }
 130         bool running() const { return _running; }
 131
 132         Glib::Threads::Mutex& process_lock() { return _process_lock; }
 133         Glib::Threads::RecMutex& state_lock() { return _state_lock; }
 134
 135         int request_buffer_size (pframes_t samples) {
 136                 return set_buffer_size (samples);
 137         }
 138
 139         framecnt_t processed_frames() const { return _processed_frames; }
 140
 141         void set_session (Session *);
 142         void remove_session (); // not a replacement for SessionHandle::session_going_away()
 143         Session* session() const { return _session; }
 144
 145         void reconnect_session_routes (bool reconnect_inputs = true, bool reconnect_outputs = true);
 146
 147         class NoBackendAvailable : public std::exception {
 148             public:
 149                 virtual const char *what() const throw() { return "could not connect to engine backend"; }
 150         };
 151
 152         void split_cycle (pframes_t offset);
 153
 154         int  reset_timebase ();
 155
 156         void update_latencies ();
 157
 158         /* this signal is sent for every process() cycle while freewheeling.
 159            (the regular process() call to session->process() is not made)
 160         */
 161
 162         PBD::Signal1<int, pframes_t> Freewheel;
 163
 164         PBD::Signal0<void> Xrun;
 165
 166         /** this signal is emitted if the sample rate changes */
 167         PBD::Signal1<void, framecnt_t> SampleRateChanged;
 168
 169         /** this signal is emitted if the buffer size changes */
 170         PBD::Signal1<void, pframes_t> BufferSizeChanged;
 171
 172         /** this signal is emitted if the device cannot operate properly */
 173         PBD::Signal0<void> DeviceError;
 174
 175         /* this signal is emitted if the device list changed */
 176
 177         PBD::Signal0<void> DeviceListChanged;
 178
 179         /* this signal is sent if the backend ever disconnects us */
 180
 181         PBD::Signal1<void,const char*> Halted;
 182
 183         /* these two are emitted when the engine itself is
 184            started and stopped
 185         */
 186
 187         PBD::Signal0<void> Running;
 188         PBD::Signal0<void> Stopped;
 189
 190         /* these two are emitted when a device reset is initiated/finished
 191          */
 192
 193         PBD::Signal0<void> DeviceResetStarted;
 194         PBD::Signal0<void> DeviceResetFinished;
 195
 196         static AudioEngine* instance() { return _instance; }
 197         static void destroy();
 198         void died ();
 199
 200         /* The backend will cause these at the appropriate time(s)
 201          */
 202         int  process_callback (pframes_t nframes);
 203         int  buffer_size_change (pframes_t nframes);
 204         int  sample_rate_change (pframes_t nframes);
 205         void freewheel_callback (bool);
 206         void timebase_callback (TransportState state, pframes_t nframes, framepos_t pos, int new_position);
 207         int  sync_callback (TransportState state, framepos_t position);
 208         int  port_registration_callback ();
 209         void latency_callback (bool for_playback);
 210         void halted_callback (const char* reason);
 211
 212         /* sets up the process callback thread */
 213         static void thread_init_callback (void *);
 214
 215         /* latency measurement */
 216
 217         MTDM* mtdm() { return _mtdm; }
 218         MIDIDM* mididm() { return _mididm; }
 219
 220         int  prepare_for_latency_measurement ();
 221         int  start_latency_detection (bool);
 222         void stop_latency_detection ();
 223         void set_latency_input_port (const std::string&);
 224         void set_latency_output_port (const std::string&);
 225         uint32_t latency_signal_delay () const { return _latency_signal_latency; }
 226
 227         enum LatencyMeasurement {
 228                 MeasureNone,
 229                 MeasureAudio,
 230                 MeasureMIDI
 231         };
 232
 233         LatencyMeasurement measuring_latency () const { return _measuring_latency; }
 234
 235   private:
 236         AudioEngine ();
 237
 238         static AudioEngine*       _instance;
 239
 240         Glib::Threads::Mutex       _process_lock;
 241         Glib::Threads::RecMutex    _state_lock;
 242         Glib::Threads::Cond        session_removed;
 243         bool                       session_remove_pending;
 244         frameoffset_t              session_removal_countdown;
 245         gain_t                     session_removal_gain;
 246         gain_t                     session_removal_gain_step;
 247         bool                      _running;
 248         bool                      _freewheeling;
 249         /// number of frames between each check for changes in monitor input
 250         framecnt_t                 monitor_check_interval;
 251         /// time of the last monitor check in frames
 252         framecnt_t                 last_monitor_check;
 253         /// the number of frames processed since start() was called
 254         framecnt_t                _processed_frames;
 255         Glib::Threads::Thread*     m_meter_thread;
 256         ProcessThread*            _main_thread;
 257         MTDM*                     _mtdm;
 258         MIDIDM*                   _mididm;
 259         LatencyMeasurement        _measuring_latency;
 260         PortEngine::PortHandle    _latency_input_port;
 261         PortEngine::PortHandle    _latency_output_port;
 262         framecnt_t                _latency_flush_frames;
 263         std::string               _latency_input_name;
 264         std::string               _latency_output_name;
 265         framecnt_t                _latency_signal_latency;
 266         bool                      _stopped_for_latency;
 267         bool                      _started_for_latency;
 268         bool                      _in_destructor;
 269
 270         Glib::Threads::Thread*     _hw_reset_event_thread;
 271         gint                       _hw_reset_request_count;
 272         Glib::Threads::Cond        _hw_reset_condition;
 273         Glib::Threads::Mutex       _reset_request_lock;
 274         gint                       _stop_hw_reset_processing;
 275         Glib::Threads::Thread*     _hw_devicelist_update_thread;
 276         gint                       _hw_devicelist_update_count;
 277         Glib::Threads::Cond        _hw_devicelist_update_condition;
 278         Glib::Threads::Mutex       _devicelist_update_lock;
 279         gint                       _stop_hw_devicelist_processing;
 280
 281         void start_hw_event_processing();
 282         void stop_hw_event_processing();
 283         void do_reset_backend();
 284         void do_devicelist_update();
 285
 286         void meter_thread ();
 287         void start_metering_thread ();
 288         void stop_metering_thread ();
 289
 290         static gint      m_meter_exit;
 291
 292         typedef std::map<std::string,AudioBackendInfo*> BackendMap;
 293         BackendMap _backends;
 294         AudioBackendInfo* backend_discover (const std::string&);
 295         void drop_backend ();
 296 };
 297
 298 } // namespace ARDOUR
 299
 300 #endif /* __ardour_audioengine_h__ */