summaryrefslogtreecommitdiff
path: root/doc/bitstream_filters.texi
diff options
context:
space:
mode:
authorGyan Doshi <ffmpeg@gyani.pro>2021-07-30 17:08:53 +0530
committerGyan Doshi <ffmpeg@gyani.pro>2021-07-30 17:14:43 +0530
commitb9176dbfb7c209f2adf1f420df74b91df56c1fb3 (patch)
treefa7812e1c59e3373c48e49a76922fdfee0fad522 /doc/bitstream_filters.texi
parentae94868a576c901f313c619950ec7d8a5f6ca615 (diff)
avcodec/noise_bsf: restore dropamount for backwards compatibility
Diffstat (limited to 'doc/bitstream_filters.texi')
-rw-r--r--doc/bitstream_filters.texi7
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/bitstream_filters.texi b/doc/bitstream_filters.texi
index 18a758635f..1900eb4352 100644
--- a/doc/bitstream_filters.texi
+++ b/doc/bitstream_filters.texi
@@ -538,11 +538,16 @@ Accepts an expression whose evaluation per-packet determines how often bytes in
packet will be modified. A value below 0 will result in a variable frequency.
Default is 0 which results in no modification. However, if neither amount nor drop is specified,
amount will be set to @var{-1}. See below for accepted variables.
-@item drop, dropamount
+@item drop
Accepts an expression evaluated per-packet whose value determines whether that packet is dropped.
Evaluation to a positive value results in the packet being dropped. Evaluation to a negative
value results in a variable chance of it being dropped, roughly inverse in proportion to the magnitude
of the value. Default is 0 which results in no drops. See below for accepted variables.
+@item dropamount
+Accepts a non-negative integer, which assigns a variable chance of it being dropped, roughly inverse
+in proportion to the value. Default is 0 which results in no drops. This option is kept for backwards
+compatibility and is equivalent to setting drop to a negative value with the same magnitude
+i.e. @code{dropamount=4} is the same as @code{drop=-4}. Ignored if drop is also specified.
@end table
Both @code{amount} and @code{drop} accept expressions containing the following variables: