Release v4.5.2

prophesee-ai · Feb 12, 2024 · 112dd6e · 112dd6e
1 parent 2c9c78d
commit 112dd6e
Show file tree

Hide file tree

Showing 83 changed files with 26,331 additions and 438 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -17,7 +17,7 @@ endif(NOT CMAKE_BUILD_TYPE)
 
 cmake_minimum_required(VERSION 3.5)
 
-project(metavision VERSION 4.5.1)
+project(metavision VERSION 4.5.2)
 set(PROJECT_VERSION_SUFFIX "")
 
 if(PROJECT_VERSION_SUFFIX STREQUAL "")
@@ -62,10 +62,10 @@ set(GENERATE_FILES_DIRECTORY ${CMAKE_BINARY_DIR}/generated)
 file(MAKE_DIRECTORY ${GENERATE_FILES_DIRECTORY})
 
 # Update CMAKE_MODULE_PATH
-list(APPEND CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/cmake/Modules) # For find_packages()
-list(APPEND CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/cmake/custom_functions) # For defining custom cmake functions
-list(APPEND CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/cmake/custom_targets) # For defining custom cmake targets
-list(APPEND CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/cmake/cpack) # For cpack
+list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake/Modules) # For find_packages()
+list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake/custom_functions) # For defining custom cmake functions
+list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake/custom_targets) # For defining custom cmake targets
+list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake/cpack) # For cpack
 
 include(CMakeDependentOption)
 include(overridden_cmake_functions)
@@ -102,6 +102,12 @@ set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(CMAKE_CXX_EXTENSIONS OFF )
 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 
+include(CheckLanguage)
+check_language(CUDA)
+if (CMAKE_CUDA_COMPILER)
+    enable_language(CUDA)
+endif (CMAKE_CUDA_COMPILER)
+
 ################################################### Platform specific
 
 if (MSVC)
@@ -364,7 +370,7 @@ include(add_library_version_header)
 include(add_cpack_component)
 
 if(EXISTS "${CMAKE_CURRENT_LIST_DIR}/cmake/custom_targets_metavision_sdk")
-    list(APPEND CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/cmake/custom_targets_metavision_sdk)
+    list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake/custom_targets_metavision_sdk)
     include(create_metavision_sdk_source_archives)
 endif(EXISTS "${CMAKE_CURRENT_LIST_DIR}/cmake/custom_targets_metavision_sdk")
 

diff --git a/README.md b/README.md
@@ -120,9 +120,9 @@ Make sure that you install a version of CUDA that is compatible with your GPUs b
 
 Note that, at the moment, we don't support [OpenCL](https://www.khronos.org/opencl/) and AMD GPUs.
 
