Skip to content

Latest commit

 

History

History
357 lines (298 loc) · 17.4 KB

FAQ.md

File metadata and controls

357 lines (298 loc) · 17.4 KB
Raw

FlexASIO Frequently Asked Questions

What is PortAudio?

PortAudio is an open-source audio input/output library. It unifies many different audio APIs provided by operating systems (e.g. Windows) behind a single simplified API, making it easy to write applications (such as FlexASIO) that can leverage the variety of audio features provided by operating systems.

In FlexASIO, the PortAudio library handles most of the business logic of finding audio devices, setting them up in the correct way, and transferring audio data. In fact, it would be fair to describe FlexASIO as a mere "wrapper" or "glue layer", providing a bridge between the ASIO API and the PortAudio library.

Because FlexASIO does relatively little work compared to PortAudio, most of FlexASIO's behaviour, features, limitations, and quirks are ultimately a reflection of PortAudio's.

Note: FlexASIO is not affiliated with PortAudio in any way. It is merely using it as a library.

Where is the control panel?

There isn't one. FlexASIO settings can only be changed through a configuration file.

The reason for the lack of a proper control panel is because developing a graphical user interface requires a lot of time and resources, which FlexASIO currently doesn't have.

That said, third-party FlexASIO GUIs do exist:

Why is FlexASIO ignoring my configuration file and/or logfile?

You can double-check that the files are located in the correct folder and are named properly by running the following in a command-line prompt:

dir %userprofile%\FlexASIO*

Or, if you are using PowerShell:

dir $env:userprofile\FlexASIO*

The output should list FlexASIO.toml and/or FlexASIO.log.

Note: it is typical for Windows and some text editors to automatically add a .txt extension to file names. This results in files named FlexASIO.toml.txt or FlexASIO.log.txt, which won't work. To confuse matters further, Windows hides .txt extensions by default. Use the aforementioned command to reveal the true file name.

Why does FlexASIO fail to initialize?

There are many reasons why FlexASIO might refuse to initialize. Sadly, the ASIO API doesn't provide many ways of surfacing error details to applications, and many applications don't display them anyway. The best way to shed light on what might be going on is to inspect the FlexASIO log.

Otherwise, initialization failures can usually be traced back to problematic settings. Here are some common issues:

  • Invalid values for configuration options (e.g. wrong type, typos in backend names or device names) will result in initialization failures.
  • Windows might deny access to the audio device...
    • …if it is already in use by another exclusive mode application.
    • …if your Windows privacy settings are set to deny access to the input device (microphone).
  • When using an exclusive backend (i.e. WASAPI Exclusive, WDM-KS)…
    • The sample rate selected in the ASIO Host Application must be natively supported by the hardware audio device.
    • The channel count that FlexASIO is configured to use must be natively supported by the hardware audio device.
    • In the case of WASAPI Exclusive, the sample type that FlexASIO is configured to use must be natively supported by the hardware audio device, unless FlexASIO is configured to allow implicit sample type conversions.
  • WDM-KS will fail to initialize if the selected device is already in use by any other application, even if no audio is actually playing. This means that WDM-KS is unlikely to initialize successfully on the Windows default devices; this can be worked around using the device configuration option.
  • When using WASAPI Shared with the wasapiAutoConvert configuration option disabled…
    • Only one sample rate is supported: the one configured in the Windows audio device settings for the input and output devices.
      • If the ASIO Host Application uses any other sample rate, FlexASIO will fail to initialize.
      • If the selected input and output devices are configured with different sample rates in the Windows audio settings, FlexASIO will fail to initialize.
    • Only one channel count is supported: the one configured in the Windows audio device settings for the selected device.
      • FlexASIO will fail to initialize if it is configured to use any other channel count.
  • If other ASIO drivers (such as ASIO4ALL) are installed besides FlexASIO, it might fail or behave erratically at initialization time.
    • This is a known issue with some ASIO applications (e.g. Ableton, Pro Tools). These applications seem to initialize multiple ASIO drivers in parallel, which makes the drivers race against each other for exclusive access to audio devices, resulting in random failures.
    • This issue can be worked around by uninstalling the other drivers.
  • When using devices with an unusually large number of channels (10 or more), there is a known issue where the (default) DirectSound backend fails to initialize if the channel count set in the Windows audio device settings doesn't match.
  • A FlexASIO (or PortAudio) bug. If you believe that is the case, please file a report.
    • In particular, please do file a report if FlexASIO fails to initialize with the default configuration, as the defaults are always supposed to work on all systems.

