zxing-cpp · axxel · Jul 13, 2022 · Feb 25, 2022 · May 24, 2022 · Jun 2, 2022
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -53,6 +53,29 @@ jobs:
       # Execute tests defined by the CMake configuration.
       # See https://cmake.org/cmake/help/latest/manual/ctest.1.html for more detail
       run: ctest -V -C $BUILD_TYPE
+
+  build-ios:
+    runs-on: macos-latest
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        ref: ${{github.ref}}
+
+    - name: Build the ZXingCpp.xcframework
+      shell: sh
+      working-directory: ${{runner.workspace}}/${{github.event.repository.name}}/wrappers/ios
+      run: ./build-release.sh
+
+    - name: Upload .xcframework
+      uses: actions/upload-artifact@v3
+      with:
+        name: ios-artifacts
+        path: ${{runner.workspace}}/${{github.event.repository.name}}/wrappers/ios/ZXingCpp.xcframework
+
+    - name: Build the demo app
+      shell: sh
+      working-directory: ${{runner.workspace}}/${{github.event.repository.name}}/wrappers/ios/demo
+      run: xcodebuild build -scheme demo -sdk "iphonesimulator"
 
   build-android:
     runs-on: ubuntu-latest

diff --git a/core/CMakeLists.txt b/core/CMakeLists.txt
@@ -115,6 +115,7 @@ if (BUILD_READERS)
         src/Result.cpp
         src/ResultPoint.h
         src/ResultPoint.cpp
+        src/StructuredAppend.h
         src/TextDecoder.h
         src/TextDecoder.cpp
         src/ThresholdBinarizer.h
@@ -484,13 +485,31 @@ endif()
 
 set_target_properties(ZXing PROPERTIES PUBLIC_HEADER "${PUBLIC_HEADERS}")
 
+if (APPLE)
+    set_target_properties(ZXing PROPERTIES
+        FRAMEWORK TRUE
+        FRAMEWORK_VERSION "C"
+        XCODE_ATTRIBUTE_DEFINES_MODULE YES
+        XCODE_ATTRIBUTE_BUILD_LIBRARY_FOR_DISTRIBUTION YES
+        XCODE_ATTRIBUTE_MODULEMAP_FILE "wrappers/ios/Sources/Wrapper/module.modulemap"
+        XCODE_ATTRIBUTE_CLANG_ENABLE_OBJC_ARC YES
+        MACOSX_FRAMEWORK_IDENTIFIER "com.zxing_cpp.ios"
+        CMAKE_XCODE_ATTRIBUTE_ONLY_ACTIVE_ARCH NO
+        #MACOSX_FRAMEWORK_INFO_PLIST Info.plist
+        PUBLIC_HEADER "${PUBLIC_HEADERS}"
+        XCODE_ATTRIBUTE_CODE_SIGN_IDENTITY "iPhone Developer"
+        XCODE_ATTRIBUTE_ENABLE_BITCODE "YES"
+    )
+endif()
+
 include (GNUInstallDirs)
 
 install (
     TARGETS ZXing EXPORT ZXingTargets
     LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
     RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
     ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
+    FRAMEWORK DESTINATION ${CMAKE_INSTALL_LIBDIR}
 #    INCLUDES DESTINATION include
     PUBLIC_HEADER DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}/ZXing"
 )

