org.jaudiolibs.pipes.units.Mod Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pipes-units Show documentation
Unit Generator Pipes for use with the Pipes API
The newest version!
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2019 Neil C Smith.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License version 3 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
 * version 3 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License version 3
 * along with this work; if not, see http://www.gnu.org/licenses/
 *
 */
package org.jaudiolibs.pipes.units;

import java.util.List;
import java.util.function.DoubleBinaryOperator;
import org.jaudiolibs.pipes.Buffer;
import org.jaudiolibs.pipes.Pipe;

/**
 * A multi input unit that accumulates inputs into a single output using a
 * custom function, or by multiplying if a custom function is not set.
 */
public final class Mod extends Pipe {

    private DoubleBinaryOperator function;

    /**
     * Create a Mod unit supporting up to 32 input channels.
     */
    public Mod() {
        super(32, 1);
    }

    /**
     * Custom function to accumulate input channels. The first input channel
     * will be copied to the output. Values from each additional input channel
     * will be accumulated to the output using this function, where the first
     * value (left) is the existing output value, and the second value (right)
     * is the value from the input channel. The default function will multiply
     * values.
     *
     * @param function custom function to apply to each sample
     * @return this for chaining
     */
    public Mod function(DoubleBinaryOperator function) {
        this.function = function;
        return this;
    }

    @Override
    protected void process(List buffers) {
        int sourceCount = getSourceCount();
        if (sourceCount < 2) {
            return;
        }
        float[] out = buffers.get(0).getData();
        int size = buffers.get(0).getSize();
        for (int i = 1; i < getSourceCount(); i++) {
            float[] in = buffers.get(i).getData();
            if (function == null) {
                for (int k = 0; k < size; k++) {
                    out[k] *= in[k];
                }
            } else {
                for (int k = 0; k < size; k++) {
                    out[k] = (float) function.applyAsDouble(in[k], out[k]);
                }
            }
        }
    }

    @Override
    protected void writeOutput(List inputs, Buffer output, int index) {
        super.writeOutput(inputs, output, 0);

    }

    @Override
    public void reset() {
        function = null;
    }

}