rmagick 7.1.7 → 7.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66dc89800cb00f2289dabc151894c15c87bfb01d231e59a65e416ea340891806
-  data.tar.gz: a77148f0f14029e5eaab407e4c7a92b2f001c3d1b7d2a3bccaed2895f76a73a8
+  metadata.gz: 765ab71db74f8e2497d857f4041b604abbf848bdcc49d91ae9eb83c13c8dc130
+  data.tar.gz: 1466fca25cf24eb504a197f5db46f1a2ae36e5750d4bc82b2e08836efc6fc3b1
 SHA512:
-  metadata.gz: d39124bed163f3af7ac90f2a40476735e653a957307e9c4bb88c96f13899c6644d7af005c7a7546028bec6652c0cc0f5af2f18c3fcbc0148d660c16fa3543cbd
-  data.tar.gz: eb6b1420cf8b1d112931dc4467163817eac4ca3f87ca4e52b7b7d0e4eef322ab062554eb9e71545553ea2352a512d208e68512a0994b98ce6da3edbad09ec589
+  metadata.gz: e5f6bc440331557b902c94cf9665f572bb50f48242f1760c5cec131d9b86af2d6a92592d43077429ad90cd11171000be3e8c9ba9fb848ed11be515a431e1ee3b
+  data.tar.gz: e8cc721b925f6ff4217870ad1234b7e2eb59573a3e951056bf494d50c9855230e80f4564270e0aea067782adacdb3d202b91cbafd8318fff711919c4138751b8

data/CHANGELOG.md

@@ -3,6 +3,46 @@
 All notable changes to this project are documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## RMagick 7.2.0
