[FFmpeg-devel] [PATCH] Documentation cleanup - image formats
Daniel Verkamp
daniel
Fri Feb 20 03:08:51 CET 2009
Hi,
Attached are several trivial patches to (somewhat) clean up and update
the Image Formats section of the documentation.
I'm not sure if the distinction between the various JPEG types is
useful/correct from a user's perspective, and I don't know the
differences between them myself, so please check this part (patch 4)
carefully.
I will happily clean up more of the formats documentation as well, but
I'm not sure how useful it is currently; it's pretty much a mess both
for users and developers, from what I've seen. The comments field is
especially confusing, as it's a sort of free-for-all, sometimes
containing FourCCs, other times shortcomings of the current
implementation, occasionally whether an external library is needed,
and yet others general descriptions of the format/codec. It also is
inconsistent in whether it ends in a period or not, what voice it is
written in, etc. With some guidance as to what is actually desired,
I'll gladly try to wrangle all this into something useful...
Maybe some kind of autogenerated list like ffmpeg -formats would be
better than manually updating the docs all the time? (I started on
this, but couldn't find any way to tell image codecs from other video
codecs automatically, and at least this distinction makes the
documentation more useful than the raw -formats output, so I didn't
want to drop it.)
Thanks,
-- Daniel Verkamp
-------------- next part --------------
>From 2b8b3c9755388bb616f230645467eb8d24a1e879 Mon Sep 17 00:00:00 2001
From: Daniel Verkamp <daniel at drv.nu>
Date: Thu, 19 Feb 2009 19:20:45 -0600
Subject: [PATCH 1/5] Break image format lines before comments
---
doc/general.texi | 39 ++++++++++++++++++++++++++-------------
1 files changed, 26 insertions(+), 13 deletions(-)
diff --git a/doc/general.texi b/doc/general.texi
index 720d020..6cb4533 100644
--- a/doc/general.texi
+++ b/doc/general.texi
@@ -230,20 +230,33 @@ following image formats are supported:
@multitable @columnfractions .4 .1 .1 .4
@item Name @tab Encoding @tab Decoding @tab Comments
- at item .Y.U.V @tab X @tab X @tab one raw file per component
- at item animated GIF @tab X @tab X @tab Only uncompressed GIFs are generated.
- at item JPEG @tab X @tab X @tab Progressive JPEG is not supported.
- at item JPEG 2000 @tab @tab E @tab decoding supported through external library libopenjpeg
- at item PAM @tab X @tab X @tab PAM is a PNM extension with alpha support.
- at item PCX @tab @tab X @tab PC Paintbrush
+ at item .Y.U.V @tab X @tab X
+ @tab one raw file per component
+ at item animated GIF @tab X @tab X
+ @tab Only uncompressed GIFs are generated.
+ at item JPEG @tab X @tab X
+ @tab Progressive JPEG is not supported.
+ at item JPEG 2000 @tab @tab E
+ @tab decoding supported through external library libopenjpeg
+ at item PAM @tab X @tab X
+ @tab PAM is a PNM extension with alpha support.
+ at item PCX @tab @tab X
+ @tab PC Paintbrush
@item PGM, PPM @tab X @tab X
- at item PGMYUV @tab X @tab X @tab PGM with U and V components in YUV 4:2:0
- at item PNG @tab X @tab X @tab 2/4 bpp not supported yet
- at item PTX @tab @tab X @tab V.Flash PTX format
- at item RAS @tab @tab X @tab Sun Rasterfile
- at item SGI @tab X @tab X @tab SGI RGB image format
- at item Targa @tab @tab X @tab Targa (.TGA) image format
- at item TIFF @tab X @tab X @tab YUV, JPEG and some extension is not supported yet.
+ at item PGMYUV @tab X @tab X
+ @tab PGM with U and V components in YUV 4:2:0
+ at item PNG @tab X @tab X
+ @tab 2/4 bpp not supported yet
+ at item PTX @tab @tab X
+ @tab V.Flash PTX format
+ at item RAS @tab @tab X
+ @tab Sun Rasterfile
+ at item SGI @tab X @tab X
+ @tab SGI RGB image format
+ at item Targa @tab @tab X
+ @tab Targa (.TGA) image format
+ at item TIFF @tab X @tab X
+ @tab YUV, JPEG and some extension is not supported yet.
@end multitable
@code{X} means that encoding (resp. decoding) is supported.
--
1.6.1.3
-------------- next part --------------
>From e447a99d15c5d59580e0b50b53ada2172c30ffdc Mon Sep 17 00:00:00 2001
From: Daniel Verkamp <daniel at drv.nu>
Date: Thu, 19 Feb 2009 19:21:18 -0600
Subject: [PATCH 2/5] Move Renderware TXD to image formats section
---
doc/general.texi | 4 ++--
1 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/doc/general.texi b/doc/general.texi
index 6cb4533..ec44097 100644
--- a/doc/general.texi
+++ b/doc/general.texi
@@ -251,6 +251,8 @@ following image formats are supported:
@tab V.Flash PTX format
@item RAS @tab @tab X
@tab Sun Rasterfile
+ at item Renderware TXD @tab @tab X
+ @tab Texture dictionaries used by the Renderware Engine.
@item SGI @tab X @tab X
@tab SGI RGB image format
@item Targa @tab @tab X
@@ -383,8 +385,6 @@ following image formats are supported:
@item RealVideo 3.0 @tab @tab X
@tab still far from ideal
@item RealVideo 4.0 @tab @tab X
- at item Renderware TXD @tab @tab X
- @tab Texture dictionaries used by the Renderware Engine.
@item RTjpeg @tab @tab X
@tab Video encoding used in NuppelVideo files.
@item Smacker video @tab @tab X
--
1.6.1.3
-------------- next part --------------
>From 8adc11bd65129ab4fda77935cfbf1d40439f7ace Mon Sep 17 00:00:00 2001
From: Daniel Verkamp <daniel at drv.nu>
Date: Thu, 19 Feb 2009 19:32:35 -0600
Subject: [PATCH 3/5] Split PGM and PPM
---
doc/general.texi | 5 ++++-
1 files changed, 4 insertions(+), 1 deletions(-)
diff --git a/doc/general.texi b/doc/general.texi
index ec44097..5c4d2a3 100644
--- a/doc/general.texi
+++ b/doc/general.texi
@@ -242,11 +242,14 @@ following image formats are supported:
@tab PAM is a PNM extension with alpha support.
@item PCX @tab @tab X
@tab PC Paintbrush
- at item PGM, PPM @tab X @tab X
+ at item PGM @tab X @tab X
+ @tab Portable GrayMap image
@item PGMYUV @tab X @tab X
@tab PGM with U and V components in YUV 4:2:0
@item PNG @tab X @tab X
@tab 2/4 bpp not supported yet
+ at item PPM @tab X @tab X
+ @tab Portable PixelMap image
@item PTX @tab @tab X
@tab V.Flash PTX format
@item RAS @tab @tab X
--
1.6.1.3
-------------- next part --------------
>From 3bf4bb6e4dcc13a3029edb69bf4dd4b7f749c0e6 Mon Sep 17 00:00:00 2001
From: Daniel Verkamp <daniel at drv.nu>
Date: Thu, 19 Feb 2009 19:43:51 -0600
Subject: [PATCH 4/5] Add missing image formats
---
doc/general.texi | 7 +++++++
1 files changed, 7 insertions(+), 0 deletions(-)
diff --git a/doc/general.texi b/doc/general.texi
index 5c4d2a3..4851795 100644
--- a/doc/general.texi
+++ b/doc/general.texi
@@ -234,12 +234,19 @@ following image formats are supported:
@tab one raw file per component
@item animated GIF @tab X @tab X
@tab Only uncompressed GIFs are generated.
+ at item BMP @tab X @tab X
+ @tab Microsoft BMP image
@item JPEG @tab X @tab X
@tab Progressive JPEG is not supported.
@item JPEG 2000 @tab @tab E
@tab decoding supported through external library libopenjpeg
+ at item JPEG-LS @tab X @tab X
+ at item LJPEG @tab X @tab
+ @tab Lossless JPEG
@item PAM @tab X @tab X
@tab PAM is a PNM extension with alpha support.
+ at item PBM @tab X @tab X
+ @tab Portable BitMap image
@item PCX @tab @tab X
@tab PC Paintbrush
@item PGM @tab X @tab X
--
1.6.1.3
-------------- next part --------------
>From 87000a26c4a4c77e2d0d16686135fd1ca2d4b717 Mon Sep 17 00:00:00 2001
From: Daniel Verkamp <daniel at drv.nu>
Date: Thu, 19 Feb 2009 19:44:54 -0600
Subject: [PATCH 5/5] Targa encoding supported
---
doc/general.texi | 2 +-
1 files changed, 1 insertions(+), 1 deletions(-)
diff --git a/doc/general.texi b/doc/general.texi
index 4851795..721c1bf 100644
--- a/doc/general.texi
+++ b/doc/general.texi
@@ -265,7 +265,7 @@ following image formats are supported:
@tab Texture dictionaries used by the Renderware Engine.
@item SGI @tab X @tab X
@tab SGI RGB image format
- at item Targa @tab @tab X
+ at item Targa @tab X @tab X
@tab Targa (.TGA) image format
@item TIFF @tab X @tab X
@tab YUV, JPEG and some extension is not supported yet.
--
1.6.1.3
More information about the ffmpeg-devel
mailing list