webp-ffi 0.3.1 → 1.0.0

data/sig/webp.rbs

@@ -0,0 +1,74 @@
+# Type signatures for the public API of the webp-ffi gem.
+module WebP
+  VERSION: String
+
+  # A file name: a String, a Pathname or anything with #to_path.
+  type path = String | _ToPath
+
+  # Image data: a String (or anything with #to_str) or an IO to read from.
+  type data = String | _ToStr | _ReadableData
+
+  interface _ReadableData
+    def read: () -> String?
+  end
+
+  # Options are a Hash with Symbol keys; see the README for the names.
+  type options = Hash[Symbol, untyped]
+
+  class Error < StandardError
+    attr_reader code: Integer?
+    attr_reader reason: Symbol?
+
+    def initialize: (?String? message, ?code: Integer?, ?reason: Symbol?) -> void
+  end
+
+  class InvalidImageFormatError < Error
+  end
+
+  class EncoderError < Error
+  end
+
+  class DecoderError < Error
+  end
+
+  class Info < Data
+    attr_reader width: Integer
+    attr_reader height: Integer
+    attr_reader format: :lossy | :lossless | :mixed
+    attr_reader alpha: bool
+    attr_reader animated: bool
+    attr_reader metadata: Array[:icc | :exif | :xmp]
+
+    def self.new: (width: Integer, height: Integer, format: :lossy | :lossless | :mixed, alpha: bool,
+                   animated: bool, metadata: Array[:icc | :exif | :xmp]) -> instance
+
+    def lossless?: () -> bool
+    def alpha?: () -> bool
+    def animated?: () -> bool
+  end
+
+  class RGBAImage < Data
+    attr_reader rgba: String
+    attr_reader width: Integer
+    attr_reader height: Integer
+
+    def self.new: (rgba: String, width: Integer, height: Integer) -> instance
+  end
+
+  def self.decoder_version: () -> String
+  def self.encoder_version: () -> String
+
+  def self.webp_size: (data data) -> [Integer, Integer]
+                    | (nil) -> nil
+  def self.info: (data data) -> Info
+               | (nil) -> nil
+
+  def self.encode: (path input_file, path output_file, ?options options) -> true
+  def self.decode: (path input_file, path output_file, ?options options) -> true
+
+  def self.encode_data: (data data, ?options options) -> String
+  def self.decode_data: (data data, ?options options) -> String
+
+  def self.encode_rgba: (String | _ToStr | _ReadableData pixels, Integer width, Integer height, ?options options) -> String
+  def self.decode_rgba: (data data, ?options options) -> RGBAImage
+end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: webp-ffi
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 1.0.0
 platform: ruby
 authors:
-- Alexey Vasyliev
-autorequire:
+- Oleksii Vasyliev
 bindir: bin
 cert_chain: []
-date: 2021-02-15 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -38,6 +37,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.1.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -53,33 +66,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rbs
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '0'
 description: Ruby wrapper for libwebp
 email:
 - leopard.not.a@gmail.com
@@ -88,17 +101,15 @@ extensions:
 - ext/webp_ffi/Rakefile
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".ruby-version"
-- ".travis.yml"
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - ext/webp_ffi/Rakefile
+- ext/webp_ffi/build_config.rb
 - ext/webp_ffi/jpegdec.c
 - ext/webp_ffi/jpegdec.h
+- ext/webp_ffi/metadata.c
+- ext/webp_ffi/metadata.h
 - ext/webp_ffi/pngdec.c
 - ext/webp_ffi/pngdec.h
 - ext/webp_ffi/tiffdec.c
@@ -110,30 +121,16 @@ files:
 - lib/webp-ffi.rb
 - lib/webp/c.rb
 - lib/webp/error.rb
-- lib/webp/libc.rb
+- lib/webp/info.rb
 - lib/webp/options.rb
 - lib/webp/version.rb
 - lib/webp/webp.rb
 - lib/webp_ffi.rb
-- spec/factories/1.png
-- spec/factories/1.webp
-- spec/factories/2.png
-- spec/factories/2.webp
-- spec/factories/3.jpg
-- spec/factories/3.webp
-- spec/factories/4.jpg
-- spec/factories/4.webp
-- spec/factories/5.tif
-- spec/factories/5.webp
-- spec/spec_helper.rb
-- spec/travis_build.sh
-- spec/webp_ffi_spec.rb
-- webp-ffi.gemspec
+- sig/webp.rbs
 homepage: http://leopard.in.ua/webp-ffi
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -141,28 +138,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key:
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Ruby wrapper for libwebp
-test_files:
-- spec/factories/1.png
-- spec/factories/1.webp
-- spec/factories/2.png
-- spec/factories/2.webp
-- spec/factories/3.jpg
-- spec/factories/3.webp
-- spec/factories/4.jpg
-- spec/factories/4.webp
-- spec/factories/5.tif
-- spec/factories/5.webp
-- spec/spec_helper.rb
-- spec/travis_build.sh
-- spec/webp_ffi_spec.rb
+test_files: []

