Subtitle - Revision history

Reel.Deal: add link to avs+ documentation

2022-09-16T18:27:35Z

add link to avs+ documentation

← Older revision		Revision as of 20:27, 16 September 2022
Line 1:		Line 1:
	<div style="max-width:62em" >		<div style="max-width:62em" >

			<div {{BlueBox2\|40\|0\|3px solid purple}} >
			{{AvsPlusFullname}}<br>
			Up-to-date documentation: [https://avisynthplus.readthedocs.io/en/latest/avisynthdoc/corefilters/subtitle.html https://avisynthplus.readthedocs.io]
			</div>

	The '''Subtitle''' filter adds anti-aliased text to a range of frames. All parameters after {{FuncArg\|text}} are optional and can be omitted or specified out of order using the ''name=value'' syntax.		The '''Subtitle''' filter adds anti-aliased text to a range of frames. All parameters after {{FuncArg\|text}} are optional and can be omitted or specified out of order using the ''name=value'' syntax.

Pinterf: /* Changes */ Update version history

2019-02-20T08:17:27Z

Changes: Update version history

← Older revision		Revision as of 10:17, 20 February 2019
Line 187:		Line 187:
	<div style="max-width:62em" >		<div style="max-width:62em" >
	{\| border="1"		{\| border="1"
			\|-
			\| v2487
			\| font_filename and utf8 parameter.{{AvsPluscon}}
	\|-		\|-
	\| v2.60		\| v2.60
Line 207:		Line 210:
	\|}		\|}
	</div>		</div>


	==See also==		==See also==

Pinterf: /* Syntax and Parameters */ Avs+ font_filename and utf8 parameter

2019-02-20T07:50:49Z

Syntax and Parameters: Avs+ font_filename and utf8 parameter

← Older revision		Revision as of 09:50, 20 February 2019
Line 11:		Line 11:
	string ''font'', float ''size'', int ''text_color'', int ''halo_color'', int ''align'', int ''spc'', int ''lsp'', <br>		string ''font'', float ''size'', int ''text_color'', int ''halo_color'', int ''align'', int ''spc'', int ''lsp'', <br>
	float ''font_width'', float ''font_angle'', bool ''interlaced'')\|Subtitle(clip ''clip'', string ''text'')		float ''font_width'', float ''font_angle'', bool ''interlaced'')\|Subtitle(clip ''clip'', string ''text'')
			}}

			{{AvsPluscon}}<br>
			{{Template:FuncDef\|Subtitle(clip ''clip'', string ''text'', float ''x'', float ''y'', int ''first_frame'', int ''last_frame'', <br>
			string ''font'', float ''size'', int ''text_color'', int ''halo_color'', int ''align'', int ''spc'', int ''lsp'', <br>
			float ''font_width'', float ''font_angle'', bool ''interlaced'', string ''font_filename'', bool ''utf8'')
	}}		}}

Line 78:		Line 84:
	:{{Par2\|interlaced\|bool\|false}}		:{{Par2\|interlaced\|bool\|false}}
	::When enabled, reduces flicker from sharp fine vertical transitions on interlaced displays. It applies a mild vertical blur by increasing the anti-aliasing window to include 0.5 of the pixel weight from the lines above and below. Default=false.		::When enabled, reduces flicker from sharp fine vertical transitions on interlaced displays. It applies a mild vertical blur by increasing the anti-aliasing window to include 0.5 of the pixel weight from the lines above and below. Default=false.

			:{{Par2\|font_filename\|string\|}}
			::{{AvsPluscon}} allows using non-installed font, by giving the font file name. Once it is loaded, other Subtitle instances can use it.

			:{{Par2\|utf8\|bool\|false}}
			::{{AvsPluscon}} allows drawing text encoded in UTF8. Can be a bit tricky, since Avisynth does not support utf8 scripts. But when a unicode script containing non-ansi characters is saved as UTF8 without BOM, the text itself can be passed as-is and providing the utf8=true setting.

	</div>		</div>

