libis-format 1.3.4 → 1.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5fb1b156976a67b10d6885880a0611ba8361671c24da8014e7e11d7840be6318
-  data.tar.gz: 1f5e6e9b1cd84031a5a1ae986a2d0de018bb021bb48d47d6d83c9feea1e8db59
+  metadata.gz: a6fcaac952f46961bb147aa74701c93116b9e62a33924c82c1c39e939e6fa8f5
+  data.tar.gz: 184bcd3c2ea39d8b0303bec9d68908bc33f2c3b9dd8872506f9b6e89cb57c618
 SHA512:
-  metadata.gz: 364036443664fc6597d36456c554e25074926515c2b95c7475a93499a27389bc0a2d8749ba86f5cb29e47b50c41902780518b780abde202f0d69f2e3a550cf24
-  data.tar.gz: b7d5823c3da6b25a71b2d7c3a2b05a9b15042e562985775b357490ccadabc457e0784136c1e269030f7211c94e3926a2000857efa03472cb9ca05f013f25128c
+  metadata.gz: abe4e81ed1e79777a0c6319f9b3105965bdcef05fffd18d1da93dd14b147271846f544b914b04b246dd2f884eb48909c0bd8d6ae88768dbfef6db5b5d5d37f5b
+  data.tar.gz: c52f3d3d0ca1b55c984321b4b92cd9f93835ebbfce5ae68ee96d2e545f6ca501aa355719b5394eedb23cfe78db21f6c938b51926860a9db2845407fc11900d6e

data/lib/libis/format/converter/image_converter.rb

@@ -86,20 +86,13 @@ module Libis
 
         # Create or use a watermark image.
         #
-        # The watermark options are (use symbols):
+        # The main watermark options are (use symbols):
         #     - text: text to create a watermark from
         #     - file: watermark image to use
         #     - image: same as above
-        #     - rotation: rotation of the watermark text (in degrees; integer number)
-        #     - size: font size of the watermark text
-        #     - opacity: opacity of the watermark (fraction 0.0 - 1.0)
-        #     - gap: size of the gap between watermark instances. Integer value is absolute size in points (1/72 inch).
-        #            Fractions are percentage of widht/height.
-        # If both options are given, the file will be used as-is if it exists and is a valid image file. Otherwise the
-        # file will be created or overwritten with a newly created watermark image.
+        #     - banner: use side banner
         #
-        # The created watermark file will be a PNG image with transparent background containing the supplied text
-        # slanted by 30 degrees counter-clockwise.
+        # For each of these options above a dedicated option handler will be called
         #
         # @param [Hash] options Hash of options for watermark creation.
 
@@ -169,13 +162,13 @@ module Libis
           @options[:watermark][:rotation] = 360 - (options[:rotation] || 30).to_i
         end
 
-        # Create a vertical banner to the right side of each page
+        # Create a vertical banner to the right side of the image
         #
         # The banner options are:
         # - banner: text to put in the banner
         # - add_filename: append filename to the text (use any value to enable)
         # - fontsize: size of the font (in points) (default: autoscale)
-        # - width: width of the banner (default: 3% of image height). Not including a border of 30% of the banner width
+        # - width: width of the banner (default: 3% of image height). Not including a border of 1/3 of the banner width
         # - background_color_(red|green|blue): color components of background (default: rgb(84,190,233))
         # - text_color_(red|green|blue): color components of background (default: rgb(255,255,255))
         def watermark_banner(options = {})
@@ -261,6 +254,8 @@ module Libis
             wm = @options.delete(:watermark)
             if wm
               image_info = MiniMagick::Image::Info.new(source) { |b| b.quiet }
+              im_height = image_info['height']
+              im_width = image_info['width']
               case wm[:command]
               when 'text'
                 convert.background 'transparent'
@@ -272,7 +267,7 @@ module Libis
                 convert.trim.repage.+ # rubocop:disable Lint/Void
                 convert.bordercolor('transparent').border("#{wm[:gap]}%") if wm[:gap].positive?
                 convert.filter('Lagrange')
-                convert.resize("#{image_info['width'] / wm[:tiles]}x#{image_info['height'] / wm[:tiles]}") if wm[:tiles].positive?
+                convert.resize("#{im_width / wm[:tiles]}x#{im_height / wm[:tiles]}") if wm[:tiles].positive?
                 convert.resize("#{wm[:resize]}%") if wm[:resize]
               when 'image'
                 convert << wm[:data]
@@ -280,13 +275,13 @@ module Libis
                 convert.bordercolor('transparent').border("#{wm[:gap]}%") if wm[:gap].positive?
                 convert.rotate wm[:rotation]
                 convert.filter('Lagrange')
-                convert.resize("#{image_info['width'] / wm[:tiles]}x#{image_info['height'] / wm[:tiles]}") if wm[:tiles].positive?
+                convert.resize("#{im_width / wm[:tiles]}x#{im_height / wm[:tiles]}") if wm[:tiles].positive?
                 convert.resize("#{wm[:resize]}%") if wm[:resize]
               when 'banner'
