Commit ef16d126 authored by Mark Harris's avatar Mark Harris Committed by Stefano Sabatini

doc/filters.texi: fix time duration references

Make time duration references consistent, using @ref links, and
eliminate incorrect syntax [-]HH[:MM[:SS[.m...]]].
Signed-off-by: 's avatarStefano Sabatini <stefasab@gmail.com>
parent 6f0fc1a9
...@@ -517,27 +517,21 @@ volume as the input audio, at the end of the fade-out transition ...@@ -517,27 +517,21 @@ volume as the input audio, at the end of the fade-out transition
the output audio will be silence. Default is 44100. the output audio will be silence. Default is 44100.
@item start_time, st @item start_time, st
Specify time for starting to apply the fade effect. Default is 0. Specify the start time of the fade effect. Default is 0.
The accepted syntax is: The value must be specified as a time duration; see
@example @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}
[-]HH[:MM[:SS[.m...]]] for the accepted syntax.
[-]S+[.m...] If set this option is used instead of @var{start_sample}.
@end example
See also the function @code{av_parse_time()}.
If set this option is used instead of @var{start_sample} one.
@item duration, d @item duration, d
Specify the duration for which the fade effect has to last. Default is 0. Specify the duration of the fade effect. See
The accepted syntax is: @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}
@example for the accepted syntax.
[-]HH[:MM[:SS[.m...]]]
[-]S+[.m...]
@end example
See also the function @code{av_parse_time()}.
At the end of the fade-in effect the output audio will have the same At the end of the fade-in effect the output audio will have the same
volume as the input audio, at the end of the fade-out transition volume as the input audio, at the end of the fade-out transition
the output audio will be silence. the output audio will be silence.
If set this option is used instead of @var{nb_samples} one. By default the duration is determined by @var{nb_samples}.
If set this option is used instead of @var{nb_samples}.
@item curve @item curve
Set curve for fade transition. Set curve for fade transition.
...@@ -1120,9 +1114,9 @@ The number of the first sample that should be output. ...@@ -1120,9 +1114,9 @@ The number of the first sample that should be output.
The number of the first sample that should be dropped. The number of the first sample that should be dropped.
@end table @end table
@option{start}, @option{end}, @option{duration} are expressed as time @option{start}, @option{end}, and @option{duration} are expressed as time
duration specifications, check the "Time duration" section in the duration specifications; see
ffmpeg-utils manual. @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}.
Note that the first two sets of the start/end options and the @option{duration} Note that the first two sets of the start/end options and the @option{duration}
option look at the frame timestamp, while the _sample options simply count the option look at the frame timestamp, while the _sample options simply count the
...@@ -1637,9 +1631,9 @@ Set the number of samples per channel per each output frame, default ...@@ -1637,9 +1631,9 @@ Set the number of samples per channel per each output frame, default
is 1024. Only used if plugin have zero inputs. is 1024. Only used if plugin have zero inputs.
@item duration, d @item duration, d
Set the minimum duration of the sourced audio. See the function Set the minimum duration of the sourced audio. See
@code{av_parse_time()} for the accepted format, also check the "Time duration" @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}
section in the ffmpeg-utils manual. for the accepted syntax.
Note that the resulting duration may be greater than the specified duration, Note that the resulting duration may be greater than the specified duration,
as the generated audio is always cut at the end of a complete frame. as the generated audio is always cut at the end of a complete frame.
If not specified, or the expressed duration is negative, the audio is If not specified, or the expressed duration is negative, the audio is
...@@ -2189,8 +2183,9 @@ Set the channel layout. The number of channels in the specified layout ...@@ -2189,8 +2183,9 @@ Set the channel layout. The number of channels in the specified layout
must be equal to the number of specified expressions. must be equal to the number of specified expressions.
@item duration, d @item duration, d
Set the minimum duration of the sourced audio. See the function Set the minimum duration of the sourced audio. See
@code{av_parse_time()} for the accepted format. @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}
for the accepted syntax.
Note that the resulting duration may be greater than the specified Note that the resulting duration may be greater than the specified
duration, as the generated audio is always cut at the end of a duration, as the generated audio is always cut at the end of a
complete frame. complete frame.
...@@ -8546,9 +8541,10 @@ The number of the first frame that should be passed to the output. ...@@ -8546,9 +8541,10 @@ The number of the first frame that should be passed to the output.
The number of the first frame that should be dropped. The number of the first frame that should be dropped.
@end table @end table
@option{start}, @option{end}, @option{duration} are expressed as time @option{start}, @option{end}, and @option{duration} are expressed as time
duration specifications, check the "Time duration" section in the duration specifications; see
ffmpeg-utils manual. @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}
for the accepted syntax.
Note that the first two sets of the start/end options and the @option{duration} Note that the first two sets of the start/end options and the @option{duration}
option look at the frame timestamp, while the _frame variants simply count the option look at the frame timestamp, while the _frame variants simply count the
...@@ -9459,12 +9455,9 @@ number or a valid video frame rate abbreviation. The default value is ...@@ -9459,12 +9455,9 @@ number or a valid video frame rate abbreviation. The default value is
"25". "25".
@item duration, d @item duration, d
Set the video duration of the sourced video. The accepted syntax is: Set the duration of the sourced video. See
@example @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}
[-]HH:MM:SS[.m...] for the accepted syntax.
[-]S+[.m...]
@end example
See also the function @code{av_parse_time()}.
If not specified, or the expressed duration is negative, the video is If not specified, or the expressed duration is negative, the video is
supposed to be generated forever. supposed to be generated forever.
...@@ -9726,12 +9719,9 @@ number or a valid video frame rate abbreviation. The default value is ...@@ -9726,12 +9719,9 @@ number or a valid video frame rate abbreviation. The default value is
Set the sample aspect ratio of the sourced video. Set the sample aspect ratio of the sourced video.
@item duration, d @item duration, d
Set the video duration of the sourced video. The accepted syntax is: Set the duration of the sourced video. See
@example @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}
[-]HH[:MM[:SS[.m...]]] for the accepted syntax.
[-]S+[.m...]
@end example
Also see the the @code{av_parse_time()} function.
If not specified, or the expressed duration is negative, the video is If not specified, or the expressed duration is negative, the video is
supposed to be generated forever. supposed to be generated forever.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment