Skip to content

GitHub mirror for the DSP library's docs/tests

License

Notifications You must be signed in to change notification settings

Signalsmith-Audio/dsp-doc

Repository files navigation

DSP Library: Documentation and Tests

This provides tests and doc-generating scripts for Signalsmith Audio's DSP Library.

This should be placed as a sub-directory of the main DSP library (e.g. doc/).

Tests

Tests are in tests/, and (where possible) they test the actual audio characteristics of the tools (e.g. frequency responses and aliasing levels).

make tests

You can compile/run just specific groups of tests, based on the subfolders in tests/, e.g.:

make test-delay

The tests are defined with some simple macros. Some tests use random numbers, but you can reproduce a run by setting SEED= when running.

Plots

Some of the tests write results to CSV files (as well as verifying them). Any Python files in the tests/ (sub-)directory are run if the tests succeed, and these generally plot the CSV results into graphs.

Both the tests and the Python scripts are run from the out/analysis/ directory.

You'll need SciPy/NumPy and Matplotlib. These Python plots are being gradually replaced by my C++ plotting library.

There are some supplemental animations, which (if you have ffmpeg installed) you can generate with:

make analysis-animations