linux/Documentation/media/uapi/v4l/pixfmt-sdr-cs14le.rst
Mauro Carvalho Chehab 5bd4bb7817 [media] docs-rst: add tabularcolumns to all tables
LaTeX doesn't handle too well auto-width on tables, and ReST
markup requires an special tag to give it the needed hints.

As we're using A4 paper, we have 17cm of useful spaces. As
most media tables have widths, let's use it to generate the
needed via the following perl script:

my ($line_size, $table_header, $has_cols) = (17.5, 0, 0);
my $out;
my $header = "";
my @widths = ();
sub round { $_[0] > 0 ? int($_[0] + .5) : -int(-$_[0] + .5) }
while (<>) {
	if (!$table_header) {
		$has_cols = 1 if (m/..\s+tabularcolumns::/);
		if (m/..\s+flat-table::/) {
			$table_header = 1;
			$header = $_;
			next;
		}
		$out .= $_;
		next;
	}
	$header .= $_;
	@widths = split(/ /, $1) if (m/:widths:\s+(.*)/);
	if (m/^\n$/) {
		if (!$has_cols && @widths) {
			my ($tot, $t, $i) = (0, 0, 0);
			foreach my $v(@widths) { $tot += $v; };
			$out .= ".. tabularcolumns:: |";
			for ($i = 0; $i < scalar @widths - 1; $i++) {
				my $v = $widths[$i];
				my $w = round(10 * ($v * $line_size) / $tot) / 10;
				$out .= sprintf "p{%.1fcm}|", $w;
				$t += $w;
			}
			my $w = $line_size - $t;
			$out .= sprintf "p{%.1fcm}|\n\n", $w;
		}
		$out .= $header;
		$table_header = 0;
		$has_cols = 0;
		$header = "";
		@widths = ();
	}
}
print $out;

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-08-22 10:07:12 -03:00

51 lines
950 B
ReStructuredText

.. -*- coding: utf-8; mode: rst -*-
.. _V4L2-SDR-FMT-CS14LE:
****************************
V4L2_SDR_FMT_CS14LE ('CS14')
****************************
*man V4L2_SDR_FMT_CS14LE(2)*
Complex signed 14-bit little endian IQ sample
Description
===========
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 14 bit signed little endian number. I value
comes first and Q value after that. 14 bit value is stored in 16 bit
space with unused high bits padded with 0.
**Byte Order.**
Each cell is one byte.
.. tabularcolumns:: |p{8.8cm}|p{4.4cm}|p{4.3cm}|
.. flat-table::
:header-rows: 0
:stub-columns: 0
:widths: 2 1 1
- .. row 1
- start + 0:
- I'\ :sub:`0[7:0]`
- I'\ :sub:`0[13:8]`
- .. row 2
- start + 2:
- Q'\ :sub:`0[7:0]`
- Q'\ :sub:`0[13:8]`