applications: nrf5340_audio: Moved contin_array

koffes · greg-fer · rlubos · commit 07201b664c99 · 2022-12-20T09:11:53.000+01:00
Tests and code moved.

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
@@ -43,6 +43,7 @@
   - "applications/nrf5340_audio/**/*"
   - "boards/arm/nrf5340_audio_dk_nrf5340/**/*"
   - "tests/nrf5340_audio/**/*"
+  - "tests/lib/contin_array/**/*"
 
 "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/contin_array/                        @koffes @alexsven @erikrobstad @rick1082 @gWacey
 /modules/                                 @tejlmand
 /modules/mcuboot/                         @de-nordic @nordicjm
 /modules/cjson/                           @simensrostad @plskeggs @sigvartmh
diff --git a/applications/nrf5340_audio/Kconfig.defaults b/applications/nrf5340_audio/Kconfig.defaults
@@ -65,6 +65,10 @@ config SENSOR
 	bool
 	default y
 
+config CONTIN_ARRAY
+	bool
+	default y
+
 # I2S
 config NRFX_I2S
 	bool
diff --git a/applications/nrf5340_audio/src/utils/CMakeLists.txt b/applications/nrf5340_audio/src/utils/CMakeLists.txt
@@ -7,7 +7,6 @@
 target_sources(app PRIVATE
 	       ${CMAKE_CURRENT_SOURCE_DIR}/board_version.c
 	       ${CMAKE_CURRENT_SOURCE_DIR}/channel_assignment.c
-	       ${CMAKE_CURRENT_SOURCE_DIR}/contin_array.c
 	       ${CMAKE_CURRENT_SOURCE_DIR}/data_fifo.c
 	       ${CMAKE_CURRENT_SOURCE_DIR}/error_handler.c
 	       ${CMAKE_CURRENT_SOURCE_DIR}/pcm_stream_channel_modifier.c
diff --git a/applications/nrf5340_audio/src/utils/Kconfig b/applications/nrf5340_audio/src/utils/Kconfig
@@ -48,10 +48,6 @@ module = CHAN_ASSIGNMENT
 module-str = chan-assignment
 source "subsys/logging/Kconfig.template.log_config"
 
-module = CONTIN_ARRAY
-module-str = contin-array
-source "subsys/logging/Kconfig.template.log_config"
-
 module = DATA_FIFO
 module-str = data-fifo
 source "subsys/logging/Kconfig.template.log_config"
diff --git a/applications/nrf5340_audio/src/utils/contin_array.h b/applications/nrf5340_audio/src/utils/contin_array.h
diff --git a/doc/nrf/libraries/others/contin_array.rst b/doc/nrf/libraries/others/contin_array.rst
@@ -0,0 +1,29 @@
+.. _lib_contin_array:
+
+Continuous array
+################
+
+.. contents::
+   :local:
+   :depth: 2
+
+The continuous array library introduces an array that you can loop over, for example if you want to create a period of a Pulse-code modulated (PCM) sine wave.
+You can use it to test playback with applications that support audio development kits, for example the :ref:`nrf53_audio_app`.
+
+The library introduces the :c:func:`contin_array_create` function, which takes an array that the user wants to loop over.
+For more information, see `API documentation`_.
+
+Configuration
+*************
+
+To enable the library, set the :kconfig:option:`CONFIG_CONTIN_ARRAY` Kconfig option to ``y`` in the project configuration file :file:`prj.conf`.
+
+API documentation
+*****************
+
+| Header file: :file:`include/contin_array.h`
+| Source file: :file:`lib/contin_array/contin_array.c`
+
+.. doxygengroup:: contin_array
+   :project: nrf
+   :members:
diff --git a/doc/nrf/releases/release-notes-changelog.rst b/doc/nrf/releases/release-notes-changelog.rst
@@ -340,6 +340,11 @@ Libraries for NFC
 Other libraries
 ---------------
 
+* :ref:`lib_contin_array` library:
+
+  * Separated the library from the :ref:`nrf53_audio_app` and moved it to :file:`lib/contin_array`.
+    Updated code and documentation accordingly.
+
 * :ref:`lib_location` library:
 
   * Updated:
diff --git a/include/contin_array.h b/include/contin_array.h
@@ -0,0 +1,46 @@
+/*
+ * Copyright (c) 2018 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+ */
+
+#ifndef CONTIN_ARRAY_H
+#define CONTIN_ARRAY_H
+
+#include <zephyr/kernel.h>
+
+/**
+ * @file contin_array.h
+ *
+ * @defgroup contin_array Continuous array
+ * @{
+ * @brief Basic continuous array.
+ */
+
+/** @brief Creates a continuous array from a finite array.
+ *
+ * @param pcm_cont		Pointer to the destination array.
+ * @param pcm_cont_size	        Size of pcm_cont.
+ * @param pcm_finite		Pointer to an array of samples or data.
+ * @param pcm_finite_size	Size of pcm_finite.
+ * @param finite_pos		Variable used internally. Must be set
+ *				to 0 for the first run and not changed.
+ *
+ * @note  This function serves the purpose of e.g. having a set of audio samples
+ * stored in pcm_finite. This can then be fetched in smaller pieces into ram and
+ * played back in a loop using the results in pcm_cont.
+ * The function keeps track of the current position in finite_pos,
+ * so that the function can be called multiple times and maintain the correct
+ * position in pcm_finite.
+ *
+ * @retval 0		If the operation was successful.
+ * @retval -EPERM	If any sizes are zero.
+ * @retval -ENXIO	On NULL pointer.
+ */
+int contin_array_create(void *pcm_cont, uint32_t pcm_cont_size, void const *const pcm_finite,
+			uint32_t pcm_finite_size, uint32_t *const finite_pos);
+
+/**
+ * @}
+ */
+#endif /* CONTIN_ARRAY_H */
diff --git a/lib/CMakeLists.txt b/lib/CMakeLists.txt
@@ -40,3 +40,4 @@ add_subdirectory_ifdef(CONFIG_MODEM_ANTENNA modem_antenna)
 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)