Note that FlexASIO advertising a sample rate as "available" to the application does not mean that this sample rate will actually work (see below).

Why does the device channel count/routing seem wrong with some backends?

In many cases, the device channel count reported by FlexASIO might be wrong, or some channels can be misrouted. This is especially true for multichannel (5.1, 7.1, etc.) setups.

With the notable exception of the WDM-KS backend (which typically deals with hardware output channels directly), all FlexASIO backends eventually rely on the channel count that is configured in the Windows audio device control panel settings. It is imperative that this setting be configured correctly, otherwise FlexASIO (as well as most other Windows applications) will not route audio channels in the way you'd expect.

To confuse matters further, the (default) DirectSound and MME backends support on-the-fly downmixing, which means they might provide more channels than Windows is configured to use - but these aren't "real" channels!

To fix most channel count issues, go through the Windows audio settings, or run mmsys.cpl, to access the relevant Windows audio control panel. For typical output devices, channel configuration can be changed by selecting the relevant device and clicking the "Configure" button. For other devices including input devices, the channel count can be changed in the device properties, "Advanced" tab.

Why am I getting "glitches" (cracks, pops) in the audio?

A more technical term for these is discontinuities. They are often caused by buffer overflows (input) or buffer underruns (output). These in turn have two typical causes:

  • When the input and output are not provided by a single hardware device (e.g. using two sound cards):
    • It is unlikely that the two devices will use the same clock.
    • Therefore, they will run at slightly different speeds.
    • The ASIO API does not handle this case well, as it can only use a single speed and the same streaming sequence is used for both the input and output.
    • For this reason, discontinuities are pretty much guaranteed to occur at one point or another.
    • This is an inherent limitation of ASIO. The only way to work around it would be to adjust for clock drift on-the-fly using sample rate conversion, but that is not supported by FlexASIO and it would have a number of other downsides anyway.
  • Expensive processing is being done in the critical real-time audio streaming loop, or the ASIO Host Application real-time streaming path is poorly optimized, and the pipeline is unable to keep up.
  • Overly tight scheduling constraints, which make it impossible to run the audio streaming event code (callback) in time.
    • This is especially likely to occur when using very small buffer sizes (smaller than the default values). See the bufferSizeSamples and suggestedLatencySeconds options.
    • Small buffer sizes require audio streaming events to fire with very tight deadlines, which can put too much pressure on the Windows thread scheduler or other parts of the system, especially when combined with expensive processing (see above).
    • Scheduling constraints are tighter when using both input and output devices (full duplex mode), even if both devices are backed by the same hardware. Problems are less likely to occur when using only the input, or only the output (half duplex mode).
  • FlexASIO logging is enabled.
    • FlexASIO writes to the log using blocking file I/O from critical real-time code paths. This can easily lead to missed deadlines, especially with small buffer sizes.
    • Do not forget to disable logging when you don't need it.
    • To disable logging, simply delete or move the FlexASIO.log file.
  • There is a known issue with Pro Tools where using different sample types for the input and output devices can lead to crashes, error messages, or even a garbage sound signal.
    • This can happen when using WASAPI Exclusive mode, or explicitly setting the sampleType option.
    • One way to work around the issue is to explicitly set sampleType to the same value in the [input] and [output] sections.
  • A FlexASIO (or PortAudio) bug (or lack of optimization). If you believe that is the case, please file a report.

How to improve the latency?

The default FlexASIO settings are optimized for reliability and ease of use, not latency. Worse, the default backend (DirectSound) is known to underestimate its own latency, which makes the number misleading. To improve the latency, you will need to make some adjustments to the FlexASIO configuration.

The best latency (and latency reporting) is provided by the WASAPI (especially in exclusive mode) and WDM-KS backends. This is because these backends offer the most direct path to the hardware.

