code: a few tweaks

Author: Grok Compression

CMakeLists.txt

@@ -1,11 +1,26 @@
+# Copyright (C) 2016-2025 Grok Image Compression Inc.
+#
+# This source code is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License, version 3,
+# as published by the Free Software Foundation.
+#
+# This source code is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+
 cmake_minimum_required(VERSION 3.20)
 
 project(GROK)
 
 #######################################
 # GROK version
-set(GROK_VERSION_MAJOR 15)
-set(GROK_VERSION_MINOR 1)
+set(GROK_VERSION_MAJOR 20)
+set(GROK_VERSION_MINOR 0)
 set(GROK_VERSION_PATCH 0)
 set(GROK_VERSION
   "${GROK_VERSION_MAJOR}.${GROK_VERSION_MINOR}.${GROK_VERSION_PATCH}")
@@ -27,12 +42,10 @@ set(GROK_CORE_NAME grokj2k)
 set(GROK_CODEC_NAME grokj2kcodec)
 set(GROK_PLUGIN_NAME grokj2k_plugin)
 
-set(CMAKE_CXX_STANDARD 23)
+set(CMAKE_CXX_STANDARD 20)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
-if ( (CMAKE_CXX_COMPILER_ID MATCHES "GNU") AND (CMAKE_CXX_COMPILER_VERSION LESS 11.0) )
-   message(FATAL_ERROR "GNU compiler version must be at least 11.0")
-endif()
 
+set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 
 if (CMAKE_SYSTEM_PROCESSOR MATCHES "unknown")
   # uname -p is broken on this system.  Try uname -m
@@ -45,9 +58,13 @@ else (CMAKE_SYSTEM_PROCESSOR MATCHES "unknown")
 endif (CMAKE_SYSTEM_PROCESSOR MATCHES "unknown")
 message(STATUS "Architecture: " ${GRK_ARCH})
 
-IF(MSVC)
-    string(APPEND CMAKE_CXX_FLAGS " /EHsc /utf-8")
-ENDIF(MSVC)
+if(MSVC)
+    add_compile_options(/EHsc /utf-8)
+endif()
+
+if ( (CMAKE_CXX_COMPILER_ID MATCHES "GNU") AND (CMAKE_CXX_COMPILER_VERSION LESS 10.0) )
+   message(FATAL_ERROR "GNU compiler version must be at least 10.0")
+endif()
 
 # Set a default build type if none was specified
 if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
@@ -64,6 +81,11 @@ check_pie_supported(LANGUAGES CXX)
    set(CMAKE_POSITION_INDEPENDENT_CODE TRUE)
 endif()
 
+set(CMAKE_CXX_FLAGS_RELWITHDEBINFO "${CMAKE_CXX_FLAGS_RELWITHDEBINFO} -fno-omit-frame-pointer")
+set(CMAKE_C_FLAGS_RELWITHDEBINFO "${CMAKE_C_FLAGS_RELWITHDEBINFO} -fno-omit-frame-pointer")
+set(CMAKE_SHARED_LINKER_FLAGS_RELWITHDEBINFO "${CMAKE_SHARED_LINKER_FLAGS_RELWITHDEBINFO} -Wl,--build-id")
+
+
 # Path to additional CMake modules
 set(CMAKE_MODULE_PATH
     ${GROK_SOURCE_DIR}/cmake
@@ -128,10 +150,11 @@ option(GRK_BUILD_LCMS2 "Build lcms2 library" ON)
 option(GRK_BUILD_JPEG "Build jpeg library" ON)
 add_subdirectory(thirdparty)
 
+# Build Library
 option(BUILD_LUTS_GENERATOR "Build utility to generate t1_luts.h" OFF)
 
 # Build examples
-option(GRK_BUILD_CORE_EXAMPLES "Build core examples" OFF)
+option(GRK_BUILD_CORE_EXAMPLES "Build core examples" ON)
 option(GRK_BUILD_CODEC_EXAMPLES "Build codec examples" OFF)
 
 # examples use files from data folder
@@ -142,6 +165,26 @@ if (GRK_BUILD_CORE_EXAMPLES OR GRK_BUILD_CODEC_EXAMPLES)
 	  NO_CMAKE_FIND_ROOT_PATH)
 endif()
 
