buf: introduce ops instead of a single free function

in struct audio_buffer there was only one virtual method
(free). There are probably more coming, so an ops structure
is introduced.

ring buffer which uses audio buffer as a base must adjust,
including using of an audio_buffer_init procedure, what implies
using audio_stream_params located in audio_buffer

Signed-off-by: Marcin Szkudlinski <marcin.szkudlinski@intel.com>

Author: marcinszkudlinski

src/audio/buffer.c

@@ -103,6 +103,11 @@ int buffer_attach_secondary_buffer(struct comp_buffer *buffer, bool at_input,
 		buf_err(buffer, "Only one secondary buffer may be attached to a buffer");
 		return -EINVAL;
 	}
+
+	/* secondary buffer must share audio params with the primary buffer */
+	audio_buffer_replace_audio_stream_params(secondary_buffer,
+						 &buffer->stream.runtime_stream_params);
+
 	if (at_input)
 		buffer->stream.secondary_buffer_sink = secondary_buffer;
 	else

src/audio/buffers/audio_buffer.c

@@ -92,7 +92,7 @@ void audio_buffer_free(struct sof_audio_buffer *buffer)
 	audio_buffer_free(buffer->secondary_buffer_sink);
 	audio_buffer_free(buffer->secondary_buffer_source);
 #endif /* CONFIG_PIPELINE_2_0 */
-	if (buffer->free)
-		buffer->free(buffer);
+	if (buffer->ops->free)
+		buffer->ops->free(buffer);
 	rfree(buffer);
 }

src/audio/buffers/ring_buffer.c

