Barcode: add experimental BitMatrix Barcode::symbol() property

axxel · axxel · commit b31f80461478 · 2024-02-27T15:31:52.000+01:00
Add `-symbol` cli argument to `ZXingReader` to print the detected symbol
as (nicely rendered unicode) text.

This feature is a precursor to the new writer API.

Need to compile with `BUILD_EXPERIMENTAL_API=ON` cmake setting to see this.
diff --git a/core/src/Barcode.cpp b/core/src/Barcode.cpp
@@ -34,6 +34,9 @@ Result::Result(DecoderResult&& decodeResult, DetectorResult&& detectorResult, Ba
 	  _lineCount(decodeResult.lineCount()),
 	  _isMirrored(decodeResult.isMirrored()),
 	  _readerInit(decodeResult.readerInit())
+#ifdef ZXING_BUILD_EXPERIMENTAL_API
+	  , _symbol(std::make_shared<BitMatrix>(std::move(detectorResult).bits()))
+#endif
 {
 	if (decodeResult.versionNumber())
 		snprintf(_version, 4, "%d", decodeResult.versionNumber());
diff --git a/core/src/Barcode.h b/core/src/Barcode.h
@@ -15,6 +15,11 @@
 #include "Quadrilateral.h"
 #include "StructuredAppend.h"
 
+#ifdef ZXING_BUILD_EXPERIMENTAL_API
+#include "BitMatrix.h"
+#include <memory>
+#endif
+
 #include <string>
 #include <vector>
 
@@ -158,6 +163,10 @@ class Result
 	 */
 	std::string version() const;
 
+#ifdef ZXING_BUILD_EXPERIMENTAL_API
+	const BitMatrix& symbol() const { return *_symbol; }
+#endif
+
 	bool operator==(const Result& o) const;
 
 private:
@@ -173,6 +182,9 @@ class Result
 	bool _isMirrored = false;
 	bool _isInverted = false;
 	bool _readerInit = false;
+#ifdef ZXING_BUILD_EXPERIMENTAL_API
+	std::shared_ptr<BitMatrix> _symbol;
+#endif
 };
 
 /**
diff --git a/example/ZXingReader.cpp b/example/ZXingReader.cpp
@@ -4,8 +4,9 @@
 */
 // SPDX-License-Identifier: Apache-2.0
 
-#include "ReadBarcode.h"
+#include "BitMatrixIO.h"
 #include "GTIN.h"
+#include "ReadBarcode.h"
 #include "ZXVersion.h"
 
 #include <cctype>
@@ -52,6 +53,9 @@ static void PrintUsage(const char* exePath)
 			  << "    -mode <plain|eci|hri|escaped>\n"
 			  << "               Text mode used to render the raw byte content into text\n"
 			  << "    -1         Print only file name, content/error on one line per file/barcode (implies '-mode Escaped')\n"
+#ifdef ZXING_BUILD_EXPERIMENTAL_API
+			  << "    -symbol    Print the detected symbol (if available)\n"
+#endif
 			  << "    -bytes     Write (only) the bytes content of the symbol(s) to stdout\n"
 			  << "    -pngout <file name>\n"
 			  << "               Write a copy of the input image with barcodes outlined by a green line\n"
@@ -128,6 +132,8 @@ static bool ParseOptions(int argc, char* argv[], ReaderOptions& options, CLI& cl
 			cli.oneLine = true;
 		} else if (is("-bytes")) {
 			cli.bytesOnly = true;
+		} else if (is("-symbol")) {
+			cli.showSymbol = true;
 		} else if (is("-pngout")) {
 			if (++i == argc)
 				return false;
@@ -296,6 +302,11 @@ int main(int argc, char* argv[])
 
 			if (barcode.readerInit())
 				std::cout << "Reader Initialisation/Programming\n";
+
+#ifdef ZXING_BUILD_EXPERIMENTAL_API
+			if (auto& symbol = barcode.symbol(); cli.showSymbol && !symbol.empty())
+				std::cout << "Symbol:\n" << ToString(symbol);
+#endif
 		}
 
 		if (Size(cli.filePaths) == 1 && !cli.outPath.empty())