+if(CMAKE_BUILD_TYPE STREQUAL "Release")
+    if(WIN32)
+        # Ensure no debug symbols & remove Debug Directory
+        set(CMAKE_EXE_LINKER_FLAGS_RELEASE "${CMAKE_EXE_LINKER_FLAGS_RELEASE} /DEBUG:NONE /RELEASE")
+        set(CMAKE_SHARED_LINKER_FLAGS_RELEASE "${CMAKE_SHARED_LINKER_FLAGS_RELEASE} /DEBUG:NONE /RELEASE")
+
+        if(MSVC)
+            # Ensure MSVC does not generate .pdb files
+            set(CMAKE_MSVC_DEBUG_INFORMATION_FORMAT "None")
+        endif()
+    elseif(APPLE)
+        # Strip all local symbols for macOS
+        set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} -Wl,-x")
+        set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -Wl,-x")
+    else()
+        # Strip all symbols for shared libraries on other non-Windows platforms (e.g., Linux)
+        set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} -Wl,--strip-all")
+        set(CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -Wl,--strip-all")
+    endif()
+endif()
 
 # Build Applications
 option(GRK_BUILD_CODEC "Build the CODEC executables" ON)
@@ -151,20 +194,24 @@ mark_as_advanced(GRK_BUILD_PLUGIN_LOADER)
 # Add an option to enable or disable the ExifTool check
 option(GRK_ENABLE_EXIFTOOL "Enable detection of ExifTool Perl module" ON)
 
-# Check for Perl library
+# Check for Perl libraries and ExifTool only if the option is enabled
 if (GRK_ENABLE_EXIFTOOL)
-  find_package(PerlLibs)
-  if (PERLLIBS_FOUND)
-    message(STATUS "Perl libraries found")
-    execute_process(COMMAND ${PERL_EXECUTABLE} -MImage::ExifTool -e ""
-      ERROR_QUIET RESULT_VARIABLE status)
-      if (NOT status)
-          message(STATUS "ExifTool Perl module found")
-          set(GROK_HAVE_EXIFTOOL define)
-      else()
-          message(STATUS "ExifTool Perl module not found")
-      endif()
-  endif(PERLLIBS_FOUND)
+    find_package(PerlLibs)
+    if (PERLLIBS_FOUND)
+        message(STATUS "Perl libraries found")
+        execute_process(COMMAND ${PERL_EXECUTABLE} -MImage::ExifTool -e ""
+            ERROR_QUIET RESULT_VARIABLE status)
+        if (NOT status)
+            message(STATUS "ExifTool Perl module found")
+            set(GROK_HAVE_EXIFTOOL define)
+        else()
+            message(STATUS "ExifTool Perl module not found")
+        endif()
+    else()
+        message(STATUS "Perl libraries not found")
+    endif()
+else()
+    message(STATUS "ExifTool detection is disabled")
 endif()
 
 add_subdirectory(src/lib/core)
@@ -183,6 +230,7 @@ if(GRK_BUILD_CORE_SWIG_BINDINGS)
 endif()
 
 
+
 if(GRK_BUILD_CODEC)
   add_subdirectory(src/bin)
   add_subdirectory(src/lib/codec)
@@ -214,6 +262,7 @@ if(BUILD_TESTING AND GRK_BUILD_CODEC)
 	  PATHS $ENV{GRK_DATA_ROOT} ${CMAKE_SOURCE_DIR}/../grok-test-data
 	  NO_CMAKE_FIND_ROOT_PATH)
 	add_subdirectory(tests)
+  set(GRK_BUILD_CORE_EXAMPLES ON CACHE BOOL "Build core examples" FORCE)
 endif()
 
 # install all targets referenced as GrokTargets
