Add support for smart object layers

.github/workflows/build-wheels.yml

@@ -63,22 +63,31 @@ jobs:
     steps:
     - uses: actions/checkout@v4
       with:
-        submodules: true
-
-    # We need to specify Xcode15.3 here as the default for macos-14 runners is 15.01 which has a bug 
-    # causing linking to fail.
-    - name: Setup Xcode 15.3
-      if: matrix.os == 'macos-latest'
-      uses: maxim-lobanov/setup-xcode@v1
+        submodules: 'recursive'
+        fetch-depth: 0
+
+    # Further brew packages needed to run/install vcpkg dependencies
+    - name: Setup macos dependencies
+      if: matrix.os_dist.os == 'macos-latest'
+      run: |
+          brew install ninja
+          brew install autoconf
+          brew install libtool
+          brew install automake
+
+    - name: Initialize vcpkg
+      uses: lukka/run-vcpkg@v11
       with:
-        xcode-version: '15.3'
+        vcpkgDirectory: '${{ github.workspace }}/thirdparty/vcpkg'
 
-    - uses: pypa/cibuildwheel@v2.16
+    - uses: pypa/cibuildwheel@v2.22.0
       env:
         CC: gcc-13
         CXX: g++-13
         CIBW_ARCHS: auto64
-        CIBW_MANYLINUX_X86_64_IMAGE: manylinux_2_28
+        MACOSX_DEPLOYMENT_TARGET: 14.0
+        CIBW_BEFORE_BUILD: pip install cmake
+        CIBW_MANYLINUX_X86_64_IMAGE: quay.io/pypa/manylinux_2_34_x86_64:latest
         CIBW_BUILD: "${{ matrix.os_dist.dist }}"
         # Test not only by running the test suite but also by executing every example we provide. This is to ensure
         # our examples are working and users can rely on them for starting off points
@@ -91,6 +100,7 @@ jobs:
             python -u {project}/PhotoshopExamples/ModifyLayerStructure/modify_layer_structure.py &&
             python -u {project}/PhotoshopExamples/ReplaceImageData/replace_image_data.py &&
             python -u {project}/PhotoshopExamples/RescaleCanvas/rescale_canvas.py &&
+            python -u {project}/PhotoshopExamples/SmartObjects/smart_objects.py &&
             nosetests {project}/python/psapi-test --verbose
 
     - name: Verify clean directory
