Audio: TDFB: Tune: Rename top level scripts with sof_ prefix

singalsu · singalsu · commit 3506772cf320 · 2024-06-04T19:04:04.000+03:00
The names of top level functions are prefixed with sof_ to
ensure there is no conflict with other possible scripts. The
paths to other directories are also fixed to work after the
move.

Signed-off-by: Seppo Ingalsuo &lt;seppo.ingalsuo@linux.intel.com&gt;
diff --git a/src/audio/tdfb/tune/sof_bf_array_circ.m b/src/audio/tdfb/tune/sof_bf_array_circ.m
@@ -1,4 +1,4 @@
-% bf = bf_array_circ(bf)
+% bf = sof_bf_array_circ(bf)
 %
 % Inputs
 % bf.mic_n ... number of microphones
@@ -15,7 +15,7 @@
 %
 % Author: Seppo Ingalsuo <seppo.ingalsuo@linux.intel.com>
 
-function bf = bf_array_circ(bf)
+function bf = sof_bf_array_circ(bf)
 
 bf.mic_angle = (0:bf.mic_n-1)*360/bf.mic_n; % Mic 1 at 0 deg
 idx = find(bf.mic_angle > 180); % wrap > 180 deg to -180 .. 0
diff --git a/src/audio/tdfb/tune/sof_bf_array_line.m b/src/audio/tdfb/tune/sof_bf_array_line.m
@@ -1,4 +1,4 @@
-% bf = bf_array_line(bf)
+% bf = sof_bf_array_line(bf)
 %
 % Inputs
 % bf.mic_n ... number of microphones
@@ -15,7 +15,7 @@
 %
 % Author: Seppo Ingalsuo <seppo.ingalsuo@linux.intel.com>
 
-function bf = bf_array_line(bf)
+function bf = sof_bf_array_line(bf)
 
 bf.mic_y = linspace(0, -(bf.mic_n-1) * bf.mic_d, bf.mic_n) ...
 	+ (bf.mic_n-1) * bf.mic_d / 2;
diff --git a/src/audio/tdfb/tune/sof_bf_array_lshape.m b/src/audio/tdfb/tune/sof_bf_array_lshape.m
@@ -1,4 +1,4 @@
-% bf = bf_array_lshape(bf)
+% bf = sof_bf_array_lshape(bf)
 %
 % Inputs
 % bf.mic_nxy ... vector of two with number of microphones along x and y
@@ -15,7 +15,7 @@
 %
 % Author: Seppo Ingalsuo <seppo.ingalsuo@linux.intel.com>
 
-function bf = bf_array_lshape(bf)
+function bf = sof_bf_array_lshape(bf)
 
 bf.mic_x = [];
 bf.mic_y = [];
diff --git a/src/audio/tdfb/tune/sof_bf_array_rect.m b/src/audio/tdfb/tune/sof_bf_array_rect.m
@@ -1,4 +1,4 @@
-% bf = bf_array_rect(bf)
+% bf = sof_bf_array_rect(bf)
 %
 % Inputs
 % bf.mic_nxy ... vector of two with number of microphones along x and y
@@ -15,7 +15,7 @@
 %
 % Author: Seppo Ingalsuo <seppo.ingalsuo@linux.intel.com>
 
-function bf = bf_array_rect(bf)
+function bf = sof_bf_array_rect(bf)
 
 bf.mic_x = [];
 bf.mic_y = [];
diff --git a/src/audio/tdfb/tune/sof_bf_array_rot.m b/src/audio/tdfb/tune/sof_bf_array_rot.m
@@ -1,4 +1,4 @@
-% bf = bf_array_rot(bf)
+% bf = sof_bf_array_rot(bf)
 %
 % Inputs
 % bf.array_angle ... three element vector for x, y, z rotation [degrees]
@@ -17,7 +17,7 @@
 %
 % Author: Seppo Ingalsuo <seppo.ingalsuo@linux.intel.com>
 
-function bf = bf_array_rot(bf)
+function bf = sof_bf_array_rot(bf)
 
 % Equations reference
 % https://en.wikipedia.org/wiki/Rotation_matrix#Basic_rotations
