Lines Matching +full:camera +full:- +full:sensor
1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
3 .. _camera-controls:
6 Camera Control Reference
9 The Camera class includes controls for mechanical (or equivalent
13 .. _camera-control-id:
15 Camera Control IDs
19 The Camera class descriptor. Calling
23 .. _v4l2-exposure-auto-type:
28 enum v4l2_exposure_auto_type -
36 .. flat-table::
37 :header-rows: 0
38 :stub-columns: 0
40 * - ``V4L2_EXPOSURE_AUTO``
41 - Automatic exposure time, automatic iris aperture.
42 * - ``V4L2_EXPOSURE_MANUAL``
43 - Manual exposure time, manual iris.
44 * - ``V4L2_EXPOSURE_SHUTTER_PRIORITY``
45 - Manual exposure time, auto iris.
46 * - ``V4L2_EXPOSURE_APERTURE_PRIORITY``
47 - Auto exposure time, manual iris.
52 Determines the exposure time of the camera sensor. The exposure time
72 light at the image sensor. The camera performs the exposure
75 .. _v4l2-exposure-metering:
80 enum v4l2_exposure_metering -
81 Determines how the camera measures the amount of light available for
86 .. flat-table::
87 :header-rows: 0
88 :stub-columns: 0
90 * - ``V4L2_EXPOSURE_METERING_AVERAGE``
91 - Use the light information coming from the entire frame and average
93 * - ``V4L2_EXPOSURE_METERING_CENTER_WEIGHTED``
94 - Average the light information coming from the entire frame giving
96 * - ``V4L2_EXPOSURE_METERING_SPOT``
97 - Measure only very small area at the center of the frame.
98 * - ``V4L2_EXPOSURE_METERING_MATRIX``
99 - A multi-zone metering. The light intensity is measured in several
107 This control turns the camera horizontally by the specified amount.
108 The unit is undefined. A positive value moves the camera to the
110 left. A value of zero does not cause motion. This is a write-only
114 This control turns the camera vertically by the specified amount.
115 The unit is undefined. A positive value moves the camera up, a
117 a write-only control.
120 When this control is set, the camera moves horizontally to the
124 When this control is set, the camera moves vertically to the default
128 This control turns the camera horizontally to the specified
129 position. Positive values move the camera to the right (clockwise
131 interpret the values as arc seconds, with valid values between -180
135 This control turns the camera vertically to the specified position.
136 Positive values move the camera up, negative values down. Drivers
138 between -180 * 3600 and +180 * 3600 inclusive.
141 This control sets the focal point of the camera to the specified
143 closer to the camera, negative values towards infinity.
146 This control moves the focal point of the camera by the specified
148 to the camera, negative values towards infinity. This is a
149 write-only control.
167 .. _v4l2-auto-focus-status:
170 The automatic focus status. This is a read-only control.
178 .. flat-table::
179 :header-rows: 0
180 :stub-columns: 0
182 * - ``V4L2_AUTO_FOCUS_STATUS_IDLE``
183 - Automatic focus is not active.
184 * - ``V4L2_AUTO_FOCUS_STATUS_BUSY``
185 - Automatic focusing is in progress.
186 * - ``V4L2_AUTO_FOCUS_STATUS_REACHED``
187 - Focus has been reached.
188 * - ``V4L2_AUTO_FOCUS_STATUS_FAILED``
189 - Automatic focus has failed, the driver will not transition from
194 .. _v4l2-auto-focus-range:
199 enum v4l2_auto_focus_range -
204 .. flat-table::
205 :header-rows: 0
206 :stub-columns: 0
208 * - ``V4L2_AUTO_FOCUS_RANGE_AUTO``
209 - The camera automatically selects the focus range.
210 * - ``V4L2_AUTO_FOCUS_RANGE_NORMAL``
211 - Normal distance range, limited for best automatic focus
213 * - ``V4L2_AUTO_FOCUS_RANGE_MACRO``
214 - Macro (close-up) auto focus. The camera will use its minimum
216 * - ``V4L2_AUTO_FOCUS_RANGE_INFINITY``
217 - The lens is set to focus on an object at infinite distance.
223 zoom unit is driver-specific and its value should be a positive
229 telephoto direction, negative values towards the wide-angle
230 direction. The zoom unit is driver-specific. This is a write-only
239 wide-angle direction. The zoom speed unit is driver-specific.
242 This control sets the camera's aperture to the specified value. The
247 This control modifies the camera's aperture by the specified amount.
250 write-only control.
253 Prevent video from being acquired by the camera. When this control
254 is set to ``TRUE`` (1), no image can be captured by the camera.
256 sensor and firmware image processing, but the device is not
261 Switch the band-stop filter of a camera sensor on or off, or specify
262 its strength. Such band-stop filters can be used, for example, to
265 .. _v4l2-auto-n-preset-white-balance:
270 enum v4l2_auto_n_preset_white_balance -
272 determine color temperature of the light as a hint to the camera for
279 .. flat-table::
280 :header-rows: 0
281 :stub-columns: 0
283 * - ``V4L2_WHITE_BALANCE_MANUAL``
284 - Manual white balance.
285 * - ``V4L2_WHITE_BALANCE_AUTO``
286 - Automatic white balance adjustments.
287 * - ``V4L2_WHITE_BALANCE_INCANDESCENT``
288 - White balance setting for incandescent (tungsten) lighting. It
291 * - ``V4L2_WHITE_BALANCE_FLUORESCENT``
292 - White balance preset for fluorescent lighting. It corresponds
294 * - ``V4L2_WHITE_BALANCE_FLUORESCENT_H``
295 - With this setting the camera will compensate for fluorescent H
297 * - ``V4L2_WHITE_BALANCE_HORIZON``
298 - White balance setting for horizon daylight. It corresponds
300 * - ``V4L2_WHITE_BALANCE_DAYLIGHT``
301 - White balance preset for daylight (with clear sky). It corresponds
303 * - ``V4L2_WHITE_BALANCE_FLASH``
304 - With this setting the camera will compensate for the flash light.
307 * - ``V4L2_WHITE_BALANCE_CLOUDY``
308 - White balance preset for moderately overcast sky. This option
311 * - ``V4L2_WHITE_BALANCE_SHADE``
312 - White balance preset for shade or heavily overcast sky. It
317 .. _v4l2-wide-dynamic-range:
320 Enables or disables the camera's wide dynamic range feature. This
327 .. _v4l2-image-stabilization:
333 Determines ISO equivalent of an image sensor indicating the sensor's
335 as per :ref:`iso12232` standard, where doubling the sensor
345 .. _v4l2-iso-sensitivity-auto-type:
350 enum v4l2_iso_sensitivity_type -
355 .. flat-table::
356 :header-rows: 0
357 :stub-columns: 0
359 * - ``V4L2_CID_ISO_SENSITIVITY_MANUAL``
360 - Manual ISO sensitivity.
361 * - ``V4L2_CID_ISO_SENSITIVITY_AUTO``
362 - Automatic ISO sensitivity adjustments.
366 .. _v4l2-scene-mode:
371 enum v4l2_scene_mode -
372 This control allows to select scene programs as the camera automatic
374 camera determines best exposure, aperture, focusing, light metering,
377 behavior in each mode is subject to the camera specification.
389 .. flat-table::
390 :header-rows: 0
391 :stub-columns: 0
393 * - ``V4L2_SCENE_MODE_NONE``
394 - The scene mode feature is disabled.
395 * - ``V4L2_SCENE_MODE_BACKLIGHT``
396 - Backlight. Compensates for dark shadows when light is coming from
398 * - ``V4L2_SCENE_MODE_BEACH_SNOW``
399 - Beach and snow. This mode compensates for all-white or bright
400 scenes, which tend to look gray and low contrast, when camera's
405 * - ``V4L2_SCENE_MODE_CANDLELIGHT``
406 - Candle light. The camera generally raises the ISO sensitivity and
410 * - ``V4L2_SCENE_MODE_DAWN_DUSK``
411 - Dawn and dusk. Preserves the colors seen in low natural light
412 before dusk and after down. The camera may turn off the flash, and
415 * - ``V4L2_SCENE_MODE_FALL_COLORS``
416 - Fall colors. Increases saturation and adjusts white balance for
419 * - ``V4L2_SCENE_MODE_FIREWORKS``
420 - Fireworks. Long exposure times are used to capture the expanding
421 burst of light from a firework. The camera may invoke image
423 * - ``V4L2_SCENE_MODE_LANDSCAPE``
424 - Landscape. The camera may choose a small aperture to provide deep
428 * - ``V4L2_SCENE_MODE_NIGHT``
429 - Night, also known as Night Landscape. Designed for low light
431 out bright objects. The camera generally sets itself to a
432 medium-to-high ISO sensitivity, with a relatively long exposure
435 * - ``V4L2_SCENE_MODE_PARTY_INDOOR``
436 - Party and indoor. Designed to capture indoor scenes that are lit
437 by indoor background lighting as well as the flash. The camera
440 * - ``V4L2_SCENE_MODE_PORTRAIT``
441 - Portrait. The camera adjusts the aperture so that the depth of
446 * - ``V4L2_SCENE_MODE_SPORTS``
447 - Sports. Significantly increases ISO and uses a fast shutter speed
448 to freeze motion of rapidly-moving subjects. Increased image noise
450 * - ``V4L2_SCENE_MODE_SUNSET``
451 - Sunset. Preserves deep hues seen in sunsets and sunrises. It bumps
453 * - ``V4L2_SCENE_MODE_TEXT``
454 - Text. It applies extra contrast and sharpness, it is typically a
455 black-and-white mode optimized for readability. Automatic focus
456 may be switched to close-up mode and this setting may also involve
457 some lens-distortion correction.
467 by setting the corresponding lock bit to 1. The camera then retains
480 .. flat-table::
481 :header-rows: 0
482 :stub-columns: 0
484 * - ``V4L2_LOCK_EXPOSURE``
485 - Automatic exposure adjustments lock.
486 * - ``V4L2_LOCK_WHITE_BALANCE``
487 - Automatic white balance adjustments lock.
488 * - ``V4L2_LOCK_FOCUS``
489 - Automatic focus lock.
494 This control turns the camera horizontally at the specific speed.
495 The unit is undefined. A positive value moves the camera to the
501 This control turns the camera vertically at the specified speed. The
502 unit is undefined. A positive value moves the camera up, a negative
507 This read-only control describes the camera orientation by reporting its
508 mounting position on the device where the camera is installed. The control
513 example, a camera installed on the user-facing side of a phone, a tablet or
515 orientation, while a camera installed on the opposite side of the front one
516 is said to be have ``V4L2_CAMERA_ORIENTATION_BACK`` orientation. Camera
523 .. flat-table::
524 :header-rows: 0
525 :stub-columns: 0
527 * - ``V4L2_CAMERA_ORIENTATION_FRONT``
528 - The camera is oriented towards the user facing side of the device.
529 * - ``V4L2_CAMERA_ORIENTATION_BACK``
530 - The camera is oriented towards the back facing side of the device.
531 * - ``V4L2_CAMERA_ORIENTATION_EXTERNAL``
532 - The camera is not directly attached to the device and is freely movable.
537 This read-only control describes the rotation correction in degrees in the
538 counter-clockwise direction to be applied to the captured images once
539 captured to memory to compensate for the camera sensor mounting rotation.
541 For a precise definition of the sensor mounting rotation refer to the
543 bindings file 'video-interfaces.txt'.
548 0 X-axis
549 0 +------------------------------------->
560 Y-axis
562 Example one - Webcam
565 the camera module of the laptop is installed on the user facing part of a
570 The camera is typically mounted upside-down to compensate the lens optical
575 If the camera sensor is not mounted upside-down it is required to compensate
580 +--------------------------------------+
590 +--------------------------------------+
595 +--------------------------------------+
605 +--------------------------------------+
607 Example two - Phone camera
610 with you and take pictures with the camera that is installed on the back
615 The camera sensor is typically mounted with its pixel array longer side
616 aligned to the device longer side, upside-down mounted to compensate for
623 +-------------------------------------+
633 +-------------------------------------+
635 A correction of 90 degrees in counter-clockwise direction has to be
639 +--------------------+
654 +--------------------+