SubtitleEx

From Avisynth wiki
(Difference between revisions)
Jump to: navigation, search
(redirect for convenient searching)
 
(SubtitleEx - docs copied from archived homepage)
Line 1: Line 1:
−
#REDIRECT [[External_filters#Subtitling]]
+
{{FilterCat4|External_filters|Plugins|Adjustment_filters|Subtitling}}
−
{{FilterCat|External_filters|Adjustment_filters|Subtitling}}
+
{{Filter3
 +
| [http://web.archive.org/web/20070821222318/http://mvideo.ddpp.net/eng/index.htm basilik]
 +
| v0.1.1
 +
| [http://www.avisynth.nl/users/warpenterprises/files/subtitleex_5F25_dll_20040819.zip subtitleex_5F25_dll_20040819.zip]
 +
| Subtitling
 +
| Open source (source code N/A)
 +
|6=}}
 +
<br>
 +
== Description ==
 +
The SubtitleEx is an AviSynth plugin to show a text over any video clip with one function inside: SubtitleEx. It is an extension of an existing Subtitle function of the AviSynth. Many of the parameters of the SubtitleEx have the same meaning as a original [[Subtitle]] function. See [http://web.archive.org/web/20071025023938/http://mvideo.ddpp.net/eng/subtitleex_plugin.htm official documentation and examples.]
 +
 
 +
<br>
 +
== Requirements ==
 +
* AviSynth 2.5.8 or [http://sourceforge.net/projects/avisynth2/ greater]
 +
* Supported color formats: [[RGB32]]
 +
<br>
 +
 
 +
== [[Script variables|Syntax and Parameters]] ==
 +
:{{Template:FuncDef|SubtitleEx (clip, string, int "x", int "y", int "firstframe", int "lastframe", int, string "font" string "effects", int "size", int "textcolor", int "halocolor") }}
 +
<br>
 +
::{{Par2||clip| }}
 +
:::Input clip.
 +
<br>
 +
::{{Par2||string|}}
 +
:::Text - obligatory parameter; no default value; can be multiline, to split a text into lines a "|" symbol is used.
 +
<br>
 +
::{{Par2|x|int|-clipWidth * 0.11}}
 +
::{{Par2|y|int|-clipHeight * 0.17}}
 +
:::Text position (default values: x = -clipWidth * 0.11, y = -clipHeight * 0.17). Following picture helps to understand how x and y to be defined:
 +
::: [[File:Subtitleex_textmetrics_.jpg]]
 +
:::Top left corner coordinates are (0, 0), x growth to the right, y growth down.
 +
 
 +
:::Value A defines vertical text position if (y >= 0) and then y = A
 +
:::Value B defines vertical text position if (y < 0) and then y = -B
 +
:::Value C defines horizontal text position if (x >= 0) and then x = C, text is left aligned
 +
:::Value D defines horizontal text position if (x < 0) and then x = -D, text is right aligned
 +
<br>
 +
::{{Par2|firstframe|int|0}}
 +
::{{Par2|lastframe|int|-1}}
 +
:::A range to which the text is applied (default values: firstframe = 0, lastframe = -1); if lastframe = -1 then last clip frame number is used.
 +
<br>
 +
::{{Par2|font|string|"Arial"}}
 +
:::Font name (default value: "Arial")
 +
<br>
 +
::{{Par2|effects|string|"b"}}
 +
:::Effects applied to the text.
 +
 
 +
:::Following control letter are used for the font and text appearance (order and position in the effects string do not matter):
 +
 
 +
::::b - bold
 +
::::i - italic
 +
::::u - underlined
 +
::::c - centered
 +
 
 +
 
 +
:::Dynamic effects usually have own parameters in the parentheses. Some parameters can be omitted, then they have default values (currently all of them are zeros). Following letters are used for dynamic effects:
 +
 
 +
::::f - fading; the effect has following parameters:
 +
 
 +
::::f(
 +
 
 +
:::::inFrames,
 +
:::::outFrames),
 +
 
 +
::::where
 +
 
 +
:::::inFrames - number of fade-in frames
 +
:::::outFrames - number of fade-out frames
 +
 
 +
 
 +
::::m - motion; the effect has following parameters:
 +
 
 +
::::m(
 +
 
 +
:::::moveInFrames,
 +
:::::xPosFrom,
 +
:::::yPosFrom,
 +
:::::moveOutFrames,
 +
:::::xPosTo,
 +
:::::yPosTo),
 +
 
 +
::::where
 +
 
 +
:::::moveInFrames - number of frames for move-in effect
 +
:::::xPosFrom, yPosFrom - starting point of move-in movement
 +
:::::moveOutFrames - number of frames for move-out effect
 +
:::::xPosTo, yPosTo - final point after move-out
 +
 
 +
 
 +
::::Following letters are used for usage of different filters:
 +
 
 +
:::::s - soft blur
 +
:::::g - gaussian blur
 +
:::::e - emboss filter
 +
:::::l - laplacian filter (edge detection)
 +
 
 +
 
 +
:::The order, in which filters letters are, is important. A filter can be applied several times and previous filter result is used for the current filter. The usage of the effects string is shown in very details in the Examples section.
 +
<br>
 +
::{{Par2|size|int|36}}
 +
:::Size of the font.
 +
<br>
 +
::{{Par2|textcolor|int|$00FFFFFF}}
 +
:::Text color.
 +
<br>
 +
::{{Par2|halocolor|int|$00000000}}
 +
::: This parameter defines a color of letters border in most of the cases (default value: $00000000). When the emboss filter is applied the parameter defines the darken side of letters
 +
 
 +
:::The color values have the following format (in hex): $TTRRGGBB, where TT stands for a transparency, $00 - opaque, $FF - completely transparent; RR - red color value, GG - green color value, BB - blue color value.
 +
<br>
 +
 
 +
== Examples ==
 +
[[TODO]]
 +
[[AviSource]]("Blah.avi")
 +
#SupTitleEx(TODO)
 +
 
 +
See [http://web.archive.org/web/20070823045159/http://mvideo.ddpp.net/eng/subtitleex_examples.htm examples section here] to have a look the possibilities of the plugin.
 +
 
 +
<br>
 +
 
 +
== Changelog ==
 +
<pre>
 +
v0.1.1        2004/09/12      - Latest release.
 +
v0.1.0        2004/05/24      - Initial release.
 +
</pre>
 +
<br>
 +
== Archived Downloads ==
 +
{| class="wikitable" border="1"; width="600px"
 +
|-
 +
!!width="100px"| Version
 +
!!width="150px"| Download
 +
!!width="150px"| Mirror
 +
|-
 +
!v0.1.1
 +
|
 +
*[http://www.avisynth.nl/users/warpenterprises/files/subtitleex_5F25_dll_20040819.zip subtitleex_5F25_dll_20040819.zip]
 +
|
 +
|}
 +
<br>
 +
== External Links ==
 +
<br>
 +
<br>
 +
-----------------------------------------------
 +
'''Back to [[External_filters#Subtitling|External Filters]] &larr;'''

Revision as of 16:52, 11 August 2019

Abstract
Author basilik
Version v0.1.1
Download subtitleex_5F25_dll_20040819.zip
Category Subtitling
License Open source (source code N/A)
Discussion


Contents

Description

The SubtitleEx is an AviSynth plugin to show a text over any video clip with one function inside: SubtitleEx. It is an extension of an existing Subtitle function of the AviSynth. Many of the parameters of the SubtitleEx have the same meaning as a original Subtitle function. See official documentation and examples.


Requirements


Syntax and Parameters

SubtitleEx (clip, string, int "x", int "y", int "firstframe", int "lastframe", int, string "font" string "effects", int "size", int "textcolor", int "halocolor")


clip   =
Input clip.


string   =
Text - obligatory parameter; no default value; can be multiline, to split a text into lines a "|" symbol is used.


int  x = -clipWidth * 0.11
int  y = -clipHeight * 0.17
Text position (default values: x = -clipWidth * 0.11, y = -clipHeight * 0.17). Following picture helps to understand how x and y to be defined:
Subtitleex textmetrics .jpg
Top left corner coordinates are (0, 0), x growth to the right, y growth down.
Value A defines vertical text position if (y >= 0) and then y = A
Value B defines vertical text position if (y < 0) and then y = -B
Value C defines horizontal text position if (x >= 0) and then x = C, text is left aligned
Value D defines horizontal text position if (x < 0) and then x = -D, text is right aligned


int  firstframe = 0
int  lastframe = -1
A range to which the text is applied (default values: firstframe = 0, lastframe = -1); if lastframe = -1 then last clip frame number is used.


string  font = "Arial"
Font name (default value: "Arial")


string  effects = "b"
Effects applied to the text.
Following control letter are used for the font and text appearance (order and position in the effects string do not matter):
b - bold
i - italic
u - underlined
c - centered


Dynamic effects usually have own parameters in the parentheses. Some parameters can be omitted, then they have default values (currently all of them are zeros). Following letters are used for dynamic effects:
f - fading; the effect has following parameters:
f(
inFrames,
outFrames),
where
inFrames - number of fade-in frames
outFrames - number of fade-out frames


m - motion; the effect has following parameters:
m(
moveInFrames,
xPosFrom,
yPosFrom,
moveOutFrames,
xPosTo,
yPosTo),
where
moveInFrames - number of frames for move-in effect
xPosFrom, yPosFrom - starting point of move-in movement
moveOutFrames - number of frames for move-out effect
xPosTo, yPosTo - final point after move-out


Following letters are used for usage of different filters:
s - soft blur
g - gaussian blur
e - emboss filter
l - laplacian filter (edge detection)


The order, in which filters letters are, is important. A filter can be applied several times and previous filter result is used for the current filter. The usage of the effects string is shown in very details in the Examples section.


int  size = 36
Size of the font.


int  textcolor = $00FFFFFF
Text color.


int  halocolor = $00000000
This parameter defines a color of letters border in most of the cases (default value: $00000000). When the emboss filter is applied the parameter defines the darken side of letters
The color values have the following format (in hex): $TTRRGGBB, where TT stands for a transparency, $00 - opaque, $FF - completely transparent; RR - red color value, GG - green color value, BB - blue color value.


Examples

TODO 

AviSource("Blah.avi")
#SupTitleEx(TODO)

See examples section here to have a look the possibilities of the plugin.


Changelog 

 v0.1.1        2004/09/12      - Latest release.
 v0.1.0        2004/05/24      - Initial release.


Archived Downloads

Version Download Mirror
v0.1.1


External Links



Back to External Filters ←

Retrieved from "http://avisynth.nl/index.php?title=SubtitleEx&oldid=10725"
Personal tools