[meshroom] Add AliceVision nodes and templates for Meshroom

.github/workflows/continuous-integration.yml

@@ -94,38 +94,39 @@ jobs:
       - name: Functional Tests - PanoramaFisheyeHdr Pipeline
         working-directory: ./functional_tests
         run: |
-          # clone required repos
+          # Clone required repos
           git clone --branch develop https://github.com/alicevision/Meshroom.git
           git clone --branch main https://github.com/alicevision/dataset_panoramaFisheyeHdr.git
           cd Meshroom/
-          # select meshroom branch
           meshroom_avBranch=$(git ls-remote --heads https://github.com/alicevision/Meshroom.git $GITHUB_HEAD_REF | cut -f 1)
           if [ $meshroom_avBranch != "" ]; then git checkout $meshroom_avBranch; echo "Use Meshroom/$GITHUB_HEAD_REF"; fi
+
+          # Set environment variables specific to Meshroom
           export MESHROOM_INSTALL_DIR=$PWD
+          export MESHROOM_NODES_PATH=${MESHROOM_NODES_PATH}:${ALICEVISION_ROOT}/share/meshroom
+          export MESHROOM_PIPELINE_TEMPLATES_PATH=${MESHROOM_PIPELINE_TEMPLATES_PATH}:${ALICEVISION_ROOT}/share/meshroom
+
+          # Set environment variables to find executables and libraries
           export PYTHONPATH=$PWD:${ALICEVISION_ROOT}/bin:${PYTHONPATH}
           export PATH=$PATH:${ALICEVISION_ROOT}/bin
           export LD_LIBRARY_PATH=${ALICEVISION_ROOT}/lib:${ALICEVISION_ROOT}/lib64:${DEPS_INSTALL_DIR}/lib64:${DEPS_INSTALL_DIR}/lib:${LD_LIBRARY_PATH}
-          mkdir ./outputData
-          cd bin/
-          python3 --version
-          pip3 --version
+
+          # Run the test pipeline
           pip3 install psutil
-          echo "ldd aliceVision_cameraInit"
-          ldd ${ALICEVISION_ROOT}/bin/aliceVision_cameraInit
+          cd bin/
+          mkdir ./outputData
           python3 meshroom_batch -i $PWD/../../dataset_panoramaFisheyeHdr/RAW -p panoramaFisheyeHdr -o $PWD/../outputData
 
       - name: Functional Tests - SfM Quality Evaluation
         working-directory: ./functional_tests
         run: |
           git clone --branch master https://github.com/alicevision/SfM_quality_evaluation.git
           cd SfM_quality_evaluation/
-          # checkout a specific commit to ensure repeatability
+          # Checkout a specific commit to ensure repeatability
           git checkout 36e3bf2d05c64d1726cb4a0e770923794f203f98
           export PYTHONPATH=${ALICEVISION_ROOT}/bin:${PYTHONPATH}
           export LD_LIBRARY_PATH=${ALICEVISION_ROOT}/lib:${ALICEVISION_ROOT}/lib64:${DEPS_INSTALL_DIR}/lib64:${DEPS_INSTALL_DIR}/lib:${LD_LIBRARY_PATH}
-          echo "ldd aliceVision_cameraInit"
-          ldd ${ALICEVISION_ROOT}/bin/aliceVision_cameraInit
-          python3 --version
+
           python3 EvaluationLauncher.py -s ${ALICEVISION_ROOT}/bin -i $PWD/Benchmarking_Camera_Calibration_2008/ -o $PWD/reconstructions/ -r $PWD/results.json -v
 
       - name: Python Binding - Unit Tests
@@ -135,6 +136,27 @@ jobs:
           pip3 install pytest
           pytest ./pyTests
 
+      - name: Meshroom Plugin - Templates validity
+        working-directory: ./functional_tests
+        run: |
+          git clone https://github.com/meshroomHub/mrSegmentation.git
+          cd Meshroom/
+          export MESHROOM_INSTALL_DIR=$PWD
+          export MESHROOM_NODES_PATH=${MESHROOM_NODES_PATH}:${ALICEVISION_ROOT}/share/meshroom:$PWD/../mrSegmentation/meshroom/nodes
+          export MESHROOM_PIPELINE_TEMPLATES_PATH=${MESHROOM_PIPELINE_TEMPLATES_PATH}:${ALICEVISION_ROOT}/share/meshroom
+          export PYTHONPATH=$PWD:${ALICEVISION_ROOT}/bin:${PYTHONPATH}
+          export PATH=$PATH:${ALICEVISION_ROOT}/bin
+          export LD_LIBRARY_PATH=${ALICEVISION_ROOT}/lib:${ALICEVISION_ROOT}/lib64:${DEPS_INSTALL_DIR}/lib64:${DEPS_INSTALL_DIR}/lib:${LD_LIBRARY_PATH}
+
+          echo "
+          import sys
+          from meshroom.core import test
+          if test.checkAllTemplatesVersions():
+              sys.exit(0)
+          sys.exit(1)
+          " | tee test_templatesVersions.py
+          python3 test_templatesVersions.py
+
   build-windows:
     runs-on: windows-latest
     env:
@@ -229,6 +251,7 @@ jobs:
                              -DALICEVISION_BUILD_PHOTOMETRICSTEREO=OFF
                              -DALICEVISION_BUILD_SEGMENTATION=OFF
                              -DALICEVISION_BUILD_SWIG_BINDING=ON
+                             -DALICEVISION_INSTALL_MESHROOM_PLUGIN=OFF
                              -DBOOST_NO_CXX11=ON
 
           cmakeBuildType: Release

CMakeLists.txt

@@ -8,6 +8,7 @@ option(ALICEVISION_BUILD_TESTS "Build AliceVision tests" OFF)
 option(AV_USE_CUDA "Enable CUDA" ON)
 option(AV_USE_OPENMP "Enable OpenMP" $<$<CXX_COMPILER_ID:"AppleClang">,OFF,ON>) # disable by default for AppleClang
 option(BUILD_SHARED_LIBS "Build shared libraries" ON)
+option(ALICEVISION_INSTALL_MESHROOM_PLUGIN "Install AliceVision's plugin for Meshroom" ON)
 
 if(NOT CMAKE_BUILD_TYPE)
     set(CMAKE_BUILD_TYPE Release CACHE STRING "Build type for AliceVision" FORCE)
@@ -85,6 +86,13 @@ install(
 
 endif()
 
+if (ALICEVISION_INSTALL_MESHROOM_PLUGIN)
+    install(
+        DIRECTORY meshroom
+        DESTINATION ${CMAKE_INSTALL_DATADIR}
+    )
+endif()
+
 # Bundle target (see src/cmake/MakeBundle.cmake)
 # Note: require that the install rule has been executed
 # Include VCPKG installed dir for runtime dependencies lookup

meshroom/aliceVision/ApplyCalibration.py

@@ -0,0 +1,49 @@
+__version__ = "1.0"
+
+from meshroom.core import desc
+from meshroom.core.utils import VERBOSE_LEVEL
+
+
+class ApplyCalibration(desc.AVCommandLineNode):
+    commandLine = "aliceVision_applyCalibration {allParams}"
+    size = desc.DynamicNodeSize("input")
+
+    category = "Utils"
+    documentation = """ Overwrite intrinsics with a calibrated intrinsic. """
+
+    inputs = [
+        desc.File(
+            name="input",
+            label="SfMData",
+            description="Input SfMData file.",
+            value="",
+        ),
+        desc.File(
+            name="calibration",
+            label="Calibration",
+            description="Calibration file (SfmData or Lens calibration file).",
+            value="",
+        ),
+        desc.BoolParam(
+            name="useJson",
+            label="Use Lens Calibration File",
+            description="Calibration is a Lens calibration file generated using 3Dequalizer instead of an sfmData.",
+            value=False,
+        ),
+        desc.ChoiceParam(
+            name="verboseLevel",
+            label="Verbose Level",
+            description="Verbosity level (fatal, error, warning, info, debug, trace).",
+            values=VERBOSE_LEVEL,
+            value="info",
+        ),
+    ]
+
+    outputs = [
+        desc.File(
+            name="output",
+            label="SMData",
+            description="Path to the output SfMData file.",
+            value="{nodeCacheFolder}/sfmData.sfm",
+        ),
+    ]

meshroom/aliceVision/CameraCalibration.py

@@ -0,0 +1,129 @@
+__version__ = "1.0"
+
+from meshroom.core import desc
+from meshroom.core.utils import VERBOSE_LEVEL
+
+
+class CameraCalibration(desc.AVCommandLineNode):
+    commandLine = 'aliceVision_cameraCalibration {allParams}'
+
+    category = 'Utils'
+    documentation = '''
+    '''
+
+    inputs = [
+        desc.File(
+            name="input",
+            label="Input",
+            description="Input images in one of the following form:\n"
+                        " - folder containing images.\n"
+                        " - image sequence like \"/path/to/[email protected]\".\n"
+                        " - video file.",
+            value="",
+        ),
+        desc.ChoiceParam(
+            name="pattern",
+            label="Pattern",
+            description="Type of pattern (CHESSBOARD, CIRCLES, ASYMMETRIC_CIRCLES, ASYMMETRIC_CCTAG).",
+            value="CHESSBOARD",
+            values=["CHESSBOARD", "CIRCLES", "ASYMMETRIC_CIRCLES", "ASYMMETRIC_CCTAG"],
+        ),
+        desc.GroupAttribute(
+            name="size",
+            label="Size",
+            description="Number of inner corners per one of board dimension like W H.",
+            groupDesc=[
+                desc.IntParam(
+                    name="width",
+                    label="Width",
+                    description="",
+                    value=7,
+                    range=(0, 10000, 1),
+                ),
+                desc.IntParam(
+                    name="height",
+                    label="Height",
+                    description="",
+                    value=5,
+                    range=(0, 10000, 1),
+                ),
+            ],
+        ),
+        desc.FloatParam(
+            name="squareSize",
+            label="Square Size",
+            description="Size of the grid's square cells (mm).",
+            value=1.0,
+            range=(0.0, 100.0, 1.0),
+        ),
+        desc.IntParam(
+            name="nbDistortionCoef",
+            label="Nb Distortion Coef",
+            description="Number of distortion coefficients.",
+            value=3,
+            range=(0, 5, 1),
+        ),
+        desc.IntParam(
+            name="maxFrames",
+            label="Max Frames",
+            description="Maximum number of frames to extract from the video file.",
+            value=0,
+            range=(0, 5, 1),
+        ),
+        desc.IntParam(
+            name="maxCalibFrames",
+            label="Max Calib Frames",
+            description="Maximum number of frames to use to calibrate from the selected frames.",
+            value=100,
+            range=(0, 1000, 1),
+        ),
+        desc.IntParam(
+            name="calibGridSize",
+            label="Calib Grid Size",
+            description="Define the number of cells per edge.",
+            value=10,
+            range=(0, 50, 1),
+        ),
+        desc.IntParam(
+            name="minInputFrames",
+            label="Min Input Frames",
+            description="Minimum number of frames to limit the refinement loop.",
+            value=10,
+            range=(0, 100, 1),
+        ),
+        desc.FloatParam(
+            name="maxTotalAvgErr",
+            label="Max Total Avg Err",
+            description="Maximum total average error.",
+            value=0.10000000000000001,
+            range=(0.0, 1.0, 0.01),
+        ),
+        desc.File(
+            name="debugRejectedImgFolder",
+            label="Debug Rejected Img Folder",
+            description="Folder to export images that were deleted during the refinement loop.",
+            value="",
+        ),
+        desc.File(
+            name="debugSelectedImgFolder",
+            label="Debug Selected Img Folder",
+            description="Folder to export debug images.",
+            value="",
+        ),
+        desc.ChoiceParam(
+            name="verboseLevel",
+            label="Verbose Level",
+            description="Verbosity level (fatal, error, warning, info, debug, trace).",
+            values=VERBOSE_LEVEL,
+            value="info",
+        ),
+    ]
+
+    outputs = [
+        desc.File(
+            name="output",
+            label="Output",
+            description="Output filename for intrinsic [and extrinsic] parameters.",
+            value="{nodeCacheFolder}/cameraCalibration.cal",
+        ),
+    ]