-Then, you will need to install [PyTorch 1.13.1](https://pytorch.org/get-started/locally/).
-Retrieve and execute the pip command from the installation guide.
-If the latest Pytorch version doesn't match, please consider looking  into the [previous versions section](<https://pytorch.org/get-started/previous-versions/>).
+Then, you need to install [PyTorch 1.13.1](https://pytorch.org).
+Retrieve and execute the pip command of version 1.13.1 from
+the [previous versions install guide section](<https://pytorch.org/get-started/previous-versions/#v1131>).
 
 Then install some extra Python libraries:
 
@@ -133,7 +133,7 @@ python3 -m pip install "numba==0.56.3" "profilehooks==1.12.0" "pytorch_lightning
 
 ### Compilation
 
- 1. Retrieve the code: `git clone https://github.com/prophesee-ai/openeb.git --branch 4.5.1`.
+ 1. Retrieve the code: `git clone https://github.com/prophesee-ai/openeb.git --branch 4.5.2`.
     (If you choose to download an archive of OpenEB from GitHub rather than cloning the repository,
     you need to ensure that you select a ``Full.Source.Code.*`` archive instead of using
     the automatically generated ``Source.Code.*`` archives. This is because the latter do not include
@@ -255,8 +255,6 @@ To compile OpenEB, you will need to install some extra tools:
     * `cd <VCPKG_SRC_DIR>`
     * `bootstrap-vcpkg.bat`
   * install the libraries by running `vcpkg.exe install --triplet x64-windows libusb boost opencv dirent gtest glew glfw3 hdf5[cpp,threadsafe,tools,zlib]`
-    * Note that to avoid using `--triplet x64-windows`, which informs vcpkg to install packages for a x64-windows target,
-      you can run `setx VCPKG_DEFAULT_TRIPLET x64-windows` (you need to close the command line and re-open it to ensure that this variable is set)
   * Finally, download and install [ffmpeg](https://www.gyan.dev/ffmpeg/builds/ffmpeg-release-full.7z) and add the `bin` directory to your PATH.
 
 Note that if you are using vcpkg for various projects or multiple versions of OpenEB, you might want to optimize the
@@ -310,9 +308,9 @@ To use Machine Learning features, you need to install some additional dependenci
 First, if you have some Nvidia hardware with GPUs, you can optionally install [CUDA (11.6 or 11.7)](https://developer.nvidia.com/cuda-downloads)
 and [cuDNN](https://docs.nvidia.com/deeplearning/cudnn/install-guide/index.html) to leverage them with pytorch and libtorch.
 
-Then, you will need to install [PyTorch 1.13.1](https://pytorch.org/get-started/locally/).
-Retrieve and execute the pip command from the installation guide.
-If the latest Pytorch version doesn't match, please consider looking  into the [previous versions section](<https://pytorch.org/get-started/previous-versions/>).
+Then, you need to install [PyTorch 1.13.1](https://pytorch.org).
+Retrieve and execute the pip command of version 1.13.1 from
+the [previous versions install guide section](<https://pytorch.org/get-started/previous-versions/#v1131>).
 
 Then install some extra Python libraries:
 
@@ -325,7 +323,7 @@ python -m pip install "numba==0.56.3" "profilehooks==1.12.0" "pytorch_lightning=
 First, retrieve the codebase:
 
 ```bash
-git clone https://github.com/prophesee-ai/openeb.git --branch 4.5.1
+git clone https://github.com/prophesee-ai/openeb.git --branch 4.5.2
 ```
 
 Note that if you choose to download an archive of OpenEB from GitHub rather than cloning the repository,
@@ -339,7 +337,7 @@ a necessary submodule.
 Open a command prompt inside the `openeb` folder (absolute path to this directory is called `OPENEB_SRC_DIR` in next sections) and do as follows:
 
  1. Create and open the build directory, where temporary files will be created: `mkdir build && cd build`
- 2. Generate the makefiles using CMake: `cmake -A x64 -DCMAKE_TOOLCHAIN_FILE=<OPENEB_SRC_DIR>\cmake\toolchains\vcpkg.cmake -DVCPKG_DIRECTORY=<VCPKG_SRC_DIR> ..`.
+ 2. Generate the makefiles using CMake: `cmake .. -A x64 -DCMAKE_TOOLCHAIN_FILE=<OPENEB_SRC_DIR>\cmake\toolchains\vcpkg.cmake -DVCPKG_DIRECTORY=<VCPKG_SRC_DIR>`.
     Note that the value passed to the parameter `-DCMAKE_TOOLCHAIN_FILE` must be an absolute path, not a relative one. 
  3. Compile: `cmake --build . --config Release --parallel 4`
  
@@ -357,42 +355,50 @@ or you can deploy the OpenEB files (applications, samples, libraries etc.) in a
     
 * Option 2 - deploying in a directory of your choice
 
-  * To deploy OpenEB, configure the target folder (`OPENEB_INSTALL_DIR`) with `CMAKE_INSTALL_PREFIX` variable
-    and the directory where the Python packages will be deployed (`PYTHON3_PACKAGES_INSTALL_DIR`) using the `PYTHON3_SITE_PACKAGES` variable
-    when generating the solution in step 2:
+  * To deploy SDK Pro in the default folder (`C:\Program Files\Prophesee`), execute this command 
+    (your console should be launched as an administrator):
 
+    ```bash 
+    cmake --build . --config Release --target install
+    ```
+
+  * To deploy OpenEB in another folder, you should generate the solution again (step 2 above)
+    with the additional variable `CMAKE_INSTALL_PREFIX` having the value of your target folder (`OPENEB_INSTALL_DIR`).
+
+    Similarly, to specify where the Python packages will be deployed (``PYTHON3_PACKAGES_INSTALL_DIR``), you should use
+    the `PYTHON3_SITE_PACKAGES` variable.
+
+    Here is an example of a command customizing those two folders:
+    
     ```bash
-    cmake -A x64 -DCMAKE_TOOLCHAIN_FILE=<OPENEB_SRC_DIR>\cmake\toolchains\vcpkg.cmake -DVCPKG_DIRECTORY=<VCPKG_SRC_DIR> -DCMAKE_INSTALL_PREFIX=<OPENEB_INSTALL_DIR> -DPYTHON3_SITE_PACKAGES=<PYTHON3_PACKAGES_INSTALL_DIR> -DBUILD_TESTING=OFF ..
+    cmake .. -A x64 -DCMAKE_TOOLCHAIN_FILE=<OPENEB_SRC_DIR>\cmake\toolchains\vcpkg.cmake -DVCPKG_DIRECTORY=<VCPKG_SRC_DIR> -DCMAKE_INSTALL_PREFIX=<OPENEB_INSTALL_DIR> -DPYTHON3_SITE_PACKAGES=<PYTHON3_PACKAGES_INSTALL_DIR> -DBUILD_TESTING=OFF
     ```
     
-  *  You can now launch the actual compilation and installation of the OpenEB files (your console should be launched as an administrator) :
+    After this command, you should launch the actual compilation and installation of OpenEB 
+    (your console should be launched as an administrator):
 
     ```bash
     cmake --build . --config Release --parallel 4
     cmake --build . --config Release --target install
     ```
-    
-  * You also need to edit the `PATH`, `HDF5_PLUGIN_PATH` and `PYTHONPATH` environment variables:
 
-    * append `<OPENEB_INSTALL_DIR>\bin` to the `PATH`
-    * append `<OPENEB_INSTALL_DIR>\lib\hdf5\plugin` to the `HDF5_PLUGIN_PATH`
-    * append `<PYTHON3_PACKAGES_INSTALL_DIR>` to the `PYTHONPATH`
-
-  * If you did not customize the install folders when generating the solution, the `PYTHONPATH` environment variable needs
-    not be modified and the `OPENEB_INSTALL_DIR` can be replaced by `C:\Program Files\Prophesee` in the previous instructions.
+  * You also need to manually edit some environment variables:
 
+    * append `<OPENEB_INSTALL_DIR>\bin` to `PATH` (`C:\Program Files\Prophesee\bin` if you used default configuration)
+    * append `<OPENEB_INSTALL_DIR>\lib\metavision\hal\plugins` to `MV_HAL_PLUGIN_PATH` (`C:\Program Files\Prophesee\lib\metavision\hal\plugins` if you used default configuration)
+    * append `<OPENEB_INSTALL_DIR>\lib\hdf5\plugin` to `HDF5_PLUGIN_PATH` (`C:\Program Files\Prophesee\lib\hdf5\plugin` if you used default configuration)
+    * append `<PYTHON3_PACKAGES_INSTALL_DIR>` to `PYTHONPATH` (not needed if you used default configuration)
+    
 
 #### Compilation using MS Visual Studio
 
 Open a command prompt inside the `openeb` folder (absolute path to this directory is called `OPENEB_SRC_DIR` in next sections) and do as follows:
 
  1. Create and open the build directory, where temporary files will be created: `mkdir build && cd build`
- 2. Generate the Visual Studio files using CMake: `cmake -G "Visual Studio 17 2022" -A x64 -DCMAKE_TOOLCHAIN_FILE=<OPENEB_SRC_DIR>\cmake\toolchains\vcpkg.cmake -DVCPKG_DIRECTORY=<VCPKG_SRC_DIR> ..` (adapt to your Visual Studio version).
+ 2. Generate the Visual Studio files using CMake: `cmake .. -G "Visual Studio 17 2022" -A x64 -DCMAKE_TOOLCHAIN_FILE=<OPENEB_SRC_DIR>\cmake\toolchains\vcpkg.cmake -DVCPKG_DIRECTORY=<VCPKG_SRC_DIR>` (adapt to your Visual Studio version).
     Note that the value passed to the parameter `-DCMAKE_TOOLCHAIN_FILE` must be an absolute path, not a relative one.
  3. Open the solution file `metavision.sln`, select the `Release` configuration and build the `ALL_BUILD` project.
 
-
-
 Once the compilation is done, you can choose to work directly from the `build` folder
 or you can deploy the OpenEB files (applications, samples, libraries etc.) in a directory of your choice.
 
@@ -417,11 +423,13 @@ for the cameras to be available on Windows. To do so, follow this procedure:
 
 ```bash
 wdi-simple.exe -n "EVK" -m "Prophesee" -v 0x04b4 -p 0x00f4
-wdi-simple.exe -n "EVK" -m "Prophesee" -v 0x03fd -p 0x5832 -i 00
 wdi-simple.exe -n "EVK" -m "Prophesee" -v 0x04b4 -p 0x00f5
 wdi-simple.exe -n "EVK" -m "Prophesee" -v 0x04b4 -p 0x00f3
 ```
 
+If you own an EVK2 or an RDK2, there are a few additional steps to complete that are detailed in our online documentation
+in the [Camera Plugin section of the OpenEB install guide](https://docs.prophesee.ai/stable/installation/windows_openeb.html#camera-plugins).
+
 If you are using a third-party camera, you need to follow the instructions provided by the camera vendor
 to install the driver and the camera plugin. Make sure that you reference the location of the plugin in
 the `MV_HAL_PLUGIN_PATH` environment variable.
@@ -453,18 +461,16 @@ Running the test suite is a sure-fire way to ensure you did everything well with
 
         ```
         cd <OPENEB_SRC_DIR>/build
-        cmake -A x64 -DCMAKE_TOOLCHAIN_FILE=<OPENEB_SRC_DIR>\cmake\toolchains\vcpkg.cmake -DVCPKG_DIRECTORY=<VCPKG_SRC_DIR> -DBUILD_TESTING=ON ..
+        cmake .. -A x64 -DCMAKE_TOOLCHAIN_FILE=<OPENEB_SRC_DIR>\cmake\toolchains\vcpkg.cmake -DVCPKG_DIRECTORY=<VCPKG_SRC_DIR> -DBUILD_TESTING=ON
         ```
     2. Compile: `cmake --build . --config Release --parallel 4`
 
 
    * Compilation using MS Visual Studio
 
-    1. Generate the Visual Studio files using CMake (adapt the command to your Visual Studio version):
-
-        `cmake -G "Visual Studio 17 2022" -A x64 -DCMAKE_TOOLCHAIN_FILE=<OPENEB_SRC_DIR>\cmake\toolchains\vcpkg.cmake -DVCPKG_DIRECTORY=<VCPKG_SRC_DIR> -DBUILD_TESTING=ON ..`
+    1. Generate the Visual Studio files using CMake (adapt the command to your Visual Studio version and note that `-DCMAKE_TOOLCHAIN_FILE` must be absolute path, not a relative one):
 
-        Note that the value passed to the parameter `-DCMAKE_TOOLCHAIN_FILE` must be an absolute path, not a relative one.
+        `cmake .. -G "Visual Studio 17 2022" -A x64 -DCMAKE_TOOLCHAIN_FILE=<OPENEB_SRC_DIR>\cmake\toolchains\vcpkg.cmake -DVCPKG_DIRECTORY=<VCPKG_SRC_DIR> -DBUILD_TESTING=ON`
 
     2. Open the solution file `metavision.sln`, select the `Release` configuration and build the `ALL_BUILD` project.
 

diff --git a/cmake/custom_functions/add_library_version_header.cmake b/cmake/custom_functions/add_library_version_header.cmake
@@ -8,8 +8,8 @@
 # See the License for the specific language governing permissions and limitations under the License.
 
 set(GIT_BRANCH "main")
-set(GIT_COMMIT_ID "9ec4e835e1cfd4f3bc94b8b390ad5894a4ac0d42")
-set(GIT_COMMIT_DATE "2023-12-21 09:14:06 +0100")
+set(GIT_COMMIT_ID "330aa64e328a2343c85c251e6f483b9c58de7a62")
+set(GIT_COMMIT_DATE "2024-02-09 11:47:53 +0100")
 
 find_program(GIT_SCM git DOC "Git version control" HINTS "C:\\Program Files\\Git\\bin\\")
 

diff --git a/cmake/custom_functions/lfs_download.cmake b/cmake/custom_functions/lfs_download.cmake
@@ -40,7 +40,7 @@ function(lfs_download)
             while (NOT success AND retries GREATER 0)
                 execute_process(
                     COMMAND git lfs pull --include "${file_or_dir_to_download_comma_separated}"
-                    WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
+                    WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}
                     OUTPUT_VARIABLE OUTPUT
                     ERROR_VARIABLE ERROR
                     RESULT_VARIABLE RESULT

diff --git a/cmake/custom_functions/overridden_cmake_functions.cmake b/cmake/custom_functions/overridden_cmake_functions.cmake
@@ -271,10 +271,21 @@ if (WIN32)
         # forwards the call to the vcpkg version (which will eventually call the cmake original one)
         add_library_vcpkg(${ARGN})
         if (NOT LIB_ARGS_OBJECT AND NOT LIB_ARGS_IMPORTED AND NOT LIB_ARGS_ALIAS)
-            # if we are builing a DLL, let's add a resources.rc to embed some details (version, etc.)
+            # If we are building a DLL, let's add a resources.rc to embed some details (version, etc.).
+            # To allow Metavision to be used as a submodule, we need to use the PROJECT_SOURCE_DIR variable to indicate
+            # the path to the template of this resource file.
+            # However, the value of this variable will change when this function is used inside Metavision's internal
+            # submodules (e.g. hdf5). To workaround this problem, we make the assumption that this function won't be
+            # called first by Metavision's internal submodules and we initialize this variable in a cache the first time
+            # it is executed.
+            if(NOT DEFINED RESOURCES_FILE_TEMPLATE_PATH)
+                set(RESOURCES_FILE_TEMPLATE_PATH ${PROJECT_SOURCE_DIR}/utils/windows/resources.rc.in CACHE STRING
+                        "Path to the template of DLLs' resource file")
+            endif ()
+
             set (rc_file_path ${GENERATE_FILES_DIRECTORY}/resources/resources.${ARGV0}.rc)
             set (dll_filename "${ARGV0}")
-            configure_file(${CMAKE_SOURCE_DIR}/utils/windows/resources.rc.in ${rc_file_path})
+            configure_file(${RESOURCES_FILE_TEMPLATE_PATH} ${rc_file_path})
             target_sources(${ARGV0} PRIVATE ${rc_file_path})
         endif ()
     endfunction ()