diff --git a/lib/Kconfig b/lib/Kconfig
@@ -41,5 +41,6 @@ rsource "modem_antenna/Kconfig"
 rsource "qos/Kconfig"
 rsource "identity_key/Kconfig"
 rsource "sfloat/Kconfig"
+rsource "contin_array/Kconfig"
 
 endmenu
diff --git a/lib/contin_array/CMakeLists.txt b/lib/contin_array/CMakeLists.txt
@@ -0,0 +1,12 @@
+#
+# Copyright (c) 2022 Nordic Semiconductor
+#
+# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+#
+
+zephyr_library()
+zephyr_library_sources(
+	contin_array.c
+)
+
+zephyr_include_directories(.)
diff --git a/lib/contin_array/Kconfig b/lib/contin_array/Kconfig
@@ -0,0 +1,19 @@
+# Continuous Array creator
+#
+# Copyright (c) 2022 Nordic Semiconductor
+#
+# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+#
+
+config CONTIN_ARRAY
+	bool "Continuous array library"
+	help
+		Enable continuous array library
+
+if CONTIN_ARRAY
+
+module = CONTIN_ARRAY
+module-str = Continuous array
+source "${ZEPHYR_BASE}/subsys/logging/Kconfig.template.log_config"
+
+endif #CONTIN_ARRAY
diff --git a/lib/contin_array/contin_array.c b/lib/contin_array/contin_array.c
diff --git a/tests/lib/contin_array/CMakeLists.txt b/tests/lib/contin_array/CMakeLists.txt
@@ -0,0 +1,13 @@
+#
+# Copyright (c) 2018 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(contin_array)
+
+FILE(GLOB app_sources src/*.c)
+target_sources(app PRIVATE ${app_sources})
diff --git a/tests/lib/contin_array/Kconfig b/tests/lib/contin_array/Kconfig
diff --git a/tests/lib/contin_array/prj.conf b/tests/lib/contin_array/prj.conf
@@ -1,2 +1,3 @@
 CONFIG_ZTEST=y
 CONFIG_IRQ_OFFLOAD=y
+CONFIG_CONTIN_ARRAY=y
diff --git a/tests/lib/contin_array/src/main.c b/tests/lib/contin_array/src/main.c
diff --git a/tests/lib/contin_array/testcase.yaml b/tests/lib/contin_array/testcase.yaml
diff --git a/tests/nrf5340_audio/contin_array/CMakeLists.txt b/tests/nrf5340_audio/contin_array/CMakeLists.txt

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_CONTIN_ARRAY=y`