Skip to content

support xcf >= 4 and xcf >= 11 #106

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 4, 2025
Merged

support xcf >= 4 and xcf >= 11 #106

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
80d7f08
support xcf >= 4 and xcf >= 11
mothsART Mar 3, 2025
8001a21
add 4 samples and tests
mothsART Mar 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
102 changes: 89 additions & 13 deletions hachoir/parser/image/xcf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

from hachoir.parser import Parser
from hachoir.field import (StaticFieldSet, FieldSet, ParserError,
UInt8, UInt32, Enum, Float32, String, PascalString32, RawBytes)
UInt8, UInt32, UInt64, Enum, Float32, String, PascalString32, RawBytes)
from hachoir.parser.image.common import RGBA
from hachoir.core.endian import NETWORK_ENDIAN

Expand Down Expand Up @@ -152,7 +152,10 @@ def createFields(self):
return
data_offsets = []
while (self.absolute_address + self.current_size) // 8 < offset:
chunk = UInt32(self, "data_offset[]", "Data offset")
if self._parent._parent._parent.version >= 11:
chunk = UInt64(self, "data_offset[]", "Data offset")
else:
chunk = UInt32(self, "data_offset[]", "Data offset")
yield chunk
if chunk.value == 0:
break
Expand All @@ -176,7 +179,10 @@ def createFields(self):

offsets = []
while True:
chunk = UInt32(self, "offset[]", "Level offset")
if self._parent._parent.version >= 11:
chunk = UInt64(self, "offset[]", "Level offset")
else:
chunk = UInt32(self, "offset[]", "Level offset")
yield chunk
if chunk.value == 0:
break
Expand All @@ -196,7 +202,12 @@ def createFields(self):
yield UInt32(self, "height", "Channel height")
yield PascalString32(self, "name", "Channel name", strip="\0", charset="UTF-8")
yield from readProperties(self)
yield UInt32(self, "hierarchy_ofs", "Hierarchy offset")

if self._parent.version >= 11:
yield UInt64(self, "hierarchy_ofs", "Hierarchy offset")
else:
yield UInt32(self, "hierarchy_ofs", "Hierarchy offset")

yield XcfHierarchy(self, "hierarchy", "Hierarchy")

def createDescription(self):
Expand All @@ -213,12 +224,15 @@ def createFields(self):
for prop in readProperties(self):
yield prop

# --
# TODO: Hack for Gimp 1.2 files
# --

yield UInt32(self, "hierarchy_ofs", "Hierarchy offset")
yield UInt32(self, "mask_ofs", "Layer mask offset")
if self._parent.version >= 11:
yield UInt64(self, "hierarchy_ofs", "Hierarchy offset")
yield UInt64(self, "mask_ofs", "Layer mask offset")
else:
# --
# TODO: Hack for Gimp 1.2 files
# --
yield UInt32(self, "hierarchy_ofs", "Hierarchy offset")
yield UInt32(self, "mask_ofs", "Layer mask offset")
padding = self.seekByte(self["hierarchy_ofs"].value, relative=False)
if padding is not None:
yield padding
Expand Down Expand Up @@ -357,26 +371,85 @@ class XcfFile(Parser):
2: "Indexed"
}

# Doc : https://testing.developer.gimp.org/core/standards/xcf/#header
# NOTE: XCF 3 or older's precision was always "8-bit gamma integer".

# For XCF 4 (which was a development version, hence
# this format should not be found often and may be
# ignored by readers), its value may be one of:
IMAGE_PRECISION_NAME_XCF4 = {
0: "8-bit gamma integer",
1: "16-bit gamma integer",
2: "32-bit linear integer",
3: "16-bit linear floating point",
4: "32-bit linear floating point",
}

# For XCF 5 or 6 (which were development versions,
# hence these formats may be ignored by readers),
# its value may be one of:
IMAGE_PRECISION_NAME_XCF5 = {
100: "8-bit linear integer",
150: "8-bit gamma integer",
200: "16-bit linear integer",
250: "16-bit gamma integer",
300: "32-bit linear integer",
350: "32-bit gamma integer",
400: "16-bit linear floating point",
450: "16-bit gamma floating point",
500: "32-bit linear floating point",
550: "32-bit gamma floating point"
}

IMAGE_PRECISION_NAME_XCF7 = {
100: "8-bit linear integer",
150: "8-bit gamma integer",
200: "16-bit linear integer",
250: "16-bit gamma integer",
300: "32-bit linear integer",
350: "32-bit gamma integer",
500: "16-bit linear floating point",
550: "16-bit gamma floating point",
600: "32-bit linear floating point",
650: "32-bit gamma floating point",
700: "64-bit linear floating point",
750: "64-bit gamma floating point",
}

version = 0

def validate(self):
if self.stream.readBytes(0, 9) != b'gimp xcf ':
return "Wrong signature"
return True