data/.gitignore

@@ -1,22 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-.DS_Store
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-ext/webp_ffi/x86_64-darwin/
-ext/webp_ffi/x86_64-linux/
-.vagrant
-Vagrantfile

data/.ruby-version

@@ -1 +0,0 @@
-2.7.1

data/.travis.yml

@@ -1,38 +0,0 @@
-language: ruby
-
-before_install:
-  - ./spec/travis_build.sh > /dev/null 2>&1
-  - export LD_FLAGS=-L$HOME/opt/lib
-  - export LD_LIBRARY_PATH=/lib:/usr/lib:/usr/local/lib:$HOME/opt/lib
-  - export CPATH=$CPATH:$HOME/opt/include
-
-rvm:
-  - 2.5
-  - 2.6
-  - 2.7
-  - 3.0
-  - jruby-19mode
-  - rbx-19mode
-  - ruby-head
-  - jruby-head
-env:
-  - LIBWEBP_VERSION=0.4.4
-  - LIBWEBP_VERSION=1.0.2
-
-cache: bundler
-sudo: false
-dist: xenial
-
-notifications:
-  email: false
-
-branches:
-  only:
-    - master
-    - development
-
-matrix:
-  allow_failures:
-    - rvm: rbx-19mode
-    - rvm: ruby-head
-    - rvm: jruby-head

data/Gemfile

@@ -1,4 +0,0 @@
-source 'http://rubygems.org'
-
-# Specify your gem's dependencies in webp-ffi.gemspec
-gemspec

data/Rakefile

@@ -1,38 +0,0 @@
-require 'rubygems'
-require 'bundler/setup'
-require 'rake'
-require 'rake/clean'
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'ffi-compiler/compile_task'
-
-desc "compiler tasks"
-namespace "ffi-compiler" do
-  FFI::Compiler::CompileTask.new('ext/webp_ffi/webp_ffi') do |c|
-    c.have_header?('stdio.h', '/usr/local/include')
-    c.have_func?('puts')
-    c.have_library?('z')
-    c.have_header?('decode.h', '/usr/local/include')
-    c.have_header?('encode.h', '/usr/local/include')
-    c.have_func?('WebPDecoderConfig')
-    c.have_func?('WebPGetInfo')
-    c.have_library?('webp')
-    c.have_library?('png')
-    c.have_library?('jpeg')
-    c.have_library?('tiff')
-    c.ldflags << ENV['LD_FLAGS'] if ENV['LD_FLAGS']
-    c.cflags << ENV['C_FLAGS'] if ENV['C_FLAGS']
-  end
-end
-task :compile => ["ffi-compiler:default"]
-
-desc "run specs"
-task :spec do
-  RSpec::Core::RakeTask.new
-end
-
-task :default => [:clean, :compile, :spec]
-
-CLEAN.include('ext/**/*{.o,.log,.so,.bundle}')
-CLEAN.include('lib/**/*{.o,.log,.so,.bundle}')
-CLEAN.include('ext/**/Makefile')

data/lib/webp/libc.rb

@@ -1,20 +0,0 @@
-module WebP
-  module LibC
-    extend FFI::Library
-    # figures out the correct libc for each platform including Windows
-    library = ffi_lib(FFI::Library::LIBC).first
-
-    # Size_t not working properly on Windows
-    find_type(:size_t) rescue typedef(:ulong, :size_t)
-
-    # memory allocators
-    attach_function :malloc, [:size_t], :pointer
-    attach_function :free, [:pointer], :void
-  
-    # get a pointer to the free function
-    Free = library.find_symbol('free')
-
-    # memory movers
-    attach_function :memcpy, [:pointer, :pointer, :size_t], :pointer
-  end # module LibC
-end

data/spec/spec_helper.rb

@@ -1,9 +0,0 @@
-require 'rspec'
-
-require File.dirname(__FILE__) + "/../lib/webp_ffi"
-
-RSpec.configure do |config|
-  config.expect_with :rspec do |c|
-    c.syntax = :expect
-  end
-end

data/spec/travis_build.sh

@@ -1,6 +0,0 @@
-#/usr/bin/env sh
-wget http://downloads.webmproject.org/releases/webp/libwebp-$LIBWEBP_VERSION.tar.gz
-tar xvzf libwebp-$LIBWEBP_VERSION.tar.gz
-cd libwebp-$LIBWEBP_VERSION
-./configure --prefix=$HOME/opt
-make && make install

data/spec/webp_ffi_spec.rb

