toxiclibs 0.4.0 → 0.8.0

data/src/toxi/audio/SoundListener.java

@@ -0,0 +1,154 @@
+/*
+ *   __               .__       .__  ._____.           
+ * _/  |_  _______  __|__| ____ |  | |__\_ |__   ______
+ * \   __\/  _ \  \/  /  |/ ___\|  | |  || __ \ /  ___/
+ *  |  | (  <_> >    <|  \  \___|  |_|  || \_\ \\___ \ 
+ *  |__|  \____/__/\_ \__|\___  >____/__||___  /____  >
+ *                   \/       \/             \/     \/ 
+ *
+ * Copyright (c) 2006-2011 Karsten Schmidt
+ * 
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ * 
+ * http://creativecommons.org/licenses/LGPL/2.1/
+ * 
+ * This library 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 for more details.
+ * 
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
+ * Modified and updated by Martin Prout December 2015
+ */
+
+package toxi.audio;
+
+import com.jogamp.openal.AL;
+import toxi.geom.Vec3D;
+
+/**
+ * The concept of a SoundListener refers directly to the user's instance in the
+ * virtual (audio) world. By setting the 3D position, velocity and orientation
+ * of the listener, the underlying audio hardware can produce a realistic 3D
+ * spatial sound simulation (incl. doppler effect, volume falloff etc.).
+ * 
+ * <p>
+ * Like {@link AudioSource}, this class extends {@link Vec3D} and so if the
+ * position of the listener is changed via the public x,y,z vector components,
+ * the <code>updatePosition()</code> method needs to be called afterwards in
+ * order to reflect these changes in the OpenAL context.
+ */
+public final class SoundListener extends Vec3D {
+
+    protected JOALUtil liboal;
+
+    protected final float[] position = { 0.0f, 0.0f, 0.0f };
+    protected final float[] velocity = { 0.0f, 0.0f, 0.0f };
+    protected final float[] orient = { 0.0f, 1.0f, 0.0f, 0.0f, 0.0f, 1.0f };
+
+    protected SoundListener(JOALUtil lib) {
+        super();
+        liboal = lib;
+        setGain(1f);
+        setPosition(position);
+        setVelocity(velocity);
+        setOrientation(orient);
+    }
+
+    public final float[] getOrientation() {
+        return orient;
+    }
+
+    public final float[] getPosition() {
+        return position;
+    }
+
+    public final float[] getVelocity() {
+        return velocity;
+    }
+
+    public final SoundListener setGain(float gain) {
+        liboal.getAL().alListenerf(AL.AL_GAIN, gain);
+        return this;
+    }
+
+    public SoundListener setOrientation(float upX, float upY, float upZ,
+            float forwardX, float forwardY, float forwardZ) {
+        orient[0] = upX;
+        orient[1] = upY;
+        orient[2] = upZ;
+        orient[3] = forwardX;
+        orient[4] = forwardY;
+        orient[5] = forwardZ;
+        liboal.getAL().alListenerfv(AL.AL_ORIENTATION, orient, 0);
+        return this;
+    }
+
+    public SoundListener setOrientation(float[] o) {
+        if (o.length == 6) {
+            orient[0] = o[0];
+            orient[1] = o[1];
+            orient[2] = o[2];
+            orient[3] = o[3];
+            orient[4] = o[4];
+            orient[5] = o[5];
+            liboal.getAL().alListenerfv(AL.AL_ORIENTATION, orient, 0);
+        } else {
+            throw new IllegalArgumentException("wrong number of array elements");
+        }
+        return this;
+    }
+
+    public SoundListener setPosition(float xx, float yy, float zz) {
+        x = position[0] = xx;
+        y = position[1] = yy;
+        z = position[2] = zz;
+        liboal.getAL().alListenerfv(AL.AL_POSITION, position, 0);
+        return this;
+    }
+
+    public final SoundListener setPosition(float[] p) {
+        if (p.length == 3) {
+            x = position[0] = p[0];
+            y = position[1] = p[1];
+            z = position[2] = p[2];
+            liboal.getAL().alListenerfv(AL.AL_POSITION, position, 0);
+        } else {
+            throw new IllegalArgumentException("wrong number of elements");
+        }
+        return this;
+    }
+
+    public SoundListener setVelocity(float xx, float yy, float zz) {
+        velocity[0] = xx;
+        velocity[1] = yy;
+        velocity[2] = zz;
+        liboal.getAL().alListenerfv(AL.AL_VELOCITY, velocity, 0);
+        return this;
+    }
+
+    public final SoundListener setVelocity(float[] v) {
+        if (v.length == 3) {
+            velocity[0] = v[0];
+            velocity[1] = v[1];
+            velocity[2] = v[2];
+            liboal.getAL().alListenerfv(AL.AL_VELOCITY, velocity, 0);
+        } else {
+            throw new IllegalArgumentException("wrong number of elements");
+        }
+        return this;
+    }
+
+    public SoundListener updatePosition() {
+        position[0] = x;
+        position[1] = y;
+        position[2] = z;
+        liboal.getAL().alListenerfv(AL.AL_POSITION, position, 0);
+        return this;
+    }
+}

data/src/toxi/audio/SynthUtil.java

@@ -0,0 +1,109 @@
+/*
+ *   __               .__       .__  ._____.           
+ * _/  |_  _______  __|__| ____ |  | |__\_ |__   ______
+ * \   __\/  _ \  \/  /  |/ ___\|  | |  || __ \ /  ___/
+ *  |  | (  <_> >    <|  \  \___|  |_|  || \_\ \\___ \ 
+ *  |__|  \____/__/\_ \__|\___  >____/__||___  /____  >
+ *                   \/       \/             \/     \/ 
+ *
+ * Copyright (c) 2006-2011 Karsten Schmidt
+ * 
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ * 
+ * http://creativecommons.org/licenses/LGPL/2.1/
+ * 
+ * This library 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 for more details.
+ * 
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
+ * Modified and updated by Martin Prout December 2015
+ */
+package toxi.audio;
+
+import java.nio.ByteBuffer;
+
+/**
+ * This class provides static conversion tools for translating normalized
+ * floating point wave data into 16bit PCM.
+ */
+public class SynthUtil {
+
+    public static AudioBuffer floatArrayTo16bitBuffer(JOALUtil audioSys,
+            float[] raw, int rate) {
+        byte[] pcm = floatArrayTo16bitPCM(raw);
+        AudioBuffer buffer = audioSys.generateBuffers(1)[0];
+        buffer.configure(ByteBuffer.wrap(pcm), AudioBuffer.Format.MONO16, rate);
+        return buffer;
+    }
+
+    public static byte[] floatArrayTo16bitPCM(float[] raw) {
+        byte[] sample = new byte[raw.length * 2];
+        for (int i = 0, j = 0; i < raw.length; i++) {
+            int pcm = (int) (raw[i] * 0x8000);
+            sample[j++] = (byte) (pcm & 0xff);
+            sample[j++] = (byte) (pcm >> 8 & 0xff);
+        }
+        return sample;
+    }
+
+    public static AudioBuffer floatArrayTo16bitStereoBuffer(JOALUtil audioSys,
+            float[] raw, int rate) {
+        byte[] pcm = floatArrayTo16bitPCM(raw);
+        AudioBuffer buffer = audioSys.generateBuffers(1)[0];
+        buffer.configure(ByteBuffer.wrap(pcm), AudioBuffer.Format.STEREO16,
+                rate);
+        return buffer;
+    }
+
+    public static AudioBuffer floatArrayTo8bitBuffer(JOALUtil audioSys,
+            float[] raw, int rate) {
+        byte[] pcm = floatArrayTo8bitPCM(raw);
+        AudioBuffer buffer = audioSys.generateBuffers(1)[0];
+        buffer.configure(ByteBuffer.wrap(pcm), AudioBuffer.Format.MONO8, rate);
+        return buffer;
+    }
+
+    public static byte[] floatArrayTo8bitPCM(float[] raw) {
+        byte[] sample = new byte[raw.length];
+        for (int i = 0; i < raw.length; i++) {
+            sample[i] = (byte) (raw[i] * 0x7f + 0x80);
+        }
+        return sample;
+    }
+
+    public static AudioBuffer floatArrayTo8bitStereoBuffer(JOALUtil audioSys,
+            float[] raw, int rate) {
+        byte[] pcm = floatArrayTo8bitPCM(raw);
+        AudioBuffer buffer = audioSys.generateBuffers(1)[0];
+        buffer.configure(ByteBuffer.wrap(pcm), AudioBuffer.Format.STEREO8, rate);
+        return buffer;
+    }
+
+    /**
+     * Merges the two given mono arrays into an interleaved stereo array in
+     * left-right order.
+     *
+     * @param left
+     * @param right
+     * @return stereo array
+     */
+    public static float[] joinMonoFloatArrays(float[] left, float[] right) {
+        if (left.length != right.length) {
+            throw new IllegalArgumentException(
+                    "left & right channels need to be of equal size");
+        }
+        float[] stereo = new float[left.length * 2];
+        for (int i = 0, j = 0; i < left.length; i++, j += 2) {
+            stereo[j] = left[i];
+            stereo[j + 1] = right[i];
+        }
+        return stereo;
+    }
+}