-                banner_width = wm[:width] || [0.03 * image_info['height'], 20].max.round(0)
+                banner_width = wm[:width] || [0.03 * im_height, 20].max.round(0)
                 banner_border = banner_width / 3
                 convert.background "rgb(#{wm[:background_red]},#{wm[:background_green]},#{wm[:background_blue]})"
-                convert.size("#{image_info['height']}x#{banner_width}")
+                convert.size("#{im_height}x#{banner_width}")
                 convert.bordercolor "rgb(#{wm[:background_red]},#{wm[:background_green]},#{wm[:background_blue]})"
                 convert.border "0x#{banner_border}"
                 convert.fill "rgb(#{wm[:text_red]},#{wm[:text_green]},#{wm[:text_blue]})"
@@ -298,6 +293,9 @@ module Libis
 
               # Save watermark image to buffer
               convert.write('mpr:watermark').delete.+
+
+              # Restore canvas to source image size (workaround for IM bug when loading JP2K files)
+              convert.size("#{im_width}x#{im_height}")
             end
 
             # load source image

data/lib/libis/format/converter/video_converter.rb

@@ -64,7 +64,7 @@ module Libis
         end
 
         def constant_rate_factor(value)
-          @options[:crf] = value.to_s
+          @options[:constant_rate_factor] = value.to_s
         end
 
         def frame_rate(value)
@@ -84,36 +84,66 @@ module Libis
           @options[:watermark_image] = file
         end
 
-        # @param [String] value text for watermark. No watermark if nil (default)
+        # @param [String] value Text for watermark. No watermark if nil (default)
         def watermark_text(value)
-          @options[:watermark_text] = value
+          @options[:watermark_text] = value.to_s
         end
 
-        # @param [Integer] value Font size for watermark text. Default: 10
+        # @param [Boolean] value Should the filename be appended to the watermark text; use any value to enable
+        def watermark_text_add_filename(value)
+          @options[:watermark_text_add_filename] = !!value
+        end
+
+        # @param [String] value Font size for watermark text. Default: 10
         # Note that the font is selected by the Config[:watermark_font] setting
         def watermark_text_size(value)
-          @options[:watermark_text_size] = value.to_i
+          @options[:watermark_text_size] = value.to_s
         end
 
         # @param [String] value Text color for the watermark text. Default: white
         def watermark_text_color(value)
-          @options[:watermark_text_color] = value
+          @options[:watermark_text_color] = value.to_s
+        end
+
+        # @param [Integer] value Offset of the watermark text shadow. Used for both x and y offset; default: 1
+        # If the offset is set to 0, no shadow will be printed
+        def watermark_text_shadow_offset(value)
+          @options[:watermark_text_shadow_offset] = value.to_i
         end
 
         # @param [String] value Text color for the watermark text shadow. Default: black
         def watermark_text_shadow_color(value)
-          @options[:watermark_text_shadow_color] = value
+          @options[:watermark_text_shadow_color] = value.to_s
         end
 
-        # @param [Integer] value Offset of the watermark text shadow. Used for both x and y offset; default: 1
-        # If the offset is set to 0, no shadow will be printed
-        def watermark_text_shadow_offset(value)
-          @options[:watermark_text_offset] = value.to_i
+        # @param [Integer] value Enable/disable watermark text box. 1 to enanble, 0 to disable; default: 0
+        def watermark_text_box(value)
+          @options[:watermark_text_box] = value.to_i
+        end
+
+        # @param [String] value Color of the watermark text box; default: white
+        def watermark_text_box_color(value)
+          @options[:watermark_text_box_color] = value.to_s
+        end
+
+        # @param [String] value Border width of the watermark text box
+        def watermark_text_box_width(value)
+          @options[:watermark_text_box_width] = value.to_s
         end
 
         # @param [String] value one of 'bottom_left' (default), 'top_left', 'bottom_right', 'top_right', 'center'
         def watermark_position(value)
-          @options[:watermark_position] = value
+          @options[:watermark_position] = value.to_s
+        end
+
+        # @param [String] value offset x value for the text box. Default: 10
+        def watermark_offset_x(value)
+          @options[:watermark_offset_x] = value.to_s
+        end
+
+        # @param [String] value offset y value for the text box. Default: 10
+        def watermark_offset_y(value)
+          @options[:watermark_offset_y] = value.to_s
         end
 
         # @param [Number] value watermark opacity (0-1) with 0 = invisible and 1 = 100% opaque. Default: 0.5
@@ -121,6 +151,11 @@ module Libis
           @options[:watermark_opacity] = value.to_f
         end
 
+        # @param [Number] value watermark blending (0-1) with 0 = invisible and 1 = 100% opaque. Default: 0.5
+        def watermark_blending(value)
+          @options[:watermark_blending] = value.to_f
+        end
+
         # @param [Boolean] value If set to true automatically selects optimal format for web viewing. Default: false
         def web_stream(value)
           return unless value
