Video Converters

Halide Deinterlacer Converter (Deprecated) [hdic]

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

FieldOrder

The output field order.

When reinterlacing this property determins the output field order. By default the converter will choose to make progressive output.

See Also: CVideoProperties

Type: Int32

DeinterlaceMode

The deinterlace mode.

Type: DeinterlaceModes

Enumerations:

ComputeModes

Valid values for the ComputeMode property.

DeinterlaceModes

Valid values for the DeinterlaceMode property.

Deinterlacer Converter [vdic]

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

FieldOrder

The output field order.

When reinterlacing this property determins the output field order. By default the converter will choose to make progressive output.

See Also: CVideoProperties

Type: Int32

DeinterlaceMode

The deinterlace mode.

Type: DeinterlaceModes

Enumerations:

ComputeModes

Valid values for the ComputeMode property.

DeinterlaceModes

Valid values for the DeinterlaceMode property.

InSync Frame Former Converter [iffc]

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

TimeScale

Sets the time scale of an output frame.

Type: Int32

ColorPrimaries

Sets the output color space.

Only BT.709, PQ, HLG, and SLog3 are supported.

Type: Int32

Threads

The number of threads the filter should use.

Type: Int

CpuAffinity

Restrict the use of cpu cores to the supplied cpu core indicies.

For example, to run only on the 1st, 3rd, and 9th cores set [0, 2, 8]. All accessible cpu cores will be used if this property is not specified.

Type: VariantArray of Integer

Width

Sets the width of the output video frame, in pixels.

Type: Int32

ScaleAdjustment

Applies a small scale adjustment to the RGB channels.

The valid range for this control is [0.7. 1.3]. It is recommended to leave it at the default value of unity.

Type: Float

FrameDuration

Sets the frame duration of an output frame.

Type: Int32

Height

Sets the height of the output video frame, in pixels.

Type: Int32

DisplayMappingMethod

Sets the display mapping method used by the conversion.

Note this only affects conversions involving PQ or highlight expansion.

Note: The default value is COLOUR_METHOD_RGB.

Type: ColorMethod

TransferCharacteristics

Sets the output transfer characteristics (the opto-electro transfer function (OETF) and electro-optical transfer function (EOTF)).

Only BT.709, PQ, HLG, and SLog3 are supported.

Type: Int32

FieldOrder

Sets the field order of an output frame.

See Also: CVideoProperties::SetFieldOrder

Type: Int32

InputCadenceMode

Sets the cadence modulation mode of the input.

This parameter is optional. If it isn’t specified, then cadence modulation is disabled entirely. The value \c CADENCE_AUTO only makes sense for an input format, and enables automatic cadence detection.

Type: Int32

InputCadencePhase

Sets the cadence modulation mode of the input.

This parameter is optional. If it isn’t specified, then cadence modulation is disabled entirely. The value \c CADENCE_AUTO only makes sense for an input format, and enables automatic cadence detection. To select a specific cadence mode, but enable autodetection of phase, pass -1 as the \p InputCadencePhase argument.

Type: Int32

OutputCadenceMode

Sets the cadence modulation mode of the output.

This parameter is optional. If it isn’t specified, then cadence modulation is disabled entirely. The value \c CADENCE_AUTO only makes sense for an input format, and enables automatic cadence detection. If selected as an output format, it produces the same effect as \c CADENCE_NONE.

Type: Int32

HorizontalPixelAspectRatio

Specifies the horizontal pixel aspect ratio of the video.

By default the horizontal pixel aspect ratio will be the same as the input. This property allows the client to specify a new horizontal pixel aspect ratio.

Note: Defaults to the input horizontal pixel aspect ratio.

Type: Int32

OutputCadencePhase

Sets the cadence modulation mode of the input.

This parameter is optional. If it isn’t specified, then cadence modulation is disabled entirely. The value \c CADENCE_AUTO only makes sense for an input format, and enables automatic cadence detection. If selected as an output format, it produces the same effect as \c CADENCE_NONE.

Type: Int32

DisplayMapping

Sets the display mapping options used by the conversion.

Note not all conversion types can use all display mapping techniques.

Type: DisplayMapping

HorizontalAspect

Sets the horizontal aspect ratio adjustment.

Modifies the aspect ratio of the output. This parameter acts as a horizontal scale (i.e. a \p HorizontalScale of 1 means the aspect ratio of the resultant video will exactly match the width of the specified output format).

Type: Float

GammaAdjustment

Applies a small gamma adjustment to the RGB channels.

The valid range for this control is [-0.2. +0.2]. It is recommended to leave it at the default value of zero.

Note: Default is 0

Type: Float

Scale

Set the isotropic scale.

Scale the output video equally in both dimensions. Sets the dimensions of the output video as a ratio of the output format’s size (i.e. a \p Scale of 1 will precisely fill the output in both dimensions, and a \p Scale of 1/2 will produce a width/2 × height/2 video). This parameter has a default value of 1.

Type: Float

HorizontalOffset

Sets the horizontal offset.

Sets the horizontal position of the output video as a ratio of the output format’s width. An offset of 0 centers the video horizontally in the output.

Note: This parameter has a default value of 0.

Type: Float

VerticalOffset

Sets the vertical offset.

Sets the vertical position of the output video as a ratio of the output format’s height. An offset of 0 centers the video vertically in the output.

Note: This parameter has a default value of 0.

Type: Float

VerticalPixelAspectRatio

Specifies the vertical pixel aspect rati˙o of the video.

By default the vertical pixel aspect ratio will be the same as the input. This property allows the client to specify a new vertical pixel aspect ratio.

Note: Defaults to the input vertical pixel aspect ratio.

Type: Int32

MinimumAutoCadenceProgressiveFramesPerSecond

Sets the minimum input progressive frame rate permitted to undergo automatic cadence detection. The applicable frame rate for interlaced inputs is always half the progressive rate. Sources with a lower frame rate will not automatically detect cadence.

Note: The default minimum rate is 50 progressive frames per second.

Type: Int

MotionCompoenstionAttenuation

Sets the degree of motion compensation attenuation when performing frame-rate conversion.

By default picture elements are fully motion compensated by their measured motion. Setting this control to a value greater than 0 and less than or equal to 1, progressively scales back from full to no motion compensation. Ordinarily this control should be left at its default of 0.

Note: Default is 0

Type: Float

HorizontalResolution

Override the horizontal resolution.

Reducing the resolution can be used to soften an image while increasing the resolution can potentially be used to sharpen it (at the expense of increasing aliasing). Note the outputs may only appear sharper where the default aperture is performing some band- limiting, otherwise no effect will be observed (for example, when up-converting).

It is expected that this control will only be used to adjust the resolution by a small amount and so the value will not differ far from unity.

Type: Float

VerticalResolution

Override the vertical resolution.

Reducing the resolution can be used to soften an image while increasing the resolution can potentially be used to sharpen it (at the expense of increasing aliasing). Note the outputs may only appear sharper where the default aperture is performing some band- limiting, otherwise no effect will be observed (for example, when up-converting).

