Tools: Testbench: Add support for ALSA controls script

This patch adds to testbench command line option -s <controls file>.
The controls file can contain comments with line starting with #,
empty lines, amixer cset name= commands and sleep n commands.

The script format is similar to what can be applied to a real
SOF device running Linux OS. E.g.

amixer -c0 cset name='Post Mixer Analog Playback DRC switch' off
amixer -c0 cset name='Post Mixer Analog Playback Volume' 42,43
sleep 0.5
amixer -c0 cset name='Post Mixer Analog Playback Volume' 45

The result simulated waveform would show in the beginning left
channel set to gain value 42, and right channel to gain value 43.
After processing 0.5 seconds of audio both left and right
channel gains are set to 45.

The supported controls types are mixer, switch and enum.

Signed-off-by: Seppo Ingalsuo <seppo.ingalsuo@linux.intel.com>

Author: singalsu

tools/testbench/include/testbench/topology_ipc4.h

@@ -48,6 +48,10 @@ int tb_new_process(struct testbench_prm *tp);
 int tb_pipelines_set_state(struct testbench_prm *tp, int state, int dir);
 int tb_send_bytes_data(struct tb_mq_desc *ipc_tx, struct tb_mq_desc *ipc_rx,
 		       uint32_t module_id, uint32_t instance_id, struct sof_abi_hdr *abi);
+int tb_send_volume_control(struct tb_mq_desc *ipc_tx, struct tb_mq_desc *ipc_rx,
+			   struct tb_ctl *ctl, int *control_values, int num_values);
+int tb_send_alsa_control(struct tb_mq_desc *ipc_tx, struct tb_mq_desc *ipc_rx, struct tb_ctl *ctl,
+			 int *control_values, int num_values, int param_id);
 int tb_set_reset_state(struct testbench_prm *tp);
 int tb_set_running_state(struct testbench_prm *tp);
 int tb_set_up_pipeline(struct testbench_prm *tp, struct tplg_pipeline_info *pipe_info);

tools/testbench/include/testbench/utils.h

@@ -19,6 +19,10 @@
 #define TB_MAX_INPUT_FILE_NUM		16
 #define TB_MAX_OUTPUT_FILE_NUM		16
 #define TB_MAX_PIPELINES_NUM		16
+#define TB_MAX_CMD_CHARS		256
+#define TB_MAX_CTL_NAME_CHARS		128
+#define TB_MAX_VOLUME_SIZE		120
+#define TB_MAX_DATA_SIZE		512
 
 /* number of widgets types supported in testbench */
 #define TB_NUM_WIDGETS_SUPPORTED	16
@@ -32,13 +36,34 @@ struct file_comp_lookup {
 	struct file_state *state;
 };
 
+struct tb_ctl {
+	struct tplg_comp_info *comp_info;
+	unsigned int module_id;
+	unsigned int instance_id;
+	unsigned int type;
+	unsigned int volume_table[TB_MAX_VOLUME_SIZE];
+	unsigned int index;
+	char data[TB_MAX_DATA_SIZE];
+	char name[TB_MAX_CTL_NAME_CHARS];
+	union {
+		struct snd_soc_tplg_mixer_control mixer_ctl;
+		struct snd_soc_tplg_enum_control enum_ctl;
+		struct snd_soc_tplg_bytes_control bytes_ctl;
+	};
+};
+
+struct tb_glb_state {
+	char magic[8];			/* SOF_MAGIC */
+	uint32_t num_ctls;		/* number of ctls */
+	size_t size;			/* size of this structure in bytes */
+	struct tb_ctl *ctl;
+};
+
 #if CONFIG_IPC_MAJOR_4
 
 #define TB_NAME_SIZE		256
 #define TB_MAX_CONFIG_COUNT	2
 #define TB_MAX_CONFIG_NAME_SIZE	64
