Align plugins with Dolby Encoding Engine 6.4 release

Author: mszym1

plugins/BUILDING.md

@@ -25,12 +25,15 @@ Specifying an option that is unsupported on a given platform will simply be igno
 cmake -B build -S . -DCMAKE_BUILD_TYPE=Release -DCMAKE_MSVC_RUNTIME_LIBRARY="MultiThreaded" -DCMAKE_POSITION_INDEPENDENT_CODE=ON
 ```
 
+To specify custom installation folder, please pass `-DCMAKE_INSTALL_PREFIX=<install_dir>` to the command above.
+
 Please refer to [CMakeLists.txt](CMakeLists.txt) for more build options.
 
-## Build
+## Build and install
 
-To build the project, run:
+To build and install the project, run:
 
 ```bash
 cmake --build build --config Release -j
+cmake --install build --config Release
 ```

plugins/code/CMakeLists.txt

@@ -1,3 +1,10 @@
+if(APPLE)
+    set(CMAKE_INSTALL_RPATH "@loader_path")
+    set(CMAKE_INSTALL_NAME_DIR "@loader_path")
+elseif(UNIX)
+    set(CMAKE_INSTALL_RPATH "$ORIGIN")
+endif()
+
 add_subdirectory(api)
 add_subdirectory(common)
 add_subdirectory(hevc_enc)

plugins/code/hevc_enc/beamr/README.md

@@ -38,4 +38,4 @@ The build uses files in following folders:
 
 Extract the kit folder from the archive and set the `BEAMR_SDK` environment variable.
 
-Build the plugin (see [BUILDING.md](../../../BUILDING.md)), then copy `libdee_plugin_hevc_enc_beamr.so` or `libdee_plugin_hevc_enc_beamr.dll` (depending on your operating system) to the DEE installation folder. The file can be renamed, but the extension must remain unchanged.
+Build and install the plugin (see [BUILDING.md](../../../BUILDING.md)), then copy `libdee_plugin_hevc_enc_beamr.so` or `libdee_plugin_hevc_enc_beamr.dll` (depending on your operating system) to the DEE installation folder. The file can be renamed, but the extension must remain unchanged.

plugins/code/hevc_enc/x265/README.md

@@ -6,14 +6,14 @@ The provided source code was built and tested using the x265 library version 4.1
 - Windows:
   - Visual Studio 2022
   - [NASM](https://nasm.us/pub/nasm/releasebuilds/?C=M;O=D)
-  - [CMake](https://github.com/Kitware/CMake/releases/tag/v3.31.8) 
+  - [CMake](https://github.com/Kitware/CMake/releases/tag/v3.31.8)
 - Linux:
   - gcc 11.5
   - [NASM](https://nasm.us/pub/nasm/releasebuilds/?C=M;O=D)
-  - [CMake](https://github.com/Kitware/CMake/releases/tag/v3.31.8) 
+  - [CMake](https://github.com/Kitware/CMake/releases/tag/v3.31.8)
 
 ## Building x265 library
- The x265 library has to be build with multi-bitdepth (8/10/12-bit) support and in shared format.  
+ The x265 library has to be build with multi-bitdepth (8/10/12-bit) support and in shared format.
  - Navigate to [x265 git repository](https://bitbucket.org/multicoreware/x265_git/src/4.1/build/) and locate `multilib` file for your platform.
  - Execute `multilib` file to build `x265` library.
  - Multi-bitdepth library will be located in newly created `8bit` directory
@@ -30,6 +30,6 @@ The provided source code was built and tested using the x265 library version 4.1
   ```
 
 - Set `X265ROOT` environment variable pointing to `x265_root`.
-- Build the plugin (see [BUILDING.md](../../../BUILDING.md))
+- Build and install the plugin (see [BUILDING.md](../../../BUILDING.md))
 - Copy x265 shared library (`libx265.so` or `libx265.dll`)
 and plugin library (`libdee_plugin_hevc_enc_x265.so` or `dee_plugin_hevc_enc_x265.dll`) to the DEE installation folder. The plugin library file can be renamed, but the extension must remain unchanged.

plugins/code/j2k_dec/kakadu/CMakeLists.txt

@@ -36,6 +36,11 @@ target_link_libraries(dee_plugin_j2k_dec_kakadu
         dee_plugins::dee_plugin_j2k_dec_kakadu_base
 )
 
