libs/ardour/ardour/audio_backend.h

   1 /*
   2     Copyright (C) 2013 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 __libardour_audiobackend_h__
  21 #define __libardour_audiobackend_h__
  22
  23 #include <string>
  24 #include <vector>
  25
  26 #include <stdint.h>
  27 #include <stdlib.h>
  28
  29 #include <boost/function.hpp>
  30
  31 #include "ardour/libardour_visibility.h"
  32 #include "ardour/types.h"
  33 #include "ardour/audioengine.h"
  34 #include "ardour/port_engine.h"
  35
  36 #ifdef ARDOURBACKEND_DLL_EXPORTS // defined if we are building the ARDOUR Panners DLLs (instead of using them)
  37     #define ARDOURBACKEND_API LIBARDOUR_DLL_EXPORT
  38 #else
  39     #define ARDOURBACKEND_API LIBARDOUR_DLL_IMPORT
  40 #endif
  41 #define ARDOURBACKEND_LOCAL LIBARDOUR_DLL_LOCAL
  42
  43 namespace ARDOUR {
  44
  45 struct LIBARDOUR_API AudioBackendInfo {
  46     const char* name;
  47
  48     /** Using arg1 and arg2, initialize this audiobackend.
  49      *
  50      * Returns zero on success, non-zero otherwise.
  51      */
  52     int (*instantiate) (const std::string& arg1, const std::string& arg2);
  53
  54     /** Release all resources associated with this audiobackend
  55      */
  56     int (*deinstantiate) (void);
  57
  58     /** Factory method to create an AudioBackend-derived class.
  59      *
  60      * Returns a valid shared_ptr to the object if successfull,
  61      * or a "null" shared_ptr otherwise.
  62      */
  63     boost::shared_ptr<AudioBackend> (*factory) (AudioEngine&);
  64
  65     /** Return true if the underlying mechanism/API has been
  66      * configured and does not need (re)configuration in order
  67      * to be usable. Return false otherwise.
  68      *
  69      * Note that this may return true if (re)configuration, even though
  70      * not currently required, is still possible.
  71      */
  72     bool (*already_configured)();
  73
  74     /** Return true if the underlying mechanism/API can be
  75      * used on the given system.
  76      *
  77      * If this function returns false, the backend is not
  78      * listed in the engine dialog.
  79      */
  80     bool (*available)();
  81 };
  82
  83 class LIBARDOUR_API AudioBackend : public PortEngine {
  84   public:
  85
  86     AudioBackend (AudioEngine& e, AudioBackendInfo& i) : PortEngine (e), _info (i), engine (e) {}
  87     virtual ~AudioBackend () {}
  88
  89     /** Return the AudioBackendInfo object from which this backend
  90         was constructed.
  91     */
  92     AudioBackendInfo& info() const { return _info; }
  93
  94     /** Return the name of this backend.
  95      *
  96      * Should use a well-known, unique term. Expected examples
  97      * might include "JACK", "CoreAudio", "ASIO" etc.
  98      */
  99     virtual std::string name() const = 0;
 100
 101     /** Return true if the callback from the underlying mechanism/API
 102      * (CoreAudio, JACK, ASIO etc.) occurs in a thread subject to realtime
 103      * constraints. Return false otherwise.
 104     */
 105     virtual bool is_realtime () const = 0;
 106
 107     /* Discovering devices and parameters */
 108
 109     /** Return true if this backend requires the selection of a "driver"
 110      * before any device can be selected. Return false otherwise.
 111      *
 112      * Intended mainly to differentiate between meta-APIs like JACK
 113      * which can still expose different backends (such as ALSA or CoreAudio
 114      * or FFADO or netjack) and those like ASIO or CoreAudio which
 115      * do not.
 116      */
 117     virtual bool requires_driver_selection() const { return false; }
 118
 119     /** If the return value of requires_driver_selection() is true,
 120      * then this function can return the list of known driver names.
 121      *
 122      * If the return value of requires_driver_selection() is false,
 123      * then this function should not be called. If it is called
 124      * its return value is an empty vector of strings.
 125      */
 126     virtual std::vector<std::string> enumerate_drivers() const { return std::vector<std::string>(); }
 127
 128     /** Returns zero if the backend can successfully use @param name as the
 129      * driver, non-zero otherwise.
 130      *
 131      * Should not be used unless the backend returns true from
 132      * requires_driver_selection()
 133      */
 134     virtual int set_driver (const std::string& /*drivername*/) { return 0; }
 135
 136     /** used to list device names along with whether or not they are currently
 137      *  available.
 138     */
 139     struct DeviceStatus {
 140         std::string name;
 141         bool        available;
 142
 143         DeviceStatus (const std::string& s, bool avail) : name (s), available (avail) {}
 144     };
 145
 146     /** Returns a collection of DeviceStatuses identifying devices discovered
 147      * by this backend since the start of the process.
 148      *
 149      * Any of the names in each DeviceStatus may be used to identify a
 150      * device in other calls to the backend, though any of them may become
 151      * invalid at any time.
 152      */
 153     virtual std::vector<DeviceStatus> enumerate_devices () const = 0;
 154
 155     /** Returns a collection of float identifying sample rates that are
 156      * potentially usable with the hardware identified by @param device.
 157      * Any of these values may be supplied in other calls to this backend
 158      * as the desired sample rate to use with the name device, but the
 159      * requested sample rate may turn out to be unavailable, or become invalid
 160      * at any time.
 161      */
 162     virtual std::vector<float> available_sample_rates (const std::string& device) const = 0;
 163
 164     /* Returns the default sample rate that will be shown to the user when
 165      * configuration options are first presented. If the derived class
 166      * needs or wants to override this, it can. It also MUST override this
 167      * if there is any chance that an SR of 44.1kHz is not in the list
 168      * returned by available_sample_rates()
 169      */
 170     virtual float default_sample_rate () const {
 171             return 44100.0;
 172     }
 173
 174     /** Returns a collection of uint32 identifying buffer sizes that are
 175      * potentially usable with the hardware identified by @param device.
 176      * Any of these values may be supplied in other calls to this backend
 177      * as the desired buffer size to use with the name device, but the
 178      * requested buffer size may turn out to be unavailable, or become invalid
 179      * at any time.
 180      */
 181     virtual std::vector<uint32_t> available_buffer_sizes (const std::string& device) const = 0;
 182
 183     /* Returns the default buffer size that will be shown to the user when
 184      * configuration options are first presented. If the derived class
 185      * needs or wants to override this, it can. It also MUST override this
 186      * if there is any chance that a buffer size of 1024 is not in the list
 187      * returned by available_buffer_sizes()
 188      */
 189     virtual uint32_t default_buffer_size () const {
 190             return 1024;
 191     }
 192
 193     /** Returns the maximum number of input channels that are potentially
 194      * usable with the hardware identified by @param device.  Any number from 1
 195      * to the value returned may be supplied in other calls to this backend as
 196      * the input channel count to use with the name device, but the requested
 197      * count may turn out to be unavailable, or become invalid at any time.
 198      */
 199     virtual uint32_t available_input_channel_count (const std::string& device) const = 0;
 200
 201     /** Returns the maximum number of output channels that are potentially
 202      * usable with the hardware identified by @param device.  Any number from 1
 203      * to the value returned may be supplied in other calls to this backend as
 204      * the output channel count to use with the name device, but the requested
 205      * count may turn out to be unavailable, or become invalid at any time.
 206      */
 207     virtual uint32_t available_output_channel_count (const std::string& device) const = 0;
 208
 209     /* Return true if the derived class can change the sample rate of the
 210      * device in use while the device is already being used. Return false
 211      * otherwise. (example: JACK cannot do this as of September 2013)
 212      */
 213     virtual bool can_change_sample_rate_when_running () const = 0;
 214     /* Return true if the derived class can change the buffer size of the
 215      * device in use while the device is already being used. Return false
 216      * otherwise.
 217      */
 218     virtual bool can_change_buffer_size_when_running () const = 0;
 219
 220     /* Set the hardware parameters.
 221      *
 222      * If called when the current state is stopped or paused,
 223      * the changes will not take effect until the state changes to running.
 224      *
 225      * If called while running, the state will change as fast as the
 226      * implementation allows.
 227      *
 228      * All set_*() methods return zero on success, non-zero otherwise.
 229      */
 230
 231     /** Set the name of the device to be used
 232      */
 233     virtual int set_device_name (const std::string&) = 0;
 234     /** Deinitialize and destroy current device
 235      */
 236         virtual int drop_device() {return 0;};
 237     /** Set the sample rate to be used
 238      */
 239     virtual int set_sample_rate (float) = 0;
 240     /** Set the buffer size to be used.
 241      *
 242      * The device is assumed to use a double buffering scheme, so that one
 243      * buffer's worth of data can be processed by hardware while software works
 244      * on the other buffer. All known suitable audio APIs support this model
 245      * (though ALSA allows for alternate numbers of buffers, and CoreAudio
 246      * doesn't directly expose the concept).
 247      */
 248     virtual int set_buffer_size (uint32_t) = 0;
 249     /** Set the preferred underlying hardware data layout.
 250      * If @param yn is true, then the hardware will interleave
 251      * samples for successive channels; otherwise, the hardware will store
 252      * samples for a single channel contiguously.
 253      *
 254      * Setting this does not change the fact that all data streams
 255      * to and from Ports are mono (essentially, non-interleaved)
 256      */
 257     virtual int set_interleaved (bool yn) = 0;
 258     /** Set the number of input channels that should be used
 259      */
 260     virtual int set_input_channels (uint32_t) = 0;
 261     /** Set the number of output channels that should be used
 262      */
 263     virtual int set_output_channels (uint32_t) = 0;
 264     /** Set the (additional) input latency that cannot be determined via
 265      * the implementation's underlying code (e.g. latency from
 266      * external D-A/D-A converters. Units are samples.
 267      */
 268     virtual int set_systemic_input_latency (uint32_t) = 0;
 269     /** Set the (additional) output latency that cannot be determined via
 270      * the implementation's underlying code (e.g. latency from
 271      * external D-A/D-A converters. Units are samples.
 272      */
 273     virtual int set_systemic_output_latency (uint32_t) = 0;
 274     /** Set the (additional) input latency for a specific midi device,
 275      * or if the identifier is empty, apply to all midi devices.
 276      */
 277     virtual int set_systemic_midi_input_latency (std::string const, uint32_t) = 0;
 278     /** Set the (additional) output latency for a specific midi device,
 279      * or if the identifier is empty, apply to all midi devices.
 280      */
 281     virtual int set_systemic_midi_output_latency (std::string const, uint32_t) = 0;
 282
 283     /* Retrieving parameters */
 284
 285     virtual std::string  device_name () const = 0;
 286     virtual float        sample_rate () const = 0;
 287     virtual uint32_t     buffer_size () const = 0;
 288     virtual bool         interleaved () const = 0;
 289     virtual uint32_t     input_channels () const = 0;
 290     virtual uint32_t     output_channels () const = 0;
 291     virtual uint32_t     systemic_input_latency () const = 0;
 292     virtual uint32_t     systemic_output_latency () const = 0;
 293     virtual uint32_t     systemic_midi_input_latency (std::string const) const = 0;
 294     virtual uint32_t     systemic_midi_output_latency (std::string const) const = 0;
 295
 296     /** override this if this implementation returns true from
 297      * requires_driver_selection()
 298      */
 299     virtual std::string  driver_name() const { return std::string(); }
 300
 301     /** Return the name of a control application for the
 302      * selected/in-use device. If no such application exists,
 303      * or if no device has been selected or is in-use,
 304      * return an empty string.
 305      */
 306     virtual std::string control_app_name() const = 0;
 307     /** Launch the control app for the currently in-use or
 308      * selected device. May do nothing if the control
 309      * app is undefined or cannot be launched.
 310      */
 311     virtual void launch_control_app () = 0;
 312
 313     /* @return a vector of strings that describe the available
 314      * MIDI options.
 315      *
 316      * These can be presented to the user to decide which
 317      * MIDI drivers, options etc. can be used. The returned strings
 318      * should be thought of as the key to a map of possible
 319      * approaches to handling MIDI within the backend. Ensure that
 320      * the strings will make sense to the user.
 321      */
 322     virtual std::vector<std::string> enumerate_midi_options () const = 0;
 323
 324     /* Request the use of the MIDI option named @param option, which
 325      * should be one of the strings returned by enumerate_midi_options()
 326      *
 327      * @return zero if successful, non-zero otherwise
 328      */
 329     virtual int set_midi_option (const std::string& option) = 0;
 330
 331     virtual std::string midi_option () const = 0;
 332
 333     /** Detailed MIDI device list - if available */
 334     virtual std::vector<DeviceStatus> enumerate_midi_devices () const = 0;
 335
 336     /** mark a midi-devices as enabled */
 337     virtual int set_midi_device_enabled (std::string const, bool) = 0;
 338
 339     /** query if a midi-device is enabled */
 340     virtual bool midi_device_enabled (std::string const) const = 0;
 341
 342     /** if backend supports systemic_midi_[in|ou]tput_latency() */
 343     virtual bool can_set_systemic_midi_latencies () const = 0;
 344
 345     /* State Control */
 346
 347     /** Start using the device named in the most recent call
 348      * to set_device(), with the parameters set by various
 349      * the most recent calls to set_sample_rate() etc. etc.
 350      *
 351      * At some undetermined time after this function is successfully called,
 352      * the backend will start calling the ::process_callback() method of
 353      * the AudioEngine referenced by @param engine. These calls will
 354      * occur in a thread created by and/or under the control of the backend.
 355      *
 356      * @param for_latency_measurement if true, the device is being started
 357      *        to carry out latency measurements and the backend should this
 358      *        take care to return latency numbers that do not reflect
 359      *        any existing systemic latency settings.
 360      *
 361      * Return zero if successful, negative values otherwise.
 362      *
 363      *
 364      *
 365      *
 366      * Why is this non-virtual but ::_start() is virtual ?
 367      * Virtual methods with default parameters create possible ambiguity
 368      * because a derived class may implement the same method with a different
 369      * type or value of default parameter.
 370      *
 371      * So we make this non-virtual method to avoid possible overrides of
 372      * default parameters. See Scott Meyers or other books on C++ to understand
 373      * this pattern, or possibly just this:
 374      *
 375      * http://stackoverflow.com/questions/12139786/good-pratice-default-arguments-for-pure-virtual-method
 376      */
 377     int start (bool for_latency_measurement=false) {
 378             return _start (for_latency_measurement);
 379     }
 380
 381     /** Stop using the device currently in use.
 382      *
 383      * If the function is successfully called, no subsequent calls to the
 384      * process_callback() of @param engine will be made after the function
 385      * returns, until parameters are reset and start() are called again.
 386      *
 387      * The backend is considered to be un-configured after a successful
 388      * return, and requires calls to set hardware parameters before it can be
 389      * start()-ed again. See pause() for a way to avoid this. stop() should
 390      * only be used when reconfiguration is required OR when there are no
 391      * plans to use the backend in the future with a reconfiguration.
 392      *
 393      * Return zero if successful, 1 if the device is not in use, negative values on error
 394      */
 395     virtual int stop () = 0;
 396
 397          /** Reset device.
 398      *
 399      * Return zero if successful, negative values on error
 400      */
 401         virtual int reset_device() = 0;
 402
 403     /** While remaining connected to the device, and without changing its
 404      * configuration, start (or stop) calling the process_callback() of @param engine
 405      * without waiting for the device. Once process_callback() has returned, it
 406      * will be called again immediately, thus allowing for faster-than-realtime
 407      * processing.
 408      *
 409      * All registered ports remain in existence and all connections remain
 410      * unaltered. However, any physical ports should NOT be used by the
 411      * process_callback() during freewheeling - the data behaviour is undefined.
 412      *
 413      * If @param start_stop is true, begin this behaviour; otherwise cease this
 414      * behaviour if it currently occuring, and return to calling
 415      * process_callback() of @param engine by waiting for the device.
 416      *
 417      * Return zero on success, non-zero otherwise.
 418      */
 419     virtual int freewheel (bool start_stop) = 0;
 420
 421     /** return the fraction of the time represented by the current buffer
 422      * size that is being used for each buffer process cycle, as a value
 423      * from 0.0 to 1.0
 424      *
 425      * E.g. if the buffer size represents 5msec and current processing
 426      * takes 1msec, the returned value should be 0.2.
 427      *
 428      * Implementations can feel free to smooth the values returned over
 429      * time (e.g. high pass filtering, or its equivalent).
 430      */
 431     virtual float dsp_load() const  = 0;
 432
 433     /* Transport Control (JACK is the only audio API that currently offers
 434        the concept of shared transport control)
 435     */
 436
 437     /** Attempt to change the transport state to TransportRolling.
 438      */
 439     virtual void transport_start () {}
 440     /** Attempt to change the transport state to TransportStopped.
 441      */
 442     virtual void transport_stop () {}
 443     /** return the current transport state
 444      */
 445     virtual TransportState transport_state () const { return TransportStopped; }
 446     /** Attempt to locate the transport to @param pos
 447      */
 448     virtual void transport_locate (framepos_t /*pos*/) {}
 449     /** Return the current transport location, in samples measured
 450      * from the origin (defined by the transport time master)
 451      */
 452     virtual framepos_t transport_frame() const { return 0; }
 453
 454     /** If @param yn is true, become the time master for any inter-application transport
 455      * timebase, otherwise cease to be the time master for the same.
 456      *
 457      * Return zero on success, non-zero otherwise
 458      *
 459      * JACK is the only currently known audio API with the concept of a shared
 460      * transport timebase.
 461      */
 462     virtual int set_time_master (bool /*yn*/) { return 0; }
 463
 464     virtual int        usecs_per_cycle () const { return 1000000 * (buffer_size() / sample_rate()); }
 465     virtual size_t     raw_buffer_size (DataType t) = 0;
 466
 467     /* Process time */
 468
 469     /** return the time according to the sample clock in use, measured in
 470      * samples since an arbitrary zero time in the past. The value should
 471      * increase monotonically and linearly, without interruption from any
 472      * source (including CPU frequency scaling).
 473      *
 474      * It is extremely likely that any implementation will use a DLL, since
 475      * this function can be called from any thread, at any time, and must be
 476      * able to accurately determine the correct sample time.
 477      *
 478      * Can be called from any thread.
 479      */
 480     virtual pframes_t sample_time () = 0;
 481
 482     /** Return the time according to the sample clock in use when the most
 483      * recent buffer process cycle began. Can be called from any thread.
 484      */
 485     virtual pframes_t sample_time_at_cycle_start () = 0;
 486
 487     /** Return the time since the current buffer process cycle started,
 488      * in samples, according to the sample clock in use.
 489      *
 490      * Can ONLY be called from within a process() callback tree (which
 491      * implies that it can only be called by a process thread)
 492      */
 493     virtual pframes_t samples_since_cycle_start () = 0;
 494
 495     /** Return true if it possible to determine the offset in samples of the
 496      * first video frame that starts within the current buffer process cycle,
 497      * measured from the first sample of the cycle. If returning true,
 498      * set @param offset to that offset.
 499      *
 500      * Eg. if it can be determined that the first video frame within the cycle
 501      * starts 28 samples after the first sample of the cycle, then this method
 502      * should return true and set @param offset to 28.
 503      *
 504      * May be impossible to support outside of JACK, which has specific support
 505      * (in some cases, hardware support) for this feature.
 506      *
 507      * Can ONLY be called from within a process() callback tree (which implies
 508      * that it can only be called by a process thread)
 509      */
 510     virtual bool get_sync_offset (pframes_t& /*offset*/) const { return false; }
 511
 512     /** Create a new thread suitable for running part of the buffer process
 513      * cycle (i.e. Realtime scheduling, memory allocation, etc. etc are all
 514      * correctly setup), with a stack size given in bytes by specified @param
 515      * stacksize. The thread will begin executing @param func, and will exit
 516      * when that function returns.
 517      */
 518     virtual int create_process_thread (boost::function<void()> func) = 0;
 519
 520     /** Wait for all processing threads to exit.
 521      *
 522      * Return zero on success, non-zero on failure.
 523      */
 524     virtual int join_process_threads () = 0;
 525
 526     /** Return true if execution context is in a backend thread
 527      */
 528     virtual bool in_process_thread () = 0;
 529
 530     /** Return the minimum stack size of audio threads in bytes
 531      */
 532     static size_t thread_stack_size () { return 100000; }
 533
 534     /** Return number of processing threads
 535      */
 536     virtual uint32_t process_thread_count () = 0;
 537
 538     virtual void update_latencies () = 0;
 539
 540     /** Set @param speed and @param position to the current speed and position
 541      * indicated by some transport sync signal.  Return whether the current
 542      * transport state is pending, or finalized.
 543      *
 544      * Derived classes only need implement this if they provide some way to
 545      * sync to a transport sync signal (e.g. Sony 9 Pin) that is not
 546      * handled by Ardour itself (LTC and MTC are both handled by Ardour).
 547      * The canonical example is JACK Transport.
 548      */
 549      virtual bool speed_and_position (double& speed, framepos_t& position) {
 550              speed = 0.0;
 551              position = 0;
 552              return false;
 553      }
 554
 555   protected:
 556      AudioBackendInfo&  _info;
 557      AudioEngine&        engine;
 558
 559      virtual int _start (bool for_latency_measurement) = 0;
 560 };
 561
 562 } // namespace
 563
 564 #endif /* __libardour_audiobackend_h__ */
 565