quirc 0.0.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 95b42c1794ae28a39eaa4624f95f21ec08998e82
-  data.tar.gz: 30374a93a681b09eb4c6895187a1149139bcca36
+SHA256:
+  metadata.gz: 238e53d6dcadb8f91b5a227a343544d152494ca10657958e51a937b2cee09785
+  data.tar.gz: db1ff5a61049d9ecee487af9632939af22aa9f762c170725c3b4b08f19f48045
 SHA512:
-  metadata.gz: 20cd7bc2adbf17fcfbbb10dc1286a23f6db8b6597c4705147e265c55b665c721676889ad50bea6075b168427ed2e93fddf930125bf6fbf1368cae85e92de1c38
-  data.tar.gz: a72a276e462450515e457c60f5b86b33702e30b38d5bbf0ecda8f9ec9a18fdfcd3d2d04199c799a7450233ceeeb52e7f76d4d9457e30d0a1ef9fbdb0e4c2c021
+  metadata.gz: 6c8078f8528ae8984060aa91f7603beb785cfa5fe9da9f2863ce648c94d4b0bcc03a8001545d4af85bf44076148dca27f93c046e121a163043366367a538833b
+  data.tar.gz: eff42614d61320a6df00bfb0c01c5b33bb03a4083f8c4376956b5e35f2dd7237895f9251ee38973f98028a31fd456edd700e21fc545168cd5b3500db8ac33f4d

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017 Jacob Middag
+Copyright (c) 2017-2019 Jacob Middag
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,7 +1,37 @@
 # Quirc bindings for Ruby
 