This control can be used to further reduce the permitted degree of twitter in interlaced output.

It is expected that this control will only be used to adjust the resolution by a small amount and so the value will not differ far from unity.

Type: Float

InputMaxLuminance

Sets the maximum luminance (white level) for the input display, specified in candelas per square metre (nits).

Note not all conversion types actually use the input luminance parameter. It is currently only used by the following conversions:

• PQ to SDR
• PQ to HLG

Type: Float

OutputMaxLuminance

Sets the maximum luminance (white level) for the output display, specified in candelas per square metre (nits).

Note not all conversion types actually use the output luminance parameter. It is currently only used by the following conversions:

• PQ to PQ
• SLog3 to PQ

Type: Float

EnableSceneReferencedConversion

When true, conversions are scene-referred rather than display-referred.

A scene referred conversion applies the inverse OETF of the source display and then the OETF of the target display. Transformations such as color-space changes are done in scene-light. By contrast, a display-referred conversion applies the EOTF of the source display followed by the inverse EOTF of the target display, with transformations being done in display-light. This setting is disabled by default, so conversions are display-referred.

Type: Bool

ExpandHighlightsThreshold

Sets the threshold above which highlight expansion is applied.

This setting is only used when the display mapping is set to DISPLAY_MAPPING_EXPAND_HIGHLIGHTS. The valid range is [0.2, 0.8]. Recommended values for varying amounts of highlight expansion are:

Note: Default value is 0.7.

Type: Float

IntraframeConcurrency

Permits the explicit manual control over the number of processing threads that may be allocated to compute the result of a single plane of converted output.

This value is set automatically but may be controlled manually to fine tune the performance of a given system. The degree of intra-frame concurrency can impact the minimum conversion latency.

Type: Int

ExpandHighlightsGain

Sets the gain used for highlight expansion (units are arbitrary).

This setting is only used when the display mapping is set to DISPLAY_MAPPING_EXPAND_HIGHLIGHTS. The valid range is [1.0, 4.0]. Recommended values for varying amounts of highlight expansion are:

Note: Default value is 1.5.

Type: Float

TemporalConversionMode

Selects the method used to generate output frames which are not aligned with a temporal sample in the input.

Type: ConversionMode

GammaAdjustmentMethod

Sets the gamma adjustment method used by the conversion.

Note: The default value is COLOUR_METHOD_RGB.

Type: ColorMethod

SdrTransferFunction

Selects the opto-electric transfer function used for scene- referred conversions involving SDR.

Note: The default value is SDR_OE_BT_709_EXACT.

Type: SDR_OETF

TemporalScaleFactor

Sets the temporal scale factor.

Sets the factor by which output time is scaled relative to input time as a rational number.

This parameter can not be changed for live conversions. It must be left in its default state of 1/1.

Type: Float

FirstOutputFrame

Sets the frame number of the first output frame to generate.

This parameter allows segmenting a conversion into multiple partial conversions, which can then be combined later.

Note: This parameter has a default value of 0.

Type: Int

EnableSoftSync

Controls whether the soft synchronise function is enabled.

This function ensures the best possible conversion result when the difference in source and output temporal rates is very small: e.g. 59.94 to 60.00 fps. Under these circumstances the period of sustained temporal interpolation may by limited to a fixed value with no compromise to the output quality. The maximum (sustained) interpolated duration is set by SoftSyncMid.

Type: Bool

SoftSyncDuration

When EnableSoftSync is true, this value defines the maximum (sustained) interpolated duration as a value of absolute time in units of milliseconds.

Type: Int

EnableSoftFrameSync

When EnableSoftSync is true, this control enables a soft interlaced-frame-aware synchronisation, when applicable i.e. it will only affect conversions between interlaced sources to interlaced outputs which maintain identical frame dimensions.

This mechanism allows original interlaced frames to be passed transparently from source to output when using the soft synchronise feature to prevent unnecessary temporal conversion.

Type: Bool

EnableIntraFrameCuts

Permits native interlaced frames to contain fields from two different shots. Such intra-frame cuts are not enabled by default.

Note such intra-frame cuts are automatically enabled when generating output cadence.

Type: Bool

EnableBlankingDetection

Permits the automatic detection of blanked regions in the input.

These are used to restrict motion-compensated interpolation and preserve blank regions in the output. This feature is enabled by default.

Type: Bool

BidirectionalInterpolationAmount

Sets the degree of bidirectional interpolation when performing frame-rate conversion.

By default outputs are interpolated unidirectionally i.e. they are derived as exclusively as possible from a preceding or a succeeding field/frame. Setting this control to a value greater than 0 and less than or equal to 1, progressively increases the use of a preceding and succeeding field/frame. This mode of interpolation can yield a subjectively preferable result to the interpolation.

Type: Float

EnableChromaAnalysis

Permits the analysis of chrominance when measuring the inter-field difference metric used by cadence and shot change detection.

Note this should not be used on sources where misaligned chrominance exists (a known problem in some decoders for 4:2:0 sampled chroma). This feature is disabled by default.

Type: Bool

AbsoluteInterpolationOffset

Sets an absolute interpolation offset.

By default the interpolation of first output temporal sample is aligned to be temporally coincident with the first input temporal sample. A temporal sample is a frame for progressive standards and a field for interlaced standards). This control allows the alignment of all output samples to be temporally offset. Ordinarily this control should be left at its default of 0.

Note: Default is 0.

Type: Float

QuantizationMode

Sets the method used to quantize the conversion of the total input duration to an integer number of interpolated output frames.

Note: The default mode is QUANTISATION_MODE_EXC_CEIL.

Type: QuantizationMode

MinimumMotionCompensatedProgressiveFramesPerSecond

Sets the minimum input progressive frame rate permitted to undergo motion compensated interpolation. This may be a native progressive frame rate or the frame rate obtained after cadence removal. The applicable frame rate for interlaced inputs is always half the progressive rate.

Note: The default minimum rate is 18 progressive frames per second.

Type: Int

EnableLiveConversion

Sets the converter to perform a live conversion instead of an offline conversion.

When performing a live conversion the converter may occasionally make concessions to the quality of output frames in order to meet the real-time constraint.

Type: Bool

MaximumSupportedLatency

@note Defaults to 5000ms.

@type Int

Enumerations:

DisplayMapping

Provides control over the mapping between different dynamic ranges (for the limited set of conversions for which such control is currently possible).

ColorMethod

Controls whether certain color transforms are applied to the R, G and B channels separately, or whether a common scaling factor is applied to all channels based on the luninance.

SDR_OETF

Selects the opto-electrical transfer function used for scene- referred conversions involving SDR.

Cadence

Selects the cadence mode of an input or output video format.

ConversionMode

Selects the method used to generate output frames which are not aligned with a temporal sample in the input.

QuantizationModeType

Selects the method used to quantize the conversion of the total input duration to an integer number of interpolated output frames. The total duration of the set of input frames from which output frames may be interpolated may be set to include the duration of the last input frame (LIF) or exclude it. Note output frames obtained from the last input frame’s duration can not be interpolated due to the absence of any further input frames. In addition, the interpolated duration may be treated as a half- closed interval (HC) which excludes output’s coincident with the durations end point (i.e. the start of the next input)