data/src/toxi/color/AccessCriteria.java

@@ -0,0 +1,114 @@
+/*
+ *   __               .__       .__  ._____.           
+ * _/  |_  _______  __|__| ____ |  | |__\_ |__   ______
+ * \   __\/  _ \  \/  /  |/ ___\|  | |  || __ \ /  ___/
+ *  |  | (  <_> >    <|  \  \___|  |_|  || \_\ \\___ \ 
+ *  |__|  \____/__/\_ \__|\___  >____/__||___  /____  >
+ *                   \/       \/             \/     \/ 
+ *
+ * Copyright (c) 2006-2011 Karsten Schmidt
+ * 
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ * 
+ * http://creativecommons.org/licenses/LGPL/2.1/
+ * 
+ * This library 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 for more details.
+ * 
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
+ */
+
+package toxi.color;
+
+import java.util.Comparator;
+
+/**
+ * Defines standard color component access criterias and associated comparators
+ * used to sort colors based on component values. If a new custom accessor is
+ * needed (e.g. for sub-classes TColor's), then simply sub-class this class and
+ * implement the {@link Comparator} interface and the 2 abstract getter & setter
+ * methods defined by this class.
+ */
+public abstract class AccessCriteria implements Comparator<ReadonlyTColor> {
+
+    /**
+     *
+     */
+    public static final AccessCriteria HUE = new HSVAccessor(0);
+
+    /**
+     *
+     */
+    public static final AccessCriteria SATURATION = new HSVAccessor(1);
+
+    /**
+     *
+     */
+    public static final AccessCriteria BRIGHTNESS = new HSVAccessor(2);
+
+    /**
+     *
+     */
+    public static final AccessCriteria RED = new RGBAccessor(0);
+
+    /**
+     *
+     */
+    public static final AccessCriteria GREEN = new RGBAccessor(1);
+
+    /**
+     *
+     */
+    public static final AccessCriteria BLUE = new RGBAccessor(2);
+
+    /**
+     *
+     */
+    public static final AccessCriteria CYAN = new CMYKAccessor(0);
+
+    /**
+     *
+     */
+    public static final AccessCriteria MAGENTA = new CMYKAccessor(1);
+
+    /**
+     *
+     */
+    public static final AccessCriteria YELLOW = new CMYKAccessor(2);
+
+    /**
+     *
+     */
+    public static final AccessCriteria BLACK = new CMYKAccessor(3);
+
+    /**
+     *
+     */
+    public static final AccessCriteria ALPHA = new AlphaAccessor();
+
+    /**
+     *
+     */
+    public static final AccessCriteria LUMINANCE = new LuminanceAccessor();
+
+    /**
+     *
+     * @param col
+     * @return
+     */
+    public abstract float getComponentValueFor(ReadonlyTColor col);
+
+    /**
+     *
+     * @param col
+     * @param value
+     */
+    public abstract void setComponentValueFor(TColor col, float value);
+}

data/src/toxi/color/AlphaAccessor.java

