[FFmpeg-devel] [PATCH] Document ffmpeg -formats

[Daniel Verkamp]

On Fri, Feb 20, 2009 at 6:14 AM, Michael Niedermayer <michaelni at gmx.at> wrote:
> On Thu, Feb 19, 2009 at 08:35:03PM -0600, Daniel Verkamp wrote:
>> Hi,
>>
>> As in $subject.
>>
>> Please inspect these carefully, as I have only made my best guess at
>> what they actually mean (since they aren't documented :).
>>
>> Thanks,
>> -- Daniel Verkamp
>
>> From 23b080ad2f94ca6b74a9543396aaf1d554202bd5 Mon Sep 17 00:00:00 2001
>> From: Daniel Verkamp <daniel at drv.nu>
>> Date: Thu, 19 Feb 2009 20:32:35 -0600
>> Subject: [PATCH] Document -formats
>>
>> ---
>>  doc/ffmpeg-doc.texi |   18 +++++++++++++++++-
>>  1 files changed, 17 insertions(+), 1 deletions(-)
>>
>> diff --git a/doc/ffmpeg-doc.texi b/doc/ffmpeg-doc.texi
>> index bb093f7..20b49f4 100644
>> --- a/doc/ffmpeg-doc.texi
>> +++ b/doc/ffmpeg-doc.texi
>> @@ -229,7 +229,23 @@ Show help.
>>  Show version.
>>
>>  @item -formats
>> -Show available formats, codecs, protocols, ...
>> +Show available formats, codecs, bitstream filters, protocols, and frame size and frame rate abbreviations.
>> +
>> +The fields preceding the format and codec names have the following meanings:
>> + at table @samp
>> + at item D
>> +Decoding available
>> + at item E
>> +Encoding available
>> + at item V/A/S
>> +Video/audio/subtitle codec
>
>> + at item S
>> +Decoder can use draw_horiz_band callback
>> + at item D
>> +Codec uses get_buffer() for allocating buffers
>
> S stands for slice support
> D for direct rendering
>

New patch attached.  Probably the corresponding codec flags should be
documented this way too (especially CODEC_CAP_DR1, as it has no
doxygen at all).

Thanks,
-- Daniel Verkamp
-------------- next part --------------
>From fc06ed083df37cc639b9413d670aefb2e6b374a4 Mon Sep 17 00:00:00 2001
From: Daniel Verkamp <daniel at drv.nu>
Date: Thu, 19 Feb 2009 20:32:35 -0600
Subject: [PATCH] Document -formats

---
 doc/ffmpeg-doc.texi |   18 +++++++++++++++++-
 1 files changed, 17 insertions(+), 1 deletions(-)

diff --git a/doc/ffmpeg-doc.texi b/doc/ffmpeg-doc.texi
index bb093f7..46150c7 100644
--- a/doc/ffmpeg-doc.texi
+++ b/doc/ffmpeg-doc.texi
@@ -229,7 +229,23 @@ Show help.
 Show version.
 
 @item -formats
-Show available formats, codecs, protocols, ...
+Show available formats, codecs, bitstream filters, protocols, and frame size and frame rate abbreviations.
+
+The fields preceding the format and codec names have the following meanings:
+ at table @samp
+ at item D
+Decoding available
+ at item E
+Encoding available
+ at item V/A/S
+Video/audio/subtitle codec
+ at item S
+Codec supports slices
+ at item D
+Codec supports direct rendering
+ at item T
+Codec can handle input truncated at random locations instead of only at frame boundaries
+ at end table
 
 @item -f @var{fmt}
 Force format.
-- 
1.6.1.3