Upgrade Basis plugins to 1.15 #112

pezcode · 2021-10-19T22:08:24Z

This PR upgrades BasisImporter and BasisImageConverter to work with basis_universal 1.15 (more specifically, tag v1_15_update2 because that contains a few important changes).

Not entirely finished with everything, but the majority is there, so feel free to give it a first review 🙇

New features

Along with the upgraded dependency come a few new features:

import of all image types supported by Basis, including 2D arrays/cubemaps/cubemap arrays/3D/video as ImageData3D
KTX2 import and export, including UASTC and Zstd supercompression
- import happens transparently, with the minor caveat that 3D images are not supported. basisu itself can only generated 2D arrays for KTX2, anyway.
- in BasisImageConverter this is simply a new config option (defaults to off)
support for sRGB formats:
- in BasisImporter this is a flag read from the file header, affecting the output format
- in BasisImageConverter it's detected from the image format and sets the correct parameters for the encoder. Can be overridden by config options, if desired
support for user-supplied mipmaps in BasisImageConverter
- mipmap generation by basis is still possible, but is disabled if the user supplies their own mipmaps

Todo

Or rather: questions to @mosra

~~allow export of 3D images in BasisImageConverter? Is this a priority?~~ nope, but probably revisit once image flags are in, for cube and 2D array texture export
~~the importer code got rather messy, should I write a small abstraction over the two transcoders to make the code legible again?~~ eh, that'll just sweep the code into another corner
should we flip z in 3D images? Files have a y-flip flag so we could use that to deduce y-flip = z-flip, but I'm not sure how foolproof that is since the basisu tool doesn't do any z-flipping at all, regardless of y_flip being set nope, "solved" now that we import 3D images as 2D array layers
~~BC7RGB seems deprecated since UAST, should this go away? Investigate what this means for the output data~~ they both mean the same thing, removing the RGB variant
~~print a useful error about PVRTC1 requiring power-of-two, instead of just "transcoding failed"? However, then we won't have an easy way to test the transcoding failing 🤡~~ PVRTC is pretty ancient, not worth the extra effort
more validation on .basis files. The KTX2 transcoder does all that, but the basis transcoder is missing a few checks we need, e.g. all array layers having the same size.
update the config options, there are a few new ones , some of them seem obsolete and we should add some comments (just take whatever basisu itself says). Also: the docs say the config options follow the basisu tool, and the .conf file says they follow the C++ API. The latter is true, but we should decide on one. I think basisu options would be more intuitive but require some extra wiring + tests...
test BasisImageConverter sRGB handling

Related issue: #110. Can be closed if this PR and the upcoming PR for KtxImporter Basis-forwarding are merged.

TODO: tests

TODO: tests, docs

If zstd can't be found by FindBasisUniversal.cmake, compile with Zstandard (de)compression support disabled. At runtime, detect this and print a useful error (instead of "transcoding failed").

This sets the correct basis parameters depending on the image format. Can still be overridden by config values, if present. TODO tests

TODO tests

Array layers, cube faces and z slices are imported in an extra image dimension, ie. Image3D. Image type is exposed via texture(). TODO tests, docs, some extra validation on .basis files

basisu doesn't do it for us, only in .basis files

whoops

Removed from the basisu C++ API, can be replaced by swizzle=rrrg

basisu doesn't flip level 1 or higher

All mipmaps in basis are 2D, but they'd need to halve in Z for correct 3D mipmaps. Print a warning and import them as 2D array textures with mipmaps instead.

pezcode · 2021-10-20T12:36:52Z

I realized that importing video files as a single Image3D is probably not what you'd want most of the time, assuming the average video is rather rather large. I'll change that back to report multiple images, hopefully basisu saves the KTX2 animation metadata so we can detect videos in those, too.

…on, second attempt

pezcode · 2021-10-25T14:43:03Z

I have a drastic suggestion: remove big-endian detection, hoping nobody ever needs it 🤠 On CMake 3.20 we can use CMAKE_CXX_BYTE_ORDER without having to enable C and causing all these headaches.

mosra · 2021-10-25T14:44:59Z

Oh wait, so if you enable C it causes the C files to be compiled as C on static builds even though told to be compiled as CXX, and if you don't enable C the C files get properly compiled as CXX?

Or is that C enablement independent of the problem with C files being compiled as C on static builds?

