source: josm/trunk/src/org/openstreetmap/josm/gui/layer/imagery/ColorfulFilter.java@ 13397

// License: GPL. For details, see LICENSE file.
package org.openstreetmap.josm.gui.layer.imagery;

import java.awt.Rectangle;
import java.awt.RenderingHints;
import java.awt.geom.Point2D;
import java.awt.geom.Rectangle2D;
import java.awt.image.BufferedImage;
import java.awt.image.BufferedImageOp;
import java.awt.image.ColorModel;
import java.awt.image.DataBuffer;
import java.awt.image.DataBufferByte;
import java.awt.image.IndexColorModel;
import java.util.Objects;
import java.util.Optional;
import java.util.function.Consumer;

import org.openstreetmap.josm.tools.Logging;

/**
 * Colorful filter.
 * @since 11914 (extracted from ColorfulImageProcessor)
 */
public class ColorfulFilter implements BufferedImageOp {
    private static final double LUMINOSITY_RED = .21d;
    private static final double LUMINOSITY_GREEN = .72d;
    private static final double LUMINOSITY_BLUE = .07d;
    private final double colorfulness;

    /**
     * Create a new colorful filter.
     * @param colorfulness The colorfulness as defined in the {@link ColorfulImageProcessor} class.
     */
    ColorfulFilter(double colorfulness) {
        this.colorfulness = colorfulness;
    }

    @Override
    public BufferedImage filter(BufferedImage src, BufferedImage dst) {
        if (src.getWidth() == 0 || src.getHeight() == 0 || src.getType() == BufferedImage.TYPE_CUSTOM) {
            return src;
        }

        BufferedImage dest = Optional.ofNullable(dst).orElseGet(() -> createCompatibleDestImage(src, null));
        int type = src.getType();

        if (type == BufferedImage.TYPE_BYTE_INDEXED) {
            return filterIndexed(src, dest);
        }

        DataBuffer srcBuffer = src.getRaster().getDataBuffer();
        DataBuffer destBuffer = dest.getRaster().getDataBuffer();
        if (!(srcBuffer instanceof DataBufferByte) || !(destBuffer instanceof DataBufferByte)) {
            Logging.trace("Cannot apply color filter: Images do not use DataBufferByte.");
            return src;
        }

        if (type != dest.getType()) {
            Logging.trace("Cannot apply color filter: Src / Dest differ in type (" + type + '/' + dest.getType() + ')');
            return src;
        }
        int redOffset;
        int greenOffset;
        int blueOffset;
        int alphaOffset = 0;
        switch (type) {
        case BufferedImage.TYPE_3BYTE_BGR:
            blueOffset = 0;
            greenOffset = 1;
            redOffset = 2;
            break;
        case BufferedImage.TYPE_4BYTE_ABGR:
        case BufferedImage.TYPE_4BYTE_ABGR_PRE:
            blueOffset = 1;
            greenOffset = 2;
            redOffset = 3;
            break;
        case BufferedImage.TYPE_INT_ARGB:
        case BufferedImage.TYPE_INT_ARGB_PRE:
            redOffset = 0;
            greenOffset = 1;
            blueOffset = 2;
            alphaOffset = 3;
            break;
        default:
            Logging.trace("Cannot apply color filter: Source image is of wrong type (" + type + ").");
            return src;
        }
        doFilter((DataBufferByte) srcBuffer, (DataBufferByte) destBuffer, redOffset, greenOffset, blueOffset,
                alphaOffset, src.getAlphaRaster() != null);
        return dest;
    }

    /**
     * Fast alternative for indexed images: We can change the palette here.
     * @param src The source image
     * @param dest The image to copy the source to
     * @return The image.
     */
    private BufferedImage filterIndexed(BufferedImage src, BufferedImage dest) {
        Objects.requireNonNull(dest, "dst needs to be non null");
        if (src.getType() != BufferedImage.TYPE_BYTE_INDEXED) {
            throw new IllegalArgumentException("Source must be of type TYPE_BYTE_INDEXED");
        }
        if (dest.getType() != BufferedImage.TYPE_BYTE_INDEXED) {
            throw new IllegalArgumentException("Destination must be of type TYPE_BYTE_INDEXED");
        }
        if (!(src.getColorModel() instanceof IndexColorModel)) {
            throw new IllegalArgumentException("Expecting an IndexColorModel for a image of type TYPE_BYTE_INDEXED");
        }
        src.copyData(dest.getRaster());

        IndexColorModel model = (IndexColorModel) src.getColorModel();
        int size = model.getMapSize();
        byte[] red = getIndexColorModelData(size, model::getReds);
        byte[] green = getIndexColorModelData(size, model::getGreens);
        byte[] blue = getIndexColorModelData(size, model::getBlues);
        byte[] alphas = getIndexColorModelData(size, model::getAlphas);

        for (int i = 0; i < size; i++) {
            int r = red[i] & 0xff;
            int g = green[i] & 0xff;
            int b = blue[i] & 0xff;
            double luminosity = r * LUMINOSITY_RED + g * LUMINOSITY_GREEN + b * LUMINOSITY_BLUE;
            red[i] = mix(r, luminosity);
            green[i] = mix(g, luminosity);
            blue[i] = mix(b, luminosity);
        }

        IndexColorModel dstModel = new IndexColorModel(model.getPixelSize(), model.getMapSize(), red, green, blue, alphas);
        return new BufferedImage(dstModel, dest.getRaster(), dest.isAlphaPremultiplied(), null);
    }

    private static byte[] getIndexColorModelData(int size, Consumer<byte[]> consumer) {
        byte[] data = new byte[size];
        consumer.accept(data);
        return data;
    }

    private void doFilter(DataBufferByte src, DataBufferByte dest, int redOffset, int greenOffset, int blueOffset,
            int alphaOffset, boolean hasAlpha) {
        byte[] srcPixels = src.getData();
        byte[] destPixels = dest.getData();
        if (srcPixels.length != destPixels.length) {
            Logging.trace("Cannot apply color filter: Source/Dest lengths differ.");
            return;
        }
        int entries = hasAlpha ? 4 : 3;
        for (int i = 0; i < srcPixels.length; i += entries) {
            int r = srcPixels[i + redOffset] & 0xff;
            int g = srcPixels[i + greenOffset] & 0xff;
            int b = srcPixels[i + blueOffset] & 0xff;
            double luminosity = r * LUMINOSITY_RED + g * LUMINOSITY_GREEN + b * LUMINOSITY_BLUE;
            destPixels[i + redOffset] = mix(r, luminosity);
            destPixels[i + greenOffset] = mix(g, luminosity);
            destPixels[i + blueOffset] = mix(b, luminosity);
            if (hasAlpha) {
                destPixels[i + alphaOffset] = srcPixels[i + alphaOffset];
            }
        }
    }

    private byte mix(int color, double luminosity) {
        int val = (int) (colorfulness * color + (1 - colorfulness) * luminosity);
        if (val < 0) {
            return 0;
        } else if (val > 0xff) {
            return (byte) 0xff;
        } else {
            return (byte) val;
        }
    }

    @Override
    public Rectangle2D getBounds2D(BufferedImage src) {
        return new Rectangle(src.getWidth(), src.getHeight());
    }

    @Override
    public BufferedImage createCompatibleDestImage(BufferedImage src, ColorModel destCM) {
        return new BufferedImage(src.getWidth(), src.getHeight(), src.getType());
    }

    @Override
    public Point2D getPoint2D(Point2D srcPt, Point2D dstPt) {
        return (Point2D) srcPt.clone();
    }

    @Override
    public RenderingHints getRenderingHints() {
        return null;
    }
}