Merge branch 'main' into 717_windows_build_updates

Author: cedrik-fuoco-adsk

.clang-tidy

@@ -1,6 +1,7 @@
 ---
 Checks: >
   bugprone-*,
+  -bugprone-easily-swappable-parameters,
   cert-*,
   clang-diagnostic-*,
   clang-analyzer-*,
@@ -13,6 +14,7 @@ Checks: >
   -modernize-use-trailing-return-type,
   performance-*,
   readability-*,
+  -readability-uppercase-literal-suffix,
 WarningsAsErrors: ''
 FormatStyle: 'file'
 ...

.github/workflows/ci.yml

@@ -51,7 +51,7 @@ jobs:
             arch-type: "x86_64"
             build-type: "Release"
             qt-version: "5.15.2"
-            cmake-version: "3.29.8"
+            cmake-version: "3.31.6"
             python-version: "3.10"
             vfx-platform: "CY2023"
             extra_repo: "powertools"
@@ -61,7 +61,7 @@ jobs:
             arch-type: "x86_64"
             build-type: "Release"
             qt-version: "5.15.2"
-            cmake-version: "3.29.8"
+            cmake-version: "3.31.6"
             python-version: "3.10"
             vfx-platform: "CY2023"
             extra_repo: "crb"
@@ -71,7 +71,7 @@ jobs:
             arch-type: "x86_64"
             build-type: "Debug"
             qt-version: "5.15.2"
-            cmake-version: "3.29.8"
+            cmake-version: "3.31.6"
             python-version: "3.10"
             vfx-platform: "CY2023"
             extra_repo: "powertools"
@@ -81,7 +81,7 @@ jobs:
             arch-type: "x86_64"
             build-type: "Debug"
             qt-version: "5.15.2"
-            cmake-version: "3.29.8"
+            cmake-version: "3.31.6"
             python-version: "3.10"
             vfx-platform: "CY2023"
             extra_repo: "crb"
@@ -180,7 +180,7 @@ jobs:
           tools: 'tools_qtcreator'
           set-env: 'true'
           tools-only: 'false'
-          aqtversion: '==3.1.*'
+          aqtversion: '==3.2.*'
 
       - name: Install Python dependencies
         run: |
@@ -191,6 +191,7 @@ jobs:
 
       - name: Configure OpenRV
         run: |
+          cmake --version
           export QT_HOME=/__w/OpenRV/OpenRV/deps/Qt/${{ matrix.qt-version}}/gcc_64
           cmake -B _build -G "Ninja" -DCMAKE_BUILD_TYPE=${{ matrix.build-type }} -DRV_DEPS_QT5_LOCATION=$QT_HOME -DRV_VFX_PLATFORM=${{ matrix.vfx-platform }}
    
@@ -228,12 +229,14 @@ jobs:
             build-type: "Release"
             qt-version: "5.15.2"
             python-version: "3.10"
+            cmake-version: "3.31.6"
             vfx-platform: "CY2023"
           - os: "macos-13"
             arch-type: "x86_64"
             build-type: "Debug"
             qt-version: "5.15.2"
             python-version: "3.10"
+            cmake-version: "3.31.6"
             vfx-platform: "CY2023"
     steps:
       - name: Check if it is a schedule job
@@ -266,7 +269,12 @@ jobs:
       - name: Add repository as safe directory
         run: |
           git config --global --add safe.directory /__w/OpenRV/OpenRV
-          
+
+      - name: Install cmake
+        uses: jwlawson/actions-setup-cmake@802fa1a2c4e212495c05bf94dba2704a92a472be # v2
+        with:
+          cmake-version: "${{ matrix.cmake-version }}"
+
       - name: Prepare Qt folder
         run: |
           mkdir -p "${{ github.workspace }}/deps"
@@ -289,7 +297,7 @@ jobs:
           tools: 'tools_qtcreator'
           set-env: 'true'
           tools-only: 'false'
-          aqtversion: '==3.1.*'
+          aqtversion: '==3.2.*'
 
       - name: Patch Qt ${{ matrix.qt-version }}
         if: matrix.arch-type == 'x86_64'
@@ -345,6 +353,7 @@ jobs:
 
       - name: Configure OpenRV
         run: |
+          cmake --version
           cmake -B _build -G "Ninja" -DCMAKE_BUILD_TYPE=${{ matrix.build-type }} -DRV_DEPS_QT5_LOCATION=$QT_HOME -DRV_VFX_PLATFORM=${{ matrix.vfx-platform }}
    
       - name: Build OpenRV dependencies
@@ -385,7 +394,7 @@ jobs:
             build-type: "Release"
             qt-version: "5.15.2"
             python-version: "3.10"
-            cmake-version: "3.29.8"
+            cmake-version: "3.31.6"
             vfx-platform: "CY2023"
             msvc-component: "14.40.17.10.x86.x64"
             msvc-compiler: "14.40.33807"
@@ -394,7 +403,7 @@ jobs:
             build-type: "Debug"
             qt-version: "5.15.2"
             python-version: "3.10"
-            cmake-version: "3.29.8"
+            cmake-version: "3.31.6"
             vfx-platform: "CY2023"
             msvc-component: "14.40.17.10.x86.x64"
             msvc-compiler: "14.40.33807"
@@ -521,7 +530,7 @@ jobs:
           tools: 'tools_qtcreator'
           set-env: 'true'
           tools-only: 'false'
