quirc-rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bba78f2f6bfc2db3f2fcfb40bbf48ebcc0225e2ea917a1cdde546c2b0d9dfd41
+  data.tar.gz: 7b9a66a2b6c741af5444e921c8e18137e17283404666d3a255fec6b8577b5df2
+SHA512:
+  metadata.gz: f53c2b498c8a6e42ae3ba3436a03bbf5421aeac4dda015fac0cf2610d00a4c1ca4868f3d5d52b41ff173f5be1b713508bdab1208da3ad18968f5c4e22b6e6af1
+  data.tar.gz: f72e0f0ba6fefa71f1647fff6e43ffdcd45c174b4ec61eb70ce65eb04a2082dfcb2450c5a1f4e4ef387243443ca1a2e1fb7ca95fb58e5777e24019b66db390db

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+*.log

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in quirc.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rake-compiler"
+
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    quirc-rb (0.1.0)
+      image_processing (~> 1.12, >= 1.12.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ffi (1.15.3)
+    image_processing (1.12.1)
+      mini_magick (>= 4.9.5, < 5)
+      ruby-vips (>= 2.0.17, < 3)
+    mini_magick (4.11.0)
+    minitest (5.14.4)
+    rake (13.0.3)
+    rake-compiler (1.1.1)
+      rake
+    ruby-vips (2.1.2)
+      ffi (~> 1.12)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  quirc-rb!
+  rake (~> 13.0)
+  rake-compiler
+
+BUNDLED WITH
+   2.2.22

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 songji
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,44 @@
+# Quirc
+
+QRcode recognizer
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "quirc-rb"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install quirc-rb
+
+## Usage
+
+```ruby
+require "quirc"
+
+Quirc.recognize("qrcode.png")
+Quirc.recognize("qrcode.png", image_processor: :vips) # default
+Quirc.recognize("qrcode.png", image_processor: :mini_magick)
+Quirc.recognize("qrcode.png", image_processor: :vips, width: 200) # resize
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/songjiz/quirc-rb.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "fileutils"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "rake/extensiontask"
+
+task build: :compile
+
+Rake::ExtensionTask.new("quirc") do |ext|
+  ext.name    = "quirc"
+  ext.lib_dir = "lib/quirc"
+end
+
+desc "git clone https://github.com/dlbeer/quirc.git"
+task :clone do
+  FileUtils.remove_dir("ext/src", true)
+  FileUtils.remove_dir("tmp/quirc", true)
+  FileUtils.mkdir("ext/src")
+  system("git clone https://github.com/dlbeer/quirc.git tmp/quirc")
+  FileUtils.copy_entry("tmp/quirc/lib", "ext/src/lib")
+  FileUtils.copy_file("tmp/quirc/Makefile", "ext/src/Makefile")
+end
+
+task default: %i[clobber compile test]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "quirc"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ext/quirc/extconf.rb

@@ -0,0 +1,28 @@
+require "mkmf"
+require "fileutils"
+
+src_dir = File.expand_path(File.join(__dir__, "../src"))
+lib_dir = "#{src_dir}/lib"
+inc_dir = "#{src_dir}/lib"
+
+Dir.chdir(src_dir) do
+  system("make clean")
+  system("make libquirc.a")
+  FileUtils.mv(Dir.glob("*.a"), "lib")
+end
+
+$libs     << " -lquirc"
+$CPPFLAGS << " -I#{inc_dir}"
+$LDFLAGS  << " -L#{lib_dir}"
+
+have_header("quirc.h")
+have_library("quirc")
+have_func("quirc_version")
+have_func("quirc_new")
+have_func("quirc_begin")
+have_func("quirc_end")
+have_func("quirc_destroy")
+have_func("quirc_resize")
+have_func("quirc_count")
+
+create_makefile("quirc/quirc")

data/ext/quirc/quirc.c

@@ -0,0 +1,146 @@
+#include <ruby.h>
+#include "quirc_internal.h"
+
+#define LIB_VERSION rb_str_new_cstr(quirc_version())
+
+VALUE mQuirc;
+VALUE cQuircRecognizer;
+VALUE cQuircData;
+
+typedef struct {
+  struct quirc *quirc;
+} quirc_recognizer_t;
+
+static void quirc_recognizer_t_dfree(void* _qr) {
+  quirc_recognizer_t* qr = (quirc_recognizer_t*)_qr;
+  if (qr->quirc != NULL) {
+    quirc_destroy(qr->quirc);
+  }
+  free(qr);
+}
+
+static size_t quirc_recognizer_t_dsize(const void* _qr) {
+  size_t size;
+  quirc_recognizer_t* qr = (quirc_recognizer_t*)_qr;
+  size = sizeof(quirc_recognizer_t);
+  if (qr->quirc != NULL) {
+    size += sizeof(struct quirc);
+    size += sizeof(quirc_pixel_t);
+    // image byte size
+    size += qr->quirc->w * qr->quirc->h;
+    size += sizeof(struct quirc_flood_fill_vars);
+  }
+  return size;
+}
+
+// static void quirc_recognizer_t_dmark(void* _qr) {
+//   quirc_recognizer_t* qr = (quirc_recognizer_t*)_qr;
+// }
+
+static const rb_data_type_t quirc_recognizer_data_type = {
+  .wrap_struct_name = "quirc recognizer object",
+  .function = {
+    // .dmark = quirc_recognizer_t_dmark,
+    .dfree = quirc_recognizer_t_dfree,
+    .dsize = quirc_recognizer_t_dsize,
+  },
+  .flags = RUBY_TYPED_FREE_IMMEDIATELY,
+};
+
+VALUE quirc_recognizer_t_alloc(VALUE self) {
+  quirc_recognizer_t *qr = malloc(sizeof(quirc_recognizer_t));
+
+  qr->quirc = quirc_new();
+
+  if (qr->quirc == NULL) {
+    free(qr);
+    rb_raise(rb_eNoMemError, "%s", "(quirc_new) failed to allocate memory");
+  }
+
+  return TypedData_Wrap_Struct(self, &quirc_recognizer_data_type, qr);
+}
+
+VALUE quirc_recognizer_t_recognize(VALUE self, VALUE image_data, VALUE width, VALUE height) {
+  quirc_recognizer_t *qr;
+  uint8_t *image;
+  int w, h;
+  int total_pixels;
+  int total_codes;
+  VALUE results;
+
+  Check_Type(image_data, T_STRING);
+
+  total_pixels = NUM2INT(width) * NUM2INT(height);
+
+  TypedData_Get_Struct(self, quirc_recognizer_t, &quirc_recognizer_data_type, qr);
+
+  if (quirc_resize(qr->quirc, NUM2INT(width), NUM2INT(height)) == -1) {
+    rb_raise(rb_eNoMemError, "%s", "(quirc_resize) failed to allocate memory");
+  }
+
+  image = quirc_begin(qr->quirc, &w, &h);
+  total_pixels = w * h;
+
+  // Filling the image buffer. One byte per pixel.
+  if (RSTRING_LEN(image_data) >= total_pixels) {
+    memcpy(image, StringValuePtr(image_data), total_pixels);
+  } else {
+    // rb_raise(rb_eArgError, "%s", "Expect an 8-bit image");
+  }
+
+  quirc_end(qr->quirc);
+
+  total_codes = quirc_count(qr->quirc);
+  results = rb_ary_new_capa(total_codes);
+
+  for (int i = 0; i < total_codes; ++i) {
+    struct quirc_code code;
+    struct quirc_data data;
+    quirc_decode_error_t err;
+    VALUE result;
+
+    quirc_extract(qr->quirc, i, &code);
+
+    err = quirc_decode(&code, &data);
+
+    if (err == QUIRC_ERROR_DATA_ECC) {
+      quirc_flip(&code);
+      err = quirc_decode(&code, &data);
+    }
+
+    if (err != QUIRC_SUCCESS) {
+      rb_warn("(quirc_decode) %s", quirc_strerror(err));
+      continue;
+    }
+
+    result = rb_funcall(cQuircData, rb_intern("new"), 0);
+    rb_iv_set(result, "@version", INT2FIX(data.version));
+    rb_iv_set(result, "@ecc_level", INT2FIX(data.ecc_level));
+    rb_iv_set(result, "@mask", INT2FIX(data.mask));
+    rb_iv_set(result, "@data_type", INT2FIX(data.data_type));
+    rb_iv_set(result, "@payload_len", INT2FIX(data.payload_len));
+    rb_iv_set(result, "@payload", rb_str_new_cstr((const char *)data.payload));
+    rb_iv_set(result, "@eci", INT2NUM(data.eci));
+    rb_ary_push(results, result);
+  }
+
+  return results;
+}
+
+void Init_quirc(void) {
+  mQuirc = rb_define_module("Quirc");
+  rb_define_const(mQuirc, "LIB_VERSION", LIB_VERSION);
+
+  cQuircRecognizer = rb_define_class_under(mQuirc, "Recognizer", rb_cObject);
+  rb_define_alloc_func(cQuircRecognizer, quirc_recognizer_t_alloc);
+  rb_define_method(cQuircRecognizer, "recognize", quirc_recognizer_t_recognize, 3);
+
+  cQuircData = rb_define_class_under(mQuirc, "Data", rb_cObject);
+  rb_define_attr(cQuircData, "version", 1, 0);
+  rb_define_attr(cQuircData, "ecc_level", 1, 0);
+  rb_define_attr(cQuircData, "mask", 1, 0);
+  rb_define_attr(cQuircData, "data_type", 1, 0);
+  rb_define_attr(cQuircData, "payload_len", 1, 0);
+  rb_define_attr(cQuircData, "payload", 1, 0);
+  rb_define_attr(cQuircData, "eci", 1, 0);
+}

data/ext/src/Makefile

@@ -0,0 +1,103 @@
+# quirc -- QR-code recognition library
+# Copyright (C) 2010-2012 Daniel Beer <dlbeer@gmail.com>
+#
+# Permission to use, copy, modify, and/or distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+CC ?= gcc
+PREFIX ?= /usr/local
+SDL_CFLAGS != pkg-config --cflags sdl
+SDL_LIBS != pkg-config --libs sdl
+
+LIB_VERSION = 1.0
+
+CFLAGS ?= -O3 -Wall -fPIC
+QUIRC_CFLAGS = -Ilib $(CFLAGS) $(SDL_CFLAGS)
+LIB_OBJ = \
+    lib/decode.o \
+    lib/identify.o \
+    lib/quirc.o \
+    lib/version_db.o
+DEMO_OBJ = \
+    demo/camera.o \
+    demo/mjpeg.o \
+    demo/convert.o
+DEMO_UTIL_OBJ = \
+    demo/dthash.o \
+    demo/demoutil.o
+
+OPENCV_CFLAGS != pkg-config --cflags opencv4
+OPENCV_LIBS != pkg-config --libs opencv4
+QUIRC_CXXFLAGS = $(QUIRC_CFLAGS) $(OPENCV_CFLAGS) --std=c++17
+
+all: libquirc.so qrtest inspect quirc-demo quirc-scanner
+
+qrtest: tests/dbgutil.o tests/qrtest.o libquirc.a
+	$(CC) -o $@ tests/dbgutil.o tests/qrtest.o libquirc.a $(LDFLAGS) -lm -ljpeg -lpng
+
+inspect: tests/dbgutil.o tests/inspect.o libquirc.a
+	$(CC) -o $@ tests/dbgutil.o tests/inspect.o libquirc.a $(LDFLAGS) -lm -ljpeg -lpng $(SDL_LIBS) -lSDL_gfx
+
+quirc-demo: $(DEMO_OBJ) $(DEMO_UTIL_OBJ) demo/demo.o libquirc.a
+	$(CC) -o $@ $(DEMO_OBJ) $(DEMO_UTIL_OBJ) demo/demo.o libquirc.a $(LDFLAGS) -lm -ljpeg $(SDL_LIBS) -lSDL_gfx
+
+quirc-demo-opencv: $(DEMO_UTIL_OBJ) demo/demo_opencv.o libquirc.a
+	$(CXX) -o $@ $(DEMO_UTIL_OBJ) demo/demo_opencv.o libquirc.a $(LDFLAGS) -lm $(OPENCV_LIBS)
+
+quirc-scanner: $(DEMO_OBJ) $(DEMO_UTIL_OBJ) demo/scanner.o libquirc.a
+	$(CC) -o $@ $(DEMO_OBJ) $(DEMO_UTIL_OBJ) demo/scanner.o libquirc.a $(LDFLAGS) -lm -ljpeg
+
+libquirc.a: $(LIB_OBJ)
+	rm -f $@
+	ar cru $@ $(LIB_OBJ)
+	ranlib $@
+
+.PHONY: libquirc.so
+libquirc.so: libquirc.so.$(LIB_VERSION)
+
+libquirc.so.$(LIB_VERSION): $(LIB_OBJ)
+	$(CC) -shared -o $@ $(LIB_OBJ) $(LDFLAGS) -lm
+
+.c.o:
+	$(CC) $(QUIRC_CFLAGS) -o $@ -c $<
+
+.SUFFIXES: .cxx
+.cxx.o:
+	$(CXX) $(QUIRC_CXXFLAGS) -o $@ -c $<
+
+install: libquirc.a libquirc.so.$(LIB_VERSION) quirc-demo quirc-scanner
+	install -o root -g root -m 0644 lib/quirc.h $(DESTDIR)$(PREFIX)/include
+	install -o root -g root -m 0644 libquirc.a $(DESTDIR)$(PREFIX)/lib
+	install -o root -g root -m 0755 libquirc.so.$(LIB_VERSION) \
+		$(DESTDIR)$(PREFIX)/lib
+	install -o root -g root -m 0755 quirc-demo $(DESTDIR)$(PREFIX)/bin
+	# install -o root -g root -m 0755 quirc-demo-opencv $(DESTDIR)$(PREFIX)/bin
+	install -o root -g root -m 0755 quirc-scanner $(DESTDIR)$(PREFIX)/bin
+
+uninstall:
+	rm -f $(DESTDIR)$(PREFIX)/include/quirc.h
+	rm -f $(DESTDIR)$(PREFIX)/lib/libquirc.so.$(LIB_VERSION)
+	rm -f $(DESTDIR)$(PREFIX)/lib/libquirc.a
+	rm -f $(DESTDIR)$(PREFIX)/bin/quirc-demo
+	rm -f $(DESTDIR)$(PREFIX)/bin/quirc-demo-opencv
+	rm -f $(DESTDIR)$(PREFIX)/bin/quirc-scanner
+
+clean:
+	rm -f */*.o
+	rm -f */*.lo
+	rm -f libquirc.a
+	rm -f libquirc.so.$(LIB_VERSION)
+	rm -f qrtest
+	rm -f inspect
+	rm -f quirc-demo
+	rm -f quirc-demo-opencv
+	rm -f quirc-scanner