javase/src/com/google/zxing/client/j2se/BufferedImageMonochromeBitmapSource.java

   1 /*
   2  * Copyright 2008 ZXing authors
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package com.google.zxing.client.j2se;
  18
  19 import com.google.zxing.MonochromeBitmapSource;
  20 import com.google.zxing.common.BaseMonochromeBitmapSource;
  21
  22 import java.awt.geom.AffineTransform;
  23 import java.awt.image.AffineTransformOp;
  24 import java.awt.image.BufferedImage;
  25 import java.awt.image.BufferedImageOp;
  26
  27 /**
  28  * <p>An implementation based upon {@link BufferedImage}. This provides access to the
  29  * underlying image as if it were a monochrome image. Behind the scenes, it is evaluating
  30  * the luminance of the underlying image by retrieving its pixels' RGB values.</p>
  31  *
  32  * <p>This may also be used to construct a {@link MonochromeBitmapSource}
  33  * based on a region of a {@link BufferedImage}; see
  34  * {@link #BufferedImageMonochromeBitmapSource(BufferedImage, int, int, int, int)}.</p>
  35  *
  36  * @author Sean Owen
  37  * @author Daniel Switkin (dswitkin@google.com)
  38  */
  39 public final class BufferedImageMonochromeBitmapSource extends BaseMonochromeBitmapSource {
  40
  41   private final BufferedImage image;
  42   private final int left;
  43   private final int top;
  44   private final int width;
  45   private final int height;
  46
  47   /**
  48    * Creates an instance that uses the entire given image as a source of pixels to decode.
  49    *
  50    * @param image image to decode
  51    */
  52   public BufferedImageMonochromeBitmapSource(BufferedImage image) {
  53     this(image, 0, 0, image.getWidth(), image.getHeight());
  54   }
  55
  56   /**
  57    * Creates an instance that uses only a region of the given image as a source of pixels to decode.
  58    *
  59    * @param image image to decode a region of
  60    * @param left x coordinate of leftmost pixels to decode
  61    * @param top y coordinate of topmost pixels to decode
  62    * @param right one more than the x coordinate of rightmost pixels to decode. That is, we will decode
  63    *  pixels whose x coordinate is in [left,right)
  64    * @param bottom likewise, one more than the y coordinate of the bottommost pixels to decode
  65    */
  66   public BufferedImageMonochromeBitmapSource(BufferedImage image, int left, int top, int right, int bottom) {
  67     this.image = image;
  68     int sourceHeight = image.getHeight();
  69     int sourceWidth = image.getWidth();
  70     if (left < 0 || top < 0 || right > sourceWidth || bottom > sourceHeight || right <= left || bottom <= top) {
  71       throw new IllegalArgumentException("Invalid bounds: (" + top + ',' + left + ") (" + right + ',' + bottom + ')');
  72     }
  73     this.left = left;
  74     this.top = top;
  75     this.width = right - left;
  76     this.height = bottom - top;
  77   }
  78
  79   /**
  80    * @return underlying {@link BufferedImage} behind this instance. Note that even if this instance
  81    *  only uses a subset of the full image, the returned value here represents the entire backing image.
  82    */
  83   public BufferedImage getImage() {
  84     return image;
  85   }
  86
  87   public int getHeight() {
  88     return height;
  89   }
  90
  91   public int getWidth() {
  92     return width;
  93   }
  94
  95   @Override
  96   public MonochromeBitmapSource rotateCounterClockwise() {
  97     if (!isRotateSupported()) {
  98       throw new IllegalStateException("Rotate not supported");
  99     }
 100     int sourceWidth = image.getWidth();
 101     int sourceHeight = image.getHeight();
 102     // 90 degrees counterclockwise:
 103     AffineTransform transform = new AffineTransform(0.0, -1.0, 1.0, 0.0, 0.0, sourceWidth);
 104     BufferedImageOp op = new AffineTransformOp(transform, AffineTransformOp.TYPE_NEAREST_NEIGHBOR);
 105     // Note width/height are flipped since we are rotating 90 degrees:
 106     BufferedImage rotatedImage = new BufferedImage(sourceHeight, sourceWidth, image.getType());
 107     op.filter(image, rotatedImage);
 108     return new BufferedImageMonochromeBitmapSource(rotatedImage,
 109                                                    top,
 110                                                    sourceWidth - (left + width),
 111                                                    top + height,
 112                                                    sourceWidth - left);
 113   }
 114
 115   @Override
 116   public boolean isRotateSupported() {
 117     // Can't run AffineTransforms on images of unknown format
 118     return image.getType() != BufferedImage.TYPE_CUSTOM;
 119   }
 120
 121   /**
 122    * Extracts luminance from a pixel from this source. By default, the source is assumed to use RGB,
 123    * so this implementation computes luminance is a function of a red, green and blue components as
 124    * follows:
 125    *
 126    * <code>Y = 0.299R + 0.587G + 0.114B</code>
 127    *
 128    * where R, G, and B are values in [0,1].
 129    */
 130   protected int getLuminance(int x, int y) {
 131     int pixel = image.getRGB(left + x, top + y);
 132     // Coefficients add up to 1024 to make the divide into a fast shift
 133     return (306 * ((pixel >> 16) & 0xFF) +
 134         601 * ((pixel >> 8) & 0xFF) +
 135         117 * (pixel & 0xFF)) >> 10;
 136   }
 137
 138   protected int[] getLuminanceRow(int y, int[] row) {
 139     if (row == null || row.length < width) {
 140       row = new int[width];
 141     }
 142     image.getRGB(left, top + y, width, 1, row, 0, width);
 143     for (int x = 0; x < width; x++) {
 144       int pixel = row[x];
 145       row[x] = (306 * ((pixel >> 16) & 0xFF) +
 146           601 * ((pixel >> 8) & 0xFF) +
 147           117 * (pixel & 0xFF)) >> 10;
 148     }
 149     return row;
 150   }
 151
 152   protected int[] getLuminanceColumn(int x, int[] column) {
 153     if (column == null || column.length < height) {
 154       column = new int[height];
 155     }
 156     image.getRGB(left + x, top, 1, height, column, 0, 1);
 157     for (int y = 0; y < height; y++) {
 158       int pixel = column[y];
 159       column[y] = (306 * ((pixel >> 16) & 0xFF) +
 160           601 * ((pixel >> 8) & 0xFF) +
 161           117 * (pixel & 0xFF)) >> 10;
 162     }
 163     return column;
 164   }
 165
 166 }