Xy-VSFilter

Latest revision as of 09:29, 4 January 2024

[edit] Description

xy-VSFilter Project (High Performance VSFilter Compatible Subtitle Filters). Based on VSFilter 2.39 Guliverkli2 with various important changes from VSFilter 2.41 MPC-HC.

VSFilter includes the following functions:

• VobSub
• TextSub
• TextSubSwapUV
• MaskSub

[edit] Requirements

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

[edit] Syntax and Parameters

[edit] TextSub

Adds subtitles from text-based subtitle 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.

[edit] VobSub

Adds image-based subtitles in VobSub format. It consists of an *.idx file that stores the subtitle properties and a .sub file that contains the binary data..

VobSub (clip, string)

clip   =

Input clip.

string   =

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

[edit] MaskSub

Creates a subtitle mask.

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

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. - Fixed in v3.2.0.808

[edit] 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.

[edit] Examples

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

#Assume clip is 1280x720, 24fps, and 3,000 frames total
MaskSub(file="subtitle.ass", width=1280, height=720, fps=24, length=3000)


#or alternatively you can get the clip properties
video =  AviSource("Blah.avi")
MaskSub(file="subtitle.ass", width=video.Width(), height=video.Height(), fps=video.FrameRate(), length=video.FrameCount())

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

[edit] Changelog

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

[edit] External Links

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

Back to External Filters ←