diff mbox series

[FFmpeg-devel,v3] doc/filters: add example for idet filter

Message ID 20231211200741.977160-1-marth64@proxyid.net
State New
Headers show
Series [FFmpeg-devel,v3] doc/filters: add example for idet filter | expand

Checks

Context Check Description
yinshiyou/make_loongarch64 success Make finished
yinshiyou/make_fate_loongarch64 success Make fate finished
andriy/make_x86 success Make finished
andriy/make_fate_x86 success Make fate finished

Commit Message

Marth64 Dec. 11, 2023, 8:07 p.m. UTC
Clean up the example further. Sorry.

Signed-off-by: Marth64 <marth64@proxyid.net>
---
 doc/filters.texi | 7 +++++++
 1 file changed, 7 insertions(+)

Comments

Stefano Sabatini Dec. 11, 2023, 11:51 p.m. UTC | #1
On date Monday 2023-12-11 14:07:42 -0600, Marth64 wrote:
> Clean up the example further. Sorry.
> 
> Signed-off-by: Marth64 <marth64@proxyid.net>
> ---
>  doc/filters.texi | 7 +++++++
>  1 file changed, 7 insertions(+)
> 
> diff --git a/doc/filters.texi b/doc/filters.texi
> index 6d00ba2c3f..bf59352ba0 100644
> --- a/doc/filters.texi
> +++ b/doc/filters.texi
> @@ -15919,6 +15919,13 @@ further computations. This allows inserting the idet filter as a low computation
>  method to clean up the interlaced flag
>  @end table
>  
> +@subsection Examples
> +

> +Analyze the field order of the first 360 frames in a video:
> +@example
> +ffmpeg -i INPUT -filter:v idet -frames:v 360 -an -f null -
> +@end example

Probably it's also useful to clarify the expectations for the user.
This command will add the metadata to the frames, which will be then
discarded, and print a final report with some stats.
Probably it's more useful to show a complete example showing the value
for each frame, for example with metadata=mode=print

-filter:v idet,metadata=mode=print
diff mbox series

Patch

diff --git a/doc/filters.texi b/doc/filters.texi
index 6d00ba2c3f..bf59352ba0 100644
--- a/doc/filters.texi
+++ b/doc/filters.texi
@@ -15919,6 +15919,13 @@  further computations. This allows inserting the idet filter as a low computation
 method to clean up the interlaced flag
 @end table
 
+@subsection Examples
+
+Analyze the field order of the first 360 frames in a video:
+@example
+ffmpeg -i INPUT -filter:v idet -frames:v 360 -an -f null -
+@end example
+
 @section il
 
 Deinterleave or interleave fields.