@@ -102,7 +112,7 @@ jobs:
       with:
         name: PhotoshopAPI_Py-${{ matrix.os_dist.os }}-${{ matrix.os_dist.dist }}
         path: wheelhouse/*.whl
-
+        
   mock-publish:
     name: Mock Upload release to PyPI
     permissions:

.github/workflows/cmake-build.yml

@@ -26,60 +26,63 @@ jobs:
              os: ubuntu-24.04
              compiler: gcc-13
              compilercxx: g++-13
+             cflags: ""
+             cxxflags: ""
            - name: Ubuntu Clang
              os: ubuntu-24.04
              compiler: clang
              compilercxx: clang++
+             cflags: ""
+             cxxflags: ""
            - name: Windows MSVC
              os: windows-latest
              compiler: msvc
              compilercxx: msvc
+             cflags: ""
+             cxxflags: ""
            - name: MacOS ARM GCC
              os: macos-latest
              compiler: gcc-13
-             compilercxx: g++-13      
+             compilercxx: g++-13
+             cflags: ""
+             cxxflags: ""
 
     steps:
     - uses: actions/checkout@v4
       with:
         submodules: 'recursive'
-
-    # We need to specify Xcode15.3 here as the default for macos-14 runners is 15.01 which has a bug 
-    # causing linking to fail.
-    - name: Setup Xcode 15.3
+        fetch-depth: 0
+        
+    # Further brew packages needed to run/install vcpkg dependencies
+    - name: Setup MacOS dependencies
       if: matrix.os == 'macos-latest'
-      uses: maxim-lobanov/setup-xcode@v1
+      run: |
+          brew install ninja
+          brew install autoconf
+          brew install libtool
+          brew install automake
+
+    - name: Initialize vcpkg
+      uses: lukka/run-vcpkg@v11
       with:
-        xcode-version: '15.3'
+        vcpkgDirectory: '${{ github.workspace }}/thirdparty/vcpkg'
 
     - name: Configure CMake ${{ matrix.os }}-${{ matrix.compilercxx }}
       env:
         CC: ${{ matrix.compiler }}
         CXX: ${{ matrix.compilercxx }}
+        CFLAGS: ${{ matrix.cflags }}
+        CXXFLAGS: ${{ matrix.cxxflags }}
       run: |
-        cmake -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DPSAPI_BUILD_DOCS=OFF -DPSAPI_BUILD_BENCHMARKS=OFF -DPSAPI_BUILD_EXAMPLES=OFF -DPSAPI_BUILD_PYTHON=OFF
+        cmake -B ${{github.workspace}}/build -DCMAKE_OSX_ARCHITECTURES="arm64" -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DPSAPI_BUILD_DOCS=OFF -DPSAPI_BUILD_BENCHMARKS=OFF -DPSAPI_BUILD_TESTS=OFF -DPSAPI_BUILD_EXAMPLES=ON -DPSAPI_BUILD_PYTHON=OFF
 
 
     - name: Build ${{ matrix.os }}-${{ matrix.compilercxx }}
       # Build your program with the given configuration
       env:
         CC: ${{ matrix.compiler }}
         CXX: ${{ matrix.compilercxx }}
-      run: cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}}
-
-
-    # Call our python script to generate the relevant release artifacts after which we upload
-    # them for each platform
-    - name: Set up Python
-      uses: actions/setup-python@v5
-      with:
-        python-version: '3.10'
-
-    - name: Generate artifacts for ${{ matrix.os }}-${{ matrix.compilercxx }}
-      run: python scripts/generate_release.py --build-dir ${{github.workspace}}/build
-
-    - name: Upload Release Artifacts
-      uses: actions/upload-artifact@v4
-      with:
-        name: PhotoshopAPI-${{ matrix.os }}-${{ matrix.compilercxx }}
-        path: ${{github.workspace}}/release
+        CFLAGS: ${{ matrix.cflags }}
+        CXXFLAGS: ${{ matrix.cxxflags }}
+      run:  cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}} --parallel $(getconf _NPROCESSORS_ONLN || sysctl -n hw.ncpu || echo %NUMBER_OF_PROCESSORS%)
+

.github/workflows/cmake-test.yml

@@ -26,14 +26,14 @@ jobs:
              os: ubuntu-24.04
              compiler: gcc-13
              compilercxx: g++-13
-             cflags: ""
-             cxxflags: ""
+             cflags: "-fsanitize=address,leak,undefined"
+             cxxflags: "-fsanitize=address,leak,undefined"
            - name: Ubuntu Clang
              os: ubuntu-24.04
              compiler: clang
+             compilercxx: clang++
              cflags: "-fsanitize=address,leak,undefined"
              cxxflags: "-fsanitize=address,leak,undefined"
-             compilercxx: clang++
            - name: Windows MSVC
              os: windows-latest
              compiler: msvc
@@ -51,31 +51,38 @@ jobs:
     - uses: actions/checkout@v4
       with:
         submodules: 'recursive'
-
-    # We need to specify Xcode15.3 here as the default for macos-14 runners is 15.01 which has a bug 
-    # causing linking to fail.
-    - name: Setup Xcode 15.3
+        fetch-depth: 0
+        
+    # Further brew packages needed to run/install vcpkg dependencies
+    - name: Setup MacOS dependencies
       if: matrix.os == 'macos-latest'
-      uses: maxim-lobanov/setup-xcode@v1
-      with:
-        xcode-version: '15.3'
+      run: |
+          brew install ninja
+          brew install autoconf
+          brew install libtool
+          brew install automake
 
+    - name: Initialize vcpkg
+      uses: lukka/run-vcpkg@v11
+      with:
+        vcpkgDirectory: '${{ github.workspace }}/thirdparty/vcpkg'
+
     - name: Configure CMake ${{ matrix.os }}-${{ matrix.compilercxx }}
       env:
         CC: ${{ matrix.compiler }}
         CXX: ${{ matrix.compilercxx }}
         CFLAGS: ${{ matrix.cflags }}
         CXXFLAGS: ${{ matrix.cxxflags }}
       run: |
-        cmake -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DPSAPI_BUILD_DOCS=OFF -DPSAPI_BUILD_BENCHMARKS=OFF -DPSAPI_BUILD_EXAMPLES=OFF -DPSAPI_BUILD_PYTHON=OFF
+        cmake -B ${{github.workspace}}/build -DCMAKE_OSX_ARCHITECTURES="arm64" -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DPSAPI_BUILD_DOCS=OFF -DPSAPI_BUILD_BENCHMARKS=OFF -DPSAPI_BUILD_EXAMPLES=OFF -DPSAPI_BUILD_PYTHON=OFF
 
     - name: Build ${{ matrix.os }}-${{ matrix.compilercxx }}
       env:
         CC: ${{ matrix.compiler }}
         CXX: ${{ matrix.compilercxx }}
         CFLAGS: ${{ matrix.cflags }}
         CXXFLAGS: ${{ matrix.cxxflags }}
-      run: cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}}
+      run: cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}} --parallel $(getconf _NPROCESSORS_ONLN || sysctl -n hw.ncpu || echo %NUMBER_OF_PROCESSORS%)
 
     # On windows we need to copy the test files differently as it generates sub-folders
     # for the copied test files

.github/workflows/cmake-valgrind.yml

@@ -26,34 +26,48 @@ jobs:
              os: ubuntu-24.04
              compiler: gcc-13
              compilercxx: g++-13
+             cflags: ""
+             cxxflags: ""
            - name: Ubuntu Clang
              os: ubuntu-24.04
              compiler: clang
              compilercxx: clang++
+             cflags: ""
+             cxxflags: ""
 
     steps:
     - uses: actions/checkout@v4
       with:
         submodules: 'recursive'
+        fetch-depth: 0
+
+    - name: Load or restore vcpkg libraries
+      uses: lukka/run-vcpkg@v11
+      with:
+        vcpkgDirectory: '${{ github.workspace }}/thirdparty/vcpkg'
 
     - name: Configure CMake ${{ matrix.os }}-${{ matrix.compilercxx }}
       env:
         CC: ${{ matrix.compiler }}
         CXX: ${{ matrix.compilercxx }}
+        CFLAGS: ${{ matrix.cflags }}
+        CXXFLAGS: ${{ matrix.cxxflags }}
       run: |
-        cmake -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DPSAPI_BUILD_DOCS=OFF -DPSAPI_BUILD_BENCHMARKS=OFF -DPSAPI_BUILD_EXAMPLES=OFF -DPSAPI_BUILD_PYTHON=OFF
+        cmake -B ${{github.workspace}}/build -DCMAKE_OSX_ARCHITECTURES="arm64" -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DPSAPI_BUILD_DOCS=OFF -DPSAPI_BUILD_BENCHMARKS=OFF -DPSAPI_BUILD_EXAMPLES=ON -DPSAPI_BUILD_PYTHON=OFF
 
     - name: Build ${{ matrix.os }}-${{ matrix.compilercxx }}
       env:
         CC: ${{ matrix.compiler }}
         CXX: ${{ matrix.compilercxx }}
-      run: cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}}
+        CFLAGS: ${{ matrix.cflags }}
+        CXXFLAGS: ${{ matrix.cxxflags }}
+      run: cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}} --parallel $(getconf _NPROCESSORS_ONLN || sysctl -n hw.ncpu || echo %NUMBER_OF_PROCESSORS%)
 
     - name: Run Valgrind
       if: matrix.os == 'ubuntu-24.04'
       working-directory: ${{github.workspace}}/build/PhotoshopTest
       run: |
         sudo apt-get update
         sudo apt-get install -y valgrind
-        valgrind --leak-check=full ./PhotoshopTest
+        valgrind --leak-check=full --show-leak-kinds=all --track-origins=yes ./PhotoshopTest
       continue-on-error: false

.gitmodules

@@ -7,12 +7,15 @@
 [submodule "thirdparty/pybind11"]
 	path = thirdparty/pybind11
 	url = https://github.com/pybind/pybind11
-[submodule "thirdparty/libdeflate"]
-	path = thirdparty/libdeflate
-	url = https://github.com/ebiggers/libdeflate
 [submodule "thirdparty/mio"]
 	path = thirdparty/mio
 	url = https://github.com/vimpunk/mio
 [submodule "thirdparty/simdutf"]
 	path = thirdparty/simdutf
 	url = https://github.com/simdutf/simdutf
+[submodule "thirdparty/vcpkg"]
+	path = thirdparty/vcpkg
+	url = https://github.com/microsoft/vcpkg
+[submodule "thirdparty/json"]
+	path = thirdparty/json
+	url = https://github.com/nlohmann/json

CMakeLists.txt

@@ -1,20 +1,21 @@
 cmake_minimum_required (VERSION 3.20)
+set(VCPKG_LIBRARY_LINKAGE "static")
 project ("PhotoshopAPIBuild" VERSION 0.5.2 LANGUAGES CXX)
 
 if (MSVC)
-    # MSVC is stupid
     add_compile_definitions(NOMINMAX)
 endif()
 
 # --------------------------------------------------------------------------
 # Configurable options
 
-option(PSAPI_BUILD_STATIC "Build a static library version of the PhotoshopAPI" ON)
+option(PSAPI_BUILD_STATIC "Build a static library version of the PhotoshopAPI, currently must be on as we dont create a dynamic library target" ON)
+option(PSAPI_USE_VCPKG "Build the extra dependencies using vckpg instead of system installed libraries" ON)
 option(PSAPI_BUILD_TESTS "Build the tests associated with the PhotoshopAPI" ON)
 option(PSAPI_BUILD_EXAMPLES "Build the examples associated with the PhotoshopAPI" ON)
 option(PSAPI_BUILD_BENCHMARKS "Build the benchmarks associated with the PhotoshopAPI" ON)
-option(PSAPI_BUILD_DOCS "Builds the documentation, requires some external installs which are documented in the README.md" OFF)
-option(PSAPI_BUILD_PYTHON "Build the python bindings associated with the PhotoshopAPI" OFF)
+option(PSAPI_BUILD_DOCS "Builds the documentation, requires some external installs which are documented in the README.md" ON)
+option(PSAPI_BUILD_PYTHON "Build the python bindings associated with the PhotoshopAPI" ON)
 
 
 if (PSAPI_BUILD_PYTHON)
@@ -23,6 +24,7 @@ if (PSAPI_BUILD_PYTHON)
 endif()
 
 
+
 # Build setup
 list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
 set (CMAKE_CXX_STANDARD 20)
@@ -32,14 +34,33 @@ set (CMAKE_CXX_STANDARD 20)
 set(CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/cmake" ${CMAKE_MODULE_PATH})
 
 
-# Add thirdparty libraries
+# Set up our toolchain using the local vcpkg, gets the 
 # --------------------------------------------------------------------------
 
+# Include the local vcpkg toolchain, if specified
+if (PSAPI_USE_VCPKG)
+    include("${PROJECT_SOURCE_DIR}/thirdparty/vcpkg/scripts/buildsystems/vcpkg.cmake")
+endif()
+
+# Here we add support for OpenImageIO which is used for smart object image data extraction.
+find_package(OpenImageIO CONFIG REQUIRED)
+
+# Add libdeflate for zip compression and decompression
+find_package(libdeflate CONFIG REQUIRED)
+
+# Eigen is used to construct e.g. homographies for applying non-affine transforms
+find_package(Eigen3 CONFIG REQUIRED)
+
+# fmt library for formatting and logging.
+find_package(fmt CONFIG REQUIRED)
 
-# Add libdeflate
-add_subdirectory (thirdparty/libdeflate)
-add_library(libdeflate_include INTERFACE)
-target_include_directories(libdeflate_include SYSTEM INTERFACE thirdparty/libdeflate)
+# UUID for storing e.g. uuids of smart objects
+find_package(stduuid CONFIG REQUIRED)
+
+
+
+# Add thirdparty libraries
+# --------------------------------------------------------------------------
 
 # Add mio for memory-mapped IO files
 add_subdirectory (thirdparty/mio)
@@ -57,7 +78,6 @@ add_subdirectory (thirdparty/c-blosc2 EXCLUDE_FROM_ALL)
 add_library(blosc2_include INTERFACE)
 target_include_directories(blosc2_include SYSTEM INTERFACE thirdparty/c-blosc2/include)
 
-
 # Add doctest
 add_library(doctest INTERFACE)
 target_include_directories(doctest SYSTEM INTERFACE thirdparty/doctest/doctest)
@@ -68,6 +88,9 @@ set (SIMDUTF_TOOLS OFF)
 set (SIMDUTF_ICONV OFF)
 add_subdirectory (thirdparty/simdutf)
 
+# JSON module for parsing of Descriptors
+add_subdirectory(thirdparty/json)
+
 # Add span from tcb for compatibility with older compilers for python bindings
 add_library(tcb_span INTERFACE)
 target_include_directories(tcb_span SYSTEM INTERFACE thirdparty/compatibility)
@@ -92,6 +115,7 @@ if(PSAPI_BUILD_EXAMPLES)
     add_subdirectory (PhotoshopExamples/ModifyLayerStructure)
     add_subdirectory (PhotoshopExamples/ProgressCallbacks)
     add_subdirectory (PhotoshopExamples/ReplaceImageData)
+    add_subdirectory (PhotoshopExamples/SmartObjects)
 endif()
 if(PSAPI_BUILD_DOCS)
     if(NOT PSAPI_BUILD_PYTHON)