Merge branch 'release_v0.3.0' into 'main'

sync with internal nvimagecodec repo release_v0.3.0 branch (commit c80dfc7)

See merge request cuda-hpc-libraries/nvimagecodec-public!2

Author: jantonguirao

.github/ISSUE_TEMPLATE/bug_report_form.yml

@@ -28,7 +28,7 @@ body:
     attributes:
       label: Version
       description: What version of nvImageCodec are you running?
-      placeholder: "example: 0.2.0"
+      placeholder: "example: 0.3.0"
     validations:
       required: true
 

.gitmodules

@@ -1,36 +1,36 @@
-[submodule "external/pybind11"]
-	path = external/pybind11
-	url = https://github.com/pybind/pybind11.git
+[submodule "python/pybind11"]
+        path = external/pybind11
+        url =  https://github.com/pybind/pybind11.git
 [submodule "external/NVTX"]
-	path = external/NVTX
-	url = https://github.com/NVIDIA/NVTX.git
-	branch = release-v3
+        path = external/NVTX
+        url = https://github.com/NVIDIA/NVTX.git
+        branch = release-v3
 [submodule "external/googletest"]
-	path = external/googletest
-	url = https://github.com/google/googletest.git
-	branch = main
+        path = external/googletest
+        url = https://github.com/google/googletest.git
+        branch = main
 [submodule "external/dlpack"]
-	path = external/dlpack
-	url = https://github.com/dmlc/dlpack.git
+        path = external/dlpack
+        url = https://github.com/dmlc/dlpack.git
 [submodule "external/boost/preprocessor"]
-	path = external/boost/preprocessor
-	url = https://github.com/boostorg/preprocessor
+        path = external/boost/preprocessor
+        url = https://github.com/boostorg/preprocessor
 [submodule "external/libjpeg-turbo"]
-	path = external/libjpeg-turbo
-	url = https://github.com/libjpeg-turbo/libjpeg-turbo.git
-	branch = main
+        path = external/libjpeg-turbo
+        url = https://github.com/libjpeg-turbo/libjpeg-turbo.git
+        branch = main
 [submodule "external/openjpeg"]
-	path = external/openjpeg
-	url = https://github.com/uclouvain/openjpeg.git
+        path = external/openjpeg
+        url = https://github.com/uclouvain/openjpeg.git
 [submodule "external/opencv"]
-	path = external/opencv
-	url = https://github.com/opencv/opencv.git
+        path = external/opencv
+        url = https://github.com/opencv/opencv.git
 [submodule "external/libtiff"]
-	path = external/libtiff
-	url = https://gitlab.com/libtiff/libtiff.git
+        path = external/libtiff
+        url = https://gitlab.com/libtiff/libtiff.git
 [submodule "external/zstd"]
-	path = external/zstd
-	url = https://github.com/facebook/zstd.git
+        path = external/zstd
+        url = https://github.com/facebook/zstd.git
 [submodule "external/zlib"]
-	path = external/zlib
-	url = https://github.com/madler/zlib.git
+        path = external/zlib
+        url = https://github.com/madler/zlib.git

CMakeLists.txt

@@ -15,11 +15,13 @@
 
 cmake_minimum_required(VERSION 3.18 FATAL_ERROR)
 
+include(CMakeDependentOption)
+
 set(NVIMGCODEC_PROJECT_NAME "nvimgcodec")
-set(NVIMGCODEC_VERSION "0.2.0")
+set(NVIMGCODEC_VERSION "0.3.0")
 
 if (NVIMGCODEC_FLAVOR)
-    set(NVIMGCODEC_FLAVOR "${NVIMGCODEC_FLAVOR} ")  # could be nightly, weekly, etc if necessary
+    set(NVIMGCODEC_FLAVOR "${NVIMGCODEC_FLAVOR}")  # could be nightly, weekly, etc if necessary
     set(NVIMGCODEC_FLAVOR_MINUS "-${NVIMGCODEC_FLAVOR}")  # -nightly, -weekly, etc
 endif()
 
@@ -31,7 +33,11 @@ if (NOT ARCH)
 endif()
 
 if (NOT NVIMGCODEC_WHL_PLATFORM_NAME)
-    set(NVIMGCODEC_WHL_PLATFORM_NAME "manylinux2014_${ARCH}")
+    if(UNIX)
+        set(NVIMGCODEC_WHL_PLATFORM_NAME "manylinux2014_${ARCH}")
+    else()
+        set(NVIMGCODEC_WHL_PLATFORM_NAME "win_amd64")
+    endif()
 endif()
 
 if(NOT BUILD_ID)
