summaryrefslogtreecommitdiffstats
path: root/Documentation/media/uapi/v4l
Commit message (Collapse)AuthorAgeFilesLines
* [media] docs-rst: Convert V4L2 uAPI to use C function referencesMauro Carvalho Chehab2016-08-2269-263/+262
| | | | | | | | Name all ioctl references and make them match the ioctls that are documented. That will improve the cross-reference index, as it will have all ioctls and syscalls there. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] docs-next: stop abusing on the cpp domainMauro Carvalho Chehab2016-08-2269-83/+83
| | | | | | | | Now that we have an override for the c domain that will do the right thing for the Kernel, stop abusing on the cpp domain. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] pixfmt-007.rst: use Sphinx math:: expressionsMauro Carvalho Chehab2016-08-221-61/+114
| | | | | | | Enrich math formulas by using the Sphinx math. That will allow using those formulas on pdf documents as well. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] docs-rst: fix some .. note:: occurrencesMauro Carvalho Chehab2016-08-223-3/+3
| | | | | | | | On some places, either an space or the second ':' is missing. Fix them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] docs-rst: fix some LaTeX errors when in interactive modeMauro Carvalho Chehab2016-08-227-11/+10
| | | | | | | | | There are several minor issues that are seen when building PDF on interactive mode. Fix them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] subdev-formats.rst: adjust tables size for LaTeX outputMauro Carvalho Chehab2016-08-221-6/+30
| | | | | | | | | | | | | | There are two big tables here that are very hard to adjust its size. The first one would fit into one page, but the latex.py logic at Sphinx auto-switches to longtable when there are more than 30 rows. There's no way to override without coding. The second one is really big, and won't fit on a single page. So, it has to use tiny font to fit. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] extended-controls.rst: avoid going past page with LaTeXMauro Carvalho Chehab2016-08-221-54/+213
| | | | | | | | | | | | | | | | | It is painful to put code/verbatim code in bold. It seems that the only way is to arrange it like: ``foo`` bar At least on LaTeX output, when this happens, the "foo" string is not hidentable/breakable. The entire string should fit into a single line. Add a workaround for this ReST limitation by splitting the foo string into two strings, on separate lines. The output is not the best, but it works. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] Fix a few additional tables at uAPI for LaTeX outputMauro Carvalho Chehab2016-08-223-3/+3
| | | | | | | There are still a few tables with wrong columns at the uAPI docs. Fix them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] docs-rst: fix warnings introduced by LaTeX patchsetMauro Carvalho Chehab2016-08-2234-174/+159
| | | | | | | | | | | | | | | | | | | | | | | Sphinx is really pedantic with respect to the order where table tags and references are created. Putting things at the wrong order causes troubles. The order that seems to work is: .. raw:: latex .. tabularcolumns:: .. _foo_name: .. cssclass: longtable .. flat-table:: Reorder the tags to the above order, to avoid troubles, and fix remaining warnings introduced by media recent patches. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] fix v4l2-selection-*.rst tables for LaTeX outputMauro Carvalho Chehab2016-08-222-0/+3
| | | | | | Adjust the tables there to fit inside the page margins. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] vidioc-g-tuner.rst: Fix tables to fit at LaTeX outputMauro Carvalho Chehab2016-08-221-8/+24
| | | | | | | Several tables are missing column definitions and/or are too big to fit into the page. Adjust them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] vidioc-g-tuner.rst: improve documentation for tuner typeMauro Carvalho Chehab2016-08-221-6/+6
| | | | | | | | | The tuner type table misses descriptions for each type. While most of stuff are obvious, the two SDR definitions aren't. So, add descriptions to all of them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] adjust some vidioc-*rst tables with wrong columnsMauro Carvalho Chehab2016-08-2213-30/+50
| | | | | | | Adjust simple cases where the columns on some vidioc files are overriding their neighbours. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] vidioc-g-sliced-vbi-cap.rst: make tables fit on LaTeX outputMauro Carvalho Chehab2016-08-221-7/+23
| | | | | | | | | | | The tables don't fit at the page on this file. As noticed before, Sphinx (or LaTeX?) does a crap job on tables with cell span, and some work has to be done to make it fit. Move the see also reference to a footnote, break one paragraph into two and adjust the table columns to make it visible. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] vidioc-enumstd.rst: adjust video standards tableMauro Carvalho Chehab2016-08-221-4/+19
| | | | | | | | | | | | This table is too big for LaTeX output, and lacks columns specs for LaTeX format. Also, it has a hidden column, as there are some cell spans with the wrong values. Fix it, so it can be displayed properly on LaTeX/PDF. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] vidioc-dv-timings-cap.rst: Adjust LaTeX columnsMauro Carvalho Chehab2016-08-221-6/+8
| | | | | | Some tables are not properly displayed on LaTeX. Fix them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] vidioc-dqevent.rst: adjust two table columns for LaTeX outputMauro Carvalho Chehab2016-08-221-2/+4
| | | | | | There are two tables with mangled columns. Fix it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] vidioc-decoder-cmd.rst: better adjust column widthsMauro Carvalho Chehab2016-08-221-4/+6
| | | | | | Better adjust the columns for LaTeX output Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] diff-v4l.rst: Make capabilities table fit in LaTeXMauro Carvalho Chehab2016-08-221-1/+3
| | | | | | | | | | | | | | | | | | This table has several troubles: - a duplicated "struct" on its name; - a reference to a V4L version 1 struct that will never point to something (as we got rid of V4L1 API a long time ago); - misses hints for LaTeX output (column size and longtable style). Fix them. It should be noticed that the first column of this table is not aligned with the rest. I suspect that this is a bug at the flat-table extension. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] subdev-formats.rst: adjust most of the tables to fill in pageMauro Carvalho Chehab2016-08-221-2769/+2806
| | | | | | | | | | | | | | | Fix mosto fo the tables there in order to make them fit at the page size. There are, however, two exceptions: RGB and YUV big tables, where adding the raw latex adjustbox caused the tables to not be properly formatted. I suspect that the problem is because those are long tables, but not really sure. The thing is that Sphinx lacks an "adjustbox" tag that would avoid the raw latex hacks. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] dev-subdev.rst: make table fully visible on LaTeXMauro Carvalho Chehab2016-08-221-0/+9
| | | | | | | | | The table there is too big and doesn't have format hints for LaTeX output. Fix it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] dev-rds.rst: adjust table dimentions for LaTeXMauro Carvalho Chehab2016-08-221-1/+1
| | | | | | One of the tables has wrong column dimentions. Fix it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] dev-sliced-vbi.rst: Adjust tables on LaTeX outputMauro Carvalho Chehab2016-08-221-10/+24
| | | | | | | Better format the tables in a way that will fit inside the page. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] dev-sliced-vbi.rst: use a footnote for VBI imagesMauro Carvalho Chehab2016-08-221-2/+4
| | | | | | | | Just like on dvb-raw-vbi.rst, the LaTeX output doesn't work well with cell spans. Also, this is actually a note, so, move it to a footnote. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] docs-rst: re-generate vbi_525.pdf and vbi_625.pdfMauro Carvalho Chehab2016-08-222-0/+0
| | | | | | | | Originally, each image were one page big, causing them to be displayed on separate pages at the PDF output. Re-generate them from the gif files. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] dev-raw-vbi.rst: adjust table columns for LaTeX outputMauro Carvalho Chehab2016-08-221-2/+4
| | | | | | Add the needed tags to fix LaTeX output of the tables there. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] dev-raw-vbi.rst: add a footnote for the count limitsMauro Carvalho Chehab2016-08-221-4/+6
| | | | | | | | | | | | There's a bug with LaTeX output on flat-tables with Sphinx 1.4.5 that prevents references at a cell span to be broken. As the text is indeed too long, it makes sense to place the reference to the pictures showing the VBI limits as a footnote. That makes the text easier to read and also solves the issue with LaTeX output. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] dev-overlay.rst: don't ident a noteMauro Carvalho Chehab2016-08-221-5/+5
| | | | | | | There's one note there that it is indented for no good reason. Fix it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] buffer.rst: Adjust table columns for LaTeX outputMauro Carvalho Chehab2016-08-221-6/+14
| | | | | | | | The table columns are not properly displayed. Also, some tables are too big to fit into just one page. So, fix them, in order to better display the tables. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] docs-rst: remove width hints from pixfmt byte order tablesMauro Carvalho Chehab2016-08-2243-183/+8
| | | | | | | Those hints are wrong, and doesn't really improve the look of those tables. So, keep them only when they're useful. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] pixfmt-packed-yuv.rst: adjust tables to fit in LaTeXMauro Carvalho Chehab2016-08-221-9/+17
| | | | | | | Adjust the table to fit at the LaTeX and PDF outputs, just like what was done with pixfmt-packed-rgb.rst. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] pixfmt-packed-rgb.rst: adjust tables to fit in LaTeXMauro Carvalho Chehab2016-08-221-9/+28
| | | | | | | | | | | | | | Adjust the tables to fit at the LaTeX and PDF outputs. I wrote a previous patch RFC to show the big table in landscape, but it makes harder to read on displays. So, instead, let's use the adjustbox to shrink the size of those long tables, as the table size can still be visible on screen, and it is a way better to read in horizontal position and visible if printed. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] pixfmt-packed-rgb.rst: Fix cell spansMauro Carvalho Chehab2016-08-221-36/+42
| | | | | | | | | | There is an extra column just before eack pack of bits, to improve table reading, but the header file didn't take this into account. Fix it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] docs-rst: add column hints for pixfmt-002 and pixfmt-006Mauro Carvalho Chehab2016-08-222-1/+8
| | | | | | | Add column hints for LaTeX to format columns on the tables inside pixfmt-002.rst and pixfmt-006.rst. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] extended-controls.rst: fix table sizesMauro Carvalho Chehab2016-08-221-27/+36
| | | | | | | Lots of tables at extended-controls.rst need explicit hints for LaTeX to adjust their widths. Provide that. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] control.rst: Fix table widthMauro Carvalho Chehab2016-08-221-1/+3
| | | | | | Manually adjust the table width for it to look nice on PDF output. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] docs-rst: add tabularcolumns to all tablesMauro Carvalho Chehab2016-08-2299-0/+360
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* [media] vidioc-querycap.rst: Better format tables on PDF outputMauro Carvalho Chehab2016-08-221-4/+10
| | | | | | | | | | | | Both tables on this rst file were not shown right, as they miss the proper tag (tabularcolumns) to specify the column widths required for PDF and LaTeX output. Also, the second table is too big to fit into one page. So, it should use the longtable class to allow it to be split into two pages. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] docs-rst: get rid of code-block inside tablesMauro Carvalho Chehab2016-08-222-13/+4
| | | | | | | | There are two tables with a C code-block inside it. Unfortunately, that causes LaTeX output to break. Yet, there's nothing special there, so let's remove the code-block from them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] docs-rst: better use the .. note:: tagMauro Carvalho Chehab2016-08-2236-50/+148
| | | | | | | Change multi-line note tags to be more symetric, e. g. not starting the text together witht the tag. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] vidioc-enumstd.rst: remove bullets from sound carrierMauro Carvalho Chehab2016-08-221-13/+12
| | | | | | | | The items at the sound carrier had a bullet. Those are not needed. So, get rid of them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] vidioc-enumstd.rst: fix a broken referenceMauro Carvalho Chehab2016-08-221-1/+1
| | | | | | Somehow, the conversion broke a reference here. Re-add it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] pixfmt-nv12mt.rst: use PNG instead of GIFMauro Carvalho Chehab2016-08-225-2/+2
| | | | | | | | | | | pdflatex doesn't like gif images: None:None: WARNING: no matching candidate for image URI u'media/uapi/v4l/pixfmt-nv12mt_files/nv12mt.*' None:None: WARNING: no matching candidate for image URI u'media/uapi/v4l/pixfmt-nv12mt_files/nv12mt_example.*' But it works fine with png. So, convert them. As a plus, PNG images are smaller. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: better organize the media booksMauro Carvalho Chehab2016-07-231-4/+8
| | | | | | | | | | | | | | | The uAPI book has 5 parts, but they lost numeration after conversion to rst. Manually number those parts, and make the main index with 1 depth, to only show the parts and the annexes. At each part, use :maxwidth: 5, in order to show a more complete index. While here, fix the cross-references between different books. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: fix htmldocs build warningsMauro Carvalho Chehab2016-07-132-3/+4
| | | | | | | | Fix those warnings: Documentation/output/videodev2.h.rst:6: WARNING: undefined label: vidioc_unsubscribe_event (if the link has no caption the label must precede a section header) Documentation/media/uapi/v4l/dev-overlay.rst:248: WARNING: Title underline too short. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* Revert "[media] docs-rst: escape [] characters"Mauro Carvalho Chehab2016-07-1353-126/+126
| | | | | | | | | | This patch touches on places where it shouldn't: image files and code examples. Also, it doesn't fix all array occurrences. So, let's revert it. This reverts commit ffbab694ede33c294e5864a5e0bf4d1474446a71.
* [media] docs-rst: escape [] charactersMauro Carvalho Chehab2016-07-1253-126/+126
| | | | | | | Those characters are used for citations. Better to escape, to avoid them to be misinterpreted. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] doc-rst: use the right markup for footnotesMauro Carvalho Chehab2016-07-1220-94/+94
| | | | | | | According with ReST spec, footnotes should be like: [#name], and not [name]. So, change them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] vidioc-g-dv-timings.rst: document interlaced definesHans Verkuil2016-07-121-1/+1
| | | | | | | | Document V4L2_DV_PROGRESSIVE and V4L2_DV_INTERLACED and fix missing references. Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
* [media] pixfmt-006.rst: add missing V4L2_YCBCR_ENC_SMPTE240MHans Verkuil2016-07-121-0/+6
| | | | | | | Fix missing documentation, and its cross reference. Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
OpenPOWER on IntegriCloud