Merge branch 'aous72:master' into feature/add-openexr-support

Author: michaeldsmith

.github/workflows/ccp-workflow.yml

@@ -1,7 +1,7 @@
 # taken from https://github.com/onqtam/doctest/blob/master/.github/workflows/main.yml
 
 name: C/C++ CI
-on: 
+on:
   push:
   pull_request:
     types: [opened, reopened]
@@ -64,6 +64,42 @@ jobs:
       run: cmake --build . --config Release
       working-directory: build
 
+  build_mingw:
+    strategy:
+      fail-fast: false
+      matrix:
+        include: [
+          { system: Windows-MinGW,  runner: windows-latest },
+        ]
+    name: ${{ matrix.system }} Build
+    runs-on: ${{ matrix.runner }}
+    steps:
+    - uses: actions/checkout@v4
+    - name: cmake
+      run: cmake -G "MinGW Makefiles" -DOJPH_ENABLE_TIFF_SUPPORT=OFF -DOJPH_BUILD_STREAM_EXPAND=ON ..
+      working-directory: build
+    - name: build
+      run: cmake --build . --config Release
+      working-directory: build
+
+  build_windows_on_arm:
+    strategy:
+      fail-fast: false
+      matrix:
+        include: [
+          { system: WindowsOnARM,  runner: windows-11-arm },
+        ]
+    name: ${{ matrix.system }} Build
+    runs-on: ${{ matrix.runner }}
+    steps:
+    - uses: actions/checkout@v4
+    - name: cmake
+      run: cmake -G "Visual Studio 17 2022" -A ARM64 -DOJPH_ENABLE_TIFF_SUPPORT=OFF -DOJPH_BUILD_STREAM_EXPAND=ON ..
+      working-directory: build
+    - name: build
+      run: cmake --build . --config Release
+      working-directory: build
+
   test:
     strategy:
       fail-fast: false
@@ -86,7 +122,7 @@ jobs:
     - name: test
       run: ctest --output-on-failure
       working-directory: build
-      
+
   test_windows:
     strategy:
       fail-fast: false
@@ -108,6 +144,50 @@ jobs:
       run: ctest --output-on-failure -C Release
       working-directory: build
 
+  # # MinGW tests needs debugging, as they are failing to pass in my test
+  # test_MinGW:
+  #   strategy:
+  #     fail-fast: false
+  #     matrix:
+  #       include: [
+  #         { system: Windows,  runner: windows-latest },
+  #       ]
+  #   name: ${{ matrix.system }} Test
+  #   runs-on: ${{ matrix.runner }}
+  #   steps:
+  #   - uses: actions/checkout@v4
+  #   - name: cmake
+  #     run: cmake -G "MinGW Makefiles" -DOJPH_ENABLE_TIFF_SUPPORT=OFF -DOJPH_BUILD_TESTS=ON ..
+  #     working-directory: build
+  #   - name: build
+  #     run: cmake --build . --config Release
+  #     working-directory: build
+  #   - name: test
+  #     run: ctest --output-on-failure -C Release
+  #     working-directory: build
+
+  test_windows_on_arm:
+    strategy:
+      fail-fast: false
+      matrix:
+        include: [
+          { system: WindowsOnARM,  runner: windows-11-arm },
+        ]
+    name: ${{ matrix.system }} Test
+    runs-on: ${{ matrix.runner }}
+    steps:
+    - uses: actions/checkout@v4
+    - name: cmake
+      run: cmake -G "Visual Studio 17 2022" -A ARM64 -DOJPH_ENABLE_TIFF_SUPPORT=OFF -DOJPH_BUILD_TESTS=ON ..
+      working-directory: build
+    - name: build
+      run: cmake --build . --config Release
+      working-directory: build
+    - name: test
+      run: ctest --output-on-failure -C Release
+      working-directory: build
+
+
 #jobs:
 #  ci:
 #    name: ${{ matrix.name }}

CMakeLists.txt

@@ -18,7 +18,7 @@ set(CMAKE_MODULE_PATH
 
 ## Target architecture
 # We use the target architecture to help with arranging files in "source_group" commands.
-# The code does not use the results provided by target_arch.cmake, and relies, instead, 
+# The code does not use the results provided by target_arch.cmake, and relies, instead,
 # on its own logic, which matches that in target_arch.cmake, to identify the architecture
 include(target_arch.cmake)
 target_architecture(OJPH_TARGET_ARCH)
@@ -64,8 +64,8 @@ if (DEFINED OJPH_DISABLE_INTEL_SIMD)
                  "which is architecture agnostic. If you do not specify any, the default is "
                  "OJPH_DISABLE_SIMD=OFF.")
   set(OJPH_DISABLE_SIMD ${OJPH_DISABLE_INTEL_SIMD})
