mudhorn/zxing
1
0
Fork 0
mirror of https://github.com/zxing/zxing.git synced 2025-03-05 20:48:51 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Issue 1314 add hint to control margin in Writer, and switch to more natural boolean[] representation

Browse source 
git-svn-id: https://zxing.googlecode.com/svn/trunk@2353 59b500cc-1b3d-0410-9834-0bbf25fbcc57
This commit is contained in:
srowen 2012-07-16 19:17:56 +00:00
parent 95f42d6340
commit f653154da3
10 changed files with 98 additions and 83 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
core/src/com/google/zxing/EncodeHintType.java
View file

@ -35,6 +35,13 @@ public enum EncodeHintType {
*/ */
CHARACTER_SET, CHARACTER_SET,
/**
* Specifies margin, in pixels, to use when generating the barcode. The meaning can vary
* by format; for example it controls margin before and after the barcode horizontally for
* most 1D formats. (Type {@link Integer}).
*/
MARGIN,
/** /**
* Specifies whether to use compact mode for PDF417 (type {@link Boolean}). * Specifies whether to use compact mode for PDF417 (type {@link Boolean}).
*/ */

32
core/src/com/google/zxing/oned/CodaBarWriter.java
View file

@ -18,6 +18,8 @@ package com.google.zxing.oned;
import com.google.zxing.common.BitMatrix; import com.google.zxing.common.BitMatrix;
import java.util.Arrays;
/** /**
* This class renders CodaBar as {@link BitMatrix}. * This class renders CodaBar as {@link BitMatrix}.
* *
@ -25,29 +27,23 @@ import com.google.zxing.common.BitMatrix;
*/ */
public final class CodaBarWriter extends OneDimensionalCodeWriter { public final class CodaBarWriter extends OneDimensionalCodeWriter {
public CodaBarWriter() { private static final char[] START_CHARS = {'A', 'B', 'C', 'D'};
// Super constructor requires the sum of the left and right margin length. private static final char[] END_CHARS = {'T', 'N', '*', 'E'};
// CodaBar spec requires a side margin to be more than ten times wider than narrow space.
// In this implementation, narrow space has a unit length, so 20 is required minimum.
super(20);
}
/* /*
* @see OneDimensionalCodeWriter#encode(java.lang.String) * @see OneDimensionalCodeWriter#encode(String)
*/ */
@Override @Override
public byte[] encode(String contents) { public boolean[] encode(String contents) {
// Verify input and calculate decoded length. // Verify input and calculate decoded length.
if (!CodaBarReader.arrayContains( if (!CodaBarReader.arrayContains(START_CHARS, Character.toUpperCase(contents.charAt(0)))) {
new char[]{'A', 'B', 'C', 'D'}, Character.toUpperCase(contents.charAt(0)))) {
throw new IllegalArgumentException( throw new IllegalArgumentException(
"Codabar should start with one of the following: 'A', 'B', 'C' or 'D'"); "Codabar should start with one of the following: " + Arrays.toString(START_CHARS));
} }
if (!CodaBarReader.arrayContains(new char[]{'T', 'N', '*', 'E'}, if (!CodaBarReader.arrayContains(END_CHARS, Character.toUpperCase(contents.charAt(contents.length() - 1)))) {
Character.toUpperCase(contents.charAt(contents.length() - 1)))) {
throw new IllegalArgumentException( throw new IllegalArgumentException(
"Codabar should end with one of the following: 'T', 'N', '*' or 'E'"); "Codabar should end with one of the following: " + Arrays.toString(END_CHARS));
} }
// The start character and the end character are decoded to 10 length each. // The start character and the end character are decoded to 10 length each.
int resultLength = 20; int resultLength = 20;
@ -66,7 +62,7 @@ public final class CodaBarWriter extends OneDimensionalCodeWriter {
// A blank is placed between each character. // A blank is placed between each character.
resultLength += contents.length() - 1; resultLength += contents.length() - 1;
byte[] result = new byte[resultLength]; boolean[] result = new boolean[resultLength];
int position = 0; int position = 0;
for (int index = 0; index < contents.length(); index++) { for (int index = 0; index < contents.length(); index++) {
char c = Character.toUpperCase(contents.charAt(index)); char c = Character.toUpperCase(contents.charAt(index));
@ -95,14 +91,14 @@ public final class CodaBarWriter extends OneDimensionalCodeWriter {
break; break;
} }
} }
byte color = 1; boolean color = true;
int counter = 0; int counter = 0;
int bit = 0; int bit = 0;
while (bit < 7) { // A character consists of 7 digit. while (bit < 7) { // A character consists of 7 digit.
result[position] = color; result[position] = color;
position++; position++;
if (((code >> (6 - bit)) & 1) == 0 || counter == 1) { if (((code >> (6 - bit)) & 1) == 0 || counter == 1) {
color ^= 1; // Flip the color. color = !color; // Flip the color.
bit++; bit++;
counter = 0; counter = 0;
} else { } else {
@ -110,7 +106,7 @@ public final class CodaBarWriter extends OneDimensionalCodeWriter {
} }
} }
if (index < contents.length() - 1) { if (index < contents.length() - 1) {
result[position] = 0; result[position] = false;
position++; position++;
} }
} }

8
core/src/com/google/zxing/oned/Code128Writer.java
View file

@ -30,7 +30,7 @@ import java.util.Map;
* *
* @author erik.barbara@gmail.com (Erik Barbara) * @author erik.barbara@gmail.com (Erik Barbara)
*/ */
public final class Code128Writer extends UPCEANWriter { public final class Code128Writer extends OneDimensionalCodeWriter {
private static final int CODE_START_B = 104; private static final int CODE_START_B = 104;
private static final int CODE_START_C = 105; private static final int CODE_START_C = 105;
@ -62,7 +62,7 @@ public final class Code128Writer extends UPCEANWriter {
} }
@Override @Override
public byte[] encode(String contents) { public boolean[] encode(String contents) {
int length = contents.length(); int length = contents.length();
// Check length // Check length
if (length < 1 || length > 80) { if (length < 1 || length > 80) {
@ -176,10 +176,10 @@ public final class Code128Writer extends UPCEANWriter {
} }
// Compute result // Compute result
byte[] result = new byte[codeWidth]; boolean[] result = new boolean[codeWidth];
int pos = 0; int pos = 0;
for (int[] pattern : patterns) { for (int[] pattern : patterns) {
pos += appendPattern(result, pos, pattern, 1); pos += appendPattern(result, pos, pattern, true);
} }
return result; return result;

16
core/src/com/google/zxing/oned/Code39Writer.java
View file

@ -28,7 +28,7 @@ import java.util.Map;
* *
* @author erik.barbara@gmail.com (Erik Barbara) * @author erik.barbara@gmail.com (Erik Barbara)
*/ */
public final class Code39Writer extends UPCEANWriter { public final class Code39Writer extends OneDimensionalCodeWriter {
@Override @Override
public BitMatrix encode(String contents, public BitMatrix encode(String contents,
@ -43,7 +43,7 @@ public final class Code39Writer extends UPCEANWriter {
} }
@Override @Override
public byte[] encode(String contents) { public boolean[] encode(String contents) {
int length = contents.length(); int length = contents.length();
if (length > 80) { if (length > 80) {
throw new IllegalArgumentException( throw new IllegalArgumentException(
@ -59,20 +59,20 @@ public final class Code39Writer extends UPCEANWriter {
codeWidth += width; codeWidth += width;
} }
} }
byte[] result = new byte[codeWidth]; boolean[] result = new boolean[codeWidth];
toIntArray(Code39Reader.CHARACTER_ENCODINGS[39], widths); toIntArray(Code39Reader.CHARACTER_ENCODINGS[39], widths);
int pos = appendPattern(result, 0, widths, 1); int pos = appendPattern(result, 0, widths, true);
int[] narrowWhite = {1}; int[] narrowWhite = {1};
pos += appendPattern(result, pos, narrowWhite, 0); pos += appendPattern(result, pos, narrowWhite, false);
//append next character to bytematrix //append next character to bytematrix
for(int i = length-1; i >= 0; i--) { for(int i = length-1; i >= 0; i--) {
int indexInString = Code39Reader.ALPHABET_STRING.indexOf(contents.charAt(i)); int indexInString = Code39Reader.ALPHABET_STRING.indexOf(contents.charAt(i));
toIntArray(Code39Reader.CHARACTER_ENCODINGS[indexInString], widths); toIntArray(Code39Reader.CHARACTER_ENCODINGS[indexInString], widths);
pos += appendPattern(result, pos, widths, 1); pos += appendPattern(result, pos, widths, true);
pos += appendPattern(result, pos, narrowWhite, 0); pos += appendPattern(result, pos, narrowWhite, false);
} }
toIntArray(Code39Reader.CHARACTER_ENCODINGS[39], widths); toIntArray(Code39Reader.CHARACTER_ENCODINGS[39], widths);
pos += appendPattern(result, pos, widths, 1); pos += appendPattern(result, pos, widths, true);
return result; return result;
} }

14
core/src/com/google/zxing/oned/EAN13Writer.java
View file

@ -50,7 +50,7 @@ public final class EAN13Writer extends UPCEANWriter {
} }
@Override @Override
public byte[] encode(String contents) { public boolean[] encode(String contents) {
if (contents.length() != 13) { if (contents.length() != 13) {
throw new IllegalArgumentException( throw new IllegalArgumentException(
"Requested contents should be 13 digits long, but got " + contents.length()); "Requested contents should be 13 digits long, but got " + contents.length());
@ -58,10 +58,10 @@ public final class EAN13Writer extends UPCEANWriter {
int firstDigit = Integer.parseInt(contents.substring(0, 1)); int firstDigit = Integer.parseInt(contents.substring(0, 1));
int parities = EAN13Reader.FIRST_DIGIT_ENCODINGS[firstDigit]; int parities = EAN13Reader.FIRST_DIGIT_ENCODINGS[firstDigit];
byte[] result = new byte[CODE_WIDTH]; boolean[] result = new boolean[CODE_WIDTH];
int pos = 0; int pos = 0;
pos += appendPattern(result, pos, UPCEANReader.START_END_PATTERN, 1); pos += appendPattern(result, pos, UPCEANReader.START_END_PATTERN, true);
// See {@link #EAN13Reader} for a description of how the first digit & left bars are encoded // See {@link #EAN13Reader} for a description of how the first digit & left bars are encoded
for (int i = 1; i <= 6; i++) { for (int i = 1; i <= 6; i++) {
@ -69,16 +69,16 @@ public final class EAN13Writer extends UPCEANWriter {
if ((parities >> (6 - i) & 1) == 1) { if ((parities >> (6 - i) & 1) == 1) {
digit += 10; digit += 10;
} }
pos += appendPattern(result, pos, UPCEANReader.L_AND_G_PATTERNS[digit], 0); pos += appendPattern(result, pos, UPCEANReader.L_AND_G_PATTERNS[digit], false);
} }
pos += appendPattern(result, pos, UPCEANReader.MIDDLE_PATTERN, 0); pos += appendPattern(result, pos, UPCEANReader.MIDDLE_PATTERN, false);
for (int i = 7; i <= 12; i++) { for (int i = 7; i <= 12; i++) {
int digit = Integer.parseInt(contents.substring(i, i + 1)); int digit = Integer.parseInt(contents.substring(i, i + 1));
pos += appendPattern(result, pos, UPCEANReader.L_PATTERNS[digit], 1); pos += appendPattern(result, pos, UPCEANReader.L_PATTERNS[digit], true);
} }
pos += appendPattern(result, pos, UPCEANReader.START_END_PATTERN, 1); pos += appendPattern(result, pos, UPCEANReader.START_END_PATTERN, true);
return result; return result;
} }

18
core/src/com/google/zxing/oned/EAN8Writer.java
View file

@ -50,31 +50,33 @@ public final class EAN8Writer extends UPCEANWriter {
return super.encode(contents, format, width, height, hints); return super.encode(contents, format, width, height, hints);
} }
/** @return a byte array of horizontal pixels (0 = white, 1 = black) */ /**
* @return a byte array of horizontal pixels (false = white, true = black)
*/
@Override @Override
public byte[] encode(String contents) { public boolean[] encode(String contents) {
if (contents.length() != 8) { if (contents.length() != 8) {
throw new IllegalArgumentException( throw new IllegalArgumentException(
"Requested contents should be 8 digits long, but got " + contents.length()); "Requested contents should be 8 digits long, but got " + contents.length());
} }
byte[] result = new byte[CODE_WIDTH]; boolean[] result = new boolean[CODE_WIDTH];
int pos = 0; int pos = 0;
pos += appendPattern(result, pos, UPCEANReader.START_END_PATTERN, 1); pos += appendPattern(result, pos, UPCEANReader.START_END_PATTERN, true);
for (int i = 0; i <= 3; i++) { for (int i = 0; i <= 3; i++) {
int digit = Integer.parseInt(contents.substring(i, i + 1)); int digit = Integer.parseInt(contents.substring(i, i + 1));
pos += appendPattern(result, pos, UPCEANReader.L_PATTERNS[digit], 0); pos += appendPattern(result, pos, UPCEANReader.L_PATTERNS[digit], false);
} }
pos += appendPattern(result, pos, UPCEANReader.MIDDLE_PATTERN, 0); pos += appendPattern(result, pos, UPCEANReader.MIDDLE_PATTERN, false);
for (int i = 4; i <= 7; i++) { for (int i = 4; i <= 7; i++) {
int digit = Integer.parseInt(contents.substring(i, i + 1)); int digit = Integer.parseInt(contents.substring(i, i + 1));
pos += appendPattern(result, pos, UPCEANReader.L_PATTERNS[digit], 1); pos += appendPattern(result, pos, UPCEANReader.L_PATTERNS[digit], true);
} }
pos += appendPattern(result, pos, UPCEANReader.START_END_PATTERN, 1); pos += appendPattern(result, pos, UPCEANReader.START_END_PATTERN, true);
return result; return result;
} }

17
core/src/com/google/zxing/oned/ITFWriter.java
View file

@ -28,7 +28,10 @@ import java.util.Map;
* *
* @author erik.barbara@gmail.com (Erik Barbara) * @author erik.barbara@gmail.com (Erik Barbara)
*/ */
public final class ITFWriter extends UPCEANWriter { public final class ITFWriter extends OneDimensionalCodeWriter {
private static final int[] START_PATTERN = {1, 1, 1, 1};
private static final int[] END_PATTERN = {3, 1, 1};
@Override @Override
public BitMatrix encode(String contents, public BitMatrix encode(String contents,
@ -44,7 +47,7 @@ public final class ITFWriter extends UPCEANWriter {
} }
@Override @Override
public byte[] encode(String contents) { public boolean[] encode(String contents) {
int length = contents.length(); int length = contents.length();
if (length % 2 != 0) { if (length % 2 != 0) {
throw new IllegalArgumentException("The lenght of the input should be even"); throw new IllegalArgumentException("The lenght of the input should be even");
@ -53,9 +56,8 @@ public final class ITFWriter extends UPCEANWriter {
throw new IllegalArgumentException( throw new IllegalArgumentException(
"Requested contents should be less than 80 digits long, but got " + length); "Requested contents should be less than 80 digits long, but got " + length);
} }
byte[] result = new byte[9 + 9 * length]; boolean[] result = new boolean[9 + 9 * length];
int[] start = {1, 1, 1, 1}; int pos = appendPattern(result, 0, START_PATTERN, true);
int pos = appendPattern(result, 0, start, 1);
for (int i = 0; i < length; i += 2) { for (int i = 0; i < length; i += 2) {
int one = Character.digit(contents.charAt(i), 10); int one = Character.digit(contents.charAt(i), 10);
int two = Character.digit(contents.charAt(i+1), 10); int two = Character.digit(contents.charAt(i+1), 10);
@ -64,10 +66,9 @@ public final class ITFWriter extends UPCEANWriter {
encoding[(j << 1)] = ITFReader.PATTERNS[one][j]; encoding[(j << 1)] = ITFReader.PATTERNS[one][j];
encoding[(j << 1) + 1] = ITFReader.PATTERNS[two][j]; encoding[(j << 1) + 1] = ITFReader.PATTERNS[two][j];
} }
pos += appendPattern(result, pos, encoding, 1); pos += appendPattern(result, pos, encoding, true);
} }
int[] end = {3, 1, 1}; appendPattern(result, pos, END_PATTERN, true);
appendPattern(result, pos, end, 1);
return result; return result;
} }

50
core/src/com/google/zxing/oned/OneDimensionalCodeWriter.java
View file

@ -31,12 +31,6 @@ import java.util.Map;
*/ */
public abstract class OneDimensionalCodeWriter implements Writer { public abstract class OneDimensionalCodeWriter implements Writer {
private final int sidesMargin;
protected OneDimensionalCodeWriter(int sidesMargin) {
this.sidesMargin = sidesMargin;
}
@Override @Override
public BitMatrix encode(String contents, BarcodeFormat format, int width, int height) public BitMatrix encode(String contents, BarcodeFormat format, int width, int height)
throws WriterException { throws WriterException {
@ -65,14 +59,22 @@ public abstract class OneDimensionalCodeWriter implements Writer {
+ width + 'x' + height); + width + 'x' + height);
} }
byte[] code = encode(contents); int sidesMargin = getDefaultMargin();
return renderResult(code, width, height); if (hints != null) {
Integer sidesMarginInt = (Integer) hints.get(EncodeHintType.MARGIN);
if (sidesMarginInt != null) {
sidesMargin = sidesMarginInt;
}
}
boolean[] code = encode(contents);
return renderResult(code, width, height, sidesMargin);
} }
/** /**
* @return a byte array of horizontal pixels (0 = white, 1 = black) * @return a byte array of horizontal pixels (0 = white, 1 = black)
*/ */
private BitMatrix renderResult(byte[] code, int width, int height) { private static BitMatrix renderResult(boolean[] code, int width, int height, int sidesMargin) {
int inputWidth = code.length; int inputWidth = code.length;
// Add quiet zone on both sides. // Add quiet zone on both sides.
int fullWidth = inputWidth + sidesMargin; int fullWidth = inputWidth + sidesMargin;
@ -84,7 +86,7 @@ public abstract class OneDimensionalCodeWriter implements Writer {
BitMatrix output = new BitMatrix(outputWidth, outputHeight); BitMatrix output = new BitMatrix(outputWidth, outputHeight);
for (int inputX = 0, outputX = leftPadding; inputX < inputWidth; inputX++, outputX += multiple) { for (int inputX = 0, outputX = leftPadding; inputX < inputWidth; inputX++, outputX += multiple) {
if (code[inputX] == 1) { if (code[inputX]) {
output.setRegion(outputX, 0, multiple, outputHeight); output.setRegion(outputX, 0, multiple, outputHeight);
} }
} }
@ -95,34 +97,34 @@ public abstract class OneDimensionalCodeWriter implements Writer {
/** /**
* Appends the given pattern to the target array starting at pos. * Appends the given pattern to the target array starting at pos.
* *
* @param startColor starting color - 0 for white, 1 for black * @param startColor starting color - false for white, true for black
* @return the number of elements added to target. * @return the number of elements added to target.
*/ */
protected static int appendPattern(byte[] target, int pos, int[] pattern, int startColor) { protected static int appendPattern(boolean[] target, int pos, int[] pattern, boolean startColor) {
if (startColor != 0 && startColor != 1) { boolean color = startColor;
throw new IllegalArgumentException(
"startColor must be either 0 or 1, but got: " + startColor);
}
byte color = (byte) startColor;
int numAdded = 0; int numAdded = 0;
for (int len : pattern) { for (int len : pattern) {
for (int j = 0; j < len; j++) { for (int j = 0; j < len; j++) {
target[pos] = color; target[pos++] = color;
pos += 1;
numAdded += 1;
} }
color ^= 1; // flip color after each segment numAdded += len;
color = !color; // flip color after each segment
} }
return numAdded; return numAdded;
} }
public int getDefaultMargin() {
// CodaBar spec requires a side margin to be more than ten times wider than narrow space.
// This seems like a decent idea for a default for all formats.
return 10;
}
/** /**
* Encode the contents to byte array expression of one-dimensional barcode. * Encode the contents to byte array expression of one-dimensional barcode.
* Start code and end code should be included in result, and side margins should not be included. * Start code and end code should be included in result, and side margins should not be included.
* *
* @return a byte array of horizontal pixels (0 = white, 1 = black) * @return a {@code boolean[]} of horizontal pixels (false = white, true = black)
*/ */
public abstract byte[] encode(String contents); public abstract boolean[] encode(String contents);
} }

6
core/src/com/google/zxing/oned/UPCEANWriter.java
View file

@ -25,8 +25,10 @@ package com.google.zxing.oned;
*/ */
public abstract class UPCEANWriter extends OneDimensionalCodeWriter { public abstract class UPCEANWriter extends OneDimensionalCodeWriter {
protected UPCEANWriter() { @Override
super(UPCEANReader.START_END_PATTERN.length << 1); public int getDefaultMargin() {
// Use a different default more appropriate for UPC/EAN
return UPCEANReader.START_END_PATTERN.length;
} }
} }

13
core/src/com/google/zxing/qrcode/QRCodeWriter.java
View file

@ -65,28 +65,33 @@ public final class QRCodeWriter implements Writer {
} }
ErrorCorrectionLevel errorCorrectionLevel = ErrorCorrectionLevel.L; ErrorCorrectionLevel errorCorrectionLevel = ErrorCorrectionLevel.L;
int quietZone = QUIET_ZONE_SIZE;
if (hints != null) { if (hints != null) {
ErrorCorrectionLevel requestedECLevel = (ErrorCorrectionLevel) hints.get(EncodeHintType.ERROR_CORRECTION); ErrorCorrectionLevel requestedECLevel = (ErrorCorrectionLevel) hints.get(EncodeHintType.ERROR_CORRECTION);
if (requestedECLevel != null) { if (requestedECLevel != null) {
errorCorrectionLevel = requestedECLevel; errorCorrectionLevel = requestedECLevel;
} }
Integer quietZoneInt = (Integer) hints.get(EncodeHintType.MARGIN);
if (quietZoneInt != null) {
quietZone = quietZoneInt;
}
} }
QRCode code = Encoder.encode(contents, errorCorrectionLevel, hints); QRCode code = Encoder.encode(contents, errorCorrectionLevel, hints);
return renderResult(code, width, height); return renderResult(code, width, height, quietZone);
} }
// Note that the input matrix uses 0 == white, 1 == black, while the output matrix uses // Note that the input matrix uses 0 == white, 1 == black, while the output matrix uses
// 0 == black, 255 == white (i.e. an 8 bit greyscale bitmap). // 0 == black, 255 == white (i.e. an 8 bit greyscale bitmap).
private static BitMatrix renderResult(QRCode code, int width, int height) { private static BitMatrix renderResult(QRCode code, int width, int height, int quietZone) {
ByteMatrix input = code.getMatrix(); ByteMatrix input = code.getMatrix();
if (input == null) { if (input == null) {
throw new IllegalStateException(); throw new IllegalStateException();
} }
int inputWidth = input.getWidth(); int inputWidth = input.getWidth();
int inputHeight = input.getHeight(); int inputHeight = input.getHeight();
int qrWidth = inputWidth + (QUIET_ZONE_SIZE << 1); int qrWidth = inputWidth + (quietZone << 1);
int qrHeight = inputHeight + (QUIET_ZONE_SIZE << 1); int qrHeight = inputHeight + (quietZone << 1);
int outputWidth = Math.max(width, qrWidth); int outputWidth = Math.max(width, qrWidth);
int outputHeight = Math.max(height, qrHeight); int outputHeight = Math.max(height, qrHeight);