Video Analyzers

Black Detection Analyzer [bdan]

Properties:

OutputFormat

Four character code that specifies the output video stream format

Type: Four


UsingHardwareAcceleration

True if the filter is using hardware acceleration.

Note: This property is read only.

Type: Bool


LeftMargin

Left margin of the region of interest.

Positive value measured in pixels from the left edge of the frame.

Type: Int32


RightMargin

Right margin of the region of interest.

Positive value measured in pixels from the right edge of the frame.

Type: Int32


TopMargin

Top margin of the region of interest.

Positive value measured in pixels from the top edge of the frame.

Type: Int32


BottomMargin

Bottom margin of the region of interest.

Positive value measured in pixels from the bottom edge of the frame.

Type: Int32


Border Detection Analyzer [boan]

Properties:

OutputFormat

Four character code that specifies the output video stream format

Type: Four


UsingHardwareAcceleration

True if the filter is using hardware acceleration.

Note: This property is read only.

Type: Bool


LeftMargin

Left margin of the region of interest.

Positive value measured in pixels from the left edge of the frame. This property is also set on the output sample to idicate the detected left margin.

Type: Int32


RightMargin

Right margin of the region of interest.

Positive value measured in pixels from the right edge of the frame. This property is also set on the output sample to idicate the detected right margin.

Type: Int32


BottomMargin

Bottom margin of the region of interest.

Positive value measured in pixels from the bottom edge of the frame. This property is also set on the output sample to idicate the detected bottom margin.

Type: Int32


TopMargin

Top margin of the region of interest.

Positive value measured in pixels from the top edge of the frame. This property is also set on the output sample to idicate the detected top margin.

Type: Int32


BlackLevel

The black level.

The property specifies the value at (or below) which is considered black.

Type: Int


Color Levels Analyzer [clev]

Properties:

OutputFormat

Four character code that specifies the output video stream format

Type: Four


UsingHardwareAcceleration

True if the filter is using hardware acceleration.

Note: This property is read only.

Type: Bool


LeftMargin

Left margin of the region of interest.

Positive value measured in pixels from the left edge of the frame.

Type: Int32


RightMargin

Right margin of the region of interest.

Positive value measured in pixels from the right edge of the frame.

Type: Int32


TopMargin

Top margin of the region of interest.

Positive value measured in pixels from the top edge of the frame.

Type: Int32


BottomMargin

Bottom margin of the region of interest.

Positive value measured in pixels from the bottom edge of the frame.

Type: Int32


Curtain Detection Analyzer [cdan]

Properties:

OutputFormat

Four character code that specifies the output video stream format

Type: Four


UsingHardwareAcceleration

True if the filter is using hardware acceleration.

Note: This property is read only.

Type: Bool


LeftMargin

Left margin of the region of interest.

Positive value measured in pixels from the left edge of the frame.

Type: Int32


RightMargin

Right margin of the region of interest.

Positive value measured in pixels from the right edge of the frame.

Type: Int32


TopMargin

Top margin of the region of interest.

Positive value measured in pixels from the top edge of the frame.

Type: Int32


BottomMargin

Bottom margin of the region of interest.

Positive value measured in pixels from the bottom edge of the frame.

Type: Int32


Dolby Vision Analyzer [dvan]

Properties:

OutputFormat

Four character code that specifies the output video stream format

Type: Four


UsingHardwareAcceleration

True if the filter is using hardware acceleration.

Note: This property is read only.

Type: Bool


Content

Sets the L11 content.

Note: Default is DefaultContent.

This property is ignored unless XmlVersion is set to XML_5_0_1.

Type: ContentType


XmlVersion

Sets the DolbyVision XML version.

If set to XML_4_0_2 the level 11 metadata will be ignored since this is only supported in XML version 5.1.0 and above.

Note: Default is XML_4_0_2.

Type: XmlVersionType


MasteringDisplay

Sets the mastering display type.

The mastering display chromaticity and luminance values are always determined by the HDR properties extension. If the property extensions are not available this property determines the mastering display values. If left unset, a 1000 nit BT-2020 display will be assumed.

Type: Int32


TemporalFilterHalfWindowSize

Set temporal filter half-window size in seconds. Minimum size is 2.

If set below 2 then temporal filtering will be disabled.

Note: Default is 2.

Type: Int32


WhitePoint

Sets the L11 white point.

Note: Default is WHITE_POINT_10254K.

This property is ignored unless XmlVersion is set to XML_5_0_1.

Type: WhitePointType


Threads

Specifies the number of threads to use.

Set to -1 to use as many threads as cores. Set to 0 to disable threading.

Defaults to -1.

Type: Int32


Enumerations:

