[FFmpeg-cvslog] doc/filters: put vidstab filters documentation in a sensible order

[Stefano Sabatini]

ffmpeg | branch: master | Stefano Sabatini <stefasab at gmail.com> | Thu Apr 25 11:26:33 2013 +0200| [16cecf9c3de89600aa28852201da4e605cf796bf] | committer: Stefano Sabatini

doc/filters: put vidstab filters documentation in a sensible order

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=16cecf9c3de89600aa28852201da4e605cf796bf
---

 doc/filters.texi |  437 +++++++++++++++++++++++++++---------------------------
 1 file changed, 217 insertions(+), 220 deletions(-)

diff --git a/doc/filters.texi b/doc/filters.texi
index 24241e8..9456aa4 100644
--- a/doc/filters.texi
+++ b/doc/filters.texi
@@ -5306,140 +5306,6 @@ much, but it will increase the amount of blurring needed to cover over
 the image and will destroy more information than necessary, and extra
 pixels will slow things down on a large logo.
 
- at anchor{vidstabtransform}
- at section vidstabtransform
-
-Video stabilization/deshaking: pass 2 of 2,
-see @ref{vidstabdetect} for pass 1.
-
-Read a file with transform information for each frame and
-apply/compensate them. Together with the @ref{vidstabdetect}
-filter this can be used to deshake videos. See also
- at url{http://public.hronopik.de/vid.stab}. It is important to also use
-the unsharp filter, see below.
-
-To enable compilation of this filter you need to configure FFmpeg with
- at code{--enable-libvidstab}.
-
-This filter accepts the following options:
-
- at table @option
-
- at item input
-path to the file used to read the transforms (default: @file{transforms.trf})
-
- at item smoothing
-number of frames (value*2 + 1) used for lowpass filtering the camera movements
-(default: 10). For example a number of 10 means that 21 frames are used
-(10 in the past and 10 in the future) to smoothen the motion in the
-video. A larger values leads to a smoother video, but limits the
-acceleration of the camera (pan/tilt movements).
-
- at item maxshift
-maximal number of pixels to translate frames (default: -1 no limit)
-
- at item maxangle
-maximal angle in radians (degree*PI/180) to rotate frames (default: -1
-no limit)
-
- at item crop
-How to deal with borders that may be visible due to movement
-compensation. Available values are:
-
- at table @samp
- at item keep
-keep image information from previous frame (default)
- at item black
-fill the border black
- at end table
-
- at item invert
- at table @samp
- at item 0
- keep transforms normal (default)
- at item 1
- invert transforms
- at end table
-
-
- at item relative
-consider transforms as
- at table @samp
- at item 0
- absolute
- at item 1
- relative to previous frame (default)
- at end table
-
-
- at item zoom
-percentage to zoom (default: 0)
- at table @samp
- at item >0
-  zoom in
- at item <0
-  zoom out
- at end table
-
- at item optzoom
-if 1 then optimal zoom value is determined (default).
-Optimal zoom means no (or only little) border should be visible.
-Note that the value given at zoom is added to the one calculated
-here.
-
- at item interpol
-type of interpolation
-
-Available values are:
- at table @samp
- at item no
-no interpolation
- at item linear
-linear only horizontal
- at item bilinear
-linear in both directions (default)
- at item bicubic
-cubic in both directions (slow)
- at end table
-
- at item tripod
-virtual tripod mode means that the video is stabilized such that the
-camera stays stationary. Use also @code{tripod} option of
- at ref{vidstabdetect}.
- at table @samp
- at item 0
-off (default)
- at item 1
-virtual tripod mode: equivalent to @code{relative=0:smoothing=0}
- at end table
-
- at end table
-
- at subsection Examples
-
- at itemize
- at item
-typical call with default default values:
- (note the unsharp filter which is always recommended)
- at example
-ffmpeg -i inp.mpeg -vf vidstabtransform,unsharp=5:5:0.8:3:3:0.4 inp_stabilized.mpeg
- at end example
-
- at item
-zoom in a bit more and load transform data from a given file
- at example
-vidstabtransform=zoom=5:input="mytransforms.trf"
- at end example
-
- at item
-smoothen the video even more
- at example
-vidstabtransform=smoothing=30
- at end example
-
- at end itemize
-
-
 @section scale
 
 Scale (resize) the input video, using the libswscale library.
@@ -5838,92 +5704,6 @@ in [-30,0] will filter edges. Default value is 0.
 If a chroma option is not explicitly set, the corresponding luma value
 is set.
 
- at anchor{vidstabdetect}
- at section vidstabdetect
-
-Video stabilization/deshaking: pass 1 of 2, see @ref{vidstabtransform}
-for pass 2.
-
-Generates a file with relative transform information translation,
-rotation about subsequent frames.
-
-To enable compilation of this filter you need to configure FFmpeg with
- at code{--enable-libvidstab}.
-
-This filter accepts the following options:
-
- at table @option
- at item result
-path to the file used to write the transforms (default:@file{transforms.trf})
-
- at item shakiness
-how shaky is the video and how quick is the camera? (default: 5)
- at table @samp
- at item 1
- little (fast)
- at item ...
- at item 10
- very strong/quick (slow)
- at end table
-
- at item accuracy
-accuracy of detection process (>=shakiness) (default: 9)
- at table @samp
- at item 1
- low (fast)
- at item 15
- high (slow)
- at end table
-
- at item stepsize
-stepsize of search process, region around minimum is scanned with 1 pixel
-resolution (default: 6)
-
- at item mincontrast
-below this contrast a local measurement field is discarded (0-1) (default: 0.3)
-
- at item tripod
-virtual tripod mode: @code{tripod=framenum} if framenum>0 otherwise disabled.
-The motion of the frames is compared to a reference frame (framenum).
-The idea is to compensate all movements in a more-or-less static scene
- and keep the camera view absolutely still.
-(default: 0 (disabled))
-
- at item show
-draw nothing (default); 1,2: show fields and transforms in the resulting frames
-
- at end table
-
- at subsection Examples
-
- at itemize
- at item
-use default values:
- at example
-vidstabdetect
- at end example
-
- at item
-strongly shaky movie and put the results in @code{mytransforms.trf}
- at example
-vidstabdetect=shakiness=10:accuracy=15:result="mytransforms.trf"
- at end example
-
- at item
-visualize some internals in the resulting video
- at example
-vidstabdetect=show=1
- at end example
-
-
- at item
-Typical call with visualization
- at example
-ffmpeg -i input -vf vidstabdetect=shakiness=5:show=1 dummy.avi
- at end example
- at end itemize
-
-
 @section stereo3d
 
 Convert between different stereoscopic image formats.
@@ -6438,6 +6218,223 @@ unsharp=7:7:-2:7:7:-2
 @end example
 @end itemize
 
+ at anchor{vidstabdetect}
+ at section vidstabdetect
+
+Video stabilization/deshaking: pass 1 of 2, see @ref{vidstabtransform}
+for pass 2.
+
+Generates a file with relative transform information translation,
+rotation about subsequent frames.
+
+To enable compilation of this filter you need to configure FFmpeg with
+ at code{--enable-libvidstab}.
+
+This filter accepts the following options:
+
+ at table @option
+ at item result
+path to the file used to write the transforms (default:@file{transforms.trf})
+
+ at item shakiness
+how shaky is the video and how quick is the camera? (default: 5)
+ at table @samp
+ at item 1
+ little (fast)
+ at item ...
+ at item 10
+ very strong/quick (slow)
+ at end table
+
+ at item accuracy
+accuracy of detection process (>=shakiness) (default: 9)
+ at table @samp
+ at item 1
+ low (fast)
+ at item 15
+ high (slow)
+ at end table
+
+ at item stepsize
+stepsize of search process, region around minimum is scanned with 1 pixel
+resolution (default: 6)
+
+ at item mincontrast
+below this contrast a local measurement field is discarded (0-1) (default: 0.3)
+
+ at item tripod
+virtual tripod mode: @code{tripod=framenum} if framenum>0 otherwise disabled.
+The motion of the frames is compared to a reference frame (framenum).
+The idea is to compensate all movements in a more-or-less static scene
+ and keep the camera view absolutely still.
+(default: 0 (disabled))
+
+ at item show
+draw nothing (default); 1,2: show fields and transforms in the resulting frames
+
+ at end table
+
+ at subsection Examples
+
+ at itemize
+ at item
+use default values:
+ at example
+vidstabdetect
+ at end example
+
+ at item
+strongly shaky movie and put the results in @code{mytransforms.trf}
+ at example
+vidstabdetect=shakiness=10:accuracy=15:result="mytransforms.trf"
+ at end example
+
+ at item
+visualize some internals in the resulting video
+ at example
+vidstabdetect=show=1
+ at end example
+
+ at item
+Typical call with visualization
+ at example
+ffmpeg -i input -vf vidstabdetect=shakiness=5:show=1 dummy.avi
+ at end example
+ at end itemize
+
+ at anchor{vidstabtransform}
+ at section vidstabtransform
+
+Video stabilization/deshaking: pass 2 of 2,
+see @ref{vidstabdetect} for pass 1.
+
+Read a file with transform information for each frame and
+apply/compensate them. Together with the @ref{vidstabdetect}
+filter this can be used to deshake videos. See also
+ at url{http://public.hronopik.de/vid.stab}. It is important to also use
+the unsharp filter, see below.
+
+To enable compilation of this filter you need to configure FFmpeg with
+ at code{--enable-libvidstab}.
+
+This filter accepts the following options:
+
+ at table @option
+
+ at item input
+path to the file used to read the transforms (default: @file{transforms.trf})
+
+ at item smoothing
+number of frames (value*2 + 1) used for lowpass filtering the camera movements
+(default: 10). For example a number of 10 means that 21 frames are used
+(10 in the past and 10 in the future) to smoothen the motion in the
+video. A larger values leads to a smoother video, but limits the
+acceleration of the camera (pan/tilt movements).
+
+ at item maxshift
+maximal number of pixels to translate frames (default: -1 no limit)
+
+ at item maxangle
+maximal angle in radians (degree*PI/180) to rotate frames (default: -1
+no limit)
+
+ at item crop
+How to deal with borders that may be visible due to movement
+compensation. Available values are:
+
+ at table @samp
+ at item keep
+keep image information from previous frame (default)
+ at item black
+fill the border black
+ at end table
+
+ at item invert
+ at table @samp
+ at item 0
+ keep transforms normal (default)
+ at item 1
+ invert transforms
+ at end table
+
+
+ at item relative
+consider transforms as
+ at table @samp
+ at item 0
+ absolute
+ at item 1
+ relative to previous frame (default)
+ at end table
+
+
+ at item zoom
+percentage to zoom (default: 0)
+ at table @samp
+ at item >0
+  zoom in
+ at item <0
+  zoom out
+ at end table
+
+ at item optzoom
+if 1 then optimal zoom value is determined (default).
+Optimal zoom means no (or only little) border should be visible.
+Note that the value given at zoom is added to the one calculated
+here.
+
+ at item interpol
+type of interpolation
+
+Available values are:
+ at table @samp
+ at item no
+no interpolation
+ at item linear
+linear only horizontal
+ at item bilinear
+linear in both directions (default)
+ at item bicubic
+cubic in both directions (slow)
+ at end table
+
+ at item tripod
+virtual tripod mode means that the video is stabilized such that the
+camera stays stationary. Use also @code{tripod} option of
+ at ref{vidstabdetect}.
+ at table @samp
+ at item 0
+off (default)
+ at item 1
+virtual tripod mode: equivalent to @code{relative=0:smoothing=0}
+ at end table
+
+ at end table
+
+ at subsection Examples
+
+ at itemize
+ at item
+typical call with default default values:
+ (note the unsharp filter which is always recommended)
+ at example
+ffmpeg -i inp.mpeg -vf vidstabtransform,unsharp=5:5:0.8:3:3:0.4 inp_stabilized.mpeg
+ at end example
+
+ at item
+zoom in a bit more and load transform data from a given file
+ at example
+vidstabtransform=zoom=5:input="mytransforms.trf"
+ at end example
+
+ at item
+smoothen the video even more
+ at example
+vidstabtransform=smoothing=30
+ at end example
+
+ at end itemize
+
 @section vflip
 
 Flip the input video vertically.