zxing_ffi 0.1.0

data/lib/zxing_ffi.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require_relative "zxing_ffi/version"
+require_relative "zxing_ffi/errors"
+require_relative "zxing_ffi/config"
+
+# Read barcodes from images and PDFs with zxing-cpp, bound through its C API with the ffi gem.
+#
+# @example
+#   ZXingFFI.scan("invoice.pdf") # => [#<data ZXingFFI::Barcode ...>, ...]
+module ZXingFFI
+  autoload :LibraryLoader, "zxing_ffi/library_loader"
+  autoload :Native, "zxing_ffi/native"
+  autoload :Formats, "zxing_ffi/formats"
+  autoload :Image, "zxing_ffi/image"
+  autoload :Reader, "zxing_ffi/reader"
+  autoload :LIBRARY_DEFAULTS, "zxing_ffi/library_defaults"
+  autoload :Barcode, "zxing_ffi/barcode"
+  autoload :Geometry, "zxing_ffi/geometry"
+  autoload :Point, "zxing_ffi/geometry"
+  autoload :Quad, "zxing_ffi/geometry"
+  autoload :Dedupe, "zxing_ffi/dedupe"
+  autoload :Pnm, "zxing_ffi/pnm"
+  autoload :Sniffer, "zxing_ffi/sniffer"
+  autoload :HeaderProbe, "zxing_ffi/header_probe"
+  autoload :Subprocess, "zxing_ffi/subprocess"
+  autoload :ImageMagick, "zxing_ffi/image_magick"
+  autoload :Dpi, "zxing_ffi/dpi"
+  autoload :Source, "zxing_ffi/source"
+  autoload :Loaders, "zxing_ffi/loaders"
+  autoload :Transformers, "zxing_ffi/transformers"
+  autoload :Strategy, "zxing_ffi/strategy"
+  autoload :Scanner, "zxing_ffi/scanner"
+  autoload :PageResult, "zxing_ffi/scanner"
+  autoload :Diagnostics, "zxing_ffi/diagnostics"
+  autoload :CLI, "zxing_ffi/cli"
+
+  class << self
+    # Scans every page or frame of +input+ and returns all barcodes.
+    #
+    # @param input [String, Pathname, IO, Image] a path, an IO, or a raw image
+    # @return [Array<Barcode>] ordered by page, then top-to-bottom, left-to-right
+    def scan(input, **options)
+      Scanner.new(**options).scan(input)
+    end
+
+    # Streams per-page results. Returns an Enumerator without a block.
+    #
+    # @yieldparam page_result [PageResult]
+    def scan_pages(input, **options, &block)
+      return enum_for(:scan_pages, input, **options) unless block
+
+      Scanner.new(**options).scan_pages(input, &block)
+    end
+
+    # Decodes a raw pixel buffer with a single pass and no pipeline.
+    #
+    # @param image [Image]
+    # @return [Array<Barcode>]
+    def read(image, **options)
+      Reader.read(image, options)
+    end
+
+    # All readable barcode formats as symbols, derived from the loaded library.
+    # @return [Array<Symbol>]
+    def formats
+      Formats.readable
+    end
+
+    # Linear (1D) readable formats, used by the rotated pass.
+    # @return [Array<Symbol>]
+    def linear_formats
+      Formats.linear
+    end
+
+    # A Hash describing the environment: library, loaders, tools and defaults.
+    # @return [Hash]
+    def diagnostics
+      Diagnostics.collect
+    end
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: zxing_ffi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Will Hibbard
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: |
+  Extracts barcodes (QR and every symbology zxing-cpp can read) from PNG, JPEG, TIFF, GIF, BMP,
+  WebP, HEIF, PNM and PDF inputs in any orientation. Binds the zxing-cpp C API with the ffi gem and
+  adds a pipeline around it: input sniffing, normalization to 8-bit grayscale, an escalating
+  sequence of decode passes, coordinate mapping, deduplication and filtering.
+email:
+- eng@niva.co
+executables:
+- zxing-scan
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- exe/zxing-scan
+- lib/zxing_ffi.rb
+- lib/zxing_ffi/barcode.rb
+- lib/zxing_ffi/cli.rb
+- lib/zxing_ffi/config.rb
+- lib/zxing_ffi/dedupe.rb
+- lib/zxing_ffi/diagnostics.rb
+- lib/zxing_ffi/dpi.rb
+- lib/zxing_ffi/errors.rb
+- lib/zxing_ffi/formats.rb
+- lib/zxing_ffi/geometry.rb
+- lib/zxing_ffi/header_probe.rb
+- lib/zxing_ffi/image.rb
+- lib/zxing_ffi/image_magick.rb
+- lib/zxing_ffi/library_defaults.rb
+- lib/zxing_ffi/library_loader.rb
+- lib/zxing_ffi/loaders.rb
+- lib/zxing_ffi/loaders/base.rb
+- lib/zxing_ffi/loaders/image_magick.rb
+- lib/zxing_ffi/loaders/pnm.rb
+- lib/zxing_ffi/loaders/poppler.rb
+- lib/zxing_ffi/loaders/registry.rb
+- lib/zxing_ffi/loaders/vips.rb
+- lib/zxing_ffi/native.rb
+- lib/zxing_ffi/pnm.rb
+- lib/zxing_ffi/reader.rb
+- lib/zxing_ffi/scanner.rb
+- lib/zxing_ffi/sniffer.rb
+- lib/zxing_ffi/source.rb
+- lib/zxing_ffi/strategy.rb
+- lib/zxing_ffi/subprocess.rb
+- lib/zxing_ffi/transformers.rb
+- lib/zxing_ffi/transformers/base.rb
+- lib/zxing_ffi/transformers/image_magick.rb
+- lib/zxing_ffi/transformers/vips.rb
+- lib/zxing_ffi/version.rb
+homepage: https://github.com/withniva/zxing_ffi
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/withniva/zxing_ffi
+  changelog_uri: https://github.com/withniva/zxing_ffi/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Read QR codes and other barcodes from images and PDFs with zxing-cpp (via
+  FFI).
+test_files: []