From: Urban Wallasch <urban.wallasch@freenet.de>
Date: Sun, 23 May 2021 17:40:39 +0000 (+0200)
Subject: * Added section about filter expressions to README.md.
X-Git-Tag: v0.4~41
X-Git-Url: https://git.packet-gain.de/?a=commitdiff_plain;h=56dde00da102991ce728ceb7115b6d6d1470e174;p=ffpreview.git

* Added section about filter expressions to README.md.
---

diff --git a/README.md b/README.md
index d022207..73f3339 100644
--- a/README.md
+++ b/README.md
@@ -32,6 +32,28 @@ below), plus the incantations to start external programs, can be specified
 in the configuration file. For more detailed information please refer to
 the `ffpreview.conf.sample` example configuration file.
 
+## Video filters
+
+The thumbnail sampling method presets available in `ffpreview` translate
+to `ffmpeg` filters as follows:
+
+`iframe` (_--iframe_, key frame detection):
+>   `-vf select=eq(pict_type,I), ...`
+
+`scene` (_--scene_, automatic scene change detection):
+>   `-vf select=gt(scene,SCENE_THRESHOLD), ...`
+
+`skip` (_--nskip_, skip number of frames):
+>   `-vf select=not(mod(n,NUM_FRAMES)), ...`
+
+`time` (_--nsecs_, skip number of seconds):
+>   `-vf select=not(mod(n,NUM_SECONDS*FPS)), ...`
+
+`customvf` (_--customvf_, custom video filter):
+>   `-vf select=YOUR_CUSTOM_FILTER, ...`
+
+Please consult the `ffmpeg` documentation to learn more about video filter
+expressions.
 
 ## Usage
 
@@ -130,6 +152,7 @@ $ ./ffpreview.py -m
 $ ./ffpreview.py -b movie1.mkv movie2.mp4 another.mpg
 $ ./ffpreview.py -b /some/directory/*
 ```
+**Note:** `ffpreview` does _not_ recursively traverse subdirectories.
 
 ## License