AVIF support #115

salty-ivy · 2023-06-25T09:25:48Z

Fixed #111

Before

After

figure out how the pillow heic imports functionality
figure out how Wagtial uses Pillow HEIC for to see how to copy the approach
sketch out a design or update this issue with some ideas
write an implementation for using this in a fork of Wagtail
add some tests
show example of use
figure out how to get into this into Bakery Demo
figure out next steps

salty-ivy · 2023-06-25T09:29:41Z

@thibaudcolas I have opened a draft, only tests are left although I am not sure about quality and lossless
in function save_as_avif I do understand these properties, just no sure about what values should be passed in this case.

Stormheg · 2023-06-25T15:38:04Z

Thanks @salty-ivy 👏

It makes me very happy to see AVIF support added to Wagtail.

thibaudcolas

Looking really solid @salty-ivy! This is going to be such a big change for us 🥳 @zerolab could you review this as well as we discussed?

I gave it a try and it worked a treat. There are a few things to change in the code and as you noted documentation (README, reference.rst).

I think we should additionally add save_as_heic to the README – and mention for it and save_as_avif that they’re only available in Pillow for people who install pillow-heif.

Record of my trial for future ref, with walnuts.jpg from our bakerydemo.

source = open('tests/images/walnuts.jpg', 'rb')
out_avif = open('walnuts.avif', 'wb')
out_webp = open('walnuts.webp', 'wb')
source_img = Image.open(source)
source_img.save_as_webp(out_webp)
source_img.save_as_avif(out_avif)
out_webp.close()
out_avif.close()
out_avif_40 = open('walnuts-40.avif', 'wb')
out_webp_40 = open('walnuts-40.webp', 'wb')
source_img.save_as_avif(out_avif_40, quality=40)
out_avif_40.close()
source_img.save_as_webp(out_webp_40, quality=40)
out_webp_40.close()

File sizes (rounded) for ref:

192K	tests/images/walnuts.jpg
 40K	walnuts-40.avif
 60K	walnuts-40.webp
160K	walnuts.avif
128K	walnuts.webp

tests/images/tree-avif.avif

willow/image.py

tests/test_pillow.py

tests/test_image.py

thibaudcolas · 2023-06-27T05:45:57Z

willow/image.py

@@ -252,6 +252,7 @@ def __init__(self, f, dom=None):
            self.dom = ElementTree.parse(f)
            f.seek(0)
        else:
+


Suggested change

should we go for chroma=420 default way? then.

thibaudcolas · 2023-06-27T06:04:32Z

willow/plugins/pillow.py

+    def save_as_avif(self, f, quality=80, lossless=False):
+        if lossless:
+            self.image.save(f, 'AVIF', quality=-1, chroma=444)
+        else:
+            self.image.save(f, 'AVIF', quality=quality)


Might be one for later but I’m surprised we’d not make the chroma subsampling configurable 🤔 I don’t know whether the default is 4:2:2 or 4:2:0 but I could imagine scenarios where we’d want to change it.

note to self: https://pillow-heif.readthedocs.io/en/latest/options.html mentions chroma=444 is to be using lossless encoding.

there's no stopping us from doing

@Image.operation def save_as_avif(self, f, quality=80, lossless=False, chroma: int = 420): if lossless: self.image.save(f, 'AVIF', quality=-1, chroma=444) else: self.image.save(f, 'AVIF', quality=quality, chroma=chroma)

at the same time, we will want to document some best practices on chroma and to be honest this is not something I fully understand (yet)

Found https://github.com/bigcat88/pillow_heif/blob/891d3fcef08eb03066f557ccef8fdc2492fd1c40/CHANGELOG.md?plain=1#L191 which mentions 420 (4:2:0) is the default

It would be good to document the quality kwarg, and what the different values mean (Possible values: None, -1, range(0-100). Set -1 for lossless quality or from 0 to 100, where 0 is lowest and 100 is highest.)

If we are to support pillow-avif-plugin as an alternative to pillow-heif, then this becomes more complicated - https://github.com/fdintino/pillow-avif-plugin/blob/master/src/pillow_avif/AvifImagePlugin.py#L130-L137. The latter plugin has a corresponding PR for Pillow - python-pillow/Pillow#5201

salty-ivy · 2023-06-27T09:07:20Z

Also this considering this comment by @mrchrisadams wagtail/wagtail#10486 (comment)

should we try to save them as lossless=True ?

zerolab · 2023-06-27T10:02:36Z

should we try to save them as lossless=True ?

We don't do this for any other types, so.. no. Only for the original rendition in Wagtail

.gitignore

zerolab · 2023-06-28T09:56:50Z

