Module: ChunkyPNG::Canvas::Adam7Interlacing

Included in:
ChunkyPNG::Canvas
Defined in:
lib/chunky_png/canvas/adam7_interlacing.rb

Overview

Methods for decoding and encoding Adam7 interlacing.

Adam7 interlacing extracts 7 pass images out of a single image, that can be encoded to a stream separately so the image can be built up progressively. The module is included into ChunkyPNG canvas and is used to extract the pass images from the original image, or to reconstruct an original image from separate pass images.

Instance Method Summary (collapse)

Instance Method Details

- (ChunkyPNG::Canvas) adam7_extract_pass(pass, canvas)

Extracts a pass from a complete image

Parameters:

  • pass (Integer)

    The pass number, should be in 0..6.

  • canvas (ChunkyPNG::Canvas)

    The image that is being deconstructed.

Returns:



57
58
59
60
61
62
63
64
65
66
67
68
69
# File 'lib/chunky_png/canvas/adam7_interlacing.rb', line 57

def adam7_extract_pass(pass, canvas)
  x_shift, x_offset, y_shift, y_offset = adam7_multiplier_offset(pass)
  sm_pixels = []
  
  y_offset.step(canvas.height - 1, 1 << y_shift) do |y|
    x_offset.step(canvas.width - 1, 1 << x_shift) do |x|
      sm_pixels << canvas[x, y]
    end
  end
  
  new_canvas_args = adam7_pass_size(pass, canvas.width, canvas.height) + [sm_pixels]
  ChunkyPNG::Canvas.new(*new_canvas_args)
end

- (Object) adam7_merge_pass(pass, canvas, subcanvas)

Merges a pass image into a total image that is being constructed.

Parameters:

  • pass (Integer)

    The pass number, should be in 0..6.

  • canvas (ChunkyPNG::Canvas)

    The image that is being constructed.

  • subcanvas (ChunkyPNG::Canvas)

    The pass image that should be merged



42
43
44
45
46
47
48
49
50
51
# File 'lib/chunky_png/canvas/adam7_interlacing.rb', line 42

def adam7_merge_pass(pass, canvas, subcanvas)
  x_shift, x_offset, y_shift, y_offset = adam7_multiplier_offset(pass)
  for y in 0...subcanvas.height do
    for x in 0...subcanvas.width do
      new_x = (x << x_shift) | x_offset
      new_y = (y << y_shift) | y_offset
      canvas[new_x, new_y] = subcanvas[x, y]
    end
  end
end

- (Object) adam7_multiplier_offset(pass)

Returns an array with the x-shift, x-offset, y-shift and y-offset for the requested pass.

Parameters:

  • pass (Integer)

    The pass number, should be in 0..6.



14
15
16
17
# File 'lib/chunky_png/canvas/adam7_interlacing.rb', line 14

def adam7_multiplier_offset(pass)
  [3 - (pass >> 1), (pass & 1 == 0) ? 0 : 8 >> ((pass + 1) >> 1),
   pass == 0 ? 3 : 3 - ((pass - 1) >> 1), (pass == 0 || pass & 1 == 1) ? 0 : 8 >> (pass >> 1)]
end

- (Object) adam7_pass_size(pass, original_width, original_height)

Returns the pixel dimensions of the requested pass.

Parameters:

  • pass (Integer)

    The pass number, should be in 0..6.

  • original_width (Integer)

    The width of the original image.

  • original_height (Integer)

    The height of the original image.



23
24
25
26
27
# File 'lib/chunky_png/canvas/adam7_interlacing.rb', line 23

def adam7_pass_size(pass, original_width, original_height)
  x_shift, x_offset, y_shift, y_offset = adam7_multiplier_offset(pass)
  [ (original_width  - x_offset + (1 << x_shift) - 1) >> x_shift,
    (original_height - y_offset + (1 << y_shift) - 1) >> y_shift]
end

- (Array<Array<Integer>>) adam7_pass_sizes(original_width, original_height)

Returns an array of the dimension of all the pass images.

Parameters:

  • original_width (Integer)

    The width of the original image.

  • original_height (Integer)

    The height of the original image.

Returns:

  • (Array<Array<Integer>>)

    Returns an array with 7 pairs of dimensions.

See Also:



34
35
36
# File 'lib/chunky_png/canvas/adam7_interlacing.rb', line 34

def adam7_pass_sizes(original_width, original_height)
  (0...7).map { |pass| adam7_pass_size(pass, original_width, original_height) }
end