Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/surge-synthesizer/sst-filters

Surge filters as a GPL3 library
https://github.com/surge-synthesizer/sst-filters

Last synced: 3 months ago
JSON representation

Surge filters as a GPL3 library

Host: GitHub
URL: https://github.com/surge-synthesizer/sst-filters
Owner: surge-synthesizer
License: gpl-3.0
Created: 2022-01-17T18:23:05.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2024-11-01T15:16:48.000Z (3 months ago)
Last Synced: 2024-11-01T16:21:24.682Z (3 months ago)
Language: C++
Homepage: https://surge-synthesizer.github.io/sst-docs/docs/sst-filters
Size: 356 KB
Stars: 18
Watchers: 6
Forks: 10
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

awesome-juce - sst-filters - synthesizer](https://github.com/surge-synthesizer) | Surge filters as a separate library| GPL-3.0|19|3 months󠀠󠀠🟢| (DSP)

README

# SST Filters

Tests: [![CI Build Status](https://dev.azure.com/surge-synthesizer/surge/_apis/build/status/surge-synthesizer.sst-filters?branchName=main)](https://dev.azure.com/surge-synthesizer/surge/_apis/build/status/surge-synthesizer.sst-filters?branchName=main)

This repository contains the filters from the
[Surge Synthesizer](https://github.com/surge-synthesizer/surge)
as a submodule.

Current filters include:
- Original Surge filters:
- LPF/HPF/BPF/Notch/APF
- "Legacy" Ladder
- Comb
- Sample & Hold
- "Vintage" Ladder filters
- OB-Xd filters (ported from [OB-Xd](https://github.com/reales/OB-Xd))
- K35 and Diode Ladder filters (ported from [Odin 2](https://github.com/TheWaveWarden/odin2))
- Cutoff/Resonance Warp filters
- Tri-Pole filter

For more information, see the [API documentation](https://surge-synthesizer.github.io/sst-docs/docs/sst-filters).

## Usage

`sst-filters` is a header-only library, so it is possible to use the library
simply by adding `include/` to your header search paths, and writing
`#include ` somewhere in your source code. However, it is
recommended to use the provided CMake configuration.

```cmake
add_subdirectory(path/to/sst-filters)
target_link_libraries(My-Killer-App PUBLIC sst-filters)
```

**Note: the sst-filters library uses raw SSE SIMD intrinsics. If you
are planning to use this library in a context that may not support SSE
intrisics, it is recommended to also link with
[simde](https://github.com/simd-everywhere/simde).**

## Building Unit Tests

To build and run the sst-filters unit tests:
```bash
cmake -Bbuild
cmake --build build
./build/test-binary/sst-filters-tests
```

## Building Examples

To build the sst-filters examples:
```bash
cmake -Bbuild -DSST_FILTERS_BUILD_EXAMPLES=ON
cmake --build build
```

Example binaries will be located in `build/example-binaries/`.

## License
The code in this repository is licensed under the General Public License v3.