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