• Stars
    star
    132
  • Rank 274,205 (Top 6 %)
  • Language
    C++
  • License
    MIT License
  • Created almost 6 years ago
  • Updated 10 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

An app for exploring real-time audio performance on iPhone and iPad.
CI Status

Logo

An app for exploring real-time audio performance on iPhone and iPad

Screenshot

Table of Contents

About

The performance controller for Apple Silicon is tasked with balancing the competing interests of performance and energy efficiency. For light workloads, the performance controller saves energy by scheduling work onto efficiency cores and running them at low clock speeds. For heavier workloads, it moves the work to performance cores and ramps up their clock speeds.

For most apps, the performance controller strikes a good balance between these interests. Low-latency pro audio apps, however, are especially demanding, and performance isn't always optimal by default. AudioPerfLab provides an environment for testing workarounds to improve multi-threaded audio performance.

To simulate a demanding DSP workload, the app synthesizes a unison saw wave chord using additive synthesis. Sine wave partials are computed in parallel using a pool of real-time threads. Increasing the number of sine waves increases the DSP load. Pressing  Play  increases the number of waves all at once to test the system's response to a sudden load increase.

The cores visualization shows how audio threads are scheduled onto cores over time and the energy visualization shows power consumption. The main two workarounds to avoid CPU throttling are adding artificial load to real-time threads and running busy threads that perform low-energy work in the background. There are additional controls to tweak things like the number of audio threads and if those threads join a workgroup.

See High Performance Audio on iOS from ADC '19 for more information.

Recommendations

On iOS 13, real-time multi-threading doesn't work at low buffer sizes (< 512). For these buffer sizes, worker threads get scheduled onto efficiency cores with low clock speeds. These threads run so slow that a task that could be processed in 0.5ms on a fast core ends up taking more than 3ms, overshooting the 2.7ms deadline for a buffer size of 128.

If you need to support iOS 13, the Busy Thread + Delegated DSP workaround described in the ADC talk (the "Optimal" preset) will make multi-threading perform well with small buffer sizes and increase burst processing power.

As of iOS 14, the workgroup API should be used instead to inform the performance controller that worker threads contribute to meeting the audio device's deadline. With workgroups, multi-threaded audio works well for all buffer sizes. For most apps, no workaround is necessary. 🥳

However, if your app uses large buffer sizes (>= 512) and has a bursty DSP workload (i.e., CPU usage can jump to near the maximum at the touch of a button), using the Busy Thread + Delegated DSP workaround instead of workgroups on iOS 14 will increase the processing power available for a burst. This workaround may stop working due to future changes in the performance controller, so it should not be dropped in as a preventative measure but rather be used to fix real-world performance problems.

Requirements

  • Xcode 12 and above
  • iOS 13 and above
  • iPhone 6s and above

License

This software is distributed under the MIT License.

Visualizations and Controls

Toolbar


Play

Trigger a burst of sine waves to test the system's response to a sudden load increase. The number of sines can be set with the Burst Waves slider.

Preset

Switch between presets. The Standard preset uses CoreAudio as intended, with no workarounds. The Optimal preset uses the best known workaround to boost performance.

Enable visualizations

Turn visualizations on and off. Pause visualizations to take a closer look at the data.

⚠️ Drawing visualizations is expensive and can impact the scheduling of audio threads in surprising ways. You can observe behavior without the confounding effect of drawing by briefly turning visualizations off, performing a test, and then turning them back on.

Visualizations

Load

A graph of the amount of time taken to process each audio buffer as a percentage of the buffer duration. Drop-outs are drawn in red.

Work Distribution

A stacked area graph showing the relative number of sine waves processed per thread. Colors represent threads and the CoreAudio I/O thread is drawn in black. A solid black graph, for example, indicates that the I/O thread has processed all sines. A half black/half blue graph indicates that two threads each processed an equal number of sines.

If work is not distributed evenly, threads are likely being scheduled onto cores with different clock speeds. Note that the chunk size (kNumPartialsPerProcessingChunk) impacts the distribution when processing a small number of sines.

Cores

A visualization of thread activity on each CPU core. Each row represents a core and each color represents an audio thread. On iPhone 8 and up, the first four rows represent energy-efficient cores and the last two rows represent high-performance cores. The CoreAudio I/O thread is drawn in black.

Energy

A graph of the estimated power consumption of the AudioPerfLab process in watts. This can be used to compare the energy impact of different approaches for avoiding core switching and frequency scaling (see the Minimum Load and Busy Threads sliders).

Audio

Audio Input

Toggle if audio input is enabled. A meter is shown to check that input is working.

This can be used to check for performance differences due to the audio configuration. One known difference is the background CPU usage allowance on iOS 13:

  • Only output: 48s over 60s (80% average)
  • Input and output: 9s over 15s (60% average)