+if(COMMAND kakadu_fix_install_name)
+    # Changes kakadu relative path reference to @loader_path/<libname> in the plugin library on macOS
+    kakadu_fix_install_name(dee_plugin_j2k_dec_kakadu)
+endif()
+
 install(TARGETS dee_plugin_j2k_dec_kakadu
     EXPORT dee_plugin_j2k_dec_kakaduTargets
 )

plugins/code/j2k_dec/kakadu/README.md

@@ -1,6 +1,6 @@
 # Kakadu JPEG2000 decoder plugin for Dolby Encoding Engine
 
-The provided source code was built and tested using the Kakadu SDK version 8.4.
+The provided source code was built and tested using the Kakadu SDK version 8.6.0.
 
 ## Build tools:
 - Visual Studio 2022
@@ -64,19 +64,19 @@ A typical Kakadu SDK directory structure is shown below. Note that, in addition
 │   │   └── ...
 │   ├── lib
 │   │   ├── Linux-x86-64-gcc
-│   │   │   └── libkdu_v84R.so
+│   │   │   └── libkdu_v86R.so
 │   │   ├── Mac-x86-64-gcc
-│   │   │   └── libkdu_v84R.so
+│   │   │   └── libkdu_v86R.so
 │   │   └── ...
 │   └── ...
 ├── bin_x64
-│   └── kdu_v84R.dll
+│   └── kdu_v86R.dll
 └── lib_x64
