applications: nrf5340_audio: Use net_buf directly for audio

- Remove all calls to data_fifo
- Use net_buf throughout the system for audio
- Insert metadata into the net_buf as user data
- OCT-3379

Signed-off-by: Alexander Svensen <[email protected]>

Author: alexsven

applications/nrf5340_audio/Kconfig.defaults

@@ -57,9 +57,6 @@ config PCM_MIX
 config PSCM
 	default y
 
-config DATA_FIFO
-	default y
-
 # Enable NRFX_CLOCK for ACLK control
 config NRFX_CLOCK
 	default y

applications/nrf5340_audio/broadcast_sink/main.c

@@ -568,7 +568,7 @@ uint8_t stream_state_get(void)
 	return strm_state;
 }
 
-void streamctrl_send(struct audio_data const *const audio_frame)
+void streamctrl_send(struct net_buf const *const audio_frame)
 {
 	ARG_UNUSED(audio_frame);
 

applications/nrf5340_audio/broadcast_source/main.c

@@ -494,13 +494,13 @@ uint8_t stream_state_get(void)
 	return strm_state;
 }
 
-void streamctrl_send(struct audio_data const *const audio_frame)
+void streamctrl_send(struct net_buf const *const audio_frame)
 {
 	int ret;
 	static int prev_ret;
 
 	if (strm_state == STATE_STREAMING) {
-		ret = broadcast_source_send(0, 0, audio_frame);
+		ret = broadcast_source_send(audio_frame, 0, 0);
 
 		if (ret != 0 && ret != prev_ret) {
 			if (ret == -ECANCELED) {

applications/nrf5340_audio/prj.conf

@@ -18,6 +18,7 @@ CONFIG_THREAD_RUNTIME_STATS=y
 CONFIG_STACK_SENTINEL=y
 CONFIG_INIT_STACKS=y
 CONFIG_BT=y
+CONFIG_NET_BUF_POOL_USAGE=y
 
 # Uart driver
 CONFIG_SERIAL=y

applications/nrf5340_audio/prj_fota.conf

@@ -18,6 +18,7 @@ CONFIG_STACK_USAGE=y
 CONFIG_THREAD_RUNTIME_STATS=y
 CONFIG_STACK_SENTINEL=y
 CONFIG_INIT_STACKS=y
+CONFIG_NET_BUF_POOL_USAGE=y
 
 # Uart driver
 CONFIG_SERIAL=y

applications/nrf5340_audio/prj_release.conf

@@ -20,6 +20,7 @@ CONFIG_CONSOLE=n
 CONFIG_PRINTK=n
 CONFIG_UART_CONSOLE=n
 CONFIG_BOOT_BANNER=n
+CONFIG_NET_BUF_POOL_USAGE=y
 
 # Bluetooth
 # Default value from src/bluetooth/Kconfig.defaults.

applications/nrf5340_audio/src/audio/audio_datapath.c

@@ -12,7 +12,6 @@
 #include <zephyr/zbus/zbus.h>
 #include <zephyr/kernel.h>
 #include <zephyr/shell/shell.h>
-#include <zephyr/net_buf.h>
 #include <nrfx_clock.h>
 #include <contin_array.h>
 #include <tone.h>
@@ -92,7 +91,8 @@ LOG_MODULE_REGISTER(audio_datapath, CONFIG_AUDIO_DATAPATH_LOG_LEVEL);
 /* How often to print under-run warning */
 #define UNDERRUN_LOG_INTERVAL_BLKS 5000
 
-NET_BUF_POOL_FIXED_DEFINE(pool_i2s_rx, FIFO_NUM_BLKS, BLK_STEREO_SIZE_OCTETS, 8, net_buf_destroy);
+NET_BUF_POOL_FIXED_DEFINE(pool_i2s_rx, FIFO_NUM_BLKS, BLK_STEREO_SIZE_OCTETS,
+			  sizeof(struct audio_metadata), NULL);
 
 enum drift_comp_state {
 	DRIFT_STATE_INIT,   /* Waiting for data to be received */
@@ -128,7 +128,7 @@ static struct {
 	void *decoded_data;
 
 	struct {
-		struct data_fifo *fifo;
+		struct k_msgq *audio_q;
 	} in;
 
 	struct {
@@ -693,69 +693,60 @@ static void audio_datapath_i2s_blk_complete(uint32_t frame_start_ts_us, uint32_t
 
 	/********** I2S RX **********/
 	static int prev_ret;
-	struct audio_data *rx_audio_block = NULL;
-	struct net_buf *buf_in;
+	struct net_buf *rx_audio_block = NULL;
 
 	if (IS_ENABLED(CONFIG_STREAM_BIDIRECTIONAL) || (CONFIG_AUDIO_DEV == GATEWAY)) {
 		if (rx_buf_released == NULL) {
 			/* No RX data available */
 			ERR_CHK_MSG(-ENOMEM, "No RX data available");
 		}
 
-		buf_in = net_buf_alloc(&pool_i2s_rx, K_NO_WAIT);
-		if (buf_in == NULL) {
-			ERR_CHK_MSG(-ENOMEM, "Out of RX buffers for I2S");
+		if (k_msgq_num_free_get(ctrl_blk.in.audio_q) == 0 || pool_i2s_rx.avail_count == 0) {
+			ret = -ENOMEM;
+		} else {
+			ret = 0;
 		}
 
-		/* Store RX buffer in net_buf */
-		net_buf_add_mem(buf_in, rx_buf_released, BLK_STEREO_SIZE_OCTETS);
-
-		/* Get first available audio block */
-		ret = data_fifo_pointer_first_vacant_get(ctrl_blk.in.fifo, (void *)&rx_audio_block,
-							 K_NO_WAIT);
 		/* If RX FIFO is filled up */
 		if (ret == -ENOMEM) {
-			struct audio_data *stale_i2s_data;
-			size_t stale_i2s_data_size;
+			struct net_buf *stale_i2s_data;
 
 			if (ret != prev_ret) {
 				LOG_WRN("I2S RX overrun. Single msg");
 				prev_ret = ret;
 			}
 
-			ret = data_fifo_pointer_last_filled_get(ctrl_blk.in.fifo,
-								(void *)&stale_i2s_data,
-								&stale_i2s_data_size, K_NO_WAIT);
+			ret = k_msgq_get(ctrl_blk.in.audio_q, (void *)&stale_i2s_data, K_NO_WAIT);
 			ERR_CHK(ret);
 
-			struct net_buf *buf = stale_i2s_data->data;
+			net_buf_unref(stale_i2s_data);
 
-			net_buf_unref(buf);
-			data_fifo_block_free(ctrl_blk.in.fifo, stale_i2s_data);
-
-			ret = data_fifo_pointer_first_vacant_get(
-				ctrl_blk.in.fifo, (void *)&rx_audio_block, K_NO_WAIT);
 		} else if (ret == 0 && prev_ret == -ENOMEM) {
 			LOG_WRN("I2S RX continuing stream");
 			prev_ret = ret;
 		}
 
-		rx_audio_block->data = buf_in;
-		rx_audio_block->data_size = BLK_STEREO_SIZE_OCTETS;
+		rx_audio_block = net_buf_alloc(&pool_i2s_rx, K_NO_WAIT);
+		if (rx_audio_block == NULL) {
+			ERR_CHK_MSG(-ENOMEM, "Out of RX buffers for I2S");
+		}
+
+		/* Store RX buffer in net_buf */
+		net_buf_add_mem(rx_audio_block, rx_buf_released, BLK_STEREO_SIZE_OCTETS);
+
+		struct audio_metadata *meta = net_buf_user_data(rx_audio_block);
 
 		/* Add meta data */
-		rx_audio_block->meta.data_coding = PCM;
-		rx_audio_block->meta.data_len_us = 1000;
-		rx_audio_block->meta.sample_rate_hz = CONFIG_AUDIO_SAMPLE_RATE_HZ;
-		rx_audio_block->meta.bits_per_sample = CONFIG_AUDIO_BIT_DEPTH_BITS;
-		rx_audio_block->meta.carried_bits_per_sample = CONFIG_AUDIO_BIT_DEPTH_BITS;
-		rx_audio_block->meta.locations =
-			BT_AUDIO_LOCATION_FRONT_LEFT | BT_AUDIO_LOCATION_FRONT_RIGHT;
-		rx_audio_block->meta.bad_data = false;
-
-		ret = data_fifo_block_lock(ctrl_blk.in.fifo, (void *)&rx_audio_block,
-					   sizeof(struct audio_data));
-		ERR_CHK_MSG(ret, "Unable to lock block RX");
+		meta->data_coding = PCM;
+		meta->data_len_us = 1000;
+		meta->sample_rate_hz = CONFIG_AUDIO_SAMPLE_RATE_HZ;
+		meta->bits_per_sample = CONFIG_AUDIO_BIT_DEPTH_BITS;
+		meta->carried_bits_per_sample = CONFIG_AUDIO_BIT_DEPTH_BITS;
+		meta->locations = BT_AUDIO_LOCATION_FRONT_LEFT | BT_AUDIO_LOCATION_FRONT_RIGHT;
+		meta->bad_data = false;
+
+		ret = k_msgq_put(ctrl_blk.in.audio_q, (void *)&rx_audio_block, K_NO_WAIT);
+		ERR_CHK_MSG(ret, "Unable to put RX audio block into queue");
 	}
 
 	/*** Data exchange ***/
@@ -907,32 +898,29 @@ void audio_datapath_pres_delay_us_get(uint32_t *delay_us)
 	*delay_us = ctrl_blk.pres_comp.pres_delay_us;
 }
 
-void audio_datapath_stream_out(struct audio_data *audio_frame)
+void audio_datapath_stream_out(struct net_buf *audio_frame)
 {
 	if (!ctrl_blk.stream_started) {
 		LOG_WRN("Stream not started");
 		return;
 	}
 
-	/*** Check incoming data ***/
-	struct net_buf *audio_buf = audio_frame->data;
-
-	if (!audio_buf->data) {
+	if (audio_frame == NULL) {
 		LOG_ERR("Buffer pointer is NULL");
 	}
 
-	if (audio_frame->meta.reference_ts_us == ctrl_blk.prev_pres_sdu_ref_us &&
-	    audio_frame->meta.reference_ts_us != 0) {
-		LOG_WRN("Duplicate sdu_ref_us (%d) - Dropping audio frame",
-			audio_frame->meta.reference_ts_us);
+	/*** Check incoming data ***/
+	struct audio_metadata *meta = net_buf_user_data(audio_frame);
+
+	if (meta->reference_ts_us == ctrl_blk.prev_pres_sdu_ref_us && meta->reference_ts_us != 0) {
+		LOG_WRN("Duplicate sdu_ref_us (%d) - Dropping audio frame", meta->reference_ts_us);
 		return;
 	}
 
 	bool sdu_ref_not_consecutive = false;
 
 	if (ctrl_blk.prev_pres_sdu_ref_us) {
-		uint32_t sdu_ref_delta_us =
-			audio_frame->meta.reference_ts_us - ctrl_blk.prev_pres_sdu_ref_us;
+		uint32_t sdu_ref_delta_us = meta->reference_ts_us - ctrl_blk.prev_pres_sdu_ref_us;
 
 		/* Check if the delta is from two consecutive frames */
 		if (sdu_ref_delta_us <
@@ -946,8 +934,8 @@ void audio_datapath_stream_out(struct audio_data *audio_frame)
 					sdu_ref_delta_us);
 
 				/* Estimate sdu_ref_us */
-				audio_frame->meta.reference_ts_us = ctrl_blk.prev_pres_sdu_ref_us +
-								    CONFIG_AUDIO_FRAME_DURATION_US;
+				meta->reference_ts_us = ctrl_blk.prev_pres_sdu_ref_us +
+							CONFIG_AUDIO_FRAME_DURATION_US;
 			}
 		} else {
 			LOG_INF("sdu_ref_us not from consecutive frames (diff: %d us)",
@@ -956,12 +944,11 @@ void audio_datapath_stream_out(struct audio_data *audio_frame)
 		}
 	}
 
-	ctrl_blk.prev_pres_sdu_ref_us = audio_frame->meta.reference_ts_us;
+	ctrl_blk.prev_pres_sdu_ref_us = meta->reference_ts_us;
 
 	/*** Presentation compensation ***/
 	if (ctrl_blk.pres_comp.enabled) {
-		audio_datapath_presentation_compensation(audio_frame->meta.data_rx_ts_us,
-							 audio_frame->meta.reference_ts_us,
+		audio_datapath_presentation_compensation(meta->data_rx_ts_us, meta->reference_ts_us,
 							 sdu_ref_not_consecutive);
 	}
 
@@ -1012,26 +999,25 @@ void audio_datapath_stream_out(struct audio_data *audio_frame)
 		}
 
 		/* Record producer block start reference */
-		ctrl_blk.out.prod_blk_ts[out_blk_idx] =
-			audio_frame->meta.data_rx_ts_us + (i * BLK_PERIOD_US);
+		ctrl_blk.out.prod_blk_ts[out_blk_idx] = meta->data_rx_ts_us + (i * BLK_PERIOD_US);
 
 		out_blk_idx = NEXT_IDX(out_blk_idx);
 	}
 
 	ctrl_blk.out.prod_blk_idx = out_blk_idx;
 }
 
-int audio_datapath_start(struct data_fifo *fifo_rx)
+int audio_datapath_start(struct k_msgq *audio_q_rx)
 {
-	__ASSERT_NO_MSG(fifo_rx != NULL);
+	__ASSERT_NO_MSG(audio_q_rx != NULL);
 
 	if (!ctrl_blk.datapath_initialized) {
 		LOG_WRN("Audio datapath not initialized");
 		return -ECANCELED;
 	}
 
 	if (!ctrl_blk.stream_started) {
-		ctrl_blk.in.fifo = fifo_rx;
+		ctrl_blk.in.audio_q = audio_q_rx;
 
 		/* Clear counters and mute initial audio */
 		memset(&ctrl_blk.out, 0, sizeof(ctrl_blk.out));

applications/nrf5340_audio/src/audio/audio_datapath.h

@@ -10,76 +10,76 @@
 #include <zephyr/kernel.h>
 #include <stdint.h>
 #include <stdbool.h>
-#include <data_fifo.h>
+#include <zephyr/net_buf.h>
 
 #include "sw_codec_select.h"
 #include "audio_defines.h"
 
 /**
- * @brief Mixes a tone into the I2S TX stream
+ * @brief	Mixes a tone into the I2S TX stream.
  *
- * @param freq Tone frequency [Hz]
- * @param dur_ms Tone duration [ms]. 0 = forever
- * @param amplitude Tone amplitude [0, 1]
+ * @param	freq		Tone frequency [Hz].
+ * @param	dur_ms		Tone duration [ms]. (0 == forever)
+ * @param	amplitude	Tone amplitude [0, 1].
  *
- * @return 0 if successful, error otherwise
+ * @return	0 if successful, error otherwise.
  */
 int audio_datapath_tone_play(uint16_t freq, uint16_t dur_ms, float amplitude);
 
 /**
- * @brief Stops tone playback
+ * @brief	Stops tone playback.
  */
 void audio_datapath_tone_stop(void);
 
 /**
- * @brief Set the presentation delay
+ * @brief	Set the presentation delay.
  *
- * @param delay_us The presentation delay in µs
+ * @param	delay_us	The presentation delay in µs.
  *
- * @return 0 if successful, error otherwise
+ * @return	0 if successful, error otherwise.
  */
 int audio_datapath_pres_delay_us_set(uint32_t delay_us);
 
 /**
- * @brief Get the current presentation delay
+ * @brief	Get the current presentation delay.
  *
- * @param delay_us  The presentation delay in µs
+ * @param	delay_us	The presentation delay in µs.
  */
 void audio_datapath_pres_delay_us_get(uint32_t *delay_us);
 
 /**
- * @brief Input an audio data frame which is processed and outputted over I2S
+ * @brief	Input an audio data frame which is processed and outputted over I2S.
  *
- * @note A frame of raw encoded audio data is inputted, and this data then is decoded
- *       and processed before being outputted over I2S. The audio is synchronized
- *       using sdu_ref_us
+ * @note	A frame of raw encoded audio data is inputted, and this data then is decoded
+ *		and processed before being outputted over I2S. The audio is synchronized
+ *		using sdu_ref_us.
  *
- * @param audio_frame Pointer to the audio data frame to be processed
+ * @param	audio_frame	Pointer to the audio buffer.
  */
-void audio_datapath_stream_out(struct audio_data *audio_frame);
+void audio_datapath_stream_out(struct net_buf *audio_frame);
 
 /**
- * @brief Start the audio datapath module
+ * @brief	Start the audio datapath module.
  *
- * @note The continuously running I2S is started
+ * @note	The continuously running I2S is started.
  *
- * @param fifo_rx Pointer to FIFO structure where I2S RX data is put
+ * @param	queue_rx	Pointer to the queue structure where I2S RX data is put.
  *
- * @return 0 if successful, error otherwise
+ * @return	0 if successful, error otherwise.
  */
-int audio_datapath_start(struct data_fifo *fifo_rx);
+int audio_datapath_start(struct k_msgq *queue_rx);
 
 /**
- * @brief Stop the audio datapath module
+ * @brief	Stop the audio datapath module.
  *
- * @return 0 if successful, error otherwise
+ * @return	0 if successful, error otherwise.
  */
 int audio_datapath_stop(void);
 
 /**
- * @brief Initialize the audio datapath module
+ * @brief	Initialize the audio datapath module.
  *
- * @return 0 if successful, error otherwise
+ * @return	0 if successful, error otherwise.
  */
 int audio_datapath_init(void);