Frame Rate Converter [vfrc]

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

FrameDuration

Frame duration of output frame rate.

Type: Int64

TimeScale

Time scale of output frame rate.

Type: Int64

Mode

Frame rate conversion mode.

Type: ConversionMode

Strength

Motion search strength.

Type: SearchStrength

Enumerations:

ConversionMode

Frame rate conversion mode

SearchStrength

Frame rate conversion search strength

Picture Correction Converter [picc]

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

Resize Converter [vrc ]

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

RightCrop

Specifies the right edge of the cropping rectangle.

The cropping rectangle is specified as the number of pixels from the edge of the input frame.

Note: Defaults to 0.

Type: Int32

Width

Specifies the width of the video.

By default the width will be the same as the input. This property allows the client to specify a new width.

The pixel aspect ratio will be updated automatically to preserve the display aspect ratio of the source.

Note: Defaults to the input width.

Type: Int32

BottomAperture

Specifies the size of the clean aperture below the displayed content.

The aperture rectangle is specified as the number of pixels from the edge of the output frame.

Note: Defaults to 0.

Type: Int32

TopCrop

Specifies the top edge of the cropping rectangle.

The cropping rectangle is specified as the number of pixels from the edge of the input frame.

Note: Defaults to 0.

Type: Int32

BottomMask

Specifies the bottom edge of the mask rectangle.

The masking rectangle is specified as the number of pixels from the edge of the output frame.

Note: Defaults to 0.

Type: Int32

LeftCrop

Specifies the left edge of the cropping rectangle.

The cropping rectangle is specified as the number of pixels from the edge of the input frame.

Note: Defaults to 0.

Type: Int32

ResizeMode

Specifies the interpolation mode for resizing.

Note: Defaults to Lanczos.

Type: Interpolation

PixelAspectRatioX

Specifies the horizontal pixel aspect ratio of the video.

By default the horizaontal pixel aspect ratio will be the same as the input. This property allows the client to specify a new horizontal pixel aspect ratio.

The width will be updated automatically to preserve the display aspect ratio of the source.

Note: Defaults to the input horizontal pixel aspect ratio.

Type: Int32

Height

Specifies the height of the video.

By default the hegiht will be the same as the input. This property allows the client to specify a new hegiht.

The pixel aspect ratio will be updated automatically to preserve the display aspect ratio of the source.

Note: Defaults to the input height.

Type: Int32

PixelAspectRatioY

Specifies the vertical pixel aspect ratio of the video.

By default the vertical pixel aspect ratio will be the same as the input. This property allows the client to specify a new vertical pixel aspect ratio.

The height will be updated automatically to preserve the display aspect ratio of the source.

Note: Defaults to the input vertical pixel aspect ratio.

Type: Int32

BottomCrop

Specifies the bottom edge of the cropping rectangle.

The cropping rectangle is specified as the number of pixels from the edge of the input frame.

Note: Defaults to 0.

Type: Int32

LeftAperture

Specifies the size of the clean aperture to the left of the displayed content.

The aperture rectangle is specified as the number of pixels from the edge of the output frame.

Note: Defaults to 0.

Type: Int32

LeftMask

Specifies the left edge of the mask rectangle.

The masking rectangle is specified as the number of pixels from the edge of the output frame.

Note: Defaults to 0.

Type: Int32

RightMask

Specifies the right edge of the mask rectangle.

The masking rectangle is specified as the number of pixels from the edge of the output frame.

Note: Defaults to 0.

Type: Int32

TopMask

Specifies the top edge of the mask rectangle.

The masking rectangle is specified as the number of pixels from the edge of the output frame.

Note: Defaults to 0.

Type: Int32

TopAperture

Specifies the size of the clean aperture above the displayed content.

The aperture rectangle is specified as the number of pixels from the edge of the output frame.

Note: Defaults to 0.

Type: Int32

RightAperture

Specifies the size of the clean aperture to the right of the displayed content.

The aperture rectangle is specified as the number of pixels from the edge of the output frame.

Note: Defaults to 0.

Type: Int32

Enumerations:

ComputeModes

Valid values for the ComputeMode property.

Interpolation

Valid values for the ResizeMode property.

Bitmap Overlay Converter [bmoc]

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

OverlayHeight

Height in pixels of bitmap used by overlay converter

Type: Int32

OverlayMode

Approach used to overlay the bitmap

Type: OverlayModeType

OverlayAlpha

Alpha blending value used by the converter

Type: Float

OverlayWidth

Width in pixels of bitmap used by overlay converter

Type: Int32

BitmapReference

Bitmap used by video overlay converter

Type: CByteArray

OverlayPosX

X coordinate of bitmap position used by overlay converter

Type: Int32

OverlayPosY

Y coordinate of bitmap position used by overlay converter

Type: Int32

Enumerations:

OverlayModeType

Overlay modes.

Video Overlay Converter [vovc]

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

VideoOverlays

Video overlays

Type: VariantArray

Bottom

Y coordinate of bottom bitmap position.

Type: Int32

Top

Y coordinate of top bitmap position.

Type: Int32

Bitmap

Bitmap used by video overlay converter

Type: RByteArray

Left

X coordinate of left bitmap position.

Type: Int32

OverlayAnalysis

Include overlays derived from analyzers

Note: Defaults to false.

Type: Bool

OverlayExtensions

Include overlays derived from container extensions

Note: Defaults to false.

Type: Bool

Right

X coordinate of right bitmap position.

Type: Int32

Video Properties Converter [vpc ]

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

BitRate

The bit rate to be reflected on the output properties.

See Also: CMediaProperties

Type: Int64

MasteringDisplayColorPrimaries

The display primaries and white point: BT2020, P3D65 or P3DCI.

Setting this property will add an CHdrProperties extension to the output propertes.

Type: Int, see ColorPrimaries.

HorizontalPixelAspectRatio

The horizontal pixel aspect ratio to be reflected on the output properties.

See Also: CVideoProperties

Type: Int32

Format

The format to be reflected on the output properties.

See Also: CMediaProperties

Type: Four

MediaProperties

The properties collection to set on the output media properties.

Each property in the collection will be set as named property on the output media properties.

Note: Defaults to nullptr.

Type: CProperties

VerticalPixelAspectRatio

The vertical pixel aspect ratio to be reflected on the output properties.

See Also: CVideoProperties

Type: Int32

RoundingMethod

The frame duration rounding method.

When converting frame durations this property determines how new durations will be calculated if rounding should occur.

Note: Defaults to Nearest.

Type: RoundingMethods

Width

The width to be reflected on the output properties.

See Also: CVideoProperties

Type: Int32

Language

The language to be reflected on the output properties.

See Also: CMediaProperties

Type: UInt16 or String

Region

The region to be reflected on the output properties.

See Also: CMediaProperties

Type: UInt16 or String

Duration

The media duration to be reflected on the output properties.

See Also: CMediaProperties