ContentType

Property values for Content.

Value Name Description

XmlVersionType

Property values for XmlVersion.

Value Name Description
0 XML_4_0_2 DolbyVision XML version 4.0.2
1 XML_5_1_0 DolbyVision XML version 5.1.0

MasteringDisplayType

Predefined mastering dislpay values.

Value Name Description
0 MASTER_4000NIT_P3D65 Luminance range: 0.005 to 4000
1 MASTER_4000NIT_BT2020 Luminance range: 0.005 to 4000
2 MASTER_1000NIT_P3D65 Luminance range: 0.0001 to 4000
3 MASTER_1000NIT_BT2020 Luminance range: 0.0001 to 4000

WhitePointType

Property values for WhitePoint.

Value Name Description

Interlacing Detection Analyzer [idan]

Properties:

OutputFormat

Four character code that specifies the output video stream format

Type: Four


UsingHardwareAcceleration

True if the filter is using hardware acceleration.

Note: This property is read only.

Type: Bool


LeftMargin

Left margin of the region of interest.

Positive value measured in pixels from the left edge of the frame.

Type: Int32


RightMargin

Right margin of the region of interest.

Positive value measured in pixels from the right edge of the frame.

Type: Int32


TopMargin

Top margin of the region of interest.

Positive value measured in pixels from the top edge of the frame.

Type: Int32


BottomMargin

Bottom margin of the region of interest.

Positive value measured in pixels from the bottom edge of the frame.

Type: Int32


Letterbox Detection Analyzer [ldan]

Properties:

OutputFormat

Four character code that specifies the output video stream format

Type: Four


UsingHardwareAcceleration

True if the filter is using hardware acceleration.

Note: This property is read only.

Type: Bool


Level Gamut Analyzer [lgan]

Properties:

OutputFormat

Four character code that specifies the output video stream format

Type: Four


UsingHardwareAcceleration

True if the filter is using hardware acceleration.

Note: This property is read only.

Type: Bool


Light Level Analyzer [llan]

Properties:

OutputFormat

Four character code that specifies the output video stream format

Type: Four


UsingHardwareAcceleration

True if the filter is using hardware acceleration.

Note: This property is read only.

Type: Bool


MaxCLL

The maximum content light level.

Determines the current maximum content light level in nits (cd / m^2). This property can be read from the filter at any point.

See CTA-861.3-A.

Note: This property is read only.

Type: Float


LeftMargin

The left margin offset.

Specifies the margin offset from the left edge of the frame in pixels. The margins indictate the active area over which light levels are measured.

Note: Defaults to 0.

Type: Int32


MaximumLightLevel

Maximum pixel light level within the active area in candellas per square meter.

Determines the maximum light level in nits (cd / m^2). This property can be read from the output sample.

See CTA-861.3-A.

Note: This property is read only.

Type: Float


RightMargin

The right margin offset.

Specifies the margin offset from the right edge of the frame in pixels. The margins indictate the active area over which computations are made.

Note: Defaults to 0.

Type: Int32


AverageLightLevel

Average frame light level within the active area in candellas per square meter.

Determines the average light level in nits (cd / m^2). This property can be read from the output sample.

See CTA-861.3-A.

Note: This property is read only.

Type: Float


TopMargin

The top margin offset.

Specifies the margin offset from the top edge of the frame in pixels. The margins indictate the active area over which computations are made.

Note: Defaults to 0.

Type: Int32


MaxFALL

The maximum frame average light level.

Determines the current maximum frame average light level in nits (cd / m^2). This property can be read from the filter at any point.

See CTA-861.3-A.

Note: This property is read only.

Type: Float


BottomMargin

The bottom margin offset.

Specifies the margin offset from the bottom edge of the frame in pixels. The margins indictate the active area over which computations are made.

Note: Defaults to 0.

Type: Int32


Macroblock Detection Analyzer [mdan]

Properties:

OutputFormat

Four character code that specifies the output video stream format

Type: Four


UsingHardwareAcceleration

True if the filter is using hardware acceleration.

Note: This property is read only.

Type: Bool


LeftMargin

Left margin of the region of interest.

Positive value measured in pixels from the left edge of the frame.

Type: Int32


RightMargin

Right margin of the region of interest.

Positive value measured in pixels from the right edge of the frame.

Type: Int32


TopMargin

Top margin of the region of interest.

Positive value measured in pixels from the top edge of the frame.

Type: Int32


BottomMargin

Bottom margin of the region of interest.

Positive value measured in pixels from the bottom edge of the frame.

Type: Int32


Optical Flow Analyzer [ofan]

Properties:

OutputFormat

Four character code that specifies the output video stream format

Type: Four


