[FFmpeg-devel] [RFC] documentation: add encoders chapter

[James Zern]

On Fri, Feb 11, 2011 at 15:51, M?ns Rullg?rd <mans at mansr.com> wrote:
> James Zern <jzern at google.com> writes:
>
>> On Fri, Feb 11, 2011 at 02:33, Stefano Sabatini
>> <stefano.sabatini-lala at poste.it> wrote:
>>> On date Thursday 2011-02-10 16:47:59 -0800, James Zern encoded:
>>>> Initial encoders.texi shell
>>>> ---
>>>> ?doc/encoders.texi | ? 20 ++++++++++++++++++++
>>>> ?doc/ffmpeg.texi ? | ? ?1 +
>>>> ?2 files changed, 21 insertions(+), 0 deletions(-)
>>>> ?create mode 100644 doc/encoders.texi
>>>>
>>>> As suggested by Stefano in '[FFmpeg-devel] [PATCH] vpxenc: add codec
>>>> specific speed option' [1].
>>>>
>>>> [1]: https://lists.mplayerhq.hu/pipermail/ffmpeg-devel/2011-January/102749.html
>>>
>>>> diff --git a/doc/encoders.texi b/doc/encoders.texi
>>>> new file mode 100644
>>>> index 0000000..7e7aa99
>>>> --- /dev/null
>>>> +++ b/doc/encoders.texi
>>>> @@ -0,0 +1,20 @@
>>>> + at chapter Encoders
>>>> + at c man begin ENCODERS
>>>> +
>>>> +Encoders are configured elements in FFmpeg which allow the creation of
>>>> +multimedia streams.
>>>
>>> Here "creation" is a bit ambiguous (for example it may be interpreted
>>> as "synthesis"), maybe "encoding" would be just fine.
>>>
>> Using encoding in the same sentence with encoders seems off to me.
>
> Encoders encode, nothing strange about that. ?This is a technical
> manual, not poetry.
>
Very well.
-------------- next part --------------
diff --git a/doc/encoders.texi b/doc/encoders.texi
new file mode 100644
index 0000000..cab98fb
--- /dev/null
+++ b/doc/encoders.texi
@@ -0,0 +1,20 @@
+ at chapter Encoders
+ at c man begin ENCODERS
+
+Encoders are configured elements in FFmpeg which allow the encoding of
+multimedia streams.
+
+When you configure your FFmpeg build, all the supported native encoders
+are enabled by default. Encoders requiring an external library must be enabled
+manually via the corresponding @code{--enable-lib} option. You can list all
+available encoders using the configure option @code{--list-encoders}.
+
+You can disable all the encoders with the configure option
+ at code{--disable-encoders} and selectively enable / disable single encoders
+with the options @code{--enable-encoder=@var{ENCODER}} /
+ at code{--disable-encoder=@var{ENCODER}}.
+
+The option @code{-codecs} of the ff* tools will display the list of
+enabled encoders.
+
+ at c man end ENCODERS
diff --git a/doc/ffmpeg.texi b/doc/ffmpeg.texi
index 8b8e42f..f0f3b65 100644
--- a/doc/ffmpeg.texi
+++ b/doc/ffmpeg.texi
@@ -981,6 +981,7 @@ file to which you want to add them.
 @c man end EXAMPLES
 
 @include eval.texi
+ at include encoders.texi
 @include demuxers.texi
 @include muxers.texi
 @include indevs.texi