diff --git a/src/audio/tdfb/tune/sof_bf_array_xyz.m b/src/audio/tdfb/tune/sof_bf_array_xyz.m
@@ -1,4 +1,4 @@
-% bf = bf_array_xyz(bf)
+% bf = sof_bf_array_xyz(bf)
 %
 % Inputs
 % bf.mic_x ... x coordinates [m]
@@ -17,7 +17,7 @@
 %
 % Author: Seppo Ingalsuo <seppo.ingalsuo@linux.intel.com>
 
-function bf = bf_array_xyz(bf)
+function bf = sof_bf_array_xyz(bf)
 
 bf.mic_n = length(bf.mic_x);
 bf.mic_x = bf.mic_x - mean(bf.mic_x);
diff --git a/src/audio/tdfb/tune/sof_bf_blob_pack.m b/src/audio/tdfb/tune/sof_bf_blob_pack.m
@@ -1,4 +1,4 @@
-function blob8 = bf_blob_pack(bf, ipc_version)
+function blob8 = sof_bf_blob_pack(bf, ipc_version)
 
 %% Pack TDFB struct to bytes
 %
diff --git a/src/audio/tdfb/tune/sof_bf_defaults.m b/src/audio/tdfb/tune/sof_bf_defaults.m
@@ -1,4 +1,4 @@
-function bf = bf_defaults()
+function bf = sof_bf_defaults()
 
 % Recording array general setup
 bf.taylorwin_sidelobe = -30;
@@ -19,10 +19,11 @@
 bf.array_angle = [0 0 0]; % Array rotation angles for xyz
 bf.tplg_fn = '';
 bf.sofctl_fn = '';
-bf.tplg1_path = '../../topology/topology1/m4/tdfb';
-bf.tplg2_path = '../../topology/topology2/include/components/tdfb';
-bf.sofctl3_path = '../../ctl/ipc3/tdfb';
-bf.sofctl4_path = '../../ctl/ipc4/tdfb';
+sof_tools = '../../../../tools';
+bf.tplg1_path = fullfile(sof_tools, 'topology/topology1/m4/tdfb');
+bf.tplg2_path = fullfile(sof_tools, 'topology/topology2/include/components/tdfb');
+bf.sofctl3_path = fullfile(sof_tools, 'ctl/ipc3/tdfb');
+bf.sofctl4_path = fullfile(sof_tools, 'ctl/ipc4/tdfb');
 bf.data_path = './data';
 bf.endian = 'little';
 bf.fn = 1;
diff --git a/src/audio/tdfb/tune/sof_bf_design.m b/src/audio/tdfb/tune/sof_bf_design.m
@@ -1,4 +1,4 @@
-% bf = bf_design(bf)
+% bf = sof_bf_design(bf)
 %
 % This script calculates beamformer filters with superdirective design
 % criteria.
@@ -9,10 +9,9 @@
 %
 % Author: Seppo Ingalsuo <seppo.ingalsuo@linux.intel.com>
 
-function bf = bf_design(bf)
+function bf = sof_bf_design(bf)
 
-addpath('../../test/audio/test_utils');
-addpath('../../test/audio/std_utils');
+sof_bf_paths(1);
 mkdir_check('plots');
 mkdir_check('data');
 
@@ -30,15 +29,15 @@
 
 switch lower(bf.array)
 	case 'line'
-		bf = bf_array_line(bf);
+		bf = sof_bf_array_line(bf);
 	case 'circular'
-		bf = bf_array_circ(bf);
+		bf = sof_bf_array_circ(bf);
 	case 'rectangle'
-		bf = bf_array_rect(bf);
+		bf = sof_bf_array_rect(bf);
 	case 'lshape'
-		bf = bf_array_lshape(bf);
+		bf = sof_bf_array_lshape(bf);
 	case 'xyz'
-		bf = bf_array_xyz(bf);
+		bf = sof_bf_array_xyz(bf);
 	otherwise
 		error('Invalid array type')
 end
@@ -51,7 +50,7 @@
 	end
 end
 