def createFields(self):
# Read signature
yield String(self, "signature", 14, "Gimp picture signature (ends with nul byte)", charset="ASCII")
signature = String(self, "signature", 14, "Gimp picture signature (ends with nul byte)", charset="ASCII")
yield signature
if signature.createValue() != 'gimp xcf file\0':
self.version = int(str(signature)[11:-3])

# Read image general informations (width, height, type)
yield UInt32(self, "width", "Image width")
yield UInt32(self, "height", "Image height")
yield Enum(UInt32(self, "type", "Image type"), self.IMAGE_TYPE_NAME)
if self.version == 4:
yield Enum(UInt32(self, "precision", "Image precision"), self.IMAGE_PRECISION_NAME_XCF4)
elif self.version in [5, 6]:
yield Enum(UInt32(self, "precision", "Image precision"), self.IMAGE_PRECISION_NAME_XCF5)
elif self.version >= 7:
yield Enum(UInt32(self, "precision", "Image precision"), self.IMAGE_PRECISION_NAME_XCF7)
for prop in readProperties(self):
yield prop

# Read layer offsets
layer_offsets = []
while True:
chunk = UInt32(self, "layer_offset[]", "Layer offset")
if self.version >= 11:
chunk = UInt64(self, "layer_offset[]", "Layer offset")
else:
chunk = UInt32(self, "layer_offset[]", "Layer offset")
yield chunk
if chunk.value == 0:
break
Expand All @@ -385,7 +458,10 @@ def createFields(self):
# Read channel offsets
channel_offsets = []
while True:
chunk = UInt32(self, "channel_offset[]", "Channel offset")
if self.version >= 11:
chunk = UInt64(self, "channel_offset[]", "Channel offset")
else:
chunk = UInt32(self, "channel_offset[]", "Channel offset")
yield chunk
if chunk.value == 0:
break
Expand Down
Binary file added tests/files/1024x1024-better-compression.xcf
View file
Open in desktop
Binary file not shown.
Binary file added tests/files/minimal_xcf1.xcf
View file
Open in desktop
Binary file not shown.
Binary file added tests/files/minimal_xcf10.xcf
View file
Open in desktop
Binary file not shown.
Binary file added tests/files/minimal_xcf3.xcf
View file
Open in desktop
Binary file not shown.
39 changes: 39 additions & 0 deletions tests/test_parser.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -883,6 +883,45 @@ def test_arj2(self):
self.checkValue(parser, "/file_header[15]/filename", "usr/bin/groups")
self.checkValue(parser, "/file_header[15]/original_size", 35000)

def test_xcf1(self):
parser = self.parse("minimal_xcf1.xcf")
self.checkValue(parser, "/signature", "gimp xcf file\0")
self.checkValue(parser, "/layer[0]/width", 1)
self.checkValue(parser, "/layer[0]/height", 1)
self.checkValue(parser, "/layer[0]/name", "Background")
self.checkValue(parser, "/layer[0]/hierarchy/bpp", 3)
self.checkValue(parser, "/layer[0]/hierarchy/level[0]/offset", 196)

def test_xcf3(self):
parser = self.parse("minimal_xcf3.xcf")
self.checkValue(parser, "/signature", "gimp xcf v003\0")
self.checkValue(parser, "/layer[0]/width", 1)
self.checkValue(parser, "/layer[0]/height", 1)
self.checkValue(parser, "/layer[0]/name", "Background")
self.checkValue(parser, "/layer[0]/hierarchy/bpp", 3)
self.checkValue(parser, "/layer[0]/hierarchy/level[0]/offset", 196)

def test_xcf10(self):
parser = self.parse("minimal_xcf10.xcf")
self.checkValue(parser, "/signature", "gimp xcf v010\0")
self.checkValue(parser, "/layer[0]/width", 1)
self.checkValue(parser, "/layer[0]/height", 1)
self.checkValue(parser, "/layer[0]/name", "Background")
self.checkValue(parser, "/layer[0]/hierarchy/bpp", 3)
self.checkValue(parser, "/layer[0]/hierarchy/level[0]/offset", 200)

def test_xcf11(self):
parser = self.parse("1024x1024-better-compression.xcf")
self.checkValue(parser, "/signature", "gimp xcf v011\0")
self.checkValue(parser, "/layer[0]/width", 512)
self.checkValue(parser, "/layer[0]/height", 512)
self.checkValue(parser, "/layer[0]/name", "Layer 2")
self.checkValue(parser, "/layer[0]/hierarchy/level[2]/width", 128)
self.checkValue(parser, "/layer[1]/name", "Layer 1")
self.checkValue(parser, "/layer[1]/hierarchy/level[2]/width", 128)
self.checkValue(parser, "/layer[2]/name", "Background")
self.checkValue(parser, "/layer[2]/hierarchy/level[1]/width", 256)

def test_zlib(self):
parser = self.parse("usa_railroad.jpg.6.zlib")
self.checkValue(parser, "/compression_method", 8)
Expand Down
Loading