-
Notifications
You must be signed in to change notification settings - Fork 288
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Documentation for premake, examples, more on the biquad filters
- Loading branch information
1 parent
8a8b2da
commit 2b22b4f
Showing
7 changed files
with
132 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| Examples | ||
| ======== | ||
|
|
||
| SoLoud package comes with a few simple examples. These can be found under the 'demos' directory. Pre-built binaries for Windows can also be found in the 'bin' directory. | ||
|
|
||
| simplest | ||
| -------- | ||
|
|
||
| The simplest example initializes SoLoud with winmm (for windows) or portaudio (otherwise), and uses the speech synthesizer to play some sound. Once the sound has finished, the application cleans up and quits. | ||
|
|
||
| This example also uses SoLoud's cross-platform thread library to sleep while waiting for the sound to end. | ||
|
|
||
| multimusic | ||
| ---------- | ||
|
|
||
| The multimusic example loads two OGG music loops as well as one sound effect. You can use the keyboard keys 1 through 5 for various effects: | ||
|
|
||
| Key Effect | ||
| ----- -------- | ||
| 1 Play sound effect at random play speed and pan | ||
| 2 Fade music 1 in and music 2 out | ||
| 3 Fade music 2 in and music 1 out | ||
| 4 Fade music relative play speed way down | ||
| 5 Fade music relative play speed to normal | ||
|
|
||
| piano | ||
| ----- | ||
|
|
||
| This example is a simple implementation of a playable instrument. The example also includes a simple waveform generator (soloud_basicwave.cpp/h), which can produce square, saw, sine and triangle waves. If compiled to use portmidi, you can also use a midi keyboard to drive the example. | ||
|
|
||
| The 1234.. and qwer.. rows of your keyboard can be used to play notes. asdf.. row selects waveform, and zxcv.. row selects filters. Speech synthesizer and on-screen text describes what different keys do. Have fun experimenting! | ||
|
|
||
| mixbusses | ||
| --------- | ||
|
|
||
| The mixbusses example demonstrates the use of mixing busses. You can use "qw", "as" and "zx" keys to adjust volume of different busses. | ||
|
|
||
| env | ||
| --- | ||
|
|
||
| The env demo is a non-interactive demo of how SoLoud could be used to play environmental audio. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| Premake | ||
| ======= | ||
|
|
||
| SoLoud comes with a premake4 script. If you want to build SoLoud as static library, instead of including the source files in your project, this can be handy. | ||
|
|
||
| Premake can be downloaded from <http://industriousone.com/premake>. | ||
|
|
||
| Unfortunately, premake4 cannot magically figure out where your libraries may be installed, so you may have to edit the premake4.lua file. The lines to edit can be found at the very beginning of the file, with the following defaults: | ||
|
|
||
| local sdl_root = "/libraries/sdl" | ||
| local portmidi_root = "/libraries/portmidi" | ||
| local dxsdk_root = "C:/Program Files (x86)/Microsoft ..." | ||
| local portaudio_root = "/libraries/portaudio" | ||
| local openal_root = "/libraries/openal" | ||
|
|
||
| You will most likely want to edit at least the sdl_root variable. After your edits, you can run premake4 to generate makefiles or the IDE project files of your preference, such as: | ||
|
|
||
| premake4 vs2010 | ||
|
|
||
| The current version (4.3) supports codeblocks, codelite, vs2002, vs2003, vs2005, vs2008, vs2010, xcode3 and gnu makefiles (gmake). New version with at least vs2012 support is coming soon (as of this writing). | ||
|
|
||
| If you wish to use portmidi with the piano example, run premake with an additional parameter: | ||
|
|
||
| premake4 --with-portmidi vs2010 | ||
|
|