diff --git a/wrappers/ios/.gitignore b/wrappers/ios/.gitignore
@@ -0,0 +1,5 @@
+.swiftpm
+_builds
+.build
+xcuserdata
+ZXingCpp.xcframework
diff --git a/wrappers/ios/Info.plist b/wrappers/ios/Info.plist
diff --git a/wrappers/ios/Package.swift b/wrappers/ios/Package.swift
@@ -0,0 +1,31 @@
+// swift-tools-version:5.3
+import PackageDescription
+
+let package = Package(
+    name: "ZXingCppWrapper",
+    platforms: [
+        .iOS(.v13)
+    ],
+    products: [
+        .library(
+            name: "ZXingCppWrapper",
+            type: .static,
+            targets: ["ZXingCppWrapper"])
+    ],
+    targets: [
+        .binaryTarget(
+            name: "ZXingCpp",
+            path: "ZXingCpp.xcframework"
+        ),
+        .target(
+            name: "ZXingCppWrapper",
+            dependencies: ["ZXingCpp"],
+            path: "Sources/Wrapper",
+            publicHeadersPath: ".",
+            cxxSettings: [
+                .unsafeFlags(["-stdlib=libc++"]),
+                .unsafeFlags(["-std=gnu++17"])
+            ]
+        )
+    ]
+)
diff --git a/wrappers/ios/README.md b/wrappers/ios/README.md
@@ -0,0 +1,14 @@
+# ZXingCpp iOS Framework
+
+To use the iOS (wrapper) framework in other apps, it is easiest
+to build the library project and include the resulting xcframework
+file in your app.
+
+## How to build and use
+
+To build the xcframework:
+
+	$ ./build-release.sh
+
+Then you can add the iOS Wrapper as a local Swift Package by adding it as a dependency to your app.
+Don't forget to add the wrapper to the `Frameworks, Libraries, and Embedded Content` section within the `General` tab.
diff --git a/wrappers/ios/Sources/Wrapper/Reader/ZXIBarcodeReader.h b/wrappers/ios/Sources/Wrapper/Reader/ZXIBarcodeReader.h
@@ -0,0 +1,21 @@
+// Copyright 2022 KURZ Digital Solutions GmbH
+//
+// SPDX-License-Identifier: Apache-2.0
+
+#import <CoreGraphics/CoreGraphics.h>
+#import <CoreImage/CoreImage.h>
+#import "ZXIResult.h"
+#import "ZXIDecodeHints.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface ZXIBarcodeReader : NSObject
+@property(nonatomic, strong) ZXIDecodeHints *hints;
+
+- (instancetype)initWithHints:(ZXIDecodeHints*)options;
+- (NSArray<ZXIResult *> *)readCIImage:(nonnull CIImage *)image;
+- (NSArray<ZXIResult *> *)readCGImage:(nonnull CGImageRef)image;
+- (NSArray<ZXIResult *> *)readCVPixelBuffer:(nonnull CVPixelBufferRef)pixelBuffer;
+@end
+
+NS_ASSUME_NONNULL_END
diff --git a/wrappers/ios/Sources/Wrapper/Reader/ZXIBarcodeReader.mm b/wrappers/ios/Sources/Wrapper/Reader/ZXIBarcodeReader.mm
@@ -0,0 +1,127 @@
+// Copyright 2022 KURZ Digital Solutions GmbH
+//
+// SPDX-License-Identifier: Apache-2.0
+
+#import "ZXIBarcodeReader.h"
+#import "ZXing/ReadBarcode.h"
+#import "ZXing/ImageView.h"
+#import "ZXing/Result.h"
+#import "ZXIFormatHelper.h"
+#import "ZXIPosition+Helper.h"
+
+using namespace ZXing;
+
+@interface ZXIBarcodeReader()
+@property (nonatomic, strong) CIContext* ciContext;
+@end
+
+@implementation ZXIBarcodeReader
+
+- (instancetype)init {
+    return [self initWithHints: [[ZXIDecodeHints alloc]initWithTryHarder:NO tryRotate:NO tryDownscale:NO maxNumberOfSymbols:1 formats:@[]]];
+}
+
+- (instancetype)initWithHints:(ZXIDecodeHints*)hints{
+    self = [super init];
+    self.ciContext = [CIContext new];
+    self.hints = hints;
+    return self;
+}
+
+- (NSArray<ZXIResult *> *)readCVPixelBuffer:(nonnull CVPixelBufferRef)pixelBuffer {
+    OSType pixelFormat = CVPixelBufferGetPixelFormatType(pixelBuffer);
+
+    // We tried to work with all luminance based formats listed in kCVPixelFormatType
+    // but only the following ones seem to be supported on iOS.
+    switch (pixelFormat) {
+        case kCVPixelFormatType_420YpCbCr8BiPlanarVideoRange:
+        case kCVPixelFormatType_420YpCbCr8BiPlanarFullRange:
+            NSInteger cols = CVPixelBufferGetWidth(pixelBuffer);
+            NSInteger rows = CVPixelBufferGetHeight(pixelBuffer);
+            NSInteger bytesPerRow = CVPixelBufferGetBytesPerRowOfPlane(pixelBuffer, 0);
+            CVPixelBufferLockBaseAddress(pixelBuffer, kCVPixelBufferLock_ReadOnly);
+            const uint8_t * bytes = static_cast<const uint8_t *>(CVPixelBufferGetBaseAddressOfPlane(pixelBuffer, 0));
+            ImageView imageView = ImageView(
+                                            static_cast<const uint8_t *>(bytes),
+                                            static_cast<int>(cols),
+                                            static_cast<int>(rows),
+                                            ImageFormat::Lum,
+                                            static_cast<int>(bytesPerRow),
+                                            0);
+            NSArray* results = [self readImageView:imageView];
+            CVPixelBufferUnlockBaseAddress(pixelBuffer, kCVPixelBufferLock_ReadOnly);
+            return results;
+    }
+
+    // If given pixel format is not a supported type with a luminance channel we just use the
+    // default method
+    return [self readCIImage:[[CIImage alloc] initWithCVImageBuffer:pixelBuffer]];
+}
+
+- (NSArray<ZXIResult *> *)readCIImage:(nonnull CIImage *)image {
+    CGImageRef cgImage = [self.ciContext createCGImage:image fromRect:image.extent];
+    auto results = [self readCGImage:cgImage];
+    CGImageRelease(cgImage);
+    return results;
+}
+
+- (NSArray<ZXIResult *> *)readCGImage: (nonnull CGImageRef)image {
+    CGColorSpaceRef colorSpace = CGColorSpaceCreateWithName(kCGColorSpaceGenericGray);
+    CGFloat cols = CGImageGetWidth(image);
+    CGFloat rows = CGImageGetHeight(image);
+    NSMutableData *data = [NSMutableData dataWithLength: cols * rows];
+
+
+    CGContextRef contextRef = CGBitmapContextCreate(
+                                                    data.mutableBytes,// Pointer to backing data
+                                                    cols,                      // Width of bitmap
+                                                    rows,                     // Height of bitmap
+                                                    8,                          // Bits per component
+                                                    cols,              // Bytes per row
+                                                    colorSpace,                 // Colorspace
+                                                    kCGBitmapByteOrderDefault); // Bitmap info flags
+    CGContextDrawImage(contextRef, CGRectMake(0, 0, cols, rows), image);
+    CGContextRelease(contextRef);
+
+    ImageView imageView = ImageView(
+              static_cast<const uint8_t *>(data.bytes),
+              static_cast<int>(cols),
+              static_cast<int>(rows),
+              ImageFormat::Lum);
+    return [self readImageView:imageView];
+}
+
++ (DecodeHints)DecodeHintsFromZXIOptions:(ZXIDecodeHints*)hints {
+    BarcodeFormats formats;
+    for(NSNumber* flag in hints.formats) {
+        formats.setFlag(BarcodeFormatFromZXIFormat((ZXIFormat)flag.integerValue));
+    }
+    DecodeHints resultingHints = DecodeHints()
+        .setTryRotate(hints.tryRotate)
+        .setTryHarder(hints.tryHarder)
+        .setTryDownscale(hints.tryDownscale)
+        .setFormats(formats)
+        .setMaxNumberOfSymbols(hints.maxNumberOfSymbols);
+    return resultingHints;
+}
+
+- (NSArray<ZXIResult*> *)readImageView: (ImageView)imageView {
+    Results results = ReadBarcodes(imageView, [ZXIBarcodeReader DecodeHintsFromZXIOptions:self.hints]);
+
+    NSMutableArray* zxiResults = [NSMutableArray array];
+    for (auto result: results) {
+        auto resultText = result.text();
+        NSString *text = [[NSString alloc]initWithBytes:resultText.data() length:resultText.size() encoding:NSUTF8StringEncoding];
+
+        NSData *bytes = [[NSData alloc] initWithBytes:result.bytes().data() length:result.bytes().size()];
+        [zxiResults addObject:
+         [[ZXIResult alloc] init:text
+                          format:ZXIFormatFromBarcodeFormat(result.format())
+                           bytes:bytes
+                        position:[[ZXIPosition alloc]initWithPosition: result.position()]
+         ]];
+    }
+    return zxiResults;
+}
+
+@end
diff --git a/wrappers/ios/Sources/Wrapper/Reader/ZXIDecodeHints.h b/wrappers/ios/Sources/Wrapper/Reader/ZXIDecodeHints.h
@@ -0,0 +1,24 @@
+// Copyright 2022 KURZ Digital Solutions GmbH
+//
+// SPDX-License-Identifier: Apache-2.0
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface ZXIDecodeHints : NSObject
+@property(nonatomic) BOOL tryHarder;
+@property(nonatomic) BOOL tryRotate;
+@property(nonatomic) BOOL tryDownscale;
+@property(nonatomic) NSInteger maxNumberOfSymbols;
+/// An array of ZXIFormat
+@property(nonatomic, strong) NSArray<NSNumber*> *formats;
+
+- (instancetype)initWithTryHarder:(BOOL)tryHarder
+                        tryRotate:(BOOL)tryRotate
+                     tryDownscale:(BOOL)tryDownscale
+               maxNumberOfSymbols:(NSInteger)maxNumberOfSymbol
+                          formats:(NSArray<NSNumber*>*)formats;
+@end
+
+NS_ASSUME_NONNULL_END
diff --git a/wrappers/ios/Sources/Wrapper/Reader/ZXIDecodeHints.mm b/wrappers/ios/Sources/Wrapper/Reader/ZXIDecodeHints.mm
@@ -0,0 +1,23 @@
+// Copyright 2022 KURZ Digital Solutions GmbH
+//
+// SPDX-License-Identifier: Apache-2.0
+
+#import "ZXIDecodeHints.h"
+
+@implementation ZXIDecodeHints
+
+- (instancetype)initWithTryHarder:(BOOL)tryHarder
+                        tryRotate:(BOOL)tryRotate
+                     tryDownscale:(BOOL)tryDownscale
+               maxNumberOfSymbols:(NSInteger)maxNumberOfSymbols
+                          formats:(NSArray<NSNumber*>*)formats {
+    self = [super init];
+    self.tryHarder = tryHarder;
+    self.tryRotate = tryRotate;
+    self.tryDownscale = tryDownscale;
+    self.maxNumberOfSymbols = maxNumberOfSymbols;
+    self.formats = formats;
+    return self;
+}
+
+@end
diff --git a/wrappers/ios/Sources/Wrapper/Reader/ZXIPoint.h b/wrappers/ios/Sources/Wrapper/Reader/ZXIPoint.h
@@ -0,0 +1,17 @@
+// Copyright 2022 KURZ Digital Solutions GmbH
+//
+// SPDX-License-Identifier: Apache-2.0
+
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface ZXIPoint : NSObject
+@property(nonatomic) NSInteger x;
+@property(nonatomic) NSInteger y;
+
+- (instancetype)initWithX:(NSInteger)x y:(NSInteger)y;
+@end
+
+NS_ASSUME_NONNULL_END
diff --git a/wrappers/ios/Sources/Wrapper/Reader/ZXIPoint.m b/wrappers/ios/Sources/Wrapper/Reader/ZXIPoint.m
@@ -0,0 +1,16 @@
+// Copyright 2022 KURZ Digital Solutions GmbH
+//
+// SPDX-License-Identifier: Apache-2.0
+
+
+#import "ZXIPoint.h"
+
+@implementation ZXIPoint
+
+- (instancetype)initWithX:(NSInteger)x y:(NSInteger)y {
+    self = [super init];
+    self.x = x;
+    self.y = y;
+    return self;
+}
+@end
diff --git a/wrappers/ios/Sources/Wrapper/Reader/ZXIPosition+Helper.h b/wrappers/ios/Sources/Wrapper/Reader/ZXIPosition+Helper.h
@@ -0,0 +1,15 @@
+// Copyright 2022 KURZ Digital Solutions GmbH
+//
+// SPDX-License-Identifier: Apache-2.0
+
+#import <Foundation/Foundation.h>
+#import "ZXIPosition.h"
+#import "ZXing/Result.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface ZXIPosition(Helper)
+- (instancetype)initWithPosition:(ZXing::Position)position;
+@end
+
+NS_ASSUME_NONNULL_END
diff --git a/wrappers/ios/Sources/Wrapper/Reader/ZXIPosition+Helper.mm b/wrappers/ios/Sources/Wrapper/Reader/ZXIPosition+Helper.mm
@@ -0,0 +1,17 @@
+// Copyright 2022 KURZ Digital Solutions GmbH
+//
+// SPDX-License-Identifier: Apache-2.0
+
+
+#import "ZXIPosition+Helper.h"
+#import "ZXIPoint.h"
+
+@implementation ZXIPosition(Helper)
+-(instancetype)initWithPosition:(ZXing::Position)position {
+    return [self initWithTopLeft:[[ZXIPoint alloc] initWithX:position.topLeft().x y:position.topLeft().y]
+                        topRight:[[ZXIPoint alloc] initWithX:position.topRight().x y:position.topRight().y]
+                     bottomRight:[[ZXIPoint alloc] initWithX:position.bottomRight().x y:position.bottomRight().y]
+                      bottomLeft:[[ZXIPoint alloc] initWithX:position.bottomLeft().x y:position.bottomLeft().y]];
+}
+
+@end