avcodec: Move all AVCodecParser.split functions to remove_extradata_bsf

[ffmpeg] / doc / filters.texi

diff --git a/doc/filters.texi b/doc/filters.texi
index 891e8c45448ef99655e95ce3311a19be2c83f825..e99d70a2d3dcca63f0004dbb0187c1b5363d0020 100644 (file)
--- a/doc/filters.texi
+++ b/doc/filters.texi
@@ -656,44 +656,44 @@ Samples detected as impulsive noise are replaced by interpolated samples using
 autoregressive modelling.
 
 @table @option
 autoregressive modelling.
 
 @table @option

-@item w
+@item window, w

 Set window size, in milliseconds. Allowed range is from @code{10} to
 @code{100}. Default value is @code{55} milliseconds.
 This sets size of window which will be processed at once.
 
 Set window size, in milliseconds. Allowed range is from @code{10} to
 @code{100}. Default value is @code{55} milliseconds.
 This sets size of window which will be processed at once.
 

-@item o
+@item overlap, o

 Set window overlap, in percentage of window size. Allowed range is from
 @code{50} to @code{95}. Default value is @code{75} percent.
 Setting this to a very high value increases impulsive noise removal but makes
 whole process much slower.
 
 Set window overlap, in percentage of window size. Allowed range is from
 @code{50} to @code{95}. Default value is @code{75} percent.
 Setting this to a very high value increases impulsive noise removal but makes
 whole process much slower.
 

-@item a
+@item arorder, a

 Set autoregression order, in percentage of window size. Allowed range is from
 @code{0} to @code{25}. Default value is @code{2} percent. This option also
 controls quality of interpolated samples using neighbour good samples.
 
 Set autoregression order, in percentage of window size. Allowed range is from
 @code{0} to @code{25}. Default value is @code{2} percent. This option also
 controls quality of interpolated samples using neighbour good samples.
 

-@item t
+@item threshold, t

 Set threshold value. Allowed range is from @code{1} to @code{100}.
 Default value is @code{2}.
 This controls the strength of impulsive noise which is going to be removed.
 The lower value, the more samples will be detected as impulsive noise.
 
 Set threshold value. Allowed range is from @code{1} to @code{100}.
 Default value is @code{2}.
 This controls the strength of impulsive noise which is going to be removed.
 The lower value, the more samples will be detected as impulsive noise.
 

-@item b
+@item burst, b

 Set burst fusion, in percentage of window size. Allowed range is @code{0} to
 @code{10}. Default value is @code{2}.
 If any two samples detected as noise are spaced less than this value then any
 sample between those two samples will be also detected as noise.
 
 Set burst fusion, in percentage of window size. Allowed range is @code{0} to
 @code{10}. Default value is @code{2}.
 If any two samples detected as noise are spaced less than this value then any
 sample between those two samples will be also detected as noise.
 

-@item m
+@item method, m

 Set overlap method.
 
 It accepts the following values:
 @table @option
 Set overlap method.
 
 It accepts the following values:
 @table @option

-@item a
+@item add, a

 Select overlap-add method. Even not interpolated samples are slightly
 changed with this method.
 
 Select overlap-add method. Even not interpolated samples are slightly
 changed with this method.
 

-@item s
+@item save, s

 Select overlap-save method. Not interpolated samples remain unchanged.
 @end table
 
 Select overlap-save method. Not interpolated samples remain unchanged.
 @end table
 


@@ -707,38 +707,38 @@ Samples detected as clipped are replaced by interpolated samples using
 autoregressive modelling.
 
 @table @option
 autoregressive modelling.
 
 @table @option

-@item w
+@item window, w

 Set window size, in milliseconds. Allowed range is from @code{10} to @code{100}.
 Default value is @code{55} milliseconds.
 This sets size of window which will be processed at once.
 
 Set window size, in milliseconds. Allowed range is from @code{10} to @code{100}.
 Default value is @code{55} milliseconds.
 This sets size of window which will be processed at once.
 

