Debian packaging update v10.0.6

.github/workflows/build.yml

@@ -26,12 +26,16 @@ jobs:
         sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-10 100 \
           --slave /usr/bin/g++ g++ /usr/bin/g++-10 --slave /usr/bin/gcov gcov /usr/bin/gcov-10
         echo DATA_BRANCH=linux-release >> $GITHUB_ENV
+        sudo apt install exiftool
 
 
     - name: macos-dependencies
       if: startsWith(matrix.os, 'macos')
       run: |
         echo DATA_BRANCH=osx >> $GITHUB_ENV
+        brew upgrade
+        brew install exiftool
+        #perl -MImage::ExifTool -e ""
 
     - name: windows-dependencies
       if: startsWith(matrix.os, 'windows')

CMakeLists.txt

@@ -6,7 +6,7 @@ project(GROK)
 # GROK version
 set(GROK_VERSION_MAJOR 10)
 set(GROK_VERSION_MINOR 0)
-set(GROK_VERSION_BUILD 5)
+set(GROK_VERSION_BUILD 6)
 set(GROK_VERSION
   "${GROK_VERSION_MAJOR}.${GROK_VERSION_MINOR}.${GROK_VERSION_BUILD}")
 set(PACKAGE_VERSION
@@ -58,11 +58,18 @@ if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
     "MinSizeRel" "RelWithDebInfo")
 endif()
 
+include(CheckPIESupported OPTIONAL RESULT_VARIABLE CHECK_PIE_SUPPORTED)
+check_pie_supported(LANGUAGES CXX)
+ if(CMAKE_CXX_LINK_PIE_SUPPORTED)
+   set(CMAKE_POSITION_INDEPENDENT_CODE TRUE)
+endif()
+
 # Path to additional CMake modules
 set(CMAKE_MODULE_PATH
     ${GROK_SOURCE_DIR}/cmake
     ${CMAKE_MODULE_PATH})
 
+include (ExternalProject)
 # Install directories
 include(GNUInstallDirs)
 string(TOLOWER ${PROJECT_NAME} projectname)
@@ -80,8 +87,8 @@ endif()
 
 # Grok build configuration options.
 option(BUILD_SHARED_LIBS "Build Grok shared library and link executables against it." ON)
-set (EXECUTABLE_OUTPUT_PATH ${CMAKE_BINARY_DIR}/bin CACHE PATH "Single output directory for building all executables.")
-set (LIBRARY_OUTPUT_PATH ${CMAKE_BINARY_DIR}/bin CACHE PATH "Single output directory for building all libraries.")
+set (EXECUTABLE_OUTPUT_PATH ${CMAKE_CURRENT_BINARY_DIR}/bin CACHE PATH "Single output directory for building all executables.")
+set (LIBRARY_OUTPUT_PATH ${CMAKE_CURRENT_BINARY_DIR}/bin CACHE PATH "Single output directory for building all libraries.")
 mark_as_advanced(LIBRARY_OUTPUT_PATH EXECUTABLE_OUTPUT_PATH)
 
 # Compiler specific flags:
@@ -111,6 +118,7 @@ include(CheckSymbolExists)
 option(GRK_BUILD_LIBPNG "Build libpng library" ON)
 option(GRK_BUILD_LIBTIFF "Build libtiff library" ON)
 option(GRK_BUILD_LCMS2 "Build lcms2 library" ON)
+option(GRK_BUILD_JPEG "Build jpeg library" ON)
 add_subdirectory(thirdparty)
 
 # Build Library

INSTALL.md

