001/**
002 *
003 * Copyright (c) 2014, the Railo Company Ltd. All rights reserved.
004 *
005 * This library is free software; you can redistribute it and/or
006 * modify it under the terms of the GNU Lesser General Public
007 * License as published by the Free Software Foundation; either 
008 * version 2.1 of the License, or (at your option) any later version.
009 * 
010 * This library is distributed in the hope that it will be useful,
011 * but WITHOUT ANY WARRANTY; without even the implied warranty of
012 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
013 * Lesser General Public License for more details.
014 * 
015 * You should have received a copy of the GNU Lesser General Public 
016 * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
017 * 
018 **/
019/*
020*
021
022Licensed under the Apache License, Version 2.0 (the "License");
023you may not use this file except in compliance with the License.
024You may obtain a copy of the License at
025
026   http://www.apache.org/licenses/LICENSE-2.0
027
028Unless required by applicable law or agreed to in writing, software
029distributed under the License is distributed on an "AS IS" BASIS,
030WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
031See the License for the specific language governing permissions and
032limitations under the License.
033*/
034
035package lucee.runtime.img.filter;import java.awt.image.BufferedImage;
036
037import lucee.runtime.engine.ThreadLocalPageContext;
038import lucee.runtime.exp.FunctionException;
039import lucee.runtime.exp.PageException;
040import lucee.runtime.img.ImageUtil;
041import lucee.runtime.type.KeyImpl;
042import lucee.runtime.type.Struct;
043import lucee.runtime.type.util.CollectionUtil;
044
045
046
047/**
048 * Applies a bit mask to each ARGB pixel of an image. You can use this for, say, masking out the red channel.
049 */
050public class MaskFilter extends PointFilter  implements DynFiltering {
051
052        private int mask;
053
054        public MaskFilter() {
055                this(0xff00ffff);
056        }
057
058        public MaskFilter(int mask) {
059                canFilterIndexColorModel = true;
060                setMask(mask);
061        }
062
063        public void setMask(int mask) {
064                this.mask = mask;
065        }
066
067        public int getMask() {
068                return mask;
069        }
070
071        public int filterRGB(int x, int y, int rgb) {
072                return rgb & mask;
073        }
074
075        public String toString() {
076                return "Mask";
077        }
078
079        public BufferedImage filter(BufferedImage src, Struct parameters) throws PageException {BufferedImage dst=ImageUtil.createBufferedImage(src);
080                Object o;
081                if((o=parameters.removeEL(KeyImpl.init("Mask")))!=null)setMask(ImageFilterUtil.toIntValue(o,"Mask"));
082                if((o=parameters.removeEL(KeyImpl.init("Dimensions")))!=null){
083                        int[] dim=ImageFilterUtil.toDimensions(o,"Dimensions");
084                        setDimensions(dim[0],dim[1]);
085                }
086
087                // check for arguments not supported
088                if(parameters.size()>0) {
089                        throw new FunctionException(ThreadLocalPageContext.get(), "ImageFilter", 3, "parameters", "the parameter"+(parameters.size()>1?"s":"")+" ["+CollectionUtil.getKeyList(parameters,", ")+"] "+(parameters.size()>1?"are":"is")+" not allowed, only the following parameters are supported [Mask, Dimensions]");
090                }
091
092                return filter(src, dst);
093        }
094}