update readme
This commit is contained in:
parent
fa9d9e69cc
commit
1bd8e2f816
14
README.md
14
README.md
|
@ -4,14 +4,14 @@ For a description of the math and the general idea,
|
||||||
see [the article](https://kageru.moe/blog/article/adaptivegrain/).
|
see [the article](https://kageru.moe/blog/article/adaptivegrain/).
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
`core.adg.Mask(clip, luma_scaling: float)`
|
```py
|
||||||
|
core.adg.Mask(clip, luma_scaling: float)
|
||||||
|
```
|
||||||
|
|
||||||
You must call `std.PlaneStats()` before this plugin
|
You must call `std.PlaneStats()` before this plugin
|
||||||
(or fill the PlaneStatsAverage frame property using some other method).
|
(or fill the PlaneStatsAverage frame property using some other method).
|
||||||
|
|
||||||
Supported formats are YUV with 8-32 bit precision integer or single precision float.
|
Supported formats are YUV with 8-32 bit precision integer or single precision float.
|
||||||
Half precision float input is not supported since no one seems to be using that anyway.
|
Half precision float input is not supported since no one seems to be using that anyway.
|
||||||
|
|
||||||
Since the output is grey and only luma is processed,
|
Since the output is grey and only luma is processed,
|
||||||
the subsampling of the input does not matter.
|
the subsampling of the input does not matter.
|
||||||
|
|
||||||
|
@ -20,10 +20,14 @@ It behaves exactly like the original implementation
|
||||||
(except for the performance, which is about 3x faster on my machine).
|
(except for the performance, which is about 3x faster on my machine).
|
||||||
|
|
||||||
### Parameters
|
### Parameters
|
||||||
`clip: vapoursynth.VideoNode`
|
```
|
||||||
|
clip: vapoursynth.VideoNode
|
||||||
|
```
|
||||||
the input clip to generate a mask for.
|
the input clip to generate a mask for.
|
||||||
|
|
||||||
`luma_scaling: float = 10.0`
|
```py
|
||||||
|
luma_scaling: float = 10.0
|
||||||
|
```
|
||||||
the luma\_scaling factor as described in the blog post.
|
the luma\_scaling factor as described in the blog post.
|
||||||
Higher values will make the mask brighter overall.
|
Higher values will make the mask brighter overall.
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue
Block a user