Avslibplacebo

Latest revision as of 10:39, 18 May 2023

[edit] Description

An AviSynth+ plugin interface to libplacebo - a reusable library for GPU-accelerated image/video processing primitives and shaders.

This is a port of the VapourSynth plugin vs-placebo.

Filters

• Deband - tunable debanding. Based on flash3kyuu, expanded to provide high quality by combining multiple debanding passes.
• Resample - high-quality, optimized upscaling and downscaling including support for polar filters ("Jinc"), anti-aliasing, anti-ringing and gamma correct scaling.
• Shader - loads GLSL shaders written in mpv's .hook syntax. This can be used to arbitrarily extend the range of custom shaders to include popular user shaders like RAVU, FSRCNNX, or Anime4K, and others.
• Tonemap - dynamic HDR tone mapping, includes peak and scene-change detection, chroma-preserving (luma-only) tone mapping, highlight desaturation, dynamic exposure control and a variety of industry-standard EETFs including BT.2390.

[edit] Requirements

• Vulkan compatible devive
• [x64]: AviSynth+ r3682 or greater (AviSynth+ 3.7.3 (test 6, r3935 can be downloaded from here)
• Microsoft VisualC++ Redistributable Package 2022 (can be downloaded from here)
• Supported color formats: listed below for each filter

[edit] Syntax and Parameters

[edit] Deband

libplacebo_Deband (clip input, int "iterations", float "threshold", float "radius", float "grainY", float "grainC", int "dither", int "lut_size", bool "temporal", int[] "planes", int "device", bool "list_device", float[] "grain_neutral")

clip   =

A clip to process.

It must be in 8, 16 or 32-bit planar format.

int  iterations = 1

The number of debanding steps to perform per sample.

Each step reduces a bit more banding, but takes time to compute.

Note that the strength of each step falls off very quickly, so high numbers (>4) are practically useless.

Must be greater than or equal to 0.

Default: 1.

float  threshold = 4.0

The debanding filter's cut-off threshold.

Higher numbers increase the debanding strength dramatically, but progressively diminish image details.

Must be greater than or equal to 0.0.

Default: 4.0.

float  radius = 16.0

The debanding filter's initial radius.

The radius increases linearly for each iteration.

A higher radius will find more gradients, but a lower radius will smooth more aggressively.

Must be radius must be greater than or equal to 0.0.

Default: 16.0.

float  grainY, grainC = 6.0

Add some extra noise respectively to the luma and chroma plane.

This significantly helps cover up remaining quantization artifacts.

Higher numbers add more noise.

Note: When debanding HDR sources, even a small amount of grain can result in a very big change to the brightness level.

It's recommended to either scale this value down or disable it entirely for HDR.

Must be greater than or equal to 0.0.

When the clip is RGB, grainC doesn't have effect.

Default: grainY = 6.0; grainC = grainY.

int  dither = 1

It's valid only for 8-bit clips.

• 0 : Disabled.
• 1 : PL_DITHER_BLUE_NOISE
  Dither with blue noise.
  Very high quality, but requires the use of a LUT.
  Warning: Computing a blue noise texture with a large size can be very slow, however this only needs to be performed once. Even so, using this with a lut_size greater than 6 is generally ill-advised.
• 2 : PL_DITHER_ORDERED_LUT
  Dither with an ordered (bayer) dither matrix, using a LUT.
  Low quality, and since this also uses a LUT, there's generally no advantage to picking this instead of PL_DITHER_BLUE_NOISE.
  It's mainly there for testing.
• 3 : PL_DITHER_ORDERED_FIXED
  The same as PL_DITHER_ORDERED_LUT, but uses fixed function math instead of a LUT.
  This is faster, but only supports a fixed dither matrix size of 16x16 (equal to a lut_size of 4).
• 4 : PL_DITHER_WHITE_NOISE
  Dither with white noise.
  This does not require a LUT and is fairly cheap to compute.
  Unlike the other modes it doesn't show any repeating patterns either spatially or temporally, but the downside is that this is visually fairly jarring due to the presence of low frequencies in the noise spectrum.

Default: 1.

int  lut_size = 6

For the dither methods which require the use of a LUT.

This controls the size of the LUT (base 2).

Must be less than or equal to 8.

Default: 6 (64x64).

bool  temporal = false

Enables temporal dithering.

This reduces the persistence of dithering artifacts by perturbing the dithering matrix per frame.

Warning: This can cause nasty aliasing artifacts on some LCD screens.

Default: False.

int array  planes = [3,2,2]

Planes to process.

• 1 : Return garbage.
• 2 : Copy plane.
• 3 : Process plane. Always process planes when the clip is RGB.

Format is [y, u, v].

Default: [3, 2, 2].

int  device =

Sets target Vulkan device.

Use list_device to get the index of the available devices.

By default the default device is selected.

bool  list_device = false

Whether to draw the devices list on the frame.

Default: False.

float[]  grain_neutral = [0, 0, 0]

"Neutral" grain value for each channel being debanded.

Grain application will be modulated to avoid disturbing colors close to this value.

Set this to a value corresponding to black in the relevant colorspace.

Must be greater than 0.0

Default: [0, 0, 0].

[edit] Resample

libplacebo_Resample (clip input, int width, int height, string "filter", float "radius", float "clamp", float "taper", float "blur", float "param1", float "param2", float "sx", float "sy", float "antiring", float "lut_entries", float "cutoff", bool "sigmoidize", bool "linearize", float "sigmoid_center", float "sigmoid_slope", int "trc", int "cplace", int "device", bool "list_device", float "src_width", float "src_height")

clip   =

A clip to process.

It must be in 8, 16 or 32-bit planar format.

int  width =

int  height =

The width and height of the output.

string  filter = "ewa_lanczos"

The used filter function.

• spline16 (2 taps)
• spline36 (3 taps)
• spline64 (4 taps)
• box (AKA nearest)
• triangle (AKA bilinear)
• gaussian

Sinc family (all configured to 3 taps):

• sinc (unwindowed)
• lanczos (sinc-sinc)
• ginseng (sinc-jinc)
• ewa_jinc (unwindowed)
• ewa_lanczos (jinc-jinc)
• ewa_ginseng (jinc-sinc)
• ewa_hann (jinc-hann)
• haasnsoft (blurred ewa_hann)

Spline family:

• bicubic
• catmull_rom
• mitchell
• robidoux
• robidouxsharp
• ewa_robidoux
• ewa_robidouxsharp

Default: "ewa_lanczos"

float  radius =

It may be used to adjust the function's radius.

Defaults to the the radius needed to represent a single filter lobe (tap).

If the function is not resizable, this doesn't have effect.

float  clamp = 0.0

Represents a clamping coefficient for negative weights: 0.0: No clamping.

1.0: Full clamping, i.e. all negative weights will be clamped to 0.

Default: 0.0.

float  taper = 0.0

Additional taper coefficient.

This essentially flattens the function's center.

The values within [-taper, taper] will return 1.0, with the actual function being squished into the remainder of [taper, radius].

Default: 0.0.

float  blur = 0.0

Additional blur coefficient.

This effectively stretches the kernel, without changing the effective radius of the filter radius.

Values significantly below 1.0 may seriously degrade the visual output, and should be used with care.

Default: 0.0.

float  param1 =

float  param2 =

These may be used to adjust the function.

Defaults to the function's preferred defaults. if the relevant setting is not tunable, they are ignored entirely.

float  sx = 0.0

float  sy = 0.0

Cropping of the left and top edge.

Default: 0.0.

float  antiring = 0.0

Antiringing strength.

A value of 0.0 disables antiringing, and a value of 1.0 enables full-strength antiringing.

Only relevant for separated/orthogonal filters.

Default: 0.0.

int  lut_entries = 64

The precision of the LUT.

A value of 64 should be fine for most practical purposes, but higher or lower values may be justified depending on the use case.

Must be greater than 0.

Default: 64.

float  cutoff = 0.0

As a micro-optimization, all samples below this cutoff value will be ignored when updating the cutoff radius.

Setting it to a value of 0.0 disables this optimization.

Only relevant for polar filters.

Default: 0.0.

bool  sigmoidize = true

bool  linearize = true

Whether to linearize/sigmoidize before scaling.

Only relevant for RGB formats.

When sigmodizing, linearize should be true

Default: True.

float  sigmoid_center = 0.75

The center (bias) of the sigmoid curve.

Must be between 0.0 and 1.0.

Default: 0.75.

float  sigmoid_slope = 6.5

The slope (steepness) of the sigmoid curve.

Must be between 1.0 and 20.0.

Default: 6.5.

int  trc = 1

The colorspace's transfer function (gamma / EOTF) to use for linearizing.

• 0 : UNKNOWN

Standard dynamic range:

• 1 : BT_1886 (ITU-R Rec. BT.1886 (CRT emulation + OOTF))
• 2 : SRGB (IEC 61966-2-4 sRGB (CRT emulation))
• 3 : LINEAR (Linear light content)
• 4 : GAMMA18 (Pure power gamma 1.8)
• 5 : GAMMA20 (Pure power gamma 2.0)
• 6 : GAMMA22 (Pure power gamma 2.2)
• 7 : GAMMA24 (Pure power gamma 2.4)
• 8 : GAMMA26 (Pure power gamma 2.6)
• 9 : GAMMA28 (Pure power gamma 2.8)
• 10 : PRO_PHOTO (ProPhoto RGB (ROMM))
• 11: ST428 (Digital Cinema Distribution Master (XYZ))

High dynamic range:

• 11 : PQ (ITU-R BT.2100 PQ (perceptual quantizer), aka SMPTE ST2048)
• 12 : HLG (ITU-R BT.2100 HLG (hybrid log-gamma), aka ARIB STD-B67)
• 13 : V_LOG (Panasonic V-Log (VARICAM))
• 14 : S_LOG1 (Sony S-Log1)
• 15 : S_LOG2 (Sony S-Log2)

Default: 1.

int  cplace = 0

Chroma sample position in YUV formats.

• 0: left
• 1: center
• 2: topleft

Default: 0.

int  device =

Sets target Vulkan device.

Use list_device to get the index of the available devices.

By default the default device is selected.

bool  list_device = false

Whether to draw the devices list on the frame.

Default: False.

float  src_width = Source width

Sets the width of the clip before resizing.

Must be greater than 0.0.

Default: Source width.

float  src_height = Source height

Sets the height of the clip before resizing.

Must be greater than 0.0.

Default: Source height.

[edit] Shader

libplacebo_Shader(clip input, string shader, int "width", int "height", int "chroma_loc", int "matrix", int "trc", string "filter", float "radius", float "clamp", float "taper", float "blur", float "param1", float "param2", float "antiring", float "lut_entries", float "cutoff", bool "sigmoidize", bool "linearize", float "sigmoid_center", float "sigmoid_slope", string "shader_param", int "device", bool "list_device" )

clip   =

A clip to process.

It must be YUV 16-bit planar format.

The output is YUV444P16. This is necessitated by the fundamental design of libplacebo/mpv’s custom shader feature: the shaders aren’t meant (nor written) to be run by themselves, but to be injected at arbitrary points into a rendering pipeline with RGB output.

As such, the user needs to specify the output frame properties, and libplacebo will produce a conforming image, only running the supplied shader if the texture it hooks into is actually rendered. For example, if a shader hooks into the LINEAR texture, it will only be executed when linearize = true.

string  shader =

Path to the shader file.

int  width =

int  height =

The width and height of the output.

Default: Source width and height.

int  chroma_loc = 1

Chroma location to derive chroma shift from.

• 0: UNKNOWN
• 1: LEFT
• 2: CENTER
• 3: TOP_LEFT
• 4: TOP_CENTER
• 5: BOTTOM_LEFT
• 6: BOTTOM_CENTER

Default: 1.

int  matrix = 2

• 0: UNKNOWN
• 1: BT_601 (ITU-R Rec. BT.601 (SD))
• 2: BT_709 (ITU-R Rec. BT.709 (HD))
• 3: SMPTE_240M (SMPTE-240M)
• 4: BT_2020_NC (ITU-R Rec. BT.2020 (non-constant luminance))
• 5: BT_2020_C (ITU-R Rec. BT.2020 (constant luminance))
• 6: BT_2100_PQ (ITU-R Rec. BT.2100 ICtCp PQ variant)
• 7: BT_2100_HLG (ITU-R Rec. BT.2100 ICtCp HLG variant)
• 8: YCGCO (YCgCo (derived from RGB))

Default: 2.

int  trc = 1

The colorspace's transfer function (gamma / EOTF) to use for linearizing.

• 0: UNKNOWN

Standard dynamic range:

• 1: BT_1886 (ITU-R Rec. BT.1886 (CRT emulation + OOTF))
• 2: SRGB (IEC 61966-2-4 sRGB (CRT emulation))
• 3: LINEAR (Linear light content)
• 4: GAMMA18 (Pure power gamma 1.8)
• 5: GAMMA20 (Pure power gamma 2.0)
• 6: GAMMA22 (Pure power gamma 2.2)
• 7: GAMMA24 (Pure power gamma 2.4)
• 8: GAMMA26 (Pure power gamma 2.6)
• 9: GAMMA28 (Pure power gamma 2.8)
• 10: PRO_PHOTO (ProPhoto RGB (ROMM))
• 11: ST428 (Digital Cinema Distribution Master (XYZ))

High dynamic range:

• 11: PQ (ITU-R BT.2100 PQ (perceptual quantizer), aka SMPTE ST2048)
• 12: HLG (ITU-R BT.2100 HLG (hybrid log-gamma), aka ARIB STD-B67)
• 13: V_LOG (Panasonic V-Log (VARICAM))
• 14: S_LOG1 (Sony S-Log1)
• 15: S_LOG2 (Sony S-Log2)

Default: 1.

string  filter = "ewa_lanczos"

The used filter function.

• spline16 (2 taps)
• spline36 (3 taps)
• spline64 (4 taps)
• box (AKA nearest)
• triangle (AKA bilinear)
• gaussian

Sinc family (all configured to 3 taps):

• sinc (unwindowed)
• lanczos (sinc-sinc)
• ginseng (sinc-jinc)
• ewa_jinc (unwindowed)
• ewa_lanczos (jinc-jinc)
• ewa_ginseng (jinc-sinc)
• ewa_hann (jinc-hann)
• haasnsoft (blurred ewa_hann)

Spline family:

• bicubic
• catmull_rom
• mitchell
• robidoux
• robidouxsharp
• ewa_robidoux
• ewa_robidouxsharp

Default: "ewa_lanczos"

float  radius =

It may be used to adjust the function's radius.

Defaults to the the radius needed to represent a single filter lobe (tap).

If the function is not resizable, this doesn't have effect.

float  clamp = 0.0

Represents a clamping coefficient for negative weights: 0.0: No clamping.

1.0: Full clamping, i.e. all negative weights will be clamped to 0.

Default: 0.0.

float  taper = 0.0

Additional taper coefficient.

This essentially flattens the function's center.

The values within [-taper, taper] will return 1.0, with the actual function being squished into the remainder of [taper, radius].

Default: 0.0.

float  blur = 0.0

Additional blur coefficient.

This effectively stretches the kernel, without changing the effective radius of the filter radius.

Values significantly below 1.0 may seriously degrade the visual output, and should be used with care.

Default: 0.0.

float  param1 =

float  param2 =

These may be used to adjust the function.

Defaults to the function's preferred defaults. if the relevant setting is not tunable, they are ignored entirely.

float  sx = 0.0

float  sy = 0.0

Cropping of the left and top edge.

Default: 0.0.

float  antiring = 0.0

Antiringing strength.

A value of 0.0 disables antiringing, and a value of 1.0 enables full-strength antiringing.

Only relevant for separated/orthogonal filters.

Default: 0.0.

int  lut_entries = 64

The precision of the LUT.

A value of 64 should be fine for most practical purposes, but higher or lower values may be justified depending on the use case.

Must be greater than 0.

Default: 64.

float  cutoff = 0.0

As a micro-optimization, all samples below this cutoff value will be ignored when updating the cutoff radius.

Setting it to a value of 0.0 disables this optimization.

Only relevant for polar filters.

Default: 0.0.

bool  sigmoidize = true

bool  linearize = true

Whether to linearize/sigmoidize before scaling.

Only relevant for RGB formats.

When sigmodizing, linearize should be true

Default: True.

float  sigmoid_center = 0.75

The center (bias) of the sigmoid curve.

Must be between 0.0 and 1.0.

Default: 0.75.

float  sigmoid_slope = 6.5

The slope (steepness) of the sigmoid curve.

Must be between 1.0 and 20.0.

Default: 6.5.

string  shader_param =

This changes shader's parameter set by #define XXXX YYYY on the fly.

Format is: param=value.

parameter is case sensitive and must be the same as in the shader file.

If more than one parameter is specified, the parameters must be separated by space.

Usage example: if the shader has the following parameters:

• #define INTENSITY_SIGMA 0.1 //Intensity window size, higher is stronger denoise, must be a positive real number
• #define SPATIAL_SIGMA 1.0 //Spatial window size, higher is stronger denoise, must be a positive real number

shader_param="INTENSITY_SIGMA=0.15 SPATIAL_SIGMA=1.1"

int  device =

Sets target Vulkan device.

Use list_device to get the index of the available devices.

By default the default device is selected.

bool  list_device = false

Whether to draw the devices list on the frame.

Default: False.

[edit] Tonemap

libplacebo_Tonemap (clip input, int "src_csp", float "dst_csp", float "src_max", float "src_min", float "dst_max", float "dst_min", bool "dynamic_peak_detection", float "smoothing_period", float "scene_threshold_low", float "scene_threshold_high", float "percentile", int "intent", int "gamut_mode", int "tone_mapping_function", int "tone_mapping_mode", float "tone_mapping_param", float "tone_mapping_crosstalk", int "metadata", bool "visualize_lut", bool "show_clipping", bool "use_dovi", int "device", bool "list_device")

clip   =

A clip to process.

It must be 16-bit planar format. (min. 3 planes)

The output is YUV444P16 if the input is YUV.

int  src_csp = 1

int  dst_csp = 0

Respectively source and output color space.

• 0: SDR
• 1: HDR10
• 2: HLG
• 3: DOVI

Default: src_csp = 1; dst_csp = 0.

For example, to map from [BT.2020, PQ] (HDR) to traditional [BT.709, BT.1886] (SDR), pass src_csp=1, dst_csp=0.

float  src_max =

float  src_min =

float  dst_max =

float  dst_min =

Source max/min and output max/min in nits (cd/m^2).

The source values can be derived from props if available.

Default: max = 1000 (HDR)/203 (SDR); min = 0.005 (HDR)/0.2023 (SDR)

bool  dynamic_peak_detection = true

Enables computation of signal stats to optimize HDR tonemapping quality.

Default: True.

float  smoothing_period = 100.0

Smoothing coefficient for the detected values.

This controls the time parameter (tau) of an IIR low pass filter. In other words, it represent the cutoff period (= 1 / cutoff frequency) in frames. Frequencies below this length will be suppressed.

This helps block out annoying "sparkling" or "flickering" due to small variations in frame-to-frame brightness.

Default: 100.0.

float  scene_threshold_low = 5.5

float  scene_threshold_high = 10.0

In order to avoid reacting sluggishly on scene changes as a result of the low-pass filter, we disable it when the difference between the current frame brightness and the average frame brightness exceeds a given threshold difference.

But rather than a single hard cutoff, which would lead to weird discontinuities on fades, we gradually disable it over a small window of brightness ranges. These parameters control the lower and upper bounds of this window, in dB.

To disable this logic entirely, set either one to a negative value.

Default: scene_threshold_low = 5.5; scene_threshold_high = 10.0

float  percentile = 99.995

Which percentile of the input image brightness histogram to consider as the true peak of the scene.

If this is set to 100 (or 0), the brightest pixel is measured. Otherwise, the top of the frequency distribution is progressively cut off.

Setting this too low will cause clipping of very bright details, but can improve the dynamic brightness range of scenes with very bright isolated highlights.

The default of 99.995% is very conservative and should cause no major issues in typical content.

int  intent = 1

The rendering intent to use for gamut mapping.

• 0: PERCEPTUAL
• 1: RELATIVE_COLORIMETRIC
• 2: SATURATION
• 3: ABSOLUTE_COLORIMETRIC

Default: 1.

int  gamut_mode = 0

How to handle out-of-gamut colors when changing the content primaries.

• 0: CLIP (Do nothing, simply clip out-of-range colors to the RGB volume)
• 1: WARN (Equal to CLIP but also highlights out-of-gamut colors (by coloring them pink))
• 2: DARKEN (Linearly reduces content brightness to preserves saturated details, followed by clipping the remaining out-of-gamut colors.
  As the name implies, this makes everything darker, but provides a good balance between preserving details and colors.)
• 3: DESATURATE (Hard-desaturates out-of-gamut colors towards white, while preserving the luminance. Has a tendency to shift colors.)

Default: 0.

int  tone_mapping_function = 0

• 0: auto (Special tone mapping function that means "automatically pick a good function based on the HDR levels")
• 1: clip (Performs no tone-mapping, just clips out-of-range colors.
  Retains perfect color accuracy for in-range colors but completely destroys out-of-range information.
  Does not perform any black point adaptation.)
• 2: st2094_40 (EETF from SMPTE ST 2094-40 Annex B, which uses the provided OOTF based on Bezier curves to perform tone-mapping.
  The OOTF used is adjusted based on the ratio between the targeted and actual display peak luminances.
  In the absence of HDR10+ metadata, falls back to a simple constant bezier curve with tunable knee point.
  The tone_mapping_param gives the target brightness adaptation strength for the knee point, defaulting to 0.7.)
• 3: st2094_10 (EETF from SMPTE ST 2094-10 Annex B.2, which takes into account the input signal average luminance in addition to the maximum/minimum.
  The tone_mapping_param gives the target brightness adaptation strength for the knee point, defaulting to 0.5.
  Note: This does not currently include the subjective gain/offset/gamma controls defined in Annex B.3.)
• 4: bt2390 (EETF from the ITU-R Report BT.2390, a hermite spline roll-off with linear segment.
  The knee point offset is configurable. Note that this defaults to 1.0, rather than the value of 0.5 from the ITU-R spec.)
• 5: bt2446a (EETF from ITU-R Report BT.2446, method A.
  Can be used for both forward and inverse tone mapping. Not configurable.)
• 6: spline (Simple spline consisting of two polynomials, joined by a single pivot point.
  The tone_mapping_param gives the pivot point (in PQ space), defaulting to 0.30.
  Can be used for both forward and inverse tone mapping.)
• 7: reinhard (Simple non-linear, global tone mapping algorithm.
  Named after Erik Reinhard.
  The tone_mapping_param specifies the local contrast coefficient at the display peak.
  Essentially, a value of param=0.5 implies that the reference white will be about half as bright as when clipping.
  Defaults to 0.5, which results in the simplest formulation of this function.)
• 8: mobius (Generalization of the reinhard tone mapping algorithm to support an additional linear slope near black.
  The tone mapping tone_mapping_param indicates the trade-off between the linear section and the non-linear section.
  Essentially, for param=0.5, every color value below 0.5 will be mapped linearly, with the higher values being non-linearly tone mapped.
  Values near 1.0 make this curve behave like clip, and values near 0.0 make this curve behave like reinhard.
  The default value is 0.3, which provides a good balance between colorimetric accuracy and preserving out-of-gamut details.
  The name is derived from its function shape (ax+b)/(cx+d), which is known as a Möbius transformation in mathematics.)
• 9: hable (Piece-wise, filmic tone-mapping algorithm developed by John Hable for use in Uncharted 2, inspired by a similar tone-mapping algorithm used by Kodak.
  Popularized by its use in video games with HDR rendering.
  Preserves both dark and bright details very well, but comes with the drawback of changing the average brightness quite significantly.
  This is sort of similar to reinhard with tone_mapping_param 0.24.)
• 10: gamma (Fits a gamma (power) function to transfer between the source and target color spaces, effectively resulting in a perceptual hard-knee joining two roughly linear sections.
  This preserves details at all scales fairly accurately, but can result in an image with a muted or dull appearance.
  The tone_mapping_param is used as the cutoff point, defaulting to 0.5.)
• 11: linear (Linearly stretches the input range to the output range, in PQ space.
  This will preserve all details accurately, but results in a significantly different average brightness.
  Can be used for inverse tone-mapping in addition to regular tone-mapping.
  The parameter can be used as an additional linear gain coefficient (defaulting to 1.0).)

Default: 0.

int  tone_mapping_mode = 0

• 0: AUTO (Picks the best tone-mapping mode based on internal heuristics.)
• 1: RGB (Per-channel tone-mapping in RGB. Guarantees no clipping and heavily desaturates the output, but distorts the colors quite significantly.)
• 2: MAX (Tone-mapping is performed on the brightest component found in the signal.
  Good at preserving details in highlights, but has a tendency to crush blacks.)
• 3: HYBRID (Tone-map per-channel for highlights and linearly (luma-based) for midtones/shadows, based on a fixed gamma 2.4 coefficient curve.)
• 4: LUMA (Tone-map linearly on the luma component, and adjust (desaturate) the chromaticities to compensate using a simple constant factor.
  This is essentially the mode used in ITU-R BT.2446 method A.)

Default: 0.

float  tone_mapping_param =

The tone-mapping curve parameter.

Default: Default for the selected tone_mapping_function.

float  tone_mapping_crosstalk = 0.04

Extra crosstalk factor to apply before tone-mapping.

May help to improve the appearance of very bright, monochromatic highlights.

Default: 0.04.

int  metadata =

Data source to use when tone-mapping.

Setting this to a specific value allows overriding the default metadata preference logic.

• 0: ANY
• 1: NONE
• 2: HDR10 (HDR10 static mastering display metadata)
• 3: HDR10PLUS (HDR10+ dynamic metadata)
• 4: CIE_Y (CIE Y derived dynamic luminance metadata)

bool  visualize_lut = false

Visualize the tone-mapping curve / LUT. (PQ-PQ graph)

Default: False.

bool  show_clipping = false

Graphically highlight hard-clipped pixels during tone-mapping (i.e. pixels that exceed the claimed source luminance range).

Note that the difference between this and gamut_mode=1 is that the latter only shows out-of-gamut colors (that are inside the monitor brightness range), while this shows out-of-range colors (regardless of whether or not they're in-gamut).

Default: False.

bool  use_dovi =

Whether to use the Dolby Vision RPU for ST2086 metadata.

Defaults to true when tonemapping from Dolby Vision.

int  device =

Sets target Vulkan device.

Use list_device to get the index of the available devices.

By default the default device is selected.

bool  list_device = false

Whether to draw the devices list on the frame.

Default: False.

[edit] Examples

TODO

[edit] Changelog

Version      Date            Changes

v1.2.0       2023/03/11      - Resample/Shader: added trc ST428.
                             - Tonemap: added parameters percentile, metadata, visualize_lut, show_clipping.
                             - Tonemap: added tone_mapping_function st2094_40, st2094_10.
                             - Shader/Tonemap: improved speed. (based on Lypheo/vs-placebo@09075cf)
                             - Tonemap: added support for libdovi 3. (based on Lypheo/vs-placebo@f65161b)
                             - Removed libp2p dependency.
                             - Tonemap: fixed wrong levels when output is SDR.
                             - Tonemap: remove HDR frame props when output is SDR.
                             - Tonemap: added support for libplacebo v5.264.0. (based on Lypheo/vs-placebo@4a42255)
                             - Shader: removed shader_param limit.
                             - Updated Vulkan SDK 1.3.239.0.
                             - Updated libplacebo. (v5.264.0-rc1)
                             - Updated libdovi. (e150367)

v1.1.5       2022/01/09      - libplacebo_Tonemap: fixed dst_min.
                             - Updated Vulkan SDK 1.3.236.0.
                             - Updated libplacebo. (v5.229.2)

v1.1.4       2022/12/23      - libplacebo_Tonemap: fixed src_csp < 3.

v1.1.3       2022/11/20      - libplacebo_Resample: added src_width and src_height parameters.
                             - libplacebo_Deband: added grain_neutral parameter.
                             - Updated Vulkan SDK 1.3.231.1.
                             - Updated libplacebo. (v5.229.1)

v1.1.2       2022/10/01      - libplacebo_Tonemap: properly handle video w/o DolbyVisionRPU.

v1.1.1       2022/09/22      - libplacebo_Resample: fixed chroma location for YUV444.

v1.1.0       2022/09/11      - libplacebo_Deband: replaced parameter grain with grainY and grainC.
                             - Fixed undefined behavior when upstream throw runtime error.
                             - libplacebo_Tonemap: throw error when src_csp=3 and there is no frame property DolbyVisionRPU.
                             - libplacebo_Tonemap: fixed black point for any Dolby Vision to PQ conversion.
                             - Updated Vulkan SDK 1.3.224.1.

v1.0.1       2022/07/17      - libplacebo_Shader: added shader_param.
                             - Updated libplacebo. (v4.208.0)

v1.0.0       2022/07/15      - Initial release

[edit] External Links

• GitHub - Source code repository.

Shaders

• GitHub - MPV Wiki: a collection of Shaders compatible with avslibplacebo.
• GitHub - AviSynthAiUpscale: implementation of some Super-Resolution Convolutional Neural Networks.
• GitHub - small collection of mpv shaders, more info here.
• Reddit - crt-easymode shader. Fix for YUV ouput: Doom9 thread

Back to External Filters ←