@@ -0,0 +1,67 @@
+/*
+ *   __               .__       .__  ._____.           
+ * _/  |_  _______  __|__| ____ |  | |__\_ |__   ______
+ * \   __\/  _ \  \/  /  |/ ___\|  | |  || __ \ /  ___/
+ *  |  | (  <_> >    <|  \  \___|  |_|  || \_\ \\___ \ 
+ *  |__|  \____/__/\_ \__|\___  >____/__||___  /____  >
+ *                   \/       \/             \/     \/ 
+ *
+ * Copyright (c) 2006-2011 Karsten Schmidt
+ * 
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ * 
+ * http://creativecommons.org/licenses/LGPL/2.1/
+ * 
+ * This library 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 for more details.
+ * 
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
+ */
+
+package toxi.color;
+
+/**
+ * Compares 2 colors by their alpha value.
+ */
+public class AlphaAccessor extends AccessCriteria {
+
+    /**
+     *
+     * @param a
+     * @param b
+     * @return
+     */
+    @Override
+    public int compare(ReadonlyTColor a, ReadonlyTColor b) {
+        float aa = a.alpha();
+        float ba = b.alpha();
+        return aa < ba ? -1 : aa > ba ? 1 : 0;
+    }
+
+    /**
+     *
+     * @param col
+     * @return
+     */
+    @Override
+    public float getComponentValueFor(ReadonlyTColor col) {
+        return col.alpha();
+    }
+
+    /**
+     *
+     * @param col
+     * @param value
+     */
+    @Override
+    public void setComponentValueFor(TColor col, float value) {
+        col.setAlpha(value);
+    }
+}

data/src/toxi/color/CMYKAccessor.java

@@ -0,0 +1,122 @@
+/*
+ *   __               .__       .__  ._____.           
+ * _/  |_  _______  __|__| ____ |  | |__\_ |__   ______
+ * \   __\/  _ \  \/  /  |/ ___\|  | |  || __ \ /  ___/
+ *  |  | (  <_> >    <|  \  \___|  |_|  || \_\ \\___ \ 
+ *  |__|  \____/__/\_ \__|\___  >____/__||___  /____  >
+ *                   \/       \/             \/     \/ 
+ *
+ * Copyright (c) 2006-2011 Karsten Schmidt
+ * 
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ * 
+ * http://creativecommons.org/licenses/LGPL/2.1/
+ * 
+ * This library 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 for more details.
+ * 
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
+ */
+
+package toxi.color;
+
+/**
+ * Compares 2 colors by one of their CMYK component values.
+ */
+public class CMYKAccessor extends AccessCriteria {
+
+    private final int component;
+
+    /**
+     *
+     * @param comp
+     */
+    public CMYKAccessor(int comp) {
+        component = comp;
+    }
+
+    /**
+     *
+     * @param a
+     * @param b
+     * @return
+     */
+    @Override
+    public int compare(ReadonlyTColor a, ReadonlyTColor b) {
+        float ca, cb;
+        switch (component) {
+            case 0:
+                ca = a.cyan();
+                cb = b.cyan();
+                break;
+            case 1:
+                ca = a.magenta();
+                cb = b.magenta();
+                break;
+            case 2:
+                ca = a.yellow();
+                cb = b.yellow();
+                break;
+            case 3:
+            default:
+                ca = a.black();
+                cb = b.black();
+        }
+        return Float.compare(ca, cb);
+    }
+
+    /**
+     *
+     * @param col
+     * @return
+     */
+    @Override
+    public float getComponentValueFor(ReadonlyTColor col) {
+        float comp;
+        switch (component) {
+            case 0:
+                comp = col.cyan();
+                break;
+            case 1:
+                comp = col.magenta();
+                break;
+            case 2:
+                comp = col.yellow();
+                break;
+            case 3:
+            default:
+                comp = col.black();
+        }
+        return comp;
+    }
+
+    /**
+     *
+     * @param col
+     * @param val
+     */
+    @Override
+    public void setComponentValueFor(TColor col, float val) {
+        switch (component) {
+            case 0:
+                col.setCyan(val);
+                break;
+            case 1:
+                col.setMagenta(val);
+                break;
+            case 2:
+                col.setYellow(val);
+                break;
+            case 3:
+            default:
+                col.setBlack(val);
+        }
+    }
+}