tools/wov_capture: add WOV slot/trigger helpers and dynamic control discovery

Extend WOV capture tooling:
- wov_capture_app: add dynamic ALSA control lookup by name (ctl_find_numid),
  channel count CLI flag (-C), and direct capture mode.
- read_wov_trigger.py: script to read wov_trigger_id active detection slot.
- set_wov_slot.py: script to write slot assignment via IPC4 bytes kcontrol.

Signed-off-by: Liam Girdwood <liam.r.girdwood@linux.intel.com>

Author: lrgirdwo

tools/wov_capture/read_wov_trigger.py

@@ -0,0 +1,27 @@
+#!/usr/bin/env python3
+# Reads wov_trigger_id to get active_slot after detection.
+# Usage: read_wov_trigger.py [numid] [card]
+import fcntl, os, struct, sys
+
+numid = int(sys.argv[1]) if len(sys.argv) > 1 else 19
+card = int(sys.argv[2]) if len(sys.argv) > 2 else 0
+
+SNDRV_CTL_IOCTL_TLV_READ = (2 << 30) | (8 << 16) | (0x55 << 8) | 0x1a
+
+def read_active_slot(card_id=0, ctl_numid=19):
+    response_size = 44
+    buf = bytearray(struct.pack('<II', ctl_numid, response_size) + bytes(response_size))
+    dev_path = f'/dev/snd/controlC{card_id}'
+    fd = os.open(dev_path, os.O_RDWR)
+    try:
+        fcntl.ioctl(fd, SNDRV_CTL_IOCTL_TLV_READ, buf)
+    finally:
+        os.close(fd)
+    return struct.unpack_from('<I', buf, 48)[0]
+
+try:
+    slot = read_active_slot(card, numid)
+    print(f'active_slot = {slot}  (255 = no active detection)')
+except Exception as e:
+    print(f'Error reading trigger ID (numid={numid}, card={card}): {e}')
+    sys.exit(1)

tools/wov_capture/set_wov_slot.py

@@ -0,0 +1,44 @@
+#!/usr/bin/env python3
+# Usage: set_wov_slot.py <numid> <slot_id> [card]
+#   numid: ALSA control numid for wov_init_1NN
+#   slot_id: 0-2 to enable; 255 to disable (WOV_SLOT_INVALID)
+#   card: card number (default 0)
+import sys, fcntl, struct, os
+
+if len(sys.argv) < 3:
+    print(f"Usage: {sys.argv[0]} <numid> <slot_id> [card]")
+    sys.exit(1)
+
+numid = int(sys.argv[1])
+slot_id = int(sys.argv[2])
+card = int(sys.argv[3]) if len(sys.argv) > 3 else 0
+
+SOF_IPC4_ABI_MAGIC              = 0x34464F53
+SOF_CTRL_CMD_BINARY             = 3
+SOF_IPC4_BYTES_CONTROL_PARAM_ID = 202
+SNDRV_CTL_IOCTL_TLV_WRITE      = (1 << 30) | (8 << 16) | (0x55 << 8) | 0x1b
+
+payload_size   = 4
+sizeof_abi_hdr = 32
+inner_length   = sizeof_abi_hdr + payload_size   # 36
+outer_length   = 8 + inner_length                # 44
+
+abi_hdr  = (struct.pack('<IIII', SOF_IPC4_ABI_MAGIC,
+                         SOF_IPC4_BYTES_CONTROL_PARAM_ID, payload_size, 0)
+            + bytes(16))
+payload  = struct.pack('<I', slot_id)
+
+ioctl_buf = (struct.pack('<II', numid, outer_length) +
+             struct.pack('<II', SOF_CTRL_CMD_BINARY, inner_length) +
+             abi_hdr + payload)
+
+dev_path = f'/dev/snd/controlC{card}'
+fd = os.open(dev_path, os.O_RDWR)
+try:
+    fcntl.ioctl(fd, SNDRV_CTL_IOCTL_TLV_WRITE, bytearray(ioctl_buf))
+    print(f'OK: card={card} numid={numid} slot_id={slot_id}')
+except OSError as e:
+    print(f'FAIL: card={card} numid={numid}: {e}')
+    sys.exit(1)
+finally:
+    os.close(fd)

tools/wov_capture/wov_capture_app.c