In addition, it would be good to add a note about lossless AVIF in docs/guide/save.rst (similar to

Willow/docs/guide/save.rst

Lines 49 to 58 in 4eac48a

    
           Lossless WebP 
        
           ----------------- 
        
           You can encode the image to WebP without any loss by setting the 
        
           ``lossless`` keyword argument to ``True``: 
        
           .. code-block:: python 
        
               with open('lossless.webp', 'wb') as f: 
        
                   i.save_as_webp(f, lossless=True)

)

salty-ivy · 2023-06-28T10:01:53Z

@zerolab apologies if the question is too obvious but are we supporting avif with lossless=True ?

zerolab · 2023-06-28T10:56:44Z

@zerolab apologies if the question is too obvious but are we supporting avif with lossless=True ?

That is what https://github.com/wagtail/Willow/pull/115/files#diff-a804be079e5771c0e82b11e493ad11d319d34d042b33871a729f5eb151ace339R228-R229 does, no?

salty-ivy · 2023-06-28T11:29:12Z

yup, I thought by default that Is default value.

@zerolab apologies if the question is too obvious but are we supporting avif with lossless=True ?

That is what https://github.com/wagtail/Willow/pull/115/files#diff-a804be079e5771c0e82b11e493ad11d319d34d042b33871a729f5eb151ace339R228-R229 does, no?

Yes I thought of it as default( default argument to True ) or not but I guess I understand now! as we wouldn't do it by default that is the right way and how other save_as have been configured.

salty-ivy · 2023-06-29T06:03:04Z

@zerolab @thibaudcolas Could you guys confirm or have any idea.
Looks like there's some issue while running runtests.py

Traceback (most recent call last):
  File "/Users/apple/Desktop/open-source/wagtail/Willow/runtests.py", line 11, in <module>
    from tests.test_wand import *  # noqa: F403
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/apple/Desktop/open-source/wagtail/Willow/tests/test_wand.py", line 16, in <module>
    no_webp_support = not WandImage.is_format_supported("WEBP")
                          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/apple/Desktop/open-source/wagtail/Willow/willow/plugins/wand.py", line 64, in is_format_supported
    return bool(_wand_version().formats(image_format))
                ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/Users/apple/Desktop/open-source/wagtail/willow-dev/lib/python3.11/site-packages/wand/version.py", line 264, in formats
    library.MagickWandGenesis()
    ^^^^^^^
NameError: name 'library' is not defined

seems to be originating from wand from this line https://github.com/emcconville/wand/blob/11e37fc9d7f9e3375f34e381b3a73cbbdc8517ec/wand/version.py#L263

setup.py

tests/test_pillow.py

zerolab · 2023-06-29T15:53:05Z

willow/plugins/pillow.py

+    @Image.operation
+    def save_as_avif(self, f, quality=80, lossless=False):
+        if lossless:
+            self.image.save(f, "AVIF", quality=-1, chroma=444)


nitpick: since we're basing this on pillow-heif, it would be great to document what these magic values mean

https://github.com/bigcat88/pillow_heif/blob/891d3fcef08eb03066f557ccef8fdc2492fd1c40/pillow_heif/options.py#L21-L26

also, we need an entry about lossless AVIF at https://github.com/wagtail/Willow/blob/main/docs/guide/save.rst?plain=1#L49

I think the lossless save test for Avif is failing for some reason need to look at that as well.

Looking at pillow_heif, they admit a small variation of about 1%

https://github.com/bigcat88/pillow_heif/blob/master/tests/write_test.py#L415-L422 and https://github.com/bigcat88/pillow_heif/blob/3798f0df6b12c19dfa8fd76dd6259b329bf88029/tests/helpers.py#L39-L48

zerolab

This is so close, needs a bit more documentation and I think we're good

salty-ivy · 2023-06-29T19:06:27Z

@zerolabn both heic and avif seems to fail at saving the file as completely lossless I.e lossless=True

zerolab · 2023-06-30T08:06:27Z

@salty-ivy will have a look later today and advise on next steps

tests/test_image.py

tests/test_pillow.py

willow/plugins/wand.py

salty-ivy · 2023-07-01T14:42:16Z

Few finale questions....

Should we have mention WebP, AVIF and HEIC all at once in LOSSLESS section in save.rst.
Should I also include lossless test for AVIF in test_wand.py as well?
Why does lossless test for webP in test_wand.py fails in local testing?

zerolab

Added further suggestions.
I am not sure why the webp test fails locally yet, but will check and get to you later

docs/guide/save.rst

zerolab · 2023-07-03T09:21:13Z

docs/guide/save.rst

 -----------------

-You can encode the image to WebP without any loss by setting the
+You can encode the image to Avif, Heic (only pillow) and WebP without any loss by setting the


