Xy-VSFilter

From Avisynth wiki
(Difference between revisions)
Jump to: navigation, search
(xy-VSFilter: add documentation)
 
(add more documentation)
Line 31: Line 31:
 
<br>
 
<br>
 
<br>
 
<br>
−
:{{Template:FuncDef|TextSub(clip, string "file", int "charset", float "fps", string "vfr") }}
+
:{{Template:FuncDef|TextSub (clip, string "file", int "charset", float "fps", string "vfr") }}
 
<br>
 
<br>
 
::{{Par2||clip| }}
 
::{{Par2||clip| }}
Line 40: Line 40:
 
<br>
 
<br>
 
::{{Par2|charset|int|1}}
 
::{{Par2|charset|int|1}}
−
:::
+
:::''charset'' is the encoding to assume the file is in, if it's not Unicode UTF-8 or UTF-16. (If you need to use this you're doing something wrong.)
 
<br>
 
<br>
 
::{{Par2|fps|float|-1.0}}
 
::{{Par2|fps|float|-1.0}}
−
:::
+
:::''fps'' is the FPS to assume the video is at. You could just as well just use <code>AssumeFPS</code>instead of using this. VFR overrides this.
 
<br>
 
<br>
 
::{{Par2|vfr|string|""}}
 
::{{Par2|vfr|string|""}}
−
:::Path to timecodes V2 file.
+
:::''vfr'' is the path to the VFR timecodes file (format 1 or 2) to use for frame times. If set, overrides all other FPS specifications.
 
<br>
 
<br>
 
===VobSub===
 
===VobSub===
Line 52: Line 52:
 
<br>
 
<br>
 
<br>
 
<br>
−
:{{Template:FuncDef|VobSub (clip, string "file") }}
+
:{{Template:FuncDef|VobSub (clip, string) }}
 
<br>
 
<br>
 
::{{Par2||clip| }}
 
::{{Par2||clip| }}
 
:::Input clip.
 
:::Input clip.
 
<br>
 
<br>
−
::{{Par2|file|string|}}
+
::{{Par2| |string| }}
 
:::Path to subtitles file, only .idx and .sub files supported.
 
:::Path to subtitles file, only .idx and .sub files supported.
 
<br>
 
<br>
Line 64: Line 64:
 
<br>
 
<br>
 
<br>
 
<br>
−
:{{Template:FuncDef|TextSubMod(clip, string "file", int "width", int "height", float "fps", int "length", int "charset", string "vfr", string "pixel_type") }}
+
:{{Template:FuncDef|MaskSub(clip, string "file", int "width", int "height", float "fps", int "length", int "charset", string "vfr", string "pixel_type") }}
 
<br>
 
<br>
 
::{{Par2||clip| }}
 
::{{Par2||clip| }}
 
:::Input clip.
 
:::Input clip.
 
<br>
 
<br>
−
::{{Par2||string|}}
+
::{{Par2|file|string|}}
 
:::Path to subtitles file.
 
:::Path to subtitles file.
 
<br>
 
<br>
 
::{{Par2|width|int| }}
 
::{{Par2|width|int| }}
 
::{{Par2|height|int| }}
 
::{{Par2|height|int| }}
−
:::Width and height.
+
:::''width'' and ''height'' specify the size of the produced video frame.
 
<br>
 
<br>
 
::{{Par2|fps|float| }}
 
::{{Par2|fps|float| }}
−
:::FPS
+
:::''fps'' specifies the FPS of the generated video.
 
<br>
 
<br>
 
::{{Par2|length|int| }}
 
::{{Par2|length|int| }}
−
:::Length
+
:::''length'' is the number of frames to generate.
 
<br>
 
<br>
 
::{{Par2|charset|int| }}
 
::{{Par2|charset|int| }}
−
:::Character set.
+
:::''charset'' is the encoding to assume the file is in, if it's not Unicode UTF-8 or UTF-16. (If you need to use this you're doing something wrong.)
 
<br>
 
<br>
 
::{{Par2|vfr|string|""}}
 
