Tools: Tune: TDFB: Add generate of few needed blobs

This patch adds a few blobs generate for the beamformer. There is
no need to update the blobs in tplg2 since the update has been
already done with run of an earlier version of this patch.

- Support two mic line array with 74 mm spacing with addition to
  sof_example_line_array.m and sof_example_two_beams.m

- Updates beamformer pass-through configuration blob with
  steer angle to avoid initialize error.

- Adds script sof_example_two_beams_default.m to export generic
  blobs for 2 and 4 mic line arrays. The parameters are such that
  the array mic spacing is not critical (delay-and-sum type) and
  narrow user faced stereo beams. The two beams design functions
  are split to own files for use from two scripts.

Signed-off-by: Seppo Ingalsuo <[email protected]>

src/audio/tdfb/tune/sof_bf_line2_two_beams.m

@@ -0,0 +1,73 @@
+function sof_bf_line2_two_beams(fs, d, a1, a2, fn, prm)
+
+% sof_bf_line2_two_beams(fs, d, a1, a2, fn, prm)
+% Input
+%   fs - sample rate
+%   d - microphones distance in meters
+%   a1 - steer angle beam 1
+%   a2 - steer angle beam 2
+%   fn - struct with exported blob files names
+%   prm
+%      .add_beam_beam_off - controls addition of beam off definition to blob
+%      .type - Use 'SDB' or 'DSB'
+%      .export_note - comment about build generally
+%      .export_howto - detailed build instruction
+%
+
+% SPDX-License-Identifier: BSD-3-Clause
+%
+% Copyright (c) 2020-2024, Intel Corporation.
+%
+% Author: Seppo Ingalsuo <[email protected]>
+
+% Get defaults
+bf1 = sof_bf_defaults();
+bf1.fs = fs;
+
+% Setup array
+bf1.array='line';          % Calculate xyz coordinates for line
+bf1.mic_n = 2;
+bf1.mic_d = d;
+bf1.beam_off_defined = prm.add_beam_off;
+bf1.type = prm.type;
+
+% Copy settings for bf2
+bf2 = bf1;
+
+% Design beamformer 1 (left)
+bf1.steer_az = a1;
+bf1.steer_el = 0 * a1;
+bf1.input_channel_select        = [0 1];  % Input two channels
+bf1.output_channel_mix          = [1 1];  % Mix both filters to channel 2^0
+bf1.output_channel_mix_beam_off = [1 2];  % Filter 1 to channel 2^0, etc.
+bf1.output_stream_mix           = [0 0];  % Mix both filters to stream 0
+bf1.num_output_channels = 2;
+bf1.fn = 10;                              % Figs 10....
+bf1 = sof_bf_filenames_helper(bf1);
+bf1 = sof_bf_design(bf1);
+
+% Design beamformer 2 (right)
+bf2.steer_az = a2;
+bf2.steer_el = 0 * a2;
+bf2.input_channel_select        = [0 1];  % Input two channels
+bf2.output_channel_mix          = [2 2];  % Mix both filters to channel 2^1
+bf2.output_channel_mix_beam_off = [0 0];  % Filters omitted
+bf2.output_stream_mix           = [0 0];  % Mix both filters to stream 0
+bf2.num_output_channels = 2;
+bf2.fn = 20;                              % Figs 20....
+bf2 = sof_bf_filenames_helper(bf2);
+bf2 = sof_bf_design(bf2);
+
+% Merge two beamformers into single description, set file names
+bfm = sof_bf_merge(bf1, bf2);
+bfm.sofctl3_fn = fullfile(bfm.sofctl3_path, fn.sofctl3_fn);
+bfm.tplg1_fn = fullfile(bfm.tplg1_path, fn.tplg1_fn);
+bfm.sofctl4_fn = fullfile(bfm.sofctl4_path, fn.sofctl4_fn);
+bfm.tplg2_fn = fullfile(bfm.tplg2_path, fn.tplg2_fn);
+
+% Export files for topology and sof-ctl
+bfm.export_note = prm.export_note;
+bfm.export_howto = prm.export_howto;
+sof_bf_export(bfm);
+
+end

src/audio/tdfb/tune/sof_bf_line4_two_beams.m

@@ -0,0 +1,73 @@
+function sof_bf_line4_two_beams(fs, d, a1, a2, fn, prm)
+
+% sof_bf_line4_two_beams(fs, d, a1, a2, fn, prm)
+% Input
+%   fs - sample rate
+%   d - microphones distance in meters
+%   a1 - steer angle beam 1
+%   a2 - steer angle beam 2
+%   fn - struct with exported blob files names
+%   prm
+%      .add_beam_beam_off - controls addition of beam off definition to blob
+%      .type - Use 'SDB' or 'DSB'
+%      .export_note - comment about build generally
+%      .export_howto - detailed build instruction
+%
+
+% SPDX-License-Identifier: BSD-3-Clause
+%
+% Copyright (c) 2020-2024, Intel Corporation. All rights reserved.
+%
+% Author: Seppo Ingalsuo <[email protected]>
+
+% Get defaults
+bf1 = sof_bf_defaults();
+bf1.fs = fs;
+
+% Setup array
+bf1.array='line';          % Calculate xyz coordinates for line
+bf1.mic_n = 4;
+bf1.mic_d = d;
+bf1.beam_off_defined = prm.add_beam_off;
+bf1.type = prm.type;
+
+% Copy settings for bf2
+bf2 = bf1;
+
+% Design beamformer 1 (left)
+bf1.steer_az = a1;
+bf1.steer_el = 0 * a1;
+bf1.input_channel_select        = [0 1 2 3];  % Input four channels
+bf1.output_channel_mix          = [1 1 1 1];  % Mix filters to channel 2^0
+bf1.output_channel_mix_beam_off = [1 0 0 2];  % Filter 1 to channel 2^0, filter 4 to channel 2^1
+bf1.output_stream_mix           = [0 0 0 0];  % Mix filters to stream 0
+bf1.num_output_channels = 2;
+bf1.fn = 10;                                  % Figs 10....
+bf1 = sof_bf_filenames_helper(bf1);
+bf1 = sof_bf_design(bf1);
+
+% Design beamformer 2 (right)
+bf2.steer_az = a2;
+bf2.steer_el = 0 * a2;
+bf2.input_channel_select        = [0 1 2 3];  % Input two channels
+bf2.output_channel_mix          = [2 2 2 2];  % Mix filters to channel 2^1
+bf2.output_channel_mix_beam_off = [0 0 0 0];  % Filters omitted
+bf2.output_stream_mix           = [0 0 0 0];  % Mix filters to stream 0
+bf2.num_output_channels = 2;
+bf2.fn = 20;                                      % Figs 20....
+bf2 = sof_bf_filenames_helper(bf2);
+bf2 = sof_bf_design(bf2);
+
+% Merge two beamformers into single description, set file names
+bfm = sof_bf_merge(bf1, bf2);
+bfm.sofctl3_fn = fullfile(bfm.sofctl3_path, fn.sofctl3_fn);
+bfm.tplg1_fn = fullfile(bfm.tplg1_path, fn.tplg1_fn);
+bfm.sofctl4_fn = fullfile(bfm.sofctl4_path, fn.sofctl4_fn);
+bfm.tplg2_fn = fullfile(bfm.tplg2_path, fn.tplg2_fn);
+
+% Export files for topology and sof-ctl
+bfm.export_note = prm.export_note;
+bfm.export_howto = prm.export_howto;
+sof_bf_export(bfm);
+
+end

src/audio/tdfb/tune/sof_example_all.sh

@@ -1,12 +1,13 @@
 #!/bin/bash
 
 # SPDX-License-Identifier: BSD-3-Clause