-#define TB_MAX_VOLUME_SIZE	120
-#define TB_MAX_DATA_SIZE	512
 #define TB_MAX_CTLS		16
 
 struct tb_mq_desc {
@@ -55,27 +80,6 @@ struct tb_config {
 	int channels;
 	unsigned long format;
 };
-
-struct tb_ctl {
-	unsigned int module_id;
-	unsigned int instance_id;
-	unsigned int type;
-	unsigned int volume_table[TB_MAX_VOLUME_SIZE];
-	unsigned int index;
-	char data[TB_MAX_DATA_SIZE];
-	union {
-		struct snd_soc_tplg_mixer_control mixer_ctl;
-		struct snd_soc_tplg_enum_control enum_ctl;
-		struct snd_soc_tplg_bytes_control bytes_ctl;
-	};
-};
-
-struct tb_glb_state {
-	char magic[8];			/* SOF_MAGIC */
-	uint32_t num_ctls;		/* number of ctls */
-	size_t size;			/* size of this structure in bytes */
-	struct tb_ctl *ctl;
-};
 #endif
 
 /*
@@ -93,6 +97,7 @@ struct testbench_prm {
 	char *output_file[TB_MAX_OUTPUT_FILE_NUM]; /* output file names */
 	char *tplg_file; /* topology file to use */
 	char *bits_in; /* input bit format */
+	char *control_file;
 	int input_file_num; /* number of input files */
 	int output_file_num; /* number of output files */
 	int pipeline_num;
@@ -123,6 +128,9 @@ struct testbench_prm {
 	/* topology */
 	struct tplg_context tplg;
 
+	FILE *control_fh;
+	struct tb_glb_state glb_ctx;
+
 #if CONFIG_IPC_MAJOR_4
 	struct list_item widget_list;
 	struct list_item route_list;
@@ -136,12 +144,12 @@ struct testbench_prm {
 	struct tb_config config[TB_MAX_CONFIG_COUNT];
 	int num_configs;
 	int period_frames;
-	struct tb_glb_state glb_ctx;
 #endif
 };
 
 extern int debug;
 
+int tb_decode_enum(struct snd_soc_tplg_enum_control *enum_ctl, char *token);
 int tb_find_file_components(struct testbench_prm *tp);
 int tb_free_all_pipelines(struct testbench_prm *tp);
 int tb_load_topology(struct testbench_prm *tp);
@@ -150,7 +158,10 @@ int tb_pipeline_params(struct testbench_prm *tp, struct ipc *ipc, struct pipelin
 int tb_pipeline_reset(struct ipc *ipc, struct pipeline *p);
 int tb_pipeline_start(struct ipc *ipc, struct pipeline *p);
 int tb_pipeline_stop(struct ipc *ipc, struct pipeline *p);
+int tb_read_controls(struct testbench_prm *tp, int64_t *sleep_ns);
+int tb_set_enum_control(struct testbench_prm *tp, struct tb_ctl *ctl, char *control_params);
 int tb_set_reset_state(struct testbench_prm *tp);
+int tb_set_mixer_control(struct testbench_prm *tp, struct tb_ctl *ctl, char *control_params);
 int tb_set_running_state(struct testbench_prm *tp);
 int tb_set_up_all_pipelines(struct testbench_prm *tp);
 int tb_setup(struct sof *sof, struct testbench_prm *tp);

tools/testbench/testbench.c

@@ -129,6 +129,7 @@ static void print_usage(char *executable)
 	printf("  -p <pipeline1,pipeline2,...>\n");
 	printf("  -C <number of copy() iterations>\n");
 	printf("  -P <number of dynamic pipeline iterations>\n");
+	printf("  -s <script file to set controls, with amixer and sleep commands>\n\n");
 	printf("Options for input and output format override:\n");
 	printf("  -b <input_format>, S16_LE, S24_LE, or S32_LE\n");
 	printf("  -c <input channels>\n");
@@ -146,7 +147,7 @@ static int parse_input_args(int argc, char **argv, struct testbench_prm *tp)
 	int option = 0;
 	int ret = 0;
 
-	while ((option = getopt(argc, argv, "hd:i:o:t:b:r:R:c:n:C:P:p:")) != -1) {
+	while ((option = getopt(argc, argv, "hd:i:o:t:b:r:R:c:n:C:P:p:s:")) != -1) {
 		switch (option) {
 		/* input sample file */
 		case 'i':
@@ -216,6 +217,11 @@ static int parse_input_args(int argc, char **argv, struct testbench_prm *tp)
 			ret = parse_pipelines(optarg, tp);
 			break;
 
+		/* control script file name */
+		case 's':
+			tp->control_file = strdup(optarg);
+			break;
+
 		/* print usage */
 		case 'h':
 			print_usage(argv[0]);
@@ -302,9 +308,13 @@ static void test_pipeline_stats(struct testbench_prm *tp, long long delta_t)
  */
 static int pipline_test(struct testbench_prm *tp)
 {
+	float samples_to_ns;
 	int dp_count = 0;
 	struct timespec td0, td1;
+	struct file_state *out_stat;
 	long long delta_t;
+	int64_t next_control_ns;
+	int64_t time_ns;
 	int err;
 
 	/* build, run and teardown pipelines */
@@ -341,17 +351,46 @@ static int pipline_test(struct testbench_prm *tp)
 			break;
 		}
 
+		/* Use first file writer to create simulation time. Calculate coefficient
+		 * to calculate current time from file write samples count
+		 */
+		out_stat = tp->fw[0].state;
+		samples_to_ns = 1.0e9 / ((float)out_stat->channels * out_stat->rate);
+
+		/* Apply initial controls time to call again controls handler */
+		err = tb_read_controls(tp, &next_control_ns);
+		if (err) {
+			fprintf(stderr, "error: failed to read control commands.\n");
+			goto out;
+		}
+
 		tb_gettime(&td0);
 
 		while (true) {
 			if (tb_schedule_pipeline_check_state(tp))
 				break;
+
+			if (next_control_ns) {
+				time_ns = (int64_t)(samples_to_ns * out_stat->n);
+				if (time_ns >= next_control_ns) {
+					err = tb_read_controls(tp, &next_control_ns);
+					if (err) {
+						fprintf(stderr,
+							"error: failed to read control commands.\n");
+						goto out;
+					}
+
+					if (next_control_ns)
+						next_control_ns += time_ns;
+				}
+			}
 		}
 
 		tb_schedule_pipeline_check_state(tp); /* Once more to flush out remaining data */
 
 		tb_gettime(&td1);
 
+out:
 		err = tb_set_reset_state(tp);
 		if (err < 0) {
 			fprintf(stderr, "error: pipeline reset %d failed %d\n",
@@ -445,6 +484,16 @@ int main(int argc, char **argv)
 		goto out;
 	}
 
+	if (tp->control_file) {
+		tp->control_fh = fopen(tp->control_file, "r");
+		if (!tp->control_fh) {
+			fprintf(stderr, "error: opening script %s (%s).\n",
+				tp->control_file, strerror(errno));
+			ret = -errno;
+			goto out;
+		}
+	}
+
 	/* build, run and teardown pipelines */
 	pipline_test(tp);
 
@@ -456,6 +505,10 @@ int main(int argc, char **argv)
 	/* free all other data */
 	free(tp->bits_in);
 	free(tp->tplg_file);
+	free(tp->control_file);
+	if (tp->control_fh)
+		fclose(tp->control_fh);
+
 	for (i = 0; i < tp->output_file_num; i++)
 		free(tp->output_file[i]);