3.3.6 update

CHANGELOG

@@ -2,6 +2,14 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+### 3.3.6
+
+# Added:
+- ScannablePipelineResult
+
+# Fixed:
+- Improved performance
+
 ### 3.3.5
 
 # Added:

Quikkly.framework/Headers/Quikkly-Swift.h

@@ -292,7 +292,7 @@ SWIFT_CLASS_NAMED("Scannable")
 /// \param completion Block with an array of detected scannables; can be empty but not nil
 ///
 + (void)detectInImage:(CGImageRef _Nonnull)image completion:(void (^ _Nonnull)(NSArray<QKScannable *> * _Nonnull))completion;
-/// Asynchronous detection of scannables in an image
+/// Synchronous detection of scannables in an image
 /// \param image The image to scan for scannables
 ///
 ///
@@ -346,13 +346,24 @@ SWIFT_CLASS_NAMED("ScannablePipeline")
 - (void)clear;
 @end
 
+enum QKScannableResult : NSInteger;
 
 /// ScannablePipelineDelegate allows you to receive processed results on the main thread.
 SWIFT_PROTOCOL_NAMED("ScannablePipelineDelegate")
 @protocol QKScannablePipelineDelegate
-- (void)pipelineDidProcessImage:(CGImageRef _Nonnull)image scannables:(NSArray<QKScannable *> * _Nonnull)scannables;
+- (void)pipelineDidProcessImage:(CGImageRef _Nonnull)image result:(enum QKScannableResult)result scannables:(NSArray<QKScannable *> * _Nonnull)scannables;
 @end
 
+/// ScannablePipelineResult for more detailed results.
+typedef SWIFT_ENUM_NAMED(NSInteger, QKScannableResult, "ScannablePipelineResult") {
+  QKScannableResultUnknown = 0,
+  QKScannableResultNoFrameScanned = 10,
+  QKScannableResultNoShapesFound = 100,
+  QKScannableResultShapeFound = 200,
+  QKScannableResultDotsFound = 300,
+  QKScannableResultSuccess = 10000,
+};
+
 enum QKScannableSkinImageFit : int32_t;
 
 /// The ScannableSkin class holds relevant data for the visual representation of a Scannable object.

Quikkly.framework/Headers/quikklycore.h

@@ -47,15 +47,15 @@ Otherwise Python bindings get messy, and floating point access crashes with a ve
 #define QC_EXPORT __attribute__((visibility("default")))
 
 
-#define QC_VERSION_STR "3.3.4"
+#define QC_VERSION_STR "3.3.6"
 
 
 // Greyscale, 1 byte per pixel. Array order is: row, column.
 // For NV21, just use GREY_UINT8, its grayscale channel comes first in memory, and the color channels will be ignored.
-#define QC_IMAGE_FORMAT_GREY_UINT8 0
+#define QC_IMAGE_FORMAT_GREY_UINT8  0
 #define QC_IMAGE_FORMAT_BGRA_UINT32 1
 #define QC_IMAGE_FORMAT_RGBA_UINT32 2
-#define QC_IMAGE_FORMAT_NV21_UINT8 3  // Input byte buffer must be 1.5 * height rows!
+#define QC_IMAGE_FORMAT_NV21_UINT8  3  // Input byte buffer must be 1.5 * height rows!
 
 #define QC_OK 0
 
@@ -76,6 +76,15 @@ Otherwise Python bindings get messy, and floating point access crashes with a ve
 #define QC_JOIN_MAX           16  // Sum of all join constants, do not use.
 
 
+#define QC_SCAN_STATUS_UNKNOWN             0
+#define QC_SCAN_STATUS_NO_FRAME_SCANNED    10
+#define QC_SCAN_STATUS_NO_SHAPES_FOUND     100
+#define QC_SCAN_STATUS_SHAPE_FOUND         200
+#define QC_SCAN_STATUS_DOTS_FOUND          300
+#define QC_SCAN_STATUS_SUCCESS             10000
+#define QC_SCAN_STATUS_MAX                 99999
+
+
 typedef void _QCPipeline;
 
 
@@ -100,8 +109,9 @@ typedef struct _QCTag QCTag;
 // You can access the data until a matching qc_release_result() call.
 struct _QCScanResult {
     QCTag * tags;
+    uint8_t * status_image;  // May be null
     int32_t num_tags;
-    int32_t _pad;
+    int32_t status_code;
 } __attribute__ ((aligned(8)));
 typedef struct _QCScanResult QCScanResult;
 
@@ -160,7 +170,7 @@ int32_t qc_process_frame(
 );
 
 // Allocates a new QCScanResult, and fills it with data from the last processed frame from the pipeline.
-QCScanResult* qc_alloc_extract_result(const _QCPipeline* const pipeline);
+QCScanResult* qc_alloc_extract_result(const _QCPipeline* const pipeline, uint8_t return_status_image);
 void qc_release_result(QCScanResult * result);
 
 // Generate new tags.

Quikkly.podspec.json

@@ -1,6 +1,6 @@
 {
     "name": "Quikkly",
-    "version": "3.3.5",
+    "version": "3.3.6",
     "homepage": "http://www.quikkly.io",
     "license": {
         "type": "Commercial",