Type: Int64

FrameDuration

The frame duration to be reflected on the output properties.

Additionally each sample will reflect the frame duration.

See Also: CVideoProperties

Type: Int32

TimeScale

The time scale to be reflected on the output properties.

See Also: CVideoProperties

Type: Int32

FieldOrder

The field order to be reflected on the output properties.

See Also: CVideoProperties

Type: Int32

Height

The height to be reflected on the output properties.

See Also: CVideoProperties

Type: Int32

MatrixCoefficients

The matrix coefficients of the color-space to be reflected on the output properties.

See Also: CVideoProperties

Type: Byte

MaxCLL

Maximum content light level in candellas per square meter.

Setting this property will add an CHdrProperties extension to the output propertes.

See CTA-861.3-A.

Type: Int

ColorPrimaries

The color primaries of the color-space to be reflected on the output properties.

See Also: CVideoProperties

Type: Byte

TransferCharacteristics

The transfer characteristics of the color-space to be reflected on the output properties.

See Also: CVideoProperties

Type: Byte

ReferenceBlackLevel

The normalized [0-1] reference black level at 0% reflectivity to be reflected on the output properties.

Type: Float

ReferenceWhiteLevel

The normalized [0-1] reference white level at 100% reflectivity to be reflected on the output properties.

Type: Float

VideoRange

The video range to be reflected on the output properties.

See Also: CVideoProperties

Type: Byte or Array

BitDepth

The bit dpeth to be reflected on the output properties.

See Also: CVideoProperties

Type: Int32

Orientation

The orientation to be reflected on the output properties.

See Also: CVideoProperties

Type: Byte

Subsampling

The subsampling to be reflected on the output properties.

See Also: CVideoProperties

Type: Byte

ChromaSiting

The chroma location to be reflected on the output properties.

See Also: CVideoProperties

Type: Byte

MaxFALL

Maximum frame average light level in candellas per square meter.

Setting this property will add an CHdrProperties extension to the output propertes.

See CTA-861.3-A.

Type: Int

MasteringDisplayMaxLuminance

Maximum display luminance in candellas per square meter.

Setting this property will add an CHdrProperties extension to the output propertes.

Type: Float

MasteringDisplayMinLuminance

Minimum display luminance in candellas per square meter.

Setting this property will add an CHdrProperties extension to the output propertes.

Type: Float

Enumerations:

RoundingMethods

Frame duration rounding method.

Tachyon Dark Energy Converter [tdec]

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

ColorPrimaries

The color primaries of the output color space.

The color primaries determine the RGB->XYZ conversion matrix.

Note: Defaults to input color primaries. See the values enumerated by ColorPrimaries.

Type: Int32

AdvancedSettings

Pass-through string with temporary settings.

Type: String

MatrixCoefficients

The matrix coefficients of the output color space.

The matrix coefficients determine the YUV->RGB conversion matrix.

Note: Defaults to input matrix coeffecients. See the values enumerated by ColorSpace::MatrixCoeffients.

Type: Int32

PadOutputTop

The number output pixels to pad after scaling.

Type: Int32

FrameDuration

Nominal frame duration in timescale ticks (e.g. 1001).

Type: Int64

EnableMotionCompensation

Enables or disables motion compensated frame rate conversion.

Type: Bool

TimeScale

Stream timescale in ticks per second (e.g. 30000).

Type: Int64

Width

Frame width in pixels.

Type: Int32

DisableFrameRateConversion

Disable framerate conversion to further reduce latency and gpu buffering.

Type: Bool

Height

Frame hieght in pixels.

Type: Int32

FieldOrder

Indicates whether the frame is progressive or interlaced (upper or lower field first).

Type: Int32

TransferCharacteristics

The transfer characteristics of the output color space.

The transfer characteristics determine the non-linear electro-optical response function.

Note: Defaults to input transfer characteristics. See the values enumerated by TransferCharacteristics.

Type: Int32

SharpenAmount

Amount of sharpening to apply.

Type: SHARPEN_AMOUNT

TextureSize

Size of the simulated film grain particles.

Type: TEXTURE_SIZE

VideoRange

The video range of the output color space.

Teh video range specifies the range of values in RGB.

Note: Defaults to input video range. See the values enumerated by VideoProperties.

Type: Int32

DisableDetectors

Disable portions of the pipeline, such as scene cut detection, pulldown removal, and deinterlacing, that require significant buffering.

This is useful if you have pure progressive footage from one scene that you want to process, and you want the lowest possible latency and minimal gpu memory footprint.

Type: Bool

ResizeMode

Specifies the method used to scale the video to the output image dimensions

Type: SIZE_MODE

MotionAmount

Amount of motion compensation to use.

Type: MOTION_AMOUNT

FallbackSize

Size of fallback region

Type: FALLBACK_SIZE

MotionBlockSize

Size of the pixel blocks used for motion estimation.

Increased block size uses more information in the motion estimation; however, it can reduce the resolution of the motion vectors. Smaller blocks increase performance. Large blocks imrpove object detection.

Type: MOTION_BLOCK_SIZE

EnableOptimizeModule

Allow Tachyon to run on a low end CUDA capable GPU.

Type: Bool

ExtremeMotionAmount

Amount of motion compensation applied to high motion frames.

Type: MOTION_AMOUNT

AnchorInputIndex

Zero-based index of the anchor frame on the input stream.

Set to 0 to disable. It is undefined to set AnchorInputIndex to 0 and not AnchorOutputIndex.

Note: Defaults to 0.

Type: Int

ExtremeFallbackSize

Size of the fallback region for high motion frames.

Type: FALLBACK_SIZE

AnchorOutputIndex

Zero-based index of the anchor frame on the Output stream.

Set to 0 to disable. It is undefined to set AnchorOutputIndex to 0 and not AnchorInputIndex.

Note: Defaults to 0.

Type: Int

ExtremeMotionBlockSize

Size of the motion estimation block for high motion frames.

Increased block size uses more information in the motion estimation; however, it can reduce the resolution of the motion vectors. Lower block sizes have higher performance.Valid values include.

Type: MOTION_BLOCK_SIZE

AllowRemovePulldown

Enables or disables inverse telecine.

This mode de-interlaces the input and converts to the output frame rate by removing duplicate fields or frames.

Type: Bool

EnablePostPulldownFilter

Applies the de-interlacing filter to frames after pulldown removal.

Type: Bool

CropInputRight

The number input pixels to crop before scaling.

Type: Int32

IsCartoon

Set to true of the pre-telecine frames are repeated as is typical in cartoon and anime content.

Type: Bool

AllowAddAdaptivePD

Adpative pulldown, similar to Euro but allows fractional in rate, for going from 24p->25i or 29p->25i uses a non - invertable changing pattern.

Type: Bool

MoreSensitiveRemovePulldown

Lowers the pulldown detection threshold.

Type: Bool

MaxDeviceMemory

Determines the maximum amount of GPU memory Tachyon is allowed to allocate.

