- Follow the best practices of https://reuse.software/ to ensure BSD-3 licence is correctly applied.
- Add a badge to README.md
- Note: remove arm build as the CI pipeline is broken for this architecture
The main purpose of golomb_code_match is to see if there is a precomputed match which allows to just skip the bytes.
Rename the struct to make it clear it is not the actual glomb code itself.
Update the golomb_code_match struct back into a POD. The Windows x64 ABI cannot return non-POD structs in a single register even when the would fit.
By design the benchmark project is not build as it relies on Google Benchmark that is retrieved using vcpkg.
Vcpkg is now part of Visual Studio 2022, so building with VS 2022 works.
One of the build steps of the CI pipeline build CharLS however with VS 2019 to ensure that VS 2019 still can be used. Enabled benchmark in the solution file for x86 and X64 would break VS 2019.
ARM64 build are only support in VS 2022, so enabling that version doesn't break VS 2019.
To make it more clear to users and tooling that the project is a C++ project use the extension .hpp for pure C++ headers.
Add a new public header file charls.hpp. External C++ projects should this header file, C projects should still use charls.h.
The Azure CI Pipeline can analyze code coverage when running the unit tests. Enable this option. It provides an additional tab on the CI status report. On this tab a single code coverage number is displayed. The .coverage file can be downloaded and opened in Visual Studio to get more insights.
Only the debug DLL is code covered as it provided a good report. The release build has too many optimalizations to provide a report that is useful.
Note 1: The unit test DLL needs to link with the CharLS .obj files to make it possible to unit test low level methods. This means however the the unit test DLL needs to be code covered and not the actual CharLS DLL.
Note 2: the Cobertura format was also tested, but it didn't provide additional details (only more warnings and complexity)
Enable code coverage in CI pipeline
- Use structured binding (when it makes sense)
- Add [[nodiscard]]
- Disable structured binding ReSharper warnings (it also advises to use structured binding for variables that will explode in too many parameters)
CharLS doesn't support mixing interleave modes.
Add a unit test to ensure that CharLS will throw a not supported exception.
The actual checking was already done.
Note: also resolve some static analyzer warnings, reported with the latest version of ReSharper\clang-tidy.
The destructor of std::ofstream will close the stream, but not report any failures (by design).
Call close to trigger an exception when the close fails.
static_cast for constant values can be replaced with uniform initialization, this allows
to reduce the number of static_casts.
Change the bin+intermediate to be sub-directories of build for MSBuild builds.
This makes it easier to clean.
- Rename the log_2 function into log2_ceil as that is what the function performs.
- Add unit test and benchmark test to get insights if using it in more places has benefits.
Backport C++20 countl_zero
1) countl_zero can be used in peek_0_bits and is 2X faster.
Note: peek_0_bits is not on a hot path, overall gain is limited.
2) Apply updates for clang-tidy v13 (ships with VS 2022 17.1 Preview 2)
3) Increase upper range of supported CMake to 3.22
* Add an initial benchmark project to research optimizations.
* Use memchr to search for 0xFF during decoding.
* Rename function to make intent more clear.
* Use const pointers (decoding only need to read).
