aslanyanhaik / roundcode Goto Github PK

Custom rounded QR code with lots of customization.

License: MIT License

Swift 98.93% Ruby 1.07%

barcode swift qrcode qrcode-reader aztec-code xcode cocoapods roundcode swift-package-manager ios

roundcode's Introduction

RoundCode for iOS

RoundCode is custom circular QR code with lots of customization. Similar to Facebook messenger and Apple's App Clip Codes the RoundCode includes convenient camera scanner and decoder.

Installation

Cocoapods:

pod 'RoundCode'

Swift Package Manager:

File > Swift Packages > Add Package Dependency

https://github.com/aslanyanhaik/RoundCode

Usage example

import framework

import RoundCode

Encoding

create coder and encode

let image = RCImage(message: "Hello World")
let coder = RCCoder()
do {
  imageView.image = try coder.encode(image)
} catch {
  //handle errors
}

You can also validate the messsage before encoding

let coder = RCCoder()
let isValidText = coder.validate("Hello world")

Decoding

Create instane of RCCameraViewController and handle the delegate

class ViewController: UIViewController, RCCameraViewControllerDelegate {
  
  func scan() {
    let cameraController = RCCameraViewController()
    cameraController.delegate = self
    present(cameraController, animated: true)
  }
  
  func cameraViewController(didFinishScanning message: String) {
    messageLabel.text = message
  }
}

You can also decode a UIImage like this

let coder = RCCoder()
do {
  messageLabel.text = try coder.decode(UIImage(named: code)!)
} catch {
  //handle errors
}

Appearance

You can change the appearance like this

var image = RCImage(message: "Hello world")
image.contentInsets = UIEdgeInsets(top: 8, left: 10, bottom: 4, right: 10)
image.attachmentImage = UIImage(named: "Profile")
image.size = 300
image.gradientType = .linear(angle: CGFloat.pi)
image.tintColors = [.red, .black]

If image is on dark background you should change scanning mode to darkBackground

let coder = RCCoder()
coder.scanningMode = .darkBackground

Advanced coding configuration

You can provide custom coding configuration in order to encode long text by reducing number of characters

let configuration = RCCoderConfiguration.shortConfiguration
let coder = RCCoder(configuration: configuration)

let configuration = RCCoderConfiguration(characters: " -abcdefghijklmnopqrstuvwxyz0123456789")
let coder = RCCoder(configuration: configuration)

⚠️ If you are encoding with custom configuration, then you should change the RCCameraViewController configuration ⚠️

let configuration = RCCoderConfiguration(characters: " -abcdefghijklmnopqrstuvwxyz0123456789")
let coder = RCCoder(configuration: configuration)
let camera = RCCameraViewController()
camera.coder = coder

Compatibility

Written in Swift 5 and requires Xcode 11.0

RoundCode is compatible with iOS 13.0+.

Author

Haik Aslanyan

License

Licensed under MIT License: https://opensource.org/licenses/MIT

roundcode's People

Stargazers

Watchers

roundcode's Issues

Impressive! Some suggestion how to improve

I never thought that something that possible to do in Swift. Well done! 👍

Here some ideas to improve performance of your algo:

The slowest part of your algo it control point detector. If you will use simplest structure here, you will have better performance and it will be possible to process full image.

  static let lightBackgroundRange = UInt8(0)...UInt8(180) // simple compare better: pixel < 180 
  static let darkBackgroundRange = UInt8(100)...UInt8(255) // simple compare better: pixel > 100

I recommend to perform threshold separately. Accelerate framework can help

let bit = pixelThreshold.contains(data[x, y]) ? RCBit.one : RCBit.zero

You probably don't need RCBit abstraction. typealias around bool will works better and pretty informative

pixelPatterns[pixelPatterns.count - 1] = lastPattern

This operation call lot of times. Just with change struct to class and you can remove this line

2) Reed Solomon codes. Additional you will get error restoration. You have interesting idea with something like `hash` with `RCMatrix` (if I understand it right). To make orientation working, you can try 4 possible orientation on decode bits. It's stupid and simple solution.

You awesome! =)

Custom background color?

Very nice library, is there a way to change the background color in the source code? It must be possible right?

Is there some sort of a spec/documentation?

Title

Change the position of the focus / decoder on the screen

Hi,

The focus is currently in the center of the screen, but how can i change the radius of the focus, and the position on the screen ?

Thanks a lot

coder.scanningMode = .darkBackground not working for iOS 14

I am trying to decode a Round code with a white tint and black background and an image in the middle. I am running on iOS 14 . Regardless of what scanning mode I put It on, It only works for a dark Roundcode on a white background.

Slow loading scanner

Please improve the loading and dismiss time of the scanner

Does the detection have to be on a white BG?

Seems like it only works on the output generated image (White Background), not while on a black BG (using the example app). Could this be made configurable?

I tried to apply a CIFilter(name: "CIColorInvert") to the pixelBuffer with not much luck.

Limitation

Hi!

I know that it isn't issue per se but I have a question directly connected with the code encoder/decoder. May I ask for some data about limitation (especially in terms of character amount) and the "regen" level for damaged codes?

Android Clone

Hi, Do you know if one Android repo exists, like a clone of your project ?

I want to use your code for one project, but i need to have the same with the android app, only to read it

Thanks

White on black background does not seem to scan

I tried latest version with a simple white on black background and cannot seem to get detections to work. Any ideas?

Difficult to scan the roundcode

Character limitation.

Could we have a way to increase character count?
Current character limit is so small.

Why is RoundCodes only compatible with iOS 13.0+?

The README states that RoundCodes is written in Swift 5, requires Xcode 11 and is compatible with iOS 13.0+. Does it not work below iOS 13? Which APIs do you use that are not available on, say, iOS 11?

Decode not working from camera roll

Love the package. Great work. I'm not able to get it working with codes generated by the package that are then loaded from my camera roll. I tested the example project in the repo which also failed with a generic decode error.

if let message = try? coder.decode(camImage) {
  messageLabel.text = message
  messageLabel.isHidden = false
  DispatchQueue.main.asyncAfter(deadline: .now() + 3) {
    self.messageLabel.isHidden = true
  }
}

coder.scanningMode = .darkBackground not working for iOS 14

Is it possible to read theses QR codes with other QrCode Reader ?

Hi, i want to read theses QR codes with the iphone app photo, it's possible ?

Because currently the iphone doesnt detect it

Thanks a lot

Increase number of accepted characters in textfield input

Hey,

I would like to know if it possible to increase the number of input characters in the textfield where you put your string with the default configuration. I want to pass firebase UID but I can because they are too long.

Thanks.

darkBackground not working for iOS 14

Why didn't the android version? 为什么没有安卓版本呢？

这个二维码挺有个性的，可惜没有发现类似的Android版本，只有ios一端的话，难以在app上使用。