diff options
Diffstat (limited to 'Documentation/DocBook/v4l/dev-subdev.xml')
-rw-r--r-- | Documentation/DocBook/v4l/dev-subdev.xml | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/Documentation/DocBook/v4l/dev-subdev.xml b/Documentation/DocBook/v4l/dev-subdev.xml index fc62e65f45ef..e9eb8af0f303 100644 --- a/Documentation/DocBook/v4l/dev-subdev.xml +++ b/Documentation/DocBook/v4l/dev-subdev.xml | |||
@@ -275,6 +275,39 @@ | |||
275 | </para> | 275 | </para> |
276 | </section> | 276 | </section> |
277 | 277 | ||
278 | <section> | ||
279 | <title>Cropping and scaling</title> | ||
280 | |||
281 | <para>Many sub-devices support cropping frames on their input or output | ||
282 | pads (or possible even on both). Cropping is used to select the area of | ||
283 | interest in an image, typically on a video sensor or video decoder. It can | ||
284 | also be used as part of digital zoom implementations to select the area of | ||
285 | the image that will be scaled up.</para> | ||
286 | |||
287 | <para>Crop settings are defined by a crop rectangle and represented in a | ||
288 | &v4l2-rect; by the coordinates of the top left corner and the rectangle | ||
289 | size. Both the coordinates and sizes are expressed in pixels.</para> | ||
290 | |||
291 | <para>The crop rectangle is retrieved and set using the | ||
292 | &VIDIOC-SUBDEV-G-CROP; and &VIDIOC-SUBDEV-S-CROP; ioctls. Like for pad | ||
293 | formats, drivers store try and active crop rectangles. The format | ||
294 | negotiation mechanism applies to crop settings as well.</para> | ||
295 | |||
296 | <para>On input pads, cropping is applied relatively to the current pad | ||
297 | format. The pad format represents the image size as received by the | ||
298 | sub-device from the previous block in the pipeline, and the crop rectangle | ||
299 | represents the sub-image that will be transmitted further inside the | ||
300 | sub-device for processing. The crop rectangle be entirely containted | ||
301 | inside the input image size.</para> | ||
302 | |||
303 | <para>Input crop rectangle are reset to their default value when the input | ||
304 | image format is modified. Drivers should use the input image size as the | ||
305 | crop rectangle default value, but hardware requirements may prevent this. | ||
306 | </para> | ||
307 | |||
308 | <para>Cropping behaviour on output pads is not defined.</para> | ||
309 | |||
310 | </section> | ||
278 | </section> | 311 | </section> |
279 | 312 | ||
280 | &sub-subdev-formats; | 313 | &sub-subdev-formats; |