digilib-old: servlet/src/digilib/image/DocuImage.java annotate

annotate servlet/src/digilib/image/DocuImage.java @ 79:63c8186455c1

Servlet version 1.6b. Further cleanup and new functionality: * mirroring * contrast/brightness * rotation (not finished)

author	robcast
date	Mon, 03 Feb 2003 16:04:53 +0100
parents	3b8797fc3e90
children	4e6757e8ccd4

rev	line source
1 0ff3ede32060 Initial revision robcast parents: diff changeset	1 /* DocuImage -- General image interface class
0ff3ede32060 Initial revision robcast parents: diff changeset	2
0ff3ede32060 Initial revision robcast parents: diff changeset	3 Digital Image Library servlet components
0ff3ede32060 Initial revision robcast parents: diff changeset	4
0ff3ede32060 Initial revision robcast parents: diff changeset	5 Copyright (C) 2001, 2002 Robert Casties (robcast@mail.berlios.de)
0ff3ede32060 Initial revision robcast parents: diff changeset	6
0ff3ede32060 Initial revision robcast parents: diff changeset	7 This program is free software; you can redistribute it and/or modify it
0ff3ede32060 Initial revision robcast parents: diff changeset	8 under the terms of the GNU General Public License as published by the
0ff3ede32060 Initial revision robcast parents: diff changeset	9 Free Software Foundation; either version 2 of the License, or (at your
0ff3ede32060 Initial revision robcast parents: diff changeset	10 option) any later version.
0ff3ede32060 Initial revision robcast parents: diff changeset	11
0ff3ede32060 Initial revision robcast parents: diff changeset	12 Please read license.txt for the full details. A copy of the GPL
0ff3ede32060 Initial revision robcast parents: diff changeset	13 may be found at http://www.gnu.org/copyleft/lgpl.html
0ff3ede32060 Initial revision robcast parents: diff changeset	14
0ff3ede32060 Initial revision robcast parents: diff changeset	15 You should have received a copy of the GNU General Public License
0ff3ede32060 Initial revision robcast parents: diff changeset	16 along with this program; if not, write to the Free Software
0ff3ede32060 Initial revision robcast parents: diff changeset	17 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
0ff3ede32060 Initial revision robcast parents: diff changeset	18
0ff3ede32060 Initial revision robcast parents: diff changeset	19 */
0ff3ede32060 Initial revision robcast parents: diff changeset	20
0ff3ede32060 Initial revision robcast parents: diff changeset	21 package digilib.image;
0ff3ede32060 Initial revision robcast parents: diff changeset	22
73 3b8797fc3e90 New servlet version 1.5b. robcast parents: 1 diff changeset	23 import java.io.File;
79 63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	24 import java.io.OutputStream;
73 3b8797fc3e90 New servlet version 1.5b. robcast parents: 1 diff changeset	25
3b8797fc3e90 New servlet version 1.5b. robcast parents: 1 diff changeset	26 import digilib.io.FileOpException;
3b8797fc3e90 New servlet version 1.5b. robcast parents: 1 diff changeset	27
3b8797fc3e90 New servlet version 1.5b. robcast parents: 1 diff changeset	28 /** The basic class for the representation of a digilib image.
3b8797fc3e90 New servlet version 1.5b. robcast parents: 1 diff changeset	29 *
3b8797fc3e90 New servlet version 1.5b. robcast parents: 1 diff changeset	30 * The actual image object is hidden in the class, only methods for loading,
3b8797fc3e90 New servlet version 1.5b. robcast parents: 1 diff changeset	31 * manipulation, and saving are exported. This strategy enables implementations
3b8797fc3e90 New servlet version 1.5b. robcast parents: 1 diff changeset	32 * using different toolkits that rely on different image base classes (like
3b8797fc3e90 New servlet version 1.5b. robcast parents: 1 diff changeset	33 * JIMI, Java2D and JAI).
3b8797fc3e90 New servlet version 1.5b. robcast parents: 1 diff changeset	34 */
1 0ff3ede32060 Initial revision robcast parents: diff changeset	35 public interface DocuImage {
0ff3ede32060 Initial revision robcast parents: diff changeset	36
79 63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	37 /** Returns the list of image file types known to the DocuImage implementation.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	38 *
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	39 * @return List of image file types. Strings are standard file extensions.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	40 */
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	41 public String[] getKnownFileTypes();
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	42
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	43 /** Loads an image file into the Object.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	44 *
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	45 * @param f Image File.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	46 * @throws FileOpException Exception thrown if any error occurs.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	47 */
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	48 public void loadImage(File f) throws FileOpException;
1 0ff3ede32060 Initial revision robcast parents: diff changeset	49
79 63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	50 /** Writes the current image to a ServletResponse.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	51 *
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	52 * The image is encoded to the mime-type <code>mt</code> and sent to the output
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	53 * stream of the <code>ServletResponse</code> <code>res</code>.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	54 *
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	55 * Currently only mime-types "image/jpeg" and "image/png" are supported.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	56 *
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	57 * @param mt mime-type of the image to be sent.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	58 * @param res ServletResponse where the image is sent.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	59 * @throws FileOpException Exception thrown on any error.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	60 */
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	61 public void writeImage(String mt, OutputStream ostream)
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	62 throws FileOpException;
1 0ff3ede32060 Initial revision robcast parents: diff changeset	63
79 63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	64 /** The width of the current image in pixel.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	65 *
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	66 * @return Image width in pixels.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	67 */
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	68 public int getWidth();
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	69
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	70 /** The height of the current image in pixel.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	71 *
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	72 * @return Image height in pixels.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	73 */
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	74 public int getHeight();
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	75
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	76 /** Crops the current image.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	77 *
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	78 * Cuts out a region of the size <code>width</code> x <code>height</code> at
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	79 * the offset <code>xoff</code>, <code>yoff</code> from the current image
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	80 * and replaces the current image with the result.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	81 *
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	82 * @param xoff X offset of crop region
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	83 * @param yoff Y offset of crop region
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	84 * @param width width of crop region
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	85 * @param height height of crop region
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	86 * @throws ImageOpException
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	87 */
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	88 public void crop(int xoff, int yoff, int width, int height)
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	89 throws ImageOpException;
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	90
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	91 /** Scales the current image.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	92 *
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	93 * Replaces the current image with an image scaled by the factor
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	94 * <code>scale</code>.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	95 *
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	96 * @param scale scaling factor
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	97 * @throws ImageOpException
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	98 */
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	99 public void scale(double scale) throws ImageOpException;
1 0ff3ede32060 Initial revision robcast parents: diff changeset	100
79 63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	101 /** Crops and scales the current image.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	102 *
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	103 * The current image is cropped to a rectangle of <code>width</code>,
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	104 * <code>height</code> at position <code>x_off</code>, <code>y_off</code>. The
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	105 * resulting image is scaled by the factor <code>scale</code> using the
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	106 * interpolation quality <code>qual</code> (0=worst).
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	107 *
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	108 * @param x_off x offset of the crop rectangle in pixel.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	109 * @param y_off y offset of the crop rectangle in pixel.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	110 * @param width width of the crop rectangle in pixel.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	111 * @param height height of the crop rectangle in pixel.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	112 * @param scale scaling factor.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	113 * @param qual interpolation quality (0=worst).
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	114 * @throws ImageOpException exception thrown on any error.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	115 */
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	116 public void cropAndScale(
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	117 int x_off,
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	118 int y_off,
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	119 int width,
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	120 int height,
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	121 double scale,
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	122 int qual)
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	123 throws ImageOpException;
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	124
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	125 /** Rotates the current image.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	126 *
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	127 * Replaces the current image with a rotated image. The image is rotated
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	128 * around the center by <code>angle</code> given in degrees [0, 360]
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	129 * clockwise. Image size and aspect ratio are likely to change.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	130 *
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	131 * @param angle rotation angle in degree
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	132 */
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	133 public void rotate(double angle) throws ImageOpException;
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	134
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	135 /** Mirrors the current image.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	136 *
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	137 * Replaces the current image with a mirrored image. The mirror axis goes
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	138 * through the center of the image and is rotated by <code>angle</code>
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	139 * degrees. Currently only horizontal and vertical mirroring (0 and 90
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	140 * degree) are supported.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	141 *
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	142 * @param angle angle of mirror axis
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	143 * @throws ImageOpException
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	144 */
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	145 public void mirror(double angle) throws ImageOpException;
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	146
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	147 /** Enhaces brightness and contrast of the current image.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	148 *
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	149 * Replaces the current image with a brightness and contrast enhanced image.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	150 * Contrast is enhanced by multiplying the pixel value with the constant
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	151 * <code>mult</code>. Brightness is enhanced by adding the constant
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	152 * <code>add</code> to the pixel value. Operation: p1 = (p0*mult)+add.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	153 *
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	154 * @param mult multiplicative constant for contrast enhancement
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	155 * @param add additive constant for brightness enhancement
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	156 * @throws ImageOpException
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	157 */
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	158 public void enhance(double mult, double add) throws ImageOpException;
1 0ff3ede32060 Initial revision robcast parents: diff changeset	159
79 63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	160 /**
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	161 * Returns the interpolation quality.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	162 * @return int
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	163 */
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	164 public int getQuality();
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	165
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	166 /**
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	167 * Sets the interpolation quality.
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	168 * @param quality The quality to set
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	169 */
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	170 public void setQuality(int quality);
63c8186455c1 Servlet version 1.6b. Further cleanup and new functionality: robcast parents: 73 diff changeset	171
1 0ff3ede32060 Initial revision robcast parents: diff changeset	172 }

Mercurial > hg > digilib-old

annotate servlet/src/digilib/image/DocuImage.java @ 79:63c8186455c1