Describe the bug

Using the head of the master branch, if layers have alpha channels, any alpha value less than 1 will end up darker than it should (based on the export from Gimp)

variable-alpha.zip

Expected outcome

Actual outcome

Feature

When flattening an XcfDocument with flattenAll it does not look the way it does when exported from GIMP. Masks seem to be ignored whether on a layer or on a group.

Describe the solution you'd like

flattenAll should result in the same image one would get if viewed in, or exported from, GIMP.

Group masks should be applied to all layers inside the group. A layer mask should be applied to its layer.

System info

$ uname -a
Linux 5.14.0-4-amd64 #1 SMP Debian 5.14.16-1 (2021-11-03) x86_64 GNU/Linux

$ python3 --version
Python 3.9.9

$ pip freeze
aenum==3.1.5
binaryiotools==2021.0.3
blendmodes==2021.3.3
brackettree==0.2.5
deprecation==2.1.0
gimpformats==2021.1.3
numpy==1.21.4
packaging==21.3
Pillow==8.4.0
pyparsing==3.0.6

Describe the bug

Opening an XCF file and then saving, with either save or saveNew methods, results in a corrupt XCF file which can't be opened with gimpformats or Gimp. Test file attached test.zip.

Expected outcome

Creates an identical or at least valid XCF file.

Actual outcome