-Quirc is a small C library for extracting and decode QR codes from images.
+[Quirc](https://github.com/dlbeer/quirc) is a small C library for extracting and decode QR codes from images.
 This project is a Ruby binding for that library with the library embedded.
 
+## Example
+You have to supply a [ChunkyPNG](http://chunkypng.com/) object or a binary string of the grayscale image with width and height.
+```ruby
+require 'chunky_png'
+require 'quirc'
+
+img = ChunkyPNG::Image.from_file('path_to_image.png')
+res = Quirc.decode(img).first
+puts res.payload
+```
+
+```ruby
+require 'base64'
+require 'zlib'
+require 'quirc'
+
+encoded = <<~EOD
+  eJzt0kEOwyAMRNHe/9LpFo1mwK1IYqQ/mwQDfl5wXYQQQgghT+cziZ7Tb+Ue
+  7vvurL76Vvvhvuvqu0jvqHoP9wx3dh73fHdWxz3Hrc5TvYfbx01RP83j7uH2
+  cCtzuf+7g7uvr74ZrY9r967cedxebrrjZtK9tMbt4Y7+L/V/Tdzn3DRH+td5
+  0hq3h5veR+qjNTcPbh+3Mpd7Qzt6497vat+Voe9Oa7j93GpdrXGt+7i9XO3j
+  +jknzYB7huvmGM+7GXHPcWeOM3B7upV5Rlvvun3cHm6K+qt5qibucy4hhBBC
+  yN58AXWDGDc=
+EOD
+
+img = Zlib::Inflate.inflate(Base64.decode64(encoded))
+res = Quirc.decode(img, 120, 120).first
+puts res.payload
+```
+
 ## License
 This software is licensed under the MIT License. [View the license](LICENSE).

data/ext/quirc/embed/Makefile

@@ -19,7 +19,7 @@ BUILD_DIR ?= .
 
 LIB_VERSION = 1.0
 
-CFLAGS ?= -O3 -Wall -fPIC
+CFLAGS ?= -O3 -Wall -fPIC -std=c99
 LIB_OBJ = \
     lib/decode.o \
     lib/identify.o \

data/ext/quirc/embed/lib/decode.c

@@ -117,7 +117,7 @@ static const uint8_t gf256_log[256] = {
 	0x74, 0xd6, 0xf4, 0xea, 0xa8, 0x50, 0x58, 0xaf
 };
 
-const static struct galois_field gf256 = {
+static const struct galois_field gf256 = {
 	.p = 255,
 	.log = gf256_log,
 	.exp = gf256_exp
@@ -790,12 +790,18 @@ static quirc_decode_error_t decode_kanji(struct quirc_data *data,
 
 	for (i = 0; i < count; i++) {
 		int d = take_bits(ds, 13);
+		int msB = d / 0xc0;
+		int lsB = d % 0xc0;
+		int intermediate = (msB << 8) | lsB;
 		uint16_t sjw;
 
-		if (d + 0x8140 >= 0x9ffc)
-			sjw = d + 0x8140;
-		else
-			sjw = d + 0xc140;
+		if (intermediate + 0x8140 <= 0x9ffc) {
+			/* bytes are in the range 0x8140 to 0x9FFC */
+			sjw = intermediate + 0x8140;
+		} else {
+			/* bytes are in the range 0xE040 to 0xEBBF */
+			sjw = intermediate + 0xc140;
+		}
 
 		data->payload[data->payload_len++] = sjw >> 8;
 		data->payload[data->payload_len++] = sjw & 0xff;

data/ext/quirc/embed/lib/identify.c

@@ -196,9 +196,7 @@ static void threshold(struct quirc *q)
 		threshold_s = THRESHOLD_S_MIN;
 
 	for (y = 0; y < q->h; y++) {
-		int row_average[q->w];
-
-		memset(row_average, 0, sizeof(row_average));
+		memset(q->row_average, 0, q->w * sizeof(int));
 
 		for (x = 0; x < q->w; x++) {
 			int w, u;
@@ -216,12 +214,12 @@ static void threshold(struct quirc *q)
 			avg_u = (avg_u * (threshold_s - 1)) /
 				threshold_s + row[u];
 
-			row_average[w] += avg_w;
-			row_average[u] += avg_u;
+			q->row_average[w] += avg_w;
+			q->row_average[u] += avg_u;
 		}
 
 		for (x = 0; x < q->w; x++) {
-			if (row[x] < row_average[x] *
+			if (row[x] < q->row_average[x] *
 			    (100 - THRESHOLD_T) / (200 * threshold_s))
 				row[x] = QUIRC_PIXEL_BLACK;
 			else
@@ -427,7 +425,7 @@ static void finder_scan(struct quirc *q, int y)
 {
 	quirc_pixel_t *row = q->pixels + y * q->w;
 	int x;
-	int last_color;
+	int last_color = 0;
 	int run_length = 0;
 	int run_count = 0;
 	int pb[5];

data/ext/quirc/embed/lib/quirc.c

@@ -36,34 +36,83 @@ struct quirc *quirc_new(void)
 
 void quirc_destroy(struct quirc *q)
 {
-	if (q->image)
-		free(q->image);
+	free(q->image);
+	/* q->pixels may alias q->image when their type representation is of the
+	   same size, so we need to be careful here to avoid a double free */
 	if (sizeof(*q->image) != sizeof(*q->pixels))
 		free(q->pixels);
-
+	free(q->row_average);
 	free(q);
 }
 
 int quirc_resize(struct quirc *q, int w, int h)
 {
-	uint8_t *new_image = realloc(q->image, w * h);
-
-	if (!new_image)
-		return -1;
-
+	uint8_t		*image  = NULL;
+	quirc_pixel_t	*pixels = NULL;
+	int		*row_average = NULL;
+
+	/*
+	 * XXX: w and h should be size_t (or at least unsigned) as negatives
+	 * values would not make much sense. The downside is that it would break
+	 * both the API and ABI. Thus, at the moment, let's just do a sanity
+	 * check.
+	 */
+	if (w < 0 || h < 0)
+		goto fail;
+
+	/*
+	 * alloc a new buffer for q->image. We avoid realloc(3) because we want
+	 * on failure to be leave `q` in a consistant, unmodified state.
+	 */
+	image = calloc(w, h);
+	if (!image)
+		goto fail;
+
+	/* compute the "old" (i.e. currently allocated) and the "new"
+	   (i.e. requested) image dimensions */
+	size_t olddim = q->w * q->h;
+	size_t newdim = w * h;
+	size_t min = (olddim < newdim ? olddim : newdim);
+
+	/*
+	 * copy the data into the new buffer, avoiding (a) to read beyond the
+	 * old buffer when the new size is greater and (b) to write beyond the
+	 * new buffer when the new size is smaller, hence the min computation.
+	 */
+	(void)memcpy(image, q->image, min);
+
+	/* alloc a new buffer for q->pixels if needed */
 	if (sizeof(*q->image) != sizeof(*q->pixels)) {
-		size_t new_size = w * h * sizeof(quirc_pixel_t);
-		quirc_pixel_t *new_pixels = realloc(q->pixels, new_size);
-		if (!new_pixels)
-			return -1;
-		q->pixels = new_pixels;
+		pixels = calloc(newdim, sizeof(quirc_pixel_t));
+		if (!pixels)
+			goto fail;
 	}
 
-	q->image = new_image;
+	/* alloc a new buffer for q->row_average */
+	row_average = calloc(w, sizeof(int));
+	if (!row_average)
+		goto fail;
+
+	/* alloc succeeded, update `q` with the new size and buffers */
 	q->w = w;
 	q->h = h;
+	free(q->image);
+	q->image = image;
+	if (sizeof(*q->image) != sizeof(*q->pixels)) {
+		free(q->pixels);
+		q->pixels = pixels;
+	}
+	free(q->row_average);
+	q->row_average = row_average;
 
 	return 0;
+	/* NOTREACHED */
+fail:
+	free(image);
+	free(pixels);
+	free(row_average);
+
+	return -1;
 }
 
 int quirc_count(const struct quirc *q)

data/ext/quirc/embed/lib/quirc.h

@@ -121,7 +121,7 @@ struct quirc_code {
 	 * is a bitmask giving the actual values of cells. If the cell
 	 * at (x, y) is black, then the following bit is set:
 	 *
-	 *     cell_bitmap[i << 3] & (1 << (i & 7))
+	 *     cell_bitmap[i >> 3] & (1 << (i & 7))
 	 *
 	 * where i = (y * size) + x.
 	 */

data/ext/quirc/embed/lib/quirc_internal.h

@@ -77,6 +77,7 @@ struct quirc_grid {
 struct quirc {
 	uint8_t			*image;
 	quirc_pixel_t		*pixels;
+	int			*row_average; /* used by threshold() */
 	int			w;
 	int			h;
 

data/ext/quirc/extconf.rb

@@ -9,7 +9,7 @@ BUILD_DIR = File.join(TMP_DIR, "quirc-1.0")
 LIB_FILE = File.join(BUILD_DIR, "libquirc.a")
 
 def build_library
-  Dir.mkdir(BUILD_DIR) unless File.exist?(BUILD_DIR)
+  FileUtils.makedirs(BUILD_DIR)
   system({ "BUILD_DIR" => BUILD_DIR }, "make", "-C", SRC_DIR) or raise "Error building quirc"
 end
 
@@ -17,4 +17,5 @@ find_header("quirc.h", "#{SRC_DIR}/lib") or missing("quirc.h")
 build_library
 $LOCAL_LIBS << LIB_FILE
 
+$CFLAGS << ' --std=c99'
 create_makefile("quirc/quirc")

data/lib/quirc.rb

@@ -2,6 +2,10 @@
 
 module Quirc
   def self.decode(image, width=nil, height=nil)
+    unless image.respond_to?(:to_grayscale_stream) || (width && height)
+      raise ArgumentError, "Arguments width and height are required if binary string is passed"
+    end
+
     width ||= image.public_send(:width)
     height ||= image.public_send(:height)
     if image.respond_to?(:to_grayscale_stream)

data/lib/quirc/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Quirc
-  VERSION = "0.0.1".freeze
+  VERSION = "0.1.3"
 end

data/test/fixtures/hello.gz

@@ -0,0 +1 @@
+x���A� D������f��Hb�?�~^p]�B!O�3���o����V����H�z�wv�|wV�=ǭ�S����MQ?�����p+s����������k���y�^n��fҽ�����/�M���4G��y�����G�57n�2�{C;z���jߕ��Nk���j]�q����\���9'̀{���ϻq�qg�3p{��yF[�}�n���y�&�s.!�B��|
u�7

data/test/helper.rb

@@ -1,15 +1,24 @@
 # frozen_string_literal: true
 
+require "zlib"
+
 require "minitest/autorun"
 require "oily_png"
+
 require "quirc"
 
 module TestHelpers
+  def binary_fixture(*path)
+    Zlib::Inflate.inflate(File.binread(File.join(__dir__, "fixtures", *path)))
+  end
+
   def image_fixture(*path)
     ChunkyPNG::Image.from_file(File.join(__dir__, "fixtures", *path))
   end
 end
 
-class Minitest::Spec
-  include TestHelpers
+module Minitest
+  class Spec
+    include TestHelpers
+  end
 end

data/test/test_decode.rb

@@ -3,6 +3,14 @@
 require "helper.rb"
 
 describe Quirc do
+  describe "binary string" do
+    it "should decode" do
+      result = Quirc.decode(binary_fixture("hello.gz"), 120, 120).first
+      assert_equal 1, result.ecc_level
+      assert_equal "Hello World!", result.payload
+    end
+  end
+
   describe "error levels" do
     it "should decode all error levels" do
       %i[m l h q].each_with_index do |level, no|
@@ -16,9 +24,24 @@ describe Quirc do
 
   describe "errors" do
     it "should throw error if image size is not equal to buffer" do
-      assert_raises ArgumentError, "Decoder is allocated for 1x2 images" do
+      e = assert_raises ArgumentError do
         Quirc::Decoder.new(1, 2).decode("abc")
       end
+      assert_equal "Decoder is allocated for 1x2 images", e.message
+    end
+
+    it "should throw error if width is not specified with binary string" do
+      e = assert_raises ArgumentError do
+        Quirc.decode("", nil, 1)
+      end
+      assert_equal "Arguments width and height are required if binary string is passed", e.message
+    end
+
+    it "should throw error if width height not specified with binary string" do
+      e = assert_raises ArgumentError, "Decoder is allocated for 1x2 images" do
+        Quirc.decode("", nil, 1)
+      end
+      assert_equal "Arguments width and height are required if binary string is passed", e.message
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: quirc
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Jacob Middag
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-14 00:00:00.000000000 Z
+date: 2020-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: rake-compiler
+  name: oily_png
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -39,33 +39,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.48'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.48'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: oily_png
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.71'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.71'
 description: Ruby bindings for C library quirc that extracts and decode QR images
 email: jacob@gaddim.nl
 executables: []
@@ -91,9 +91,10 @@ files:
 - test/fixtures/hello-120-utf8-l.png
 - test/fixtures/hello-120-utf8-m.png
 - test/fixtures/hello-120-utf8-q.png
+- test/fixtures/hello.gz
 - test/helper.rb
 - test/test_decode.rb
-homepage: https://github.com/middagj/quirc
+homepage: https://github.com/middagj/quirc-ruby
 licenses:
 - MIT
 metadata: {}
@@ -105,15 +106,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: QR decoder based on quirc
@@ -122,5 +122,6 @@ test_files:
 - test/fixtures/hello-120-utf8-l.png
 - test/fixtures/hello-120-utf8-m.png
 - test/fixtures/hello-120-utf8-q.png
+- test/fixtures/hello.gz
 - test/helper.rb
 - test/test_decode.rb