media/v4l/pixfmt-meta-d4xx.rst

1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
3 .. _v4l2-meta-fmt-d4xx:
15 Intel D4xx (D435 and other) cameras include per-frame metadata in their UVC
35 .. flat-table:: D4xx metadata
37     :header-rows:  1
38     :stub-columns: 0
40     * - **Field**
41       - **Description**
42     * - :cspan:`1` *Depth Control*
43     * - __u32 ID
44       - 0x80000000
45     * - __u32 Size
46       - Size in bytes (currently 56)
47     * - __u32 Version
48       - Version of this structure. The documentation herein corresponds to
49         version xxx. The version number will be incremented when new fields are
51     * - __u32 Flags
52       - A bitmask of flags: see [2_] below
53     * - __u32 Gain
54       - Gain value in internal units, same as the V4L2_CID_GAIN control, used to
56     * - __u32 Exposure
57       - Exposure time (in microseconds) used to capture the frame
58     * - __u32 Laser power
59       - Power of the laser LED 0-360, used for depth measurement
60     * - __u32 AE mode
61       - 0: manual; 1: automatic exposure
62     * - __u32 Exposure priority
63       - Exposure priority value: 0 - constant frame rate
64     * - __u32 AE ROI left
65       - Left border of the AE Region of Interest (all ROI values are in pixels
67     * - __u32 AE ROI right
68       - Right border of the AE Region of Interest
69     * - __u32 AE ROI top
70       - Top border of the AE Region of Interest
71     * - __u32 AE ROI bottom
72       - Bottom border of the AE Region of Interest
73     * - __u32 Preset
74       - Preset selector value, default: 0, unless changed by the user
75     * - __u32 Laser mode
76       - 0: off, 1: on
77     * - :cspan:`1` *Capture Timing*
78     * - __u32 ID
79       - 0x80000001
80     * - __u32 Size
81       - Size in bytes (currently 40)
82     * - __u32 Version
83       - Version of this structure. The documentation herein corresponds to
84         version xxx. The version number will be incremented when new fields are
86     * - __u32 Flags
87       - A bitmask of flags: see [3_] below
88     * - __u32 Frame counter
89       - Monotonically increasing counter
90     * - __u32 Optical time
91       - Time in microseconds from the beginning of a frame till its middle
92     * - __u32 Readout time
93       - Time, used to read out a frame in microseconds
94     * - __u32 Exposure time
95       - Frame exposure time in microseconds
96     * - __u32 Frame interval
97       - In microseconds = 1000000 / framerate
98     * - __u32 Pipe latency
99       - Time in microseconds from start of frame to data in USB buffer
100     * - :cspan:`1` *Configuration*
101     * - __u32 ID
102       - 0x80000002
103     * - __u32 Size
104       - Size in bytes (currently 40)
105     * - __u32 Version
106       - Version of this structure. The documentation herein corresponds to
107         version xxx. The version number will be incremented when new fields are
109     * - __u32 Flags
110       - A bitmask of flags: see [4_] below
111     * - __u8 Hardware type
112       - Camera hardware version [5_]
113     * - __u8 SKU ID
114       - Camera hardware configuration [6_]
115     * - __u32 Cookie
116       - Internal synchronisation
117     * - __u16 Format
118       - Image format code [7_]
119     * - __u16 Width
120       - Width in pixels
121     * - __u16 Height
122       - Height in pixels
123     * - __u16 Framerate
124       - Requested frame rate per second
125     * - __u16 Trigger
126       - Byte 0: bit 0: depth and RGB are synchronised, bit 1: external trigger
130 [1] https://docs.microsoft.com/en-us/windows-hardware/drivers/stream/uvc-extensions-1-5
139   0x00000008 AE mode
178 [6] 8-bit camera hardware configuration bitfield: ::
185   [2]   depthIsActive - has a laser projector