-bf = bf_array_rot(bf);
+bf = sof_bf_array_rot(bf);
 
 % The design function handles only single (az, el) value, so need to
 % loop every steer angle.
@@ -88,11 +87,11 @@
 bf.mat_fn = all_mat_fn;
 bf.w = w_all;
 
+sof_bf_paths(0);
 end
 
 function bf = bf_one_design(bf)
 
-
 %% Defaults
 j = complex(0,-1);
 fs = bf.fs;
diff --git a/src/audio/tdfb/tune/sof_bf_export.m b/src/audio/tdfb/tune/sof_bf_export.m
@@ -1,4 +1,4 @@
-% bf_export(bf)
+% sof_bf_export(bf)
 %
 % Inputs
 % bf.sofctl3_fn .... filename of ascii text format blob
@@ -13,12 +13,10 @@
 %
 % Author: Seppo Ingalsuo <seppo.ingalsuo@linux.intel.com>
 
-function bf = bf_export(bf)
+function bf = sof_bf_export(bf)
 
-% Use functionc from common, test utils
-addpath('../common');
-addpath('../eq');
-addpath('../../test/audio/test_utils');
+% Use functions from common, test utils
+sof_bf_paths(1);
 
 %% Add needed default controls if missing
 
@@ -76,8 +74,8 @@
 
 %% Build blob
 bf.all_filters = filters;
-bp3 = bf_blob_pack(bf, 3);
-bp4 = bf_blob_pack(bf, 4);
+bp3 = sof_bf_blob_pack(bf, 3);
+bp4 = sof_bf_blob_pack(bf, 4);
 
 %% Export
 if isempty(bf.sofctl3_fn)
@@ -118,8 +116,6 @@
 	tplg2_write(bf.tplg2_fn, bp4, "tdfb_config", export_note, bf.export_howto);
 end
 
-rmpath('../../test/audio/test_utils');
-rmpath('../eq');
-rmpath('../common');
+sof_bf_paths(0);
 
 end
diff --git a/src/audio/tdfb/tune/sof_bf_filenames_helper.m b/src/audio/tdfb/tune/sof_bf_filenames_helper.m
@@ -1,4 +1,4 @@
-% bf = bf_filenames_helper(bf, id)
+% bf = sof_bf_filenames_helper(bf, id)
 %
 % Automatically defines output files names based on array geometry
 % and steer angle.
@@ -9,7 +9,7 @@
 %
 % Author: Seppo Ingalsuo <seppo.ingalsuo@linux.intel.com>
 
-function bf = bf_filenames_helper(bf, id)
+function bf = sof_bf_filenames_helper(bf, id)
 
 switch lower(bf.array)
 	case {'rectangle' 'lshape'}
diff --git a/src/audio/tdfb/tune/sof_bf_merge.m b/src/audio/tdfb/tune/sof_bf_merge.m
@@ -1,12 +1,12 @@
-% bfm = bf_merge(bf1, bf2)
+% bfm = sof_bf_merge(bf1, bf2)
 
 % SPDX-License-Identifier: BSD-3-Clause
 %
 % Copyright (c) 2020, Intel Corporation. All rights reserved.
 %
 % Author: Seppo Ingalsuo <seppo.ingalsuo@linux.intel.com>
 
-function bfm = bf_merge(bf1, bf2)
+function bfm = sof_bf_merge(bf1, bf2)
 
 if nargin > 2
 	error('Current implementation can merge only two beams configuration');
diff --git a/src/audio/tdfb/tune/sof_example_all.sh b/src/audio/tdfb/tune/sof_example_all.sh
@@ -5,8 +5,8 @@
 
 set -e
 
-CONFIG_LIST=( example_pass_config example_line_array
-	      example_line_0mm36mm146mm182mm example_circular_array example_two_beams )
+CONFIG_LIST=( sof_example_pass_config sof_example_line_array
+	      sof_example_line_0mm36mm146mm182mm sof_example_circular_array sof_example_two_beams )
 OCTAVE_CMD=( octave --no-window-system )
 MATLAB_CMD=( matlab -nodisplay -batch )
 
