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.img.math.BinaryFunction;
042import lucee.runtime.img.math.BlackFunction;
043import lucee.runtime.type.KeyImpl;
044import lucee.runtime.type.Struct;
045import lucee.runtime.type.util.CollectionUtil;
046/**
047 * The superclass for some of the filters which work on binary images.
048 */
049public abstract class BinaryFilter extends WholeImageFilter  implements DynFiltering {
050
051        protected int newColor = 0xff000000;
052        protected BinaryFunction blackFunction = new BlackFunction();
053        protected int iterations = 1;
054        protected Colormap colormap;
055
056        /**
057         * Set the number of iterations the effect is performed.
058         * @param iterations the number of iterations
059     * @min-value 0
060     * @see #getIterations
061         */
062        public void setIterations(int iterations) {
063                this.iterations = iterations;
064        }
065
066        /**
067         * Get the number of iterations the effect is performed.
068         * @return the number of iterations
069     * @see #setIterations
070         */
071        public int getIterations() {
072                return iterations;
073        }
074
075    /**
076     * Set the colormap to be used for the filter.
077     * @param colormap the colormap
078     * @see #getColormap
079     */
080        public void setColormap(Colormap colormap) {
081                this.colormap = colormap;
082        }
083
084    /**
085     * Get the colormap to be used for the filter.
086     * @return the colormap
087     * @see #setColormap
088     */
089        public Colormap getColormap() {
090                return colormap;
091        }
092
093        public void setNewColor(int newColor) {
094                this.newColor = newColor;
095        }
096
097        public int getNewColor() {
098                return newColor;
099        }
100
101        public void setBlackFunction(BinaryFunction blackFunction) {
102                this.blackFunction = blackFunction;
103        }
104
105        public BinaryFunction getBlackFunction() {
106                return blackFunction;
107        }
108
109        public BufferedImage filter(BufferedImage src, Struct parameters) throws PageException {BufferedImage dst=ImageUtil.createBufferedImage(src);
110                Object o;
111                if((o=parameters.removeEL(KeyImpl.init("Iterations")))!=null)setIterations(ImageFilterUtil.toIntValue(o,"Iterations"));
112                if((o=parameters.removeEL(KeyImpl.init("Colormap")))!=null)setColormap(ImageFilterUtil.toColormap(o,"Colormap"));
113                if((o=parameters.removeEL(KeyImpl.init("NewColor")))!=null)setNewColor(ImageFilterUtil.toIntValue(o,"NewColor"));
114                
115                // check for arguments not supported
116                if(parameters.size()>0) {
117                        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 [Iterations, Colormap, NewColor, BlackFunction]");
118                }
119
120                return filter(src, dst);
121        }
122}
123