-@item o
+@item overlap, o

 Set window overlap, in percentage of window size. Allowed range is from @code{50}
 to @code{95}. Default value is @code{75} percent.
 
 Set window overlap, in percentage of window size. Allowed range is from @code{50}
 to @code{95}. Default value is @code{75} percent.
 

-@item a
+@item arorder, a

 Set autoregression order, in percentage of window size. Allowed range is from
 @code{0} to @code{25}. Default value is @code{8} percent. This option also controls
 quality of interpolated samples using neighbour good samples.
 
 Set autoregression order, in percentage of window size. Allowed range is from
 @code{0} to @code{25}. Default value is @code{8} percent. This option also controls
 quality of interpolated samples using neighbour good samples.
 

-@item t
+@item threshold, t

 Set threshold value. Allowed range is from @code{1} to @code{100}.
 Default value is @code{10}. Higher values make clip detection less aggressive.
 
 Set threshold value. Allowed range is from @code{1} to @code{100}.
 Default value is @code{10}. Higher values make clip detection less aggressive.
 

-@item n
+@item hsize, n

 Set size of histogram used to detect clips. Allowed range is from @code{100} to @code{9999}.
 Default value is @code{1000}. Higher values make clip detection less aggressive.
 
 Set size of histogram used to detect clips. Allowed range is from @code{100} to @code{9999}.
 Default value is @code{1000}. Higher values make clip detection less aggressive.
 

-@item m
+@item method, m

 Set overlap method.
 
 It accepts the following values:
 @table @option
 Set overlap method.
 
 It accepts the following values:
 @table @option

-@item a
+@item add, a

 Select overlap-add method. Even not interpolated samples are slightly changed
 with this method.
 
 Select overlap-add method. Even not interpolated samples are slightly changed
 with this method.
 

-@item s
+@item save, s

 Select overlap-save method. Not interpolated samples remain unchanged.
 @end table
 
 Select overlap-save method. Not interpolated samples remain unchanged.
 @end table
 


@@ -1003,6 +1003,62 @@ aeval=val(0)|-val(1)
 @end example
 @end itemize
 
 @end example
 @end itemize
 

+@section aexciter
+
+An exciter is used to produce high sound that is not present in the
+original signal. This is done by creating harmonic distortions of the
+signal which are restricted in range and added to the original signal.
+An Exciter raises the upper end of an audio signal without simply raising
+the higher frequencies like an equalizer would do to create a more
+"crisp" or "brilliant" sound.
+
+The filter accepts the following options:
+
+@table @option
+@item level_in
+Set input level prior processing of signal.
+Allowed range is from 0 to 64.
+Default value is 1.
+
+@item level_out
+Set output level after processing of signal.
+Allowed range is from 0 to 64.
+Default value is 1.
+
+@item amount
+Set the amount of harmonics added to original signal.
+Allowed range is from 0 to 64.
+Default value is 1.
+
+@item drive
+Set the amount of newly created harmonics.
+Allowed range is from 0.1 to 10.
+Default value is 8.5.
+
+@item blend
+Set the octave of newly created harmonics.
+Allowed range is from -10 to 10.
+Default value is 0.
+
+@item freq
+Set the lower frequency limit of producing harmonics in Hz.
+Allowed range is from 2000 to 12000 Hz.
+Default is 7500 Hz.
+
+@item ceil
+Set the upper frequency limit of producing harmonics.
+Allowed range is from 9999 to 20000 Hz.
+If value is lower than 10000 Hz no limit is applied.
+
+@item listen
+Mute the original signal and output only added harmonics.
+By default is disabled.
+@end table
+
+@subsection Commands
+
+This filter supports the all above options as @ref{commands}.
+

 @anchor{afade}
 @section afade
 
 @anchor{afade}
 @section afade
 


@@ -1880,10 +1936,10 @@ stream ends. The default value is 2 seconds.
 Specify weight of each input audio stream as sequence.
 Each weight is separated by space. By default all inputs have same weight.
 
 Specify weight of each input audio stream as sequence.
 Each weight is separated by space. By default all inputs have same weight.
 

