Merge branch 'tc_action-fixes'

[mirror_ubuntu-artful-kernel.git] / Documentation / DocBook / media / v4l / pixfmt-sdr-cs08.xml

<refentry id="V4L2-SDR-FMT-CS08">
  <refmeta>
    <refentrytitle>V4L2_SDR_FMT_CS8 ('CS08')</refentrytitle>
    &manvol;
  </refmeta>
    <refnamediv>
      <refname>
        <constant>V4L2_SDR_FMT_CS8</constant>
      </refname>
      <refpurpose>Complex signed 8-bit IQ sample</refpurpose>
    </refnamediv>
    <refsect1>
      <title>Description</title>
      <para>
This format contains sequence of complex number samples. Each complex number
consist two parts, called In-phase and Quadrature (IQ). Both I and Q are
represented as a 8 bit signed number. I value comes first and Q value after
that.
      </para>
    <example>
      <title><constant>V4L2_SDR_FMT_CS8</constant> 1 sample</title>
      <formalpara>
        <title>Byte Order.</title>
        <para>Each cell is one byte.
          <informaltable frame="none">
            <tgroup cols="2" align="center">
              <colspec align="left" colwidth="2*" />
              <tbody valign="top">
                <row>
                  <entry>start&nbsp;+&nbsp;0:</entry>
                  <entry>I'<subscript>0</subscript></entry>
                </row>
                <row>
                  <entry>start&nbsp;+&nbsp;1:</entry>
                  <entry>Q'<subscript>0</subscript></entry>
                </row>
              </tbody>
            </tgroup>
          </informaltable>
        </para>
      </formalpara>
    </example>
  </refsect1>
</refentry>