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 * A filter which can be used to produce wipes by transferring the luma of a mask image into the alpha channel of the source.
047 */
048public class GradientWipeFilter extends AbstractBufferedImageOp  implements DynFiltering {
049        
050        private float density = 0;
051        private float softness = 0;
052        private boolean invert;
053        private BufferedImage mask;
054
055        public GradientWipeFilter() {
056        }
057
058        /**
059         * Set the density of the image in the range 0..1.
060         * *arg density The density
061         */
062        public void setDensity( float density ) {
063                this.density = density;
064        }
065        
066        public float getDensity() {
067                return density;
068        }
069        
070        /**
071         * Set the softness of the dissolve in the range 0..1.
072         * @param softness the softness
073     * @min-value 0
074     * @max-value 1
075     * @see #getSoftness
076         */
077        public void setSoftness( float softness ) {
078                this.softness = softness;
079        }
080        
081        /**
082         * Get the softness of the dissolve.
083         * @return the softness
084     * @see #setSoftness
085         */
086        public float getSoftness() {
087                return softness;
088        }
089        
090        public void setMask( BufferedImage mask ) {
091                this.mask = mask;
092        }
093        
094        public BufferedImage getMask() {
095                return mask;
096        }
097        
098        public void setInvert( boolean invert ) {
099                this.invert = invert;
100        }
101        
102        public boolean getInvert() {
103                return invert;
104        }
105        
106    public BufferedImage filter( BufferedImage src, BufferedImage dst ) {
107        int width = src.getWidth();
108        int height = src.getHeight();
109
110        if ( dst == null )
111            dst = createCompatibleDestImage( src, null );
112                if ( mask == null )
113                        return dst;
114
115        int maskWidth = mask.getWidth();
116        int maskHeight = mask.getHeight();
117
118                float d = density * (1+softness);
119                float lower = 255 * (d-softness);
120                float upper = 255 * d;
121
122                int[] inPixels = new int[width];
123                int[] maskPixels = new int[maskWidth];
124
125        for ( int y = 0; y < height; y++ ) {
126                        getRGB( src, 0, y, width, 1, inPixels );
127                        getRGB( mask, 0, y % maskHeight, maskWidth, 1, maskPixels );
128
129                        for ( int x = 0; x < width; x++ ) {
130                                int maskRGB = maskPixels[x % maskWidth];
131                                int inRGB = inPixels[x];
132                                int v = PixelUtils.brightness( maskRGB );
133                                float f = ImageMath.smoothStep( lower, upper, v );
134                                int a = (int)(255 * f);
135
136                                if ( invert )
137                                        a = 255-a;
138                                inPixels[x] = (a << 24) | (inRGB & 0x00ffffff);
139                        }
140
141                        setRGB( dst, 0, y, width, 1, inPixels );
142        }
143
144        return dst;
145    }
146
147        public String toString() {
148                return "Transitions/Gradient Wipe...";
149        }
150        public BufferedImage filter(BufferedImage src, Struct parameters) throws PageException {BufferedImage dst=ImageUtil.createBufferedImage(src);
151                Object o;
152                if((o=parameters.removeEL(KeyImpl.init("Density")))!=null)setDensity(ImageFilterUtil.toFloatValue(o,"Density"));
153                if((o=parameters.removeEL(KeyImpl.init("Softness")))!=null)setSoftness(ImageFilterUtil.toFloatValue(o,"Softness"));
154                if((o=parameters.removeEL(KeyImpl.init("Invert")))!=null)setInvert(ImageFilterUtil.toBooleanValue(o,"Invert"));
155                if((o=parameters.removeEL(KeyImpl.init("Mask")))!=null)setMask(ImageFilterUtil.toBufferedImage(o,"Mask"));
156
157                // check for arguments not supported
158                if(parameters.size()>0) {
159                        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 [Density, Softness, Invert, Mask]");
160                }
161
162                return filter(src, dst);
163        }
164}