Suggested change

You can encode the image to Avif, Heic (only pillow) and WebP without any loss by setting the

You can encode the image to AVIF, HEIC (Pillow-only) and WebP without any loss by setting the

note that ImageMagick (thus Wand) supports HEIC via libheif since version 7.1.0. Opened #119

we can change the docs further in that PR, would you mind if I take up that issue as well?

Happy for you to take it on, once this and the Wagtail continuation are done

docs/reference.rst

tests/test_pillow.py

tests/test_wand.py

willow/plugins/wand.py

mrchrisadams

Hi @salty-ivy as discussed, I've had a quick look over this - I only saw a few small typos, but I had one qn - if one of the benefits of the AVIF support is that the files are smaller, do you think it might be worth having a test to demontrate this?

I know it's venturing into testing the properties of format rather than the library implementing it, but it may be useufl to demonstrating the benefits it's supposed to bring,.

tests/test_wand.py

docs/reference.rst

docs/guide/save.rst

salty-ivy · 2023-07-03T12:11:33Z

@mrchrisadams That's a great idea! How about having a test where where we open one format and check the size and then save as Avif and assert the new size to be smaller ? Or something like that if I have understood it correctly?

mrchrisadams · 2023-07-03T15:30:49Z

hi @salty-ivy - yes, that was what I was thinking. I was a bit wary that it might go outside the scope of adding support, so I would defer to the maintainers.

Hope that helps!

tests/test_wand.py

willow/plugins/wand.py

tests/test_wand.py

Co-Authored-By: zerolab <dan@zerolab.org>

zerolab · 2023-07-10T14:06:45Z

A few notes on avif/webp conversion using ImageMagick:

convert tests/images/transparent.png -define heic:lossless=true tests/images/lossless.avif
magick compare tests/images/transparent.png tests/images/lossless.avif -compose Src tests/images/compare-avif.png

convert tests/images/tree.avif -define heic:lossless=true tests/images/lossless.avif
magick compare tests/images/tree.avif tests/images/lossless.avif -compose Src tests/images/compare.avif

and

convert tests/images/transparent.png -define webp:lossless=true tests/images/lossless.webp
# or
convert tests/images/transparent.png -define webp:lossless=true -define webp:exact=true tests/images/lossless.webp

magick compare tests/images/transparent.png tests/images/lossless.webp -compose Src tests/images/compare-webp.png


convert tests/images/tree.avif -define heic:lossless=true tests/images/lossless.avif
magick compare tests/images/tree.avif tests/images/lossless.avif -compose Src tests/images/compare.avif

will show some artifacts, depending on the ImageMagick version. Which explain the test failures.

Anyhow, this now looks good. Thank you for all your work, @salty-ivy! And everyone for your inputs

Stormheg · 2023-07-10T14:46:18Z

Yay! Thanks all for your work! ❤️

salty-ivy mentioned this pull request Jun 25, 2023

AVIF support in Wagtail wagtail/wagtail#10486

Closed

salty-ivy marked this pull request as ready for review June 25, 2023 11:09

thibaudcolas requested changes Jun 27, 2023

View reviewed changes

thibaudcolas requested a review from zerolab June 27, 2023 06:27

thibaudcolas added the enhancement label Jun 27, 2023

laymonage assigned zerolab Jun 27, 2023

zerolab reviewed Jun 28, 2023

View reviewed changes

.gitignore Outdated Show resolved Hide resolved

zerolab added status:Needs Review status:Needs Docs status:Needs Work and removed status:Needs Review labels Jun 28, 2023

zerolab reviewed Jun 29, 2023

View reviewed changes

setup.py Outdated Show resolved Hide resolved

salty-ivy requested a review from zerolab June 29, 2023 15:28

zerolab reviewed Jun 29, 2023

View reviewed changes

setup.py Outdated Show resolved Hide resolved

zerolab reviewed Jun 29, 2023

View reviewed changes

tests/test_pillow.py Outdated Show resolved Hide resolved

zerolab reviewed Jun 29, 2023

View reviewed changes

zerolab requested changes Jun 29, 2023

View reviewed changes

zerolab reviewed Jun 30, 2023

View reviewed changes

tests/test_image.py Outdated Show resolved Hide resolved

zerolab reviewed Jun 30, 2023

View reviewed changes

tests/test_pillow.py Outdated Show resolved Hide resolved

zerolab reviewed Jun 30, 2023

View reviewed changes

willow/plugins/wand.py Show resolved Hide resolved

salty-ivy requested a review from zerolab July 1, 2023 11:08

salty-ivy requested a review from thibaudcolas July 1, 2023 15:18

zerolab requested changes Jul 3, 2023