diff --git a/src/audio/tdfb/tune/sof_example_circular_array.m b/src/audio/tdfb/tune/sof_example_circular_array.m
@@ -1,4 +1,4 @@
-function example_circular_array()
+function sof_example_circular_array()
 
 % example_circular_array()
 %
@@ -27,7 +27,7 @@ function example_circular_array()
 function circular_one_beam(fs, r, n, fir_length, az);
 
 % Get defaults
-bf = bf_defaults();
+bf = sof_bf_defaults();
 bf.input_channel_select = 0:(n-1);            % Input all n channels to filters
 bf.output_channel_mix_beam_off = zeros(1, n); % For some stereo symmetry
 bf.output_channel_mix_beam_off(2) = 1;        % Mic2 to channel 2^0
@@ -47,9 +47,9 @@ function example_circular_array()
 bf.fir_length = fir_length;
 
 % Design
-bf = bf_filenames_helper(bf);
-bf = bf_design(bf);
-bf.export_note = 'Created with script example_circular_array.m';
-bf.export_howto = 'cd tools/tune/tdfb; octave --no-window-system example_circular_array.m';
-bf_export(bf);
+bf = sof_bf_filenames_helper(bf);
+bf = sof_bf_design(bf);
+bf.export_note = 'Created with script sof_example_circular_array.m';
+bf.export_howto = 'cd tools/tune/tdfb; octave --no-window-system sof_example_circular_array.m';
+sof_bf_export(bf);
 end
diff --git a/src/audio/tdfb/tune/sof_example_direction_emphasis.m b/src/audio/tdfb/tune/sof_example_direction_emphasis.m
diff --git a/src/audio/tdfb/tune/sof_example_line_0mm36mm146mm182mm.m b/src/audio/tdfb/tune/sof_example_line_0mm36mm146mm182mm.m
@@ -1,4 +1,4 @@
-function example_line_0mm36mm146mm182mm()
+function sof_example_line_0mm36mm146mm182mm()
 
 % Creates beamformer for device with device with microphones
 % at 0, 36, 146, 182mm locations
@@ -23,7 +23,7 @@ function line_xyz(fs, fir_length, az)
 
 % Get defaults
 close all;
-bf = bf_defaults();
+bf = sof_bf_defaults();
 bf.fs = fs;
 bf.beta = 5;
 
@@ -50,12 +50,12 @@ function line_xyz(fs, fir_length, az)
 
 %bf.sofctl_fn = fullfile(bf.sofctl_path, sofctl_fn);
 %bf.tplg_fn = fullfile(bf.tplg_path, tplg_fn);
-bf = bf_filenames_helper(bf, 'line4_0mm36mm146mm182mm');
-bf = bf_design(bf);
+bf = sof_bf_filenames_helper(bf, 'line4_0mm36mm146mm182mm');
+bf = sof_bf_design(bf);
 
 % Export files for topology and sof-ctl
 bf.export_note = 'Created with script example_line_0mm36mm146mm182mm.m';
 bf.export_howto = 'cd tools/tune/tdfb; octave --no-window-system example_line_0mm36mm146mm182mm.m';
-bf_export(bf);
+sof_bf_export(bf);
 
 end
diff --git a/src/audio/tdfb/tune/sof_example_line_array.m b/src/audio/tdfb/tune/sof_example_line_array.m
@@ -1,4 +1,4 @@
-function example_line_array()
+function sof_example_line_array()
 
 % example_line_array()
 %
@@ -32,7 +32,7 @@ function example_line_array()
 
 function line_one_beam(fs, d, az, n_mic, n_fir)
 	% Get defaults
-	bf = bf_defaults();
+	bf = sof_bf_defaults();
 	bf.input_channel_select = 0:(n_mic-1);      % Input all n channels to filters
 	bf.output_channel_mix = 3 * ones(1, n_mic); % Mix all filters to channel 1 and 2
 	bf.output_stream_mix = zeros(1, n_mic);     % Mix filters to stream 0
@@ -56,9 +56,9 @@ function line_one_beam(fs, d, az, n_mic, n_fir)
 	end
 
 	% Design
