- 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
* Add support to write mapping tables to the JPEG byte stream.
* Add API method to set the table ID for a component
* Add method to create JPEG-LS file with mapping tables only.
* Add support to read mapping tables
* Parse table-ids from the scan segment
* Extend API of charls_decoder_get_mapping_table_index to return -1 if index is not found
* Add support to read mapping table continuation segments
* Document new API methods
* Add sample image from appendix H.4.5 "Example of a palletised image" / Figure H.10 to unit test
* Update the get_mapping_table API to include size of the buffer
The release of C++17 has been 5 years ago. The supported period of C++14 has ended and the minimum required C++ version will be increased to C++17 for building the library and using it.
CharLS is cross-platform. -Wcast-align=strict will always warn for alignment issues, even when current platform can handle it (for example x86)
Use void*+static_cast to increase alignment. This is safe for dynamic allocated memory.
* Enable warning -Wuseless-cast for GCC build
* Add conditional_static_cast template to fix -Wuseless-cast warnings
Note 1: the original template code was created by
Thomas Braun (https://github.com/t-b) as an example in an issue discussion.
Note 2: the warnings are mostly reported on 32 bit (x86) builds. All CI Linux builds are x64 builds.
Per cmake documentation:
* https://cmake.org/cmake/help/git-stage/manual/cmake-compile-features.7.html#requiring-language-standards
For example, if C++ 11 features are used extensively in a project's
header files, then clients must use a compiler mode that is no less than
C++ 11. This can be requested with the code:
target_compile_features(mylib PUBLIC cxx_std_11)
In this example, CMake will ensure the compiler is invoked in a mode of
at-least C++ 11 (or C++ 14, C++ 17, ...), adding flags such as
-std=gnu++11 if necessary. This applies to sources within mylib as well
as any dependents (that may include headers from mylib).
- /permissive- is only supported since Visual Studio 2017.
- VS 2015 cannot handle some constexpr functions that have multiple return statements.
- VS 2015 template deduction is limited.
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
The latest MSVC compiler makes it possible to mark executable images CET compatible. Enable this opt-in option.
Note: CET is only enabled when the CPU, OS and the hosting process supports it.
Visual Studio 2015 cannot handle the /Zc:__cplusplus option and the new options in the manifest file. Exclude this things when build with Visual Studio 2015.
- Control Flow Guard provides more security on the Windows platform.
- To use the add_link_options, the minimum required CMake version needs to be increased to v3.13
The standard CMake option BUILD_SHARED_LIBS can be passed to CMake with the command line.
Adding this variable also as option makes it visibiel in GUIs that can be used for configure CMake options.
Note: the default value of BUILD_SHARED_LIBS is not changed.
For backwards compatibility Windows will only activate new OS functionality by an opt-in mechanism (this to prevent breaking legacy apps).
Activate the following:
- Support for long path names (requires Windows 10 1607 or newer), File names longer then 260 characters are now supported.
- The UTF-8 code page (requires Windows 10 1903 or newer). Unicode file names can be passed on the command line and opened. Calls to Win32 API functions with xxxA accept UTF-8 strings.
- Usage of the new memory heap (requires Windows 10 2004 or newer)
All C and C++ source code is encoded as utf-8 without a signature (bom). The GCC and clang compiler will read by default source code files in that format.
The MSVC compiler will look for a signature (bom), if non is found then the default system codepace encoding is used.
/utf-8 ensure that the correct source and executing encoding is used and that conversions are validated.
As no special characters are used in the source code, this is only a technical correction.
The version number was defined in charls.rc, CMakeLists.txt and version.h. Refactor to make it possible to only have the version number in version.h
Additional:
- convert the .rc file encoding to utf8 (improved git compatibility)
- add an additional DLL build for VS2015
- Remove linker warnings for VS2015 DLL x64 build
Address feedback from the SonarCloud static analyzer, replace strcpy with a safe implementation. As no cross platform solution is available, introduce a #ifdef/#else based solution.
Also get rid of _CRT_SECURE_NO_WARNINGS by removing a not used function and using std::ifstream instead of fopen\fclose.
Apply the modern way of documenting the used license, by referencing a SPDX Unique License Identifier in the source code files.
Note: From the legal point of view, this commit is only a change to the textual representation of the license information, but in no way any change to the actual license terms. With this commit applied, all files will still be licensed under the same terms they were before.
To ensure that the correct DLL is loaded, encode the ABI version (currently 2) and the CPU architecture in the DLL file name.
The architecture was already encoded (but only for x64), the ABI was missing, but requested as there are projects that use open source modules link with v1 and others with v2.
The modern way of CMake build script has changed. To make CharLS more package friendly, update the overall CMake structure to modern CMake.
For the moment target CMake 3.9 as the minimum, as this version is available on the Travis CI build system.
Visual Studio 2017 15.9 Preview 4 is required on the Windows platform, but the Visual Studio solution file and MSBuild projects is on that platform the supported way to build CharLS.
Modern practice is to move the interface header files to a include/<lib-name> folder. This prevents that header filenames conflict with other libraries. And it also allows client code to use #include <package-name\header-filename.h> constructions.