View reviewed changes

mrchrisadams reviewed Jul 3, 2023

View reviewed changes

tests/test_wand.py Outdated Show resolved Hide resolved

docs/reference.rst Outdated Show resolved Hide resolved

docs/guide/save.rst Outdated Show resolved Hide resolved

salty-ivy requested a review from zerolab July 3, 2023 16:11

zerolab reviewed Jul 4, 2023

View reviewed changes

tests/test_wand.py Outdated Show resolved Hide resolved

zerolab reviewed Jul 4, 2023

View reviewed changes

willow/plugins/wand.py Outdated Show resolved Hide resolved

zerolab reviewed Jul 4, 2023

View reviewed changes

tests/test_wand.py Outdated Show resolved Hide resolved

salty-ivy requested a review from zerolab July 4, 2023 16:02

salty-ivy and others added 3 commits July 8, 2023 20:51

Add support for AVIF

5b62f87

Add tests

0a8ffe6

Co-Authored-By: zerolab <dan@zerolab.org>

Update documentation for AVIF support

9fe9f80

zerolab force-pushed the avif-support branch from e6f4f25 to 9fe9f80 Compare July 10, 2023 14:01

zerolab approved these changes Jul 10, 2023

View reviewed changes

zerolab merged commit e076c34 into wagtail:main Jul 10, 2023
6 checks passed

salty-ivy mentioned this pull request Jul 10, 2023

AVIF support for wagtail wagtail/wagtail#10657

Merged

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

AVIF support #115

AVIF support #115

salty-ivy commented Jun 25, 2023 •

edited

Loading

salty-ivy commented Jun 25, 2023

Stormheg commented Jun 25, 2023

thibaudcolas left a comment

thibaudcolas Jun 27, 2023

salty-ivy Jun 29, 2023

thibaudcolas Jun 27, 2023

zerolab Jun 27, 2023

salty-ivy commented Jun 27, 2023 •

edited

Loading

zerolab commented Jun 27, 2023

zerolab commented Jun 28, 2023 •

edited

Loading

salty-ivy commented Jun 28, 2023 •

edited

Loading

zerolab commented Jun 28, 2023

salty-ivy commented Jun 28, 2023

salty-ivy commented Jun 29, 2023

zerolab Jun 29, 2023

zerolab Jun 29, 2023

salty-ivy Jun 29, 2023

zerolab Jul 8, 2023

zerolab left a comment

salty-ivy commented Jun 29, 2023

zerolab commented Jun 30, 2023

salty-ivy commented Jul 1, 2023 •

edited

Loading

zerolab left a comment

zerolab Jul 3, 2023

salty-ivy Jul 3, 2023

zerolab Jul 3, 2023

mrchrisadams left a comment

salty-ivy commented Jul 3, 2023 •

edited

Loading

mrchrisadams commented Jul 3, 2023

zerolab commented Jul 10, 2023 •

edited

Loading

Stormheg commented Jul 10, 2023

	You can encode the image to Avif, Heic (only pillow) and WebP without any loss by setting the
	You can encode the image to AVIF, HEIC (Pillow-only) and WebP without any loss by setting the

AVIF support #115

AVIF support #115

Conversation

salty-ivy commented Jun 25, 2023 • edited Loading

Before

After

salty-ivy commented Jun 25, 2023

Stormheg commented Jun 25, 2023

thibaudcolas left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

salty-ivy commented Jun 27, 2023 • edited Loading

zerolab commented Jun 27, 2023

zerolab commented Jun 28, 2023 • edited Loading

salty-ivy commented Jun 28, 2023 • edited Loading

zerolab commented Jun 28, 2023

salty-ivy commented Jun 28, 2023

salty-ivy commented Jun 29, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zerolab left a comment

Choose a reason for hiding this comment

salty-ivy commented Jun 29, 2023

zerolab commented Jun 30, 2023

salty-ivy commented Jul 1, 2023 • edited Loading

zerolab left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mrchrisadams left a comment

Choose a reason for hiding this comment

salty-ivy commented Jul 3, 2023 • edited Loading

mrchrisadams commented Jul 3, 2023

zerolab commented Jul 10, 2023 • edited Loading

Stormheg commented Jul 10, 2023

salty-ivy commented Jun 25, 2023 •

edited

Loading

salty-ivy commented Jun 27, 2023 •

edited

Loading

zerolab commented Jun 28, 2023 •

edited

Loading

salty-ivy commented Jun 28, 2023 •

edited

Loading

salty-ivy commented Jul 1, 2023 •

edited

Loading

salty-ivy commented Jul 3, 2023 •

edited

Loading

zerolab commented Jul 10, 2023 •

edited

Loading