-  message(STATUS "OJPH_DISABLE_SIMD is set to ${OJPH_DISABLE_SIMD}")  
-  unset(OJPH_DISABLE_INTEL_SIMD)  
+  message(STATUS "OJPH_DISABLE_SIMD is set to ${OJPH_DISABLE_SIMD}")
+  unset(OJPH_DISABLE_INTEL_SIMD)
 endif()
 if (DEFINED OJPH_ENABLE_INTEL_AVX512)
   message(STATUS "OJPH_ENABLE_INTEL_AVX512 is being deprecated, use \"OJPH_DISABLE_AVX512\" instead."
@@ -75,21 +75,21 @@ if (DEFINED OJPH_ENABLE_INTEL_AVX512)
   else()
     set(OJPH_DISABLE_AVX512 ON)
   endif()
-  message(STATUS "OJPH_DISABLE_AVX512 is set to ${OJPH_DISABLE_AVX512}")  
+  message(STATUS "OJPH_DISABLE_AVX512 is set to ${OJPH_DISABLE_AVX512}")
   unset(OJPH_ENABLE_INTEL_AVX512)
 endif()
 
 ## Setting some of the options if EMSCRIPTEN is the compiler
-# In previous releases, the cmake script used to produce both non-SIMD and 
-# SIMD builds in one go.  At the time of this writing, all interpreters and 
-# compilers of WASM code, such as web-browser and node, support SIMD, therefore 
-# it is time to make the SIMD build the default.  In other words, this cmake 
+# In previous releases, the cmake script used to produce both non-SIMD and
+# SIMD builds in one go.  At the time of this writing, all interpreters and
+# compilers of WASM code, such as web-browser and node, support SIMD, therefore
+# it is time to make the SIMD build the default.  In other words, this cmake
 # script builds only WASM SIMD code by default, if desired, a non-SIMD build
-# can be generated using the OJPH_DISABLE_SIMD option (in this case, the 
+# can be generated using the OJPH_DISABLE_SIMD option (in this case, the
 # WASM SIMD code is not generated).
 # It is worth remembering that the SIMD/non-SIMD issue arose because it is
 # NOT possible to have multiple execution paths in the code, one for non-SIMD
-# and one for SIMD, as we do for CPUs, letting the program select, at run-time, 
+# and one for SIMD, as we do for CPUs, letting the program select, at run-time,
 # the best path to follow.
 if(EMSCRIPTEN)
   set(BUILD_SHARED_LIBS OFF)
@@ -126,16 +126,20 @@ message(STATUS "Building ${CMAKE_BUILD_TYPE}")
 
 ## C++ version and flags
 # C++14 is needed for gtest, otherwise, C++11 is sufficient for the library
-set(CMAKE_CXX_STANDARD 14)
+if (NOT CMAKE_CXX_STANDARD)
+  set(CMAKE_CXX_STANDARD 14)
+endif()
+message(STATUS "C++ Standard is set to ${CMAKE_CXX_STANDARD}")
+
 if (MSVC)
   add_compile_definitions(_CRT_SECURE_NO_WARNINGS)
 endif()
 if (CMAKE_CXX_COMPILER_ID MATCHES "Clang|GNU")
   add_compile_options(
-  -fexceptions 
-  -Wall 
-  -Wextra 
-  -Wconversion 
+  -fexceptions
+  -Wall
+  -Wextra
+  -Wconversion
   -Wunused-parameter
   )
 endif()
@@ -177,6 +181,7 @@ else()
 endif()
 
 ## Build library and applications
+include(GNUInstallDirs)
 add_subdirectory(src/core)
 if (OJPH_BUILD_EXECUTABLES)
   add_subdirectory(src/apps)
@@ -186,8 +191,6 @@ endif()
 # Install
 ################################################################################################
 
-include(GNUInstallDirs)
-
 install(EXPORT openjph-targets
   DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/openjph
 )

docs/usage_examples.md

@@ -16,4 +16,5 @@ Here are some usage examples:
 * On Linux and MacOS, but NOT Windows, { and } need to be escaped; i.e, we need to write \\\{ and \\\}.  So, -block\_size {64,64} must be written as -block\_size \\\{64,64\\\}.
 * When the source is a .yuv file, use -downsamp {1,1} for 4:4:4 sources. For 4:2:2 downsampling, specify -downsamp {1,1},{2,1}, and for 4:2:0 subsampling specify -downsamp {1,1},{2,2}. The source must have already been downsampled (i.e., OpenJPH does not downsample the source before compression, but can compress downsampled sources).
 * In Kakadu, pairs of data in command line arguments represent columns,rows. Here, a pair represents x,y information.
+* It came to my realization (See https://github.com/aous72/OpenJPH/issues/187) that there is an issue with files with `.raw` extension.  Kakadu and OpenJPEG use `.raw` for big-endian data and `.rawl` for little-endian data -- This is only meaningful for data samples that are more than 1 byte.  OpenJPH uses `.raw` for little-endian and there is no support for big-endian.  I need to transition to the convention adopted by Kakadu and OpenJPEG; the plan to is to support `.rawl` first, and warning that `.raw` is currently little-endian, but the plan is to move to big-endian.  Then, at a future point, the warning for `.raw` becomes that it is for big-endian. Then after a while this warning can be removed.
 

src/apps/ojph_stream_expand/CMakeLists.txt

@@ -1,7 +1,7 @@
 ## building ojph_stream_expand
 ##############################
 
-set(CMAKE_CXX_STANDARD 14)
+find_package(Threads)
 
 file(GLOB OJPH_STREAM_EXPAND  "*.cpp" "*.h")
 file(GLOB OJPH_SOCKETS         "../others/ojph_sockets.cpp")
@@ -17,10 +17,9 @@ source_group("common"      FILES ${OJPH_SOCKETS_H} ${OJPH_THREADS_H})
 
 add_executable(ojph_stream_expand ${SOURCES})
 target_include_directories(ojph_stream_expand PRIVATE ../common)
-if(MSVC)
-    target_link_libraries(ojph_stream_expand PUBLIC openjph ws2_32)
-else()
-    target_link_libraries(ojph_stream_expand PUBLIC openjph pthread)
-endif(MSVC)
+target_link_libraries(ojph_stream_expand PRIVATE openjph Threads::Threads)
+if(WIN32)
+    target_link_libraries(ojph_stream_expand PRIVATE ws2_32)
+endif()
 
 install(TARGETS ojph_stream_expand)

src/apps/others/ojph_sockets.cpp

@@ -127,7 +127,7 @@ namespace ojph
       --ojph_socket_manager_counter;
       if (ojph_socket_manager_counter == 0)
       {
-      #ifdef _MSC_VER  
+      #ifdef OJPH_OS_WINDOWS  
       	WSACleanup();
       #endif
       }

src/core/CMakeLists.txt

@@ -116,6 +116,17 @@ else()
 
 endif()
 
+## Set debug postfix for different platforms
+if (MSVC)
+  if (NOT DEFINED CMAKE_DEBUG_POSTFIX)
+    set(CMAKE_DEBUG_POSTFIX "d")
+  endif()
+elseif (CMAKE_CXX_COMPILER_ID MATCHES "Clang|GNU")
+  if (NOT DEFINED CMAKE_DEBUG_POSTFIX)
+    set(CMAKE_DEBUG_POSTFIX "_d")
+  endif()
+endif()
+
 add_library(openjph ${SOURCES})
 
 ## The option BUILD_SHARED_LIBS
@@ -124,11 +135,9 @@ if (BUILD_SHARED_LIBS AND WIN32)
 endif()
 
 ## include library version/name
-if (NOT MSVC)
-  target_compile_options(openjph PRIVATE -fPIC)
-endif()
+set_target_properties(openjph PROPERTIES POSITION_INDEPENDENT_CODE ON)
 target_compile_definitions(openjph PUBLIC _FILE_OFFSET_BITS=64)
-target_include_directories(openjph PUBLIC $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/common> $<INSTALL_INTERFACE:include/openjph>)
+target_include_directories(openjph PUBLIC $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/common> $<INSTALL_INTERFACE:include>)
 
 if (MSVC)
   set(OJPH_LIB_NAME_STRING "openjph.${OPENJPH_VERSION_MAJOR}.${OPENJPH_VERSION_MINOR}")

src/core/codestream/ojph_codestream.cpp

@@ -2,21 +2,21 @@
 // This software is released under the 2-Clause BSD license, included
 // below.
 //
-// Copyright (c) 2019, Aous Naman 
+// Copyright (c) 2019, Aous Naman
 // Copyright (c) 2019, Kakadu Software Pty Ltd, Australia
 // Copyright (c) 2019, The University of New South Wales, Australia
-// 
+//
 // Redistribution and use in source and binary forms, with or without
 // modification, are permitted provided that the following conditions are
 // met:
-// 
+//
 // 1. Redistributions of source code must retain the above copyright
 // notice, this list of conditions and the following disclaimer.
-// 
+//
 // 2. Redistributions in binary form must reproduce the above copyright
 // notice, this list of conditions and the following disclaimer in the
 // documentation and/or other materials provided with the distribution.
-// 
+//
 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
 // IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 // TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
@@ -57,7 +57,9 @@ namespace ojph {
   ////////////////////////////////////////////////////////////////////////////
   codestream::~codestream()
   {
-    if (state) delete state;
+    if (state)
+      delete state;
+    state = NULL;
   }
 
   ////////////////////////////////////////////////////////////////////////////
@@ -66,6 +68,13 @@ namespace ojph {
     state = new local::codestream;
   }
 
+  ////////////////////////////////////////////////////////////////////////////
+  void codestream::restart()
+  {
+    assert(state != NULL);
+    state->restart();
+  }
+
   ////////////////////////////////////////////////////////////////////////////
   param_siz codestream::access_siz()
   {
@@ -103,7 +112,7 @@ namespace ojph {
   }
 
   ////////////////////////////////////////////////////////////////////////////
-  void codestream::set_tilepart_divisions(bool at_resolutions, 
+  void codestream::set_tilepart_divisions(bool at_resolutions,
                                           bool at_components)
   {
     ui32 value = 0;
@@ -147,7 +156,7 @@ namespace ojph {
   }
 
   ////////////////////////////////////////////////////////////////////////////
-  void codestream::write_headers(outfile_base *file, 
+  void codestream::write_headers(outfile_base *file,
                                  const comment_exchange* comments,
                                  ui32 num_comments)
   {