-	bf = bf_filenames_helper(bf);
-	bf = bf_design(bf);
-	bf.export_note = 'Created with script example_line_array.m';
-	bf.export_howto = 'cd tools/tune/tdfb; octave --no-window-system example_line_array.m';
-	bf_export(bf);
+	bf = sof_bf_filenames_helper(bf);
+	bf = sof_bf_design(bf);
+	bf.export_note = 'Created with script sof_example_line_array.m';
+	bf.export_howto = 'cd tools/tune/tdfb; octave --no-window-system sof_example_line_array.m';
+	sof_bf_export(bf);
 end
diff --git a/src/audio/tdfb/tune/sof_example_pass_config.m b/src/audio/tdfb/tune/sof_example_pass_config.m
@@ -1,4 +1,4 @@
-function example_pass_config()
+function sof_example_pass_config()
 
 % example_pass_config()
 %
@@ -13,7 +13,7 @@ function example_pass_config()
 % Author: Seppo Ingalsuo <seppo.ingalsuo@linux.intel.com>
 
 % Setup for two channels
-bf = bf_defaults();
+bf = sof_bf_defaults();
 bf.input_channel_select = [0 1]; % Input two channels
 bf.output_channel_mix   = [1 2]; % Filter1 -> ch0, filter2 -> ch1
 bf.output_stream_mix    = [0 0]; % Mix both filters to stream 0
@@ -27,13 +27,13 @@ function example_pass_config()
 bf.w = [1 0 0 0; 1 0 0 0]'; % Two FIR filters with first tap set to one
 
 % Files
-bf.export_note = 'Exported with script example_pass_config.m';
-bf.export_howto = 'cd tools/tune/tdfb; octave --no-window-system example_pass_config.m';
+bf.export_note = 'Exported with script sof_example_pass_config.m';
+bf.export_howto = 'cd tools/tune/tdfb; octave --no-window-system sof_example_pass_config.m';
 bf.sofctl3_fn = fullfile(bf.sofctl3_path, 'coef_line2_pass.txt');
 bf.tplg1_fn = fullfile(bf.tplg1_path, 'coef_line2_pass.m4');
 bf.sofctl4_fn = fullfile(bf.sofctl4_path, 'line2_pass.txt');
 bf.tplg2_fn = fullfile(bf.tplg2_path, 'line2_pass.conf');
-bf_export(bf);
+sof_bf_export(bf);
 
 % Setup for four channels
 bf.input_channel_select = [0 1 2 3]; % Input two channels
@@ -51,6 +51,6 @@ function example_pass_config()
 bf.tplg1_fn = fullfile(bf.tplg1_path, 'coef_line4_pass.m4');
 bf.sofctl4_fn = fullfile(bf.sofctl4_path, 'line4_pass.txt');
 bf.tplg2_fn = fullfile(bf.tplg2_path, 'line4_pass.conf');
-bf_export(bf);
+sof_bf_export(bf);
 
 end
diff --git a/src/audio/tdfb/tune/sof_example_two_beams.m b/src/audio/tdfb/tune/sof_example_two_beams.m

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-% bf = bf_array_circ(bf)`
	`1`	`+% bf = sof_bf_array_circ(bf)`
`2`	`2`	`%`
`3`	`3`	`% Inputs`
`4`	`4`	`% bf.mic_n ... number of microphones`
`@@ -15,7 +15,7 @@`
`15`	`15`	`%`
`16`	`16`	`% Author: Seppo Ingalsuo <seppo.ingalsuo@linux.intel.com>`
`17`	`17`
`18`		`-function bf = bf_array_circ(bf)`
	`18`	`+function bf = sof_bf_array_circ(bf)`
`19`	`19`
`20`	`20`	`bf.mic_angle = (0:bf.mic_n-1)*360/bf.mic_n; % Mic 1 at 0 deg`
`21`	`21`	`idx = find(bf.mic_angle > 180); % wrap > 180 deg to -180 .. 0`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-% bf = bf_array_line(bf)`
	`1`	`+% bf = sof_bf_array_line(bf)`
