lib: tone: Tone module moved

Tone module moved from applications/nrf5340_audio

Signed-off-by: Kristoffer Rist Skøien <kristoffer.skoien@nordicsemi.no>
Co-authored-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no>

Author: 2 people

CODEOWNERS

@@ -122,6 +122,7 @@ Kconfig*                                  @tejlmand
 /lib/qos/                                 @simensrostad
 /lib/pcm_mix/                             @koffes @alexsven @erikrobstad @rick1082 @gWacey
 /lib/contin_array/                        @koffes @alexsven @erikrobstad @rick1082 @gWacey
+/lib/tone/                                @koffes @alexsven @erikrobstad @rick1082 @gWacey
 /modules/                                 @tejlmand
 /modules/mcuboot/                         @de-nordic @nordicjm
 /modules/cjson/                           @simensrostad @plskeggs @sigvartmh
@@ -245,6 +246,7 @@ Kconfig*                                  @tejlmand
 /tests/lib/nrf_modem_lib/                 @lemrey @MirkoCovizzi
 /tests/lib/nrf_modem_lib/nrf91_sockets/   @MirkoCovizzi
 /tests/lib/ram_pwrdn/                     @Damian-Nordic
+/tests/lib/tone/                          @koffes @alexsven @erikrobstad @rick1082 @gWacey
 /tests/modules/lib/zcbor/                 @oyvindronningstad
 /tests/modules/mcuboot/direct_xip/        @hakonfam
 /tests/modules/mcuboot/external_flash/    @hakonfam @sigvartmh

applications/nrf5340_audio/Kconfig.defaults

@@ -77,6 +77,10 @@ config PCM_MIX
 	bool
 	default y
 
+config TONE
+	bool
+	default y
+
 # Enable NRFX_CLOCK for ACLK control
 config NRFX_CLOCK
 	bool

applications/nrf5340_audio/src/utils/CMakeLists.txt

@@ -10,6 +10,5 @@ target_sources(app PRIVATE
 	       ${CMAKE_CURRENT_SOURCE_DIR}/data_fifo.c
 	       ${CMAKE_CURRENT_SOURCE_DIR}/error_handler.c
 	       ${CMAKE_CURRENT_SOURCE_DIR}/pcm_stream_channel_modifier.c
-	       ${CMAKE_CURRENT_SOURCE_DIR}/tone.c
 	       ${CMAKE_CURRENT_SOURCE_DIR}/uicr.c
 )

applications/nrf5340_audio/src/utils/tone.h

@@ -0,0 +1,26 @@
+.. _lib_tone:
+
+Tone generator
+##############
+
+.. contents::
+   :local:
+   :depth: 2
+
+The tone generator library creates an array of pulse-code modulation (PCM) data of a one-period sine tone, with a given tone frequency and sampling frequency.
+For more information, see `API documentation`_.
+
+Configuration
+*************
+
+To enable the library, set the :kconfig:option:`CONFIG_TONE` Kconfig option to ``y`` in the project configuration file :file:`prj.conf`.
+
+API documentation
+*****************
+
+| Header file: :file:`include/tone.h`
+| Source file: :file:`lib/tone/tone.c`
+
+.. doxygengroup:: tone_gen
+   :project: nrf
+   :members:

doc/nrf/libraries/others/tone.rst

@@ -0,0 +1,47 @@
+/*
+ * Copyright (c) 2020 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+ */
+
+/** @file
+ * @brief Tone generator header.
+ */
+
+#ifndef __TONE_H__
+#define __TONE_H__
+
+/**
+ * @defgroup tone_gen Tone generator
+ * @{
+ * @brief Library for generating PCM-based period tones.
+ *
+ */
+
+#include <stdint.h>
+#include <stddef.h>
+
+/**
+ * @brief               Generates one full pulse-code modulation (PCM) period of a tone with the
+ *                      given parameters.
+ *
+ * @param tone          User provided buffer. Must be large enough to hold
+ *                      the generated PCM tone, depending on settings.
+ * @param tone_size     Resulting tone size.
+ * @param tone_freq_hz  The desired tone frequency in the range [100..10000] Hz.
+ * @param smpl_freq_hz  Sampling frequency.
+ * @param amplitude     Amplitude in the range [0..1].
+ *
+ * @retval 0            Tone generated.
+ * @retval -ENXIO       If tone or tone_size is NULL.
+ * @retval -EINVAL      If smpl_freq_hz == 0 or tone_freq_hz is out of range.
+ * @retval -EPERM       If amplitude is out of range.
+ */
+int tone_gen(int16_t *tone, size_t *tone_size, uint16_t tone_freq_hz, uint32_t smpl_freq_hz,
+	     float amplitude);
+
+/**
+ * @}
+ */
+
+#endif /* __TONE_H__ */

include/tone.h

@@ -42,3 +42,4 @@ 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)
+add_subdirectory_ifdef(CONFIG_TONE tone)

lib/CMakeLists.txt

@@ -43,5 +43,6 @@ rsource "identity_key/Kconfig"
 rsource "sfloat/Kconfig"
 rsource "contin_array/Kconfig"
 rsource "pcm_mix/Kconfig"
+rsource "tone/Kconfig"
 
 endmenu

lib/Kconfig

@@ -0,0 +1,10 @@
+#
+# Copyright (c) 2023 Nordic Semiconductor
+#
+# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+#
+
+zephyr_library()
+zephyr_library_sources(
+	tone.c
+)

lib/tone/CMakeLists.txt

@@ -0,0 +1,17 @@
+# Copyright (c) 2023 Nordic Semiconductor
+#
+# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+#
+
+menuconfig TONE
+	bool "TONE - Sinus creation library"
+	help
+	  Library for creating tones
+
+if TONE
+
+module = TONE
+module-str = tone
+source "${ZEPHYR_BASE}/subsys/logging/Kconfig.template.log_config"
+
+endif #TONE

lib/tone/Kconfig

@@ -0,0 +1,13 @@
+#
+# Copyright (c) 2023 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(tone)
+
+FILE(GLOB app_sources src/*.c)
+target_sources(app PRIVATE ${app_sources})

applications/nrf5340_audio/src/utils/tone.c lib/tone/tone.c

@@ -4,3 +4,4 @@ CONFIG_NEWLIB_LIBC=y
 CONFIG_CMSIS_DSP_FASTMATH=y
 CONFIG_CMSIS_DSP_TABLES=y
 CONFIG_MAIN_STACK_SIZE=8192
+CONFIG_TONE=y