Note that the CPU usage is tracked per-thread and not per-process.

Buffer Size

The preferred buffer size. The actual buffer size is logged and may differ from the displayed value.

Sine Waves

The number of sine waves to be processed by the audio threads.

Burst Waves

Pressing  Play  in the toolbar triggers a short burst of a configurable number of sine waves.

Busy Threads

Busy threads are low-priority threads that perform low-energy work to prevent CPU throttling. Each thread alternates between blocking on a condition variable and working. Blocking for some of the time avoids termination due to excessive CPU usage when the app is running in the background.

Note that visualizations can have the same effect as a busy thread, so they should be frozen to observe the effect of busy threads alone.

Threads

The number of threads to create. On iOS 12 and 13, there is no benefit to using more than one.

Period

The duration of one busy thread loop iteration. Higher values may reduce energy usage by reducing overhead.

CPU Usage

The percentage of the period spent performing low-energy work. This value needs to be set high enough to prevent CPU throttling and low enough to avoid termination when the app is running in the background.

Audio Threads

Process Threads

The total number of real-time threads that process sine waves.

Minimum Load

The minimum amount of time to spend processing as a percentage of the buffer duration. If real audio processing finishes before this time, artificial processing is added via a low-energy wait instruction. No artificial processing is added if real processing exceeds this time. Artificial processing is added to all audio threads and is not shown in the load graph.

When the real audio load is low, adding artificial load tricks the OS into scheduling audio threads onto high-performance cores and increasing the clock-rate of those cores. This allows sudden load increases (e.g. the burst button) without drop-outs.

Driver Thread

The driver thread's mode.

Waits for Workers

The driver thread wakes up and waits for processing threads, but does not process sines itself. Due to the non-processing driver thread, the total number of real-time threads (e.g., as shown in the Cores visualization) is one more than the "Process Threads" value.

The driver thread's automatically joined work interval is sometimes detrimental to performance. This mode can be used to avoid a work interval for all audio processing threads without calling a private API.

Processes Sines

The driver thread wakes up and waits for processing threads and processes sines as well. The total number of audio threads (e.g., as shown in the Cores visualization) is equal to the "Process Threads" value.

Work Interval

When enabled on iOS 14, audio worker threads join the audio device's workgroup interval. The workgroup API is not available prior to iOS 14, so on older systems workers instead use a private API.

Joining the work interval informs the performance controller that worker threads contribute to meeting the audio device's deadline, giving them a performance boost.

At low buffer sizes (<= 256), this boost is necessary to perform even small amounts of DSP. This can be observed by turning off visualizations, disabling busy threads, and dialing in a small number of sustained sine waves (e.g., 500). Audio will constantly drop out unless the work interval is enabled.

More Repositories

1

link

Ableton Link
C++
1,075
star
2

push-interface

The Ableton Push 2 MIDI and display interface manual.
641
star
3

m4l-connection-kit

Max for Live Connection Kit
C++
491
star
4

atria

A toolkit for modern C++ development
C++
436
star
5

maxdevtools

Python
255
star
6

aqt-stylesheets

Apply CSS style sheets to QML applications
C++
214
star
7

LinkKit

iOS SDK for Ableton Link, a new technology that synchronizes musical beat, tempo, and phase across multiple applications running on one or more devices.
Objective-C++
150
star
8

push2-display-with-juce

C++
145
star
9

aqt-cassowary

Use the Cassowary constraint solver in QML applications
QML
54
star
10

ableton.github.io

Ableton's GitHub.io website
Sass
46
star
11

go-travis

Go library for accessing the Travis CI API
Go
33
star
12

python-pipeline-utils

Jenkins shared pipeline library for Python-related utilities
Groovy
25
star
13

groovylint

A CodeNarc wrapper for linting Groovy files
Python
19
star
14

windows-openssh

Ansible role to install Openssh on a Windows host
10
star
15

ansible-role-nix

Ansible role to install Nix
Jinja
10
star
16

ansible-role-jenkins-jcasc

Ansible role for installing Jenkins with JCasC
Jinja
4
star
17

ansible-role-prometheus-node-exporter

Ansible role to install Prometheus' node_exporter application
Jinja
4
star
18

postgres-pipeline-utils

Jenkins shared pipeline library to run Postgres in a Docker container
Groovy
2
star
19

ansible-role-sccache

Ansible role to install sccache
Jinja
1
star
20

ansible-role-jenkins-swarm-client

Ansible role to install Jenkins Swarm Client
Jinja
1
star
21

ansible-role-rustup-init

Ansible role to install rustup-init
Jinja
1
star
22

ansible-role-clang

Ansible role to install clang
Jinja
1
star