`2`	`2`	`%`
`3`	`3`	`% Inputs`
`4`	`4`	`% bf.mic_n ... number of microphones`
`@@ -15,7 +15,7 @@`
`15`	`15`	`%`
`16`	`16`	`% Author: Seppo Ingalsuo <seppo.ingalsuo@linux.intel.com>`
`17`	`17`
`18`		`-function bf = bf_array_line(bf)`
	`18`	`+function bf = sof_bf_array_line(bf)`
`19`	`19`
`20`	`20`	`bf.mic_y = linspace(0, -(bf.mic_n-1) * bf.mic_d, bf.mic_n) ...`
`21`	`21`	`+ (bf.mic_n-1) * bf.mic_d / 2;`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-% bf = bf_array_lshape(bf)`
	`1`	`+% bf = sof_bf_array_lshape(bf)`
`2`	`2`	`%`
`3`	`3`	`% Inputs`
`4`	`4`	`% bf.mic_nxy ... vector of two with number of microphones along x and y`
`@@ -15,7 +15,7 @@`
`15`	`15`	`%`
`16`	`16`	`% Author: Seppo Ingalsuo <seppo.ingalsuo@linux.intel.com>`
`17`	`17`
`18`		`-function bf = bf_array_lshape(bf)`
	`18`	`+function bf = sof_bf_array_lshape(bf)`
`19`	`19`
`20`	`20`	`bf.mic_x = [];`
`21`	`21`	`bf.mic_y = [];`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-% bf = bf_array_rect(bf)`
	`1`	`+% bf = sof_bf_array_rect(bf)`
`2`	`2`	`%`
`3`	`3`	`% Inputs`
`4`	`4`	`% bf.mic_nxy ... vector of two with number of microphones along x and y`
`@@ -15,7 +15,7 @@`
`15`	`15`	`%`
`16`	`16`	`% Author: Seppo Ingalsuo <seppo.ingalsuo@linux.intel.com>`
`17`	`17`
`18`		`-function bf = bf_array_rect(bf)`
	`18`	`+function bf = sof_bf_array_rect(bf)`
`19`	`19`
`20`	`20`	`bf.mic_x = [];`
`21`	`21`	`bf.mic_y = [];`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-% bf = bf_array_rot(bf)`
	`1`	`+% bf = sof_bf_array_rot(bf)`
`2`	`2`	`%`
`3`	`3`	`% Inputs`
`4`	`4`	`% bf.array_angle ... three element vector for x, y, z rotation [degrees]`
`@@ -17,7 +17,7 @@`
`17`	`17`	`%`
`18`	`18`	`% Author: Seppo Ingalsuo <seppo.ingalsuo@linux.intel.com>`
`19`	`19`
`20`		`-function bf = bf_array_rot(bf)`
	`20`	`+function bf = sof_bf_array_rot(bf)`
`21`	`21`
`22`	`22`	`% Equations reference`
`23`	`23`	`% https://en.wikipedia.org/wiki/Rotation_matrix#Basic_rotations`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-% bf = bf_array_xyz(bf)`
	`1`	`+% bf = sof_bf_array_xyz(bf)`
`2`	`2`	`%`
`3`	`3`	`% Inputs`
`4`	`4`	`% bf.mic_x ... x coordinates [m]`
`@@ -17,7 +17,7 @@`
`17`	`17`	`%`
`18`	`18`	`% Author: Seppo Ingalsuo <seppo.ingalsuo@linux.intel.com>`
`19`	`19`
`20`		`-function bf = bf_array_xyz(bf)`
	`20`	`+function bf = sof_bf_array_xyz(bf)`
`21`	`21`
`22`	`22`	`bf.mic_n = length(bf.mic_x);`
`23`	`23`	`bf.mic_x = bf.mic_x - mean(bf.mic_x);`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-function blob8 = bf_blob_pack(bf, ipc_version)`
	`1`	`+function blob8 = sof_bf_blob_pack(bf, ipc_version)`
`2`	`2`
`3`	`3`	`%% Pack TDFB struct to bytes`
`4`	`4`	`%`