@@ -39,7 +39,7 @@
  * ---------------------------------------------------------------------- */
 #define DEFAULT_CARD          0
 #define DEFAULT_DEVICE        11
-#define DEFAULT_CHANNELS      1
+#define DEFAULT_CHANNELS      2
 #define DEFAULT_RATE          16000
 #define DEFAULT_FRAGMENT_SZ   65536   /* bytes per fragment */
 #define DEFAULT_FRAGMENTS     8
@@ -157,17 +157,56 @@ static int ctl_open(unsigned int card)
 	return fd;
 }
 
+static int ctl_find_numid(unsigned int card, const char *name, int default_numid)
+{
+	int fd = ctl_open(card);
+	if (fd < 0)
+		return default_numid;
+
+	struct snd_ctl_elem_list list;
+	memset(&list, 0, sizeof(list));
+	if (ioctl(fd, SNDRV_CTL_IOCTL_ELEM_LIST, &list) < 0 || list.count == 0) {
+		close(fd);
+		return default_numid;
+	}
+
+	struct snd_ctl_elem_id *ids = calloc(list.count, sizeof(*ids));
+	if (!ids) {
+		close(fd);
+		return default_numid;
+	}
+	list.space = list.count;
+	list.pids = ids;
+
+	int numid = default_numid;
+	if (ioctl(fd, SNDRV_CTL_IOCTL_ELEM_LIST, &list) >= 0) {
+		for (unsigned int i = 0; i < list.used; i++) {
+			if (strcmp((const char *)ids[i].name, name) == 0) {
+				numid = ids[i].numid;
+				break;
+			}
+		}
+	}
+	free(ids);
+	close(fd);
+	return numid;
+}
+
 /* Read vad_gate_status_100: returns 0 on success, fills energy + active */
 static int vad_read_status(unsigned int card, uint32_t *energy, bool *active)
 {
+	static int status_numid = -1;
+	if (status_numid < 0)
+		status_numid = ctl_find_numid(card, "vad_gate_status_100", VAD_STATUS_NUMID);
+
 	/* Buffer layout (56 bytes):
 	 * [0..7]  outer tlv: numid, length=48
 	 * [8..15] inner tlv: filled by kernel
 	 * [16..47] sof_abi_hdr (32 bytes)
 	 * [48..55] status payload: energy(u32) + active(u8) + pad(3)
 	 */
 	uint32_t buf[14] = { 0 };   /* 56 bytes */
-	buf[0] = VAD_STATUS_NUMID;
+	buf[0] = status_numid;
 	buf[1] = 8 + ABI_HDR_SIZE + VAD_STATUS_PAYLOAD_SZ;  /* 48 */
 
 	int fd = ctl_open(card);
@@ -191,6 +230,8 @@ static int vad_read_status(unsigned int card, uint32_t *energy, bool *active)
 /* Write vad_gate_cfg_100 */
 static int vad_write_config(const struct wov_state *s)
 {
+	int cfg_numid = ctl_find_numid(s->card, "vad_gate_cfg_100", VAD_CFG_NUMID);
+
 	/* Buffer layout (60 bytes):
 	 * [0..7]  outer tlv: numid=CFG_NUMID, length=52
 	 * [8..15] inner tlv: SOF_CTRL_CMD_BINARY, length=44
@@ -201,7 +242,7 @@ static int vad_write_config(const struct wov_state *s)
 
 	/* outer tlv */
 	uint32_t *u32 = (uint32_t *)buf;
-	u32[0] = VAD_CFG_NUMID;
+	u32[0] = cfg_numid;
 	u32[1] = 8 + ABI_HDR_SIZE + VAD_CFG_PAYLOAD_SZ;    /* 52 */
 
 	/* inner tlv */
@@ -380,27 +421,6 @@ static enum cycle_result run_cycle(const struct wov_state *s,
 			break;
 		}
 
-		if (ret == 0) {
-			int n = compress_read(compress, buf, s->frag_sz);
-			if (n > 0) {
-				if (!triggered) {
-					triggered = true;
-					wav_path  = wav_filename(s->out_dir, cycle_id);
-					wav_file  = wav_open(wav_path, s->channels, s->rate);
-					if (!wav_file) {
-						result = CYCLE_ERROR;
-						break;
-					}
-					log_state("cycle %d: TRIGGERED → writing %s",
-						  cycle_id, wav_path);
-					result = CYCLE_OK;
-				}
-				fwrite(buf, 1, n, wav_file);
-				total_bytes += n;
-				clock_gettime(CLOCK_REALTIME, &last_data_ts);
-			}
-		}
-
 		/* Poll VAD kcontrol */
 		uint32_t energy = 0;
 		bool     active = false;
@@ -420,14 +440,43 @@ static enum cycle_result run_cycle(const struct wov_state *s,
 				prev_active = active;
 				first_status = false;
 			}
-			if (triggered && !silence_seen && !active) {
+			if (!triggered) {
+				if (s->vad_threshold == 0 || active || energy >= (uint32_t)s->vad_threshold) {
+					triggered = true;
+					wav_path  = wav_filename(s->out_dir, cycle_id);
+					wav_file  = wav_open(wav_path, s->channels, s->rate);
+					if (!wav_file) {
+						result = CYCLE_ERROR;
+						break;
+					}
+					log_state("cycle %d: TRIGGERED (%s, energy=%u) → writing %s",
+						  cycle_id, (s->vad_threshold == 0) ? "DIRECT" : (active ? "VAD_SPEECH" : "THRESHOLD"), energy, wav_path);
+					result = CYCLE_OK;
+				}
+			}
+			if (triggered && s->vad_threshold > 0 && !silence_seen && !active) {
 				log_state("cycle %d: drain start (energy=%u)",
 					  cycle_id, energy);
 				silence_seen = true;
 				clock_gettime(CLOCK_REALTIME, &drain_start_ts);
 			}
 		}
 
+		if (ret == 0) {
+			int n = compress_read(compress, buf, s->frag_sz);
+			if (n > 0) {
+				if (triggered && wav_file) {
+					fwrite(buf, 1, n, wav_file);
+					total_bytes += n;
+					clock_gettime(CLOCK_REALTIME, &last_data_ts);
+					if (s->vad_threshold == 0 && total_bytes >= (uint64_t)s->rate * s->channels * 4 * 4) {
+						log_state("cycle %d: DIRECT_CAPTURE complete (%" PRIu64 " bytes)", cycle_id, total_bytes);
+						break;
+					}
+				}
+			}
+		}
+
 		/* Drain completion check */
 		if (silence_seen) {
 			struct timespec now;
@@ -500,6 +549,7 @@ static void usage(const char *prog)
 		"\n"
 		"  -c CARD        sound card number (default %d)\n"
 		"  -d DEVICE      compress PCM device (default %d)\n"
+		"  -C CHANNELS    channels count (default %d)\n"
 		"  -n CYCLES      number of WOV cycles, 0=unlimited (default 0)\n"
 		"  -o DIR         output directory for WAV files (default %s)\n"
 		"  -t THRESHOLD   VAD gate threshold in raw S32 energy units\n"
@@ -516,7 +566,7 @@ static void usage(const char *prog)
 		"\n"
 		"State log tags: STATE=pipeline transitions, CTL=kcontrol changes\n",
 		prog,
-		DEFAULT_CARD, DEFAULT_DEVICE, DEFAULT_OUT_DIR,
+		DEFAULT_CARD, DEFAULT_DEVICE, DEFAULT_CHANNELS, DEFAULT_OUT_DIR,
 		DEFAULT_RATE, DEFAULT_FRAGMENT_SZ,
 		prog);
 }
@@ -541,10 +591,11 @@ int main(int argc, char *argv[])
 	g_state = &s;
 
 	int opt;
-	while ((opt = getopt(argc, argv, "c:d:n:o:t:r:f:vh")) != -1) {
+	while ((opt = getopt(argc, argv, "c:d:C:n:o:t:r:f:vh")) != -1) {
 		switch (opt) {
 		case 'c': s.card          = (unsigned int)atoi(optarg); break;
 		case 'd': s.device        = (unsigned int)atoi(optarg); break;
+		case 'C': s.channels      = (unsigned int)atoi(optarg); break;
 		case 'n': s.max_cycles    = atoi(optarg);               break;
 		case 'o': s.out_dir       = optarg;                     break;
 		case 't': s.vad_threshold = atoi(optarg);               break;