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 * Sets the opacity (alpha) of every pixel in an image to a constant value.
049 */
050public class OpacityFilter extends PointFilter  implements DynFiltering {
051        
052        private int opacity;
053        private int opacity24;
054
055        /**
056         * Construct an OpacityFilter with 50% opacity.
057         */
058        public OpacityFilter() {
059                this(0x88);
060        }
061
062        /**
063         * Construct an OpacityFilter with the given opacity (alpha).
064         * @param opacity the opacity (alpha) in the range 0..255
065         */
066        public OpacityFilter(int opacity) {
067                setOpacity(opacity);
068        }
069
070        /**
071         * Set the opacity.
072         * @param opacity the opacity (alpha) in the range 0..255
073     * @see #getOpacity
074         */
075        public void setOpacity(int opacity) {
076                this.opacity = opacity;
077                opacity24 = opacity << 24;
078        }
079        
080        /**
081         * Get the opacity setting.
082         * @return the opacity
083     * @see #setOpacity
084         */
085        public int getOpacity() {
086                return opacity;
087        }
088        
089        public int filterRGB(int x, int y, int rgb) {
090                if ((rgb & 0xff000000) != 0)
091                        return (rgb & 0xffffff) | opacity24;
092                return rgb;
093        }
094
095        public String toString() {
096                return "Colors/Transparency...";
097        }
098
099        public BufferedImage filter(BufferedImage src, Struct parameters) throws PageException {BufferedImage dst=ImageUtil.createBufferedImage(src);
100                Object o;
101                if((o=parameters.removeEL(KeyImpl.init("Opacity")))!=null)setOpacity(ImageFilterUtil.toIntValue(o,"Opacity"));
102                if((o=parameters.removeEL(KeyImpl.init("Dimensions")))!=null){
103                        int[] dim=ImageFilterUtil.toDimensions(o,"Dimensions");
104                        setDimensions(dim[0],dim[1]);
105                }
106
107                // check for arguments not supported
108                if(parameters.size()>0) {
109                        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 [Opacity, Dimensions]");
110                }
111
112                return filter(src, dst);
113        }
114}
115