History

documentation: add setdar and setsar description to filters.texi

Stefano Sabatini committed 15 years ago

Commit 2ccbb341 parent 2f86e7b1 file · +56 −0Browse files

Unified · Split

doc/filters.texi+56−0
@@ -1001,6 +1001,36 @@ ratio of the input image. · 1000 unmodified lines
10011001
10021002 The default value of @var{width} and @var{height} is 0.
10031003
1004+@anchor{setdar}
1005+@section setdar
1006+
1007+Set the Display Aspect Ratio for the filter output video.
1008+
1009+This is done by changing the specified Sample (aka Pixel) Aspect
1010+Ratio, according to the following equation:
1011+@math{DAR = HORIZONTAL_RESOLUTION / VERTICAL_RESOLUTION * SAR}
1012+
1013+Keep in mind that this filter does not modify the pixel dimensions of
1014+the video frame. Also the display aspect ratio set by this filter may
1015+be changed by later filters in the filterchain, e.g. in case of
1016+scaling or if another "setdar" or a "setsar" filter is applied.
1017+
1018+The filter accepts a parameter string which represents the wanted
1019+display aspect ratio.
1020+The parameter can be a floating point number string, or an expression
1021+of the form @var{num}:@var{den}, where @var{num} and @var{den} are the
1022+numerator and denominator of the aspect ratio.
1023+If the parameter is not specified, it is assumed the value "0:1".
1024+
1025+For example to change the display aspect ratio to 16:9, specify:
1026+@example
1027+setdar=16:9
1028+# the above is equivalent to
1029+setdar=1.77777
1030+@end example
1031+
1032+See also the "setsar" filter documentation (@pxref{setsar}).
1033+
10041034 @section setpts
10051035
10061036 Change the PTS (presentation timestamp) of the input video frames.
@@ -1061,6 +1091,32 @@ setpts=N/(25*TB) · 54 unmodified lines
10611091 setpts='1/(25*TB) * (N + 0.05 * sin(N*2*PI/25))'
10621092 @end example
10631093
1094+@anchor{setsar}
1095+@section setsar
1096+
1097+Set the Sample (aka Pixel) Aspect Ratio for the filter output video.
1098+
1099+Note that as a consequence of the application of this filter, the
1100+output display aspect ratio will change according to the following
1101+equation:
1102+@math{DAR = HORIZONTAL_RESOLUTION / VERTICAL_RESOLUTION * SAR}
1103+
1104+Keep in mind that the sample aspect ratio set by this filter may be
1105+changed by later filters in the filterchain, e.g. if another "setsar"
1106+or a "setdar" filter is applied.
1107+
1108+The filter accepts a parameter string which represents the wanted
1109+sample aspect ratio.
1110+The parameter can be a floating point number string, or an expression
1111+of the form @var{num}:@var{den}, where @var{num} and @var{den} are the
1112+numerator and denominator of the aspect ratio.
1113+If the parameter is not specified, it is assumed the value "0:1".
1114+
1115+For example to change the sample aspect ratio to 10:11, specify:
1116+@example
1117+setsar=10:11
1118+@end example
1119+
10641120 @section settb
10651121
10661122 Set the timebase to use for the output frames timestamps.

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t