Add aec_process_frame() to lib_aec #439

shuchitak · 2025-12-19T11:24:29Z

Pending and will be part of future PRs -

Potential cleanup of the aec_init() and aec_process_frame() API.
Having task distribution schedules for commonly used configs be a part of lib_aec
lib_aec related doc updates
xcommon_cmake support to lib_aec
Unifying fwk_voice_example_bare_metal_aec_1_thread and fwk_voice_example_bare_metal_aec_2_thread examples
lib_aec still compiled as static lib since needed by CFFI tests. Move the compiling as a static lib into the test directory

Copilot

Pull request overview

This PR refactors the AEC (Acoustic Echo Cancellation) library to add a unified aec_process_frame() function that supports variable numbers of threads (1-3) through a task distribution parameter. The major changes include:

Replacing aec_api.h with aec.h as the main public API header
Adding aec_process_frame() function to replace thread-specific implementations (aec_process_frame_1thread, aec_process_frame_2threads)
Refactoring the task distribution scheme to support dynamic thread counts
Converting AEC from a static library to an interface library
Moving global state (X_energy_recalc_bin) into shared state structure

Reviewed changes

Copilot reviewed 74 out of 75 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
test/shared/python/generate_task_distribution_scheme.py	Updated script to generate new task distribution format with thread_count and passes fields
modules/lib_aec/api/aec.h	New main API header replacing aec_api.h with simplified public interface
modules/lib_aec/api/aec_defines.h	Added conditional inclusion of aec_config.h and default values for AEC_MAX_Y_CHANNELS, AEC_MAX_X_CHANNELS
modules/lib_aec/api/aec_schedule.h	Refactored task distribution structures with renamed types and dynamic sizing
modules/lib_aec/api/aec_state.h	Updated state structures to use AEC_MAX_* defines, added X_energy_recalc_bin to shared state
modules/lib_aec/src/aec_process_frame.c	Major refactoring to support variable thread counts with PAR_THREADS_PJOBS macro
modules/lib_aec/src/aec_priv.h	Moved public API functions from aec_api.h, added documentation
test/lib_aec/*/CMakeLists.txt	Removed aec_task_distribution.h from autogenerated includes, added aec_conf_h_exists define
test/lib_aec/aec_unit_tests/src/*.c	Updated includes from aec_defines.h/aec_api.h to aec.h
examples/bare-metal//.c	Updated to use aec_process_frame() with tdist parameter instead of thread-specific functions

Based on my review, all changes appear to be straightforward refactoring with trailing whitespace cleanup. The code maintains backward compatibility through the configuration system and properly handles the multi-threading scenarios. No critical issues were identified.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

test/shared/python/generate_task_distribution_scheme.py

uvvpavel

Some comments, but all looks great!

uvvpavel · 2026-01-07T14:40:53Z

modules/lib_aec/api/aec_state.h

     * aec_init() gets called with.*/
    unsigned num_x_channels;
+
+    unsigned X_energy_recalc_bin;


Does this need to be documented?

uvvpavel · 2026-01-07T14:47:56Z

CMakeLists.txt


    ## Compile flags for C/C++ for all apps (for all platforms)
-    list(APPEND   COMPILE_FLAGS        -Os -MMD -g)
+    #list(APPEND   COMPILE_FLAGS        -Os -MMD -g)


I think this line can be removed

uvvpavel · 2026-01-07T14:49:37Z

CHANGELOG.rst

+  * ADDED: `aec_process_frame()` to `lib_aec`
+  * ADDED: AEC memory pool structs (`aec_memory_pool_t` and `aec_shadow_filt_memory_pool_t`) to `lib_aec`


I think it's worth mentioning that aec_api.h has been moved to aec.h

uvvpavel · 2026-01-07T15:05:28Z

modules/lib_aec/CMakeLists.txt

Do we still use the static library anywhere? If not, I would suggest removing it and renaming the interface cmake target to the original name

We use it for the cffi tests. It needs to link to a proper .a

uvvpavel · 2026-01-07T15:05:52Z

examples/bare-metal/pipeline_multi_threaded/CMakeLists.txt

        fwk_voice::agc
        fwk_voice::ic
-        fwk_voice::example::aec2thread
+        fwk_voice::aec


aec is already linked here

thanks! fixed everywhere

uvvpavel · 2026-01-07T15:06:04Z

examples/bare-metal/pipeline_single_threaded/CMakeLists.txt

        fwk_voice::agc
        fwk_voice::ic
-        fwk_voice::example::aec1thread
+        fwk_voice::aec


