^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) .. _detect-controls:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) ************************
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) Detect Control Reference
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) ************************
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) The Detect class includes controls for common features of various motion
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) or object detection capable devices.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) .. _detect-control-id:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) Detect Control IDs
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) ==================
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) ``V4L2_CID_DETECT_CLASS (class)``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) The Detect class descriptor. Calling
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) :ref:`VIDIOC_QUERYCTRL` for this control will
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) return a description of this control class.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) ``V4L2_CID_DETECT_MD_MODE (menu)``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) Sets the motion detection mode.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) .. tabularcolumns:: |p{7.7cm}|p{9.8cm}|
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) .. flat-table::
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) :header-rows: 0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) :stub-columns: 0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) * - ``V4L2_DETECT_MD_MODE_DISABLED``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) - Disable motion detection.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) * - ``V4L2_DETECT_MD_MODE_GLOBAL``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) - Use a single motion detection threshold.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) * - ``V4L2_DETECT_MD_MODE_THRESHOLD_GRID``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) - The image is divided into a grid, each cell with its own motion
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) detection threshold. These thresholds are set through the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) ``V4L2_CID_DETECT_MD_THRESHOLD_GRID`` matrix control.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) * - ``V4L2_DETECT_MD_MODE_REGION_GRID``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) - The image is divided into a grid, each cell with its own region
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) value that specifies which per-region motion detection thresholds
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) should be used. Each region has its own thresholds. How these
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) per-region thresholds are set up is driver-specific. The region
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) values for the grid are set through the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) ``V4L2_CID_DETECT_MD_REGION_GRID`` matrix control.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) ``V4L2_CID_DETECT_MD_GLOBAL_THRESHOLD (integer)``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) Sets the global motion detection threshold to be used with the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) ``V4L2_DETECT_MD_MODE_GLOBAL`` motion detection mode.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) ``V4L2_CID_DETECT_MD_THRESHOLD_GRID (__u16 matrix)``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) Sets the motion detection thresholds for each cell in the grid. To
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) be used with the ``V4L2_DETECT_MD_MODE_THRESHOLD_GRID`` motion
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) detection mode. Matrix element (0, 0) represents the cell at the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) top-left of the grid.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) ``V4L2_CID_DETECT_MD_REGION_GRID (__u8 matrix)``
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) Sets the motion detection region value for each cell in the grid. To
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) be used with the ``V4L2_DETECT_MD_MODE_REGION_GRID`` motion
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) detection mode. Matrix element (0, 0) represents the cell at the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) top-left of the grid.