Tools: Topology: Add echo reference for SDW speaker and jack #10387

singalsu · 2025-11-21T16:45:05Z

This patch adds an echo reference capture PCM for speaker and jack playback. The additions are normally disabled but can be enabled with build options SDW_JACK_ECHO_REF=true and/or SDW_SPK_ECHO_REF=true.

This depends on merge of #10329

singalsu · 2025-11-21T16:46:18Z

This PR depends on #10329 and kernel patch by @ranj063 .

singalsu · 2025-11-21T16:52:52Z

Build variants with echo reference, for both speaker and jack, just speaker, just jack, echoref but without speaker post-processing.

Echo reference for jack:

Echo reference for jack and speaker, no EQ and DRC.

Echo reference for speaker:

Echo Reference for speaker and jack, with EQ and DRC for speaker:

tools/topology/topology2/platform/intel/sdw-amp-generic.conf

tools/topology/topology2/platform/intel/sdw-jack-generic.conf

ranj063 · 2025-11-21T19:51:53Z

tools/topology/topology2/include/pipelines/cavs/siggen-host-copier-capture.conf

+			num_input_pins 1
+			num_output_pins 1
+			num_input_audio_formats 1
+			num_output_audio_formats 1


Does the host copier need to support all output formats?

Yep, all s16/24/32 and float are OK, I can add it. The 8-bit formats are not good for the purpose.

Hmm, I added the formats for objects while this is still with single output format. But for speaker that goes with default rate the output formats could be defined here instead.

lgirdwood

Can echo ref be always available in the topology and switch on/off by opening the PCM ?

singalsu · 2025-11-24T16:51:19Z

Can echo ref be always available in the topology and switch on/off by opening the PCM ?

Yep, the PCMs can be used or ignored. If there is no playback and ref capture is done, it produces silence.

lgirdwood · 2025-11-25T12:20:47Z

Can echo ref be always available in the topology and switch on/off by opening the PCM ?

Yep, the PCMs can be used or ignored. If there is no playback and ref capture is done, it produces silence.

Perfect, lets do this so its available for general usage. This would need a new PCM ID. I assume this would capture playback if the playback PCM was in use ?

singalsu · 2025-12-10T12:28:16Z

I updated the virtual DAI name to LoopbackCapture_virtual_DAI, and added build for sof-ptl-rt721-echoref.tplg.

singalsu · 2025-12-10T17:07:34Z

The virtual DAI name is shortened to "Loopback_Virtual". The previous name was too long for kernel name limit. This matches the updated thesofproject/linux#5609 .

Copilot

Pull request overview

This PR adds echo reference capture PCM functionality for SDW speaker and jack playback paths. The echo reference feature allows capturing the audio being played back, which is typically used for acoustic echo cancellation (AEC) in voice processing applications.

Key Changes:

Introduces build-time options SDW_JACK_ECHO_REF and SDW_SPK_ECHO_REF to enable echo reference capture
Adds new pipeline configuration siggen-host-copier-capture.conf for echo reference processing
Creates echo reference PCM devices with IDs 11 (jack) and 12 (speaker)

Reviewed changes

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

Show a summary per file

File	Description
tools/topology/topology2/platform/intel/sdw-jack-generic.conf	Adds jack echo reference routing and PCM configuration with module-copier insertion
tools/topology/topology2/platform/intel/sdw-amp-generic.conf	Adds speaker echo reference routing and PCM configuration with module-copier insertion
tools/topology/topology2/include/pipelines/cavs/siggen-host-copier-capture.conf	New pipeline definition for siggen-based capture used by echo reference
tools/topology/topology2/include/common/common_definitions.conf	Adds build flags for controlling echo reference features
tools/topology/topology2/development/tplg-targets.cmake	Adds new topology target with echo reference enabled
tools/topology/topology2/cavs-sdw.conf	Includes new siggen-host-copier-capture pipeline configuration

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

Copilot · 2025-12-18T10:20:18Z

tools/topology/topology2/platform/intel/sdw-amp-generic.conf

+								in_rate			$JACK_RATE
+								in_bit_depth		32
+								in_valid_bit_depth	32
+							}
+						]
+						Object.Base.output_audio_format [
+							{
+								out_rate		$JACK_RATE


The speaker echo reference configuration incorrectly uses $JACK_RATE instead of a speaker-specific rate variable. Since this is in the speaker (amp) configuration file and other parts of this file don't reference JACK_RATE, this should likely use a speaker rate constant or the rate should be omitted if it's handled by the audio format configuration.

Suggested change

in_rate $JACK_RATE

in_bit_depth 32

in_valid_bit_depth 32

}

]

Object.Base.output_audio_format [

{

out_rate $JACK_RATE

in_bit_depth 32

in_valid_bit_depth 32

}

]