Aside from the backend option, the ASIO buffer size should also be made as small as possible (but watch out for discontinuities - see above). Some ASIO Host Applications make it possible to change the ASIO Buffer Size in the application itself. For those that don't, use the bufferSizeSamples option.

Finally, the suggestedLatencySeconds option should be set to the smallest possible value that works.

In the end, a typical low-latency configuration might look something like this:

backend = "Windows WASAPI"
bufferSizeSamples = 480 # 10 ms at 48 kHz

[input]
suggestedLatencySeconds = 0.0
wasapiExclusiveMode = true

[output]
suggestedLatencySeconds = 0.0
wasapiExclusiveMode = true

How reliable are the latency numbers reported by FlexASIO?

It depends on the backend:

  • The default backend, DirectSound, as well as MME, are blind to most sources of latency (including the Windows audio pipeline itself), and can therefore grossly underestimate the actual latency.
  • The WASAPI and WDM-KS backends have been observed to report more plausible latency numbers.

There are also a couple of things to keep in mind when interpreting latency numbers:

  • The reported latency can be higher than the ASIO buffer size.
    • This is perfectly normal in most configurations, because some backends will add additional buffering on top of the ASIO buffer itself.
  • The reported latency usually does not take the underlying hardware into account.
    • For example, when playing audio over Bluetooth, the reported latency will not take the Bluetooth stack into account, and will therefore be grossly underestimated.

How to achieve "bit-perfect" audio streaming?

In this context, bit-perfect streaming describes a setup in which the audio data generated by the ASIO Host Application is delivered to the audio hardware as-is, bit-for-bit, with no alteration whatsoever. In particular, no sample rate nor sample type (i.e. bit depth) conversions are made.

The default FlexASIO settings are optimized for reliability and ease of use, not bit-perfect streaming. To reach that goal, you will need to make some adjustments to the FlexASIO configuration:

  • You will want to avoid shared backends because these go through the Windows audio pipeline, which is never bit-perfect (unless perhaps your hardware is capable of handing 32-bit float samples natively, which is atypical).
    • That means you should either use the WASAPI backend in Exclusive mode, or the WDM-KS backend.
  • Even then, you will want to make sure no sample type conversions (e.g. 32-bit float to 16-bit integer) are taking place.
    • When using WASAPI Exclusive, FlexASIO guarantees no sample type conversions will take place, unless they are allowed via the wasapiExplicitSampleFormat option.
    • Sadly, in all other cases, PortAudio does sample type conversions automatically, and there is no way to disable that behaviour.
    • The way to ensure no conversions are done is to make them unnecessary. This means things must be set up such that the ASIO sample type matches the native sample type of the hardware.
      • In WASAPI Exclusive mode, FlexASIO will try to do that automatically by guessing the hardware native sample type.
      • Otherwise, the sampleType option can be used to override FlexASIO's choice. This is useful when FlexASIO guesses wrong, when using WDM-KS, or when the hardware supports more than one native sample type.
    • Sadly, PortAudio does not make it obvious that a sample type conversion is taking place. To verify that no conversion is done, you might need to examine the FlexASIO log.

A typical bit-perfect configuration might look something like this:

backend = "Windows WASAPI"

[input]
wasapiExclusiveMode = true

[output]
wasapiExclusiveMode = true

Why does FlexASIO list too many available sample rates?

There are some cases in which FlexASIO can report a sample rate as "available" to the ASIO host application, even if the underlying hardware doesn't support it:

  • When using backends that go through the Windows audio engine (i.e. the default DirectSound backend, MME, WASAPI Shared), any sample rate can be used as it will be transparently converted to the hardware sample rate.
  • When using input and output devices that support different sample rates, a sample rate will be reported as available if either of the devices support it. This is because, by the time the application asks for available sample rates, FlexASIO doesn't yet know what devices the application is going to use.
  • Some applications (e.g. Max MSP, Cubase, Ableton) sometimes query sample rates while a stream is already running. FlexASIO cannot probe available sample rates while running an exclusive stream. In this situation, FlexASIO will always report all sample rates as available.

Note that in the latter two cases, FlexASIO might report a sample rate as available but then fail to initialize when that sample rate is selected.

ASIO is a trademark and software of Steinberg Media Technologies GmbH