+
+> [!IMPORTANT]
+> Heavy calls can run on a Fiber scheduler's worker pool, `Image#fx` rejects an expression that names a file, and some results change with ImageMagick 7.
+>
+> On Ruby 4.0 and later, a Fiber scheduler with a worker pool, such as `Async::Scheduler.new(worker_pool: IO::Event::WorkerPool.new)`, now runs heavy ImageMagick calls on its workers, and the other fibers keep running. While such a call uses an image, using that image from another fiber raises `RuntimeError` ("object is in use by another fiber") instead of waiting. `Thread#raise`, `Timeout` and Ctrl-C now reach a thread after the ImageMagick call returns, with or without a scheduler. See "Threads, fibers and fork" in README for the rules.
+>
+> `Image#fx` now raises `ArgumentError` for an expression that starts with `@`, or that has a `%[fx:@...]`, `%[hex:@...]` or `%[pixel:@...]` escape. ImageMagick read the file it names, so an expression taken from user input could read any file the process can open. The message is "the expression must not name a file with '@'", as for the other values that reject `@`.
+>
+> With ImageMagick 7, `Pixel.new(red, green, blue, opacity)` now takes the fourth argument as opacity, as with ImageMagick 6, so `Pixel.new(0, 0, 0, 0)` is opaque. `Image#to_color` now uses the depth and alpha channel of the image, as with ImageMagick 6, so it returns `"#D8936A"` instead of `"#D8D893936A6A"` for an 8-bit image without alpha.
+
+Breaking Changes
+
+* Reject an Image#fx expression beginning with '@' instead of reading that file (#1919)
+* Fix Pixel.new treating the fourth argument as alpha instead of opacity with ImageMagick 7 (#1907)
+* Fix Image#to_color ignoring the image depth and alpha channel with ImageMagick 7 (#1908)
+
+Improvements
+
+* Improve performance by running ImageMagick calls on a Fiber scheduler's worker pool (#1921)
+* Describe how to use RMagick with threads, fibers and fork in README (#1932)
+* Fix the API reference pages that disagree with the code (#1903-#1906)
+
+Bug Fixes
+
+* Fix a crash when an image is destroyed in the block of Image#polaroid and similar methods (#1933)
+* Fix an image staying "in use by another fiber" in the child of a fork (#1931)
+* Fix Image#write and other calls doing nothing right after an Async task is stopped (#1930)
+* Fix memory leak when Thread#raise or Timeout interrupts an image operation (#1926)
+* Fix wrong pixels when two calls read the same image at once (#1925)
+* Fix Image#to_color returning the wrong color for a CMYK image (#1920)
+* Fix Image#pixel_color crashing for a coordinate whose pixel offset overflows (#1918)
+* Fix Image.read_inline crashing when ImageMagick returns no image (#1915)
+* Fix pixel_color and get_pixels returning a huge value for a negative HDRI pixel with ImageMagick 7 (#1914)
+* Fix Image.constitute accepting a pixel array whose size overflows (#1913)
+* Fix Image.constitute reading freed memory and leaking on a bad pixel value (#1912)
+* Fix out-of-range values wrapping around in Pixel and the alpha keyword (#1911)
+* Fix highlight_color and lowlight_color having no effect in compare_channel (#1910)
+* Fix Pixel#to_color rejecting depth 16, 32 and 64 with a 64-bit quantum depth (#1909)
+
 ## RMagick 7.1.7
 
 Bug Fixes

data/README.md

@@ -192,6 +192,17 @@ require 'rmagick'
 
 See <https://rmagick.github.io/usage.html> for links to more information.
 
+### Threads, fibers and fork
+
+RMagick releases the GVL while ImageMagick works, so calls on different images run in parallel.
+
+- Use each image from one thread at a time. To work in parallel, give each thread its own images.
+- On Ruby 4.0 and later, a Fiber scheduler with a worker pool, such as `Async::Scheduler.new(worker_pool: IO::Event::WorkerPool.new)`, runs heavy calls on its workers, and the other fibers keep running. While such a call uses an image, using that image from another fiber raises `RuntimeError` ("object is in use by another fiber").
+- Each call in flight holds its images in memory, so memory use grows with the number of workers. Limit the calls that run at once, for example with `Async::Semaphore`.
+- `Thread#raise`, `Timeout` and Ctrl-C reach a thread after the ImageMagick call returns. An exception raised in a `trap` handler can unwind through ImageMagick instead.
+- Do not fork while other threads or workers are running ImageMagick. The child can hang on a lock that they held.
+- After ImageMagick has used OpenMP, a call that uses OpenMP in a forked child can hang. A process that forks after using RMagick should set `MAGICK_THREAD_LIMIT=1`.
+
 Things that can go wrong
 ------------------------
 

data/Rakefile

@@ -191,6 +191,7 @@ if RUBY_PLATFORM.include?('linux')
 
   RubyMemcheck.config(
     binary_name: 'RMagick2',
+    valgrind_options: RubyMemcheck::Configuration::DEFAULT_VALGRIND_OPTIONS + ['--max-stackframe=65536'],
     valgrind_suppressions_dir: 'spec/valgrind'
   )
 

data/ext/RMagick/extconf.rb

@@ -81,7 +81,7 @@ module RMagick
     end
 
     def configure_headers
-      @headers = %w[assert.h ctype.h stdio.h stdlib.h math.h time.h sys/types.h ruby.h ruby/io.h]
+      @headers = %w[assert.h ctype.h stdio.h stdlib.h math.h time.h sys/types.h ruby.h ruby/io.h ruby/fiber/scheduler.h]
 
       if have_header('MagickCore/MagickCore.h')
         headers << 'MagickCore/MagickCore.h'
@@ -275,7 +275,8 @@ module RMagick
 
     def create_header_file
       ruby_api = [
-        'rb_io_path' # Ruby 3.3.0
+        'rb_io_path', # Ruby 3.3.0
+        'rb_fiber_scheduler_blocking_operation_extract' # Ruby 4.0.0
       ]
       memory_api = %w[
         posix_memalign

data/ext/RMagick/rmagick.h

@@ -104,7 +104,7 @@ extern "C" {
 
 // Handle Quantum <-> Ruby Numeric object conversion
 #if (MAGICKCORE_QUANTUM_DEPTH == 8 || MAGICKCORE_QUANTUM_DEPTH == 16)
-#define QUANTUM2NUM(q) INT2FIX((q)) /**< Quantum -> Ruby Numeric conversion */
+#define QUANTUM2NUM(q) INT2NUM((q)) /**< Quantum -> Ruby Numeric conversion */
 #define NUM2QUANTUM(n) (Quantum)NUM2UINT((n)) /**< Quantum <- Ruby Numeric conversion */
 #elif (MAGICKCORE_QUANTUM_DEPTH == 32)
 #define QUANTUM2NUM(q) UINT2NUM((q)) /**< Quantum -> Ruby Numeric conversion */
@@ -443,7 +443,7 @@ extern const rb_data_type_t rm_kernel_info_data_type;
 */
 #define C_boolean_to_R_boolean(attr) (attr) ? Qtrue : Qfalse /**< C boolean -> Ruby boolean */
 #define R_boolean_to_C_boolean(attr) (MagickBooleanType)RTEST(attr) /**<  C boolean <- Ruby boolean */
-#define C_int_to_R_int(attr) INT2FIX(attr) /**< C int -> Ruby int */
+#define C_int_to_R_int(attr) INT2NUM(attr) /**< C int -> Ruby int */
 #define R_int_to_C_int(attr) NUM2INT(attr) /**< C int <- Ruby int */
 #define C_long_to_R_long(attr) LONG2NUM(attr) /**< C long -> Ruby long */
 #define R_long_to_C_long(attr) NUM2LONG(attr) /**< C long <- Ruby long */
@@ -458,7 +458,7 @@ extern const rb_data_type_t rm_kernel_info_data_type;
     {\
         klass *ptr;\
         if (rb_obj_is_kind_of(self, Class_Image) == Qtrue) {\
-            rm_check_destroyed(self); \
+            rm_check_readable(self); \
         }\
         TypedData_Get_Struct(self, klass, data_type, ptr);\
         return C_##type##_to_R_##type(ptr->attr);\
@@ -468,7 +468,7 @@ extern const rb_data_type_t rm_kernel_info_data_type;
 #define IMPLEMENT_TYPED_ATTR_READERF(klass, attr, field, type, data_type) \
     {\
         klass *ptr;\
-        rm_check_destroyed(self); \
+        rm_check_readable(self); \
         TypedData_Get_Struct(self, klass, data_type, ptr);\
         return C_##type##_to_R_##type(ptr->field);\
     }
@@ -478,10 +478,11 @@ extern const rb_data_type_t rm_kernel_info_data_type;
     {\
         klass *ptr;\
         if (rb_obj_is_kind_of(self, Class_Image) == Qtrue) {\
-            rm_check_destroyed(self); \
+            rm_check_readable(self); \
         }\
         rb_check_frozen(self);\
         TypedData_Get_Struct(self, klass, data_type, ptr);\
+        rm_gvl_check_writable(ptr);\
         ptr->attr = R_##type##_to_C_##type(val);\
         return val;\
     }
@@ -491,10 +492,11 @@ extern const rb_data_type_t rm_kernel_info_data_type;
     {\
         klass *ptr;\
         if (rb_obj_is_kind_of(self, Class_Image) == Qtrue) {\
-            rm_check_destroyed(self); \
+            rm_check_readable(self); \
         }\
         rb_check_frozen(self);\
         TypedData_Get_Struct(self, klass, data_type, ptr);\
+        rm_gvl_check_writable(ptr);\
         ptr->field = R_##type##_to_C_##type(val);\
         return self;\
     }
@@ -1157,7 +1159,8 @@ extern size_t rm_strnlen_s(const char *, size_t);
 extern bool   rm_has_file_reference(const char *);
 extern void   rm_check_ary_len(VALUE, long);
 extern VALUE  rm_check_ary_type(VALUE ary);
-extern Image *rm_check_destroyed(VALUE);
+extern Image *rm_check_readable(VALUE);
+extern Image *rm_check_writable(VALUE);
 extern Image *rm_check_frozen(VALUE);
 extern char  *rm_str2cstr(VALUE *, size_t *);
 extern char  *rm_path2cstr(VALUE *, size_t *);
@@ -1215,4 +1218,6 @@ extern void   rm_check_image_exception(Image *, ErrorRetention);
 
 } // extern "C"
 
+#include "rmagick_gvl.hpp"
+
 #endif