Basic Usage

lvsfunc is a Python module, which means you must import it into your script before it can be accessed. You can import it by doing the following:

import lvsfunc

Simple, right? But writing “lvsfunc” every time is cumbersome, so we recommend you give it an alias.

import lvsfunc as lvf


The rest of the documentation will assume you alias lvsfunc as lvf.

With the module now imported, you can call functions in your script by referencing the module and writing the function name behind it.

import lvsfunc as lvf

clip = lvf.source("PATH/TO/YOUR/VIDEO")

lvsfunc exposes every function in the global scope, but also exposes every sub-module individually. Both of the following calls will call the same function:

import lvsfunc as lvf

descaled_clip_a = lvf.descale(clip)  # global scope
descaled_clip_b = lvf.scale.descale(clip)  # local scope

Calling them from the relevant sub-module is considered good practice, but for convenience, it may be easier to call the function from the global scope instead.

You can also import individual functions from sub-modules.

from lvsfunc.noise import chickendream

upscaled_clip = chickendream(clip)

This is useful if you only need a single function and don’t want to pollute your auto-completion with all the other lvsfunc functions.

For further information about specific functions, please refer to their individual documentation. You can find them by scouring the “Sub-Modules” pages to the left, or using the search bar.