ruby-brs 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7c98f5678a0545688d9a0bb7537d2eb55507559c2f6d61855796983e4b8a763
-  data.tar.gz: 19bbed82c75ecf25c17a7848b97890dfad5387a3d9244b16db2447bb21425c1b
+  metadata.gz: 519776eef000f690d628b64310be61daf3e8cc144a103fa848586f1165e92de9
+  data.tar.gz: 8a0f7b24666a6291b10700a6ddf4dfd8afe90e2286750ca02531126348f0a198
 SHA512:
-  metadata.gz: c7a82e47ac99a515794cc5e56153d10993b5b87fdb9f091dd04a685689dadcee2aec961b2cefbd1fd9531c457cd45af5d0d05af87178642b5bb545fa2f9f9246
-  data.tar.gz: 481e233bfd17fe958a384787b2dd0f469b9017d7005cb9c1b88bdf48cad578767c5003e52b53ce6fcda35635a57339115a6cd21f0768281626df99995ee308ee
+  metadata.gz: c1a644ae3619da601177e0985926acffb6a43910c9686dfdb97b33f191814699f0cb6c9e38a5ecedb5f33999ac9cf129d0864bfcb2d065981faf1da61f5ef9c5
+  data.tar.gz: f7cf208285d14a9c2ef5b868dee4c1bf2dbe1262479cc250b6ce48d4c462007da431e8c5322097c8bf71cdef009140625ed8439d0c2a878825a4b502599a2086

data/README.md

@@ -118,6 +118,8 @@ end
 | `quality`                          | 0 - 11     | 11         | compression level |
 | `lgwin`                            | 10 - 24    | 22         | compressor window size |
 | `lgblock`                          | 16 - 24    | nil (auto) | compressor input block size |
+| `npostfix`                         | 0 - 3      | nil (auto) | Recommended number of postfix bits |
+| `ndirect`                          | 0 - 120    | nil (auto) | Recommended number of direct distance codes (step 1 << npostfix, max 15 << npostfix) |
 | `disable_literal_context_modeling` | true/false | false      | disables literal context modeling format |
 | `disable_ring_buffer_reallocation` | true/false | false      | disables ring buffer reallocation |
 | `size_hint`                        | 0 - inf    | 0 (auto)   | size of input (if known) |
@@ -135,12 +137,14 @@ If `gvl` is enabled ruby won't waste time on acquiring/releasing VM lock.
 
 You can also read brotli docs for more info about options.
 
-| Option    | Related constants |
-|-----------|-------------------|
-| `mode`    | `BRS::Option::MODES` = `%i[text font generic]` |
-| `quality` | `BRS::Option::MIN_QUALITY` = 0, `BRS::Option::MAX_QUALITY` = 11 |
-| `lgwin`   | `BRS::Option::MIN_LGWIN` = 10, `BRS::Option::MAX_LGWIN` = 24 |
-| `lgblock` | `BRS::Option::MIN_LGBLOCK` = 16, `BRS::Option::MAX_LGBLOCK` = 24 |
+| Option     | Related constants |
+|------------|-------------------|
+| `mode`     | `BRS::Option::MODES` = `%i[text font generic]` |
+| `quality`  | `BRS::Option::MIN_QUALITY` = 0, `BRS::Option::MAX_QUALITY` = 11 |
+| `lgwin`    | `BRS::Option::MIN_LGWIN` = 10, `BRS::Option::MAX_LGWIN` = 24 |
+| `lgblock`  | `BRS::Option::MIN_LGBLOCK` = 16, `BRS::Option::MAX_LGBLOCK` = 24 |
+| `npostfix` | `BRS::Option::MIN_NPOSTFIX` = 0, `BRS::Option::MAX_NPOSTFIX` = 3 |
+| `ndirect`  | `BRS::Option::MIN_NDIRECT` = 0, `BRS::Option::MAX_NDIRECT` = 120, `BRS::Option::NDIRECT_NPOSTFIX_STEP_BASE` = 1, `BRS::Option::NDIRECT_NPOSTFIX_MAX_BASE` = 15 |
 
 Possible compressor options:
 ```
@@ -151,6 +155,8 @@ Possible compressor options:
 :quality
 :lgwin
 :lgblock
+:npostfix
+:ndirect
 :disable_literal_context_modeling
 :size_hint
 :large_window

data/ext/brs_ext/buffer.c

@@ -3,8 +3,6 @@
 
 #include "brs_ext/buffer.h"
 
-#include "ruby.h"
-
 VALUE brs_ext_create_string_buffer(VALUE length)
 {
   return rb_str_new(NULL, NUM2SIZET(length));

data/ext/brs_ext/error.c

@@ -3,10 +3,6 @@
 
 #include "brs_ext/error.h"
 
-#include <brotli/decode.h>
-
-#include "ruby.h"
-
 brs_ext_result_t brs_ext_get_decompressor_error(BrotliDecoderErrorCode error_code)
 {
   switch (error_code) {

data/ext/brs_ext/io.c

@@ -15,7 +15,6 @@
 #include "brs_ext/gvl.h"
 #include "brs_ext/macro.h"
 #include "brs_ext/option.h"
-#include "ruby.h"
 #include "ruby/io.h"
 
 // Additional possible results:

data/ext/brs_ext/main.c

@@ -7,7 +7,6 @@
 #include "brs_ext/stream/compressor.h"
 #include "brs_ext/stream/decompressor.h"
 #include "brs_ext/string.h"
-#include "ruby.h"
 
 void Init_brs_ext()
 {
@@ -19,4 +18,8 @@ void Init_brs_ext()
   brs_ext_compressor_exports(root_module);
   brs_ext_decompressor_exports(root_module);
   brs_ext_string_exports(root_module);
+
+  VALUE version_arguments[] = {INT2FIX(16)};
+  VALUE version = rb_block_call(UINT2NUM(BrotliEncoderVersion()), rb_intern("to_s"), 1, version_arguments, 0, 0);
+  rb_define_const(root_module, "LIBRARY_VERSION", rb_obj_freeze(version));
 }

data/ext/brs_ext/option.c

@@ -3,11 +3,7 @@
 
 #include "brs_ext/option.h"
 
-#include <brotli/decode.h>
-#include <brotli/encode.h>
-
 #include "brs_ext/error.h"
-#include "ruby.h"
 
 // -- values --
 
@@ -114,6 +110,8 @@ brs_ext_result_t brs_ext_set_compressor_options(BrotliEncoderState* state_ptr, b
   SET_ENCODER_PARAM(state_ptr, BROTLI_PARAM_QUALITY, options->quality);
   SET_ENCODER_PARAM(state_ptr, BROTLI_PARAM_LGWIN, options->lgwin);
   SET_ENCODER_PARAM(state_ptr, BROTLI_PARAM_LGBLOCK, options->lgblock);
+  SET_ENCODER_PARAM(state_ptr, BROTLI_PARAM_NPOSTFIX, options->npostfix);
+  SET_ENCODER_PARAM(state_ptr, BROTLI_PARAM_NDIRECT, options->ndirect);
   SET_ENCODER_PARAM(
     state_ptr, BROTLI_PARAM_DISABLE_LITERAL_CONTEXT_MODELING, options->disable_literal_context_modeling);
   SET_ENCODER_PARAM(state_ptr, BROTLI_PARAM_SIZE_HINT, options->size_hint);
@@ -138,6 +136,14 @@ brs_ext_result_t brs_ext_set_decompressor_options(
 
 // -- exports --
 
+#define BROTLI_MIN_NPOSTFIX 0
+#define BROTLI_MAX_NPOSTFIX 3
+
+#define BROTLI_MIN_NDIRECT                0
+#define BROTLI_NDIRECT_NPOSTFIX_STEP_BASE 1
+#define BROTLI_NDIRECT_NPOSTFIX_MAX_BASE  0xf
+#define BROTLI_MAX_NDIRECT                (BROTLI_NDIRECT_NPOSTFIX_MAX_BASE << BROTLI_MAX_NPOSTFIX)
+
 #define EXPORT_PARAM_BOUNDS(module, param, name)                      \
   rb_define_const(module, "MIN_" name, UINT2NUM(BROTLI_MIN_##param)); \
   rb_define_const(module, "MAX_" name, UINT2NUM(BROTLI_MAX_##param));
@@ -151,7 +157,12 @@ void brs_ext_option_exports(VALUE root_module)
   rb_define_const(module, "MODES", modes);
   RB_GC_GUARD(modes);
 
-  EXPORT_PARAM_BOUNDS(module, QUALITY, "QUALITY");
-  EXPORT_PARAM_BOUNDS(module, WINDOW_BITS, "LGWIN");
   EXPORT_PARAM_BOUNDS(module, INPUT_BLOCK_BITS, "LGBLOCK");
+  EXPORT_PARAM_BOUNDS(module, WINDOW_BITS, "LGWIN");
+  EXPORT_PARAM_BOUNDS(module, QUALITY, "QUALITY");
+  EXPORT_PARAM_BOUNDS(module, NPOSTFIX, "NPOSTFIX");
+  EXPORT_PARAM_BOUNDS(module, NDIRECT, "NDIRECT");
+
+  rb_define_const(module, "NDIRECT_NPOSTFIX_STEP_BASE", UINT2NUM(BROTLI_NDIRECT_NPOSTFIX_STEP_BASE));
+  rb_define_const(module, "NDIRECT_NPOSTFIX_MAX_BASE", UINT2NUM(BROTLI_NDIRECT_NPOSTFIX_MAX_BASE));
 }

data/ext/brs_ext/option.h

@@ -37,6 +37,8 @@ typedef struct
   brs_ext_option_t quality;
   brs_ext_option_t lgwin;
   brs_ext_option_t lgblock;
+  brs_ext_option_t npostfix;
+  brs_ext_option_t ndirect;
   brs_ext_option_t disable_literal_context_modeling;
   brs_ext_option_t size_hint;
   brs_ext_option_t large_window;
@@ -60,6 +62,8 @@ void brs_ext_resolve_option(VALUE options, brs_ext_option_t* option, brs_ext_opt
   BRS_EXT_RESOLVE_OPTION(options, compressor_options, BRS_EXT_OPTION_TYPE_UINT, quality);                          \
   BRS_EXT_RESOLVE_OPTION(options, compressor_options, BRS_EXT_OPTION_TYPE_UINT, lgwin);                            \
   BRS_EXT_RESOLVE_OPTION(options, compressor_options, BRS_EXT_OPTION_TYPE_UINT, lgblock);                          \
+  BRS_EXT_RESOLVE_OPTION(options, compressor_options, BRS_EXT_OPTION_TYPE_UINT, npostfix);                         \
+  BRS_EXT_RESOLVE_OPTION(options, compressor_options, BRS_EXT_OPTION_TYPE_UINT, ndirect);                          \
   BRS_EXT_RESOLVE_OPTION(options, compressor_options, BRS_EXT_OPTION_TYPE_BOOL, disable_literal_context_modeling); \
   BRS_EXT_RESOLVE_OPTION(options, compressor_options, BRS_EXT_OPTION_TYPE_UINT, size_hint);                        \
   BRS_EXT_RESOLVE_OPTION(options, compressor_options, BRS_EXT_OPTION_TYPE_BOOL, large_window);

data/ext/brs_ext/stream/compressor.c

@@ -3,14 +3,12 @@
 
 #include "brs_ext/stream/compressor.h"
 
-#include <brotli/encode.h>
 #include <brotli/types.h>
 
 #include "brs_ext/buffer.h"
 #include "brs_ext/error.h"
 #include "brs_ext/gvl.h"
 #include "brs_ext/option.h"
-#include "ruby.h"
 
 // -- initialization --
 

data/ext/brs_ext/stream/decompressor.c

@@ -3,13 +3,10 @@
 
 #include "brs_ext/stream/decompressor.h"
 
-#include <brotli/decode.h>
-
 #include "brs_ext/buffer.h"
 #include "brs_ext/error.h"
 #include "brs_ext/gvl.h"
 #include "brs_ext/option.h"
-#include "ruby.h"
 
 // -- initialization --
 

data/ext/brs_ext/string.c

@@ -13,7 +13,6 @@
 #include "brs_ext/gvl.h"
 #include "brs_ext/macro.h"
 #include "brs_ext/option.h"
-#include "ruby.h"
 
 // -- buffer --
 

data/ext/extconf.rb

@@ -5,17 +5,93 @@ require "mkmf"
 
 have_func "rb_thread_call_without_gvl", "ruby/thread.h"
 
-def require_header(name, types = [])
+def require_header(name, constants: [], macroses: [], types: [])
   abort "Can't find #{name} header" unless find_header name
 
+  constants.each do |constant|
+    abort "Can't find #{constant} constant in #{name} header" unless have_const constant, name
+  end
+
+  macroses.each do |macro|
+    abort "Can't find #{macro} macro in #{name} header" unless have_macro macro, name
+  end
+
   types.each do |type|
     abort "Can't find #{type} type in #{name} header" unless find_type type, nil, name
   end
 end
 
-require_header "brotli/types.h", %w[BROTLI_BOOL]
-require_header "brotli/encode.h", ["BrotliEncoderState *", "BrotliEncoderMode"]
-require_header "brotli/decode.h", ["BrotliDecoderState *", "BrotliDecoderResult", "BrotliDecoderErrorCode"]
+require_header(
+  "brotli/decode.h",
+  :constants => %w[
+    BROTLI_DECODER_ERROR_ALLOC_BLOCK_TYPE_TREES
+    BROTLI_DECODER_ERROR_ALLOC_CONTEXT_MAP
+    BROTLI_DECODER_ERROR_ALLOC_CONTEXT_MODES
+    BROTLI_DECODER_ERROR_ALLOC_RING_BUFFER_1
+    BROTLI_DECODER_ERROR_ALLOC_RING_BUFFER_2
+    BROTLI_DECODER_ERROR_ALLOC_TREE_GROUPS
+    BROTLI_DECODER_ERROR_FORMAT_BLOCK_LENGTH_1
+    BROTLI_DECODER_ERROR_FORMAT_BLOCK_LENGTH_2
+    BROTLI_DECODER_ERROR_FORMAT_CL_SPACE
+    BROTLI_DECODER_ERROR_FORMAT_CONTEXT_MAP_REPEAT
+    BROTLI_DECODER_ERROR_FORMAT_DICTIONARY
+    BROTLI_DECODER_ERROR_FORMAT_DISTANCE
+    BROTLI_DECODER_ERROR_FORMAT_EXUBERANT_META_NIBBLE
+    BROTLI_DECODER_ERROR_FORMAT_EXUBERANT_NIBBLE
+    BROTLI_DECODER_ERROR_FORMAT_HUFFMAN_SPACE
+    BROTLI_DECODER_ERROR_FORMAT_PADDING_1
+    BROTLI_DECODER_ERROR_FORMAT_PADDING_2
+    BROTLI_DECODER_ERROR_FORMAT_RESERVED
+    BROTLI_DECODER_ERROR_FORMAT_SIMPLE_HUFFMAN_ALPHABET
+    BROTLI_DECODER_ERROR_FORMAT_SIMPLE_HUFFMAN_SAME
+    BROTLI_DECODER_ERROR_FORMAT_TRANSFORM
+    BROTLI_DECODER_ERROR_FORMAT_WINDOW_BITS
+    BROTLI_DECODER_PARAM_DISABLE_RING_BUFFER_REALLOCATION
+    BROTLI_DECODER_PARAM_LARGE_WINDOW
+    BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT
+    BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT
+    BROTLI_DECODER_RESULT_SUCCESS
+  ],
+  :types     => [
+    "BrotliDecoderErrorCode",
+    "BrotliDecoderResult",
+    "BrotliDecoderState *"
+  ]
+)
+require_header(
+  "brotli/encode.h",
+  :constants => %w[
+    BROTLI_MAX_INPUT_BLOCK_BITS
+    BROTLI_MAX_QUALITY
+    BROTLI_MAX_WINDOW_BITS
+    BROTLI_MIN_INPUT_BLOCK_BITS
+    BROTLI_MIN_QUALITY
+    BROTLI_MIN_WINDOW_BITS
+    BROTLI_MODE_FONT
+    BROTLI_MODE_GENERIC
+    BROTLI_MODE_TEXT
+    BROTLI_OPERATION_FINISH
+    BROTLI_OPERATION_FLUSH
+    BROTLI_OPERATION_PROCESS
+    BROTLI_PARAM_DISABLE_LITERAL_CONTEXT_MODELING
+    BROTLI_PARAM_LARGE_WINDOW
+    BROTLI_PARAM_LGBLOCK
+    BROTLI_PARAM_LGWIN
+    BROTLI_PARAM_NDIRECT
+    BROTLI_PARAM_NPOSTFIX
+    BROTLI_PARAM_MODE
+    BROTLI_PARAM_QUALITY
+    BROTLI_PARAM_SIZE_HINT
+  ],
+  :types     => [
+    "BrotliEncoderMode",
+    "BrotliEncoderState *"
+  ]
+)
+require_header(
+  "brotli/types.h",
+  :macroses => %w[BROTLI_BOOL]
+)
 
 def require_library(name, functions)
   functions.each do |function|
@@ -26,12 +102,13 @@ end
 require_library(
   "brotlienc",
   %w[
-    BrotliEncoderCreateInstance
-    BrotliEncoderSetParameter
     BrotliEncoderCompressStream
+    BrotliEncoderCreateInstance
+    BrotliEncoderDestroyInstance
     BrotliEncoderHasMoreOutput
     BrotliEncoderIsFinished
-    BrotliEncoderDestroyInstance
+    BrotliEncoderSetParameter
+    BrotliEncoderVersion
   ]
 )
 
@@ -39,10 +116,11 @@ require_library(
   "brotlidec",
   %w[
     BrotliDecoderCreateInstance
-    BrotliDecoderSetParameter
     BrotliDecoderDecompressStream
-    BrotliDecoderGetErrorCode
     BrotliDecoderDestroyInstance
+    BrotliDecoderGetErrorCode
+    BrotliDecoderSetParameter
+    BrotliDecoderVersion
   ]
 )
 

data/lib/brs/option.rb

@@ -16,6 +16,8 @@ module BRS
       :quality                          => nil,
       :lgwin                            => nil,
       :lgblock                          => nil,
+      :npostfix                         => nil,
+      :ndirect                          => nil,
       :disable_literal_context_modeling => nil,
       :large_window                     => nil
     }
@@ -65,6 +67,24 @@ module BRS
         raise ValidateError, "invalid lgblock" if lgblock < MIN_LGBLOCK || lgblock > MAX_LGBLOCK
       end
 
+      npostfix = options[:npostfix]
+      unless npostfix.nil?
+        Validation.validate_not_negative_integer npostfix
+        raise ValidateError, "invalid npostfix" if npostfix < MIN_NPOSTFIX || npostfix > MAX_NPOSTFIX
+      end
+
+      ndirect = options[:ndirect]
+      unless ndirect.nil?
+        Validation.validate_not_negative_integer ndirect
+        raise ValidateError, "invalid ndirect" if ndirect < MIN_NDIRECT || ndirect > MAX_NDIRECT
+
+        raise ValidateError, "invalid ndirect" if
+          !npostfix.nil? && (
+            (ndirect - MIN_NDIRECT) % (NDIRECT_NPOSTFIX_STEP_BASE << npostfix) != 0 ||
+            (ndirect - MIN_NDIRECT) > (NDIRECT_NPOSTFIX_MAX_BASE << npostfix)
+          )
+      end
+
       disable_literal_context_modeling = options[:disable_literal_context_modeling]
       Validation.validate_bool disable_literal_context_modeling unless disable_literal_context_modeling.nil?
 

data/lib/brs/version.rb

@@ -2,5 +2,5 @@
 # Copyright (c) 2019 AUTHORS, MIT License.
 
 module BRS
-  VERSION = "1.2.1".freeze
+  VERSION = "1.3.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-brs
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Andrew Aladjev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-04 00:00:00.000000000 Z
+date: 2021-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codecov
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: parallel
   requirement: !ruby/object:Gem::Requirement
@@ -128,28 +128,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '1.22'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '1.22'
 - !ruby/object:Gem::Dependency
   name: rubocop-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.15'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -170,14 +170,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -257,7 +257,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Ruby bindings for brotli library.