@@ -69,7 +75,6 @@ if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
 endif()
 
 if(WIN32)
-  set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>")
   # XXX: cmake appends /MT after /MD that produces D9025 warnings about overriding flags, hence...
   string(REGEX REPLACE "/MD " "" CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE}")
   string(REGEX REPLACE "/MDd " "" CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG}")
@@ -90,15 +95,21 @@ option(BUILD_LIBTIFF_EXT "Build libtiff extensions module" ON)
 option(BUILD_OPENCV_EXT "Build opencv extensions module" ON)
 option(BUILD_PYTHON "Build Python binding" ON)
 option(BUILD_WHEEL "Build python wheel package" ON)
-option(WITH_DYNAMIC_NVJPEG "Dynamically loads nvjpeg at runtime" ON)
+
+cmake_dependent_option(WITH_DYNAMIC_NVJPEG "Dynamically loads nvjpeg at runtime" ON
+                      "BUILD_NVJPEG_EXT" OFF)
 propagate_option(WITH_DYNAMIC_NVJPEG)
-option(WITH_DYNAMIC_NVJPEG2K "Dynamically loads nvjpeg2k at runtime" OFF)
+cmake_dependent_option(WITH_DYNAMIC_NVJPEG2K "Dynamically loads nvjpeg2k at runtime" ON
+                      "BUILD_NVJPEG2K_EXT" OFF)
 propagate_option(WITH_DYNAMIC_NVJPEG2K)
 
 string(TOLOWER ${CMAKE_SYSTEM_NAME} SYS_NAME)
 
 if(WIN32)
     set(CPACK_GENERATOR "ZIP")
+    if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT)
+        set(CMAKE_INSTALL_PREFIX "C:\\Program Files\\nvimgcodec_cuda${CUDA_VERSION_MAJOR}" CACHE PATH "where nvImageCodec will be installed" FORCE)
+    endif()
 else()
     set(CPACK_GENERATOR "TGZ;DEB")
 
@@ -183,9 +194,9 @@ endif()
 CUDA_get_cmake_cuda_archs(CMAKE_CUDA_ARCHITECTURES ${CUDA_targeted_archs})
 message(STATUS "Generated CMAKE_CUDA_ARCHITECTURES: ${CMAKE_CUDA_ARCHITECTURES}")
 
-set(CMAKE_CUDA_FLAGS "${CMAKE_CUDA_FLAGS} --compiler-options \"-fvisibility=hidden -Wno-free-nonheap-object\" --Wno-deprecated-gpu-targets -Xfatbin -compress-all")
-
 if(WIN32)
+    set(CMAKE_CUDA_FLAGS "${CMAKE_CUDA_FLAGS} --Wno-deprecated-gpu-targets -Xfatbin -compress-all")
+
     include(third_party/generate_product_version)
 
     generate_product_version(ProductVersionFiles
@@ -195,6 +206,9 @@ if(WIN32)
         VERSION_PATCH ${CMAKE_PROJECT_VERSION_PATCH}
         VERSION_REVISION ${CMAKE_PROJECT_VERSION_TWEAK}
         COMPANY_NAME NVIDIA Corporation)
+elseif()
+    set(CMAKE_CUDA_FLAGS "${CMAKE_CUDA_FLAGS} --compiler-options \"-fvisibility=hidden -Wno-free-nonheap-object\" --Wno-deprecated-gpu-targets -Xfatbin -compress-all")
+
 endif()
 
 set(CMAKE_CXX_STANDARD 20)
@@ -205,6 +219,9 @@ set(CMAKE_CUDA_STANDARD 14)
 set(CMAKE_CUDA_STANDARD_REQUIRED ON)
 set(CMAKE_CUDA_EXTENSIONS OFF)
 