-    └── kdu_v84R.lib
+    └── kdu_v86R.lib
 ```
 
 ## Build instructions
 
 Set up the Kakadu directory as described above, and set the `KDUROOT` environment variable to point to that folder. Note that on Windows, the binaries are located outside the `KDUROOT` folder, as this is where Kakadu build files place them by default.
 
-Build the plugin (see [BUILDING.md](../../../BUILDING.md)), then copy the Kakadu shared libraries (e.g., `libkdu_v84R.so` or `kdu_v84R.dll`) and the plugin library (e.g., `libdee_plugin_j2k_dec_kakadu.so` or `dee_plugin_j2k_dec_kakadu.dll`) to the DEE installation folder. The plugin library file may be renamed, but its file extension must remain unchanged.
+Build and install the plugin (see [BUILDING.md](../../../BUILDING.md)), then copy the Kakadu shared libraries (e.g., `libkdu_v86R.so` or `kdu_v86R.dll`) and the plugin library (e.g., `libdee_plugin_j2k_dec_kakadu.so` or `dee_plugin_j2k_dec_kakadu.dll`) to the DEE installation folder. The plugin library file may be renamed, but its file extension must remain unchanged.

plugins/code/j2k_dec/kakadu/cmake/kakaduConfig.cmake

@@ -13,7 +13,7 @@ if(CMAKE_SYSTEM_NAME STREQUAL "Darwin")
         set(MACOS_ARCH "${CMAKE_SYSTEM_PROCESSOR}")
     endif()
 
-    set(KAKADU_LIBNAME "libkdu_v84R.so")
+    set(KAKADU_LIBNAME "libkdu_v86R.so")
     if(MACOS_ARCH STREQUAL "arm64")
         set(KAKADU_LIBDIR "lib/Mac-arm-64-gcc")
     elseif(MACOS_ARCH STREQUAL "x86_64")
@@ -23,9 +23,9 @@ if(CMAKE_SYSTEM_NAME STREQUAL "Darwin")
     endif()
 elseif(CMAKE_SYSTEM_NAME STREQUAL "Windows")
     set(KAKADU_LIBDIR "../bin_x64")
-    set(KAKADU_LIBNAME "kdu_v84R.dll")
+    set(KAKADU_LIBNAME "kdu_v86R.dll")
     set(KAKADU_IMPLIBDIR "../lib_x64")
-    set(KAKADU_IMPLIBNAME "kdu_v84R.lib")
+    set(KAKADU_IMPLIBNAME "kdu_v86R.lib")
 elseif(CMAKE_SYSTEM_NAME STREQUAL "Linux")
     if (CMAKE_SYSTEM_PROCESSOR MATCHES "^(arm|aarch64)")
         set(KAKADU_LIBDIR "lib/Linux-arm-64-gcc")
@@ -34,22 +34,26 @@ elseif(CMAKE_SYSTEM_NAME STREQUAL "Linux")
     else()
         message(FATAL_ERROR "Unsupported Linux architecture")
     endif()
-    set(KAKADU_LIBNAME "libkdu_v84R.so") 
+    set(KAKADU_LIBNAME "libkdu_v86R.so")
 else()
     message(FATAL_ERROR "Not supported OS/architecture")
 endif()
 
-add_library(kakadu::kdu SHARED IMPORTED)
-set_target_properties(kakadu::kdu
-    PROPERTIES
-        IMPORTED_LOCATION "$ENV{KDUROOT}/${KAKADU_LIBDIR}/${KAKADU_LIBNAME}"
-        INTERFACE_INCLUDE_DIRECTORIES "$ENV{KDUROOT}/coresys/common"
-)
-
-if (CMAKE_SYSTEM_NAME STREQUAL "Windows")
+if (UNIX)
+    add_library(kakadu::kdu INTERFACE IMPORTED)
+    set_target_properties(kakadu::kdu
+        PROPERTIES
+            INTERFACE_LINK_DIRECTORIES "$ENV{KDUROOT}/${KAKADU_LIBDIR}"
+            INTERFACE_LINK_LIBRARIES "${KAKADU_LIBNAME}"
+            INTERFACE_INCLUDE_DIRECTORIES "$ENV{KDUROOT}/coresys/common"
+    )
+else()
+    add_library(kakadu::kdu SHARED IMPORTED)
     set_target_properties(kakadu::kdu
         PROPERTIES
+            IMPORTED_LOCATION "$ENV{KDUROOT}/${KAKADU_LIBDIR}/${KAKADU_LIBNAME}"
             IMPORTED_IMPLIB "$ENV{KDUROOT}/${KAKADU_IMPLIBDIR}/${KAKADU_IMPLIBNAME}"
+            INTERFACE_INCLUDE_DIRECTORIES "$ENV{KDUROOT}/coresys/common"
     )
 endif()
 
@@ -77,4 +81,23 @@ target_link_libraries(kakadu::kakadu
     INTERFACE
         kakadu::kdu
         kakadu::support
-)
+)
+
+# Function to fix Kakadu library references in a target on macOS
+function(kakadu_fix_install_name target)
+    if(NOT APPLE OR NOT KAKADU_LIBNAME OR NOT KAKADU_LIBDIR)
+        return()
+    endif()
+
+    set(_libdir "${KAKADU_LIBDIR}")
+    set(_libname "${KAKADU_LIBNAME}")
+
+    add_custom_command(TARGET ${target} POST_BUILD
+        COMMAND install_name_tool -change
+            "../../${_libdir}/${_libname}"
+            "@loader_path/${_libname}"
+            "$<TARGET_FILE:${target}>"
+        COMMENT "Fixing Kakadu library reference in ${target}"
+        VERBATIM
+    )
+endfunction()

plugins/code/tiff_dec/README.md

@@ -11,7 +11,7 @@ The provided source code was built and tested using the libtiff version 4.7.0.
 To build the plugin, you must first build and install the [libtiff 4.7.0](https://gitlab.com/libtiff/libtiff/-/releases/v4.7.0) `tiff` shared library.
 Use `cmake` to build and install libtiff libraries. Navigate to the extracted directory in terminal and invoke:
 - See all available configuration options:
-  - `cmake -h` 
+  - `cmake -h`
 - Generate project with specific install prefix (and other options):
   - `cmake -B build -S . --install-prefix <INSTALL_PATH> [other options]`
 - Build project:
@@ -45,7 +45,7 @@ LIBTIFFROOT
 
 ## Build instructions
 
-Build the plugin (see [BUILDING.md](../../BUILDING.md)), then copy the `tiff` shared library and plugin library:
+Build and install the plugin (see [BUILDING.md](../../BUILDING.md)), then copy the `tiff` shared library and plugin library:
 - on Linux: `LIBTIFFROOT/lib/libtiff.so` and `libdee_plugin_tiff_dec_libtiff.so`
 - on Windows: `LIBTIFFROOT/bin/tiff.dll` and `libdee_plugin_tiff_dec_libtiff.dll`