Skip to content

Add documentation updates #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
quic-annemari wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Add documentation updates #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
70b2029
platform: Add minor update to RPI4 documentation
quic-annemari Apr 3, 2026
ea57ad6
dev: Replace image in adding modules workflow
quic-annemari Apr 3, 2026
1eb2e5e
dev: Update available modules guide
quic-annemari Apr 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions source/dev/adding_modules.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,8 @@ Introduction

This guide will outline how to incorporate, build, and test an audio algorithm in audioreach-engine, in the form of a **module**, using these basic steps:

.. figure:: images/adding_modules/workflow_diagram.png
.. figure:: images/adding_modules/adding_modules_workflow_diagram.png
:figclass: fig-center
:scale: 100 %

As noted in the workflow diagram above, this guide will show how to add a module with source code, or how to instead add a prebuilt ".a" binary file, which will be discussed in the section `Create a build file <#create-a-build-file>`__.

Expand Down
58 changes: 2 additions & 56 deletions source/dev/available_modules.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ On the top bar, find View -> Module List. The list of modules will appear on the
| | | | | |
| | | | | |
+-----------------------------------+------------------------------------------------------------------------+-------------------------------------------------+-----------------------------------------+------------------+
| Accumulator & Limiter | | The Accumulator & Limiter is also known as SAL | modules/cmn/simple_accumulator_limiter | Limiter | | Binary |
| | | (simple accumulator limiter). It can be used to mix concurrent PCM | | | | 32-bit ARM |
| Accumulator & Limiter | | The Accumulator & Limiter is also known as SAL | modules/cmn/simple_accumulator_limiter | Limiter | Source |
| | | (simple accumulator limiter). It can be used to mix concurrent PCM | | | |
| | | streams. When using SAL, you must ensure that all of the input | | | |
| | | streams are of the same data format. | | | |
| | | | | |
Expand Down Expand Up @@ -64,15 +64,6 @@ On the top bar, find View -> Module List. The list of modules will appear on the
| | | MFC has all the functionality of the channel_mixer, iir resampler, | | | |
| | | and dynamic resampler modules. | | | |
+-----------------------------------+------------------------------------------------------------------------+-------------------------------------------------+-----------------------------------------+------------------+
| Bass Boost | | The bass boost module is used to increase the bass for audio | modules/processing/bassboost | Limiter, DRC, MS-IIR Filter | Source |

@quic-plai quic-plai Apr 13, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think bass boost should be removed

| | | playback. | | | |
| | | | | |
| | | | | |
| | | | | |
| | | | | |
| | | | | |
| | | | | |
+-----------------------------------+------------------------------------------------------------------------+-------------------------------------------------+-----------------------------------------+------------------+
| Channel Mixer | | Channel mixer will upmix or downmix channels based on the | modules/processing/channel_mixer | None | Source |
| | | configured coefficients. | | | |
| | | | | |
Expand Down Expand Up @@ -100,24 +91,6 @@ On the top bar, find View -> Module List. The list of modules will appear on the
| | | | | |
| | | | | |
+-----------------------------------+------------------------------------------------------------------------+-------------------------------------------------+-----------------------------------------+------------------+
| Dynamic Range Control | | Used to compress the range of an audio signal, reducing the range | modules/processing/gain_control/drc | None | | Binary |
| | | between the lowest and highest signals. It is not a standalone | | | | 32-bit ARM |
| | | module in ARC, because all of its functionality is included in the | | | |
| | | IIR_MBDRC module. | | | |
| | | | | |
| | | | | |
| | | | | |
| | | | | |
+-----------------------------------+------------------------------------------------------------------------+-------------------------------------------------+-----------------------------------------+------------------+
| IIR_MBDRC | | MBDRC stands for multiband dynamic range control. It has several | modules/processing/gain_control/iir_mbdrc | DRC, Limiter | | Binary |
| | | capabilities in real time calibration mode, such as setting the | | | | 32-bit ARM |
| | | gain, compressing/expanding, and configuring the limiter. | | | |
| | | It also contains all the functionality of the DRC module. | | | |
| | | | | |
| | | | | |
| | | | | |
| | | | | |
+-----------------------------------+------------------------------------------------------------------------+-------------------------------------------------+-----------------------------------------+------------------+
| Limiter | | Limiter cannot be used as a standalone module in ARC. However, it is | modules/processing/gain_control/limiter | None | Source |
| | | a dependency for other modules, such as SAL and IIR_MBDRC. | | | |
| | | | | |
Expand Down Expand Up @@ -154,33 +127,6 @@ On the top bar, find View -> Module List. The list of modules will appear on the
| | | | | |
| | | | | |
+-----------------------------------+------------------------------------------------------------------------+-------------------------------------------------+-----------------------------------------+------------------+
| Shoebox | | The shoebox module reduces reverb effects in a cubical room. Shoebox | modules/processing/shoebox_reverb | None | | Binary |
| | | and reverb are two different modules in ARC; however, they share the | | | | 32-bit ARM |
| | | same source code. Several variables can be set to optimize the | | | |
| | | shoebox module, such as the room size, the material that the room is | | | |
| | | made out of, and more. | | | |
| | | | | |
| | | | | |
| | | | | |
+-----------------------------------+------------------------------------------------------------------------+-------------------------------------------------+-----------------------------------------+------------------+
| Reverb | | The reverb module is similar to shoebox, but it has presets for | modules/processing/shoebox_reverb | None | | Binary |
| | | the type of environment (such as arena, city, hallway, etc.). | | | | 32-bit ARM |
| | | | | |
| | | | | |
| | | | | |
| | | | | |
| | | | | |
| | | | | |
+-----------------------------------+------------------------------------------------------------------------+-------------------------------------------------+-----------------------------------------+------------------+
| Virtualizer | | Virtualizer can be used to configure surround sound. | modules/processing/Virtualizer | MS-IIR Filter, Limiter | | Binary |
| | | | | | 32-bit ARM |
| | | | | |
| | | | | |
| | | | | |
| | | | | |
| | | | | |
| | | | | |
+-----------------------------------+------------------------------------------------------------------------+-------------------------------------------------+-----------------------------------------+------------------+
| Gain | | The Gain module is used to increase and decrease the volume of | modules/processing/volume_control/capi/gain | None | Source |
| | | streams. The layout for both gain and volume control is a little bit | | | |
| | | different. The build file for gain can be found under | | | |
Expand Down
Loading
Loading