rxing 0.4.11

A rust port of the zxing barcode library.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282

/*
 * Copyright 2012 ZXing authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

use std::collections::HashMap;

use crate::{
    common::{BitMatrix, CharacterSet, Result},
    BarcodeFormat, EncodeHintType, EncodeHintValue, Exceptions, Writer,
};

use super::encoder::PDF417;

/**
 * default white space (margin) around the code
 */
const WHITE_SPACE: u32 = 30;

/**
 * default error correction level
 */
const DEFAULT_ERROR_CORRECTION_LEVEL: u32 = 2;

/**
 * @author Jacob Haynes
 * @author qwandor@google.com (Andrew Walbran)
 */
#[derive(Default)]
pub struct PDF417Writer;

impl Writer for PDF417Writer {
    fn encode(
        &self,
        contents: &str,
        format: &crate::BarcodeFormat,
        width: i32,
        height: i32,
    ) -> Result<crate::common::BitMatrix> {
        self.encode_with_hints(contents, format, width, height, &HashMap::new())
    }

    fn encode_with_hints(
        &self,
        contents: &str,
        format: &crate::BarcodeFormat,
        width: i32,
        height: i32,
        hints: &crate::EncodingHintDictionary,
    ) -> Result<crate::common::BitMatrix> {
        if format != &BarcodeFormat::PDF_417 {
            return Err(Exceptions::illegal_argument_with(format!(
                "Can only encode PDF_417, but got {format}"
            )));
        }

        let mut encoder = PDF417::new();
        let mut margin = WHITE_SPACE;
        let mut errorCorrectionLevel = DEFAULT_ERROR_CORRECTION_LEVEL;
        let mut autoECI = false;

        if !hints.is_empty() {
            if let Some(EncodeHintValue::Pdf417Compact(compact)) =
                hints.get(&EncodeHintType::PDF417_COMPACT)
            {
                if let Ok(res) = compact.parse::<bool>() {
                    encoder.setCompact(res);
                }
            }
            if let Some(EncodeHintValue::Pdf417Compaction(compaction)) =
                hints.get(&EncodeHintType::PDF417_COMPACTION)
            {
                encoder.setCompaction(compaction.try_into()?);
            }
            if let Some(EncodeHintValue::Pdf417Dimensions(dimensions)) =
                hints.get(&EncodeHintType::PDF417_DIMENSIONS)
            {
                encoder.setDimensions(
                    dimensions.getMaxCols() as u32,
                    dimensions.getMinCols() as u32,
                    dimensions.getMaxRows() as u32,
                    dimensions.getMinRows() as u32,
                );
            }
            if let Some(EncodeHintValue::Margin(m1)) = hints.get(&EncodeHintType::MARGIN) {
                if let Ok(m) = m1.parse::<u32>() {
                    margin = m;
                }
            }
            if let Some(EncodeHintValue::ErrorCorrection(ec)) =
                hints.get(&EncodeHintType::ERROR_CORRECTION)
            {
                if let Ok(ec_parsed) = ec.parse::<u32>() {
                    errorCorrectionLevel = ec_parsed;
                }
            }
            if let Some(EncodeHintValue::CharacterSet(cs)) =
                hints.get(&EncodeHintType::CHARACTER_SET)
            {
                encoder.setEncoding(CharacterSet::get_character_set_by_name(cs));
            }
            if let Some(EncodeHintValue::Pdf417AutoEci(auto_eci_str)) =
                hints.get(&EncodeHintType::PDF417_AUTO_ECI)
            {
                if let Ok(auto_eci_parsed) = auto_eci_str.parse::<bool>() {
                    autoECI = auto_eci_parsed;
                }
            }
        }

        Self::bitMatrixFromEncoder(
            &mut encoder,
            contents,
            errorCorrectionLevel,
            width as u32,
            height as u32,
            margin,
            autoECI,
        )
    }
}

