Skip to content

Commit 5f7e422

Browse files
committed
Audio: TDFB: Tune: Add a README file
This patch adds a README.md file that explains how various blob generate scrips are used. Signed-off-by: Seppo Ingalsuo <seppo.ingalsuo@linux.intel.com>
1 parent 2703a3e commit 5f7e422

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

src/audio/tdfb/tune/README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Settings blobs generators for TDFB
2+
3+
This directory contains the scripts to generate settings blobs for
4+
the time-domain fixed beamformer (TDFB) for various microphone array
5+
geometries and beamformer features.
6+
7+
The requirement is Octave or Matlab with signal processing package.
8+
9+
The most straightforward way to generate all blobs for topologies,
10+
sof-ctl and UCM is to run command
11+
12+
```
13+
./sof_example_all.sh
14+
```
15+
16+
It creates the blobs for passthrough mode, single beam blobs for
17+
line and circular arrays, and dual beam blobs for stereo audio
18+
capture. Running it can take about 30 minutes.
19+
20+
All the topology ASCII text format blobs contain instructions
21+
how to generate them from command line shell. E.g. these
22+
commands do a more fine grained build.
23+
24+
```
25+
cd $SOF_WORKSPACE/sof
26+
27+
# Generate pass-through blobs
28+
cd tools/tune/tdfb; octave --no-window-system example_pass_config.m
29+
30+
# Generate blobs for line array and single beam
31+
cd tools/tune/tdfb; octave --no-window-system example_line_array.m
32+
33+
# Generate blobs for stereo capture for arrays with known mm-spacing
34+
cd tools/tune/tdfb; matlab -nodisplay -nosplash -nodesktop -r example_two_beams
35+
36+
# Generate bobs for stereo capture for generic arrays with known microphones count
37+
cd tools/tune/tdfb; matlab -nodisplay -nosplash -nodesktop -r example_two_beams_default
38+
```
39+
40+
Further information about TDFB component is available in SOF Docs, see
41+
https://thesofproject.github.io/latest/algos/tdfb/time_domain_fixed_beamformer.html

0 commit comments

Comments
 (0)