games.rednblack.miniaudio.MANode Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of miniaudio Show documentation
Advanced Audio Engine for libGDX based on MiniAudio
The newest version!
package games.rednblack.miniaudio;

import com.badlogic.gdx.utils.Disposable;

/**
 * Abstract wrapper to node element in the graph effects.
 *
 * @author fgnm
 */
public abstract class MANode implements Disposable {
    protected long address;
    protected final MiniAudio miniAudio;

    public MANode (MiniAudio miniAudio) {
        this.miniAudio = miniAudio;
    }

    /**
     * Get the native memory address for this node
     *
     * @return long that represents the native memory address
     */
    public long getAddress() {
        return address;
    }

    /**
     * Attach to the input of this node another {@link MANode} object
     *
     * @param previousNode the node that should be attached to this node input
     * @param outputBusIndex the output bus index of the node
     */
    public void attachToThisNode(MANode previousNode, int outputBusIndex) {
        attachToThisNode(previousNode, outputBusIndex, 0);
    }

    /**
     * Attach to the input of this node another {@link MANode} object
     *
     * @param previousNode the node that should be attached to this node input
     * @param outputBusIndex the output bus index of the node
     * @param thisBusIndex the input bus index of this node
     */
    public void attachToThisNode(MANode previousNode, int outputBusIndex, int thisBusIndex) {
        if (outputBusIndex >= previousNode.getSupportedOutputs())
            throw new IllegalArgumentException("Wrong output bus number, the node support up to " + previousNode.getSupportedOutputs() + " buses.");

        miniAudio.attachOutputBus(previousNode, outputBusIndex, this, thisBusIndex);
    }

    /**
     * Detach this node in effects graph. If you want to just move the output bus from
     * one attachment to another, you do not need to detach first. You can just call {@link #attachToThisNode} and it'll
     * deal with it for you.
     *
     * @param outputBusIndex output bus index of the node
     */
    public void detach(int outputBusIndex) {
        if (outputBusIndex >= getSupportedOutputs())
            throw new IllegalArgumentException("Wrong output bus number, the node support up to " + getSupportedOutputs() + " buses.");

        miniAudio.detachOutputBus(this, outputBusIndex);
    }

    /**
     * The volume of an output bus can be configured on a per-bus basis.
     *
     * @param outputBusIndex output bus index of the node
     * @param volume of the bus
     */
    public void setOutputBusVolume(int outputBusIndex, float volume) {
        if (outputBusIndex >= getSupportedOutputs())
            throw new IllegalArgumentException("Wrong output bus number, the node support up to " + getSupportedOutputs() + " buses.");

        miniAudio.setOutputBusVolume(this, outputBusIndex, volume);
    }

    /**
     * Returns how many output bus has this node.
     *
     * @return output bus for this node
     */
    public abstract int getSupportedOutputs();

    @Override
    public boolean equals(Object obj) {
        if (obj instanceof MANode) {
            return ((MANode) obj).address == this.address;
        }
        return false;
    }
}