Xy-VSFilter

Revision as of 15:04, 27 April 2020

Description

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

VSFilter includes the following functions:

• VobSub
• TextSub
• TextSubSwapUV
• MaskSub

Requirements

• [x86]: AviSynth+ or AviSynth 2.6
• [x64]: AviSynth+
• Supported color formats: RGB24, RGB32, YV12
  • AviSynth+: TextSub accepts YUV420P10 and YUV420P16 formats

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 AssumeFPS instead 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 generated clip, in pixels.

float  fps =

fps specifies the framerate of the generated clip.

int  length =

length is the number of frames to produce in the clip.

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"

Note: With "RGB32" output the mask is flipped vertically, use FlipVertical() to correct it.

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("subtitle.sub")

Changelog

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

External Links

• GitHub - Source code repository (latest version from pinterf).
• GitHub - xy-VSFilter with VapourSynth interface added, based on the source of pinterf's fork

Back to External Filters ←