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 #ifdef HAVE_JACK_SESSION
  48 #include <jack/session.h>
  49 #endif
  50
  51 class MTDM;
  52
  53 namespace ARDOUR {
  54
  55 class InternalPort;
  56 class MidiPort;
  57 class Port;
  58 class Session;
  59 class ProcessThread;
  60 class AudioBackend;
  61 class AudioBackendInfo;
  62
  63 class LIBARDOUR_API AudioEngine : public SessionHandlePtr, public PortManager
  64 {
  65 public:
  66
  67     static AudioEngine* create ();
  68
  69     virtual ~AudioEngine ();
  70
  71     int discover_backends();
  72     std::vector<const AudioBackendInfo*> available_backends() const;
  73     std::string current_backend_name () const;
  74     boost::shared_ptr<AudioBackend> set_default_backend ();
  75     boost::shared_ptr<AudioBackend> set_backend (const std::string&, const std::string& arg1, const std::string& arg2);
  76     boost::shared_ptr<AudioBackend> current_backend() const { return _backend; }
  77     bool setup_required () const;
  78
  79     ProcessThread* main_thread() const { return _main_thread; }
  80
  81     /* START BACKEND PROXY API
  82      *
  83      * See audio_backend.h for full documentation and semantics. These wrappers
  84      * just forward to a backend implementation.
  85      */
  86
  87     int            start (bool for_latency_measurement=false);
  88     int            stop (bool for_latency_measurement=false);
  89     int            freewheel (bool start_stop);
  90     float          get_dsp_load() const ;
  91     void           transport_start ();
  92     void           transport_stop ();
  93     TransportState transport_state ();
  94     void           transport_locate (framepos_t pos);
  95     framepos_t     transport_frame();
  96     framecnt_t     sample_rate () const;
  97     pframes_t      samples_per_cycle () const;
  98     int            usecs_per_cycle () const;
  99     size_t         raw_buffer_size (DataType t);
 100     pframes_t      sample_time ();
 101     pframes_t      sample_time_at_cycle_start ();
 102     pframes_t      samples_since_cycle_start ();
 103     bool           get_sync_offset (pframes_t& offset) const;
 104
 105     int            create_process_thread (boost::function<void()> func);
 106     int            join_process_threads ();
 107     bool           in_process_thread ();
 108     uint32_t       process_thread_count ();
 109
 110     bool           is_realtime() const;
 111     bool           connected() const;
 112
 113     int set_device_name (const std::string&);
 114     int set_sample_rate (float);
 115     int set_buffer_size (uint32_t);
 116     int set_sample_format (SampleFormat);
 117     int set_interleaved (bool yn);
 118     int set_input_channels (uint32_t);
 119     int set_output_channels (uint32_t);
 120     int set_systemic_input_latency (uint32_t);
 121     int set_systemic_output_latency (uint32_t);
 122
 123     /* END BACKEND PROXY API */
 124
 125     bool freewheeling() const { return _freewheeling; }
 126     bool running() const { return _running; }
 127
 128     Glib::Threads::Mutex& process_lock() { return _process_lock; }
 129
 130     int request_buffer_size (pframes_t samples) {
 131             return set_buffer_size (samples);
 132     }
 133
 134     framecnt_t processed_frames() const { return _processed_frames; }
 135
 136     void set_session (Session *);
 137     void remove_session (); // not a replacement for SessionHandle::session_going_away()
 138     Session* session() const { return _session; }
 139
 140     class NoBackendAvailable : public std::exception {
 141       public:
 142         virtual const char *what() const throw() { return "could not connect to engine backend"; }
 143     };
 144
 145     void split_cycle (pframes_t offset);
 146
 147     int  reset_timebase ();
 148
 149     void update_latencies ();
 150
 151     /* this signal is sent for every process() cycle while freewheeling.
 152        (the regular process() call to session->process() is not made)
 153     */
 154
 155     PBD::Signal1<int, pframes_t> Freewheel;
 156
 157     PBD::Signal0<void> Xrun;
 158
 159     /* this signal is emitted if the sample rate changes */
 160
 161     PBD::Signal1<void, framecnt_t> SampleRateChanged;
 162
 163     /* this signal is sent if the backend ever disconnects us */
 164
 165     PBD::Signal1<void,const char*> Halted;
 166
 167     /* these two are emitted when the engine itself is
 168        started and stopped
 169     */
 170
 171     PBD::Signal0<void> Running;
 172     PBD::Signal0<void> Stopped;
 173
 174     static AudioEngine* instance() { return _instance; }
 175     static void destroy();
 176     void died ();
 177
 178     /* The backend will cause these at the appropriate time(s)
 179      */
 180     int  process_callback (pframes_t nframes);
 181     int  buffer_size_change (pframes_t nframes);
 182     int  sample_rate_change (pframes_t nframes);
 183     void freewheel_callback (bool);
 184     void timebase_callback (TransportState state, pframes_t nframes, framepos_t pos, int new_position);
 185     int  sync_callback (TransportState state, framepos_t position);
 186     int  port_registration_callback ();
 187     void latency_callback (bool for_playback);
 188     void halted_callback (const char* reason);
 189
 190     /* sets up the process callback thread */
 191     static void thread_init_callback (void *);
 192
 193     /* latency measurement */
 194
 195     MTDM* mtdm();
 196     int  prepare_for_latency_measurement ();
 197     int  start_latency_detection ();
 198     void stop_latency_detection ();
 199     void set_latency_input_port (const std::string&);
 200     void set_latency_output_port (const std::string&);
 201     uint32_t latency_signal_delay () const { return _latency_signal_latency; }
 202
 203   private:
 204     AudioEngine ();
 205
 206     static AudioEngine*       _instance;
 207
 208     Glib::Threads::Mutex      _process_lock;
 209     Glib::Threads::Cond        session_removed;
 210     bool                       session_remove_pending;
 211     frameoffset_t              session_removal_countdown;
 212     gain_t                     session_removal_gain;
 213     gain_t                     session_removal_gain_step;
 214     bool                      _running;
 215     bool                      _freewheeling;
 216     /// number of frames between each check for changes in monitor input
 217     framecnt_t                 monitor_check_interval;
 218     /// time of the last monitor check in frames
 219     framecnt_t                 last_monitor_check;
 220     /// the number of frames processed since start() was called
 221     framecnt_t                _processed_frames;
 222     Glib::Threads::Thread*     m_meter_thread;
 223     ProcessThread*            _main_thread;
 224     MTDM*                     _mtdm;
 225     bool                      _measuring_latency;
 226     PortEngine::PortHandle    _latency_input_port;
 227     PortEngine::PortHandle    _latency_output_port;
 228     framecnt_t                _latency_flush_frames;
 229     std::string               _latency_input_name;
 230     std::string               _latency_output_name;
 231     framecnt_t                _latency_signal_latency;
 232     bool                      _stopped_for_latency;
 233     bool                      _started_for_latency;
 234     bool                      _in_destructor;
 235
 236     void meter_thread ();
 237     void start_metering_thread ();
 238     void stop_metering_thread ();
 239
 240     static gint      m_meter_exit;
 241
 242     typedef std::map<std::string,AudioBackendInfo*> BackendMap;
 243     BackendMap _backends;
 244     AudioBackendInfo* backend_discover (const std::string&);
 245     void drop_backend ();
 246 };
 247
 248 } // namespace ARDOUR
 249
 250 #endif /* __ardour_audioengine_h__ */