Ecosyste.ms: Awesome

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

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

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

Last synced: about 1 month ago
JSON representation

Surge waveshapers as a GPL3 library

Lists

README

        

# SST Waveshapers

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

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

Current waveshapers include:
- Saturators
- Rectifiers
- Wavefolders
- Additive
- Fuzzes
- Trigonometric

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

## Usage

`sst-waveshapers` 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-waveshapers)
target_link_libraries(My-Killer-App PUBLIC sst-waveshapers)
```

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

## Building Unit Tests

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

## Building Examples

To build the sst-waveshapers examples:
```bash
cmake -Bbuild -DSST_WAVESHAPERS_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.