[FFmpeg-devel] [PATCH 1/4] doc: remove encoder/muxer/sinks docs from ffplay- and ffprobe-all

Stefano Sabatini stefasab at gmail.com
Sun Jan 5 19:34:52 CET 2014


On date Saturday 2014-01-04 19:24:29 -0800, Timothy Gu encoded:
> ffplay and ffprobe are read-only.
> 
> Signed-off-by: Timothy Gu <timothygu99 at gmail.com>
> ---
> Still needs more work on this in doc/protocols.texi as the protocols are not
> listed by read/write.
> ---
>  doc/codecs.texi  |  4 ++++
>  doc/devices.texi |  4 ++++
>  doc/ffplay.texi  |  1 +
>  doc/ffprobe.texi |  1 +
>  doc/filters.texi | 10 ++++++++++
>  doc/formats.texi |  4 ++++
>  6 files changed, 24 insertions(+)
> 
> diff --git a/doc/codecs.texi b/doc/codecs.texi
> index c2cd555..fadcf24 100644
> --- a/doc/codecs.texi
> +++ b/doc/codecs.texi
> @@ -1092,5 +1092,9 @@ instead of alpha. Default is 0.
>  
>  @c man end CODEC OPTIONS
>  
> + at ifclear config-writeonly
>  @include decoders.texi
> + at end ifclear
> + at ifclear config-readonly
>  @include encoders.texi
> + at end ifclear
> diff --git a/doc/devices.texi b/doc/devices.texi
> index 8f8b22a..5e74a96 100644
> --- a/doc/devices.texi
> +++ b/doc/devices.texi
> @@ -17,5 +17,9 @@ for programmatic use.
>  
>  @c man end DEVICE OPTIONS
>  
> + at ifclear config-writeonly
>  @include indevs.texi
> + at end ifclear
> + at ifclear config-readonly
>  @include outdevs.texi
> + at end ifclear
> diff --git a/doc/ffplay.texi b/doc/ffplay.texi
> index e68a686..14a406d 100644
> --- a/doc/ffplay.texi
> +++ b/doc/ffplay.texi
> @@ -212,6 +212,7 @@ Seek to percentage in file corresponding to fraction of width.
>  
>  @include config.texi
>  @ifset config-all
> + at set config-readonly
>  @ifset config-avutil
>  @include utils.texi
>  @end ifset
> diff --git a/doc/ffprobe.texi b/doc/ffprobe.texi
> index 75d1e72..8de8956 100644
> --- a/doc/ffprobe.texi
> +++ b/doc/ffprobe.texi
> @@ -599,6 +599,7 @@ DV, GXF and AVI timecodes are available in format metadata
> 
>  @include config.texi
>  @ifset config-all
> + at set config-readonly
>  @ifset config-avutil
>  @include utils.texi
>  @end ifset
> diff --git a/doc/filters.texi b/doc/filters.texi
> index a579964..cfc57c7 100644
> --- a/doc/filters.texi
> +++ b/doc/filters.texi
> @@ -1957,6 +1957,7 @@ raising it by +5 dB causes clipping for 6 samples, etc.
>  
>  @c man end AUDIO FILTERS
>  
> + at ifclear config-writeonly

ffprobe -f lavfi color

Filters should not be marked write only.

>  @chapter Audio Sources
>  @c man begin AUDIO SOURCES
>  
> @@ -2267,7 +2268,9 @@ sine=frequency=220:beep_factor=4:duration=5
>  @end itemize
>  
>  @c man end AUDIO SOURCES
> + at end ifclear @c config-writeonly
>  
> + at ifclear config-readonly
>  @chapter Audio Sinks
>  @c man begin AUDIO SINKS
>  
> @@ -2292,6 +2295,7 @@ mainly useful as a template and to be employed in analysis / debugging
>  tools.
>  
>  @c man end AUDIO SINKS
> + at end ifclear @c config-readonly
>  
>  @chapter Video Filters
>  @c man begin VIDEO FILTERS
> @@ -8411,6 +8415,7 @@ Default value is @code{all}.
>  
>  @c man end VIDEO FILTERS
>  
> + at ifclear config-writeonly
>  @chapter Video Sources
>  @c man begin VIDEO SOURCES
>  
> @@ -9001,7 +9006,9 @@ corresponding @option{color} option.
>  @end table
>  
>  @c man end VIDEO SOURCES
> + at end ifclear @c config-writeonly
>  
> + at ifclear config-readonly
>  @chapter Video Sinks
>  @c man begin VIDEO SINKS
>  
> @@ -9027,6 +9034,7 @@ mainly useful as a template and to be employed in analysis / debugging
>  tools.
>  
>  @c man end VIDEO SINKS
> + at end ifclear @c config-readonly
>  
>  @chapter Multimedia Filters
>  @c man begin MULTIMEDIA FILTERS
> @@ -10109,6 +10117,7 @@ echo Parsed_color_1 c pink | tools/zmqsend
>  
>  @c man end MULTIMEDIA FILTERS
>  
> + at ifclear config-writeonly
>  @chapter Multimedia Sources
>  @c man begin MULTIMEDIA SOURCES
>  
> @@ -10205,3 +10214,4 @@ movie=dvd.vob:s=v:0+#0x81 [video] [audio]
>  @end itemize
>  
>  @c man end MULTIMEDIA SOURCES
> + at end ifclear @c config-writeonly
> diff --git a/doc/formats.texi b/doc/formats.texi
> index b535a5f..ba9d277 100644
> --- a/doc/formats.texi
> +++ b/doc/formats.texi
> @@ -183,6 +183,10 @@ The exact semantics of stream specifiers is defined by the
>  @code{avformat_match_stream_specifier()} function declared in the
>  @file{libavformat/avformat.h} header.
>  
> + at ifclear config-writeonly
>  @include demuxers.texi
> + at end ifclear
> + at ifclear config-readonly
>  @include muxers.texi
> + at end ifclear
>  @include metadata.texi

In general, write-only or read-only are pretty arbitrary, for example
what if we add a movie output sink? In that case ffprobe and ffplay
will be able to use muxers and encoders.

I'm fine to mark ffplay and ffprobe as read-only, and avoid to list
muxers and encoders, but we should not disable filter listing (about
ffprobe, there is at least an use case when the user wants to apply
filters to show metadata).
-- 
FFmpeg = Frightening and Fundamental Majestic Pitiless Energized Gadget


More information about the ffmpeg-devel mailing list