[FFmpeg-devel] [PATCH] doc: add libswscale.texi

[Clément Bœsch]

On Sun, Nov 25, 2012 at 12:53:47AM +0100, Stefano Sabatini wrote:
[...]
> > From 1d1f10cad83d60bab370f6f56d250fa34f72deff Mon Sep 17 00:00:00 2001
> > From: Stefano Sabatini <stefasab at gmail.com>
> > Date: Tue, 13 Nov 2012 23:49:09 +0100
> > Subject: [PATCH] doc: add libswscale.texi
> > 
> > ---
> >  doc/Makefile        |    1 +
> >  doc/libswscale.texi |  154 +++++++++++++++++++++++++++++++++++++++++++++++++++
> >  2 files changed, 155 insertions(+)
> >  create mode 100644 doc/libswscale.texi
> 
> Updated. Will push today or later, please comment.
> -- 
> FFmpeg = Frightening Fostering Multimedia Philosophical Elastic Game

> From 507e096ced207341e8c2ef86c8d347930c1c1494 Mon Sep 17 00:00:00 2001
> From: Stefano Sabatini <stefasab at gmail.com>
> Date: Tue, 13 Nov 2012 23:49:09 +0100
> Subject: [PATCH] doc: add libswscale.texi and ffmpeg-scaler.texi files
> 
> ---
>  doc/Makefile           |    3 +-
>  doc/ffmpeg-scaler.texi |  136 ++++++++++++++++++++++++++++++++++++++++++++++++
>  doc/libswscale.texi    |   55 ++++++++++++++++++++
>  3 files changed, 193 insertions(+), 1 deletion(-)
>  create mode 100644 doc/ffmpeg-scaler.texi
>  create mode 100644 doc/libswscale.texi
> 
> diff --git a/doc/Makefile b/doc/Makefile
> index afe361f..85ca978 100644
> --- a/doc/Makefile
> +++ b/doc/Makefile
> @@ -1,9 +1,10 @@
>  DOCLIBS-$(CONFIG_AVUTIL)  += libavutil
> +DOCLIBS-$(CONFIG_SWSCALE) += libswscale
>  DOCLIBS-$(CONFIG_SWRESAMPLE) += libswresample
>  DOCLIBS-$(CONFIG_AVCODEC) += libavcodec
>  DOCLIBS-$(CONFIG_AVFILTER) += libavfilter
>  
> -COMPONENTS=$(PROGS-yes) ffmpeg-codecs ffmpeg-filters ffmpeg-resampler
> +COMPONENTS=$(PROGS-yes) ffmpeg-codecs ffmpeg-filters ffmpeg-resampler ffmpeg-scaler
>  
>  MANPAGES    = $(COMPONENTS:%=doc/%.1)    $(DOCLIBS-yes:%=doc/%.3)
>  PODPAGES    = $(COMPONENTS:%=doc/%.pod)  $(DOCLIBS-yes:%=doc/%.pod)
> diff --git a/doc/ffmpeg-scaler.texi b/doc/ffmpeg-scaler.texi
> new file mode 100644
> index 0000000..8c43864
> --- /dev/null
> +++ b/doc/ffmpeg-scaler.texi
> @@ -0,0 +1,136 @@
> +\input texinfo @c -*- texinfo -*-
> +
> + at settitle FFmpeg Scaler Documentation
> + at titlepage
> + at center @titlefont{FFmpeg Scaler Documentation}
> + at end titlepage
> +
> + at top
> +
> + at contents
> +
> + at chapter Description
> + at c man begin DESCRIPTION
> +
> +The FFmpeg rescaler provides an high-level interface to the libswscale

Speaking of a "FFmpeg rescaler" as if it was something different than the
library sounds weird. AFAIK we don't have any "rescaler", we just have a
scaling library, and filters using it.

I know it's a bit late to nitpick so sorry for raising this up now, but
maybe ffmpeg-resampling and ffmpeg-scaling would have been more
appropriate.

> +library image conversion utilities. In particular it allows to perform
> +image size rescaling and pixel format conversion.
> +
> + at c man end DESCRIPTION
> +
> + at chapter Scaler Options
> + at c man begin SCALER OPTIONS
> +
> +The video scaler supports the following named options.
> +
> +Options may be set by specifying - at var{option} @var{value} in the
> +FFmpeg tools. For programmatic use, they can be set explicitly in the
> + at code{SwsContext} options or through the @file{libavutil/opt.h} API.
> +
> + at table @option
> +
> + at item sws_flags
> +Set the scaler flags. This is also used to set the scaling
> +algorithm. Only a single algorithm should be selected.
> +
> +It accepts the following values:
> + at table @samp
> + at item fast_bilinear
> +Select fast bilinear scaling algorithm.
> +
> + at item bilinear
> +Select bilinear scaling algorithm.
> +
> + at item bicubic
> +Select bicubic scaling algorithm.
> +
> + at item experimental
> +Select experimental scaling algorithm.
> +
> + at item nighbor

neighbor

> +Select nearest neighbor rescaling algorithm.
> +

[...]
> diff --git a/doc/libswscale.texi b/doc/libswscale.texi
> new file mode 100644
> index 0000000..2414fbb
> --- /dev/null
> +++ b/doc/libswscale.texi
> @@ -0,0 +1,55 @@
> +\input texinfo @c -*- texinfo -*-
> +
> + at settitle Libswscale Documentation
> + at titlepage
> + at center @titlefont{Libswscale Documentation}
> + at end titlepage
> +
> + at top
> +
> + at contents
> +
> + at chapter Description
> + at c man begin DESCRIPTION
> +
> +The libswscale library performs highly optimized image scaling and
> +colorspace and pixel format conversion operations.
> +
> +Specifically, this library performs the following conversions:
> +
> + at itemize
> + at item
> + at emph{Rescaling}: is the process of changing the video size. Several
> +rescaling options and algorithms are available. This is usually a
> +lossy process.
> +
> + at item
> + at emph{Pixel format conversion}: is the process of converting the image
> +format and colorspace of the image, for example from planar YUV420P to
> +RGB24 packed. It also handles packing conversion, that is converts
> +from packed layout (all pixels belonging to distinct planes
> +interleaved in the same buffer), to planar layout (all samples
> +belonging to the same plane stored in a dedicated buffer or "plane").
> +
> +This is usually a lossy process in case the source and destination
> +colorspace differ.

colorspaces?

> + at end itemize
> +
> + at c man end DESCRIPTION
> +
> + at ignore
> +
> + at setfilename libswscale
> + at settitle video scaling and pixel format conversion library
> +
> + at c man begin SEEALSO
> +ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), ffmpeg-scaler(1), libavutil(3)
> + at c man end
> +
> + at c man begin AUTHORS
> +See Git history (git://source.ffmpeg.org/ffmpeg)
> + at c man end
> +
> + at end ignore
> +
> + at bye

LGTM otherwise.

-- 
Clément B.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 490 bytes
Desc: not available
URL: <http://ffmpeg.org/pipermail/ffmpeg-devel/attachments/20121125/67517de4/attachment.asc>