impl PDF417Writer {
    /**
     * Takes encoder, accounts for width/height, and retrieves bit matrix
     */
    fn bitMatrixFromEncoder(
        encoder: &mut PDF417,
        contents: &str,
        errorCorrectionLevel: u32,
        width: u32,
        height: u32,
        margin: u32,
        autoECI: bool,
    ) -> Result<BitMatrix> {
        encoder.generateBarcodeLogicWithAutoECI(contents, errorCorrectionLevel, autoECI)?;

        let aspectRatio = 4;
        let mut originalScale = encoder
            .getBarcodeMatrix()
            .as_ref()
            .ok_or(Exceptions::ILLEGAL_STATE)?
            .getScaledMatrix(1, aspectRatio);
        let mut rotated = false;
        if (height > width) != (originalScale[0].len() < originalScale.len()) {
            originalScale = Self::rotateArray(&originalScale);
            rotated = true;
        }

        let scaleX = width as usize / originalScale[0].len();
        let scaleY = height as usize / originalScale.len();
        let scale = scaleX.min(scaleY);

        if scale > 1 {
            let mut scaledMatrix = encoder
                .getBarcodeMatrix()
                .as_ref()
                .ok_or(Exceptions::ILLEGAL_STATE)?
                .getScaledMatrix(scale, scale * aspectRatio);
            if rotated {
                scaledMatrix = Self::rotateArray(&scaledMatrix);
            }
            return Self::bitMatrixFromBitArray(&scaledMatrix, margin)
                .ok_or(Exceptions::ILLEGAL_STATE);
        }

        Self::bitMatrixFromBitArray(&originalScale, margin).ok_or(Exceptions::ILLEGAL_STATE)
    }

    /**
     * This takes an array holding the values of the PDF 417
     *
     * @param input a byte array of information with 0 is black, and 1 is white
     * @param margin border around the barcode
     * @return BitMatrix of the input
     */
    fn bitMatrixFromBitArray(input: &Vec<Vec<u8>>, margin: u32) -> Option<BitMatrix> {
        // Creates the bit matrix with extra space for whitespace
        let mut output = BitMatrix::new(
            input[0].len() as u32 + 2 * margin,
            input.len() as u32 + 2 * margin,
        )
        .ok()?;
        output.clear();
        let mut y = 0;
        let mut yOutput = (output.getHeight() - margin - 1) as isize;
        while y < input.len() {
            let inputY = &input[y];
            for (x, x_index_val) in inputY.iter().enumerate().take(input[y].len()) {
                // Zero is white in the byte matrix
                if x_index_val == &1 {
                    output.set(x as u32 + margin, yOutput as u32);
                }
            }
            y += 1;
            yOutput -= 1;
        }
        Some(output)
    }

    /**
     * Takes and rotates the it 90 degrees
     */
    fn rotateArray(bitarray: &Vec<Vec<u8>>) -> Vec<Vec<u8>> {
        let mut temp = vec![vec![0; bitarray.len()]; bitarray[0].len()];

        for ii in 0..bitarray.len() {
            // This makes the direction consistent on screen when rotating the screen;
            let inverseii = bitarray.len() - ii - 1;
            for (jj, tmp_spot) in temp.iter_mut().enumerate().take(bitarray[0].len()) {
                tmp_spot[inverseii] = bitarray[ii][jj];
            }
        }

        temp
    }
    pub fn new() -> Self {
        Self
    }
}

/**
 * Tests {@link PDF417Writer}.
 */
#[cfg(test)]
mod PDF417WriterTestCase {
    use std::collections::HashMap;

    use crate::{pdf417::PDF417Writer, BarcodeFormat, EncodeHintType, EncodeHintValue, Writer};

