Skip to content

Update readme #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
erazortt wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update readme #14

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3b067ed
unify letter case of maxFall to MaxFALL
Jan 30, 2022
5a1eba0
remove unnecessary warning in readme
Feb 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 2 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@ PQ HDR Analyzer plugin for AVISynth, analyzes MaxCLL and MaxFALL and writes that

The created textfile's name is "MaxCLLFind_Results0.txt". It will be overwritten if it already exists.

**Caution:** This may not be the correct way to calculate MaxFALL and MaxCLL. For (Max)FALL I averaged the nit intensities of every single channel of every pixel in the frame. For MaxCLL I simply took the brightest channel of any pixel in any of the frames. There may be some weighting necessary akin to what was done here: https://github.com/HDRWCG/HDRStaticMetadata


### Usage
```
clip.MaxCLLFind()
Expand All @@ -21,7 +18,7 @@ clip = clip.ConvertToRGB64(matrix="Rec2020")
clip.MaxCLLFind()
```

Supported are the packed RGB formats RGB24, RGB32, RGB48, RGB64 and the planar RGB formats RGBP8, RGBP10, RGBP12, RGBP14, RGBP16. It is not advisable to use the formats RGB24, RGB32 and RGBP8 for HDR clips. The planar formats are processed about 30% faster than the packed formats, however the default maxFall calculation is unsuppored for them.
Supported are the packed RGB formats RGB24, RGB32, RGB48, RGB64 and the planar RGB formats RGBP8, RGBP10, RGBP12, RGBP14, RGBP16. It is not advisable to use the formats RGB24, RGB32 and RGBP8 for HDR clips. The planar formats are processed about 30% faster than the packed formats, however the default MaxFALL calculation is unsuppored for them.

### Alternate MaxFALL algorithm
The default MaxFALL algorithm uses the SMPTE recommendation of averaging max(R,G,B) across all pixels, meaning the brightest channel of each pixel goes into the average. If you want the average of all channels of all pixels (not the official recommendation) instead, do this:
Expand All @@ -30,7 +27,7 @@ clip.MaxCLLFind(maxFallAlgorithm=1)
```
This is more for your own curiosity and might lead to playback problems like flickering if used as actual HDR metadata, since it typically leads to typically slightly lower average intensity readings and if the TV bases its own dimming on the official recommendation, it might dim the image when it reaches a higher FALL than your calculated MaxFALL, which will almost certainly happen.

The official maxFall algorithm is not supported by the planar formats. If your input is planar either disable the maxFall calculation or use the unofficial algorithm or convert your clip to a packed format like RGB48. The maxFall calculation is disabled by:
The official MaxFALL algorithm is not supported by the planar formats. If your input is planar either disable the MaxFALL calculation or use the unofficial algorithm or convert your clip to a packed format like RGB48. The MaxFALL calculation is disabled by:

```
clip.MaxCLLFind(maxFallAlgorithm=-1)
Expand Down