-# Copyright(c) 2022 Intel Corporation. All rights reserved.
+# Copyright(c) 2022-2024 Intel Corporation.
 
 set -e
 
 CONFIG_LIST=( sof_example_pass_config sof_example_line_array
-	      sof_example_line_0mm36mm146mm182mm sof_example_circular_array sof_example_two_beams )
+	      sof_example_line_0mm36mm146mm182mm sof_example_circular_array
+	      sof_example_two_beams sof_example_two_beams_default )
 OCTAVE_CMD=( octave --no-window-system )
 MATLAB_CMD=( matlab -nodisplay -batch )
 

src/audio/tdfb/tune/sof_example_line_array.m

@@ -16,8 +16,10 @@ function sof_example_line_array()
 az = -90:15:90;
 close all; line_one_beam(48e3, 50e-3, az, 2, 64);
 close all; line_one_beam(48e3, 68e-3, az, 2, 64);
+close all; line_one_beam(48e3, 73.5e-3, az, 2, 64);
 close all; line_one_beam(16e3, 50e-3, az, 2, 40);
 close all; line_one_beam(16e3, 68e-3, az, 2, 40);
+close all; line_one_beam(16e3, 73.5e-3, az, 2, 40);
 
 %% 4 mic arrays
 close all; line_one_beam(48e3, 28e-3, az, 4, 80);

src/audio/tdfb/tune/sof_example_pass_config.m

@@ -20,7 +20,9 @@ function sof_example_pass_config()
 bf.num_output_channels  = 2;     % Two channels
 bf.num_output_streams   = 1;     % One sink stream
 bf.beam_off_defined     = 0;     % No need for separate bypass definition
-bf.num_angles           = 0;     % No beams defined
+bf.num_angles           = 1;     % Need at least one beam defined even
+bf.steer_az             = 0;     %   if no processing happens, claim it's
+bf.steer_el             = 0;     %   angle (0, 0).
 bf.num_filters          = 2;     % Two filters
 
 % Minimal manual design fields for successful export
@@ -36,8 +38,8 @@ function sof_example_pass_config()
 sof_bf_export(bf);
 
 % Setup for four channels
-bf.input_channel_select = [0 1 2 3]; % Input two channels
-bf.output_channel_mix   = [1 2 4 8]; % Filter1 -> ch0, filter2 -> ch1
+bf.input_channel_select = [0 1 2 3]; % Input four channels
+bf.output_channel_mix   = [1 2 4 8]; % Filter1 -> ch0, filter2 -> ch1, ...
 bf.output_stream_mix    = [0 0 0 0]; % Mix both filters to stream 0
 bf.num_output_channels  = 4;         % Four channels
 bf.num_output_streams   = 1;         % One sink stream
@@ -53,4 +55,24 @@ function sof_example_pass_config()
 bf.tplg2_fn = fullfile(bf.tplg2_path, 'line4_pass.conf');
 sof_bf_export(bf);
 
+
+% Setup for four channels to two channels passthrough
+
+bf.input_channel_select = [0 3]; % Input two channels, leftmost, rightmost mic of 4
+bf.output_channel_mix   = [1 2]; % Filter1 -> ch0, filter2 -> ch1
+bf.output_stream_mix    = [0 0]; % Mix both filters to stream 0
+bf.num_output_channels  = 2;     % Two channels
+bf.num_output_streams   = 1;     % One sink stream
+
+% Minimal manual design fields for successful export
+bf.num_filters = 2;
+bf.w = [1 0 0 0; 1 0 0 0]'; % Two FIR filters with first tap set to one
+
+% Files
+bf.sofctl3_fn = fullfile(bf.sofctl3_path, 'coef_line4to2_pass.txt');
+bf.tplg1_fn = fullfile(bf.tplg1_path, 'coef_line4to2_pass.m4');
+bf.sofctl4_fn = fullfile(bf.sofctl4_path, 'line4to2_pass.txt');
+bf.tplg2_fn = fullfile(bf.tplg2_path, 'line4to2_pass.conf');
+sof_bf_export(bf);
+
 end