Class: SafeImage::OperationBackends::Vips

Inherits:
Base
  • Object
show all
Defined in:
lib/safe_image/operation_backends/vips.rb

Overview

libvips operation orchestration. This is the configured-backend path for untrusted raster bytes; optional cjpegli/jpegtran tiers run only after SafeImage has decoded or validated the input.

Constant Summary collapse

NATIVE_CONVERT_DEFAULT_QUALITY = 
QualityDefaults::NATIVE_CONVERT_JPEG

Instance Attribute Summary

Attributes inherited from Base

#config

Instance Method Summary collapse

Methods inherited from Base

#frame_count, #initialize

Constructor Details

This class inherits a constructor from SafeImage::OperationBackends::Base

Instance Method Details

#convert(input:, output:, format:, quality:, optimize:, max_pixels:, chroma_subsampling:) ⇒ Object 



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/safe_image/operation_backends/vips.rb', line 105

def convert(input:, output:, format:, quality:, optimize:, max_pixels:, chroma_subsampling:)
  input, output = input_output!(input, output)
  max_pixels = resolved_max_pixels(max_pixels)
  input = PathSafety.ensure_regular_file!(input).to_s
  normalized_format = Formats.normalize(format)

  if jpegli_for_convert?(input, normalized_format)
    info =
      jpegli_convert_after_native_decode(
        input: input,
        output: output,
        quality: quality || JpegliBackend::DEFAULT_QUALITY,
        max_pixels: max_pixels,
        chroma_subsampling: chroma_subsampling
      )
    return result_from_info(input, output, info, :vips, tier: :cjpegli)
  end

  info =
    write_through_tempfile(output) do |tmp_path|
      Native.convert(input, tmp_path, normalized_format, quality || NATIVE_CONVERT_DEFAULT_QUALITY, max_pixels)
    end
  optimize_output(output, normalized_format == "jpg" ? quality : nil) if optimize
  result_from_info(input, output, info, :vips, tier: :native_convert)
end

#convert_favicon_to_png(input:, output:, optimize:, max_pixels:) ⇒ Object 



163
164
165
166
167
168
169
170
 
# File 'lib/safe_image/operation_backends/vips.rb', line 163

def convert_favicon_to_png(input:, output:, optimize:, max_pixels:)
  input, output = input_output!(input, output)
  max_pixels = resolved_max_pixels(max_pixels)
  # Pure-Ruby ICO parse; libvips only encodes the extracted pixels.
  info = Ico.convert_to_png(input, output, max_pixels: max_pixels)
  optimize_output(output, nil) if optimize
  result_from_info(input, output, info, :ico_vips, tier: :ico_ruby)
end

#crop(input:, output:, width:, height:, quality:, optimize:, max_pixels:, chroma_subsampling:) ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/safe_image/operation_backends/vips.rb', line 28

def crop(input:, output:, width:, height:, quality:, optimize:, max_pixels:, chroma_subsampling:)
  input, output = input_output!(input, output)
  max_pixels = resolved_max_pixels(max_pixels)
  probe = operation_probe(input, max_pixels: max_pixels)
  output = safe_output!(output)
  format = Formats.extension(output)

  info =
    if jpegli_for_generated_jpeg?(format)
      JpegliBackend.encode_generated_jpeg(
        output: output,
        quality: quality || JpegliBackend::DEFAULT_QUALITY,
        chroma_subsampling: chroma_subsampling,
        input_format: probe.input_format
      ) do |tmp_path|
        VipsBackend.crop_north(
          input: probe.input,
          output: tmp_path,
          width: width,
          height: height,
          format: "png",
          quality: 100,
          max_pixels: max_pixels
        )
      end
    else
      VipsBackend.crop_north(
        input: probe.input,
        output: output,
        width: width,
        height: height,
        format: format,
        quality: quality || QualityDefaults::JPEG,
        max_pixels: max_pixels
      )
    end
  optimize_output(output, quality) if optimize
  result_from_info(probe.input, output, info, :vips, tier: info[:encoder] == "cjpegli" ? :cjpegli : :crop)
end

#downsize(input:, output:, dimensions:, optimize:, max_pixels:, quality:, chroma_subsampling:) ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/safe_image/operation_backends/vips.rb', line 68

