Add to result the raw, but parsed, bytes of byte segments in 2D barcodes

[zxing.git] / core / src / com / google / zxing / MonochromeBitmapSource.java

diff --git a/core/src/com/google/zxing/MonochromeBitmapSource.java b/core/src/com/google/zxing/MonochromeBitmapSource.java
index 23feb7a..64155a1 100644 (file)
--- a/core/src/com/google/zxing/MonochromeBitmapSource.java
+++ b/core/src/com/google/zxing/MonochromeBitmapSource.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2007 Google Inc.
+ * Copyright 2007 ZXing authors
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -19,10 +19,11 @@ package com.google.zxing;
 import com.google.zxing.common.BitArray;
 
 /**
- * Encapsulates a generic black-and-white bitmap -- a collection of pixels in two dimensions.
- * This unifies many possible representations, like AWT's <code>BufferedImage</code>.
+ * <p>Encapsulates a generic black-and-white bitmap -- a collection of pixels in two dimensions.
+ * This unifies many possible representations, like AWT's <code>BufferedImage</code>.</p>
  *
- * @author srowen@google.com (Sean Owen)
+ * @author Sean Owen
+ * @author dswitkin@google.com (Daniel Switkin)
  */
 public interface MonochromeBitmapSource {
 
@@ -34,20 +35,25 @@ public interface MonochromeBitmapSource {
   boolean isBlack(int x, int y);
 
   /**
-   * Returns an entire row of black/white pixels as an array of bits, where "true" means "black".
+   * <p>Returns an entire row of black/white pixels as an array of bits, where "true" means "black".
    * This is a sort of "bulk get" operation intended to enable efficient access in
-   * certain situations.
+   * certain situations.</p>
    *
    * @param y vertical offset, from top, of the row of pixels
    * @param row if not null, {@link BitArray} to write pixels into. If null, a new {@link BitArray}
-   *  is allocated and returned.
+   * is allocated and returned.
    * @param startX horizontal offset, from left, from which to start getting pixels
    * @param getWidth number of pixels to get from the row
    * @return {@link BitArray} representing the (subset of the) row of pixels. If row parameter
-   *  was not null, it is returned.
+   *         was not null, it is returned.
    */
   BitArray getBlackRow(int y, BitArray row, int startX, int getWidth);
 
+  /**
+   * Entirely analogous to {@link #getBlackRow(int, BitArray, int, int)} but gets a column.
+   */
+  BitArray getBlackColumn(int x, BitArray column, int startY, int getHeight);
+
   /**
    * @return height of underlying image
    */
@@ -58,4 +64,41 @@ public interface MonochromeBitmapSource {
    */
   int getWidth();
 
+  /**
+   * <p>Estimates black point according to the given method, which is optionally parameterized by
+   * a single int argument. For {@link BlackPointEstimationMethod#ROW_SAMPLING}, this
+   * specifies the row to sample.</p>
+   *
+   * <p>The estimated value will be used in subsequent computations that rely on an estimated black
+   * point.</p>
+   *
+   * @param method black point estimation method
+   * @param argument method-specific argument
+   */
+  void estimateBlackPoint(BlackPointEstimationMethod method, int argument) throws ReaderException;
+
+  /**
+   * @return {@link BlackPointEstimationMethod} representing last sampling method used
+   */
+  BlackPointEstimationMethod getLastEstimationMethod();
+
+  /**
+   * <p>Optional operation which returns an implementation based on the same underlying
+   * image, but which behaves as if the underlying image had been rotated 90 degrees
+   * counterclockwise. This is useful in the context of 1D barcodes and the
+   * {@link DecodeHintType#TRY_HARDER} decode hint, and is only intended to be
+   * used in non-resource-constrained environments. Hence, implementations
+   * of this class which are only used in resource-constrained mobile environments
+   * don't have a need to implement this.</p>
+   *
+   * @throws IllegalArgumentException if not supported
+   */
+  MonochromeBitmapSource rotateCounterClockwise();
+
+  /**
+   * @return true iff rotation is supported
+   * @see #rotateCounterClockwise()
+   */
+  boolean isRotateSupported();
+
 }