MaxDeviceMemory is set to 0 by default, which will use all GPU memory (or as much as needed). Setting this to a value greater than zero will set the limit (in bytes) on how much GPU memory will be used. Setting this value too low may generate an ‘out of GPU memory error’.

Note: Defaults to 0.

Type: Int64

AllowAddStandardPD

3:2 (used for 23p->29i, or 24p->30i).

Type: Bool

AllowAdd2_2PD

2:2 (used for 30p->30i, or 25p->25i).

Type: Bool

AllowAdd4_4PD

4:4 (used for 30p->60p, or 25p->50p, doubles frames).

Type: Bool

CropInputLeft

The number input pixels to crop before scaling.

Type: Int32

ResampleMap

The resample map provides a mapping from input to output frames.

This property is mutually exclusive with AnchorInputIndex and AnchorOutputIndex. If both are set ResampleMap takes precedence. Each item in the array corresponds to a resampler map entry. The ‘input’ is the number of input frames that will result in ‘output’ number of output frames. If ‘input’ is 0, then ‘output’ number of black frames will be emitted. If ‘output’ is 0, then ‘input’ number of frames will be dropped. Note: these are not frame indices, but rather frame counts.

Type: CVariantArray of CProperties

CropInputBottom

The number input pixels to crop before scaling.

Type: Int32

AllowAdd4_6PD

4:6 (used for 24p->60p, repeats frames x2, then x3).

Type: Bool

PadOutputBottom

The number output pixels to pad after scaling.

Type: Int32

AllowAddEuroPD

2_2_2_2_2_2_2_2_2_2_2_3, for 24p->25i.

Type: Bool

EnableProgressiveSceneCuts

For interlaced output, the frames before and after the scene cut will be progressive.

This is helpful for editing and generating thumbnails.

Note: Enabling this may break the pulldown pattern at scene cuts.

Type: Bool

CropInputTop

The number input pixels to crop before scaling.

Type: Int32

PadOutputLeft

@brief The number output pixels to pad after scaling.

@type Int32

Input

The input property for each item in the ResampleMap array.

Note: Defaults to 0.

Type: Int

PadOutputRight

The number output pixels to pad after scaling.

Type: Int32

BrightnessAdjustment

Adjusts the brightness level.

Values should be in the range -1.0f … 1.0f.

Note: 0.0f is the default ‘no effect’ value.

Type: Float

GammaAdjustment

Adjusts the gamma level.

Values should be in the range -1.0f … 1.0f.

Note: 0.0f is the default ‘no effect’ value.

Type: Float

CutDetectionSensitivity

Smaller numbers increase the scene cut sensitivity. Typical range is 0.1 to 0.35, set to 0.0 for auto.

Note: Default value is 0.2.

Type: Float

EnableWatermark

Turn on Cinnafilm watermark on all output frames.

Type: Bool

DeviceIndex

Represents the GPU device to use.

DeviceIndex is set to -1 by default, which will automatically select the best GPU device available and exclude other Tachyon instances from running on the same device. Set this value to zero or greater to specify the index of the GPU device to use. The device index is based on the order of devices returned by a call to cudaGetDeviceProperties(). This method can be used to map multiple Tachyon instances onto a single GPU, however if Tachyon is not starved of work it typically uses 98-99% of the GPU. So mapping more than one instance onto the same GPU may degrade overall performance.

Note: Defaults to -1.

Type: Int32

DenoiseAmount

Amount of spatial/temporal noise reduction and film grain removal to apply.

Type: DENOISE_AMOUNT

TextureAmount

Amount of simulated film grain to add.

Type: TEXTURE_AMOUNT

Output

The output property for each item in the ResampleMap array.

Note: Defaults to 0.

Type: Int

SmoothSpatialAmount

Amount of spatial smoothing to apply.

Type: OPERATION_AMOUNT

DustBustAmount

Amount of dust, scratch and dropout removal to apply.

Type: DUSTBUST_AMOUNT

BasicSpatialAmount

Amount of spatial noise reduction to apply.

Type: OPERATION_AMOUNT

TextureColor

Color of the simulated film grain.

Type: TEXTURE_COLOR

EnableChromaNoiseRemoval

Enables or disables chroma noise removal.

True if CbCr channel is extremely noisy or changing excessively between fields.

Type: Bool

ContrastAdjustment

Adjusts the constrast level.

Values should be in the range -1.0f … 1.0f.

Note: 0.0f is the default ‘no effect’ value.

Type: Float

SaturationAdjustment

Adjusts the saturation level.

Values should be in the range -1.0f … 1.0f.

Note: 0.0f is the default ‘no effect’ value.

Type: Float

RedAdjustment

Adjusts the red level.

Values should be in the range -1.0f … 1.0f.

Note: 0.0f is the default ‘no effect’ value.

Type: Float

GreenAdjustment

Adjusts the green level.

Values should be in the range -1.0f … 1.0f.

Note: 0.0f is the default ‘no effect’ value.

Type: Float

BlueAdjustment

Adjusts the blue level.

Values should be in the range -1.0f … 1.0f.

Note: 0.0f is the default ‘no effect’ value.

Type: Float

Enumerations:

SIZE_MODE

ResizeMode property values.

TEXTURE_COLOR

TextureColor property values.

MOTION_AMOUNT

ExtremeMotionAmount property values.

TEXTURE_AMOUNT

TextureAmount property values.

FALLBACK_SIZE

ExtremeFallbackSize property values.

DENOISE_AMOUNT

DenoiseAmount property values.

MOTION_BLOCK_SIZE

MotionBlockSize property values.

SHARPEN_AMOUNT

SharpenAmout propertyvalues.

TEXTURE_SIZE

TextureSize property values.

DUSTBUST_AMOUNT

DustBustAmount property values.

OPERATION_AMOUNT

SmoothSpatialAmount and BasicSpatialAmount property levels.

Video Scope Converter [vscr]

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

VideoScopeMode

The scope mode.

This parameter affects which video scope mode is chosen

Note: type: VideoScopeMode

ParameterizedGraticule

The paramterized graticule.

This parameter affects whether the graticule SVG contains replaceable parameters

Note: type: Bool

Scale

The scale.

This parameter is used to scale down the output dimension by a factor of 1«(Scale-1)

Note: type: Int32

Enumerations:

VideoScopeModes

Valid values for the VideoScopeMode property.

Color Space Converter [vcsc]

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

ColorPrimaries

The color primaries of the output color space.

The color primaries determine the RGB->XYZ conversion matrix.

Note: Defaults to input color primaries. See the values enumerated by ColorPrimaries.

Type: Int32

LutFile

Filename of the input CUBE 3D lut file.

The converter will use this lut file to determine the lookup table. If LutFile is not specified, then a table will be automatically generated.

Type: String

RangeCompressionMaximum

Specifies the maximum allowed value when compressing the dynamic range.

This value is specified in normalized linear units.

The TMO for the shoulder is defined as: \f$ W + (w - W) e^\frac{x-W}{w-W}} \f$. Where, w is the starting point of the range compression for the whites and W is the maximum value to compress too. For narrow range, W is ~109%, for full range W is 100%.