# Conflicts: # src/MagnumPlugins/BasisImporter/BasisImporter.cpp # src/MagnumPlugins/BasisImporter/Test/BasisImporterTest.cpp

pezcode · 2021-10-25T14:55:48Z

Oh wait, so if you enable C it causes the C files to be compiled as C on static builds even though told to be compiled as CXX, and if you don't enable C the C files get properly compiled as CXX?

Or is that C enablement independent of the problem with C files being compiled as C on static builds?

Yeah, without enabling C it would just ignore those files altogether, causing unresolved symbol errors. When I forced CXX without enabling C, I don't remember getting these C-specific errors. I don't know what weird interactions are going wrong but I'm thinking it might not be worth the effort.

This is way too broken

…empt WSL is amazingly helpful for this

it requires CMake 3.7

… package recipe

pezcode · 2021-10-25T20:46:32Z

I went ahead and disabled the endianness detection on CMake < 3.9 for now. Maybe worth revisiting for later, but I can't remote diagnose this without force-pushing and eating all your CI minutes 🙊

There's one weird error about pthread_create missing, I assume this is related to the help text for BasisImageConverter. ~~But why is the importer linking to pthread...~~ oooo, it's zstd... the bad news is that even though basisu doesn't use anything from zstd that would use threads (as far as I can tell only the compression API needs pthread), the bundled zstd.c has a hard #define ZSTD_MULTITHREAD so we can't disable it with a compile definition. Sigh.

mosra · 2021-10-26T09:19:22Z

Okay, I'm taking over with finishing the PR, this whole thing seems (again!) way more cursed than anticipated.

src/MagnumPlugins/BasisImageConverter/BasisImageConverter.cpp

and test the converted image, not the original(??) image

G is taken from the alpha channel, matching the recommended basisu -swizzle rrrg for two channels. We don't control this, it's done by the transcoder.

…eir own This fixes the use case of feeding an RG image + swizzle rrrg (as recommended by the basis docs). This would lead to the output becoming rrrr since BasisImageConverter already performed that swizzle. Also document the behaviour.

mosra · 2021-10-31T17:11:18Z

Merged as 809fc18...670133c, with some of my commits mixed in (external zstd dependency, fix to that C language enablement craziness, ...).

The commits are regrouped and squashed into small enough logical chunks so it looks quite different from the patch set in this PR, but the total bulk of changes is the same ;) Thank you for the excellent work again!

pezcode added 27 commits October 16, 2021 19:18

Basis{ImageConverter,Importer}: update to basis_universal v1_15_update2

3bc79d8

BasisImporter: import KTX2 files

d83eb5b

TODO: tests

BasisImporter: import sRGB images with the appropriate format

09f13dd

TODO: tests, docs

BasisImporter: handle missing zstd gracefully

75e47e7

If zstd can't be found by FindBasisUniversal.cmake, compile with Zstandard (de)compression support disabled. At runtime, detect this and print a useful error (instead of "transcoding failed").

BasisImporter: add KtxImporter alias

7b9d26a

BasisImageConverter: support sRGB formats

aec8e3d

This sets the correct basis parameters depending on the image format. Can still be overridden by config values, if present. TODO tests

BasisImageConverter: support writing KTX2 files

564f380

TODO tests

BasisImageConverter: support user-supplied mip levels

256efbc

TODO tests

BasisImporter: import array/cube/3D images

c603aa5

Array layers, cube faces and z slices are imported in an extra image dimension, ie. Image3D. Image type is exposed via texture(). TODO tests, docs, some extra validation on .basis files

BasisImporter: test KTX2 and sRGB support

e7c5843

BasisImporter: test unsupported target format error

b2c3c84

BasisImageConverter: write KTX2 orientation metadata

f315885

basisu doesn't do it for us, only in .basis files

BasisImageConverter: test KTX2 export

38abfea

BasisImageConverter: fix sRGB format

7cc5707

whoops

BasisImageConverter: remove separate_rg_to_color_alpha

f1c5d05

Removed from the basisu C++ API, can be replaced by swizzle=rrrg

BasisImageConverter: test invalid swizzle values

015f24e

BasisImageConverter: expose UASTC options

3c4852d

BasisImageConverter: fix user-supplied mipmaps

426da44

basisu doesn't flip level 1 or higher

BasisImageConverter: test user-supplied mipmaps

2bb860f

BasisImageConverter: update image error thresholds

1bd045b

BasisImporter: import 3D images with mipmaps as 2D array textures