aec is already linked here

uvvpavel · 2026-01-07T15:06:37Z

examples/bare-metal/pipeline_single_threaded/CMakeLists.txt

            "-report"
            "${CONFIG_XSCOPE_PATH}/config.xscope")
-elseif(${CMAKE_SYSTEM_NAME} STREQUAL "Darwin")
+elseif(NOT ${CMAKE_SYSTEM_NAME} STREQUAL "Darwin")


Didn't look too closesly but I hope you know what you're doing here, same in the next instance

uvvpavel · 2026-01-07T15:06:51Z

test/lib_adec/de_unit_tests/CMakeLists.txt

            fwk_voice::test::shared::test_utils
            fwk_voice::test::shared::unity
-            fwk_voice::example::aec1thread)
+            fwk_voice::aec)


aec is already linked here

uvvpavel · 2026-01-07T15:07:07Z

test/lib_adec/test_wav_adec/CMakeLists.txt

        fwk_voice::aec
        fwk_voice::adec
-        fwk_voice::example::aec1thread
+        fwk_voice::aec


aec is already linked here

uvvpavel · 2026-01-07T15:07:26Z

test/lib_aec/aec_unit_tests/CMakeLists.txt

            fwk_voice::test::shared::test_utils
            fwk_voice::test::shared::unity
-            fwk_voice::example::aec1thread)
+            fwk_voice::aec)


aec is already linked here

- Move aec_memory_pool into lib_aec. As a result lib_aec is now an interface (and not static) library, with the AEC_MAX_Y_CHANNELS, AEC_MAX_X_CHANNELS, AEC_MAIN_FILTER_PHASES and AEC_SHADOW_FILTER_PHASES overridable by the application. - Add aec_task_distribution_t to lib_aec and extend aec_process_frame() to accept the schedule as a const aec_task_distribution_t* pointer. - Remove fwk_voice::example::aec_process_frame target - Remove linking to libm from example and test CMakeLists.txt

shuchitak force-pushed the better_aec_api branch from c2a6e17 to cefc053 Compare December 19, 2025 11:26

shuchitak marked this pull request as ready for review December 19, 2025 11:26

shuchitak marked this pull request as draft December 19, 2025 11:27

shuchitak force-pushed the better_aec_api branch 8 times, most recently from beaf15b to 2d38521 Compare December 19, 2025 20:23

shuchitak force-pushed the better_aec_api branch 19 times, most recently from e58df07 to 21e2318 Compare January 7, 2026 13:20

shuchitak force-pushed the better_aec_api branch 2 times, most recently from 61e0616 to b71dc5a Compare January 7, 2026 13:29

shuchitak changed the title ~~Add generic aec_process_frame() that can work for upto a max number o…~~ Add aec_process_frame() to lib_aec Jan 7, 2026

shuchitak requested a review from Copilot January 7, 2026 13:29

Copilot started reviewing on behalf of shuchitak January 7, 2026 13:30 View session

Copilot AI reviewed Jan 7, 2026

View reviewed changes

test/shared/python/generate_task_distribution_scheme.py Show resolved Hide resolved

test/shared/python/generate_task_distribution_scheme.py Show resolved Hide resolved

shuchitak force-pushed the better_aec_api branch 2 times, most recently from 2ebc8a5 to 8000ac0 Compare January 7, 2026 13:42

shuchitak requested a review from uvvpavel January 7, 2026 13:43

uvvpavel approved these changes Jan 7, 2026

View reviewed changes

shuchitak force-pushed the better_aec_api branch from 47b75f0 to ee8322d Compare January 7, 2026 15:39

shuchitak marked this pull request as ready for review January 7, 2026 15:39

uvvpavel mentioned this pull request Jan 7, 2026

Aec process frame #431

Closed

shuchitak force-pushed the better_aec_api branch from ee8322d to 4dc8957 Compare January 7, 2026 16:44

shuchitak merged commit a5c84aa into xmos:develop Jan 8, 2026
2 checks passed

shuchitak deleted the better_aec_api branch January 8, 2026 08:58

		* ADDED: `aec_process_frame()` to `lib_aec`
		* ADDED: AEC memory pool structs (`aec_memory_pool_t` and `aec_shadow_filt_memory_pool_t`) to `lib_aec`

Add aec_process_frame() to lib_aec #439

Add aec_process_frame() to lib_aec #439

Conversation

shuchitak commented Dec 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

uvvpavel left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

shuchitak commented Dec 19, 2025 •

edited

Loading