shithub: soundpipe

ref: 233c9646efb377aac5b0d87df6f8a16be94fa3fe
dir: /modules/data/tenv2.lua/

View raw version
sptbl["tenv2"] = {

    files = {
        module = "tenv2.c",
        header = "tenv2.h",
        example = "ex_tenv2.c",
    },

    func = {
        create = "sp_tenv2_create",
        destroy = "sp_tenv2_destroy",
        init = "sp_tenv2_init",
        compute = "sp_tenv2_compute",
    },

    params = {
        optional = {
            {
                name = "atk",
                type = "SPFLOAT",
                description = "Attack time (in seconds).",
                default = 0.1
            },
            {
                name = "rel",
                type = "SPFLOAT",
                description ="Release time (in seconds).",
                default = 0.1
            },
        }
    },

    modtype = "module",

    description = [[Linear 2-stage Attack/Release envelope generator

    This envelope takes 2 triggers. When triggered once,
the envelope will rise to 1 according to the attack time. When triggered again, it will decay to 0 according to
the decay time.]],

    ninputs = 1,
    noutputs = 1,

    inputs = {
        {
            name = "trig",
            description = "Expects a trigger signal."
        },
    },

    outputs = {
        {
            name = "out",
            description = "Signal out (a unipolar envelope)."
        },
    }

}