@@ -214,20 +249,30 @@ module Libis
           if @options[:watermark_image]
             opts[:filter] << '-i' << @options[:watermark_image] << '-filter_complex'
             opts[:filter] << Kernel.format('[1:v]format=argb,colorchannelmixer=aa=%f[wm];[0:v][wm]overlay=%s',
-                                           @options[:watermark_opacity], watermark_position_text)
+                                           @options[:watermark_opacity], watermark_position_filter)
           elsif @options[:watermark_text]
-            @options[:watermark_text_size] ||= 10
+            wm_text = @options[:watermark_text]
+            wm_text += File.basename(source, '.*') if @options[:watermark_text_add_filename]
+            @options[:watermark_text_size] ||= '10'
             @options[:watermark_text_color] ||= 'white'
             @options[:watermark_text_shadow_color] ||= 'black'
             @options[:watermark_text_shadow_offset] ||= 1
-            filter_text = Kernel.format("drawtext=text='%s':%s:fontfile=%s:fontsize=%d:fontcolor=%s@%f",
-                                        @options[:watermark_text], watermark_position_text(true), Config[:watermark_font],
+            filter_text = Kernel.format("drawtext=text='%s':%s:fontfile=%s:fontsize=%s:fontcolor=%s@%f",
+                                        wm_text, watermark_position_filter(true), Config[:watermark_font],
                                         @options[:watermark_text_size], @options[:watermark_text_color], @options[:watermark_opacity])
-            if (@options[:watermark_text_shadow_offset]).positive?
+            if !(@options[:watermark_text_shadow_offset] == 0)
               filter_text += Kernel.format(':shadowcolor=%s@%f:shadowx=%d:shadowy=%d',
                                            @options[:watermark_text_shadow_color], @options[:watermark_opacity],
                                            @options[:watermark_text_shadow_offset], @options[:watermark_text_shadow_offset])
             end
+            @options[:watermark_text_box] ||= 0
+            if (@options[:watermark_text_box]).positive?
+              filter_text += Kernel.format(':box=1:boxcolor=%s:boxborderw=%s',
+                                           @options[:watermark_text_box_color], @options[:watermark_text_box_width])
+            end
+            if (@options[:watermark_blending])
+              filter_text += Kernel.format(':alpha=%f', @options[:watermark_blending])
+            end
             opts[:filter] << '-vf' << filter_text
           end
           opts[:output] << '-ac' << @options[:audio_channels] if @options[:audio_channels]
@@ -235,7 +280,7 @@ module Libis
           opts[:output] << '-c:v' << @options[:video_codec] if @options[:video_codec]
           opts[:output] << '-b:a' << @options[:audio_bitrate] if @options[:audio_bitrate]
           opts[:output] << '-b:v' << @options[:video_bitrate] if @options[:video_bitrate]
-          opts[:output] << '-crf' << @options[:crf] if @options[:crf]
+          opts[:output] << '-crf' << @options[:constant_rate_factor] if @options[:constant_rate_factor]
           opts[:output] << '-map_metadata:g' << '0:g' # Copy global metadata
           opts[:output] << '-map_metadata:s:a' << '0:s:a' # Copy audio metadata
           opts[:output] << '-map_metadata:s:v' << '0:s:v' # Copy video metadata
@@ -261,20 +306,22 @@ module Libis
           target
         end
 
-        def watermark_position_text(for_text = false, margin = 10)
+        def watermark_position_filter(for_text = false)
+          margin_x = @options[:watermark_offset_x] || 10
+          margin_y = @options[:watermark_offset_y] || 10
           w = for_text ? 'tw' : 'w'
           h = for_text ? 'th' : 'h'
           case @options[:watermark_position]
           when 'bottom_left'
-            "x=#{margin}:y=H-#{h}-#{margin}"
+            "x=#{margin_x}:y=H-#{h}-#{margin_y}"
           when 'top_left'
-            "x=#{margin}:y=#{margin}"
+            "x=#{margin_x}:y=#{margin_y}"
           when 'bottom_right'
-            "x=W-#{w}-#{margin}:y=H-#{h}-#{margin}"
+            "x=W-#{w}-#{margin_x}:y=H-#{h}-#{margin_y}"
           when 'top_right'
-            "x=W-#{w}-#{margin}:y=#{margin}"
+            "x=W-#{w}-#{margin_x}:y=#{margin_y}"
           else
-            "x=#{margin}:y=H-#{h}-#{margin}"
+            "x=#{margin_x}:y=H-#{h}-#{margin_y}"
           end
         end
       end

data/lib/libis/format/version.rb

@@ -2,6 +2,6 @@
 
 module Libis
   module Format
-    VERSION = '1.3.4'
+    VERSION = '1.3.5'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libis-format
 version: !ruby/object:Gem::Version
-  version: 1.3.4
+  version: 1.3.5
 platform: ruby
 authors:
 - Kris Dekeyser
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-11 00:00:00.000000000 Z
+date: 2024-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chromaprint
@@ -367,7 +367,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.18
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: LIBIS File format format services.