shithub: soundpipe

ref: 0df3039072e1eb47d710348117063fa45cfaf2dd
dir: /modules/data/fmpair.lua/

View raw version
sptbl["fmpair"] = {

    files = {
        module = "fmpair.c",
        header = "fmpair.h",
        example = "ex_fmpair.c",
    },

    func = {
        create = "sp_fmpair_create",
        destroy = "sp_fmpair_destroy",
        init = "sp_fmpair_init",
        compute = "sp_fmpair_compute",
    },

    params = {
        mandatory = {
            {
                name = "tbl",
                type = "sp_ftbl *",
                description = "Wavetable to read from. Note: the size of this table must be a power of 2.",
                default = "N/A"
            },
        },
        optional = {
            {
                name = "freq",
                type = "SPFLOAT",
                description = "Frequency (in Hz)",
                default = 440
            },
            {
                name = "amp",
                type = "SPFLOAT",
                description ="Amplitude (typically a value between 0 and 1).",
                default = 0.4
            },
            {
                name = "car",
                type = "SPFLOAT",
                description ="Carrier frequency, expressed as a ratio number in C:M ratio. Typically an integer.",
                default = 1
            },
            {
                name = "mod",
                type = "SPFLOAT",
                description ="Modulator frequency, expressed as a ratio number in C:M ratio. Typically an integer.",
                default = 1
            },
            {
                name = "indx",
                type = "SPFLOAT",
                description ="Modulation index. Most commercial synthesizers have a range from 0-8, but there's nothing stopping you from going beyond that.",
                default = 8
            },
        }
    },

    modtype = "module",

    description = [[FM oscilator pair with linear interpolation]],

    ninputs = 0,
    noutputs = 1,

    inputs = {
        {
            name = "dummy",
            description = "This does nothing."
        },
    },

    outputs = {
        {
            name = "out",
            description = "Signal out."
        },
    }

}