-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
yaml --- r: 242026 b: refs/heads/master c: 35c3017 h: refs/heads/master v: v3
- Loading branch information
Laurent Pinchart
authored and
Mauro Carvalho Chehab
committed
Mar 22, 2011
1 parent
8f1f612
commit de1b024
Showing
8 changed files
with
361 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,2 @@ | ||
| --- | ||
| refs/heads/master: 333c8b97785d5afd5085ba3720b4d259623290f6 | ||
| refs/heads/master: 35c3017a29d278c4405a7f3ab30b814999d156d3 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
152 changes: 152 additions & 0 deletions
152
trunk/Documentation/DocBook/v4l/vidioc-subdev-enum-frame-interval.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,152 @@ | ||
| <refentry id="vidioc-subdev-enum-frame-interval"> | ||
| <refmeta> | ||
| <refentrytitle>ioctl VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL</refentrytitle> | ||
| &manvol; | ||
| </refmeta> | ||
|
|
||
| <refnamediv> | ||
| <refname>VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL</refname> | ||
| <refpurpose>Enumerate frame intervals</refpurpose> | ||
| </refnamediv> | ||
|
|
||
| <refsynopsisdiv> | ||
| <funcsynopsis> | ||
| <funcprototype> | ||
| <funcdef>int <function>ioctl</function></funcdef> | ||
| <paramdef>int <parameter>fd</parameter></paramdef> | ||
| <paramdef>int <parameter>request</parameter></paramdef> | ||
| <paramdef>struct v4l2_subdev_frame_interval_enum * | ||
| <parameter>argp</parameter></paramdef> | ||
| </funcprototype> | ||
| </funcsynopsis> | ||
| </refsynopsisdiv> | ||
|
|
||
| <refsect1> | ||
| <title>Arguments</title> | ||
|
|
||
| <variablelist> | ||
| <varlistentry> | ||
| <term><parameter>fd</parameter></term> | ||
| <listitem> | ||
| <para>&fd;</para> | ||
| </listitem> | ||
| </varlistentry> | ||
| <varlistentry> | ||
| <term><parameter>request</parameter></term> | ||
| <listitem> | ||
| <para>VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL</para> | ||
| </listitem> | ||
| </varlistentry> | ||
| <varlistentry> | ||
| <term><parameter>argp</parameter></term> | ||
| <listitem> | ||
| <para></para> | ||
| </listitem> | ||
| </varlistentry> | ||
| </variablelist> | ||
| </refsect1> | ||
|
|
||
| <refsect1> | ||
| <title>Description</title> | ||
|
|
||
| <note> | ||
| <title>Experimental</title> | ||
| <para>This is an <link linkend="experimental">experimental</link> | ||
| interface and may change in the future.</para> | ||
| </note> | ||
|
|
||
| <para>This ioctl lets applications enumerate available frame intervals on a | ||
| given sub-device pad. Frame intervals only makes sense for sub-devices that | ||
| can control the frame period on their own. This includes, for instance, | ||
| image sensors and TV tuners.</para> | ||
|
|
||
| <para>For the common use case of image sensors, the frame intervals | ||
| available on the sub-device output pad depend on the frame format and size | ||
| on the same pad. Applications must thus specify the desired format and size | ||
| when enumerating frame intervals.</para> | ||
|
|
||
| <para>To enumerate frame intervals applications initialize the | ||
| <structfield>index</structfield>, <structfield>pad</structfield>, | ||
| <structfield>code</structfield>, <structfield>width</structfield> and | ||
| <structfield>height</structfield> fields of | ||
| &v4l2-subdev-frame-interval-enum; and call the | ||
| <constant>VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL</constant> ioctl with a pointer | ||
| to this structure. Drivers fill the rest of the structure or return | ||
| an &EINVAL; if one of the input fields is invalid. All frame intervals are | ||
| enumerable by beginning at index zero and incrementing by one until | ||
| <errorcode>EINVAL</errorcode> is returned.</para> | ||
|
|
||
| <para>Available frame intervals may depend on the current 'try' formats | ||
| at other pads of the sub-device, as well as on the current active links. See | ||
| &VIDIOC-SUBDEV-G-FMT; for more information about the try formats.</para> | ||
|
|
||
| <para>Sub-devices that support the frame interval enumeration ioctl should | ||
| implemented it on a single pad only. Its behaviour when supported on | ||
| multiple pads of the same sub-device is not defined.</para> | ||
|
|
||
| <table pgwide="1" frame="none" id="v4l2-subdev-frame-interval-enum"> | ||
| <title>struct <structname>v4l2_subdev_frame_interval_enum</structname></title> | ||
| <tgroup cols="3"> | ||
| &cs-str; | ||
| <tbody valign="top"> | ||
| <row> | ||
| <entry>__u32</entry> | ||
| <entry><structfield>index</structfield></entry> | ||
| <entry>Number of the format in the enumeration, set by the | ||
| application.</entry> | ||
| </row> | ||
| <row> | ||
| <entry>__u32</entry> | ||
| <entry><structfield>pad</structfield></entry> | ||
| <entry>Pad number as reported by the media controller API.</entry> | ||
| </row> | ||
| <row> | ||
| <entry>__u32</entry> | ||
| <entry><structfield>code</structfield></entry> | ||
| <entry>The media bus format code, as defined in | ||
| <xref linkend="v4l2-mbus-format" />.</entry> | ||
| </row> | ||
| <row> | ||
| <entry>__u32</entry> | ||
| <entry><structfield>width</structfield></entry> | ||
| <entry>Frame width, in pixels.</entry> | ||
| </row> | ||
| <row> | ||
| <entry>__u32</entry> | ||
| <entry><structfield>height</structfield></entry> | ||
| <entry>Frame height, in pixels.</entry> | ||
| </row> | ||
| <row> | ||
| <entry>&v4l2-fract;</entry> | ||
| <entry><structfield>interval</structfield></entry> | ||
| <entry>Period, in seconds, between consecutive video frames.</entry> | ||
| </row> | ||
| <row> | ||
| <entry>__u32</entry> | ||
| <entry><structfield>reserved</structfield>[9]</entry> | ||
| <entry>Reserved for future extensions. Applications and drivers must | ||
| set the array to zero.</entry> | ||
| </row> | ||
| </tbody> | ||
| </tgroup> | ||
| </table> | ||
| </refsect1> | ||
|
|
||
| <refsect1> | ||
| &return-value; | ||
|
|
||
| <variablelist> | ||
| <varlistentry> | ||
| <term><errorcode>EINVAL</errorcode></term> | ||
| <listitem> | ||
| <para>The &v4l2-subdev-frame-interval-enum; | ||
| <structfield>pad</structfield> references a non-existing pad, one of | ||
| the <structfield>code</structfield>, <structfield>width</structfield> | ||
| or <structfield>height</structfield> fields are invalid for the given | ||
| pad or the <structfield>index</structfield> field is out of bounds. | ||
| </para> | ||
| </listitem> | ||
| </varlistentry> | ||
| </variablelist> | ||
| </refsect1> | ||
| </refentry> |
141 changes: 141 additions & 0 deletions
141
trunk/Documentation/DocBook/v4l/vidioc-subdev-g-frame-interval.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,141 @@ | ||
| <refentry id="vidioc-subdev-g-frame-interval"> | ||
| <refmeta> | ||
| <refentrytitle>ioctl VIDIOC_SUBDEV_G_FRAME_INTERVAL, VIDIOC_SUBDEV_S_FRAME_INTERVAL</refentrytitle> | ||
| &manvol; | ||
| </refmeta> | ||
|
|
||
| <refnamediv> | ||
| <refname>VIDIOC_SUBDEV_G_FRAME_INTERVAL</refname> | ||
| <refname>VIDIOC_SUBDEV_S_FRAME_INTERVAL</refname> | ||
| <refpurpose>Get or set the frame interval on a subdev pad</refpurpose> | ||
| </refnamediv> | ||
|
|
||
| <refsynopsisdiv> | ||
| <funcsynopsis> | ||
| <funcprototype> | ||
| <funcdef>int <function>ioctl</function></funcdef> | ||
| <paramdef>int <parameter>fd</parameter></paramdef> | ||
| <paramdef>int <parameter>request</parameter></paramdef> | ||
| <paramdef>struct v4l2_subdev_frame_interval *<parameter>argp</parameter> | ||
| </paramdef> | ||
| </funcprototype> | ||
| </funcsynopsis> | ||
| </refsynopsisdiv> | ||
|
|
||
| <refsect1> | ||
| <title>Arguments</title> | ||
|
|
||
| <variablelist> | ||
| <varlistentry> | ||
| <term><parameter>fd</parameter></term> | ||
| <listitem> | ||
| <para>&fd;</para> | ||
| </listitem> | ||
| </varlistentry> | ||
| <varlistentry> | ||
| <term><parameter>request</parameter></term> | ||
| <listitem> | ||
| <para>VIDIOC_SUBDEV_G_FRAME_INTERVAL, VIDIOC_SUBDEV_S_FRAME_INTERVAL</para> | ||
| </listitem> | ||
| </varlistentry> | ||
| <varlistentry> | ||
| <term><parameter>argp</parameter></term> | ||
| <listitem> | ||
| <para></para> | ||
| </listitem> | ||
| </varlistentry> | ||
| </variablelist> | ||
| </refsect1> | ||
|
|
||
| <refsect1> | ||
| <title>Description</title> | ||
|
|
||
| <note> | ||
| <title>Experimental</title> | ||
| <para>This is an <link linkend="experimental">experimental</link> | ||
| interface and may change in the future.</para> | ||
| </note> | ||
|
|
||
| <para>These ioctls are used to get and set the frame interval at specific | ||
| subdev pads in the image pipeline. The frame interval only makes sense for | ||
| sub-devices that can control the frame period on their own. This includes, | ||
| for instance, image sensors and TV tuners. Sub-devices that don't support | ||
| frame intervals must not implement these ioctls.</para> | ||
|
|
||
| <para>To retrieve the current frame interval applications set the | ||
| <structfield>pad</structfield> field of a &v4l2-subdev-frame-interval; to | ||
| the desired pad number as reported by the media controller API. When they | ||
| call the <constant>VIDIOC_SUBDEV_G_FRAME_INTERVAL</constant> ioctl with a | ||
| pointer to this structure the driver fills the members of the | ||
| <structfield>interval</structfield> field.</para> | ||
|
|
||
| <para>To change the current frame interval applications set both the | ||
| <structfield>pad</structfield> field and all members of the | ||
| <structfield>interval</structfield> field. When they call the | ||
| <constant>VIDIOC_SUBDEV_S_FRAME_INTERVAL</constant> ioctl with a pointer to | ||
| this structure the driver verifies the requested interval, adjusts it based | ||
| on the hardware capabilities and configures the device. Upon return the | ||
| &v4l2-subdev-frame-interval; contains the current frame interval as would be | ||
| returned by a <constant>VIDIOC_SUBDEV_G_FRAME_INTERVAL</constant> call. | ||
| </para> | ||
|
|
||
| <para>Drivers must not return an error solely because the requested interval | ||
| doesn't match the device capabilities. They must instead modify the interval | ||
| to match what the hardware can provide. The modified interval should be as | ||
| close as possible to the original request.</para> | ||
|
|
||
| <para>Sub-devices that support the frame interval ioctls should implement | ||
| them on a single pad only. Their behaviour when supported on multiple pads | ||
| of the same sub-device is not defined.</para> | ||
|
|
||
| <table pgwide="1" frame="none" id="v4l2-subdev-frame-interval"> | ||
| <title>struct <structname>v4l2_subdev_frame_interval</structname></title> | ||
| <tgroup cols="3"> | ||
| &cs-str; | ||
| <tbody valign="top"> | ||
| <row> | ||
| <entry>__u32</entry> | ||
| <entry><structfield>pad</structfield></entry> | ||
| <entry>Pad number as reported by the media controller API.</entry> | ||
| </row> | ||
| <row> | ||
| <entry>&v4l2-fract;</entry> | ||
| <entry><structfield>interval</structfield></entry> | ||
| <entry>Period, in seconds, between consecutive video frames.</entry> | ||
| </row> | ||
| <row> | ||
| <entry>__u32</entry> | ||
| <entry><structfield>reserved</structfield>[9]</entry> | ||
| <entry>Reserved for future extensions. Applications and drivers must | ||
| set the array to zero.</entry> | ||
| </row> | ||
| </tbody> | ||
| </tgroup> | ||
| </table> | ||
| </refsect1> | ||
|
|
||
| <refsect1> | ||
| &return-value; | ||
|
|
||
| <variablelist> | ||
| <varlistentry> | ||
| <term><errorcode>EBUSY</errorcode></term> | ||
| <listitem> | ||
| <para>The frame interval can't be changed because the pad is currently | ||
| busy. This can be caused, for instance, by an active video stream on | ||
| the pad. The ioctl must not be retried without performing another | ||
| action to fix the problem first. Only returned by | ||
| <constant>VIDIOC_SUBDEV_S_FRAME_INTERVAL</constant></para> | ||
| </listitem> | ||
| </varlistentry> | ||
| <varlistentry> | ||
| <term><errorcode>EINVAL</errorcode></term> | ||
| <listitem> | ||
| <para>The &v4l2-subdev-frame-interval; <structfield>pad</structfield> | ||
| references a non-existing pad, or the pad doesn't support frame | ||
| intervals.</para> | ||
| </listitem> | ||
| </varlistentry> | ||
| </variablelist> | ||
| </refsect1> | ||
| </refentry> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.