LADI
/
portaudio
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update docs: compile_windows_mingw-w64.dox to warn of loud sawtooth example (#718) 

The sawtooth example is absurdly loud. If it's left as part of the default build steps, it will probably cause some hearing damage. This moves it into a separate section with a warning.
This commit is contained in:
Kevin Yin 2022-06-21 19:22:57 -04:00 committed by GitHub
parent 1a9b91c9b2
commit 1de0d8ea48
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/src/tutorial/compile_windows_mingw-w64.dox
View File

@ -16,7 +16,7 @@ You can either use msys2's precompiled PortAudio or compile PortAudio yourself.
Open your msys2 shell and run "pacman -S mingw-w64-x86_64-portaudio". This will get you a default build of PortAudio. I believe it comes with DirectSound, WASAPI, WD/MKS, WD/MKS_DEVICE_INFO, and WMME. Note the "-x86_64" in the middle of the package name. When you install msys2 packages, you specify the toolchain name in the middle, and "-x86_64" chooses the msvcrt-gcc toolchain.
@section comp_mingw-w64_3 Compiling
@section comp_mingw-w64_3 Compiling from scratch
We will build with WASAPI only, with no fallback APIs, simply as an example. In the msys2 shell, navigate into your folder of PortAudio. Run:
@ -26,6 +26,11 @@ mkdir build
cd build
cmake -G Ninja .. -DCMAKE_BUILD_TYPE=Release -DPA_USE_DS=0 -DPA_USE_WDMKS=0 -DPA_USE_WDMKS_DEVICE_INFO=0 -DPA_USE_WMME=0
cmake --build .
@endcode
To test if it is working, you can run the sawtooth example (warning, it is very loud!):
@code
gcc ../examples/paex_saw.c -I../src/common -lportaudio
./a.exe
@endcode