+list(APPEND CMAKE_BUILD_RPATH $ORIGIN)
+list(APPEND CMAKE_INSTALL_RPATH $ORIGIN)
+
 include_directories(
     ${PROJECT_SOURCE_DIR}
     ${PROJECT_SOURCE_DIR}/include

README.md

@@ -1,16 +1,19 @@
 # nvImageCodec
 
+![Version](https://img.shields.io/badge/Version-v0.3.0--beta-blue)
 [![License](https://img.shields.io/badge/License-Apache_2.0-yellogreen.svg)](https://opensource.org/licenses/Apache-2.0)
 
-![Version](https://img.shields.io/badge/Version-v0.2.0--beta-blue)
+![Platform](https://img.shields.io/badge/Platform-linux--x86__64_%7C_linux--aarch64_%7C_windows--64_wsl2_%7C_windows--64-blue)
 
-![Platform](https://img.shields.io/badge/Platform-linux--x86__64_%7C_linux--aarch64_%7C_windows--64_wsl2-gray)
-
-[![Cuda](https://img.shields.io/badge/CUDA-v11.8_%7c_v12.3-%2376B900?logo=nvidia)](https://developer.nvidia.com/cuda-toolkit-archive)
+[![Cuda](https://img.shields.io/badge/CUDA-v11.8_%7c_v12.5-%2376B900?logo=nvidia)](https://developer.nvidia.com/cuda-toolkit-archive)
 [![GCC](https://img.shields.io/badge/GCC->=v9.0-yellow)](https://gcc.gnu.org/gcc-9/)
-[![Python](https://img.shields.io/badge/python-v3.8_%7c_v3.9_%7c_v3.10_%7c_v3.11_%7c_v3.12-blue?logo=python)](https://www.python.org/)
 [![CMake](https://img.shields.io/badge/CMake->=v3.18-%23008FBA?logo=cmake)](https://cmake.org/)
 
+
+[![Python](https://img.shields.io/badge/python-v3.8_%7c_v3.9_%7c_v3.10_%7c_v3.11_%7c_v3.12-blue?logo=python)](https://www.python.org/)
+![PyPI - Wheel](https://img.shields.io/pypi/wheel/nvidia-nvimgcodec-cu12?pypiBaseUrl=https%3A%2F%2Fpypi.org&label=PyPI&link=https%3A%2F%2Fpypi.org%2Fsearch%2F%3Fq%3Dnvidia-nvimgcodec-cu12)
+
+
 The nvImageCodec is an open-source library of accelerated codecs with unified interface.
 It is designed as a framework for extension modules which delivers codec plugins.
 
@@ -85,8 +88,14 @@ This section describes the recommended dependencies to use nvImageCodec.
       - RHEL 8, 9
       - SLES 15
       - Ubuntu 20.04, 22.04
+   - aarch64-jetson (CUDA Toolkit >= 12.0)
+      - Ubuntu 22.04
+- Windows
+   - x86_64
+     - [Microsoft Visual C++ Redistributable](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170)   
 - NVIDIA driver >= 520.56.06
 - CUDA Toolkit > = 11.8
+- nvJPEG2000 >= 0.8.0
 - Python >= 3.8
 
 ## Install nvImageCodec library
@@ -127,21 +136,49 @@ Install nvJPEG for CUDA 12.x
 pip install nvidia-nvjpeg-cu12
 ```
 
+### Optional installation of nvJPEG2000 library
+
+[nvJPEG2000 library](https://developer.nvidia.com/nvjpeg2000-downloads) can be installed in the system, or installed as a Python package. For the latter, follow the instructions below.
+
+Install nvJPEG2000 for CUDA 11.x
+
+```
+pip install nvidia-nvjpeg2k-cu11
+```
+
+Install nvJPEG2000 for CUDA 12.x
+
+```
+pip install nvidia-nvjpeg2k-cu12
+```
+
+Install nvJPEG2000 for CUDA 12.x on Tegra platforms
+
+```
+pip install nvidia-nvjpeg2k-tegra-cu12
+```
+
+Please see also [nvJPEG2000 installation documentation](https://docs.nvidia.com/cuda/nvjpeg2000/userguide.html#installing-nvjpeg2000) for more information
+
+
 ### Documentation
 
 [NVIDIA nvImageCodec Documentation](https://docs.nvidia.com/cuda/nvimagecodec/)
 
 ## Build and install from Sources
 
 ### Additional pre-requisites
-- GCC >= 9.4
-- cmake >= 3.18
-- patchelf >= 0.17.2
+- Linux
+  - GCC >= 9.4
+  - cmake >= 3.18
+  - patchelf >= 0.17.2
+- Windows
+  - [Microsoft Visual Studio 2022 Build Tools](https://aka.ms/vs/17/release/vs_buildtools.exe)
 - Dependencies for extensions. If you would not like to build particular extension you can skip it.
-  - nvJPEG2000 >= 0.7.0
+  - nvJPEG2000 >= 0.8.0
   - libjpeg-turbo >= 2.0.0
   - libtiff >= 4.5.0
-  - opencv >= 4.7.0
+  - opencv >= 4.10.0
 - Python packages: 
   - clang==14.0.1 
   - wheel
@@ -156,6 +193,8 @@ Please see also Dockerfiles.
 
 ### Build
 
+#### Linux
+
 ```
 git lfs clone https://github.com/NVIDIA/nvImageCodec.git
 cd nvimagecodec
@@ -166,20 +205,30 @@ export CUDACXX=nvcc
 cmake .. -DCMAKE_BUILD_TYPE=Release
 make
 ```
-
-#### Build CVCUDA samples
+##### Build CVCUDA samples
 
 To build CV-CUDA samples, additionally CV-CUDA has to be installed and CVCUDA_DIR and NVCV_TYPES_DIR
 need to point folders with *-config.cmake files. Apart of that, BUILD_CVCUDA_SAMPLES variable must be set to ON.
 
+#### Windows
+
+Open Developer Command Prompt for VS 2022
+
+```
+git lfs clone https://github.com/NVIDIA/nvImageCodec.git
+cd nvimagecodec
+git submodule update --init --recursive --depth 1
+.\externa\build_deps.bat
+.\docker\build_helper.bat .\build 12
+```
 
 ## Build Python wheel
 
 After succesfully built project, execute below commands.
 
 ```
 cd build
-make wheel
+cmake --build . --target wheel
 ```
 
 ## Packaging
@@ -197,25 +246,25 @@ This will generate in build directory *.zip or *tar.xz files
 #### Tar file installation
 
 ```
-tar -xvf nvimgcodec-0.2.0.0-cuda12-x86_64-linux-lib.tar.gz -C /opt/nvidia/
+tar -xvf nvimgcodec-0.3.0.0-cuda12-x86_64-linux-lib.tar.gz -C /opt/nvidia/
 ```
 
 #### DEB File Installation
 ```
-sudo apt-get install -y ./nvimgcodec-0.2.0.0-cuda12-x86_64-linux-lib.deb
+sudo apt-get install -y ./nvimgcodec-0.3.0.0-cuda12-x86_64-linux-lib.deb
 ```
 #### Python WHL File Installation
 
 ```
-pip install nvidia_nvimgcodec_cu12-0.2.0-py3-none-manylinux2014_x86_64.whl
+pip install nvidia_nvimgcodec_cu12-0.3.0-py3-none-manylinux2014_x86_64.whl
 ```
 
 ### Installation from sources
 
 ##### Linux
 ```
 cd build
-cmake --install . --config Release -prefix /opt/nvidia/nvimgcodec_<major_cuda_ver>
+cmake --install . --config Release --prefix /opt/nvidia/nvimgcodec_<major_cuda_ver>
 ```
 
 After execution there should be:
@@ -228,6 +277,21 @@ Add directory with libnvimgcodec.so to LD_LIBRARY_PATH
 export LD_LIBRARY_PATH=/opt/nvidia/nvimgcodec_cuda<major_cuda_ver>/lib64:$LD_LIBRARY_PATH
 ```
 
+##### Windows
+
+Open Developer Command Prompt for VS 2022
+
+```
+cd build
+cmake --install . --config Release --prefix "c:\Program Files\nvimgcodec_cuda<major_cuda_ver>"
+```
+
+After execution there should be:
+
+- all extension modules in c:\Program Files\nvimgcodec_cuda<major_cuda_ver>/extensions (it is default directory for extension discovery)
+- nvimgcodec_0.dll in c:\Program Files\nvimgcodec_cuda<major_cuda_ver>\bin
+
+Add directory with nvimgcodec_0.dll to PATH
 
 ## Testing
 Run CTest to execute L0 and L1 tests
@@ -243,7 +307,7 @@ cd build
 cmake --install . --config Release --prefix bin
 cd bin/test
 
-LD_LIBRARY_PATH=$PWD/../lib64 pytest -v test_transcoder.py
+LD_LIBRARY_PATH=$PWD/../lib64 pytest -v test_transcode.py
 
 ```
 
@@ -252,7 +316,7 @@ Run Python API tests
 First install python wheel. You would also need to have installed all Python tests dependencies (see Dockerfiles). 
 
 ```
-pip install nvidia_nvimgcodec_cu12-0.2.0.x-py3-none-manylinux2014_x86_64.whl
+pip install nvidia_nvimgcodec_cu12-0.3.0.x-py3-none-manylinux2014_x86_64.whl
 ```
 
 Run tests