@@ -227,10 +227,13 @@ static int ring_buffer_set_ipc_params(struct ring_buffer *ring_buffer,
 	if (ring_buffer->_hw_params_configured && !force_update)
 		return 0;
 
-	ring_buffer->audio_stream_params->frame_fmt = params->frame_fmt;
-	ring_buffer->audio_stream_params->rate = params->rate;
-	ring_buffer->audio_stream_params->channels = params->channels;
-	ring_buffer->audio_stream_params->buffer_fmt = params->buffer_fmt;
+	struct sof_audio_stream_params *audio_stream_params =
+		audio_buffer_get_stream_params(&ring_buffer->audio_buffer);
+
+	audio_stream_params->frame_fmt = params->frame_fmt;
+	audio_stream_params->rate = params->rate;
+	audio_stream_params->channels = params->channels;
+	audio_stream_params->buffer_fmt = params->buffer_fmt;
 
 	ring_buffer->_hw_params_configured = true;
 
@@ -271,9 +274,12 @@ static const struct sink_ops ring_buffer_sink_ops = {
 	.audio_set_ipc_params = ring_buffer_set_ipc_params_sink,
 };
 
+static const struct audio_buffer_ops audio_buffer_ops = {
+	.free = ring_buffer_free,
+};
+
 struct ring_buffer *ring_buffer_create(size_t min_available, size_t min_free_space, uint32_t flags,
-				       uint32_t id,
-				       struct sof_audio_stream_params *audio_stream_params)
+				       uint32_t id)
 {
 	struct ring_buffer *ring_buffer;
 
@@ -288,19 +294,22 @@ struct ring_buffer *ring_buffer_create(size_t min_available, size_t min_free_spa
 		return NULL;
 
 	ring_buffer->_flags = flags;
-	ring_buffer->audio_stream_params = audio_stream_params;
 
-	CORE_CHECK_STRUCT_INIT(&ring_buffer->audio_buffer, flags & RING_BUFFER_MODE_SHARED);
-
-	/* initiate structures */
-	source_init(audio_buffer_get_source(&ring_buffer->audio_buffer), &ring_buffer_source_ops,
-		    ring_buffer->audio_stream_params);
-	sink_init(audio_buffer_get_sink(&ring_buffer->audio_buffer), &ring_buffer_sink_ops,
-		  ring_buffer->audio_stream_params);
+	/* init base structure. The audio_stream_params is NULL because ring_buffer
+	 * is currently used as a secondary buffer for DP only
+	 *
+	 * pointer in audio_buffer will be overwritten when attaching ring_buffer as a
+	 * secondary buffer
+	 */
+	audio_buffer_init(&ring_buffer->audio_buffer, BUFFER_TYPE_RING_BUFFER,
+			  flags & RING_BUFFER_MODE_SHARED, &ring_buffer_source_ops,
+			  &ring_buffer_sink_ops, &audio_buffer_ops, NULL);
 
 	/* set obs/ibs in sink/source interfaces */
-	sink_set_min_free_space(&ring_buffer->audio_buffer._sink_api, min_free_space);
-	source_set_min_available(&ring_buffer->audio_buffer._source_api, min_available);
+	sink_set_min_free_space(audio_buffer_get_sink(&ring_buffer->audio_buffer),
+				min_free_space);
+	source_set_min_available(audio_buffer_get_source(&ring_buffer->audio_buffer),
+				 min_available);
 
 	uint32_t max_ibs_obs = MAX(min_available, min_free_space);
 
@@ -315,15 +324,10 @@ struct ring_buffer *ring_buffer_create(size_t min_available, size_t min_free_spa
 	if (!ring_buffer->_data_buffer)
 		goto err;
 
-	ring_buffer->audio_stream_params->id = id;
 	tr_info(&ring_buffer_tr, "Ring buffer created, id: %u shared: %u min_available: %u min_free_space %u, size %u",
 		id, ring_buffer_is_shared(ring_buffer), min_available, min_free_space,
 		ring_buffer->data_buffer_size);
 
-	/* set common buffer api */
-	ring_buffer->audio_buffer.free = ring_buffer_free;
-	ring_buffer->audio_buffer.buffer_type = BUFFER_TYPE_RING_BUFFER;
-
 	/* return a pointer to allocated structure */
 	return ring_buffer;
 err:

src/include/sof/audio/audio_buffer.h

@@ -15,6 +15,18 @@
 #define BUFFER_TYPE_LEGACY_BUFFER 1
 #define BUFFER_TYPE_RING_BUFFER 2
 
+/* forward def */
+struct sof_audio_buffer;
+
+struct audio_buffer_ops {
+	/**
+	 * @brief this method must free all structures allocated by buffer implementation
+	 *	  it must not free the buffer memory itself
+	 *	  OPTIONAL
+	 */
+	void (*free)(struct sof_audio_buffer *buffer);
+};
+
 /* base class for all buffers, all buffers must inherit from it */
 struct sof_audio_buffer {
 	CORE_CHECK_STRUCT_FIELD;
@@ -56,11 +68,7 @@ struct sof_audio_buffer {
 	struct sof_sink _sink_api;      /**< sink api handler */
 
 	/* virtual methods */
-	/**
-	 * @brief this method must free all structures allocated by buffer implementation
-	 *	  it must not free the buffer memory itself
-	 */
-	void (*free)(struct sof_audio_buffer *buffer);
+	const struct audio_buffer_ops *ops;
 };
 
 #if CONFIG_PIPELINE_2_0
@@ -195,16 +203,18 @@ static inline struct sof_audio_buffer *sof_audo_buffer_from_source(struct sof_so
  * @param is_shared indicates if the buffer will be shared between cores
  * @param source_ops pointer to virtual methods table for source API
  * @param sink_ops pointer to virtual methods table for sink API
+ * @param audio_stream_params pointer to audio stream (currently kept in buffer implementation)
  */
 static inline
 void audio_buffer_init(struct sof_audio_buffer *buffer, uint32_t buffer_type, bool is_shared,
-		       const struct source_ops *source_ops, const struct sink_ops *sink_ops)
+		       const struct source_ops *source_ops, const struct sink_ops *sink_ops,
+		       const struct audio_buffer_ops *audio_buffer_ops,
+		       struct sof_audio_stream_params *audio_stream_params)
 {
 	CORE_CHECK_STRUCT_INIT(&buffer, is_shared);
 	buffer->buffer_type = buffer_type;
-#if CONFIG_PIPELINE_2_0
-	buffer->audio_stream_params = &buffer->_audio_stream_params;
-#endif /* CONFIG_PIPELINE_2_0 */
+	buffer->ops = audio_buffer_ops;
+	buffer->audio_stream_params = audio_stream_params;
 	source_init(audio_buffer_get_source(buffer), source_ops,
 		    audio_buffer_get_stream_params(buffer));
 	sink_init(audio_buffer_get_sink(buffer), sink_ops,

src/include/sof/audio/ring_buffer.h

@@ -106,18 +106,9 @@ struct sof_audio_stream_params;
 
 /* the ring_buffer structure */
 struct ring_buffer {
-	struct sof_audio_buffer audio_buffer;
-
 	/* public: read only */
+	struct sof_audio_buffer audio_buffer;
 
-	/* note!
-	 * as ring_buffer is currently used as a shadow for comp_buffer only for DP components,
-	 * the audio_stream_params vector must be shared between comp_buffer and ring_buffer
-	 * the audio_stream_params pointer should point to the proper comp_buffer structure
-	 *
-	 * to be changed to the structure itself when pipeline2.0 is introduced
-	 */
-	struct sof_audio_stream_params *audio_stream_params;
 	size_t data_buffer_size;
 
 	uint32_t _flags;		/* RING_BUFFER_MODE_* */
@@ -140,11 +131,8 @@ struct ring_buffer {
  *
  * @param id a stream ID, accessible later by sink_get_id/source_get_id
  *
- * @param audio_stream_params pointer to audio params vector, shared between ring_buffer and
- *			      comp_buffer for dp modules
- *
  */
 struct ring_buffer *ring_buffer_create(size_t min_available, size_t min_free_space, uint32_t flags,
-				 uint32_t id, struct sof_audio_stream_params *audio_stream_params);
+				       uint32_t id);
 
 #endif /* __SOF_RING_BUFFER_H__ */

src/ipc/ipc4/helper.c

@@ -569,8 +569,7 @@ int ipc_comp_connect(struct ipc *ipc, ipc_pipe_comp_connect *_connect)
 					   sink_get_min_free_space(&buffer->stream._sink_api),
 					   buffer->is_shared ?
 						RING_BUFFER_MODE_SHARED : RING_BUFFER_MODE_LOCAL,
-					   buf_get_id(buffer),
-					   &buffer->stream.runtime_stream_params);
+					   buf_get_id(buffer));
 		if (!ring_buffer)
 			goto free;
 	}