Note: Default: ~1.09 for narrow range, 1.00 for full range.

Type: Float

TableSize

Specifies the number of elements in each dimension of the lookup table.

The number of elements in the table will be TableSize cubed if specified as a single integer. A value less than 1 is invalid as there must be at least 1 element in the table. If specified as an array (of 3 values) then each element of the array determines the size of the table in the red, green, and blue dimensions repsectively.

Note: Defaults to 33.

Type: Int32 or VariantArray of 3 Int32.

TransferCharacteristics

The transfer characteristics of the output color space.

The transfer characteristics determine the non-linear electro-optical response function.

Note: Defaults to input transfer characteristics. See the values enumerated by TransferCharacteristics.

Type: Int32

MatrixCoefficients

Specifies the matrix coefficients used to convert the output between YUV and RGB.

Note: Defaults to input matrix coeffecients. See the values enumerated by ColorSpace::MatrixCoeffients.

Type: Int32

ReferenceWhiteLevel

The normalized [0-1] reference white level at 100% reflectivity.

Note: Defaults to the white level determined by the output transfer characteristics.

Type: Float

VideoRange

The video range of the output color space.

The video range specifies the range of values in RGB. If specified as a lower and upper bound, then the range is set to ColorRange::Extension and the lower and upper bounds are added to the color space properties extension.

Note: Defaults to input video range. See the values enumerated by VideoRange.

Type: Int32 or an array of two elements

ReferenceBlackLevel

The normalized [0-1] reference black level at 0% reflectivity.

Note: Defaults to the black level determined by the output transfer characteristics.

Type: Float

EnableRangeCompression

Enables the tone mapping operator (TMO) to compress the luminance range.

Note: Default: true if the output dynamic range is less than 95% of the input dynamic range.

Type: Bool

RangeCompressionToe

Specifies the starting point of the range compression for the blacks.

This value is specified in normalized linear units.

For narrow range conversions the extra head room will be used for HDR by default.

The TMO for the toe is defined as: \f$ B + (b - B) e^\frac{x-B}{b-B}} \f$. Where, b is the starting point of the range compression for the blacks and B is the minimum value to compress too.

Note: Default: 0.0

Type: Float

RangeCompressionShoulder

Specifies the starting point of the range compression for the whites.

This value is specified in normalized linear units.

For narrow range conversions the extra head room will be used for HDR by default.

The TMO for the shoulder is defined as: \f$ W + (w - W) e^\frac{x-W}{w-W}} \f$. Where, w is the starting point of the range compression for the whites and W is the maximum value to compress too.

Note: Default: 1.0

Type: Float

RangeCompressionMinimum

Specifies the minimum allowed value when compressing the dynamic range.

This value is specified in normalized linear units.

The TMO for the toe is defined as: \f$ B + (b - B) e^\frac{x-B}{b-B}} \f$. Where, b is the starting point of the range compression for the blacks and B is the minimum value to compress too. For narrow range, B is ~-7%, for full range B is 0%.

Note: Default: ~-0.07 for narrow range, 0.00 for full range.

Type: Float

ForceSceneReferencedConversion

Disables the application of the Optical-Optical transfer function (OOTF).

It may be technically correct to always apply the OOTF when converting color spaces; however, convention mandates we ignore the OOTF in some cases, particularly when performing SDR to SDR conversions. For example, prior conversions from BT.709 -> BT.2020 or BT.601 -> BT.709, never acknowledged the existence of the OOTFs. So, there is strong reason to believe we should continue to ignore them as this seems to be expected.

This property has been added to override the application of the OOTF when performing a conversion. Conversions done in linear display referenced light acknowledge the OOTFs, while conversions done in linear scene referenced light do not. By default, if the system levels are changing (dynamic range compression) or the conversion is either to or from HLG, then we assume a conversion in display referenced light.

Note: Default is true.

Type: Bool

GamutCoercionMode

Specifies the method used to reduce gamut.

Converting the color primaries from a large gamut into a smaller gamut can produce illegal color values. For example, converting from BT.2020 to BT.709 may result in colors outside the BT.709 gamut. This property determines the method used to coerce the colors back to legal values.

Note: Applying a clamp may result in discontinuities in the LUT and introduce significant interpolation error. Default: None

Type: InterpolationModes

Enumerations:

ComputeModes

Valid values for the ComputeMode property.

InterpolationModes

Specifies valid values for the GamutCoercionMode property.

Video Format Converter [vfc ]

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

RoundingMode

Specifies the method used to round values to a lower bit depth.

This property is used to select which rounding mode to use when converting between formats. The rounding mode is only used when down-converting bit-depth. This property indicates what to do with the rounding error.

Note: Defaults to RM_DOWN.

Type: ROUNDING_MODE

MatrixCoefficients

Matrix coeffiencts override.

Specifies the matrix coefficients used to convert the output between YUV and RGB.

Note: The value defaults to the coefficients used in the input color space. If the input format is RGB and the output format is YUV, the default coefficients are determined by frame height.

Type: Byte

VideoRange

Specifies the output video range.

Teh video range specifies the range of values in RGB.

Note: Defaults to input video range. See the values enumerated by VideoProperties.

Type: Int32

ChromaSiting

Specifies the output chroma location.

The chroma siting specifies where the chroma planes are sampled. This typically only applies to 4:2:0 subsampling. Certain compression formats may specify explicit chroma sitings. For example, 4:2:0 PAL DV should always have a chroma siting of cosited-out-of-phase where as MPEG-1 should always be interstitial and MPEG-2 should be horizontally cosited.

Note: Defaults to cosited. See the chroma siting values enumerated by VideoProperties.

Type: Int32

ConversionStrategy

Specifies a hint to the conversion process.

This property is used to select which strategy to use when converting between formats.

Note: Defaults to CS_SPEED.

Type: CONVERSION_STRATEGY

BitDepth

The bit dpeth to be reflected on the output properties.

If set, only output formats of the specified bit depth will be reported.

Type: Int32

Subsampling

The subsampling to be reflected on the output properties.

If set, only output formats of the specified subsampling will be reported.

See Also: CVideoProperties

Type: Byte

Enumerations:

ComputeModes

Valid values for the ComputeMode property.

ROUNDING_MODE

Valid values for the RoundingMode property.

CONVERSION_STRATEGY

Valid values for the ConversionStrategy property.

Legacy Video Format Converter [lvfc]

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

RoundingMode

Specifies the method used to round values to a lower bit depth.

This property is used to select which rounding mode to use when converting between formats. The rounding mode is only used when down-converting bit-depth. This property indicates what to do with the rounding error.

Note: Defaults to RM_DOWN.

Type: ROUNDING_MODE

MatrixCoefficients

Matrix coeffiencts override.

Specifies the matrix coefficients used to convert the output between YUV and RGB.

Note: The value defaults to the coefficients used in the input color space. If the input format is RGB and the output format is YUV, the default coefficients are determined by frame height.

Type: Byte

VideoRange

Specifies the output video range.

Teh video range specifies the range of values in RGB.

Note: Defaults to input video range. See the values enumerated by VideoProperties.

