[nodes] KeyframeSelection: Remove old parameters and add new method

This commit removes most of the existing parameters for the keyframe
selection and adds new ones to enable the regular keyframe selection.

Since the regular method is the only one available for now, the parameter
that allows the user to enable it or not is disabled.

meshroom/nodes/aliceVision/KeyframeSelection.py

@@ -24,9 +24,9 @@ You can extract frames at regular interval by configuring only the min/maxFrameS
                 value="",
                 uid=[0],
             ),
-            name='mediaPaths',
+            name="mediaPaths",
-            label='Media Paths',
+            label="Media Paths",
-            description='Input video files or image sequence directories.',
+            description="Input video files or image sequence directories.",
         ),
         desc.ListAttribute(
             elementDesc=desc.File(
@@ -56,124 +56,73 @@ You can extract frames at regular interval by configuring only the min/maxFrameS
             elementDesc=desc.FloatParam(
                 name="mmFocal",
                 label="mmFocal",
-                description="Focal in mm (will be use if not 0).",
+                description="Focal in mm (will be used if not 0).",
                 value=0.0,
                 range=(0.0, 500.0, 1.0),
                 uid=[0],
             ),
             name="mmFocals",
             label="mmFocals",
-            description="Focals in mm (will be use if not 0)."
+            description="Focals in mm (will be used if not 0)."
         ),
-        desc.ListAttribute(
+        desc.File(
-            elementDesc=desc.FloatParam(
+            name="sensorDbPath",
-                name="pxFocal",
+            label="Sensor Db Path",
-                label="pxFocal",
+            description="Camera sensor width database path.",
-                description="Focal in px (will be use and convert in mm if not 0).",
+            value="${ALICEVISION_SENSOR_DB}",
-                value=0.0,
-                range=(0.0, 500.0, 1.0),
             uid=[0],
         ),
-            name="pxFocals",
+        desc.GroupAttribute(
-            label="pxFocals",
+            name="regularSelection",
-            description="Focals in px (will be use and convert in mm if not 0)."
+            label="Regular Keyframe Selection",
+            description="Parameters for the regular keyframe selection.\nKeyframes are selected regularly over the sequence with respect to the set parameters.",
+            group=None,  # skip group from command line
+            groupDesc=[
+                desc.BoolParam(
+                    name="useRegularSelection",
+                    label="Use Regular Selection",
+                    description="Enable and use the regular keyframe selection.",
+                    value=True,
+                    uid=[0],
+                    enabled=False,  # only method for now, it must always be enabled
                 ),
-        desc.ListAttribute(
+                desc.IntParam(
-            elementDesc=desc.IntParam(
+                    name="minFrameStep",
-                name="frameOffset",
+                    label="Min Frame Step",
-                label="Frame Offset",
+                    description="Minimum number of frames between two keyframes.",
-                description="Frame offset.",
+                    value=12,
+                    range=(1, 1000, 1),
+                    uid=[0],
+                    enabled=lambda node: node.regularSelection.useRegularSelection.value
+                ),
+                desc.IntParam(
+                    name="maxFrameStep",
+                    label="Max Frame Step",
+                    description="Maximum number of frames between two keyframes. Ignored if equal to 0.",
                     value=0,
-                range=(0, 100, 1),
+                    range=(0, 1000, 1),
-                uid=[0],
-            ),
-            name="frameOffsets",
-            label="Frame Offsets",
-            description="Frame offsets."
-        ),
-        desc.File(
-            name='sensorDbPath',
-            label='Sensor Db Path',
-            description='''Camera sensor width database path.''',
-            value='${ALICEVISION_SENSOR_DB}',
-            uid=[0],
-        ),
-        desc.File(
-            name='voctreePath',
-            label='Voctree Path',
-            description='''Vocabulary tree path.''',
-            value='${ALICEVISION_VOCTREE}',
-            uid=[0],
-        ),
-        desc.BoolParam(
-            name='useSparseDistanceSelection',
-            label='Use Sparse Distance Selection',
-            description='Use sparseDistance selection in order to avoid similar keyframes.',
-            value=False,
-            uid=[0],
-        ),
-        desc.BoolParam(
-            name='useSharpnessSelection',
-            label='Use Sharpness Selection',
-            description='Use frame sharpness score for keyframe selection.',
-            value=False,
-            uid=[0],
-        ),
-        desc.FloatParam(
-            name='sparseDistMaxScore',
-            label='Sparse Distance Max Score',
-            description='Maximum number of strong common points between two keyframes.',
-            value=100.0,
-            range=(1.0, 200.0, 1.0),
-            uid=[0],
-        ),
-        desc.ChoiceParam(
-            name='sharpnessPreset',
-            label='Sharpness Preset',
-            description='Preset for sharpnessSelection : {ultra, high, normal, low, very_low, none}',
-            value='normal',
-            values=['ultra', 'high', 'normal', 'low', 'very_low', 'none'],
-            exclusive=True,
                     uid=[0],
+                    enabled=lambda node: node.regularSelection.useRegularSelection.value
                 ),
                 desc.IntParam(
-            name='sharpSubset',
+                    name="maxNbOutFrames",
-            label='Sharp Subset',
+                    label="Max Nb Output Frames",
-            description='''sharp part of the image (1 = all, 2 = size/2, ...)''',
+                    description="Maximum number of output frames (0 = no limit).\n"
-            value=4,
+                                "'minFrameStep' and 'maxFrameStep' will always be respected, so combining them with this parameter\n"
-            range=(1, 100, 1),
+                                "might cause the selection to stop before reaching the end of the input sequence(s).",
-            uid=[0],
-        ),
-        desc.IntParam(
-            name='minFrameStep',
-            label='Min Frame Step',
-            description='''minimum number of frames between two keyframes''',
-            value=1,
-            range=(1, 100, 1),
-            uid=[0],
-        ),
-        desc.IntParam(
-            name='maxFrameStep',
-            label='Max Frame Step',
-            description='''maximum number of frames after which a keyframe can be taken''',
-            value=2,
-            range=(2, 1000, 1),
-            uid=[0],
-        ),
-        desc.IntParam(
-            name='maxNbOutFrame',
-            label='Max Nb Out Frame',
-            description='''maximum number of output frames (0 = no limit)''',
                     value=0,
                     range=(0, 10000, 1),
                     uid=[0],
+                    enabled=lambda node: node.regularSelection.useRegularSelection.value
+                ),
+            ],
         ),
         desc.ChoiceParam(
-            name='verboseLevel',
+            name="verboseLevel",
-            label='Verbose Level',
+            label="Verbose Level",
-            description='verbosity level (fatal, error, warning, info, debug, trace).',
+            description="Verbosity level (fatal, error, warning, info, debug, trace).",
-            value='info',
+            value="info",
-            values=['fatal', 'error', 'warning', 'info', 'debug', 'trace'],
+            values=["fatal", "error", "warning", "info", "debug", "trace"],
             exclusive=True,
             uid=[],
         ),
@@ -181,9 +130,9 @@ You can extract frames at regular interval by configuring only the min/maxFrameS
 
     outputs = [
         desc.File(
-            name='outputFolder',
+            name="outputFolder",
-            label='Folder',
+            label="Folder",
-            description='''Output keyframes folder for extracted frames.''',
+            description="Output keyframes folder for extracted frames.",
             value=desc.Node.internalFolder,
             uid=[],
         ),