@@ -4,17 +4,20 @@
 
 If the `-V` flag is used to transfer ExIF tags to the output file, [ExifTool](https://exiftool.org/) must be installed.
 
-### Linux/MacOS
+### Linux
 
-Follow installation instructions on the ExifTool site.
+Use your package manager to install ExifTool. This will ensure that the ExifTool Perl modules
+are correctly installed
 
-### Windows
+### MacOS
+
+Use [brew](https://brew.sh/) package manager to install ExifTool. This will ensure that the ExifTool Perl modules are correctly installed
 
-1. install [Strawberry Perl](https://strawberryperl.com/)
-1. download and extract platform-independant [ExifTool tarball](https://exiftool.org)
-1. open `lib` folder inside extracted folder and copy `Image` and `Exiftool` folders to `C:\Strawberry\perl\site\lib`
-1. to validate that the ExifTool Perl modules were installed correctly, open a command line shell and run `perl -MImage::ExifTool -e " "`. If there is no output, then installation succeeded.
+### Windows
 
+`-V` is not supported on Windows. To transfer tags, simply run
+`$ exiftool -TagsFromFile $SOURCE_FILE "-all:all>all:all" $DEST_FILE`
+after running Grok.
 
 # Install from Package Manager
 
@@ -210,20 +213,4 @@ 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`
-
-#### JPEG Support
-
-To encode and decode JPEG files, a `libjpeg`-compatible library
-(`-dev` version) must be installed.
-Recommended library : [libjpeg-turbo](https://github.com/libjpeg-turbo/libjpeg-turbo)
-On Debian systems, the `libjpeg-turbo8-dev` package will provide a development
-version of this library.
-
-##### Grok dynamic build with JPEG support (Windows)
-
-`libjpeg-turbo` must be built with the `WITH_CRT_DLL` flag on, to ensure that the dynamic version of the C runtime libraries is used. Also, if Grok is linking with dynamic build of `libjpeg-turbo`, (`cmake` flag `JPEG_LIBRARY` is set to `LIBJPEG_INSTALL_DIRECTORY/jpeg.lib`), then make sure that `LIBJPEG_INSTALL_DIRECTORY/bin` is on the path.
-
-##### Grok static build with JPEG support (Windows)
-
-`libjpeg-turbo` must be built with the `WITH_CRT_DLL` flag off, to ensure that the static version of the C runtime libraries is used.
+  `-DGRK_BUILD_LiBTIFF:BOOL=OFF`

debian/rules

@@ -15,7 +15,8 @@ CMAKE_EXTRA_FLAGS += -DCMAKE_SKIP_RPATH=ON \
   -DGRK_BUILD_DOC:BOOL=ON \
   -DGRK_BUILD_LCMS2:BOOL=OFF \
   -DGRK_BUILD_LIBPNG:BOOL=OFF \
-  -DGRK_BUILD_LIBTIFF:BOOL=OFF
+  -DGRK_BUILD_LIBTIFF:BOOL=OFF \
+  -DGRK_BUILD_JPEG:BOOL=OFF
 
 override_dh_auto_configure:
 	dh_auto_configure -- $(CMAKE_EXTRA_FLAGS)

doc/CMakeLists.txt

@@ -8,12 +8,12 @@ find_package(Doxygen)
 if(DOXYGEN_FOUND)
   # Configure the doxygen config file with variable from CMake and move it
   configure_file(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.dox.cmake.in
-    ${CMAKE_BINARY_DIR}/doc/Doxyfile-html.dox @ONLY)
+    ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile-html.dox @ONLY)
 
   # Configure the html mainpage file of the doxygen documentation with variable
   # from CMake and move it
   configure_file(${CMAKE_CURRENT_SOURCE_DIR}/mainpage.dox.in
-    ${CMAKE_BINARY_DIR}/doc/mainpage.dox @ONLY)
+    ${CMAKE_CURRENT_BINARY_DIR}/mainpage.dox @ONLY)
 
   file(GLOB headers
     ${GROK_SOURCE_DIR}/src/lib/core/*.h
@@ -22,18 +22,18 @@ if(DOXYGEN_FOUND)
   # Generate new target to build the html documentation
   add_custom_command(
     OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/html/index.html
-    COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_BINARY_DIR}/doc/Doxyfile-html.dox
-    DEPENDS ${CMAKE_BINARY_DIR}/doc/Doxyfile-html.dox
-            ${CMAKE_BINARY_DIR}/doc/mainpage.dox
+    COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile-html.dox
+    DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile-html.dox
+            ${CMAKE_CURRENT_BINARY_DIR}/mainpage.dox
             ${headers}
   )
   add_custom_target(doc ALL
-    DEPENDS ${CMAKE_BINARY_DIR}/doc/html/index.html
+    DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/html/index.html
     COMMENT "Building doxygen documentation"
   )
 
   # install HTML documentation (install png files too):
-  install(DIRECTORY ${CMAKE_BINARY_DIR}/doc/html
+  install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html
     DESTINATION ${CMAKE_INSTALL_DOCDIR}
   )
 else()

doc/Doxyfile.dox.cmake.in

@@ -6,7 +6,7 @@
 DOXYFILE_ENCODING      = UTF-8
 PROJECT_NAME           = Grok
 PROJECT_NUMBER         = @GROK_VERSION@
-OUTPUT_DIRECTORY       = @CMAKE_BINARY_DIR@/doc
+OUTPUT_DIRECTORY       = @CMAKE_CURRENT_BINARY_DIR@
 CREATE_SUBDIRS         = NO
 OUTPUT_LANGUAGE        = English
 BRIEF_MEMBER_DESC      = YES
@@ -97,7 +97,7 @@ WARN_LOGFILE           =
 #---------------------------------------------------------------------------
 INPUT                  = @GROK_SOURCE_DIR@/src/lib/core \
 						 @GROK_SOURCE_DIR@/src/lib/plugin \
-                         @CMAKE_BINARY_DIR@/doc
+                         @CMAKE_CURRENT_BINARY_DIR@/doc
 INPUT_ENCODING         = UTF-8
 FILE_PATTERNS          = *.h \
                          *.c \

examples/codec/CMakeLists.txt

@@ -1,11 +1,13 @@
 include_directories(
   ${GROK_SOURCE_DIR}/src/lib/codec
-  ${CMAKE_BINARY_DIR}/src/lib/core
+  ${CMAKE_CURRENT_BINARY_DIR}/../../src/lib/core
   ${GROK_SOURCE_DIR}/src/lib/core
   ${CMAKE_CURRENT_BINARY_DIR}/../
 )
 
-foreach(exe codec_decompress_from_file_to_tiff)
+foreach(exe codec_decompress_from_file
+			codec_compress
+)
   add_executable(${exe} ${exe}.cpp)
   target_compile_options(${exe} PRIVATE ${GROK_COMPILE_OPTIONS})
   if (CMAKE_CXX_COMPILER_ID MATCHES "GNU")
@@ -18,7 +20,7 @@ foreach(exe codec_decompress_from_file_to_tiff)
     target_compile_options(${exe} PUBLIC -matomics)
   endif()
 
-  target_link_libraries(${exe} ${GROK_CODEC_NAME})
+  target_link_libraries(${exe} ${GROK_CODEC_NAME} ${GROK_CORE_NAME})
 
   if(URING)
 	  target_link_libraries(${exe} uring)

examples/codec/codec_compress.cpp

@@ -0,0 +1,167 @@
+/*
+ *    Copyright (C) 2016-2023 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/>.
+ *
+ */
+#include <string>
+#include <cstring>
+#include <vector>
+#include <filesystem>
+
+#include "grok.h"
+#include "grok_codec.h"
+#include "grk_examples_config.h"
+
+const std::string dataRoot = GRK_DATA_ROOT;
+
+int main([[maybe_unused]] int argc, [[maybe_unused]] char** argv)
+{
+    const uint32_t dimX = 640;
+    const uint32_t dimY = 480;
+    const uint32_t numComps = 3;
+    const uint32_t precision = 8;
+    grk_image_comp* compParams = nullptr;
+    grk_image *image = nullptr;
+    grk_stream_params out_buffer;
+    memset(&out_buffer,0,sizeof(out_buffer));
+
+    bool inputFromImage = true;
+    bool outputToBuffer = true;
+
+    if (outputToBuffer) {
+        out_buffer.len = (size_t)numComps * (precision/8) * dimX * dimY;
+        out_buffer.buf = new uint8_t[out_buffer.len];
+    }
+
+    std::vector<std::string> argString;
+    std::vector<char *> args;
+
+    std::string inputFile, outputFile;
+    int rc = 1;
+
+    if (inputFromImage) {
+        // create blank image
+        compParams = new grk_image_comp[numComps];
+        for (uint32_t i = 0; i < numComps; ++i){
+            auto c = compParams + i;
+            c->w = dimX;
+            c->h = dimY;
+            c->dx = 1;
+            c->dy = 1;
+            c->prec = precision;
+            c->sgnd = false;
+        }
+        image = grk_image_new(numComps, compParams, GRK_CLRSPC_SRGB, true);
+
+        // fill in component data
+        // see grok.h header for full details of image structure
+        for (uint16_t compno = 0; compno < image->numcomps; ++compno){
+            auto comp = image->comps + compno;
+            auto compWidth = comp->w;
+            auto compHeight = comp->h;
+            auto compData = comp->data;
+            if (!compData){
+                fprintf(stderr, "Image has null data for component %d\n",compno);
+                goto beach;
+            }
+            // fill in component data, taking component stride into account
+            auto srcData = new int32_t[compWidth * compHeight];
+            auto srcPtr = srcData;
+            for (uint32_t j = 0; j < compHeight; ++j) {
+               memcpy(compData, srcPtr, compWidth * sizeof(int32_t));
+               srcPtr += compWidth;
+               compData += comp->stride;
+            }
+            delete[] srcData;
+        }
+    }
+
+	//1. form vector of command line args
+
+	// first entry must always be the name of the program, as is
+	// required by argv/argc variables in main method
+	argString.push_back("codec_compress");
+
+	// verbose output
+	argString.push_back("-v");
+
+   // a file can be passed in as a command line argument
+    // example:
+    // $ codec_compress foo.tif
+    // otherwise a file from the Grok test suite, specified below, will be used.
+
+	inputFile = dataRoot + std::filesystem::path::preferred_separator +
+			"input" +  std::filesystem::path::preferred_separator +
+			"nonregression" + std::filesystem::path::preferred_separator + "basn6a08.tif";
+	outputFile = "basn6a08.jp2";
+    if (argc > 1) {
+        inputFile = argv[1];
+        outputFile = inputFile + ".tif";
+    }
+    if (!inputFromImage) {
+        argString.push_back("-i " + inputFile);
+    }
+
+	if (outputToBuffer) {
+        argString.push_back("-out_fmt jp2");
+	} else {
+        argString.push_back("-o " + outputFile);
+	}
+
+	// 2. convert to array of C strings
+	for (auto& s : argString){
+	  char *arg = new char[s.size() + 1];
+	  copy(s.begin(), s.end(), arg);
+	  arg[s.size()] = '\0';
+	  args.push_back(arg);
+	}
+
+	// 3. decompress
+	rc =  grk_codec_compress((int)args.size(),&args[0], image,
+	                            outputToBuffer ? &out_buffer : nullptr);
+	if (rc)
+	    fprintf(stderr, "Failed to compress\n");
+
+	if (outputToBuffer)
+	    printf("Compressed to memory : %ld bytes\n",out_buffer.buf_compressed_len);
+
+    // write buffer to file
+    if (outputToBuffer) {
+        auto fp = fopen(outputFile.c_str(), "wb");
+        if(!fp)
+        {
+            fprintf(stderr,"Buffer compress: failed to open file %s for writing", outputFile.c_str());
+        }
+        else
+        {
+            size_t written = fwrite(out_buffer.buf, 1, out_buffer.buf_compressed_len, fp);
+            if(written != out_buffer.buf_compressed_len)
+            {
+                fprintf(stderr,"Buffer compress: only %ld bytes written out of %ld total", out_buffer.buf_compressed_len,
+                              written);
+            }
+            fclose(fp);
+        }
+    }
+
+beach:
+	//4. cleanup
+	for (auto& s : args)
+	  delete[] s;
+    delete[] compParams;
+    delete[] out_buffer.buf;
+    grk_object_unref(&image->obj);
+
+	return rc;
+}