Pinterf: /* Examples */ utf8

2019-02-20T07:44:11Z

Examples: utf8

← Older revision		Revision as of 09:44, 20 February 2019
Line 81:		Line 81:

	==Examples==		==Examples==
	<div style="max-width:~~62em~~" >		<div style="max-width:68em" >
	=====Center text=====		=====Center text=====
	AviSource("D:\clip.avi")		AviSource("D:\clip.avi")
Line 164:		Line 164:
	\ align=2, size=32, text_color=$c0c0c0)		\ align=2, size=32, text_color=$c0c0c0)
	}		}

			=====UTF8 text indirectly =====
			{{AvsPluscon}}
			Title="Cherry blossom "+CHR($E6)+CHR($A1)+CHR($9C)+CHR($E3)+CHR($81)+CHR($AE)+CHR($E8)+CHR($8A)+CHR($B1)
			SubTitle(Title,utf8=true)
	</div>		</div>


	==Changes==		==Changes==

Raffriff42: formatting

2016-02-28T10:38:54Z

formatting

← Older revision		Revision as of 12:38, 28 February 2016
Line 1:		Line 1:
	The Subtitle filter adds anti-aliased text to a range of frames. All parameters after ''text'' are optional and can be omitted or specified out of order using the ''name=value'' syntax.		<div style="max-width:62em" >
			The '''Subtitle''' filter adds anti-aliased text to a range of frames. All parameters after {{FuncArg\|text}} are optional and can be omitted or specified out of order using the ''name=value'' syntax.

	The short form (with all default parameters) is useful when you don't really care what the subtitle looks like as long as you can see it--for example, when you're using [[StackVertical]] and its ilk to display several versions of a frame at once, and you want to label them to remember which is which.		The short form (with all default parameters) is useful when you don't really care what the subtitle looks like as long as you can see it—for example, when you're using [[StackVertical]] and its ilk to display several versions of a frame at once, and you want to label them to remember which is which.
			</div>

	__TOC__		__TOC__
	==Syntax and Parameters==		==Syntax and Parameters==
			<div style="max-width:62em" >
	{{Template:FuncDef\|Subtitle(clip ''clip'', string ''text'', float ''x'', float ''y'', int ''first_frame'', int ''last_frame'', string ''font'', float ''size'', int ''text_color'', int ''halo_color'', int ''align'', int ''spc'', int ''lsp'', float ''font_width'', float ''font_angle'', bool ''interlaced'')\|Subtitle(clip ''clip'', string ''text'')}}		{{Template:FuncDef\|Subtitle(clip ''clip'', string ''text'', float ''x'', float ''y'', int ''first_frame'', int ''last_frame'', <br>
			string ''font'', float ''size'', int ''text_color'', int ''halo_color'', int ''align'', int ''spc'', int ''lsp'', <br>
			float ''font_width'', float ''font_angle'', bool ''interlaced'')\|Subtitle(clip ''clip'', string ''text'')
			}}

	:{{Par2\|text\|string\|}}		:{{Par2\|text\|string\|}}
