diff options
Diffstat (limited to 'v4l2-spec')
| -rw-r--r-- | v4l2-spec/Makefile | 1 | ||||
| -rw-r--r-- | v4l2-spec/biblio.sgml | 65 | ||||
| -rw-r--r-- | v4l2-spec/compat.sgml | 14 | ||||
| -rw-r--r-- | v4l2-spec/dev-rds.sgml | 174 | ||||
| -rw-r--r-- | v4l2-spec/pixfmt-sgrbg8.sgml | 75 | ||||
| -rw-r--r-- | v4l2-spec/pixfmt.sgml | 11 | ||||
| -rw-r--r-- | v4l2-spec/v4l2.sgml | 7 | ||||
| -rw-r--r-- | v4l2-spec/vidioc-g-modulator.sgml | 13 | ||||
| -rw-r--r-- | v4l2-spec/vidioc-g-tuner.sgml | 17 | ||||
| -rw-r--r-- | v4l2-spec/vidioc-querycap.sgml | 2 |
10 files changed, 289 insertions, 90 deletions
diff --git a/v4l2-spec/Makefile b/v4l2-spec/Makefile index 7a19924d4..8f40e8614 100644 --- a/v4l2-spec/Makefile +++ b/v4l2-spec/Makefile @@ -41,6 +41,7 @@ SGMLS = \ pixfmt-sbggr16.sgml \ pixfmt-sbggr8.sgml \ pixfmt-sgbrg8.sgml \ + pixfmt-sgrbg8.sgml \ pixfmt-uyvy.sgml \ pixfmt-vyuy.sgml \ pixfmt-y16.sgml \ diff --git a/v4l2-spec/biblio.sgml b/v4l2-spec/biblio.sgml index b013ece1d..afc8a0dd2 100644 --- a/v4l2-spec/biblio.sgml +++ b/v4l2-spec/biblio.sgml @@ -158,54 +158,23 @@ Signal - NTSC for Studio Applications"</title> 1125-Line High-Definition Production"</title> </biblioentry> - <biblioentry id="v4l"> - <abbrev>V4L</abbrev> - <authorgroup> - <author> - <firstname>Alan</firstname> - <surname>Cox</surname> - <affiliation> - <orgname>Red Hat, Inc.</orgname> - <address> - <email>alan@redhat.com</email> - </address> - </affiliation> - </author> - </authorgroup> - <title>Video4Linux API Specification</title> - <abstract> - <para>This file is part of the Linux kernel sources under -<filename>Documentation/video4linux</filename>.</para> - </abstract> - </biblioentry> - - <biblioentry id="v4lprog"> - <abbrev>V4LPROG</abbrev> - <authorgroup> - <author> - <firstname>Alan</firstname> - <surname>Cox</surname> - <affiliation> - <orgname>Red Hat, Inc.</orgname> - <address> - <email>alan@redhat.com</email> - </address> - </affiliation> - </author> - </authorgroup> - <title>Video4Linux Programming (a.k.a. The Video4Linux -Book)</title> - <abstract> - <para>About V4L <emphasis>driver</emphasis> programming. This -book is part of the Linux kernel DocBook documentation, for example at -<ulink url="http://kernelnewbies.org/documents/"> -http://kernelnewbies.org/documents/</ulink>. SGML sources are included -in the kernel sources.</para> - </abstract> - <copyright> - <year>2000</year> - <holder>Alan Cox</holder> - </copyright> + <biblioentry id="en50067"> + <abbrev>EN 50067</abbrev> + <authorgroup> + <corpauthor>European Committee for Electrotechnical Standardization +(<ulink url="http://www.cenelec.eu">http://www.cenelec.eu</ulink>)</corpauthor> + </authorgroup> + <title>Specification of the radio data system (RDS) for VHF/FM sound broadcasting +in the frequency range from 87,5 to 108,0 MHz</title> + </biblioentry> + + <biblioentry id="nrsc4"> + <abbrev>NRSC-4</abbrev> + <authorgroup> + <corpauthor>National Radio Systems Committee +(<ulink url="http://www.nrscstandards.org">http://www.nrscstandards.org</ulink>)</corpauthor> + </authorgroup> + <title>NTSC-4: United States RBDS Standard</title> </biblioentry> </bibliography> diff --git a/v4l2-spec/compat.sgml b/v4l2-spec/compat.sgml index 94713023d..c1c725f35 100644 --- a/v4l2-spec/compat.sgml +++ b/v4l2-spec/compat.sgml @@ -1273,9 +1273,8 @@ also the size of the structure changed, which is encoded in the ioctl request code, thus older V4L2 devices will respond with an &EINVAL; to the new &VIDIOC-QUERYCAP; ioctl.</para> - <para>There are new fields to identify the driver, a new (as -of yet unspecified) device function -<constant>V4L2_CAP_RDS_CAPTURE</constant>, the + <para>There are new fields to identify the driver, a new RDS +device function <constant>V4L2_CAP_RDS_CAPTURE</constant>, the <constant>V4L2_CAP_AUDIO</constant> flag indicates if the device has any audio connectors, another I/O capability <constant>V4L2_CAP_ASYNCIO</constant> can be flagged. In response to @@ -2294,6 +2293,15 @@ was renamed to <structname id=v4l2-chip-ident-old>v4l2_chip_ident_old</structnam </listitem> </orderedlist> </section> + <section> + <title>V4L2 in Linux 2.6.32</title> + <orderedlist> + <listitem> + <para>Finalized the RDS capture API. See <xref linkend="rds"> for +more information.</para> + </listitem> + </orderedlist> + </section> </section> <section id="other"> diff --git a/v4l2-spec/dev-rds.sgml b/v4l2-spec/dev-rds.sgml index 07bfd4c65..8f357d9f0 100644 --- a/v4l2-spec/dev-rds.sgml +++ b/v4l2-spec/dev-rds.sgml @@ -2,38 +2,154 @@ <para>The Radio Data System transmits supplementary information in binary format, for example the station name or travel -information, on a inaudible audio subcarrier of a radio program. This -interface aims at devices capable of receiving and decoding RDS +information, on an inaudible audio subcarrier of a radio program. This +interface is aimed at devices capable of receiving and decoding RDS information.</para> - <para>The V4L API defines its RDS API as follows.</para> - - <para>From radio devices supporting it, RDS data can be read -with the &func-read; function. The data is packed in groups of three, -as follows:<orderedlist> - <listitem> - <para>First Octet Least Significant Byte of RDS Block</para> - </listitem> - <listitem> - <para>Second Octet Most Significant Byte of RDS Block</para> - </listitem> - <listitem> - <para>Third Octet Bit 7: Error bit. Indicates that an -uncorrectable error occurred during reception of this block. Bit 6: -Corrected bit. Indicates that an error was corrected for this data -block. Bits 5-3: Received Offset. Indicates the offset received by the -sync system. Bits 2-0: Offset Name. Indicates the offset applied to -this data.</para> - </listitem> - </orderedlist></para> - - <para>It was argued <!-- video4linux-list@redhat.com -on 12 Nov 2002, subject "RDS/RBDS" --> the RDS API should be -extended before integration into V4L2, no new API has been devised yet. -Please write to the linux-media mailing list for discussion: &v4l-ml;. -Meanwhile no V4L2 driver should set the -<constant>V4L2_CAP_RDS_CAPTURE</constant> capability flag.</para> + <para>For more information see the core RDS standard <xref linkend="en50067"> +and the RBDS standard <xref linkend="nrsc4">.</para> + <para>Note that the RBDS standard as is used in the USA is almost identical +to the RDS standard. Any RDS decoder can also handle RBDS. Only some of the fields +have slightly different meanings. See the RBDS standard for more information.</para> + + <para>The RBDS standard also specifies support for MMBS (Modified Mobile Search). +This is a proprietary format which seems to be discontinued. The RDS interface does not +support this format. Should support for MMBS (or the so-called 'E blocks' in general) +be needed, then please contact the linux-media mailing list: &v4l-ml;.</para> + + <section> + <title>Querying Capabilities</title> + + <para>Devices supporting the RDS capturing API +set the <constant>V4L2_CAP_RDS_CAPTURE</constant> flag in +the <structfield>capabilities</structfield> field of &v4l2-capability; +returned by the &VIDIOC-QUERYCAP; ioctl.</para> + + <para>Any tuner that supports RDS will set the +<constant>V4L2_TUNER_CAP_RDS</constant> flag in the <structfield>capability</structfield> +field of &v4l2-tuner;.</para> + + <para>Whether an RDS signal is present can be detected by looking at +the <structfield>rxsubchans</structfield> field of &v4l2-tuner;: the +<constant>V4L2_TUNER_SUB_RDS</constant> will be set if RDS data was detected.</para> + + </section> + + <section> + <title>Reading RDS data</title> + + <para>RDS data can be read from the radio device +with the &func-read; function. The data is packed in groups of three bytes, +as follows:</para> + <table frame="none" pgwide="1" id="v4l2-rds-data"> + <title>struct +<structname>v4l2_rds_data</structname></title> + <tgroup cols="3"> + <colspec colname="c1" colwidth="1*"> + <colspec colname="c2" colwidth="1*"> + <colspec colname="c3" colwidth="5*"> + <tbody valign="top"> + <row> + <entry>__u8</entry> + <entry><structfield>lsb</structfield></entry> + <entry>Least Significant Byte of RDS Block</entry> + </row> + <row> + <entry>__u8</entry> + <entry><structfield>msb</structfield></entry> + <entry>Most Significant Byte of RDS Block</entry> + </row> + <row> + <entry>__u8</entry> + <entry><structfield>block</structfield></entry> + <entry>Block description</entry> + </row> + </tbody> + </tgroup> + </table> + <table frame="none" pgwide="1" id="v4l2-rds-block"> + <title>Block description</title> + <tgroup cols="2"> + <colspec colname="c1" colwidth="1*"> + <colspec colname="c2" colwidth="5*"> + <tbody valign="top"> + <row> + <entry>Bits 0-2</entry> + <entry>Block (aka offset) of the received data.</entry> + </row> + <row> + <entry>Bits 3-5</entry> + <entry>Deprecated. Currently identical to bits 0-2. Do not use these bits.</entry> + </row> + <row> + <entry>Bit 6</entry> + <entry>Corrected bit. Indicates that an error was corrected for this data block.</entry> + </row> + <row> + <entry>Bit 7</entry> + <entry>Error bit. Indicates that an uncorrectable error occurred during reception of this block.</entry> + </row> + </tbody> + </tgroup> + </table> + + <table frame="none" pgwide="1" id="v4l2-rds-block-codes"> + <title>Block defines</title> + <tgroup cols="3"> + <colspec colname="c1" colwidth="1*"> + <colspec colname="c2" colwidth="1*"> + <colspec colname="c3" colwidth="5*"> + <tbody valign="top"> + <row> + <entry>V4L2_RDS_BLOCK_MSK</entry> + <entry>7</entry> + <entry>Mask for bits 0-2 to get the block ID.</entry> + </row> + <row> + <entry>V4L2_RDS_BLOCK_A</entry> + <entry>0</entry> + <entry>Block A.</entry> + </row> + <row> + <entry>V4L2_RDS_BLOCK_B</entry> + <entry>1</entry> + <entry>Block B.</entry> + </row> + <row> + <entry>V4L2_RDS_BLOCK_C</entry> + <entry>2</entry> + <entry>Block C.</entry> + </row> + <row> + <entry>V4L2_RDS_BLOCK_D</entry> + <entry>3</entry> + <entry>Block D.</entry> + </row> + <row> + <entry>V4L2_RDS_BLOCK_C_ALT</entry> + <entry>4</entry> + <entry>Block C'.</entry> + </row> + <row> + <entry>V4L2_RDS_BLOCK_INVALID</entry> + <entry>7</entry> + <entry>An invalid block.</entry> + </row> + <row> + <entry>V4L2_RDS_BLOCK_CORRECTED</entry> + <entry>0x40</entry> + <entry>A bit error was detected but corrected.</entry> + </row> + <row> + <entry>V4L2_RDS_BLOCK_ERROR</entry> + <entry>0x80</entry> + <entry>An incorrectable error occurred.</entry> + </row> + </tbody> + </tgroup> + </table> + </section> <!-- Local Variables: diff --git a/v4l2-spec/pixfmt-sgrbg8.sgml b/v4l2-spec/pixfmt-sgrbg8.sgml new file mode 100644 index 000000000..553c5264a --- /dev/null +++ b/v4l2-spec/pixfmt-sgrbg8.sgml @@ -0,0 +1,75 @@ + <refentry id="V4L2-PIX-FMT-SGRBG8"> + <refmeta> + <refentrytitle>V4L2_PIX_FMT_SGRBG8 ('GRBG')</refentrytitle> + &manvol; + </refmeta> + <refnamediv> + <refname><constant>V4L2_PIX_FMT_SGRBG8</constant></refname> + <refpurpose>Bayer RGB format</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + + <para>This is commonly the native format of digital cameras, +reflecting the arrangement of sensors on the CCD device. Only one red, +green or blue value is given for each pixel. Missing components must +be interpolated from neighbouring pixels. From left to right the first +row consists of a green and blue value, the second row of a red and +green value. This scheme repeats to the right and down for every two +columns and rows.</para> + + <example> + <title><constant>V4L2_PIX_FMT_SGRBG8</constant> 4 × +4 pixel image</title> + + <formalpara> + <title>Byte Order.</title> + <para>Each cell is one byte. + <informaltable frame="none"> + <tgroup cols="5" align="center"> + <colspec align="left" colwidth="2*"> + <tbody valign="top"> + <row> + <entry>start + 0:</entry> + <entry>G<subscript>00</subscript></entry> + <entry>R<subscript>01</subscript></entry> + <entry>G<subscript>02</subscript></entry> + <entry>R<subscript>03</subscript></entry> + </row> + <row> + <entry>start + 4:</entry> + <entry>R<subscript>10</subscript></entry> + <entry>B<subscript>11</subscript></entry> + <entry>R<subscript>12</subscript></entry> + <entry>B<subscript>13</subscript></entry> + </row> + <row> + <entry>start + 8:</entry> + <entry>G<subscript>20</subscript></entry> + <entry>R<subscript>21</subscript></entry> + <entry>G<subscript>22</subscript></entry> + <entry>R<subscript>23</subscript></entry> + </row> + <row> + <entry>start + 12:</entry> + <entry>R<subscript>30</subscript></entry> + <entry>B<subscript>31</subscript></entry> + <entry>R<subscript>32</subscript></entry> + <entry>B<subscript>33</subscript></entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </formalpara> + </example> + </refsect1> + </refentry> + + <!-- +Local Variables: +mode: sgml +sgml-parent-document: "pixfmt.sgml" +indent-tabs-mode: nil +End: + --> diff --git a/v4l2-spec/pixfmt.sgml b/v4l2-spec/pixfmt.sgml index 3f39b408e..1be70eea0 100644 --- a/v4l2-spec/pixfmt.sgml +++ b/v4l2-spec/pixfmt.sgml @@ -565,6 +565,7 @@ access the palette, this must be done with ioctls of the Linux framebuffer API.< &sub-packed-rgb; &sub-sbggr8; &sub-sgbrg8; + &sub-sgrbg8 &sub-sbggr16; </section> @@ -724,6 +725,16 @@ kernel sources in the file <filename>Documentation/video4linux/cx2341x/README.hm <entry>'M310'</entry> <entry>Compressed BGGR Bayer format used by the gspca driver.</entry> </row> + <row id="V4L2-PIX-FMT-OV511"> + <entry><constant>V4L2_PIX_FMT_OV511</constant></entry> + <entry>'O511'</entry> + <entry>OV511 JPEG format used by the gspca driver.</entry> + </row> + <row id="V4L2-PIX-FMT-OV518"> + <entry><constant>V4L2_PIX_FMT_OV518</constant></entry> + <entry>'O518'</entry> + <entry>OV518 JPEG format used by the gspca driver.</entry> + </row> <row id="V4L2-PIX-FMT-PJPG"> <entry><constant>V4L2_PIX_FMT_PJPG</constant></entry> <entry>'PJPG'</entry> diff --git a/v4l2-spec/v4l2.sgml b/v4l2-spec/v4l2.sgml index 470793d29..815e96ab5 100644 --- a/v4l2-spec/v4l2.sgml +++ b/v4l2-spec/v4l2.sgml @@ -131,6 +131,13 @@ structs, ioctls) must be noted in more detail in the history chapter applications. --> <revision> + <revnumber>0.26</revnumber> + <date>2009-06-15</date> + <authorinitials>hv</authorinitials> + <revremark>Finalized the RDS capture API.</revremark> + </revision> + + <revision> <revnumber>0.25</revnumber> <date>2009-01-18</date> <authorinitials>hv</authorinitials> diff --git a/v4l2-spec/vidioc-g-modulator.sgml b/v4l2-spec/vidioc-g-modulator.sgml index e5d4a3f24..a3ea5ef8a 100644 --- a/v4l2-spec/vidioc-g-modulator.sgml +++ b/v4l2-spec/vidioc-g-modulator.sgml @@ -166,7 +166,7 @@ combine with <constant>V4L2_TUNER_SUB_STEREO</constant> or channel of a stereo audio signal. When the input has only one channel or two channels and <constant>V4L2_TUNER_SUB_SAP</constant> is also set, channel 1 is encoded as left and right channel. This flag does -not combine with <constant>V4L2_TUNER_SUB_MONO </constant> or +not combine with <constant>V4L2_TUNER_SUB_MONO</constant> or <constant>V4L2_TUNER_SUB_LANG1</constant>. When the driver does not support stereo audio it shall fall back to mono.</entry> </row> @@ -177,8 +177,9 @@ support stereo audio it shall fall back to mono.</entry> language of a bilingual audio signal. When the input has only one channel it is used for both languages. It is not possible to encode the primary or secondary language only. This flag does not combine -with <constant>V4L2_TUNER_SUB_MONO </constant> or -<constant>V4L2_TUNER_SUB_STEREO</constant>. If the hardware does not +with <constant>V4L2_TUNER_SUB_MONO</constant>, +<constant>V4L2_TUNER_SUB_STEREO</constant> or +<constant>V4L2_TUNER_SUB_SAP</constant>. If the hardware does not support the respective audio matrix, or the current video standard does not permit bilingual audio the <constant>VIDIOC_S_MODULATOR</constant> ioctl shall return an &EINVAL; @@ -188,7 +189,7 @@ and the driver shall fall back to mono or stereo mode.</entry> <entry><constant>V4L2_TUNER_SUB_LANG2</constant></entry> <entry>0x0004</entry> <entry>Same effect as -<constant>V4L2_TUNER_SUB_LANG1</constant>.</entry> +<constant>V4L2_TUNER_SUB_SAP</constant>.</entry> </row> <row> <entry><constant>V4L2_TUNER_SUB_SAP</constant></entry> @@ -198,7 +199,7 @@ and the driver shall fall back to mono or stereo mode.</entry> channel as Second Audio Program. When the input has only one channel it is used for both audio tracks. When the input has three channels the mono track is a down-mix of channel 1 and 2. When combined with -<constant>V4L2_TUNER_SUB_STEREO </constant> channel 1 and 2 are +<constant>V4L2_TUNER_SUB_STEREO</constant> channel 1 and 2 are encoded as left and right stereo audio, channel 3 as Second Audio Program. When the input has only two channels, the first is encoded as left and right channel and the second as SAP. When the input has only @@ -207,7 +208,7 @@ encode a Second Audio Program only. This flag must combine with <constant>V4L2_TUNER_SUB_MONO</constant> or <constant>V4L2_TUNER_SUB_STEREO</constant>. If the hardware does not support the respective audio matrix, or the current video standard -does not permit SAP the <constant> VIDIOC_S_MODULATOR</constant> ioctl +does not permit SAP the <constant>VIDIOC_S_MODULATOR</constant> ioctl shall return an &EINVAL; and driver shall fall back to mono or stereo mode.</entry> </row> diff --git a/v4l2-spec/vidioc-g-tuner.sgml b/v4l2-spec/vidioc-g-tuner.sgml index d5d379838..eb0b89e9a 100644 --- a/v4l2-spec/vidioc-g-tuner.sgml +++ b/v4l2-spec/vidioc-g-tuner.sgml @@ -120,9 +120,9 @@ field is not quite clear.--></para></entry> to decode audio subprograms. They will <emphasis>not</emphasis> change, for example with the current video standard.</para><para>When the structure refers to a radio tuner only the -<constant>V4L2_TUNER_CAP_LOW</constant> and -<constant>V4L2_TUNER_CAP_STEREO</constant> flags can be -set.</para></entry> +<constant>V4L2_TUNER_CAP_LOW</constant>, +<constant>V4L2_TUNER_CAP_STEREO</constant> and +<constant>V4L2_TUNER_CAP_RDS</constant> flags can be set.</para></entry> </row> <row> <entry>__u32</entry> @@ -312,6 +312,12 @@ carrier for a monaural secondary language. Only supports the <constant>V4L2_STD_NTSC_M</constant> video standard.</para><!-- FIXME what if PAL+NTSC and Bi but not SAP? --></entry> </row> + <row> + <entry><constant>V4L2_TUNER_CAP_RDS</constant></entry> + <entry>0x0080</entry> + <entry>RDS capture is supported. This capability is only valid for +radio tuners.</entry> + </row> </tbody> </tgroup> </table> @@ -353,6 +359,11 @@ bilingual audio signal (or a second audio program).</entry> <constant>V4L2_TUNER_SUB_SAP</constant> flag applies when the current video standard is <constant>V4L2_STD_NTSC_M</constant>.</entry> </row> + <row> + <entry><constant>V4L2_TUNER_SUB_RDS</constant></entry> + <entry>0x0010</entry> + <entry>The tuner receives an RDS channel.</entry> + </row> </tbody> </tgroup> </table> diff --git a/v4l2-spec/vidioc-querycap.sgml b/v4l2-spec/vidioc-querycap.sgml index 2715289d8..4a741f5e9 100644 --- a/v4l2-spec/vidioc-querycap.sgml +++ b/v4l2-spec/vidioc-querycap.sgml @@ -184,7 +184,7 @@ data.</entry> <row> <entry><constant>V4L2_CAP_RDS_CAPTURE</constant></entry> <entry>0x00000100</entry> - <entry>[to be defined]</entry> + <entry>The device supports the <link linkend="rds">RDS</link> interface.</entry> </row> <row> <entry><constant>V4L2_CAP_VIDEO_OUTPUT_OVERLAY</constant></entry> |