aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/DocBook
diff options
context:
space:
mode:
authorSakari Ailus <sakari.ailus@iki.fi>2012-02-02 18:17:54 -0500
committerMauro Carvalho Chehab <mchehab@redhat.com>2012-05-14 07:37:44 -0400
commitc643ee135190389e03cffd80e762c9c71dc9a165 (patch)
treedbd22fb0fe7c816f1b8595bbd01605ea43f624e7 /Documentation/DocBook
parent8c9d236ec64f1f1e7764385e7b5eae88eec7c02b (diff)
[media] v4l: Image processing control class
Add control class for image processing controls. The control class deals with controls processing image, for example digital gain or noise filtering, which can be present in any part of the pipeline. Signed-off-by: Sakari Ailus <sakari.ailus@iki.fi> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
Diffstat (limited to 'Documentation/DocBook')
-rw-r--r--Documentation/DocBook/media/v4l/controls.xml82
-rw-r--r--Documentation/DocBook/media/v4l/vidioc-g-ext-ctrls.xml6
2 files changed, 88 insertions, 0 deletions
diff --git a/Documentation/DocBook/media/v4l/controls.xml b/Documentation/DocBook/media/v4l/controls.xml
index 43cd4958c9e8..662127447aa6 100644
--- a/Documentation/DocBook/media/v4l/controls.xml
+++ b/Documentation/DocBook/media/v4l/controls.xml
@@ -3685,4 +3685,86 @@ interface and may change in the future.</para>
3685 3685
3686 </section> 3686 </section>
3687 3687
3688 <section id="image-process-controls">
3689 <title>Image Process Control Reference</title>
3690
3691 <note>
3692 <title>Experimental</title>
3693
3694 <para>This is an <link
3695 linkend="experimental">experimental</link> interface and may
3696 change in the future.</para>
3697 </note>
3698
3699 <para>
3700 The Image Source control class is intended for low-level control of
3701 image processing functions. Unlike
3702 <constant>V4L2_CID_IMAGE_SOURCE_CLASS</constant>, the controls in
3703 this class affect processing the image, and do not control capturing
3704 of it.
3705 </para>
3706
3707 <table pgwide="1" frame="none" id="image-process-control-id">
3708 <title>Image Source Control IDs</title>
3709
3710 <tgroup cols="4">
3711 <colspec colname="c1" colwidth="1*" />
3712 <colspec colname="c2" colwidth="6*" />
3713 <colspec colname="c3" colwidth="2*" />
3714 <colspec colname="c4" colwidth="6*" />
3715 <spanspec namest="c1" nameend="c2" spanname="id" />
3716 <spanspec namest="c2" nameend="c4" spanname="descr" />
3717 <thead>
3718 <row>
3719 <entry spanname="id" align="left">ID</entry>
3720 <entry align="left">Type</entry>
3721 </row><row rowsep="1"><entry spanname="descr" align="left">Description</entry>
3722 </row>
3723 </thead>
3724 <tbody valign="top">
3725 <row><entry></entry></row>
3726 <row>
3727 <entry spanname="id"><constant>V4L2_CID_IMAGE_PROC_CLASS</constant></entry>
3728 <entry>class</entry>
3729 </row>
3730 <row>
3731 <entry spanname="descr">The IMAGE_PROC class descriptor.</entry>
3732 </row>
3733 <row>
3734 <entry spanname="id"><constant>V4L2_CID_LINK_FREQ</constant></entry>
3735 <entry>integer menu</entry>
3736 </row>
3737 <row>
3738 <entry spanname="descr">Data bus frequency. Together with the
3739 media bus pixel code, bus type (clock cycles per sample), the
3740 data bus frequency defines the pixel rate
3741 (<constant>V4L2_CID_PIXEL_RATE</constant>) in the
3742 pixel array (or possibly elsewhere, if the device is not an
3743 image sensor). The frame rate can be calculated from the pixel
3744 clock, image width and height and horizontal and vertical
3745 blanking. While the pixel rate control may be defined elsewhere
3746 than in the subdev containing the pixel array, the frame rate
3747 cannot be obtained from that information. This is because only
3748 on the pixel array it can be assumed that the vertical and
3749 horizontal blanking information is exact: no other blanking is
3750 allowed in the pixel array. The selection of frame rate is
3751 performed by selecting the desired horizontal and vertical
3752 blanking. The unit of this control is Hz. </entry>
3753 </row>
3754 <row>
3755 <entry spanname="id"><constant>V4L2_CID_PIXEL_RATE</constant></entry>
3756 <entry>64-bit integer</entry>
3757 </row>
3758 <row>
3759 <entry spanname="descr">Pixel rate in the source pads of
3760 the subdev. This control is read-only and its unit is
3761 pixels / second.
3762 </entry>
3763 </row>
3764 <row><entry></entry></row>
3765 </tbody>
3766 </tgroup>
3767 </table>
3768
3769 </section>
3688</section> 3770</section>
diff --git a/Documentation/DocBook/media/v4l/vidioc-g-ext-ctrls.xml b/Documentation/DocBook/media/v4l/vidioc-g-ext-ctrls.xml
index f2d2ec3f0e31..0a4b90fcf2da 100644
--- a/Documentation/DocBook/media/v4l/vidioc-g-ext-ctrls.xml
+++ b/Documentation/DocBook/media/v4l/vidioc-g-ext-ctrls.xml
@@ -278,6 +278,12 @@ These controls are described in <xref
278 source controls. These controls are described in <xref 278 source controls. These controls are described in <xref
279 linkend="image-source-controls" />.</entry> 279 linkend="image-source-controls" />.</entry>
280 </row> 280 </row>
281 <row>
282 <entry><constant>V4L2_CTRL_CLASS_IMAGE_PROC</constant></entry>
283 <entry>0x9f0000</entry> <entry>The class containing image
284 processing controls. These controls are described in <xref
285 linkend="image-process-controls" />.</entry>
286 </row>
281 </tbody> 287 </tbody>
282 </tgroup> 288 </tgroup>
283 </table> 289 </table>