Type: Int32

ChromaSiting

Specifies the output chroma location.

The chroma siting specifies where the chroma planes are sampled. This typically only applies to 4:2:0 subsampling. Certain compression formats may specify explicit chroma sitings. For example, 4:2:0 PAL DV should always have a chroma siting of cosited-out-of-phase where as MPEG-1 should always be interstitial and MPEG-2 should be horizontally cosited.

Note: Defaults to cosited. See the chroma siting values enumerated by VideoProperties.

Type: Int32

ConversionStrategy

Specifies a hint to the conversion process.

This property is used to select which strategy to use when converting between formats.

Note: Defaults to CS_SPEED.

Type: CONVERSION_STRATEGY

BitDepth

The bit dpeth to be reflected on the output properties.

If set, only output formats of the specified bit depth will be reported.

Type: Int32

Subsampling

The subsampling to be reflected on the output properties.

If set, only output formats of the specified subsampling will be reported.

See Also: CVideoProperties

Type: Byte

Enumerations:

ComputeModes

Valid values for the ComputeMode property.

ROUNDING_MODE

Valid values for the RoundingMode property.

CONVERSION_STRATEGY

Valid values for the ConversionStrategy property.

Libav Video Converter [ffVF]

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

FilterGraph

Specification of the libavfilter filtergraph.

Libavfilter uses the notion of a filtergraph to refer to a directed graph of filters that processes media frames. The format of the filtergraph specification can be found in FFmpeg’s documentation. In its simplest form, it is just a comma-separated list of filters (with parameters), for example: ‘scale=78:24,transpose=cclock’.

Type: String

Dolby Vision Preprocessor [dvpr]

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

Profile

Sets the Dolby Vision profile.

Note: Defaults to Profile_5.

Type: ProfileType

RpuProfile

Sets the Dolby Vision RPU profile.

Note: Defaults to Baseline.

Type: RpuProfileType

ContentMappingMethod

Specifies the HDR10 content mapping method.

Note: Used only when Profile is 8.1.

Type: ContentMappingMethodType

MaxSceneFrames

Sets the maximum number of frames in scene.

The DolbyVision processor will buffer at most this number of frames while searching for a scene boundary. This value should be at least the GOP length.

Note: Defaults to the total number of frames in the stream. Only used when multi-pass mode is scene based.

Type: Int

MultiPassMode

Sets the multi-pass mode.

Note: Defaults to Scene.

Type: MultiPassModeType

Enumerations:

ProfileType

Property values for Profile.

RpuProfileType

Property values for RpuProfile.

ContentMappingMethodType

Property values for ContentMappingMethod.

MultiPassModeType

Property values for MultiPassMode.

Dolby Vision Postprocessor [dvpo]

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

RpuCompression

Sets the Dolby Vision RPU compression.

Note: Defaults to Basic.

Type: RpuCompressionType

SeiMaxCLL

Sets the HDR-10 SEI metadata maximum content light level (MaxCLL) in nits (cd/m^2).

Type: Int32

EnableRpuCompression

Enables Dolby Vision RPU compression.

Note: Defaults to false.

Type: Bool

MaxCLL

Sets the L6 metadata maximum content light level (MaxCLL) in nits (cd/m^2).

Note: This property is ignored unless MaxFALL is also set.

Type: Int32

Level1Filter

Sets the Dolby Vision level 1 Filter method.

Note: Defaults to None.

Type: FilterType

MaxFALL

Sets the L6 metadata maximum frame-average light level (MaxFALL) in nits (cd/m^2).

Note: This property is ignored unless MaxCLL is also set.

Type: Int32

SeiMaxFALL

Sets the HDR-10 SEI metadata maximum frame-average light level (MaxFALL) in nits (cd/m^2).

Type: Int32

Content

Sets the L11 content.

Note: This property is ignored unless both WhitePoint and ReferenceMode are also set.

Type: ContentType

WhitePoint

Sets the L11 white point.

Note: This property is ignored unless both Content and ReferenceMode are also set.

Type: WhitePointType

ReferenceMode

Sets the L11 reference mode.

Note: This property is ignored unless both WhitePoint and Content are also set.

Type: ReferenceModeType

Enumerations:

WhitePointType

Property values for WhitePoint.

RpuCompressionType

Property values for RpuCompression.

FilterType

Property values for Level1Filter.

ContentType

Property values for Content.

ReferenceModeType

Property values for ReferenceMode.

Teletrax Watermark Converter [twc ]

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

InPlace

Performs the watermarking in-place.

If true, then the input sample is watermarked. If false, then a copy of the input samples is watermarked. For systems that do not need an unmodified source image, setting this property to true will avoid an unnecessary copy.

Note: Defaults to false.

Type: Bool

Duration

The embedding duration of the video track.

The embedding duration should be more or less equal to the video track duration. Use this property to override the track duration specified by the input properties.

Note: Defaults to the duration of the track or 0 if not known.

Type: Int64

EncodationLogFilename

Indicates the encodation log filename.

The filename should be unique and not contain a path.

Type: String

RootPath

Indicates the root path for the embedder.

The root path points to the location where configuration files can be found and where log/encodation information is written.

Note: If left unset, defaults to the current directory, ‘.’. If RootPath is changed the ActiveProgram property is reset to the first program.

Type: String

ActiveProgram

Indicates the currently active program.

The program names can be obtained from the Programs property.

Note: Defaults to the first program. If RootPath is changed this property is reset to the first program.

Type: String

CustomerId

Indicates the customer id.

The customer id should be filled in according to the agreement the end-user has with Teletrax, or left empty ('' or null).

Type: String

Programs

Represents an array of properties for the available programs.

Each item in the array contains a Name, EID, PayloadType, and EmbeddingStrengh property.

Note: The array is read only. The name property should be used to set the active program.

Type: Properties Array

MetadataFields

Represents a properties dictionary of metadata fields.

The active program should already be selected with ActiveProgram property. In addition, each item in the properties dictionary represents a single metadata field. Read this property to get the available fields in the active program. If some keys are not defined for the selected program, they will be logged anyway, but that MAY cause problems when ingesting encodation to the Teletrax portal. Required and not mapped fields will be omitted.

Type: Properties

Name

Indicates the name of a program or metadata field.

Note: This property is read only. Use this value to set the ActiveProgram property.

Type: String

Eids

Indicates the program EIDs.

Retrieves the EIDs of a program. A program may have more than one EID. If a program has more than one EID the names are separated by commas.

Note: This property is read only.

Type: String

PayloadType

Indicates the program payload type.

Note: This property is read only.

Type: String

EmbeddingStrength

Indicates the program embedding strength.

Note: This property is read only.

Type: String

Thumbnail Converter [thmb]

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

Width

The desired thumbnail width.

The output frame width will be Width x Columns

Note: Defaults to 1/10 the input width.

Type: Int32

Height

The desired thumbnail height.

The output frame height will be Height x Rows

Note: Defaults to 1/10 the input height.

Type: Int32

Interval

The fixed length interval to take a thumbnail snapshot in timescale units.