-@item sum
-Do not scale inputs but instead do only summation of samples.
-Beware of heavy clipping if inputs are not normalized prior of filtering
-or output from @var{amix} normalized after filtering. By default is disabled.
+@item normalize
+Always scale inputs instead of only doing summation of samples.
+Beware of heavy clipping if inputs are not normalized prior or after filtering
+by this filter if this option is disabled. By default is enabled.

 @end table
 
 @subsection Commands
 @end table
 
 @subsection Commands


@@ -9257,6 +9313,10 @@ Save Gnuplot script of the curves in specified file.
 To avoid some filtergraph syntax conflicts, each key points list need to be
 defined using the following syntax: @code{x0/y0 x1/y1 x2/y2 ...}.
 
 To avoid some filtergraph syntax conflicts, each key points list need to be
 defined using the following syntax: @code{x0/y0 x1/y1 x2/y2 ...}.
 

+@subsection Commands
+
+This filter supports same @ref{commands} as options.
+

 @subsection Examples
 
 @itemize
 @subsection Examples
 
 @itemize


@@ -9354,6 +9414,10 @@ Set display number format. Can be @code{hex}, or @code{dec}. Default is @code{he
 Set pixel components to display. By default all pixel components are displayed.
 @end table
 
 Set pixel components to display. By default all pixel components are displayed.
 @end table
 

+@subsection Commands
+
+This filter supports same @ref{commands} as options excluding @code{size} option.
+

 @section dblur
 Apply Directional blur filter.
 
 @section dblur
 Apply Directional blur filter.
 


@@ -9754,12 +9818,6 @@ specified.
 Specify the width and height of the logo to clear. They must be
 specified.
 
 Specify the width and height of the logo to clear. They must be
 specified.
 

-@item band, t
-Specify the thickness of the fuzzy edge of the rectangle (added to
-@var{w} and @var{h}). The default value is 1. This option is
-deprecated, setting higher values should no longer be necessary and
-is not recommended.
-

 @item show
 When set to 1, a green rectangle is drawn on the screen to simplify
 finding the right @var{x}, @var{y}, @var{w}, and @var{h} parameters.
 @item show
 When set to 1, a green rectangle is drawn on the screen to simplify
 finding the right @var{x}, @var{y}, @var{w}, and @var{h} parameters.


@@ -9777,9 +9835,9 @@ compute the interpolated pixel values inside the rectangle.
 @itemize
 @item
 Set a rectangle covering the area with top left corner coordinates 0,0
 @itemize
 @item
 Set a rectangle covering the area with top left corner coordinates 0,0

-and size 100x77, and a band of size 10:
+and size 100x77:

 @example
 @example

-delogo=x=0:y=0:w=100:h=77:band=10
+delogo=x=0:y=0:w=100:h=77

 @end example
 
 @end itemize
 @end example
 
 @end itemize


@@ -9828,7 +9886,7 @@ Native implementation of DNN loading and execution.
 @item tensorflow
 TensorFlow backend. To enable this backend you
 need to install the TensorFlow for C library (see
 @item tensorflow
 TensorFlow backend. To enable this backend you
 need to install the TensorFlow for C library (see

-@url{https://www.tensorflow.org/install/install_c}) and configure FFmpeg with
+@url{https://www.tensorflow.org/install/lang_c}) and configure FFmpeg with

 @code{--enable-libtensorflow}
 @end table
 Default value is @samp{native}.
 @code{--enable-libtensorflow}
 @end table
 Default value is @samp{native}.


@@ -10069,6 +10127,46 @@ ffmpeg -i INPUT -f lavfi -i nullsrc=hd720,geq='r=128+80*(sin(sqrt((X-W/2)*(X-W/2
 @end example
 @end itemize
 
 @end example
 @end itemize
 

+@section dnn_detect
+
+Do object detection with deep neural networks.
+
+The filter accepts the following options:
+
+@table @option
+@item dnn_backend
+Specify which DNN backend to use for model loading and execution. This option accepts
+only openvino now, tensorflow backends will be added.
+
+@item model
+Set path to model file specifying network architecture and its parameters.
+Note that different backends use different file formats.
+
+@item input
+Set the input name of the dnn network.
+
+@item output
+Set the output name of the dnn network.
+
+@item confidence
+Set the confidence threshold (default: 0.5).
+
+@item labels
+Set path to label file specifying the mapping between label id and name.
+Each label name is written in one line, tailing spaces and empty lines are skipped.
+The first line is the name of label id 0 (usually it is 'background'),
+and the second line is the name of label id 1, etc.
+The label id is considered as name if the label file is not provided.
+
+@item backend_configs
+Set the configs to be passed into backend
+
+@item async
+use DNN async execution if set (default: set),
+roll back to sync execution if the backend does not support async.
+
+@end table
+

 @anchor{dnn_processing}
 @section dnn_processing
 
 @anchor{dnn_processing}
 @section dnn_processing
 


@@ -10089,7 +10187,7 @@ Native implementation of DNN loading and execution.
 @item tensorflow
 TensorFlow backend. To enable this backend you
 need to install the TensorFlow for C library (see
 @item tensorflow
 TensorFlow backend. To enable this backend you
 need to install the TensorFlow for C library (see

-@url{https://www.tensorflow.org/install/install_c}) and configure FFmpeg with
+@url{https://www.tensorflow.org/install/lang_c}) and configure FFmpeg with

 @code{--enable-libtensorflow}
 
 @item openvino
 @code{--enable-libtensorflow}
 
 @item openvino


@@ -11064,7 +11162,7 @@ will try to use a good random seed on a best effort basis.
 
 @item pal8
 Set pal8 output pixel format. This option does not work with codebook
 
 @item pal8
 Set pal8 output pixel format. This option does not work with codebook

-length greater than 256.
+length greater than 256. Default is disabled.

 @end table
 
 @section entropy
 @end table
 
 @section entropy


@@ -11311,6 +11409,25 @@ Six-point interpolation.
 @subsection Commands
 This filter supports same @ref{commands} as options.
 
 @subsection Commands
 This filter supports same @ref{commands} as options.
 

+@section exposure
+Adjust exposure of the video stream.
+
+The filter accepts the following options:
+
+@table @option
+@item exposure
+Set the exposure correction in EV. Allowed range is from -3.0 to 3.0 EV
+Default value is 0 EV.
+
+@item black
+Set the black level correction. Allowed range is from -1.0 to 1.0.
+Default value is 0.
+@end table
+
+@subsection Commands
+
+This filter supports same @ref{commands} as options.
+

 @section extractplanes
 
 Extract color channel components from input video stream into
 @section extractplanes
 
 Extract color channel components from input video stream into


@@ -12062,6 +12179,9 @@ Number of mipmaps, default is 3.
 
 @item xmin, ymin, xmax, ymax
 Specifies the rectangle in which to search.
 
 @item xmin, ymin, xmax, ymax
 Specifies the rectangle in which to search.

+
+@item discard
+Discard frames where object is not detected. Default is disabled.

 @end table
 
 @subsection Examples
 @end table
 
 @subsection Examples


@@ -13299,6 +13419,28 @@ By default value is 0.
 
 The @code{hysteresis} filter also supports the @ref{framesync} options.
 
 
 The @code{hysteresis} filter also supports the @ref{framesync} options.
 

+@section identity
+
+Obtain the identity score between two input videos.
+
+This filter takes two input videos.
+
+Both input videos must have the same resolution and pixel format for
+this filter to work correctly. Also it assumes that both inputs
+have the same number of frames, which are compared one by one.
+
+The obtained per component, average, min and max identity score is printed through
+the logging system.
+
+The filter stores the calculated identity scores of each frame in frame metadata.
+
+In the below example the input file @file{main.mpg} being processed is compared
+with the reference file @file{ref.mpg}.
+
+@example
+ffmpeg -i main.mpg -i ref.mpg -lavfi identity -f null -
+@end example
+

 @section idet
 
 Detect video interlacing type.
 @section idet
 
 Detect video interlacing type.


@@ -14403,6 +14545,10 @@ average, output frame will be completely filled with value set by @var{fill} opt
 Typically useful for scene changes when used in combination with @code{tblend} filter.
 @end table
 
 Typically useful for scene changes when used in combination with @code{tblend} filter.
 @end table
 

+@subsection Commands
+
+This filter supports the all above options as @ref{commands}.
+

 @section mcdeint
 
 Apply motion-compensation deinterlacing.
 @section mcdeint
 
 Apply motion-compensation deinterlacing.


@@ -14692,7 +14838,7 @@ Mix several video input streams into one video stream.
 A description of the accepted options follows.
 
 @table @option
 A description of the accepted options follows.
 
 @table @option

-@item nb_inputs
+@item inputs

 The number of inputs. If unspecified, it defaults to 2.
 
 @item weights
 The number of inputs. If unspecified, it defaults to 2.
 
 @item weights


@@ -14729,6 +14875,33 @@ This filter supports the following commands:
 Syntax is same as option with same name.
 @end table
 
 Syntax is same as option with same name.
 @end table
 

+@section monochrome
+Convert video to gray using custom color filter.
+
+A description of the accepted options follows.
+
+@table @option
+@item cb
+Set the chroma blue spot. Allowed range is from -1 to 1.
+Default value is 0.
+
+@item cr
+Set the chroma red spot. Allowed range is from -1 to 1.
+Default value is 0.
+
+@item size
+Set the color filter size. Allowed range is from .1 to 10.
+Default value is 1.
+
+@item high
+Set the highlights strength. Allowed range is from 0 to 1.
+Default value is 0.
+@end table
+
+@subsection Commands
+
+This filter supports the all above options as @ref{commands}.
+

 @section mpdecimate
 
 Drop frames that do not differ greatly from the previous frame in
 @section mpdecimate
 
 Drop frames that do not differ greatly from the previous frame in


@@ -14767,6 +14940,27 @@ Default value for @option{hi} is 64*12, default value for @option{lo} is
 64*5, and default value for @option{frac} is 0.33.
 @end table
 
 64*5, and default value for @option{frac} is 0.33.
 @end table
 

+@section msad
+
+Obtain the MSAD (Mean Sum of Absolute Differences) between two input videos.
+
+This filter takes two input videos.
+
+Both input videos must have the same resolution and pixel format for
+this filter to work correctly. Also it assumes that both inputs
+have the same number of frames, which are compared one by one.
+
+The obtained per component, average, min and max MSAD is printed through
+the logging system.
+
+The filter stores the calculated MSAD of each frame in frame metadata.
+
+In the below example the input file @file{main.mpg} being processed is compared
+with the reference file @file{ref.mpg}.
+
+@example
+ffmpeg -i main.mpg -i ref.mpg -lavfi msad -f null -
+@end example

 
 @section negate
 
 
 @section negate
 


@@ -16104,6 +16298,10 @@ Set window X position, relative offset on X axis.
 Set window Y position, relative offset on Y axis.
 @end table
 
 Set window Y position, relative offset on Y axis.
 @end table
 

+@subsection Commands
+
+This filter supports same @ref{commands} as options.
+

 @section pp
 
 Enable the specified chain of postprocessing subfilters using libpostproc. This
 @section pp
 
 Enable the specified chain of postprocessing subfilters using libpostproc. This


@@ -16362,10 +16560,10 @@ set pixel third component expression
 @item c3
 set pixel fourth component expression, corresponds to the alpha component
 
 @item c3
 set pixel fourth component expression, corresponds to the alpha component
 

-@item i
+@item index, i

 set component to use as base for altering colors
 
 set component to use as base for altering colors
 

-@item p
+@item preset, p

 Pick one of built-in LUTs. By default is set to none.
 
 Available LUTs:
 Pick one of built-in LUTs. By default is set to none.
 
 Available LUTs:


@@ -16378,12 +16576,17 @@ Available LUTs:
 @item cividis
 @item range1
 @item range2
 @item cividis
 @item range1
 @item range2

+@item shadows
+@item highlights

 @end table
 
 @end table
 

+@item opacity
+Set opacity of output colors. Allowed range is from 0 to 1.
+Default value is set to 1.

 @end table
 
 @end table
 

-Each of them specifies the expression to use for computing the lookup table for
-the corresponding pixel component values.
+Each of the expression options specifies the expression to use for computing
+the lookup table for the corresponding pixel component values.

 
 The expressions can contain the following constants and functions:
 
 
 The expressions can contain the following constants and functions:
 


@@ -18690,7 +18893,7 @@ Native implementation of DNN loading and execution.
 @item tensorflow
 TensorFlow backend. To enable this backend you
 need to install the TensorFlow for C library (see
 @item tensorflow
 TensorFlow backend. To enable this backend you
 need to install the TensorFlow for C library (see

-@url{https://www.tensorflow.org/install/install_c}) and configure FFmpeg with
+@url{https://www.tensorflow.org/install/lang_c}) and configure FFmpeg with

 @code{--enable-libtensorflow}
 @end table
 
 @code{--enable-libtensorflow}
 @end table
 


@@ -19164,6 +19367,10 @@ The timestamp expressed in seconds. It's NAN if the input timestamp is unknown.
 the position in the file of the input frame, NAN if unknown
 @end table
 
 the position in the file of the input frame, NAN if unknown
 @end table
 

+@subsection Commands
+
+This filter supports the all above options as @ref{commands}.
+

 @section swapuv
 Swap U & V plane.
 
 @section swapuv
 Swap U & V plane.
 


@@ -21139,6 +21346,27 @@ otherwise colors will be less saturated, more towards gray.
 
 This filter supports the all above options as @ref{commands}.
 
 
 This filter supports the all above options as @ref{commands}.
 

+@section vif
+
+Obtain the average VIF (Visual Information Fidelity) between two input videos.
+
+This filter takes two input videos.
+
+Both input videos must have the same resolution and pixel format for
+this filter to work correctly. Also it assumes that both inputs
+have the same number of frames, which are compared one by one.
+
+The obtained average VIF score is printed through the logging system.
+
+The filter stores the calculated VIF score of each frame.
+
+In the below example the input file @file{main.mpg} being processed is compared
+with the reference file @file{ref.mpg}.
+
+@example
+ffmpeg -i main.mpg -i ref.mpg -lavfi vif -f null -
+@end example
+

 @anchor{vignette}
 @section vignette
 
 @anchor{vignette}
 @section vignette
 


@@ -21575,6 +21803,9 @@ Default is @code{3}.
 Apply cross fade from one input video stream to another input video stream.
 The cross fade is applied for specified duration.
 
 Apply cross fade from one input video stream to another input video stream.
 The cross fade is applied for specified duration.
 

+Both inputs must be constant frame-rate and have the same resolution, pixel format,
+frame rate and timebase.
+

 The filter accepts the following options:
 
 @table @option
 The filter accepts the following options:
 
 @table @option


@@ -21979,7 +22210,7 @@ Set the x and y expression. Default is 0.
 @item d
 Set the duration expression in number of frames.
 This sets for how many number of frames effect will last for
 @item d
 Set the duration expression in number of frames.
 This sets for how many number of frames effect will last for

-single input image.
+single input image. Default is 90.

 
 @item s
 Set the output image size, default is 'hd720'.
 
 @item s
 Set the output image size, default is 'hd720'.


@@ -22297,6 +22528,13 @@ Possible values are:
 
 @item npl
 Set the nominal peak luminance.
 
 @item npl
 Set the nominal peak luminance.

+
+@item param_a
+Parameter A for scaling filters. Parameter "b" for bicubic, and the number of
+filter taps for lanczos.
+
+@item param_b
+Parameter B for scaling filters. Parameter "c" for bicubic.

 @end table
 
 The values of the @option{w} and @option{h} options are expressions
 @end table
 
 The values of the @option{w} and @option{h} options are expressions