Audio: PCM converter: Add support for A-law and mu-law #9980

singalsu · 2025-04-30T15:30:34Z

As summary this adds to math library A-law and mu-law conversions. Adds to copier conversions from these to/from s32, adds checks to IPC4 to SOF types mapping, adds a nocodec topology to test these formats plus uint8_t sample type.

tools/topology/topology2/cavs-mixin-mixout-hda.conf

Copilot

Pull Request Overview

This PR adds support for both A-law and mu-law codecs, including new source and header files, test cases, and updates to format conversion and PCM converter functions.

Added tests and codec implementations for mu-law and A-law encoding/decoding.
Updated audio format conversion functions and PCM converter mappings to handle the new codec types.
Updated IPC stream and module configuration headers to include new codec types.

Reviewed Changes

Copilot reviewed 18 out of 26 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
test/cmocka/src/math/arithmetic/{a_law_codec, mu_law_codec}.c	New test files for A-law and mu-law codecs.
src/math/{a_law.c, mu_law.c}	New codec implementations following ITU-T G.711 standard.
src/include/sof/math/{a_law.h, mu_law.h}	Public API headers for new codecs.
src/include/module/{ipc4/base-config.h, ipc/stream.h}	Extended enums to include A-law and mu-law types.
src/include/module/audio/format.h	Added new cases for A-law and mu-law in sample byte/bit depth functions.
src/audio/pcm_converter/pcm_converter_generic.c	Added new PCM conversion functions for A-law and mu-law.
src/audio/copier/copier_host.c	Updated error handling to reflect new audio format conversion returns.
src/include/sof/audio/audio_stream.h	Updated format conversion function to handle new codec types.

Files not reviewed (8)

app/boards/intel_adsp_cavs25.conf: Language not supported
src/audio/Kconfig: Language not supported
src/math/CMakeLists.txt: Language not supported
src/math/Kconfig: Language not supported
test/cmocka/m/export_headerfile_open.m: Language not supported
test/cmocka/src/math/arithmetic/CMakeLists.txt: Language not supported
test/cmocka/src/math/arithmetic/a_law_mu_law_test_vectors.m: Language not supported
tools/topology/topology2/cavs-nocodec.conf: Language not supported

src/include/sof/audio/audio_stream.h

kv2019i

Looks great. Not pressing +1 as you have the "Do not merge" commit in the series, but no blockers. Some minor notes on Kconfig and double-check on the IPC4 ABI extension.

kv2019i · 2025-05-15T10:26:51Z

src/math/Kconfig


+config MATH_A_LAW_CODEC
+	bool "A-law encoder and decoder"
+	default n


"default n" is superfluous, can be omitted https://docs.zephyrproject.org/latest/build/kconfig/tips.html#redundant-defaults

Thanks, I've fixed those all now (actually in previous push but forgot to update here).

kv2019i · 2025-05-15T10:28:24Z

src/math/Kconfig


+config MATH_MU_LAW_CODEC
+	bool "mu-law encoder and decoder"
+	default n


Ditto here.

kv2019i · 2025-05-15T10:29:22Z

src/audio/Kconfig


+config FORMAT_A_LAW
+	bool "Support A-law"
+	default n


kv2019i · 2025-05-15T10:29:31Z

src/audio/Kconfig


+config PCM_CONVERTER_FORMAT_A_LAW
+	bool "Support A-law"
+	default n


kv2019i · 2025-05-15T10:31:21Z

src/include/module/ipc/stream.h

 	SOF_IPC_FRAME_U8,
-	SOF_IPC_FRAME_S16_4LE		/* 16-bit in 32-bit container */
+	SOF_IPC_FRAME_S16_4LE,		/* 16-bit in 32-bit container */
+	SOF_IPC_FRAME_A_LAW,


Just to double check, is this in sync with Intel reference?

I have an internal email thread started, should mark those as reserved there to avoid future conflict.

This is now agreed with the reference.

kv2019i · 2025-05-15T10:31:44Z

src/audio/Kconfig


+config PCM_CONVERTER_FORMAT_MU_LAW
+	bool "Support mu-law"
+	default n


singalsu · 2025-05-15T11:51:42Z

Looks great. Not pressing +1 as you have the "Do not merge" commit in the series, but no blockers. Some minor notes on Kconfig and double-check on the IPC4 ABI extension.

Thanks for review, fixing those! I fixed also one missing header include seen from sparse build. I'll still push once more with kconfigs enabled to better see CI results for on/off configured. If it looks good, I'll remove the cavs25 kconfigs enable commit. Need to check later where to enable these (plus float format add) for testing.

singalsu · 2025-05-15T13:54:39Z

Note: Failures like this with nocodec are due to missing kernel support (thesofproject/linux#5401) while topology lists U8 as a supported format:

2025-05-15 10:53:29 UTC [REMOTE_INFO] check the PCMs before alsabat test
aplay: set_params:1416: Unable to install hw params:
ACCESS:  RW_INTERLEAVED
FORMAT:  U8

lyakh · 2025-05-20T07:03:30Z

src/math/a_law.c

+	uint8_t byte;
+
+	/* Convert to 13 bits with shift */
+	sample = sample >> 3;


sample >>= 3

lyakh · 2025-05-20T07:18:00Z

src/math/mu_law.c

+	uint8_t byte;
+
+	/* Convert to 14 bits with shift */
+	sample = sample >> 2;


lyakh · 2025-05-20T07:26:09Z

src/audio/pcm_converter/pcm_converter_generic.c

+				    uint32_t ioffset, struct audio_stream *sink,
+				    uint32_t ooffset, uint32_t samples, uint32_t chmap)
+{
+	uint8_t *src = audio_stream_get_rptr(source);


in general - source pointers probably can be const? Might also give the compiler a clue for some slight optimisations here and there. Would be good to use everywhere

Yep, added to mu_law and previous a_law

lyakh · 2025-05-20T07:31:03Z

src/audio/copier/copier_host.c

+	ret = audio_stream_fmt_conversion(copier_cfg->base.audio_fmt.depth,
+					  copier_cfg->base.audio_fmt.valid_bit_depth,
+					  &in_frame_fmt, &in_valid_fmt,
+					  copier_cfg->base.audio_fmt.s_type);


should there be a notification to the host in case of such errors? We have them now, but should be rate-limited...

I don't know how to do it, but I think already this is a large improvement to previous. But I added SOF_IPC_FRAME_INVALID as default for this function. Then functions those do not handle the return value (a lot of them, and also void functions themselves) will fail with formats those can't be supported.

This patch adds to math library functions sofm_a_law_encode() and sofm_a_law_decode(). The main usage is support for VoIP and 8-bit A-law encoded wav files support. Signed-off-by: Seppo Ingalsuo <seppo.ingalsuo@linux.intel.com>

singalsu · 2025-05-20T14:48:53Z

Note, still the don't merge patch included. I'll check CI and then remove it in next push. I think I need to remove also the topology patch for nocodec and submit it later when kernel work is merged.

lyakh · 2025-05-22T06:18:07Z

src/math/mu_law.c

+}
+
+/**
+ * sofm_mu_law_decode() - Decode A-law encoded code word


lyakh · 2025-05-22T06:19:32Z

src/math/mu_law.c

+};
+
+/**
+ * sofm_mu_law_encode() - Encode sample with A-law coding


mu-law I suppose

Oops, thanks! It's fixed now, and there was one more in addition to these.

This patch adds to math library functions sofm_mu_law_encode() and sofm_mu_law_decode(). The main usage is support for VoIP and 8-bit mu-law encoded wav files support. Signed-off-by: Seppo Ingalsuo <seppo.ingalsuo@linux.intel.com>

This patch adds to the PCM converter functions pcm_convert_alaw_to_s32() and pcm_convert_s32_to_alaw(). The function audio_stream_fmt_conversion() is also updated to check the sample type and depth to set up correctly conversion for A-law. Signed-off-by: Seppo Ingalsuo <seppo.ingalsuo@linux.intel.com>

This patch adds to the PCM converter functions pcm_convert_mulaw_to_s32() and pcm_convert_s32_to_mulaw(). The header files with support functions are updated to handle the format. Signed-off-by: Seppo Ingalsuo <seppo.ingalsuo@linux.intel.com>

This patch re-arranges function audio_stream_fmt_conversion() to use switch-case for IPC4 sample types handling. Errors are returned for non-enabled formats and for illegal depth and valid values. The U8 format must be unsigned type. The normal s16/s24/s32 SOF types are allowed to be MSB integer, LSB integer, or signed integer as relaxed check. Currently topology uses LSB integer as default. The handling of MSB integer that is used in some parts of topologies is done elsewhere. The SOF_IPC_FRAME_INVALID is added as second error indicator. It avoids e.g. in IPC helper function use of uninitialized frame_fmt. The function audio_stream_fmt_conversion() is called from a large number of other functions without check for return code. But the components usually check their format and without a handler for it, will block processing with unsupported format. Signed-off-by: Seppo Ingalsuo <seppo.ingalsuo@linux.intel.com>

This patch adds the IPC4 sample type values to topology as preparation to later add U8, A-law, and mu-law support to host copier into e.g. nocodec topologies. The change requires also kernel support add for 8-bit formats. Signed-off-by: Seppo Ingalsuo <seppo.ingalsuo@linux.intel.com>

Signed-off-by: Seppo Ingalsuo <seppo.ingalsuo@linux.intel.com>

This patch adds Octave script to generate test data for A-law and mu-law coding. Signed-off-by: Seppo Ingalsuo <seppo.ingalsuo@linux.intel.com>

singalsu mentioned this pull request May 2, 2025

ASoC: SOF: ipc-topology: Add float and 8-bit formats thesofproject/linux#5401

Merged

singalsu force-pushed the tplg_fw_add_8bit branch 2 times, most recently from 4d240b7 to 42c1ed3 Compare May 5, 2025 15:24

singalsu force-pushed the tplg_fw_add_8bit branch 3 times, most recently from e834b3b to ef38e9e Compare May 13, 2025 17:03

singalsu commented May 14, 2025

View reviewed changes

tools/topology/topology2/cavs-mixin-mixout-hda.conf Outdated Show resolved Hide resolved

singalsu force-pushed the tplg_fw_add_8bit branch from ef38e9e to b9751ff Compare May 14, 2025 17:18

singalsu changed the title ~~Audio: PCM converter: Add support for A-law~~ Audio: PCM converter: Add support for A-law and mu-law May 15, 2025

singalsu force-pushed the tplg_fw_add_8bit branch from b9751ff to 9b0d224 Compare May 15, 2025 09:19

singalsu marked this pull request as ready for review May 15, 2025 09:20

singalsu requested review from RanderWang, abonislawski, dbaluta, jsarha, kv2019i, lbetlej, lgirdwood, mmaka1, pblaszko, plbossart and ranj063 as code owners May 15, 2025 09:20

singalsu requested a review from Copilot May 15, 2025 09:20

Copilot AI reviewed May 15, 2025

View reviewed changes

src/include/sof/audio/audio_stream.h Outdated Show resolved Hide resolved

kv2019i reviewed May 15, 2025

View reviewed changes

lyakh reviewed May 20, 2025

View reviewed changes

Math: Add functions for A-law encode and decode

f24e670

This patch adds to math library functions sofm_a_law_encode() and sofm_a_law_decode(). The main usage is support for VoIP and 8-bit A-law encoded wav files support. Signed-off-by: Seppo Ingalsuo <seppo.ingalsuo@linux.intel.com>

singalsu force-pushed the tplg_fw_add_8bit branch from 9b0d224 to eb684ec Compare May 20, 2025 14:46

singalsu requested review from kv2019i and lyakh May 21, 2025 12:17

singalsu force-pushed the tplg_fw_add_8bit branch from eb684ec to 3e410ea Compare May 21, 2025 12:28

lyakh reviewed May 22, 2025

View reviewed changes

singalsu added 7 commits May 22, 2025 11:17

Math: Add functions for mu-law encode and decode

5ce1459

This patch adds to math library functions sofm_mu_law_encode() and sofm_mu_law_decode(). The main usage is support for VoIP and 8-bit mu-law encoded wav files support. Signed-off-by: Seppo Ingalsuo <seppo.ingalsuo@linux.intel.com>

Test: Cmocka: Add unit test for A-law encode and decode

4ee60a7

Signed-off-by: Seppo Ingalsuo <seppo.ingalsuo@linux.intel.com>

Test: Cmocka: Add test vector generator for A-law and mu-law

1ecabc6

This patch adds Octave script to generate test data for A-law and mu-law coding. Signed-off-by: Seppo Ingalsuo <seppo.ingalsuo@linux.intel.com>

singalsu force-pushed the tplg_fw_add_8bit branch from 3e410ea to 1ecabc6 Compare May 22, 2025 08:26

singalsu requested a review from lyakh May 22, 2025 09:08

lyakh approved these changes May 23, 2025

View reviewed changes

lgirdwood approved these changes May 23, 2025

View reviewed changes

lgirdwood merged commit 77a2213 into thesofproject:main May 23, 2025
41 of 48 checks passed

Audio: PCM converter: Add support for A-law and mu-law #9980

Audio: PCM converter: Add support for A-law and mu-law #9980

Uh oh!

Conversation

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

Uh oh!

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!

kv2019i 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!

singalsu commented May 15, 2025

Uh oh!

singalsu commented May 15, 2025

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!

singalsu commented May 20, 2025

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!

4 participants

singalsu commented Apr 30, 2025 •

edited

Loading