Python 3.9.9 (main, Nov 16 2021, 10:24:31) 
[GCC 11.2.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> from gimpformats.gimpXcfDocument import GimpDocument
>>> d = GimpDocument('test.xcf')
>>> d.saveNew('/tmp/test.xcf')
>>> d = GimpDocument('/tmp/test.xcf')
Traceback (most recent call last):
  File ".../lib/python3.9/site-packages/binaryiotools/__init__.py", line 118, in _read
    data = struct.unpack(fmt, self.data[self.index : self.index + size])[0]
struct.error: unpack requires a buffer of 4 bytes

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File ".../lib/python3.9/site-packages/gimpformats/gimpXcfDocument.py", line 81, in __init__
    self.load(fileName)
  File ".../lib/python3.9/site-packages/gimpformats/gimpXcfDocument.py", line 89, in load
    self.decode(data)
  File ".../lib/python3.9/site-packages/gimpformats/gimpXcfDocument.py", line 134, in decode
    self._propertiesDecode(ioBuf)
  File ".../lib/python3.9/site-packages/gimpformats/GimpIOBase.py", line 669, in _propertiesDecode
    self._propertyDecode(propertyType, ioBuf.getBytes(dataLength))
  File ".../lib/python3.9/site-packages/gimpformats/GimpIOBase.py", line 383, in _propertyDecode
    self.blendMode = ioBuf.u32
  File ".../lib/python3.9/site-packages/binaryiotools/__init__.py", line 362, in u32
    return self.u32be
  File ".../lib/python3.9/site-packages/binaryiotools/__init__.py", line 515, in u32be
    return self._read(4, ">I")
  File ".../lib/python3.9/site-packages/binaryiotools/__init__.py", line 120, in _read
    raise Exception(
Exception: >I 4 0 0 b''

To reproduce:

1. Open GIMP, make a new image, add a layer group, drag the background layer into it, and save as test.xcf.
2. Code:

from gimpformats.gimpXcfDocument import GimpDocument

img = GimpDocument('test.xcf')
img.image.show()

Result:

Traceback (most recent call last):
  File "tst.py", line 4, in <module>
    img.image.show()
  File "venv/lib/python3.8/site-packages/gimpformats/gimpXcfDocument.py", line 335, in image
    while layers[index].itemPath is not None:
IndexError: list index out of range

Expected result: The merged image is displayed.

File which causes the error: test.xcf.gz

from gimpformats.gimpXcfDocument import GimpDocument
imagepath = 'borders.xcf'
doc = GimpDocument(imagepath)

Produces the follow dump:

Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/home/ismael/miniconda3/lib/python3.7/site-packages/gimpformats/gimpXcfDocument.py", line 65, in __init__
    self.load(fileName)
  File "/home/ismael/miniconda3/lib/python3.7/site-packages/gimpformats/gimpXcfDocument.py", line 82, in load
    self.decode(data)
  File "/home/ismael/miniconda3/lib/python3.7/site-packages/gimpformats/gimpXcfDocument.py", line 121, in decode
    self._propertiesDecode(ioBuf)
  File "/home/ismael/miniconda3/lib/python3.7/site-packages/gimpformats/GimpIOBase.py", line 703, in _propertiesDecode
    self._propertyDecode(propertyType, ioBuf.getBytes(dataLength))
  File "/home/ismael/miniconda3/lib/python3.7/site-packages/gimpformats/GimpIOBase.py", line 441, in _propertyDecode
    self._guidelinesDecode(data)
  File "/home/ismael/miniconda3/lib/python3.7/site-packages/gimpformats/GimpIOBase.py", line 286, in _guidelinesDecode
    isVertical = struct.unpack(">B", data[index])[0] == 2
TypeError: a bytes-like object is required, not 'int'

It looks like it's likely caused by changes to bytes and str and between old and newer version of python. I'll update this "issue" as I get more detailed information. In the meantime, I'm sure you must already know or is this possibly a dead project?

See https://xcf.zerostem.io/

This tool uses gimp scripting to generate xcf files with various combinations of layer blending. It exports each one as a png with gimp, gimpformats, layeredimage, and xcftools and compares the results. In gimpformats the conversion is done like this:

img = GimpDocument(...)
img.image.save(...)

Then it compares the png files. If any channel value differs by more than 8 then the test fails.

Of 648 tests, 550 failed.

• [ ] Documentation update
• [X] Bug fix
• [ ] New feature
• [ ] Other, please explain:

Changes

• Fix mask property method to return the mask image data
• Changes the image() property method to return nested lists for nested groups
• Adjusts flattenLayerOrGroup() function to not apply offsets when rendering group layer
• Adds unit tests for group masks (test/group_masks/test.py)

Issue

No issue raised. Appears to be a regression.

System info

• OS:

  Linux excession 5.14.0-2-amd64 #1 SMP Debian 5.14.9-2 (2021-10-03) x86_64 GNU/Linux
  

• Version:

  $ python
  Python 3.9.8 (main, Nov  7 2021, 15:47:09) 
  [GCC 11.2.0] on linux
  

Describe the bug

When using Python 3.9 importing gimpformats results in a TypeError:

>>> from gimpformats.gimpXcfDocument import GimpDocument
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File ".../gimpformats/gimpXcfDocument.py", line 23, in <module>
    from . import utils
  File ".../gimpformats/utils.py", line 6, in <module>
    def fileOpen(fileName: BytesIO | str) -> tuple[str, bytes]:
TypeError: unsupported operand type(s) for |: 'type' and 'type'

Using a pipe for writing union types is only supported from Python 3.10 (PEP604)

https://github.com/FHPythonUtils/GimpFormats/blob/7475dbce123519fb0498b9d4e52ae85fdec29890/test/test.py#L15-L20

This issue was generated by todo based on a TODO comment in 7475dbce123519fb0498b9d4e52ae85fdec29890. It's been assigned to @FredHappyface because they committed the code.

Beep boop. Your images are optimized!

Your image file size has been reduced by 9% 🎉

📝 docs | :octocat: repo | 🙋🏾 issues | 🏪 marketplace

~Imgbot - Part of Optimole family

Beep boop. Your images are optimized!

Your image file size has been reduced by 12% 🎉

Black Lives Matter | 💰 donate | 🎓 learn | ✍🏾 sign

📝 docs | :octocat: repo | 🙋🏾 issues | 🏅 swag | 🏪 marketplace

This project needs a heck of a lot of attention to whip it into shape. So if you find this useful then contributions are strongly encouraged.

At the moment I simply don't have the time to dedicate to a rewrite (which is realistically what's needed) and so as things stand: when things break and cannot be easily fixed then the project will be deprecated.

Tasks

• Reduce duplication in this module and any existing modules (for instance investigate any rle implementations)
• Improved binary read/ handling implementation over binaryutils

These 2 changes alone should significantly improve the situation replacing hacked together code with more rigorously tested dependencies