Note: Defaults to 6 seconds.

Type: Int32

Rows

The desired number of rows in the thumbnail mosaic.

The output frame width will be Height x Rows

Note: Defaults to 10.

Type: Int32

Columns

The desired number of columns in the thumbnail mosaic.

The output frame height will be Width x Columns

Note: Defaults to 10.

Type: Int32

Legacy NexGuard Video Watermark Converter [lnwc]

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

Keys

An array of key information.

Each element in the array contains two properties, KeyName and KeyAlgorithm.

Note: This property is read-only.

Payload

The message to be watermarked.

For content security and forensic marking applications the watermark payload is:

1. An integer made of 22 bits,
2. Must not be equal to zero.

Type: UInt32

InPlace

Performs the watermarking in-place.

If true, then the input sample is watermarked. If false, then a copy of the input samples is watermarked. For systems that do not need an unmodified source image, setting this property to true will avoid an unnecessary copy.

Note: Defaults to false.

Type: Bool

LicensePath

Allows the user to specify the path where the license and configuration files used by the SDK are stored.

If not set, then the the environment variables, NXTP_PATH or NexGuardVideo_LICENSE_PATH, is used instead. If these variables are not set, the current folder (where S_YUV_Embedder.dll library is located) is used.

Type: String

Strength

Strength of watermark.

Type: WatermarkStrength

AvailableTokens

The number of tokens currently available.

Note: This property is read-only.

Type: Int32

Key

Index or name of key to use.

A license can contain multiple keys. This property represents the key index or the name of the key to use for watermarking. To retrieve the number of keys and their names refer to the Keys property.

Version

NexGuard Video SDK version string.

Note: This property is read-only.

KeyAlgorithm

The algorithm used dictated by the license key.

Note: This property is read-only.

KeyName

The license key name.

Note: This property is read-only.

Enumerations:

WatermarkStrength

Strength property values.

WatermarkAlgorithm

Algorithm values

NexGuard Video Watermark Converter [nvwc]

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

License

Content of the NexGuard license file.

Either LicensePath or License must be set. If both as ser License takes precedence.

Type: String

ApiKey

Specifies the API key identifing the integrattion software using the SDK.

Any integrator of this SDK should set the API key provided by NexGuard corresponding to its integration. If the API key is not properly set, marker creation will fail.

Type: String

EventMessage

NexGuard File Marker SDK event message string.

Asynchronous events may occur during the the watermarking process. This property holds a string value describing the warning or error that should be presented to the user.

Note: This property is read-only.

Type: String

TestOverlay

NexGuard File Marker SDK test overlay.

To check proper integration of the NexGuard File Marker SDK an overlay may be applied to the video stream.

Type: TestOverlayType

LicensePath

Path to the NexGuard license file.

Either LicensePath or License must be set. If both as ser License takes precedence.

Type: String

Presets

An array of preset information.

Each element in the array contains three properties, PresetName, KeyName and AlgorithmName. The PresetName or index of the element can be used as the value in the Preset property.

Note: This property is read-only.

Version

NexGuard File Marker SDK version string.

Note: This property is read-only.

FixedIdrFrameInterval

Informs the watermaker when to expect I-frames.

Type: Int32

Preset

Name of preset to use.

A license can contain multiple presets. This property represents the preset name or index to use for watermarking. To retrieve the number of presets and their names refer to the Presets property.

Type: String

Strength

Strength of watermark.

Type: WatermarkStrengthType

Payload

A 22 bit number (0 - 4194303) representing the watermark payload. In forensic applications this value uniquely identifies the recipient of the content.

For content security and forensic marking applications the watermark payload is: #. An integer made of 22 bits, for G2 technology. #. 0 or 1, for streaming technology.

Type: UInt32

AlgorithmName

The algorithm used dictated by the preset.

Note: This property is read-only.

KeyName

The key name used dictated by the preset.

Note: This property is read-only.

Type: String

PresetName

The preset name used dictated by the preset.

Note: This property is read-only.

Type: String

Enumerations:

WatermarkStrengthType

Strength property values.

TestOverlayType

TestOverlay property values.

Vpl Converter [vplc]

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

BottomAperture

Specifies the size of the clean aperture below the displayed content.

The aperture rectangle is specified as the number of pixels from the edge of the output frame.

Note: Defaults to 0.

Type: Int32

ReuseCount

Specifies that the number of times certain returned video samples should be reused

Type: Bool

TopAperture

Specifies the size of the clean aperture above the displayed content.

The aperture rectangle is specified as the number of pixels from the edge of the output frame.

Note: Defaults to 0.

Type: Int32

LeftAperture

Specifies the size of the clean aperture to the left of the displayed content.

The aperture rectangle is specified as the number of pixels from the edge of the output frame.

Note: Defaults to 0.

Type: Int32

RightAperture

Specifies the size of the clean aperture to the right of the displayed content.

The aperture rectangle is specified as the number of pixels from the edge of the output frame.

Note: Defaults to 0.

Type: Int32

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

TimeCompressionQualityMetrics

Specifies the time compression quality metrics

Type: Double

EvaluationLogo

Turns on the evaluation logo

Type: Bool

TimeCompressionRatioNumerator

Specifies the time compression ratio numerator

Type: Double

UserBlurAmount

Specifies the blur amount.

Valid values should be in the range of [0, 100].

Type: Double

TimeCompressionRatioDenominator

Specifies the time compression ratio denominator

Type: Double

UserBlurKernelWidth

Specifies the blur kernel width.

Valid values should be positive.

Type: Integer

Enumerations:

ComputeModes

Valid values for the ComputeMode property.

OpenCL Format Converter [ocfc]

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

TopCrop

Specifies the top edge of the cropping rectangle.

The cropping rectangle is specified as the number of pixels from the edge of the input frame.

Note: Defaults to 0.

Type: Int32

LeftCrop

Specifies the left edge of the cropping rectangle.

The cropping rectangle is specified as the number of pixels from the edge of the input frame.

Note: Defaults to 0.

Type: Int32

RightCrop

Specifies the right edge of the cropping rectangle.

The cropping rectangle is specified as the number of pixels from the edge of the input frame.

Note: Defaults to 0.

Type: Int32

BottomCrop

Specifies the bottom edge of the cropping rectangle.

The cropping rectangle is specified as the number of pixels from the edge of the input frame.

Note: Defaults to 0.

Type: Int32

Enumerations:

ComputeModes

Valid values for the ComputeMode property.

Combine Converter [comb]

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

Colorfront Color Space Converter [cfcs]

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

ColorSpace

Determines the output color space.

Type: ColorSpaceType

HdrAmount

The HDR amount.

This parameter controls the strength of the remap effect. A value of zero will essentially generate an SDR output.

Note: Defaults to 0.

Type: Float

HdrSurround

The HDR surround.

This parameter affects the highlight range to be boosted. A minimal value means most of the tones will preserve their luminosity and only the top of the highlight range will be brighter.

Note: Defaults to 0.

Type: Float

Enumerations:

ColorSpaceType

Output color space types.