    #[test]
    fn testDataMatrixImageWriter() {
        let mut hints = HashMap::new();
        hints.insert(
            EncodeHintType::MARGIN,
            EncodeHintValue::Margin(0.to_string()),
        );
        let size = 64;
        let writer = PDF417Writer::new();
        let matrix = writer
            .encode_with_hints("Hello Google", &BarcodeFormat::PDF_417, size, size, &hints)
            .expect("encode");
        // assert!(matrix.is_ok());
        let expected = r"X X X X X X X X   X   X   X       X X X X   X   X   X X X X         X X   X   X           X X         X X X X   X X     X     X X X     X X   X           X       X X     X X X X X   X   X   X X X X X     X X X X X X X   X       X   X     X 
X X X X X X X X   X   X   X       X X X X   X   X   X X X X         X X   X   X           X X         X X X X   X X     X     X X X     X X   X           X       X X     X X X X X   X   X   X X X X X     X X X X X X X   X       X   X     X 
X X X X X X X X   X   X   X       X X X X   X   X   X X X X         X X   X   X           X X         X X X X   X X     X     X X X     X X   X           X       X X     X X X X X   X   X   X X X X X     X X X X X X X   X       X   X     X 
X X X X X X X X   X   X   X       X X X X   X   X   X X X X         X X   X   X           X X         X X X X   X X     X     X X X     X X   X           X       X X     X X X X X   X   X   X X X X X     X X X X X X X   X       X   X     X 
X X X X X X X X   X   X   X       X X X X   X   X         X         X   X X     X     X X X X X X     X X X           X   X X       X   X X X   X           X X     X     X X X X X X   X   X   X X X       X X X X X X X   X       X   X     X 
X X X X X X X X   X   X   X       X X X X   X   X         X         X   X X     X     X X X X X X     X X X           X   X X       X   X X X   X           X X     X     X X X X X X   X   X   X X X       X X X X X X X   X       X   X     X 
X X X X X X X X   X   X   X       X X X X   X   X         X         X   X X     X     X X X X X X     X X X           X   X X       X   X X X   X           X X     X     X X X X X X   X   X   X X X       X X X X X X X   X       X   X     X 
X X X X X X X X   X   X   X       X X X X   X   X         X         X   X X     X     X X X X X X     X X X           X   X X       X   X X X   X           X X     X     X X X X X X   X   X   X X X       X X X X X X X   X       X   X     X 
X X X X X X X X   X   X   X       X   X   X     X X X X             X   X X X       X       X X       X     X X   X X     X X X X       X X       X X X X X     X     X   X   X   X         X X X X         X X X X X X X   X       X   X     X 
X X X X X X X X   X   X   X       X   X   X     X X X X             X   X X X       X       X X       X     X X   X X     X X X X       X X       X X X X X     X     X   X   X   X         X X X X         X X X X X X X   X       X   X     X 
X X X X X X X X   X   X   X       X   X   X     X X X X             X   X X X       X       X X       X     X X   X X     X X X X       X X       X X X X X     X     X   X   X   X         X X X X         X X X X X X X   X       X   X     X 
X X X X X X X X   X   X   X       X   X   X     X X X X             X   X X X       X       X X       X     X X   X X     X X X X       X X       X X X X X     X     X   X   X   X         X X X X         X X X X X X X   X       X   X     X 
X X X X X X X X   X   X   X       X   X   X X X X     X X X X       X         X X       X X     X     X   X     X X X X       X X X X   X       X X       X X         X   X X   X   X X X X     X X X X X   X X X X X X X   X       X   X     X 
X X X X X X X X   X   X   X       X   X   X X X X     X X X X       X         X X       X X     X     X   X     X X X X       X X X X   X       X X       X X         X   X X   X   X X X X     X X X X X   X X X X X X X   X       X   X     X 
X X X X X X X X   X   X   X       X   X   X X X X     X X X X       X         X X       X X     X     X   X     X X X X       X X X X   X       X X       X X         X   X X   X   X X X X     X X X X X   X X X X X X X   X       X   X     X 
X X X X X X X X   X   X   X       X   X   X X X X     X X X X       X         X X       X X     X     X   X     X X X X       X X X X   X       X X       X X         X   X X   X   X X X X     X X X X X   X X X X X X X   X       X   X     X 
X X X X X X X X   X   X   X       X X   X   X X X           X       X X     X       X X X     X       X X X X X X   X X   X     X X     X   X X X   X     X X X X X       X X X   X   X X X     X X         X X X X X X X   X       X   X     X 
X X X X X X X X   X   X   X       X X   X   X X X           X       X X     X       X X X     X       X X X X X X   X X   X     X X     X   X X X   X     X X X X X       X X X   X   X X X     X X         X X X X X X X   X       X   X     X 
X X X X X X X X   X   X   X       X X   X   X X X           X       X X     X       X X X     X       X X X X X X   X X   X     X X     X   X X X   X     X X X X X       X X X   X   X X X     X X         X X X X X X X   X       X   X     X 
X X X X X X X X   X   X   X       X X   X   X X X           X       X X     X       X X X     X       X X X X X X   X X   X     X X     X   X X X   X     X X X X X       X X X   X   X X X     X X         X X X X X X X   X       X   X     X 
X X X X X X X X   X   X   X       X X X X X   X   X X X X   X X     X           X   X       X X X X   X       X   X         X X X X     X           X X X   X       X X   X X X X   X   X X X X X   X X     X X X X X X X   X       X   X     X 
X X X X X X X X   X   X   X       X X X X X   X   X X X X   X X     X           X   X       X X X X   X       X   X         X X X X     X           X X X   X       X X   X X X X   X   X X X X X   X X     X X X X X X X   X       X   X     X 
X X X X X X X X   X   X   X       X X X X X   X   X X X X   X X     X           X   X       X X X X   X       X   X         X X X X     X           X X X   X       X X   X X X X   X   X X X X X   X X     X X X X X X X   X       X   X     X 
X X X X X X X X   X   X   X       X X X X X   X   X X X X   X X     X           X   X       X X X X   X       X   X         X X X X     X           X X X   X       X X   X X X X   X   X X X X X   X X     X X X X X X X   X       X   X     X 
";
        assert_eq!(expected, matrix.to_string());
    }
}