ref: 25a9fcc24ad00c6a406042818b9e6f2e7bba0dd1
dir: /modules/data/nsmp.lua/
sptbl["nsmp"] = {
files = {
module = "nsmp.c",
header = "nsmp.h",
example = "ex_nsmp.c",
},
func = {
create = "sp_nsmp_create",
destroy = "sp_nsmp_destroy",
init = "sp_nsmp_init",
compute = "sp_nsmp_compute",
other = {
sp_nsmp_print_index = {
description = "Prints the index and their corresponding keyword",
args = {
}
}
}
},
params = {
mandatory = {
{
name = "ft",
type = "sp_ftbl*",
description = "ftbl of the audio file. It should be mono.",
default = "N/A"
},
{
name = "sr",
type = "int",
description = "samplerate.",
default = "N/A"
},
{
name = "init",
type = "const char*",
description = "ini file.",
default = "N/A"
}
},
optional = {
{
name = "index",
type = "uint32_t",
description = "This is an optional parameter. These values are always set to a value by default, and can be set after the init function has been called.",
default = 0
},
}
},
modtype = "module",
description = [[Nanosamp: a tiny sampler built for Soundpipe
A nanosamp file is comprised of a mono audio file and an ini file. Nanosamp is geared towards percussive and found sound sample players, and is intended to be combined with soundpipe modules.
The ini file contains mappings that correspond to the audio file. Such an entry would look like this:
[keyword]
pos = 2.3
size = 3
</pre>
In this instance, an entry called "keyword" has been made, starting at 2.3 seconds in the
audio file, with a length of 3 seconds. An example file oneart.ini has been created in the
examples folder.
The SoundPipe implementation of nanosamp will automatically index the entries
in the order they appear in the INI file and must be selected this way by changing the index
parameter. Soundpipe will only select the new entry when the trigger input is a non-zero value.
]],
ninputs = 1,
noutputs = 1,
inputs = {
{
name = "trigger",
description = "Trigger input."
},
},
outputs = {
{
name = "signal out",
description = "Signal output."
},
}
}