::{{Par2|vfr|string|""}}
−
:::Path to timecodes V2 file.
+
:::''vfr'' is the path to the VFR timecodes file (format 1 or 2) to use for frame times.
 
<br>
 
<br>
 
::{{Par2|pixel_type|string|"RGB32"}}
 
::{{Par2|pixel_type|string|"RGB32"}}
Line 92: Line 92:
 
<br>
 
<br>
 
===TextSubSwapUV===
 
===TextSubSwapUV===
−
???
 
−
<br>
 
 
<br>
 
<br>
−
:{{Template:FuncDef|TextSubSwapUV (bool "invert") }}
+
:{{Template:FuncDef|TextSubSwapUV (bool) }}
 
<br>
 
<br>
 
::{{Par2||clip| }}
 
::{{Par2||clip| }}
 
:::Input clip.
 
:::Input clip.
 
<br>
 
<br>
−
::{{Par2|invert|bool|false}}
+
::{{Par2| |bool|false}}
−
:::Invert: true or false.
+
:::Toggles (globally) whether to swap assume the U and V planes are swapped in YV12 video when rendering subtitles. Default is false.
 
<br>
 
<br>
  

Revision as of 16:06, 25 April 2020

Abstract
Author Gabest, guliverkli2, cyberbeing, pinterf
Version v3.2.0.802
Download xyVSFilterSubFilter-pfmod-3.2.0.802.7z
Category Subtitling
License GPLv2
Discussion Doom9 Forum


Contents

Description

xy-VSFilter Project (High Performance VSFilter Compatible Subtitle Filters)

VSFilter includes the following functions:

  • VobSub
  • TextSub
  • TextSubSwapUV
  • MaskSub


Requirements


Syntax and Parameters

TextSub

Adds subtitles from srt, sub, psb, smi, ssa, ass file formats.

TextSub (clip, string "file", int "charset", float "fps", string "vfr")


clip   =
Input clip.


string  file =
Path to subtitles file.


int  charset = 1
charset is the encoding to assume the file is in, if it's not Unicode UTF-8 or UTF-16. (If you need to use this you're doing something wrong.)


float  fps = -1.0
fps is the FPS to assume the video is at. You could just as well just use AssumeFPSinstead of using this. VFR overrides this.


string  vfr = ""
vfr is the path to the VFR timecodes file (format 1 or 2) to use for frame times. If set, overrides all other FPS specifications.


VobSub

Adds subtitles from a vob sequence.

VobSub (clip, string)


clip   =
Input clip.


string   =
Path to subtitles file, only .idx and .sub files supported.


MaskSub

Creates a subtitle mask. See here for more info.

MaskSub(clip, string "file", int "width", int "height", float "fps", int "length", int "charset", string "vfr", string "pixel_type")


clip   =
Input clip.


string  file =
Path to subtitles file.


int  width =
int  height =
width and height specify the size of the produced video frame.


float  fps =
fps specifies the FPS of the generated video.


int  length =
length is the number of frames to generate.


int  charset =
charset is the encoding to assume the file is in, if it's not Unicode UTF-8 or UTF-16. (If you need to use this you're doing something wrong.)


string  vfr = ""
vfr is the path to the VFR timecodes file (format 1 or 2) to use for frame times.


string  pixel_type = "RGB32"
Pixel type, can be set to: "RGB32", "YUV420P10" or "YUV420P16"


TextSubSwapUV


TextSubSwapUV (bool)


clip   =
Input clip.


bool   = false
Toggles (globally) whether to swap assume the U and V planes are swapped in YV12 video when rendering subtitles. Default is false.


Examples 

AviSource("Blah.avi")
TextSub(file="subtitle.ass")

AviSource("Blah.avi")
VobSub(file="subtitle.sub")


Changelog

See GitHub releases page: https://github.com/pinterf/xy-VSFilter/releases

External Links

  • GitHub - Source code repository (latest version).

.

Back to External Filters ←

Retrieved from "http://avisynth.nl/index.php?title=Xy-VSFilter&oldid=11222"
Personal tools