def downsize(input:, output:, dimensions:, optimize:, max_pixels:, quality:, chroma_subsampling:)
  input, output = input_output!(input, output)
  max_pixels = resolved_max_pixels(max_pixels)
  probe = operation_probe(input, max_pixels: max_pixels)
  output = safe_output!(output)
  format = Formats.extension(output)
  info =
    if jpegli_for_generated_jpeg?(format)
      JpegliBackend.encode_generated_jpeg(
        output: output,
        quality: quality,
        chroma_subsampling: chroma_subsampling,
        input_format: probe.input_format
      ) do |tmp_path|
        VipsBackend.downsize(
          input: probe.input,
          output: tmp_path,
          dimensions: dimensions,
          format: "png",
          quality: 100,
          max_pixels: max_pixels
        )
      end
    else
      VipsBackend.downsize(
        input: probe.input,
        output: output,
        dimensions: dimensions,
        format: format,
        quality: quality,
        max_pixels: max_pixels
      )
    end
  optimize_output(output, nil) if optimize
  result_from_info(probe.input, output, info, :vips, tier: info[:encoder] == "cjpegli" ? :cjpegli : :downsize)
end

#fix_orientation(input:, output:, max_pixels:, quality:) ⇒ Object

Raises:

  • (ArgumentError) 


131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/safe_image/operation_backends/vips.rb', line 131

def fix_orientation(input:, output:, max_pixels:, quality:)
  input, output = input_output!(input, output)
  max_pixels = resolved_max_pixels(max_pixels)
  input = PathSafety.ensure_regular_file!(input).to_s
  format = Formats.extension(input)
  # Validates the format against the native loader allowlist and enforces
  # the pixel cap before any pixel decode.
  orient = VipsBackend.orientation(input, max_pixels: max_pixels)

  # Lossless tier: jpegtran transforms JPEG DCT coefficients directly, so
  # there is no generation loss. -perfect refuses when the dimensions are
  # not MCU-aligned; only that expected refusal falls through to the
  # observable re-encode tier.
  tier = :native_reencode
  if format == "jpg" && orient > 1 && Runner.available?("jpegtran")
    begin
      return jpegtran_fix_orientation(input, output, orient)
    rescue CommandError => e
      raise unless Optimizer.jpegtran_perfect_reject?(e)

      tier = :jpegtran_fallback_reencode
    end
  end

  quality = quality.nil? ? QualityDefaults::FIX_ORIENTATION_REENCODE_JPEG : Integer(quality)
  raise ArgumentError, "quality must be 1..100" unless (1..100).cover?(quality)

  info =
    write_through_tempfile(output) { |tmp_path| Native.resize(input, tmp_path, 1.0, format, quality, max_pixels) }
  result_from_info(input, output, info, :vips, tier: tier)
end

#letter_avatar(output:, size:, background_rgb:, letter:, pointsize:, font:) ⇒ Object 



172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/safe_image/operation_backends/vips.rb', line 172

def letter_avatar(output:, size:, background_rgb:, letter:, pointsize:, font:)
  output = safe_output!(output)
  request = {
    output: output,
    size: size,
    background_rgb: background_rgb,
    letter: letter,
    pointsize: pointsize,
    font: font
  }
  result_from_info("generated", output, VipsBackend.letter_avatar(**request), :vips, tier: :letter_avatar)
end

#resize(input:, output:, width:, height:, quality:, optimize:, max_pixels:, chroma_subsampling:) ⇒ Object 



13
14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/safe_image/operation_backends/vips.rb', line 13

def resize(input:, output:, width:, height:, quality:, optimize:, max_pixels:, chroma_subsampling:)
  input, output = input_output!(input, output)
  max_pixels = resolved_max_pixels(max_pixels)
  result =
    Processor.new(max_pixels: max_pixels, chroma_subsampling: chroma_subsampling, config: config).thumbnail(
      input: input,
      output: output,
      width: width,
      height: height,
      quality: quality || QualityDefaults::JPEG,
      optimize: optimize
    )
  result.with(tier: result.backend.include?("cjpegli") ? :cjpegli : :resize)
end