Expand description
§sunvox-sys
FFI bindings to the Sunvox library (http://warmplace.ru/soft/sunvox).
Structs§
- sunvox_
note - A single note cell in a pattern.
Constants§
- NOTECMD_
ALL_ NOTES_ OFF - Notes of all synths off.
- NOTECMD_
CLEAN_ SYNTHS - Stop and clean all synths.
- NOTECMD_
NOTE_ OFF - Single note off.
- NOTECMD_
PLAY - NOTECMD_
PREV_ TRACK - Apply effect in this note cell to the corresponding one in the previous track.
- NOTECMD_
SET_ PITCH - Change the pitch of a currently playing note.
- NOTECMD_
STOP - SV_
INIT_ FLAG_ AUDIO_ FLOA T32 - Audio is float (
c_float). - SV_
INIT_ FLAG_ AUDIO_ INT16 - Audio is signed 16-bit (
c_short). - SV_
INIT_ FLAG_ NO_ DEBUG_ OUTPUT - Supresses debug output from the SunVox library.
- SV_
INIT_ FLAG_ ONE_ THREAD - Audio callback and song modification functions are in a single thread.
- SV_
INIT_ FLAG_ USER_ AUDIO_ CALLBACK - Interaction with sound card is on the user side.
- SV_
MODULE_ FLAG_ EFFECT - SV_
MODULE_ FLAG_ EXISTS - SV_
MODULE_ INPUTS_ MASK - SV_
MODULE_ INPUTS_ OFF - SV_
MODULE_ OUTPUTS_ MASK - SV_
MODULE_ OUTPUTS_ OFF - SV_
STYPE_ FLOA T32 - SV_
STYPE_ FLOA T64 - SV_
STYPE_ INT16 - SV_
STYPE_ INT32
Functions§
- sv_
audio_ ⚠callback - Gets the next piece of SunVox audio.
- sv_
close_ ⚠slot - Closes a slot. See
sv_open_slot()for more details. - sv_
connect_ ⚠module - Connects the source to the destination. USE LOCK/UNLOCK!
- sv_
deinit ⚠ - Deinitializes the library.
- sv_
disconnect_ ⚠module - Disconnects the source from the destination. USE LOCK/UNLOCK!
- sv_
end_ ⚠of_ song - Gets whether the project is stopped (ie. not playing).
- sv_
get_ ⚠current_ line - Gets the line number of the play cursor.
- sv_
get_ ⚠current_ line2 - Gets the line number of the play in fixed point format: 27.5
- sv_
get_ ⚠current_ signal_ level - Gets the current signal level/amplitude for a given audio channel in the range 0 to 255 inclusive.
- sv_
get_ ⚠module_ color - sv_
get_ ⚠module_ ctl_ name - sv_
get_ ⚠module_ ctl_ value - sv_
get_ ⚠module_ flags - sv_
get_ ⚠module_ inputs - sv_
get_ ⚠module_ name - sv_
get_ ⚠module_ outputs - sv_
get_ ⚠module_ scope - sv_
get_ ⚠module_ scope2 - Return value: received number of samples (may be less or equal to
samples_to_read). - sv_
get_ ⚠module_ xy - sv_
get_ ⚠number_ of_ module_ ctls - sv_
get_ ⚠number_ of_ modules - Gets the number of modules in the currently loaded project?
- sv_
get_ ⚠number_ of_ patterns - sv_
get_ ⚠pattern_ data - How to use sv_get_pattern_data():
- sv_
get_ ⚠pattern_ lines - sv_
get_ ⚠pattern_ tracks - sv_
get_ ⚠pattern_ x - sv_
get_ ⚠pattern_ y - sv_
get_ ⚠sample_ type - Gets the internal sample type of the SunVox engine.
- sv_
get_ ⚠song_ bpm - Gets the Beats Per Minute of the currently loaded project.
- sv_
get_ ⚠song_ length_ frames - Gets the currently loaded song’s length in audio samples/frames.
- sv_
get_ ⚠song_ length_ lines - Gets the currently loaded song’s length in pattern lines.
- sv_
get_ ⚠song_ name - Gets the name of the currently loaded project.
- sv_
get_ ⚠song_ tpl - Gets the Ticks Per Line of the currently loaded project.
- sv_
get_ ⚠ticks - Gets the current tick counter (from 0 to 0xFFFFFFFF).
- sv_
get_ ⚠ticks_ per_ second - Gets the number of SunVox ticks per second.
- sv_init⚠
- Initializes the library.
- sv_load⚠
- Loads a SunVox project file into the specified slot.
- sv_
load_ ⚠from_ memory - Loads a SunVox project from file data in memory. TEST
- sv_
load_ ⚠module - Loads a module.
- sv_
lock_ ⚠slot - Locks a slot.
- sv_
new_ ⚠module - Creates a new module. USE LOCK/UNLOCK!
- sv_
open_ ⚠slot - Opens a slot.
- sv_
pattern_ ⚠mute - USE LOCK/UNLOCK!
- sv_play⚠
- Starts playing the project from the current play cursor position.
- sv_
play_ ⚠from_ beginning - Starts playing the project from the beginning.
- sv_
remove_ ⚠module - Removes the specified module. USE LOCK/UNLOCK!
- sv_
rewind ⚠ - Rewinds the project to the beginning.
- sv_
sampler_ ⚠load - Loads a sample to an existing Sampler.
- sv_
send_ ⚠event - Causes an event to occur as though it had been played in a pattern.
- sv_
set_ ⚠autostop - Enables or disables autostop.
- sv_stop⚠
- Stops playing the project. The play cursor stays where it is.
- sv_
unlock_ ⚠slot - Unlocks a slot. See
sv_lock_slot()for more details. - sv_
volume ⚠ - Sets the volume of the project.