VSFilterMod: Difference between revisions

From Avisynth wiki
Jump to navigationJump to search
← Older editNewer edit →

Reel.Deal (talk | contribs)

1 user group
5,521 edits
add VobSub documentation
add remaining documentation
Line 2: Line 2:
{{Filter3
{{Filter3
| Gabest, guliverkli2, and others
| Gabest, guliverkli2, and others
| R5.2.1
| R5.2.2
| [https://github.com/sorayuki/VSFilterMod/releases VSFilterMod_bin.7z]
| [https://github.com/sorayuki/VSFilterMod/releases VSFilterMod_bin.7z]
| Subtitling
| Subtitling
Line 14: Line 14:
:*VobSub
:*VobSub
:*TextSubMod
:*TextSubMod
:*MaskSubMod
:*TextSubModSwapUV


<br>
<br>
Line 20: Line 22:
* [x86]: [[AviSynth+]] or [http://forum.doom9.org/showthread.php?t=168764 AviSynth 2.6]
* [x86]: [[AviSynth+]] or [http://forum.doom9.org/showthread.php?t=168764 AviSynth 2.6]
* [x64]: [[AviSynth+]]
* [x64]: [[AviSynth+]]
* Supported color formats: [[RGB24]], [[RGB32]], [[YV12]]
* Supported color formats: [[RGB24]], [[RGB32]], [[YUY2]], [[YV12]]
<br>
<br>


Line 29: Line 31:
<br>
<br>
<br>
<br>
:{{Template:FuncDef|TextSubMod(clip, string file, int "charset", float "fps", string "vfr") }}
:{{Template:FuncDef|TextSubMod (clip, string "file", int "charset", float "fps", string "vfr") }}
<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|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===
Adds subtitles from a vob sequence.
Adds subtitles from a vob sequence.
<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||string|}}
::{{Par2| |string| }}
:::Path to subtitles file, only .idx and .sub files supported.
:::Path to subtitles file, only .idx and .sub files supported.
<br>
===MaskSubMod===
Creates a subtitle mask. Output clip is RGB32 an it is flipped vertically, use <code>[[FlipVertical]]()</code> to correct it.
<br>
<br>
:{{Template:FuncDef|MaskSubMod (clip, string "file", int "width", int "height", float "fps", int "length", int "charset", string "vfr") }}
<br>
::{{Par2|file|string|}}
:::Path to subtitles file.
<br>
::{{Par2|width|int| }}
::{{Par2|height|int| }}
:::''width'' and ''height'' specify the size of the generated clip, in pixels.
<br>
::{{Par2|fps|float| }}
:::''fps'' specifies the framerate of the generated clip.
<br>
::{{Par2|length|int| }}
:::''length'' is the number of frames to produce in the clip.
<br>
::{{Par2|charset|int| }}
:::''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>
::{{Par2|vfr|string|""}}
:::''vfr'' is the path to the VFR timecodes file (format 1 or 2) to use for frame times.
<br>
===TextSubModSwapUV===
<br>
:{{Template:FuncDef|TextSubModSwapUV (bool) }}
<br>
::{{Par2||clip| }}
:::Input clip.
<br>
::{{Par2| |bool|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>


== Examples ==
== Examples ==
  [[AviSource]]("Blah.avi")
  [[AviSource]]("Blah.avi")
  TextSubMod("subtitle.ass")
  TextSubMod(file="subtitle.ass")
 
#Assume clip is 1280x720, 24fps, and 3,000 frames total
MaskSubMod(file="subtitle.ass", width=1280, height=720, length=3000)


  [[AviSource]]("Blah.avi")
  [[AviSource]]("Blah.avi")

Revision as of 16:49, 27 April 2020

Abstract
Author Gabest, guliverkli2, and others
Version R5.2.2
Download VSFilterMod_bin.7z
Category Subtitling
License GPLv2
Discussion Doom9 Forum


Description

VSFilterMod is modification of original VSFilter subtitle renderer by Gabest. This mod brings up new features and some minor bugfixes.

VSFilterMod includes the following funtions:

  • VobSub
  • TextSubMod
  • MaskSubMod
  • TextSubModSwapUV


Requirements


Syntax and Parameters

TextSubMod

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

TextSubMod (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.


MaskSubMod

Creates a subtitle mask. Output clip is RGB32 an it is flipped vertically, use FlipVertical() to correct it.

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


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.


TextSubModSwapUV


TextSubModSwapUV (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")
TextSubMod(file="subtitle.ass")

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

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


Changelog

 R5.2.1        2019/07/07      - Add support for Unicode SMP
 R5.2          2018/08/14      - enable non-ascii filename.
 R5            2018/04/09      - support YUV420P10 and YUV420P16 for vapoursynth.


Archived Downloads

Version Download Mirror
R5.2.1 VSFilterMod_bin.7z
v
v0




Back to External Filters ←

Retrieved from "http://www.avisynth.nl/index.php?title=VSFilterMod&oldid=11238"