Class: ChunkyPNG::Chunk::CompressedText

Inherits:
Base
  • Object
show all
Defined in:
lib/chunky_png/chunk.rb

Overview

The CompressedText (zTXt) chunk contains keyword/value metadata about the PNG stream. In this chunk, the value is compressed using Deflate compression.

Instance Attribute Summary collapse

Attributes inherited from Base

#type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#write, #write_with_crc

Constructor Details

#initialize(keyword, value) ⇒ CompressedText

Returns a new instance of CompressedText.



281
282
283
284
# File 'lib/chunky_png/chunk.rb', line 281

def initialize(keyword, value)
  super('zTXt')
  @keyword, @value = keyword, value
end

Instance Attribute Details

#keywordObject

Returns the value of attribute keyword.



279
280
281
# File 'lib/chunky_png/chunk.rb', line 279

def keyword
  @keyword
end

#valueObject

Returns the value of attribute value.



279
280
281
# File 'lib/chunky_png/chunk.rb', line 279

def value
  @value
end

Class Method Details

.read(type, content) ⇒ Object



286
287
288
289
290
# File 'lib/chunky_png/chunk.rb', line 286

def self.read(type, content)
  keyword, compression, value = content.unpack('Z*Ca*')
  raise ChunkyPNG::NotSupported, "Compression method #{compression.inspect} not supported!" unless compression == ChunkyPNG::COMPRESSION_DEFAULT
  new(keyword, Zlib::Inflate.inflate(value))
end

Instance Method Details

#contentObject

Creates the content to write to the stream, by concatenating the keyword with the deflated value, joined by a null character.

Returns:

  • The content that should be written to the datastream.



296
297
298
# File 'lib/chunky_png/chunk.rb', line 296

def content
  [keyword, ChunkyPNG::COMPRESSION_DEFAULT, Zlib::Deflate.deflate(value)].pack('Z*Ca*')
end