Add BCn encoders/decoders with RDO support#1167
Conversation
Signed-off-by: Walid Chtioui <walid.chtioui.main@gmail.com>
Signed-off-by: Walid Chtioui <walid.chtioui.main@gmail.com>
*Add encode/decode tests (that use both CompressBCn/DecodeBCn) *Add BCn ktx2 test files (transcoded from tests/resources/ktx2/color_grid_uastc_zstd_5.ktx2) *Cleanup BCn test fixtures *Remove `std::cout` statement Signed-off-by: Walid Chtioui <walid.chtioui.main@gmail.com>
|
There are also a lot of compiler warnings from bc7enc_rdo dependency. These should be straightforward to address directly in copied files from bc7enc_rdo. |
*Add BC1, BC3, BC4, BC5, and BC7 encoding support to "ktx encode" command. *Cleanup ktxBCnParams and add BC1/BC3 quality and mode params. *Add docstrings/documentation to newly added enums/structs in ktx.h. Signed-off-by: Walid Chtioui <walid.chtioui.main@gmail.com>
|
@walcht, Thank you for this. Can you view the build logs? One issue I notice immediately is that there are no changes to Regarding RDO and multi-threading, the UASTC encoder also has separate multi-threading options for the encoder and for the RDO step. You can follow the same model. If we need to fix warnings in the encoder I suggest forking the encoder then incorporating the fork here by way of Re. SIMD and ISPC, be careful how you support this. We need to support building and running on arm64 processors. Also compile flags to enable SSE or other SIMD options are not compatible with straightforward use of universal build tool chains, which is why this project does not do universal builds. Better is use of compiler pre-defined macros and run-time queries to discover what the software is being compiled for and running on. However since we aren't doing universal builds there is no need to obsess over this last detail. |
|
@MarkCallow - Concerning the Concerning the build/CI logs: they are mostly failing because of bc7enc_rdo compiler warnings which should be suppressed. They will also fail because I haven't re-generated the golden files yet for ktx CTS (e.g.,
Please do so (as far as I understood, this will be forked under the KhronosGroup and any updates here will be pushed there via the Concerning SIMD and ISPC: I think it makes sense to leave this for another PR, do you agree? (reasoning is this: I have to get the basics working properly, add proper testsuite that covers all supported BCn formats, etc. Once that is done, I can open another PR for SIMD performance improvements). Or I will leave this to very end (last in TODO list above). |
*Suppress bc7enc_rdo warnings like unused-variables, memset'ing a non-trivial class (in this case the class is obviously trivial hence a void* cast is used to suppress this warning). Signed-off-by: Walid Chtioui <walid.chtioui.main@gmail.com>
*Some CIs report further unused variables/functions that are not reported when building locally. Signed-off-by: Walid Chtioui <walid.chtioui.main@gmail.com>
|
Updates about CI jobs:
|
|
You will need to rebase to or merge current main to get the fix for the NSIS issue on Windows. I have created a fork of https://github.com/richgel999/bc7enc_rdo. To incorporate it in your add-BCn-decoder branch do the following in the repo root directory: You can make changes in this subdirectory, as you are now, and when everything is working I can push the changes to the fork.
I agree. I wanted to make you aware that arm64 is a build target. Re. reuse, you have to add an entry to REUSE.toml to get external/bc7enc_rdo ignored. It is better to do that than add SPDX comments to all the files. The entry in REUSE.toml will have to mention a license. Use the MIT license option. Here are a few high level points.
|
|
Re the macOS build failure, because the output from the Xcode build is so voluminous it is run through a script, xcpretty, to prettify it. On a past CI service, without this, the logs exceeded the maximum allowed. Recently, for reasons I have yet to investigate, it has started swallowing compile errors. You can turn it off by editing scripts/install_macos.sh and commenting out the line that installs |
*Add BCn encoder support for `ktx create` command. *Add missing tests for `ktx encode`, `ktx extract`, and `ktx create`. *Expose BC1/BC3 approximation mode option to ktx CLIs *Misc cleanups (still early-stage PR) Signed-off-by: Walid Chtioui <walid.chtioui.main@gmail.com>
Signed-off-by: Walid Chtioui <walid.chtioui.main@gmail.com>
Agree. I wasn't initially aware of this. Apparently bc7f is significantly faster that the bc7 encoder used here (also the added benefit of being continuously maintained). I will integrate this right now since this seems to be straightforward (bc7enc_rdo also seems a bit not-longer-maintained so l think it's better to just integrate it now rather than waiting for it to be integrated into bc7enc_rdo repo). Concerning the decoding API: I added BCn decoders for VkUpload/GLUpload as a TODO (will follow same API as in etcunpack). Might also open a PR to add it for ASTC since I have already spent some time getting familiar with this code base.
Will add it in this PR. Will add it at the very end though since I have to finalize current formats.
I will try to address CI issues now (It is fine if I incrementally commit here to see if certain jobs pass?). |
Signed-off-by: Walid Chtioui <walid.chtioui.main@gmail.com>
Signed-off-by: Walid Chtioui <walid.chtioui.main@gmail.com>
…Group/bc7enc_rdo.git external/bc7enc_rdo subrepo: subdir: "external/bc7enc_rdo" merged: "dbe416d2" upstream: origin: "https://github.com/KhronosGroup/bc7enc_rdo.git" branch: "changes_for_ktx" commit: "dbe416d2" git-subrepo: version: "0.4.9" origin: "https://github.com/ingydotnet/git-subrepo" commit: "5e0f401"
*Before this commit, bc7enc_rdo dependency was manually copied to external/bc7enc_rdo directory (only needed files were copied). This was not ideal for a lot of reasons (mainly that we are introducing changes that may be streamed back to the original repo and having a subrepo/submodule is better suited for that than manually copying dependency files). *Add bc7enc_rdo to REUSE.toml with MIT license. *Git ignore compile_commands.json file (used by clangd LSP) Signed-off-by: Walid Chtioui <walid.chtioui.main@gmail.com>
|
The integrated basisu_transcoder is a bit outdated (actually, significantly) and doesn't contain |
|
I was not aware that bc7f is included in basisu_transcoder. By pure coincidence I have just completed integration of Basis Universal release 2.1.0. See the Neither the KTX-Software code nor our golden files required any updates for our extensive test suite to pass with BU 2.1.0. I am therefore amenable to merging it now but will have to discuss within the Khronos WG and can't make any promises. The single image decoders used by GLUpload/VkUpload should be exposed in the library API but must be independent of the ktxTexture* classes. Software reading a KTX file incrementally will find them useful. Regarding the current ETC decoder, please note that it does not have a recognized open source license so might not be suitable for your OIIO work. |
*Add initial RDO post processing step for BC1, BC3, and BC7 but without ultrasmooth blocks support see: https://richg42.blogspot.com/2021/02/updated-bc7encrdo-with-improved-smooth.html *Fix encoder in case input texture does not have multiple-of-4 dimensions. This was reading beyond std::vector size before this commit. *Add initial RDO params to BCnParams with verbose explanation/description comments. *Misc refactoring/adjustments. Signed-off-by: Walid Chtioui <walid.chtioui.main@gmail.com>
|
@MarkCallow - please don't approve the CI workflow yet (it will fail because I haven't updated the golden test files yet).
Will add bc7f once I finish RDO post processing. |
|
I have just merged PR #1170 so you will now find bc7f in One other thing re. |
Signed-off-by: Walid Chtioui <walid.chtioui.main@gmail.com>
Signed-off-by: Walid Chtioui <walid.chtioui.main@gmail.com>
That would be wonderful but let's wait until we get the BCn related stuff finished. There is already a workflow to run clang-format but the calls to it in other workflows are commented out. This is because several changes are needed in the formatting for some minor tweaks and to avoid breaking some files. We had a contractor who put in place these format-related items but the contract came to an end before the various issues could be addressed. I will have to find the closed PR where I listed the issues and refresh my memory.
Thanks for the this. I am a Vim user too. Is this a custom thing you did or is it a standard Vim extension? |
Agree. Either way, adding clang-format checks to CI should be fairly simple.
Only using built-in commands/cli-invocations. I'm mostly using NeoVim but this should also work on Vim: To format a selection of lines:
Or for formatting the whole file (this is what I usually do, then I revert hunks that I didn't change):
|
|
While adding actual robust testing to non-CTS tests (i.e., don't just check that decoding worked fine but compare the underlying data with original input within 0.08 tolerance), I found 2 more issues:
|
*Without this, ktxdiff fails with "Mismatching header" on RGB16 SFLOAT input. Signed-off-by: Walid Chtioui <walid.chtioui.main@gmail.com>
*So that tests can compare decoded BCn KTX2 files with original files without failing because of different KVD. Signed-off-by: Walid Chtioui <walid.chtioui.main@gmail.com>
*Previously these unorm PNG BCn inputs had sRGB colorspace and were converted via --assign-tf in ktx create calls. *Remove (i.e., set to 0) unused channels (e.g., for rg8_unorm_bc5, set B to 0 using oiiotool). See genktx2 for exact command. Signed-off-by: Walid Chtioui <walid.chtioui.main@gmail.com>
*Add option to write failed ktxdiff BCn decode tests to temporary location (in build/Testing/Temporary/GeneratedFiles/). *Update CTS submodule to always use supercompression in tests when RDO is used. *Significantly improve BCn decoder and encoder testing via differential testing with UASTC -> BCn transcode files. Signed-off-by: Walid Chtioui <walid.chtioui.main@gmail.com>
Signed-off-by: Walid Chtioui <walid.chtioui.main@gmail.com>
*Just to keep this as similar as possible with UASTC RDO options albeit --uastc-rdo-m may affect determinism while --bcn-rdo-m whether present or not will always result in same output. Signed-off-by: Walid Chtioui <walid.chtioui.main@gmail.com>
Signed-off-by: Walid Chtioui <walid.chtioui.main@gmail.com>
Signed-off-by: Walid Chtioui <walid.chtioui.main@gmail.com>
|
@walcht, Please do not add any more commits to this PR until I tell you I have completed my review. Probably it will take me a couple more days. |
| switch (bcn) { | ||
| case KTX_BCN_COMPRESSION_BC1: | ||
| case KTX_BCN_COMPRESSION_BC1A: | ||
| expectedCompressedSize = BC1_BLOCK_SIZE * nBlocks; |
There was a problem hiding this comment.
You are calculating nblocks using a common block size for all BCn. If the block sizes for some BCn types is different, won't nblocks be incorrect for those?
| D3D10 docs on BC1. </td></tr> | ||
| <tr><td>nvidia </td> <td> NVidia GPU mode. May produce artifacts on non-NVidia GPUs. </td></tr> | ||
| <tr><td>amd </td> <td> AMD GPU mode. May produce artifacts on non-AMD GPUs. </td></tr> | ||
| <tr><td>ideal </td> <td> Matches AMD Compressonator's output. Rounds 4-color colors 2,3 |
There was a problem hiding this comment.
Second meaning for "ideal". I suspect the first is the correct one.
Do you know anything about these modes? I am concerned about having vendor-specific images carried in a standardized file format without any indication of such. If these modes are truly useful, we must consider adding metadata to indicate the file is carrying vendor-specific data.
I am very tempted to say "support only the ideal D3D10 mode", especially given the note at line 58 below, but I have no idea how that will work on D3D9 or indeed D3D11 or 12."
|
@MarkCallow - before I push the commits that address the reviews above, I need to know your opinion about some decisions/choices (see my comments above on some of your reviews). Note: I'm back on my main PC so I will be answering faster from now on. |
*Remove vendor-specific BC1 approximation mode option and use default (Ideal).
*Add src/bcn_common.h to CMakeLists.txt's source files.
*Fix default values for ktxBCnParams struct. Now = {0} is supported and well
documented and is aligned with ktx tools default values.
*Add BC1 'faster' encoding quality option.
*Remove ktxBC1UnpackParams and use defaults.
*Remove confusing BCN_BLOCK_SIZE constant and replace with the literal '4'.
*Handle case where a supercompressed texture is provided to
ktxTexture2_CompressBCnEx().
*Use internal includes (with "") instead of external includes (with <>) for
internal files.
*Replace USAGE_MSG() macro from ktxdiff with an actual function.
*Add --skip-kvd option in ktxdiff for transcoded textures.
*Remove ugly path in ktx create/encode that relies on REGEX to remove
'--thread N' substring from KVD metadata.
*Add ASTC-to-ASTC, BCn-to-ASTC and ASTC-to-BCn checks and corresponding fatal
messages (alongside tests in CTS).
*Remove duplicate _CRT_SECURE_NO_WARNINGS warning suppression on Windows.
*Add BCn support to metrics_utils.
*Misc refactoring and duplicate code removal.
Signed-off-by: Walid Chtioui <walid.chtioui.main@gmail.com>
Signed-off-by: Walid Chtioui <walid.chtioui.main@gmail.com>
Signed-off-by: Walid Chtioui <walid.chtioui.main@gmail.com>
Signed-off-by: Walid Chtioui <walid.chtioui.main@gmail.com>
Signed-off-by: Walid Chtioui <walid.chtioui.main@gmail.com>
*fs::remove() was wrongly and inconsistently used which caused exceptions to be risen, weirdly, only on Windows. Signed-off-by: Walid Chtioui <walid.chtioui.main@gmail.com>
|
I have no idea why Windows CI fail (see https://github.com/KhronosGroup/KTX-Software/actions/runs/28717380966/job/85161079973?pr=1167). Probably a network glitch and re-running these jobs will make them pass (they all pass on all my machines; Linux and Windows). |
I do not see any comment from you in the unresolved review issues. I will review the changes since my review. Maybe they are there. |
I just triggered a re-run. |
I put some comments as answers to your review comments (e.g., https://github.com/KhronosGroup/KTX-Software/pull/1167/changes/BASE..e1523147da1256c69ed8c66e05b8b36dbb7539a6#diff-b7372a1fed46c5b6da9d108575ed837e61c1973ec07b237cee1166f3b1f7a971). They are mainly about the approaches I took to solve reviewed problems.
Thanks. Now they all pass (was a Windows runner network glitch). |
|
I have a PR in flight to update the ASTC encoder to the latest release. I would like to merge it for v5.0.0, i.e. before this PR. There is a very small API change when calling the ASTC decoder and also an updated TinyEXR which causes .exr files extracted via ktx extract to be slightly different, a difference I have not been able to spot with my eyes. Thus some golden files for some extract files have to be updated. I do not think any of this conflicts with what you are doing here but I want to check with you. Please let me know. |
This will probably not cause any issues. I think this BCn PR only uses one (or at most a couple) or .exr files to only test BC6H format. (even if it does, should be very simple to address/fix). Once that PR is merged, I will update main to see if CIs pass. |
As discussed in #1159:
ktxTexture2_CompressBCnandktxTexture2_DecodeBCnare introduced in this PR to allow libktx users/consumers to encode/decode BCn textures from/to raw decompressed formats.https://github.com/richgel999/bc7enc_rdo does not support BC6HU/BC6HS encoding/decoding and also no BC2 (this format is essentially dead since BC3 replaces it).
Please feel free to give feedback, edit, and nitpick as much as possible.
Some context: I am adding KTX2 support to OIIO (PR: AcademySoftwareFoundation/OpenImageIO#5185) and having libktx encode/decode BCn formats significantly simplifies things (also ETC encoding/decoding which I can also open a PR for - if approved).
I haven't updated the KTX-Software-CTS with the added BCn test files.
Once this is finalized, this will fix #587.
Current TODOs:
[x] BC2 mode RDOBC2 is rarely used (I don't see any reason why to use it instead of BC3). Postponed or not planned to be implemented at all.BC6H mode RDO (HDR). I don't know if this is possible. If not, then I will not adjust the ert::reduce_entropy function for the moment.postponed (too much work/overload to include in this PR).ktx encodecommandktx extractcommandktx createcommandktxBCnParamsstruct (apparently there are many and I am not qualified to know which subset to expose or to expose them all). For the moment I will just expose them all.We agreed on using same parameters as UASTC RDO and adding additional ones if they make sense (I haven't benchmarked skip 0 MSE error option so I might remove it if it useless).
enable SIMD acceleration for BC7 encoder (using ISPC - see https://github.com/ispc/ispc) (this should be straightforward and should be enabled by default via a CMake flag; e.g., BC7_SIMD).=> since we are planning to use bc7f we will be planning to use bc7g once it is released (this is the SIMD equivalent of bc7f).LIBKTX_FEATURE_BCN_DECODERCMake flag optioncopied from MIT Licensed https://github.com/iOrange/bcdecfrom basisu)[x] add BC2 encoderpostponed/aborted (rarely used).Note1: no LLMs/AI coding tools were used in any capacity whatsoever in writing or aiding in the writing of this PR.
Note2: I am an individual contributor (main reason I am contributing here is to add support for KTX2 in Blender).
Edit: TODO list edits