Lines Matching +full:camera +full:- +full:lens
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 -
37 .. flat-table::
38 :header-rows: 0
39 :stub-columns: 0
41 * - ``V4L2_EXPOSURE_AUTO``
42 - Automatic exposure time, automatic iris aperture.
43 * - ``V4L2_EXPOSURE_MANUAL``
44 - Manual exposure time, manual iris.
45 * - ``V4L2_EXPOSURE_SHUTTER_PRIORITY``
46 - Manual exposure time, auto iris.
47 * - ``V4L2_EXPOSURE_APERTURE_PRIORITY``
48 - Auto exposure time, manual iris.
53 Determines the exposure time of the camera sensor. The exposure time
73 light at the image sensor. The camera performs the exposure
76 .. _v4l2-exposure-metering:
81 enum v4l2_exposure_metering -
82 Determines how the camera measures the amount of light available for
87 .. flat-table::
88 :header-rows: 0
89 :stub-columns: 0
91 * - ``V4L2_EXPOSURE_METERING_AVERAGE``
92 - Use the light information coming from the entire frame and average
94 * - ``V4L2_EXPOSURE_METERING_CENTER_WEIGHTED``
95 - Average the light information coming from the entire frame giving
97 * - ``V4L2_EXPOSURE_METERING_SPOT``
98 - Measure only very small area at the center of the frame.
99 * - ``V4L2_EXPOSURE_METERING_MATRIX``
100 - A multi-zone metering. The light intensity is measured in several
108 This control turns the camera horizontally by the specified amount.
109 The unit is undefined. A positive value moves the camera to the
111 left. A value of zero does not cause motion. This is a write-only
115 This control turns the camera vertically by the specified amount.
116 The unit is undefined. A positive value moves the camera up, a
118 a write-only control.
121 When this control is set, the camera moves horizontally to the
125 When this control is set, the camera moves vertically to the default
129 This control turns the camera horizontally to the specified
130 position. Positive values move the camera to the right (clockwise
132 interpret the values as arc seconds, with valid values between -180
136 This control turns the camera vertically to the specified position.
137 Positive values move the camera up, negative values down. Drivers
139 between -180 * 3600 and +180 * 3600 inclusive.
142 This control sets the focal point of the camera to the specified
144 closer to the camera, negative values towards infinity.
147 This control moves the focal point of the camera by the specified
149 to the camera, negative values towards infinity. This is a
150 write-only control.
168 .. _v4l2-auto-focus-status:
171 The automatic focus status. This is a read-only control.
179 .. flat-table::
180 :header-rows: 0
181 :stub-columns: 0
183 * - ``V4L2_AUTO_FOCUS_STATUS_IDLE``
184 - Automatic focus is not active.
185 * - ``V4L2_AUTO_FOCUS_STATUS_BUSY``
186 - Automatic focusing is in progress.
187 * - ``V4L2_AUTO_FOCUS_STATUS_REACHED``
188 - Focus has been reached.
189 * - ``V4L2_AUTO_FOCUS_STATUS_FAILED``
190 - Automatic focus has failed, the driver will not transition from
195 .. _v4l2-auto-focus-range:
200 enum v4l2_auto_focus_range -
201 Determines auto focus distance range for which lens may be adjusted.
205 .. flat-table::
206 :header-rows: 0
207 :stub-columns: 0
209 * - ``V4L2_AUTO_FOCUS_RANGE_AUTO``
210 - The camera automatically selects the focus range.
211 * - ``V4L2_AUTO_FOCUS_RANGE_NORMAL``
212 - Normal distance range, limited for best automatic focus
214 * - ``V4L2_AUTO_FOCUS_RANGE_MACRO``
215 - Macro (close-up) auto focus. The camera will use its minimum
217 * - ``V4L2_AUTO_FOCUS_RANGE_INFINITY``
218 - The lens is set to focus on an object at infinite distance.
223 Specify the objective lens focal length as an absolute value. The
224 zoom unit is driver-specific and its value should be a positive
228 Specify the objective lens focal length relatively to the current
229 value. Positive values move the zoom lens group towards the
230 telephoto direction, negative values towards the wide-angle
231 direction. The zoom unit is driver-specific. This is a write-only
235 Move the objective lens group at the specified speed until it
237 the movement. A positive value moves the zoom lens group towards the
238 telephoto direction. A value of zero stops the zoom lens group
239 movement. A negative value moves the zoom lens group towards the
240 wide-angle direction. The zoom speed unit is driver-specific.
243 This control sets the camera's aperture to the specified value. The
248 This control modifies the camera's aperture by the specified amount.
251 write-only control.
254 Prevent video from being acquired by the camera. When this control
255 is set to ``TRUE`` (1), no image can be captured by the camera.
262 Switch the band-stop filter of a camera sensor on or off, or specify
263 its strength. Such band-stop filters can be used, for example, to
266 .. _v4l2-auto-n-preset-white-balance:
271 enum v4l2_auto_n_preset_white_balance -
273 determine color temperature of the light as a hint to the camera for
280 .. flat-table::
281 :header-rows: 0
282 :stub-columns: 0
284 * - ``V4L2_WHITE_BALANCE_MANUAL``
285 - Manual white balance.
286 * - ``V4L2_WHITE_BALANCE_AUTO``
287 - Automatic white balance adjustments.
288 * - ``V4L2_WHITE_BALANCE_INCANDESCENT``
289 - White balance setting for incandescent (tungsten) lighting. It
292 * - ``V4L2_WHITE_BALANCE_FLUORESCENT``
293 - White balance preset for fluorescent lighting. It corresponds
295 * - ``V4L2_WHITE_BALANCE_FLUORESCENT_H``
296 - With this setting the camera will compensate for fluorescent H
298 * - ``V4L2_WHITE_BALANCE_HORIZON``
299 - White balance setting for horizon daylight. It corresponds
301 * - ``V4L2_WHITE_BALANCE_DAYLIGHT``
302 - White balance preset for daylight (with clear sky). It corresponds
304 * - ``V4L2_WHITE_BALANCE_FLASH``
305 - With this setting the camera will compensate for the flash light.
308 * - ``V4L2_WHITE_BALANCE_CLOUDY``
309 - White balance preset for moderately overcast sky. This option
312 * - ``V4L2_WHITE_BALANCE_SHADE``
313 - White balance preset for shade or heavily overcast sky. It
318 .. _v4l2-wide-dynamic-range:
321 Enables or disables the camera's wide dynamic range feature. This
328 .. _v4l2-image-stabilization:
346 .. _v4l2-iso-sensitivity-auto-type:
351 enum v4l2_iso_sensitivity_type -
356 .. flat-table::
357 :header-rows: 0
358 :stub-columns: 0
360 * - ``V4L2_CID_ISO_SENSITIVITY_MANUAL``
361 - Manual ISO sensitivity.
362 * - ``V4L2_CID_ISO_SENSITIVITY_AUTO``
363 - Automatic ISO sensitivity adjustments.
367 .. _v4l2-scene-mode:
372 enum v4l2_scene_mode -
373 This control allows to select scene programs as the camera automatic
375 camera determines best exposure, aperture, focusing, light metering,
378 behavior in each mode is subject to the camera specification.
392 .. flat-table::
393 :header-rows: 0
394 :stub-columns: 0
396 * - ``V4L2_SCENE_MODE_NONE``
397 - The scene mode feature is disabled.
398 * - ``V4L2_SCENE_MODE_BACKLIGHT``
399 - Backlight. Compensates for dark shadows when light is coming from
401 * - ``V4L2_SCENE_MODE_BEACH_SNOW``
402 - Beach and snow. This mode compensates for all-white or bright
403 scenes, which tend to look gray and low contrast, when camera's
408 * - ``V4L2_SCENE_MODE_CANDLELIGHT``
409 - Candle light. The camera generally raises the ISO sensitivity and
413 * - ``V4L2_SCENE_MODE_DAWN_DUSK``
414 - Dawn and dusk. Preserves the colors seen in low natural light
415 before dusk and after down. The camera may turn off the flash, and
418 * - ``V4L2_SCENE_MODE_FALL_COLORS``
419 - Fall colors. Increases saturation and adjusts white balance for
422 * - ``V4L2_SCENE_MODE_FIREWORKS``
423 - Fireworks. Long exposure times are used to capture the expanding
424 burst of light from a firework. The camera may invoke image
426 * - ``V4L2_SCENE_MODE_LANDSCAPE``
427 - Landscape. The camera may choose a small aperture to provide deep
431 * - ``V4L2_SCENE_MODE_NIGHT``
432 - Night, also known as Night Landscape. Designed for low light
434 out bright objects. The camera generally sets itself to a
435 medium-to-high ISO sensitivity, with a relatively long exposure
438 * - ``V4L2_SCENE_MODE_PARTY_INDOOR``
439 - Party and indoor. Designed to capture indoor scenes that are lit
440 by indoor background lighting as well as the flash. The camera
443 * - ``V4L2_SCENE_MODE_PORTRAIT``
444 - Portrait. The camera adjusts the aperture so that the depth of
449 * - ``V4L2_SCENE_MODE_SPORTS``
450 - Sports. Significantly increases ISO and uses a fast shutter speed
451 to freeze motion of rapidly-moving subjects. Increased image noise
453 * - ``V4L2_SCENE_MODE_SUNSET``
454 - Sunset. Preserves deep hues seen in sunsets and sunrises. It bumps
456 * - ``V4L2_SCENE_MODE_TEXT``
457 - Text. It applies extra contrast and sharpness, it is typically a
458 black-and-white mode optimized for readability. Automatic focus
459 may be switched to close-up mode and this setting may also involve
460 some lens-distortion correction.
470 by setting the corresponding lock bit to 1. The camera then retains
483 .. flat-table::
484 :header-rows: 0
485 :stub-columns: 0
487 * - ``V4L2_LOCK_EXPOSURE``
488 - Automatic exposure adjustments lock.
489 * - ``V4L2_LOCK_WHITE_BALANCE``
490 - Automatic white balance adjustments lock.
491 * - ``V4L2_LOCK_FOCUS``
492 - Automatic focus lock.
497 This control turns the camera horizontally at the specific speed.
498 The unit is undefined. A positive value moves the camera to the
504 This control turns the camera vertically at the specified speed. The
505 unit is undefined. A positive value moves the camera up, a negative
509 .. _v4l2-camera-sensor-orientation:
512 This read-only control describes the camera orientation by reporting its
513 mounting position on the device where the camera is installed. The control
518 example, a camera installed on the user-facing side of a phone, a tablet or
520 orientation, while a camera installed on the opposite side of the front one
521 is said to be have ``V4L2_CAMERA_ORIENTATION_BACK`` orientation. Camera
529 .. flat-table::
530 :header-rows: 0
531 :stub-columns: 0
533 * - ``V4L2_CAMERA_ORIENTATION_FRONT``
534 - The camera is oriented towards the user facing side of the device.
535 * - ``V4L2_CAMERA_ORIENTATION_BACK``
536 - The camera is oriented towards the back facing side of the device.
537 * - ``V4L2_CAMERA_ORIENTATION_EXTERNAL``
538 - The camera is not directly attached to the device and is freely movable.
541 .. _v4l2-camera-sensor-rotation:
544 This read-only control describes the rotation correction in degrees in the
545 counter-clockwise direction to be applied to the captured images once
546 captured to memory to compensate for the camera sensor mounting rotation.
550 bindings file 'video-interfaces.txt'.
555 0 X-axis
556 0 +------------------------------------->
567 Y-axis
569 Example one - Webcam
572 the camera module of the laptop is installed on the user facing part of a
577 The camera is typically mounted upside-down to compensate the lens optical
582 If the camera sensor is not mounted upside-down it is required to compensate
583 the lens optical inversion effect and the value of the
587 +--------------------------------------+
597 +--------------------------------------+
602 +--------------------------------------+
612 +--------------------------------------+
614 Example two - Phone camera
617 with you and take pictures with the camera that is installed on the back
622 The camera sensor is typically mounted with its pixel array longer side
623 aligned to the device longer side, upside-down mounted to compensate for
624 the lens optical inversion effect.
630 +-------------------------------------+
640 +-------------------------------------+
642 A correction of 90 degrees in counter-clockwise direction has to be
646 +--------------------+
661 +--------------------+