sam/sfizz
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated readme and scripts for Clang

Browse source
This commit is contained in:
paulfd 2019-09-09 12:18:01 +02:00
parent 74204d08e1
commit 15b557946e
4 changed files with 42 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
README.md
View file

@ -1 +1,40 @@
# sfizz
## Building
Sfizz depends on the `sndfile` library.
The Jack client that you will probably build depends on the `jack` library.
To build `sfizz` you need to install both as shared libraries on the system.
In Debian-based distributions, this translates into
```
sudo apt install libjack-jackd2-dev libsndfile1-dev
```
The process is as follows:
1. Clone the repository with all the submodules
2. Create a build directory for CMake and `cd` into it
3. Prep the Makefiles with the `SFIZZ_CLIENTS` option
4. Build
5. Enjoy :)
In the shell world, this means
```sh
git clone --recursive https://github.com/paulfd/sfizz.git
cd sfizz
mkdir build && cd build
cmake -D CMAKE_BUILD_TYPE=Release -D SFIZZ_CLIENTS=ON ..
make
```
You can then find the Jack client in `clients/sfizz_jack`.
Just specify an `.sfz` file as a parameter and you are good to go.
The client will forcefully connect to the system output, and open an event input in Jack for you to connect a midi capable software or hardware (e.g. `jack-keyboard`).
If no Jack server is already started it will start one with basic options.
### Possible pitfalls and alternatives
If you already cloned the repository without the `--recursive` option, update the submodules manually with
```
git submodule update --init --recursive
```
You can build with `clang`, although in that case the CMakeFile defaults to using `libc++` instead of `libstdc++`.

2
scripts/asan_clang.sh
View file

@ -1,3 +1,3 @@
#!/bin/sh
script_dir="$(dirname "$0")"
cmake -D CMAKE_C_COMPILER=clang-9 -D CMAKE_CXX_COMPILER=clang++-9 -D CMAKE_CXX_FLAGS="-fsanitize=address" -D CMAKE_BUILD_TYPE=Release -D SFIZZ_TESTS=ON -D SFIZZ_BENCHMARKS=ON -D SFIZZ_CLIENTS=ON -S "$script_dir/.." -B .
cmake -D CMAKE_C_COMPILER=clang-10 -D CMAKE_CXX_COMPILER=clang++-10 -D CMAKE_CXX_FLAGS="-fsanitize=address" -D CMAKE_BUILD_TYPE=Release -D SFIZZ_TESTS=ON -D SFIZZ_BENCHMARKS=ON -D SFIZZ_CLIENTS=ON -S "$script_dir/.." -B .

2
scripts/debug_clang.sh
View file

@ -1,3 +1,3 @@
#!/bin/sh
script_dir="$(dirname "$0")"
cmake -D CMAKE_C_COMPILER=clang-9 -D CMAKE_CXX_COMPILER=clang++-9 -D CMAKE_BUILD_TYPE=Debug -D SFIZZ_TESTS=ON -D SFIZZ_BENCHMARKS=ON -D SFIZZ_CLIENTS=ON -S "$script_dir/.." -B .
cmake -D CMAKE_C_COMPILER=clang-10 -D CMAKE_CXX_COMPILER=clang++-10 -D CMAKE_BUILD_TYPE=Debug -D SFIZZ_TESTS=ON -D SFIZZ_BENCHMARKS=ON -D SFIZZ_CLIENTS=ON -S "$script_dir/.." -B .

2
scripts/release_clang.sh
View file

@ -1,3 +1,3 @@
#!/bin/sh
script_dir="$(dirname "$0")"
cmake -D CMAKE_C_COMPILER=clang-9 -D CMAKE_CXX_COMPILER=clang++-9 -D CMAKE_BUILD_TYPE=Release -D SFIZZ_TESTS=ON -D SFIZZ_BENCHMARKS=ON -D SFIZZ_CLIENTS=ON -S "$script_dir/.." -B .
cmake -D CMAKE_C_COMPILER=clang-10 -D CMAKE_CXX_COMPILER=clang++-10 -D CMAKE_BUILD_TYPE=Release -D SFIZZ_TESTS=ON -D SFIZZ_BENCHMARKS=ON -D SFIZZ_CLIENTS=ON -S "$script_dir/.." -B .