Line 35:		Line 40:
	::Colors for font fill and outline respectively. Default yellow, black.		::Colors for font fill and outline respectively. Default yellow, black.

	{{~~NotaBene3~~\|These may be any of the [[Preset colors]], or specified as hexadecimal $aarrggbb values, similar to HTML--except that they start with $ instead of # and the 4th octet specifies the alpha transparency. $00rrggbb is completely opaque, $FF000000 is fully transparent. You can disable the halo by selecting this color. See [[Colors]] for more information on specifying colors.}}		<div {{NotaBeneWidthIndent\|54\|4\|4px solid blue}} >
			These may be any of the [[Preset colors]], or specified as hexadecimal $aarrggbb values, similar to HTML--except that they start with $ instead of # and the 4th octet specifies the alpha transparency. $00rrggbb is completely opaque, $FF000000 is fully transparent. You can disable the halo by selecting this color. See [[Colors]] for more information on specifying colors.
			</div>

	:{{Par2\|align\|int\|7}}		:{{Par2\|align\|int\|7}}
Line 71:		Line 78:
	:{{Par2\|interlaced\|bool\|false}}		:{{Par2\|interlaced\|bool\|false}}
	::When enabled, reduces flicker from sharp fine vertical transitions on interlaced displays. It applies a mild vertical blur by increasing the anti-aliasing window to include 0.5 of the pixel weight from the lines above and below. Default=false.		::When enabled, reduces flicker from sharp fine vertical transitions on interlaced displays. It applies a mild vertical blur by increasing the anti-aliasing window to include 0.5 of the pixel weight from the lines above and below. Default=false.
			</div>

	==Examples==		==Examples==
			<div style="max-width:62em" >
	=====Center text=====		=====Center text=====
	AviSource("D:\clip.avi")		AviSource("D:\clip.avi")
Line 156:		Line 164:
	\ align=2, size=32, text_color=$c0c0c0)		\ align=2, size=32, text_color=$c0c0c0)
	}		}
			</div>


	==Changes==		==Changes==
			<div style="max-width:62em" >
	{\| border="1"		{\| border="1"
	\|-		\|-
Line 180:		Line 189:
	\| Setting x=-1 uses horizontal center and center alignment (undocumented prior to v2.07).		\| Setting x=-1 uses horizontal center and center alignment (undocumented prior to v2.07).
	\|}		\|}
			</div>


	==See also==		==See also==
			<div style="max-width:62em" >
	There are [[External_filters#Subtitling\|external subtitling filters]] that display SRT, SSA, and other format subtitle files or offer more elaborate formatting.		There are [[External_filters#Subtitling\|external subtitling filters]] that display SRT, SSA, and other format subtitle files or offer more elaborate formatting.
			</div>

Raffriff42: use template Par2

2015-12-26T17:47:39Z

use template Par2

← Older revision		Revision as of 19:47, 26 December 2015
Line 1:		Line 1:
	{{Template:FuncDef\|Subtitle(clip ''clip'', string ''text'', float ''x'', float ''y'', int ''first_frame'', int ''last_frame'', string ''font'', float ''size'', int ''text_color'', int ''halo_color'', int ''align'', int ''spc'', int ''lsp'', float ''font_width'', float ''font_angle'', bool ''interlaced'')\|Subtitle(clip ''clip'', string ''text'')}}

	The Subtitle filter adds anti-aliased text to a range of frames. All parameters after ''text'' are optional and can be omitted or specified out of order using the ''name=value'' syntax.		The Subtitle filter adds anti-aliased text to a range of frames. All parameters after ''text'' are optional and can be omitted or specified out of order using the ''name=value'' syntax.

	The short form (with all default parameters) is useful when you don't really care what the subtitle looks like as long as you can see it--for example, when you're using [[StackVertical]] and its ilk to display several versions of a frame at once, and you want to label them to remember which is which.		The short form (with all default parameters) is useful when you don't really care what the subtitle looks like as long as you can see it--for example, when you're using [[StackVertical]] and its ilk to display several versions of a frame at once, and you want to label them to remember which is which.

	===Parameters===		__TOC__
			==Syntax and Parameters==

			{{Template:FuncDef\|Subtitle(clip ''clip'', string ''text'', float ''x'', float ''y'', int ''first_frame'', int ''last_frame'', string ''font'', float ''size'', int ''text_color'', int ''halo_color'', int ''align'', int ''spc'', int ''lsp'', float ''font_width'', float ''font_angle'', bool ''interlaced'')\|Subtitle(clip ''clip'', string ''text'')}}

	:;text		:{{Par2\|text\|string\|}}
	:: The text to be displayed.		:: The text to be displayed.

	:;x, y		:{{Par2\|x\|float\|(auto)}}
			:{{Par2\|y\|float\|(auto)}}
	:: Text position. Can be set to -1 to automatically center the text horizontally or vertically, respectively. Negative values of ''x'' and ''y'' not equal to -1 can be used to move subtitles partially off the screen.		:: Text position. Can be set to -1 to automatically center the text horizontally or vertically, respectively. Negative values of ''x'' and ''y'' not equal to -1 can be used to move subtitles partially off the screen.

Line 17:		Line 19:
	::: y = ''size'' if align=4,5,6 or none; 0 if align=7,8,9; or height-1 if align=1,2,3		::: y = ''size'' if align=4,5,6 or none; 0 if align=7,8,9; or height-1 if align=1,2,3

	::'''Caution:''' If your script uses Subtitle with [[Animate]] and negative ''x'' or ''y'' values, ''x'' or ''y'' might momentarily become -1, causing a glitch in the video~~. Starting from v2.60 they can be float~~.		::'''Caution:''' Using v2.58 or older, if your script uses Subtitle with [[Animate]] and negative ''x'' or ''y'' values, ''x'' or ''y'' might momentarily become -1, causing a glitch in the video.

	:;first_frame, last_frame		:{{Par2\|first_frame\|int\|0}}
			:{{Par2\|last_frame\|int\|(clip.Framecount-1)}}
	::The text will be shown starting from frame ''first_frame'' and ending with frame ''last_frame''.		::The text will be shown starting from frame ''first_frame'' and ending with frame ''last_frame''.

	:~~:Default values: first_frame=0, last_frame=Framecount(''clip'')-1~~		:{{Par2\|font\|string\|"Arial"}}
			::Font name; can be the name of any installed Windows font.
	:;font
	::Font name; ~~default "Arial".~~

	~~::All~~ installed ~~fonts on the current machine are available; they are located in your 'windows\fonts' folder~~.

	:;size		:{{Par2\|size\|float\|18.0}}
	::Height of the text in pixels, and is rounded to the nearest 0.125 pixel. Default 18.		::Height of the text in pixels, and is rounded to the nearest 0.125 pixel. Default 18.

	:;text_color, halo_color		:{{Par2\|text_color\|int\|[[Preset colors\|color_yellow]]}}
			:{{Par2\|halo_color\|int\|[[Preset colors\|color_black]]}}
	::Colors for font fill and outline respectively. Default yellow, black.		::Colors for font fill and outline respectively. Default yellow, black.

	~~:::~~These may be any of the [[Preset colors]], or specified as hexadecimal $aarrggbb values, similar to HTML--except that they start with $ instead of # and the 4th octet specifies the alpha transparency. $00rrggbb is completely opaque, $FF000000 is fully transparent. You can disable the halo by selecting this color. See [[Colors]] for more information on specifying colors.		{{NotaBene3\|These may be any of the [[Preset colors]], or specified as hexadecimal $aarrggbb values, similar to HTML--except that they start with $ instead of # and the 4th octet specifies the alpha transparency. $00rrggbb is completely opaque, $FF000000 is fully transparent. You can disable the halo by selecting this color. See [[Colors]] for more information on specifying colors.}}

	:;align		:{{Par2\|align\|int\|7}}
	::Set where the text is placed, based on the numeric keypad layout, as follows:		::Set where the text is placed, based on the numeric keypad layout, as follows:
	<div style="margin:1em 1em 1em 8em;"><div>		<div style="margin:1em 1em 1em 8em;"><div>
Line 47:		Line 47:
	::Default 7, or top-left. If ''x'' and/or ''y'' are given, text is positioned relative to the (x,y) location. Note there is no Y-center alignment setting.		::Default 7, or top-left. If ''x'' and/or ''y'' are given, text is positioned relative to the (x,y) location. Note there is no Y-center alignment setting.

	:;spc		:{{Par2\|spc\|int\|0}}
	::Modify the inter-character spacing. If ''spc'' is less than zero, inter-character spacing is decreased; if greater, the spacing is increased. Default is 0: use Windows' default spacing.		::Modify the inter-character spacing. If ''spc'' is less than zero, inter-character spacing is decreased; if greater, the spacing is increased. Default is 0: use Windows' default spacing.

	::This is helpful for trying to match typical fonts on the PC to fonts used in film and television credits which are usually wider for the same height or to just fit or fill in a space with a fixed per-character adjustment. See example below.		::This is helpful for trying to match typical fonts on the PC to fonts used in film and television credits which are usually wider for the same height or to just fit or fill in a space with a fixed per-character adjustment. See example below.

	:::For more information, see the Microsoft documentation of the function [http://msdn.microsoft.com/en-us/library/windows/desktop/dd145092%28v=vs.85%29.aspx SetTextCharacterExtra()].		::For more information, see the Microsoft documentation of the function [http://msdn.microsoft.com/en-us/library/windows/desktop/dd145092%28v=vs.85%29.aspx SetTextCharacterExtra()].

	:;lsp		:{{Par2\|lsp\|int\|}}
	::~~Line Spacing Parameter~~; enables '''multi-line text''' (where "\n" enters a line break). If ''lsp'' is less than zero, inter-line spacing is decreased; if greater, the spacing is increased, relative to Windows' default spacing. By default, multi-line text disabled.		::'''L'''ine '''S'''pacing '''P'''arameter; enables ''multi-line text'' (where "\n" enters a line break). If ''lsp'' is less than zero, inter-line spacing is decreased; if greater, the spacing is increased, relative to Windows' default spacing. By default, multi-line text disabled.

	::In the unlikely event that you want to output the characters "\n" literally in a multi-line text, you can do this by using "\\n".		::In the unlikely event that you want to output the characters "\n" literally in a multi-line text, you can do this by using "\\n".

	:;font_width		:{{Par2\|font_width\|float\|0.0}}
	::Set character width in logical units, to the nearest 0.125 unit. Default=0, use Windows' default width. See example below.		::Set character width in logical units, to the nearest 0.125 unit. Default=0, use Windows' default width. See example below.

Line 66:		Line 66:
	:::For more information, see the Microsoft documentation of the function [http://msdn.microsoft.com/en-us/library/windows/desktop/dd183499%28v=vs.85%29.aspx CreateFont()].		:::For more information, see the Microsoft documentation of the function [http://msdn.microsoft.com/en-us/library/windows/desktop/dd183499%28v=vs.85%29.aspx CreateFont()].

	:;font_angle		:{{Par2\|font_angle\|float\|0.0}}
	::Adjust the baseline angle of text in degrees anti-clockwise to the nearest 0.1 degree. Default 0, no rotation.		::Adjust the baseline angle of text in degrees anti-clockwise to the nearest 0.1 degree. Default 0, no rotation.

	:;interlaced		:{{Par2\|interlaced\|bool\|false}}
	::When enabled, reduces flicker from sharp fine vertical transitions on interlaced displays. It applies a mild vertical blur by increasing the anti-aliasing window to include 0.5 of the pixel weight from the lines above and below. Default=false.		::When enabled, reduces flicker from sharp fine vertical transitions on interlaced displays. It applies a mild vertical blur by increasing the anti-aliasing window to include 0.5 of the pixel weight from the lines above and below. Default=false.

	===Examples===		==Examples==

	=====Center text=====		=====Center text=====
Line 158:		Line 158:


	===Changes===		==Changes==

	{\| border="1"		{\| border="1"
Line 182:		Line 182:


	===See also===		==See also==

	There are [[External_filters#Subtitling\|external subtitling filters]] that display SRT, SSA, and other format subtitle files or offer more elaborate formatting.		There are [[External_filters#Subtitling\|external subtitling filters]] that display SRT, SSA, and other format subtitle files or offer more elaborate formatting.

Raffriff42: added category

2015-11-08T19:15:43Z

added category

← Older revision		Revision as of 21:15, 8 November 2015
Line 190:		Line 190:
	[[Category:Internal filters]]		[[Category:Internal filters]]
	[[Category:Debugging/Diagnostic filters]]		[[Category:Debugging/Diagnostic filters]]
			[[Category:Subtitling]]

Raffriff42: add example & image

2015-09-21T13:53:20Z

add example & image

← Older revision		Revision as of 15:53, 21 September 2015
Line 50:		Line 50:
	::Modify the inter-character spacing. If ''spc'' is less than zero, inter-character spacing is decreased; if greater, the spacing is increased. Default is 0: use Windows' default spacing.		::Modify the inter-character spacing. If ''spc'' is less than zero, inter-character spacing is decreased; if greater, the spacing is increased. Default is 0: use Windows' default spacing.

	::This is helpful for trying to match typical fonts on the PC to fonts used in film and television credits which are usually wider for the same height or to just fit or fill in a space with a fixed per-character adjustment.		::This is helpful for trying to match typical fonts on the PC to fonts used in film and television credits which are usually wider for the same height or to just fit or fill in a space with a fixed per-character adjustment. See example below.

	:::For more information, see the Microsoft documentation of the function [http://msdn.microsoft.com/en-us/library/windows/desktop/dd145092%28v=vs.85%29.aspx SetTextCharacterExtra()].		:::For more information, see the Microsoft documentation of the function [http://msdn.microsoft.com/en-us/library/windows/desktop/dd145092%28v=vs.85%29.aspx SetTextCharacterExtra()].
Line 60:		Line 60:

	:;font_width		:;font_width
	::Set character width in logical units, to the nearest 0.125 unit. Default=0, use Windows' default width.		::Set character width in logical units, to the nearest 0.125 unit. Default=0, use Windows' default width. See example below.

	::Character width varies, depending on the font face and size, but "Arial" at size=16 is about 7 units wide; if ''font_width'' is less than that, (but greater than zero), the text is squeezed, and if it is greater, the text is stretched. Negative numbers are converted to their absolute values.		::Character width varies, depending on the font face and size, but "Arial" at size=16 is about 7 units wide; if ''font_width'' is less than that, (but greater than zero), the text is squeezed, and if it is greater, the text is stretched. Negative numbers are converted to their absolute values.
Line 96:		Line 96:
	AviSource("D:\clip.avi")		AviSource("D:\clip.avi")
	Subtitle("Width=" + String(Width()))		Subtitle("Width=" + String(Width()))

			=====Using ''spc'' and ''font_width'' arguments=====
			ColorBars.KillAudio
			Subtitle("ROYGBIV", x=-1, y=100, spc=-10, font_width=6)
			Subtitle("ROYGBIV", x=-1, y=150, spc=0, font_width=0) ## width=default
			Subtitle("ROYGBIV", x=-1, y=200, spc=10, font_width=10)
			Subtitle("ROYGBIV", x=-1, y=250, spc=20, font_width=20)
			<div style="margin:1em 1em 1em 8em;"><div>
			[[File:Subtitle_width.jpg\|360px]]
			</div></div>

	=====Animated parameter demonstration=====		=====Animated parameter demonstration=====

Raffriff42: align: replace table with image & add new image

2015-09-20T04:01:12Z

align: replace table with image & add new image

@@ Line 39: / Line 39: @@
 :;align
 ::Set where the text is placed, based on the numeric keypad layout, as follows:
-<div style="margin-left:8em"><div>
+<div style="margin:1em 1em 1em 8em;"><div>
-{| border="0" cellpadding="4" style="border:none; text-align:center;vertical-align:middle;"
+[[File:Subtitle-align-chart.png|border]]
-|style="width:5em;" | Left
+[[File:Subtitle-align-demo.png]]
-|style="width:5em;" | Center
+</div> </div>
 ::Default 7, or top-left. If ''x'' and/or ''y'' are given, text is positioned relative to the (x,y) location. Note there is no Y-center alignment setting.

Raffriff42: added category:Debugging/Diagnostic_filters

2015-06-03T22:34:37Z

added category:Debugging/Diagnostic_filters

← Older revision		Revision as of 00:34, 4 June 2015
Line 206:		Line 206:

	[[Category:Internal filters]]		[[Category:Internal filters]]
			[[Category:Debugging/Diagnostic filters]]