lib: pcm_mix: Moved PCM mix from application

koffes · greg-fer · rlubos · commit 841a7805c02e · 2022-12-20T17:06:58.000+01:00
Tests and code moved from applications: nrf5340_audio

Signed-off-by: Kristoffer Rist Skøien &lt;kristoffer.skoien@nordicsemi.no&gt;
Co-authored-by: Grzegorz Ferenc &lt;Grzegorz.Ferenc@nordicsemi.no&gt;
diff --git a/.github/test-spec.yml b/.github/test-spec.yml
@@ -44,6 +44,7 @@
   - "boards/arm/nrf5340_audio_dk_nrf5340/**/*"
   - "tests/nrf5340_audio/**/*"
   - "tests/lib/contin_array/**/*"
+  - "tests/lib/pcm_mix/**/*"
 
 "CI-iot-samples-test":
   - "include/modem/at_monitor.h"
diff --git a/CODEOWNERS b/CODEOWNERS
@@ -116,6 +116,7 @@ Kconfig*                                  @tejlmand
 /lib/modem_jwt/                           @jayteemo @SeppoTakalo
 /lib/modem_attest_token/                  @jayteemo
 /lib/qos/                                 @simensrostad
+/lib/pcm_mix/                             @koffes @alexsven @erikrobstad @rick1082 @gWacey
 /lib/contin_array/                        @koffes @alexsven @erikrobstad @rick1082 @gWacey
 /modules/                                 @tejlmand
 /modules/mcuboot/                         @de-nordic @nordicjm
diff --git a/applications/nrf5340_audio/Kconfig.defaults b/applications/nrf5340_audio/Kconfig.defaults
@@ -69,11 +69,14 @@ config CONTIN_ARRAY
 	bool
 	default y
 
-# I2S
 config NRFX_I2S
 	bool
 	default y
 
+config PCM_MIX
+	bool
+	default y
+
 # Enable NRFX_CLOCK for ACLK control
 config NRFX_CLOCK
 	bool
diff --git a/applications/nrf5340_audio/src/utils/CMakeLists.txt b/applications/nrf5340_audio/src/utils/CMakeLists.txt
@@ -12,5 +12,4 @@ target_sources(app PRIVATE
 	       ${CMAKE_CURRENT_SOURCE_DIR}/pcm_stream_channel_modifier.c
 	       ${CMAKE_CURRENT_SOURCE_DIR}/tone.c
 	       ${CMAKE_CURRENT_SOURCE_DIR}/uicr.c
-		   ${CMAKE_CURRENT_SOURCE_DIR}/pcm_mix.c
 )
diff --git a/applications/nrf5340_audio/src/utils/Kconfig b/applications/nrf5340_audio/src/utils/Kconfig
@@ -60,10 +60,6 @@ module = FW_INFO
 module-str = fw-info
 source "subsys/logging/Kconfig.template.log_config"
 
-module = PCM_MIX
-module-str = pcm-mix
-source "subsys/logging/Kconfig.template.log_config"
-
 module = PSCM
 module-str = pscm
 source "subsys/logging/Kconfig.template.log_config"
diff --git a/applications/nrf5340_audio/src/utils/pcm_mix.h b/applications/nrf5340_audio/src/utils/pcm_mix.h
diff --git a/doc/nrf/libraries/others/pcm_mix.rst b/doc/nrf/libraries/others/pcm_mix.rst
@@ -0,0 +1,34 @@
+.. _lib_pcm_mix:
+
+Pulse Code Modulation audio mixer
+#################################
+
+.. contents::
+   :local:
+   :depth: 2
+
+The Pulse Code Modulation (PCM) audio mixer lets you mix a PCM stream into another PCM stream.
+It can for example be useful for mixing a tone and an audio stream together.
+This library is useful for developing applications that offer audio features, for example using the nRF5340 Audio DK.
+
+
+The library offers the following types of mixing support:
+
+* Stereo stream into another stereo stream
+* Combinations of mono to mono
+* Mono to stereo: channel left or right or left+right
+
+Configuration
+*************
+
+To enable the library, set the :kconfig:option:`CONFIG_PCM_MIX` Kconfig option to ``y`` in the project configuration file :file:`prj.conf`.
+
+API documentation
+*****************
+
+| Header file: :file:`include/pcm_mix.h`
+| Source file: :file:`lib/pcm_mix/pcm_mix.c`
+
+.. doxygengroup:: pcm_mix
+   :project: nrf
+   :members:
diff --git a/doc/nrf/releases/release-notes-changelog.rst b/doc/nrf/releases/release-notes-changelog.rst
@@ -378,6 +378,11 @@ Other libraries
     It is replaced by the Trusted Firmware-M (TF-M) as the supported trusted execution solution.
     See :ref:`Trusted Firmware-M (TF-M) <ug_tfm>` for more information about the TF-M.
 
+* PCM Mix:
+
+  * PCM mix (Pulse Code Modulation) audio mixer has been moved out of the nRF5340 Audio
+    application, and into lib/pcm_mix.
+
 Common Application Framework (CAF)
 ----------------------------------
 
diff --git a/include/pcm_mix.h b/include/pcm_mix.h
@@ -0,0 +1,58 @@
+/*
+ * Copyright (c) 2022 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+ */
+
+/**
+ * @file
+ * @brief PCM audio mixer library header.
+ */
+
+#ifndef _PCM_MIX_H_
+#define _PCM_MIX_H_
+
+#include <zephyr/kernel.h>
+
+/**
+ * @defgroup pcm_mix Pulse Code Modulation mixer
+ * @brief Pulse Code Modulation audio mixer library.
+ *
+ * @{
+ */
+
+enum pcm_mix_mode {
+	B_STEREO_INTO_A_STEREO,
+	B_MONO_INTO_A_MONO,
+	B_MONO_INTO_A_STEREO_LR,
+	B_MONO_INTO_A_STEREO_L,
+	B_MONO_INTO_A_STEREO_R,
+};
+
+/**
+ * @brief Mixes two buffers of PCM data.
+ *
+ * @note Uses simple addition with hard clip protection.
+ * Input can be mono or stereo as long as the inputs match.
+ * By selecting the mix mode, mono can also be mixed into a stereo buffer.
+ * Hard coded for the signed 16-bit PCM.
+ *
+ * @param pcm_a         [in/out] Pointer to the PCM data buffer A.
+ * @param size_a        [in]     Size of the PCM data buffer A (in bytes).
+ * @param pcm_b         [in]     Pointer to the PCM data buffer B.
+ * @param size_b        [in]     Size of the PCM data buffer B (in bytes).
+ * @param mix_mode      [in]     Mixing mode according to pcm_mix_mode.
+ *
+ * @retval 0            Success. Result stored in pcm_a.
+ * @retval -EINVAL      pcm_a is NULL or size_a = 0.
+ * @retval -EPERM       Either size_b < size_a (for stereo to stereo, mono to mono)
+ *			or size_a/2 < size_b (for mono to stereo mix).
+ * @retval -ESRCH       Invalid mixing mode.
+ */
+int pcm_mix(void *const pcm_a, size_t size_a, void const *const pcm_b, size_t size_b,
+	    enum pcm_mix_mode mix_mode);
+
+/**
+ * @}
+ */
+#endif /* _PCM_MIX_H_ */
diff --git a/lib/CMakeLists.txt b/lib/CMakeLists.txt
@@ -41,3 +41,4 @@ add_subdirectory_ifdef(CONFIG_QOS qos)
 add_subdirectory_ifdef(CONFIG_IDENTITY_KEY identity_key)
 add_subdirectory_ifdef(CONFIG_SFLOAT sfloat)
 add_subdirectory_ifdef(CONFIG_CONTIN_ARRAY contin_array)
+add_subdirectory_ifdef(CONFIG_PCM_MIX pcm_mix)
diff --git a/lib/Kconfig b/lib/Kconfig
@@ -42,5 +42,6 @@ rsource "qos/Kconfig"
 rsource "identity_key/Kconfig"
 rsource "sfloat/Kconfig"
 rsource "contin_array/Kconfig"
+rsource "pcm_mix/Kconfig"
 
 endmenu
diff --git a/lib/pcm_mix/CMakeLists.txt b/lib/pcm_mix/CMakeLists.txt
@@ -0,0 +1,12 @@
+#
+# Copyright (c) 2022 Nordic Semiconductor
+#
+# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+#
+
+zephyr_library()
+zephyr_library_sources(
+	pcm_mix.c
+)
+
+zephyr_include_directories(.)
diff --git a/lib/pcm_mix/Kconfig b/lib/pcm_mix/Kconfig
@@ -0,0 +1,17 @@
+# Copyright (c) 2022 Nordic Semiconductor
+#
+# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+#
+
+menuconfig PCM_MIX
+	bool "PCM - Pulse Code Modulation mix library"
+	help
+	  Library for mixing multiple audio streams
+
+if PCM_MIX
+
+module = PCM_MIX
+module-str = pcm-mix
+source "${ZEPHYR_BASE}/subsys/logging/Kconfig.template.log_config"
+
+endif #PCM_MIX
diff --git a/lib/pcm_mix/pcm_mix.c b/lib/pcm_mix/pcm_mix.c
diff --git a/tests/lib/pcm_mix/CMakeLists.txt b/tests/lib/pcm_mix/CMakeLists.txt
@@ -0,0 +1,13 @@
+#
+# Copyright (c) 2020 Nordic Semiconductor ASA
+#
+# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+#
+
+cmake_minimum_required(VERSION 3.20.0)
+
+find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})
+project(pcm_mix)
+
+FILE(GLOB app_sources src/*.c)
+target_sources(app PRIVATE ${app_sources})
diff --git a/tests/lib/pcm_mix/Kconfig b/tests/lib/pcm_mix/Kconfig
diff --git a/tests/lib/pcm_mix/prj.conf b/tests/lib/pcm_mix/prj.conf
@@ -1,2 +1,3 @@
 CONFIG_ZTEST=y
 CONFIG_IRQ_OFFLOAD=y
+CONFIG_PCM_MIX=y
diff --git a/tests/lib/pcm_mix/src/main.c b/tests/lib/pcm_mix/src/main.c
diff --git a/tests/lib/pcm_mix/testcase.yaml b/tests/lib/pcm_mix/testcase.yaml
diff --git a/tests/nrf5340_audio/pcm_mix/CMakeLists.txt b/tests/nrf5340_audio/pcm_mix/CMakeLists.txt
diff --git a/tests/nrf5340_audio/pcm_stream_channel_modifier/Kconfig b/tests/nrf5340_audio/pcm_stream_channel_modifier/Kconfig
@@ -1,10 +1,6 @@
 # Copyright (c) 2022 Nordic Semiconductor ASA
 # SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 
-module = PCM_MIX
-module-str = pcm-mix
-source "subsys/logging/Kconfig.template.log_config"
-
 module = PSCM
 module-str = pscm
 source "subsys/logging/Kconfig.template.log_config"

Original file line number	Diff line number	Diff line change
`@@ -12,5 +12,4 @@ target_sources(app PRIVATE`
`12`	`12`	`${CMAKE_CURRENT_SOURCE_DIR}/pcm_stream_channel_modifier.c`
`13`	`13`	`${CMAKE_CURRENT_SOURCE_DIR}/tone.c`
`14`	`14`	`${CMAKE_CURRENT_SOURCE_DIR}/uicr.c`
`15`		`- ${CMAKE_CURRENT_SOURCE_DIR}/pcm_mix.c`
`16`	`15`	`)`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
`1`	`1`	`CONFIG_ZTEST=y`
`2`	`2`	`CONFIG_IRQ_OFFLOAD=y`
	`3`	`+CONFIG_PCM_MIX=y`