@@ -236,7 +285,6 @@ if (BUILD_SHARED_LIBS AND NOT CMAKE_SYSTEM_NAME STREQUAL Emscripten)
           DESTINATION ${GROK_INSTALL_PACKAGE_DIR})
 endif()
 
-
 if(GRK_BUILD_DOC)
    install(FILES LICENSE DESTINATION ${CMAKE_INSTALL_DOCDIR})
 endif()

INSTALL.md

@@ -112,7 +112,7 @@ to `glibc`. For a purely static build, the library can be built
 on [Alpine Linux](https://www.alpinelinux.org/). Alpine uses
 [musl libc](https://musl.libc.org/), which can be linked to statically.
 
-`cmake` must also be configured with `-DBUILD_SHARED_LIBS:bool=off -DGRK_ENABLE_EXIFTOOL:bool=off -DCMAKE_EXE_LINKER_FLAGS="-static"`.
+Note: `cmake` must also be configured with `-DCMAKE_EXE_LINKER_FLAGS="-static"`.
 
 ### Fedora
 
@@ -122,8 +122,8 @@ from the build folder, then
 must be added to the `.bashrc` file. Note that the build binary folder is
 entered before the system binary folder, so that build shared libraries
 are given priority when loading at run time.
-1. for a static build, the following libraries must be installed:
-`sudo dnf install libstdc++-static glibc-static`
+1. for a static build, the following library must be installed:
+`sudo dnf install libstdc++-static`
 
 ### Debug/Release
 
@@ -219,4 +219,10 @@ Type `cmake --help` for available generators on your platform.
 Third party libraries such as `libtiff` are built by default. To disable
 `libtiff` library build and use the version installed on your system, set :
 
-  `-DGRK_BUILD_LiBTIFF:BOOL=OFF`
+  `-DGRK_BUILD_LiBTIFF:BOOL=OFF`
+
+  ## Linking with other Cmake Projects
+
+  1. set `CMAKE_INSTALL_PREFIX` to `/PATH/TO/INSTALL/DIR`
+  1. build and install
+  1. on other project, set `CMAKE_PREFIX_PATH` to `/PATH/TO/INSTALL/DIR`

README.md

@@ -12,7 +12,8 @@
 
 ### Features
 
-* support for High Throughput JPEG 2000 (HTJ2K) encode/decode
+* support for new **High Throughput JPEG 2000 (HTJ2K)** standard
+* fast random-access sub-image decoding using `TLM` and `PLT` markers
 * full encode/decode support for `ICC` colour profiles
 * full encode/decode support for `XML`,`IPTC`, `XMP` and `EXIF` meta-data
 * full encode/decode support for `monochrome`, `sRGB`, `palette`, `YCC`, `extended YCC`, `CIELab` and `CMYK` colour spaces
@@ -28,14 +29,44 @@
 2. [Generating Lossy Access JP2s With Grok](https://www.bitsgalore.org/2022/03/30/generating-lossy-access-jp2s-from-lossless-preservation-masters)
 
 
+### Performance
+
+Below is a benchmark comparing time and memory performance for **Grok 9.7.8** and **Kakadu 8.05** on the following workflows:
+
+1. decompress large single-tiled [image of Mars](https://hirise.lpl.arizona.edu/PDS/RDR/ESP/ORB_011200_011299/ESP_011277_1825/ESP_011277_1825_RED.JP2) to TIF output
+1. decompress region `(1000,1000,5000,5000)` from large single-tiled [image of Mars](https://hirise.lpl.arizona.edu/PDS/RDR/ESP/ORB_011200_011299/ESP_011277_1825/ESP_011277_1825_RED.JP2) to TIF output
+1. decompress 6 resolutions from `580000x825000` single-tiled [image of Luxembourg](https://s3.eu-central-1.amazonaws.com/download.data.public.lu/resources/orthophoto-officelle-du-grand-duche-de-luxembourg-edition-2020/20210602-110516/Luxembourg-2020_ortho10cm_RVB_LUREF.jp2)
+1. decompress 7 resolutions from `580000x825000` single-tiled [image of Luxembourg](https://s3.eu-central-1.amazonaws.com/download.data.public.lu/resources/orthophoto-officelle-du-grand-duche-de-luxembourg-edition-2020/20210602-110516/Luxembourg-2020_ortho10cm_RVB_LUREF.jp2)
+1. decompress 8 resolutions from `580000x825000` single-tiled [image of Luxembourg](https://s3.eu-central-1.amazonaws.com/download.data.public.lu/resources/orthophoto-officelle-du-grand-duche-de-luxembourg-edition-2020/20210602-110516/Luxembourg-2020_ortho10cm_RVB_LUREF.jp2)
+1. decompress region `(574200,816750,580000,825000)` from `580000x825000` single-tiled [image of Luxembourg](https://s3.eu-central-1.amazonaws.com/download.data.public.lu/resources/orthophoto-officelle-du-grand-duche-de-luxembourg-edition-2020/20210602-110516/Luxembourg-2020_ortho10cm_RVB_LUREF.jp2)
+
+
+
+#### Benchmark Details
+
+* test system : 24 core / 48 thread `AMD Threadripper`
+running `Fedora 36` with `5.17` Linux kernel and `xfs` file system
+* codecs were configured to use all 48 threads
+* file cache was cleared before each decompression using `$ sudo sysctl vm.drop_caches=3`
+* Grok was built in release mode using `GCC 10`
+
+#### Results
+
+| Test  | Grok               | Kakadu
+| :---- | :-----             | :------: 
+| 1     | 13.74 s / 16.6 GB  | 9.02 s / 0.05 GB
+| 2     | 0.25 s / 0.4 GB    | 0.12 s   
+| 3     | 0.37 s / 0.7 GB    | 2.72 s / 1.0 GB
+| 4     | 0.67 s / 1.0 GB    | 3.02 s / 1.0 GB
+| 5     | 1.76 s / 1.8 GB    | 3.72 s / 1.1 GB
+| 6     | 2.89 s / 6.0 GB    | 7.39 s / 1.1 GB
 
 ### Library Details
 
 * [INSTALL](https://github.com/GrokImageCompression/grok/blob/master/INSTALL.md)
 * [WIKI](https://github.com/GrokImageCompression/grok/wiki)
 * [LICENSE][link-license]
 
-
 ### Current Build Status
 [![badge-actions]][link-actions]
 [![badge-oss-fuzz]][link-oss-fuzz]
@@ -52,4 +83,4 @@ For more information please contact :
 [badge-actions]: https://github.com/GrokImageCompression/grok/actions/workflows/build.yml/badge.svg?branch=master
 [link-actions]: https://github.com/GrokImageCompression/grok/actions
 [badge-oss-fuzz]: https://oss-fuzz-build-logs.storage.googleapis.com/badges/grok.svg
-[link-oss-fuzz]: https://issues.oss-fuzz.com/issues?q=proj:grok
+[link-oss-fuzz]: https://issues.oss-fuzz.com/issues?q=proj:grok

Testing/Temporary/CTestCostData.txt

@@ -0,0 +1 @@
+*.png

benchmark/.gitignore

@@ -0,0 +1,70 @@
+
+## Windows Benchmarks
+
+powershell
+
+Measure-Command {$HOME\src\grok\build\bin\Release\grk_decompress.exe -i $HOME\temp\IMG_PHR1B_P_202406071720183_SEN_7038440101-1_R1C1.JP2 -o $HOME\temp\temp.tif -t 0 -H 1}
+
+Measure-Command {$HOME\src\grok\build\bin\Release\core_decompress.exe -i $HOME\temp\IMG_PHR1B_P_202406071720183_SEN_7038440101-1_R1C1.JP2 -t 0 -H 1}
+
+Measure-Command {$HOME\bin\kdu_expand.exe -i $HOME\temp\IMG_PHR1B_P_202406071720183_SEN_7038440101-1_R1C1.JP2 -o $HOME\temp\temp.tif -region "{0.00000000000000000,0.00000000000000000},{0.10101109741060420,0.09905204101373573}" -num_threads 1 }
+
+## Image Stitching
+
+1. Create TIFFs with Fake Coordinates
+
+
+```
+gdal_translate -a_srs EPSG:3857 -a_ullr 0 20000 20000 0 input.JP2 input_georef1.tif
+gdal_translate -a_srs EPSG:3857 -a_ullr 20000 20000 40000 0 input.JP2 input_georef2.tif
+gdal_translate -a_srs EPSG:3857 -a_ullr 40000 20000 60000 0 input.JP2 input_georef3.tif
+gdal_translate -a_srs EPSG:3857 -a_ullr 60000 20000 80000 0 input.JP2 input_georef4.tif
+
+gdal_translate -a_srs EPSG:3857 -a_ullr 0 40000 20000 20000 input.JP2 input_georef5.tif
+gdal_translate -a_srs EPSG:3857 -a_ullr 20000 40000 40000 20000 input.JP2 input_georef6.tif
+gdal_translate -a_srs EPSG:3857 -a_ullr 40000 40000 60000 20000 input.JP2 input_georef7.tif
+gdal_translate -a_srs EPSG:3857 -a_ullr 60000 40000 80000 20000 input.JP2 input_georef8.tif
+
+gdal_translate -a_srs EPSG:3857 -a_ullr 0 60000 20000 40000 input.JP2 input_georef9.tif
+gdal_translate -a_srs EPSG:3857 -a_ullr 20000 60000 40000 40000 input.JP2 input_georef10.tif
+gdal_translate -a_srs EPSG:3857 -a_ullr 40000 60000 60000 40000 input.JP2 input_georef11.tif
+gdal_translate -a_srs EPSG:3857 -a_ullr 60000 60000 80000 40000 input.JP2 input_georef12.tif
+
+gdal_translate -a_srs EPSG:3857 -a_ullr 0 80000 20000 60000 input.JP2 input_georef13.tif
+gdal_translate -a_srs EPSG:3857 -a_ullr 20000 80000 40000 60000 input.JP2 input_georef14.tif
+gdal_translate -a_srs EPSG:3857 -a_ullr 40000 80000 60000 60000 input.JP2 input_georef15.tif
+gdal_translate -a_srs EPSG:3857 -a_ullr 60000 80000 80000 60000 input.JP2 input_georef16.tif
+```
+
+2. Build Virtual Raster
+
+```
+gdalbuildvrt -overwrite output.vrt \
+    input_georef1.tif input_georef2.tif input_georef3.tif input_georef4.tif \
+    input_georef5.tif input_georef6.tif input_georef7.tif input_georef8.tif \
+    input_georef9.tif input_georef10.tif input_georef11.tif input_georef12.tif \
+    input_georef13.tif input_georef14.tif input_georef15.tif input_georef16.tif
+
+```
+
+3. Convert to BigTIFF
+
+```
+gdal_translate -of GTiff -co BIGTIFF=YES -co TILED=NO output.vrt output.tif
+```
+
+4. Kakadu compression
+
+```
+kdu_compress -i pleiades4x4.tif -o pleiades4x4.jp2   -rate 90,80,70,60,50,40,30,20,10,9,8,7,6,5,1   Clayers=15   Stiles="{1024,1024}"   ORGgen_plt=yes Clevels=6 Corder=LRCP Cblk="{64,64}"   Cuse_sop=yes Cuse_eph=yes   Creversible=no
+```
+
+```
+kdu_compress -i output.tif -o output.jp2   -rate 90,80,70,60,50,40,30,20,10,9,8,7,6,5,1   Clayers=15   Stiles="{128,128}"   ORGgen_plt=yes ORGtparts=R   Clevels=6 Corder=RPCL   Cblk="{64,64}"   Cuse_sop=yes Cuse_eph=yes   Creversible=no
+```
+
+5. Add TLM Marker
+
+```
+kdu_maketlm output.jp2 output_tlm.jp2
+```