a4348cc

All mipmaps in basis are 2D, but they'd need to halve in Z for correct 3D mipmaps. Print a warning and import them as 2D array textures with mipmaps instead.

BasisImporter: fix mip level count

6f479a7

BasisImporter: fix cubemap array textures

1b78acf

BasisImporter: test all image types

85ffabb

BasisImporter: test start_transcoding failure for KTX2 files

85e46e7

BasisImporter: document image types and mipmaps

d29a013

BasisImporter: mention sRGB versions of target formats

d85bfb1

mosra added this to the 2021.0a milestone Oct 20, 2021

pezcode added 4 commits October 25, 2021 16:14

BasisImporter: remove all remaining traces of Bc7RGB

ebfb048

BasisImporter: fix array view cast on GCC 4.8, hopefully

e97ed9c

Basis{Importer,ImageConverter}: restrict and clarify enable_language(C)

08f9abd

Basis{Importer,ImageConverter}: fix AppVeyor basis_universal extracti…

be76be9

…on, second attempt

pezcode force-pushed the basis-1_15 branch from 56aa94e to 9149682 Compare October 25, 2021 14:49

Merge remote-tracking branch 'upstream/master' into basis-1_15

d7c50ca

# Conflicts: # src/MagnumPlugins/BasisImporter/BasisImporter.cpp # src/MagnumPlugins/BasisImporter/Test/BasisImporterTest.cpp

pezcode force-pushed the basis-1_15 branch from 9149682 to d7c50ca Compare October 25, 2021 14:53

pezcode added 6 commits October 25, 2021 21:35

BasisImporter: fix test image treshold

319a050

Basis{Importer,ImageConverter}: don't test for endianness on CMake < 3.9

4ff0737

This is way too broken

Basis{Importer,ImageConverter}: fix basis_universal download, 3rd att…

a5aca85

…empt WSL is amazingly helpful for this

Basis{Importer,ImageConverter}: don't use VERSION_GREATER_EQUAL

4597fb1

it requires CMake 3.7

Basis{Importer,ImageConverter}: fix basis_universal SHA1 in archlinux…

1ac0592

… package recipe

BasisImporter: oops

4f791ed

pezcode force-pushed the basis-1_15 branch from e0ba7f6 to 4f791ed Compare October 25, 2021 20:46

pezcode commented Oct 27, 2021

View reviewed changes

src/MagnumPlugins/BasisImageConverter/BasisImageConverter.cpp Outdated Show resolved Hide resolved

pezcode added 3 commits October 27, 2021 12:39

BasisImageConverter: accept multiple levels in doOpenFile

439a883

and test the converted image, not the original(??) image

BasisImporter: document two-channel format source

94b1798

G is taken from the alpha channel, matching the recommended basisu -swizzle rrrg for two channels. We don't control this, it's done by the transcoder.

pezcode mentioned this pull request Oct 29, 2021

Ktximporter: forward Basis Universal compressed images to BasisImporter #113

Closed

2 tasks

mosra added the changelog mention added label Oct 31, 2021

mosra closed this Oct 31, 2021

This was referenced Oct 31, 2021

KTX2 + Basis Universal #110

Closed

Update Basis Universal plugin for UASTC #86

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Upgrade Basis plugins to 1.15 #112

Upgrade Basis plugins to 1.15 #112

pezcode commented Oct 19, 2021 •

edited

Loading

pezcode commented Oct 20, 2021

pezcode commented Oct 25, 2021

mosra commented Oct 25, 2021 •

edited

Loading

pezcode commented Oct 25, 2021

pezcode commented Oct 25, 2021 •

edited

Loading

mosra commented Oct 26, 2021

mosra commented Oct 31, 2021

Upgrade Basis plugins to 1.15 #112

Upgrade Basis plugins to 1.15 #112

Conversation

pezcode commented Oct 19, 2021 • edited Loading

New features

Todo

pezcode commented Oct 20, 2021

pezcode commented Oct 25, 2021

mosra commented Oct 25, 2021 • edited Loading

pezcode commented Oct 25, 2021

pezcode commented Oct 25, 2021 • edited Loading

mosra commented Oct 26, 2021

mosra commented Oct 31, 2021

pezcode commented Oct 19, 2021 •

edited

Loading

mosra commented Oct 25, 2021 •

edited

Loading

pezcode commented Oct 25, 2021 •

edited

Loading