@@ -1,191 +0,0 @@
-require 'spec_helper'
-
-describe WebP do
-  factories = {
-    webp: ["1", "2", "3", "4", "5"],
-    png: ["1", "2"],
-    jpg: ["3", "4"],
-    tiff: ["5"],
-    info: {
-      "1" => {
-        size: [400, 301],
-        has_alpha: true
-      },
-      "2" => {
-        size: [386, 395],
-        has_alpha: true
-      },
-      "3" => {
-        size: [550, 368],
-        has_alpha: false
-      },
-      "4" => {
-        size: [1024, 772],
-        has_alpha: false
-      },
-      "5" => {
-        size: [1419, 1001],
-        has_alpha: false
-      }
-    }
-  }
-
-  before :all do
-    @out_dir = File.expand_path(File.join(File.dirname(__FILE__), "../tmp/"))
-    Dir.mkdir(@out_dir) unless File.exists?(@out_dir)
-  end
-  after :all do
-    @out_dir = File.expand_path(File.join(File.dirname(__FILE__), "../tmp/"))
-    Dir["#{@out_dir}/*{.png,.webp}"].each do |file|
-      File.delete(file) rescue nil
-    end
-  end
-
-  it "calculate plus 100 by test_c (verify C)" do
-    expect(WebP::C.test_c(100)).to eq(200)
-    expect(WebP::C.test_c(150)).to eq(250)
-  end
-
-  it "decoder version" do
-    expect(WebP.decoder_version).not_to be_nil
-    expect(WebP.decoder_version).to match(/^([0-9]+)\.([0-9]+)\.([0-9]+)$/)
-  end
-
-  it "encoder version" do
-    expect(WebP.encoder_version).not_to be_nil
-    expect(WebP.decoder_version).to match(/^([0-9]+)\.([0-9]+)\.([0-9]+)$/)
-  end
-
-  context "webp_size" do
-    factories[:webp].each do |image|
-      it "#{image} image size == #{factories[:info][image][:size]}" do
-        filename = File.expand_path(File.join(File.dirname(__FILE__), "factories/#{image}.webp"))
-        data = File.open(filename, "rb").read
-        info = WebP.webp_size(data)
-        expect(info.class).to eq(Array)
-        expect(info.size).to eq(2)
-        expect(info).to eq(factories[:info][image][:size])
-      end
-    end
-    it "raise InvalidImageFormatError for non-webp image" do
-      filename = File.expand_path(File.join(File.dirname(__FILE__), "factories/1.png"))
-      data = File.open(filename, "rb").read
-      expect { WebP.webp_size(data) }.to raise_error WebP::InvalidImageFormatError
-    end
-  end
-
-  context "encode" do
-    factories[:png].each do |image|
-      it "#{image}.png image" do
-        in_filename = File.expand_path(File.join(File.dirname(__FILE__), "factories/#{image}.png"))
-        out_filename = File.expand_path(File.join(@out_dir, "#{image}.png.webp"))
-        expect(WebP.encode(in_filename, out_filename)).to be_truthy
-      end
-
-      it "#{image}.png image with near_lossless" do
-        in_filename = File.expand_path(File.join(File.dirname(__FILE__), "factories/#{image}.png"))
-        out_filename = File.expand_path(File.join(@out_dir, "#{image}_near_lossless.png.webp"))
-        expect(WebP.encode(in_filename, out_filename, near_lossless: 60)).to be_truthy
-      end
-    end
-    factories[:jpg].each do |image|
-      it "#{image}.jpg image" do
-        in_filename = File.expand_path(File.join(File.dirname(__FILE__), "factories/#{image}.jpg"))
-        out_filename = File.expand_path(File.join(@out_dir, "#{image}.jpg.webp"))
-        expect(WebP.encode(in_filename, out_filename)).to be_truthy
-      end
-
-      it "#{image}.jpg image with near_lossless" do
-        in_filename = File.expand_path(File.join(File.dirname(__FILE__), "factories/#{image}.jpg"))
-        out_filename = File.expand_path(File.join(@out_dir, "#{image}_near_lossless.jpg.webp"))
-        expect(WebP.encode(in_filename, out_filename, near_lossless: 60)).to be_truthy
-      end
-    end
-    factories[:tiff].each do |image|
-      it "#{image}.tif image" do
-        in_filename = File.expand_path(File.join(File.dirname(__FILE__), "factories/#{image}.tif"))
-        out_filename = File.expand_path(File.join(@out_dir, "#{image}.tif.webp"))
-        expect(WebP.encode(in_filename, out_filename)).to be_truthy
-      end
-    end
-    factories[:webp].each do |image|
-      it "raise EncoderError on #{image}.webp image" do
-        in_filename = File.expand_path(File.join(File.dirname(__FILE__), "factories/#{image}.webp"))
-        out_filename = File.expand_path(File.join(@out_dir, "#{image}invalid.webp.png"))
-        expect { WebP.encode(in_filename, out_filename) }.to raise_error WebP::EncoderError
-      end
-    end
-    context "with options" do
-      factories[:png].each do |image|
-        it "#{image}.png image" do
-          in_filename = File.expand_path(File.join(File.dirname(__FILE__), "factories/#{image}.png"))
-          out_filename = File.expand_path(File.join(@out_dir, "#{image}.50png.webp"))
-          WebP.encode(in_filename, out_filename, quality: 50, method: 0, alpha_quality: 10, alpha_compression: 1)
-        end
-      end
-    end
-    context "raise EncoderError on invalid crop options" do
-      factories[:png].each do |image|
-        it "#{image}.png image" do
-          in_filename = File.expand_path(File.join(File.dirname(__FILE__), "factories/#{image}.png"))
-          out_filename = File.expand_path(File.join(@out_dir, "#{image}.invpng.webp"))
-          expect { WebP.encode(in_filename, out_filename, crop_w: 30000) }.to raise_error WebP::EncoderError, /crop/i
-        end
-      end
-    end
-  end
-
-  context "decode" do
-    factories[:webp].each do |image|
-      it "#{image}.webp image" do
-        in_filename = File.expand_path(File.join(File.dirname(__FILE__), "factories/#{image}.webp"))
-        out_filename = File.expand_path(File.join(@out_dir, "#{image}.webp.png"))
-        expect(WebP.decode(in_filename, out_filename)).to be_truthy
-      end
-    end
-    context "with output_format" do
-      [:png, :pam, :ppm, :pgm, :bmp, :tiff, :yuv, :alpha_plane_only].each do |output_format|
-        factories[:webp].take(2).each do |image|
-          it "#{image}.webp image to #{output_format}" do
-            in_filename = File.expand_path(File.join(File.dirname(__FILE__), "factories/#{image}.webp"))
-            out_filename = File.expand_path(File.join(@out_dir, "#{image}.#{output_format}.png"))
-            expect(WebP.decode(in_filename, out_filename, output_format: output_format)).to be_truthy
-          end
-        end
-      end
-    end
-    context "with options" do
-      factories[:webp].take(2).each do |image|
-        it "#{image}.webp image to png and crop" do
-          in_filename = File.expand_path(File.join(File.dirname(__FILE__), "factories/#{image}.webp"))
-          out_filename = File.expand_path(File.join(@out_dir, "#{image}_crop.png"))
-          expect(WebP.decode(in_filename, out_filename, crop_w: 200, crop_h: 200)).to be_truthy
-        end
-        it "#{image}.webp image to png and scale" do
-          in_filename = File.expand_path(File.join(File.dirname(__FILE__), "factories/#{image}.webp"))
-          out_filename = File.expand_path(File.join(@out_dir, "#{image}_resize.png"))
-          expect(WebP.decode(in_filename, out_filename, resize_w: 200, resize_h: 200)).to be_truthy
-        end
-      end
-    end
-    context "raise DecoderError on invalid webp image" do
-      factories[:png].each do |image|
-        it "#{image}.png image" do
-          in_filename = File.expand_path(File.join(File.dirname(__FILE__), "factories/#{image}.png"))
-          out_filename = File.expand_path(File.join(@out_dir, "#{image}.invpng.webp"))
-          expect { WebP.decode(in_filename, out_filename) }.to raise_error WebP::DecoderError, /invalid webp/i
-        end
-      end
-    end
-    context "raise DecoderError on invalid options" do
-      factories[:png].each do |image|
-        it "#{image}.png image" do
-          in_filename = File.expand_path(File.join(File.dirname(__FILE__), "factories/#{image}.webp"))
-          out_filename = File.expand_path(File.join(@out_dir, "#{image}.png"))
-          expect { WebP.decode(in_filename, out_filename, crop_w: 30000) }.to raise_error WebP::DecoderError, /decoding failed/i
-        end
-      end
-    end
-  end
-
-end

data/webp-ffi.gemspec

@@ -1,28 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'webp/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "webp-ffi"
-  spec.version       = WebP::VERSION
-  spec.authors       = ["Alexey Vasyliev"]
-  spec.email         = ["leopard.not.a@gmail.com"]
-  spec.description   = %q{Ruby wrapper for libwebp}
-  spec.summary       = %q{Ruby wrapper for libwebp}
-  spec.homepage      = "http://leopard.in.ua/webp-ffi"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-  spec.extensions    << 'ext/webp_ffi/Rakefile'
-
-  spec.add_runtime_dependency "ffi", ">= 1.9.0"
-  spec.add_runtime_dependency "ffi-compiler", ">= 0.1.2"
-
-  spec.add_development_dependency "bundler", ">= 1.2"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", ">= 3"
-end