UsingHardwareAcceleration

True if the filter is using hardware acceleration.

Note: This property is read only.

Type: Bool


DeviceIndex

Represents the device index to use.

If the compute mode indicates either GPU, OpenCL, Cuda, or Metal, this determines the device to use.

Note: type: Int32


ComputeMode

Determines the mode of computation.

This property is used to select which mode of computation to use.

If any GPU compute mode is specified, use the DeviceIndex property to determine which device to use when more than one is pressent.

Note: type: ComputeModes


GridSize

The grid size for the optical flow calculations.

Note: Defaults to 4.

Type: Int32


PerformanceLevel

The performance level for the optical flow calculations.

Note: Defaults to Medium.

Type: PerformanceLevelType


Enumerations:

ComputeModes

Valid values for the ComputeMode property.

Value Name Description
0 CPU CPU computation mode
1 GPU GPU computation mode. Selects metal on OSX and CUDA on Windows/Linux.
3 OpenCL OpenCL computation mode
2 Cuda Cuda computation mode
4 Metal Metal computation mode

PerformanceLevelType

Valid values for PerformanceLevel

Value Name Description
5 Slow Slow perf level results in lowest performance and best quality
10 Medium Medium perf level results in low performance and medium quality.
20 Fast Fast perf level results in high performance and low quality.

Psnr Analyzer [psnr]

Properties:

OutputFormat

Four character code that specifies the output video stream format

Type: Four


UsingHardwareAcceleration

True if the filter is using hardware acceleration.

Note: This property is read only.

Type: Bool


LeftMargin

Left margin of the region of interest.

Positive value measured in pixels from the left edge of the frame.

Type: Int32


RightMargin

Right margin of the region of interest.

Positive value measured in pixels from the right edge of the frame.

Type: Int32


Psnr

The Peak Signal to Noise Ratio (PSNR) of the two frames.

This property will be set on the analysis sample by the analyzer. A value of INFINITY indicates identical frames.

Type: Double


TopMargin

Top margin of the region of interest.

Positive value measured in pixels from the top edge of the frame.

Type: Int32


BottomMargin

Bottom margin of the region of interest.

Positive value measured in pixels from the bottom edge of the frame.

Type: Int32


GlobalPsnr

The Peak Signal to Noise Ratio (PSNR) of all frames.

This property will be set on the analysis sample by the analyzer. A value of INFINITY indicates all frame are identical.

The global PSNR is only calculated for frames that are not identical.

Type: Double


AveragePsnr

The average Peak Signal to Noise Ratio (PSNR) of all frames.

This property will be set on the analysis sample by the analyzer. A value of INFINITY indicates all frame are identical.

The average PSNR is only calculated for frames that are not identical.

Type: Double


Quality Index Analyzer [qian]

Properties:

OutputFormat

Four character code that specifies the output video stream format

Type: Four


UsingHardwareAcceleration

True if the filter is using hardware acceleration.

Note: This property is read only.

Type: Bool


LeftMargin

Left margin of the region of interest.

Positive value measured in pixels from the left edge of the frame.

Type: Int32


RightMargin

Right margin of the region of interest.

Positive value measured in pixels from the right edge of the frame.

Type: Int32


BottomMargin

Bottom margin of the region of interest.

Positive value measured in pixels from the bottom edge of the frame.

Type: Int32


TopMargin

Top margin of the region of interest.

Positive value measured in pixels from the top edge of the frame.

Type: Int32


Scene Change Analyzer [scha]

Properties:

OutputFormat

Four character code that specifies the output video stream format

Type: Four


UsingHardwareAcceleration

True if the filter is using hardware acceleration.

Note: This property is read only.

Type: Bool


LeftMargin

Left margin of the region of interest.

Positive value measured in pixels from the left edge of the frame.

Type: Int32


RightMargin

Right margin of the region of interest.

Positive value measured in pixels from the right edge of the frame.

Type: Int32


TopMargin

Top margin of the region of interest.

Positive value measured in pixels from the top edge of the frame.

Type: Int32


BottomMargin

Bottom margin of the region of interest.

Positive value measured in pixels from the bottom edge of the frame.

Type: Int32


Motion

The ammount motion detected from the previous frame.

This property will be added to the output sample from the analyzer. The client is responsible for determining what conditions imply a scene change.

Type: Int32


Slate Detection Analyzer [slat]

Properties:

OutputFormat

Four character code that specifies the output video stream format

Type: Four


UsingHardwareAcceleration

True if the filter is using hardware acceleration.

Note: This property is read only.

Type: Bool


TopMargin

Top margin of the region of interest.

Positive value measured in pixels from the top edge of the frame.

Type: Int32