-          aqtversion: '==3.1.*'
+          aqtversion: '==3.2.*'
 
       - name: Install Python dependencies
         run: |
@@ -551,6 +560,7 @@ jobs:
 
       - name: Configure OpenRV
         run: |
+          cmake --version
           export QT_HOME=c:/Qt/${{ matrix.qt-version }}/msvc2019_64
           cmake -B _build -G "Visual Studio 17 2022" -A x64 -DRV_DEPS_WIN_PERL_ROOT=c:/Strawberry/perl/bin -DCMAKE_BUILD_TYPE=${{ matrix.build-type }} -DRV_DEPS_QT5_LOCATION=$QT_HOME -DRV_VFX_PLATFORM=${{ matrix.vfx-platform }}
         shell: msys2 {0}

README.md

@@ -30,7 +30,7 @@ following command:
 git submodule update --init --recursive
 ```
 
-## Configuring Git to use the ignore file with `git blame`
+### Configuring Git to use the ignore file with `git blame`
 
 A `.git-blame-ignore-revs` file lists commits to ignore when running `git blame`, such as formatting commits. This allows you to use `git blame` without these commits cluttering the Git history. To configure Git to use this file when running `git blame`, use the following command:
 
@@ -64,12 +64,31 @@ the MACOSX_DEPLOYMENT_TARGET environment variable.
 
 ### Contributor setup
 
-This repository uses a pre-commit to execute formatting before a commit. To install the pre-commit hooks:
+This repository uses the `pre-commit` tool to execute formatting hooks before a commit. To install the pre-commit hooks, ensure that the packages in `requirements.txt` are installed, and then run the following command:
 
-```shell
+```bash
 pre-commit install
 ```
 
+#### Clang-tidy
+
+It is highly suggested to enable clang-tidy locally to lint the C++ code you plan to contribute to the project. A `.clang-tidy` configuration file is present at the root of the project to help standardize linting rules. While it is recommended to use clangd (which integrates clang-tidy), you can refer to the list of other well-known clang-tidy integrations [here](https://clang.llvm.org/extra/clang-tidy/Integrations.html). For more details on how to install everything you need for your IDE, please follow the steps outlined [here](https://clangd.llvm.org/installation).
+
+1. Install clangd with your package manager
+2. Install the clangd extension in your IDE
+    > **Note:** For VSCode users, after installing [vscode-clangd](https://marketplace.visualstudio.com/items?itemName=llvm-vs-code-extensions.vscode-clangd), you need to disable [Microsoft C/C++ extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools) IntelliSense by adding `"C_Cpp.intelliSenseEngine": "disabled"` to your `settings.json`.
+3. Generate a `compile_commands.json` file with CMake during the [configure step](#configure)
+
+     ```shell
+    rvcfg -DCMAKE_EXPORT_COMPILE_COMMANDS=1
+    ```
+
+4. Create a symlink to the `compile_commands.json` file in the root directory of the project so that `clangd` can locate it:
+
+    ```shell
+    ln -s _build/compile_commands.json compile_commands.json
+    ```
+
 ### Cleanup
 
 To clean your build directory and restart from a clean slate, use the `rvclean` common build alias, or delete
@@ -140,6 +159,20 @@ Example:
 rvcfg -DRV_FFMPEG_NON_FREE_DECODERS_TO_ENABLE="aac;hevc" -DRV_FFMPEG_NON_FREE_ENCODERS_TO_ENABLE="aac"
 ```
 
+##### Apple ProRes on Apple Silicon
+
+On Apple Silicon machines, Open RV supports hardware decoding through Apple's VideoToolbox framework. This feature is enabled by default but can be controlled using the `-DRV_FFMPEG_USE_VIDEOTOOLBOX` option. Set this option to `ON` to enable or `OFF` to disable VideoToolbox hardware decoding.
+
+To enable decoding of ProRes media files, you must also specify the following option during the configuration step:
+
+```bash
+-DRV_FFMPEG_NON_FREE_DECODERS_TO_ENABLE="prores"
+```
+
+Note that you should always have `-DRV_FFMPEG_USE_VIDEOTOOLBOX` enabled when decoding Apple ProRes videos on Apple Silicon machines. Failure to do so will result in performance issues and is not compliant with Apple's licensing requirements.
+
+**Important:** Before enabling ProRes decoding, you are required to obtain a proper license agreement from Apple by contacting [[email protected]](mailto:[email protected]).
+
 #### Manually
 
 ##### Windows

cmake/dependencies/ffmpeg.cmake

@@ -259,6 +259,18 @@ SET(${_force_rebuild}
     FALSE
 )
 
+IF(RV_TARGET_APPLE_ARM64)
+  SET(RV_FFMPEG_USE_VIDEOTOOLBOX_DEFAULT_VALUE
+      ON
+  )
+ELSE()
+  SET(RV_FFMPEG_USE_VIDEOTOOLBOX_DEFAULT_VALUE
+      OFF
+  )
+ENDIF()
+
+OPTION(RV_FFMPEG_USE_VIDEOTOOLBOX "FFmpeg laveraging the VideoToolbox framework" ${RV_FFMPEG_USE_VIDEOTOOLBOX_DEFAULT_VALUE})
+
 # Make a list of the Open RV's FFmpeg config options unless already customized. Note that a super project, a project consuming Open RV as a submodule, can
 # customize the FFmpeg config options via the RV_FFMPEG_CONFIG_OPTIONS cmake property.
 IF(NOT RV_FFMPEG_CONFIG_OPTIONS)