Documentation/userspace-api/media/v4l/ext-ctrls-detect.rst

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