Object.Base.output_audio_format [

{

That's a good point to check @singalsu from copilot. The file uses a 48000 rate at least in one of the definitions (for DAI), so not sure if JACK_RATE is correct.

OTOH, this was in the code prior to this PR, so can be done in a separate if a valid concern. Not a blocker.

I'll fix it. It's a copy & paste mistake. It would break with 96 kHz headset builds.

Copilot · 2025-12-18T10:20:18Z

tools/topology/topology2/platform/intel/sdw-amp-generic.conf

+						]
+						Object.Base.output_audio_format [
+							{
+								out_rate		$JACK_RATE


The speaker echo reference output configuration incorrectly uses $JACK_RATE. This variable is defined in the jack configuration file but not in the amp configuration, which could cause build failures or incorrect behavior. Either define a speaker-specific rate variable in this file or reference the appropriate rate constant.

kv2019i

Some comments inline, but I don't think any are real blockers.

tools/topology/topology2/include/pipelines/cavs/siggen-host-copier-capture.conf

kv2019i · 2025-12-18T13:41:31Z

tools/topology/topology2/platform/intel/sdw-amp-generic.conf

+			}
+		]
+	}
+	"true" {


@singalsu no need to change this PR, but @ranj063 @jsarha I was wondering if we started adding inline comments to there branches line the C conventions for ifdefs, would that make the nested conditional segments a bit more easy to follow. E.g. here on L702 "# PASSTHROUGH==true " and then the definition. What do you think?

I think it would be good. I'm quite confused with long chunks of stuff. And our indents also are not always right.

kv2019i · 2025-12-18T13:44:58Z

tools/topology/topology2/platform/intel/sdw-amp-generic.conf

+								in_rate			$JACK_RATE
+								in_bit_depth		32
+								in_valid_bit_depth	32
+							}
+						]
+						Object.Base.output_audio_format [
+							{
+								out_rate		$JACK_RATE


That's a good point to check @singalsu from copilot. The file uses a 48000 rate at least in one of the definitions (for DAI), so not sure if JACK_RATE is correct.

OTOH, this was in the code prior to this PR, so can be done in a separate if a valid concern. Not a blocker.

singalsu · 2025-12-19T10:19:27Z

Updates: I removed the $JACK_RATE from speaker pipelines. Also I moved the basic host-copier output formats to class definition, so they don't need to be repeated for speaker. Same also for formats for siggen.

Also I tried to remove some formats definition stuff from virtual DAI to reduce tplg code amount but seems it's needed. Kernel parsed it but the formats appeared as 0 Hz and 0 bit, so I felt it wasn't safe to do.

Copilot

Pull request overview

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

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

tools/topology/topology2/include/pipelines/cavs/siggen-host-copier-capture.conf

tools/topology/topology2/platform/intel/sdw-amp-generic.conf

This patch adds an echo reference capture PCM for speaker and jack playback. The additions are normally disabled but can be enabled with build options SDW_JACK_ECHO_REF=true and/or SDW_SPK_ECHO_REF=true. Signed-off-by: Seppo Ingalsuo <[email protected]>

This patch builds into development directory a version of the topology with echo reference for jack and speaker. The topology name is sof-ptl-rt721-echoref.tplg. Signed-off-by: Seppo Ingalsuo <[email protected]>

Copilot

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.

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

Copilot · 2025-12-19T10:51:39Z

tools/topology/topology2/platform/intel/sdw-jack-generic.conf

+						num_output_audio_formats 1
+						Object.Base.input_audio_format [
+							{
+								in_rate			$JACK_RATE


The in_rate field is missing in the alh-copier input_audio_format block (line 627), while it's present in the output_audio_format block (line 634). For consistency and completeness, consider adding the in_rate field here as it is defined in the module-copier blocks (lines 652, 708).

You are blind.

Copilot · 2025-12-19T10:51:40Z

tools/topology/topology2/platform/intel/sdw-amp-generic.conf

+						in_bit_depth		32
+						in_valid_bit_depth	$SDW_LINK_VALID_BITS
+						in_sample_type		$SAMPLE_TYPE_MSB_INTEGER
+						in_fmt_cfg		"$[($in_channels | ($in_valid_bit_depth * 256))]"


The alh-copier input_audio_format block (lines 936-939) is missing the in_rate field, while the output_audio_format block at line 944 includes out_bit_depth and out_valid_bit_depth. For consistency with the jack configuration and to ensure complete audio format specification, consider adding the in_rate field.

Suggested change

in_fmt_cfg "$[($in_channels | ($in_valid_bit_depth * 256))]"

in_fmt_cfg "$[($in_channels | ($in_valid_bit_depth * 256))]"

in_rate 48000

We operate the speaker pipelines with the default rate (48 kHz) from classes. It should be added everywhere in the large topology fragment, so not doing it unless we add other rates options for speaker.

Copilot · 2025-12-19T10:51:40Z

tools/topology/topology2/platform/intel/sdw-amp-generic.conf

+				]
+				Object.Base.output_audio_format [
+					{
+						out_bit_depth		32


The output_audio_format block (lines 944-945) is missing the out_rate field. For consistency with the jack configuration (line 634) and completeness of the audio format specification, consider adding the out_rate field.

Suggested change

out_bit_depth 32

out_bit_depth 32

out_rate 48000

Same, not adding rates to speaker.

singalsu force-pushed the tplg_sdw_copier_echo_ref branch from 482b7a0 to 15a0e37 Compare November 21, 2025 16:56

singalsu commented Nov 21, 2025

View reviewed changes

tools/topology/topology2/platform/intel/sdw-amp-generic.conf Show resolved Hide resolved

tools/topology/topology2/platform/intel/sdw-amp-generic.conf Outdated Show resolved Hide resolved

tools/topology/topology2/platform/intel/sdw-jack-generic.conf Outdated Show resolved Hide resolved

ranj063 reviewed Nov 21, 2025

View reviewed changes

singalsu force-pushed the tplg_sdw_copier_echo_ref branch from 15a0e37 to 523ee9d Compare November 24, 2025 14:42

lgirdwood reviewed Nov 24, 2025

View reviewed changes

singalsu mentioned this pull request Dec 2, 2025

Add support for hostless and DAIless pipelines thesofproject/linux#5609

Open

singalsu force-pushed the tplg_sdw_copier_echo_ref branch from 523ee9d to 12d8f3b Compare December 10, 2025 12:26

singalsu force-pushed the tplg_sdw_copier_echo_ref branch from 12d8f3b to f3ab66b Compare December 10, 2025 17:03

singalsu marked this pull request as ready for review December 18, 2025 10:19

singalsu requested a review from jsarha as a code owner December 18, 2025 10:19

singalsu requested review from Copilot, kv2019i and udaymb December 18, 2025 10:19

Copilot AI reviewed Dec 18, 2025

View reviewed changes

singalsu force-pushed the tplg_sdw_copier_echo_ref branch from f3ab66b to ba1400c Compare December 18, 2025 12:23

kv2019i approved these changes Dec 18, 2025

View reviewed changes

singalsu force-pushed the tplg_sdw_copier_echo_ref branch from ba1400c to ce622a7 Compare December 19, 2025 10:17

singalsu requested review from Copilot, lgirdwood and ranj063 December 19, 2025 10:19

Copilot AI reviewed Dec 19, 2025

View reviewed changes

tools/topology/topology2/include/pipelines/cavs/siggen-host-copier-capture.conf Outdated Show resolved Hide resolved

tools/topology/topology2/platform/intel/sdw-amp-generic.conf Show resolved Hide resolved

singalsu added 2 commits December 19, 2025 12:48

Tools: Topology: Enable echo reference for sof-ptl-rt721-4ch.tplg

78e231d

This patch builds into development directory a version of the topology with echo reference for jack and speaker. The topology name is sof-ptl-rt721-echoref.tplg. Signed-off-by: Seppo Ingalsuo <[email protected]>

singalsu force-pushed the tplg_sdw_copier_echo_ref branch from ce622a7 to 78e231d Compare December 19, 2025 10:49

singalsu requested a review from Copilot December 19, 2025 10:50

Copilot AI reviewed Dec 19, 2025

View reviewed changes

lgirdwood approved these changes Dec 19, 2025

View reviewed changes

lgirdwood merged commit 04076c4 into thesofproject:main Dec 19, 2025
42 of 43 checks passed

	in_fmt_cfg "$[($in_channels \| ($in_valid_bit_depth * 256))]"
	in_fmt_cfg "$[($in_channels \| ($in_valid_bit_depth * 256))]"
	in_rate 48000

Tools: Topology: Add echo reference for SDW speaker and jack #10387

Tools: Topology: Add echo reference for SDW speaker and jack #10387

Uh oh!

Conversation

singalsu commented Nov 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

singalsu commented Nov 21, 2025

Uh oh!

singalsu commented Nov 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ranj063 Nov 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

lgirdwood left a comment

Choose a reason for hiding this comment

Uh oh!

singalsu commented Nov 24, 2025

Uh oh!

lgirdwood commented Nov 25, 2025

Uh oh!

singalsu commented Dec 10, 2025

Uh oh!

singalsu commented Dec 10, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Dec 18, 2025

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!

Copilot AI Dec 18, 2025

Choose a reason for hiding this comment

Uh oh!

kv2019i left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

singalsu 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

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Dec 19, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 19, 2025

singalsu commented Nov 21, 2025 •

edited

Loading

singalsu commented Nov 21, 2025 •

edited

Loading

ranj063 Nov 21, 2025 •

edited

Loading

singalsu Dec 18, 2025 •

edited

Loading

singalsu commented Dec 19, 2025 •

edited

Loading