LeftMargin

Left margin of the region of interest.

Positive value measured in pixels from the left edge of the frame.

Type: Int32


RightMargin

Right margin of the region of interest.

Positive value measured in pixels from the right edge of the frame.

Type: Int32


BottomMargin

Bottom margin of the region of interest.

Positive value measured in pixels from the bottom edge of the frame.

Type: Int32


Ssim Analyzer [ssim]

Properties:

OutputFormat

Four character code that specifies the output video stream format

Type: Four


UsingHardwareAcceleration

True if the filter is using hardware acceleration.

Note: This property is read only.

Type: Bool


TopMargin

Top margin of the region of interest.

Positive value measured in pixels from the top edge of the frame.

Note: Defaults to the top margin of the clean aperture.

Type: Int32


LeftMargin

Left margin of the region of interest.

Positive value measured in pixels from the left edge of the frame.

Note: Defaults to the left margin of the clean aperture.

Type: Int32


RightMargin

Right margin of the region of interest.

Positive value measured in pixels from the right edge of the frame.

Note: Defaults to the right margin of the clean aperture.

Type: Int32


BottomMargin

Bottom margin of the region of interest.

Positive value measured in pixels from the bottom edge of the frame.

Note: Defaults to the bottom margin of the clean aperture.

Type: Int32


StepSize

Adjusts the ganularity of the SSim calculation.

SSim is the convolution of an 8x8 window over the reference and analysis frames. This property changes the step size between window calculations. For example, rather than calculate the SSim over ever 8x8 block, setting a value of 2 will effectively skip every other horizontal and vertical block. This would result in roughly one quarter the computation time while sacrificing accuracy.

Note: Defaults to 1.

Type: Int32


AverageSsim

Average structural similarity for all frames.

Note: Propety is set on the last analysis sample.

Type: Double


Ssim

structural similarity for the current frames.

Note: Propety is set on the current analysis sample.

Type: Double


Ssim Wave Analyzer [ssmw]

Properties:

OutputFormat

Four character code that specifies the output video stream format

Type: Four


UsingHardwareAcceleration

True if the filter is using hardware acceleration.

Note: This property is read only.

Type: Bool


Telecine Cadence Analyzer [tcan]

Properties:

OutputFormat

Four character code that specifies the output video stream format

Type: Four


UsingHardwareAcceleration

True if the filter is using hardware acceleration.

Note: This property is read only.

Type: Bool


Telecine Detection Analyzer [tdan]

Properties:

OutputFormat

Four character code that specifies the output video stream format

Type: Four


UsingHardwareAcceleration

True if the filter is using hardware acceleration.

Note: This property is read only.

Type: Bool


Video Histogram Analyzer [vhst]

Properties:

OutputFormat

Four character code that specifies the output video stream format

Type: Four


UsingHardwareAcceleration

True if the filter is using hardware acceleration.

Note: This property is read only.

Type: Bool


Histogram

Histogram of the RGB components.

This property can be found on the output samples delivered by this analyzer. The variant array should contain 3 elements, each represents the histogram array for the RGB component. Each component histogram array should have #ref Buckets elements.

Type: VariantArray


LeftMargin

Left margin of the region of interest.

Positive value measured in pixels from the left edge of the frame.

Type: Int32


Buckets

The number of buckts in each histogram.

Type: Int


RightMargin

Right margin of the region of interest.

Positive value measured in pixels from the right edge of the frame.

Type: Int32


BottomMargin

Bottom margin of the region of interest.

Positive value measured in pixels from the bottom edge of the frame.

Type: Int32


TopMargin

Top margin of the region of interest.

Positive value measured in pixels from the top edge of the frame.

Type: Int32


DeviceIndex

Represents the GPU device to use.

If the compute mode indicates a GPU mode, this determines the device to use.

Note: Defaults to the first valid device.

Type: Int32


ComputeMode

Determines the mode of computation.

This property is used to select which mode of computation to use.

If a GPU compute mode is specified, use the DeviceIndex property to determine which device to use when more than one is pressent.

Note: Defaults to CM_CPU.

Type: COMPUTE_MODE


HistogramMode

This histogram mode to use.

Individual components, or 2D (chroma for Vectorscope).

Type: HISTOGRAM_MODE


Enumerations:

COMPUTE_MODE

Valid values for the ComputeMode property.

Value Name Description
1 CM_CPU Host CPU
2 CM_OPENCL OpenCL
4 CM_METAL Metal
3 CM_CUDA Cuda
5 CM_D3D12 D3D12

HISTOGRAM_MODE

Valid values for the ComputeMode property.

Value Name Description
1 HM_COMPONENTS Components
2 HM_2D 2d