Media Filters

Mpl Converter [mplm]

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

SectionIndex

The mpl section index.

Type: Int32

SourceTranslators

Array of translators properties.

Each item in the array should have To and From properties.

InsertDefaultC708Deformatters

Adds a list of default C708-Metadata deformatter actions.

If true, a predefined default list of deformatters actions will be added to the deformatter stage. The actions are adder AFTER the actions defined by the deformatters property.

The list of default C708 deformatter actions is subject to change. New C708 metadata elements may be added or the list may be rearranged.

Note: Defaults to false.

Type: Bool

StartTimeCodeOverride

Overrides start timecode

Type: String

InitialTimeCode

Specifies the initial timecode

Type: String

InsertDisplayReorderer

Forces the insertion of a metadata reorderer stage to display order.

Ordinarily the MPL must reorder the metadata to display order prior to any processing. This happens automatically if any formatters, inserters, translateos, or interpolators have been added. After processing is complete the MPL must then reorders the metadata again back to the intended order. Setting this property forces the presense of the display reordering step. Please use with caution. Setting this property is not recommended as it will likely alter metadata processing.

Note: Defaults to false.

TimeCompressionRatioNumerator

Specifies the time compression ratio numerator

Type: Double

From

Specifies the source fourcc in a formatter action, deformatter action, or translator stage.

Type: Four

TimeCompressionRatioDenominator

Specifies the time compression ratio denominator

Type: Double

Interpolators

Array of interpolators properties.

Each item in the array should have a Type property.

ExtrapolateMpeg2GopTimeCode

Adds a stage to extrapolate MPEG-2 GOP Time Code.

MPEG-2 GOP Time Code is only placed on samples that contain MPEG-2 GOP headers. This property controlls the insertion of a metadata stage that extrapolates out the MPEG-2 GOP Time Code to the following frames until a MPEG-2 GOP Time Code element is found. This stage inserted before deformatting.

Note: Defaults to true.

Type: Bool

InsertDefaultTimeCodeDeformatters

Adds a list of default Timecode-Metadata deformatter actions.

If true, a predefined default list of deformatters actions will be added to the deformatter stage. The actions are adder AFTER the actions defined by the deformatters property.

The list of default timecode deformatter actions is subject to change. New timecode metadata elements may be added or the list may be rearranged.

Note: Defaults to false.

Type: Bool

To

Specifies the target fourcc in a formatter action, deformatter action, or translator stage.

Type: Four

UseOriginalFramesMode

Configures the interpolaters to use orignal frames mode.

Note: Defaults to false.

Type: Bool

InsertDefaultAncillaryDeformatters

Adds a list of default Ancillary-Metadata deformatter actions.

If true, a predefined default list of deformatters actions will be added to the deformatter stage. The actions are adder AFTER the actions defined by the deformatters property.

The list of default ancillary deformatter actions is subject to change. New ancillary metadata elements may be added or the list may be rearranged.

Note: Defaults to false.

Type: Bool

InsertDefaultC608Deformatters

Adds a list of default C608-Metadata deformatter actions.

If true, a predefined default list of deformatters actions will be added to the deformatter stage. The actions are adder AFTER the actions defined by the deformatters property.

The list of default C608 deformatter actions is subject to change. New C608 metadata elements may be added or the list may be rearranged.

Note: Defaults to false.

Type: Bool

InsertDefaultTeletextDeformatters

Adds a list of default Teletext-Metadata deformatter actions.

If true, a predefined default list of deformatters actions will be added to the deformatter stage. The actions are adder AFTER the actions defined by the deformatters property.

The list of default Teletext deformatter actions is subject to change. New Teletext metadata elements may be added or the list may be rearranged.

Note: Defaults to false.

Type: Bool

InterlacedMetadata

Causes the MPL to process pairs of metadata.

If true, field 1 and field 2 metadata samples will be merged together.

Note: Defaults to false.

Type: Bool

IgnoreClosedCaptionErrors

The property value is set on the output properties.

This propery does not alter the MPL logic in any way. It’s usefullness is under question and will most likely be removed.

Note: Defaults to false.

Type: Bool

InsertDefaultCaptionServiceDescriptor

The property value is set on the output properties.

This propery does not alter the MPL logic in any way. It’s usefullness is under question and will most likely be removed.

Note: Defaults to false.

Type: Bool

Repack708

The property value is set on the output properties.

This propery does not alter the MPL logic in any way. It’s usefullness is moot and will most likely be removed.

Note: Defaults to false.

Type: Bool

AfdAspectRatio

The property value is set on the output properties.

This propery is packed together with AfdAspectRatio and set on the output properties as the ActiveFormatDescriptor.

It is only used when InsertAfd is set to true.

Note: Defaults to 0.

Type: Byte

VancAfdLineNumber

The property value is set on the output properties.

Type: Int32

DisableDeformatter

Disables the deformatter stage

Note: Defaults to false.

Type: Bool

VancAfdField1LineNumber

The property value is set on the output properties.

Type: Int32

VancAfdField2LineNumber

The property value is set on the output properties.

Type: Int32

AfdValue

The property value is set on the output properties.

This propery is packed together with AfdAspectRatio and set on the output properties as the ActiveFormatDescriptor.

It is only used when InsertAfd is set to true.

Note: Defaults to 0.

Type: Byte

CoordinatedSegmentDuration

Configures the interpolaters to coordinate the output metadata on segment boundaries (in seconds).

Note: Defaults to 0 (uncordinated).

Type: Int32

IgnoreCaptionsFrameRates

Configures the MPL to ignore invalid caption frame rates.

This property’s usefullness is moot and will most likely be removed.

Note: Defaults to false.

Type: Bool

DisableUnsupportedSourceCaptionsOptions

Configures the MPL to automatically disable unsupported caption frame rates.

This property’s usefullness is moot and will most likely be removed.

Note: Defaults to false.

Type: Bool

DisableUnsupportedOutputCaptionsOptions

Configures the MPL to automatically disable unsupported caption frame rates.

This property’s usefullness is moot and will most likely be removed.

Note: Defaults to false.

Type: Bool

DisableFormatter

Disables the Formatter stage

Note: Defaults to false.

Type: Bool

InsertReorderer

Forces the insertion (or exlusion) of a metadata reorderer stage.

Ordinarily the MPL must reorder the metadata to display order prior to any processing. This happens automatically if any formatters, inserters, translateos, or interpolators have been added. After processing is complete the MPL must then reorders the metadata again back to the intended order. Setting this property forces the presense of the reordering steps. Please use with caution. Setting this property is not recommended as it will likely alter metadata processing.

Note: Defaults to false.

Type: Bool

InsertStorageReorderer

@brief Forces the insertion of a metadata reorderer stage to storage order.

@details Ordinarily the MPL must reorder the metadata to display order prior to any processing. This happens automatically if any formatters, inserters, translateos, or interpolators have been added. After processing is complete the MPL must then reorders the metadata again back to the intended order. Setting this property forces the presense of the storage reordering step effectively putting the metadata back into its intended order. Please use with caution. Setting this property is not recommended as it will likely put the metdata into an invalid state.

@note Defaults to false.

InsertAttacher

Inserts a metadata attacher stage.

Note: Defaults to false.

Type: Bool

Deformatters

Array of deformatter properties.

Each item in the array should have To and From properties.

SourceInserters

Array of inserters properties.

Each item in the array should have a Type.

Type

Specifies the type fourcc in an inserter stage or interpolator action.

Type: Four

TargetTranslators

Array of translator properties.

Each item in the array should have To and From properties.

TargetInserters

Array of inserters properties.

Each item in the array should have a Type property.

Formatters

Array of formatter properties.

Each item in the array should have To and From properties.

Subtitle Attacher [subm]

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

Deformatters

Deformatter actions to locate timecode element.

This property should be set as an array of objects. Each object should have two properties: To and From which represent the FourCC of the metadata elements. The SubtitleAttacher will will try to extract timecode metadata from the metadata element identified by the From property. The metadata is searched sequentially in the order specified by this property. If timecode can’t be found the timecode is incremented from the last frame or from the SomTimecode property if no timecode was ever available.

InsertScte20

Insert Scte20 metadata.

Type: Bool

Initialize

Initialize captions with an EDM message.

Type: Bool

InsertSeiUserData

Insert SeiUserData metadata

Type: Bool

C608FieldType

FourCC C608 field type.

Can be c618, c628, or c638.

Type: Four

InsertScte21

Insert Scte21 metadata.

Type: Bool

ReorderQueueSize

Video queue size.

Set to 0 when decode order is the same as presentation order.

Type: Int32

InsertA53

Insert A53 metadata.

Type: Bool

Translate608to708

Translate C608 to C708

Type: Bool

Bitmap Video Converter [bmvc]

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

The time scale of the video stream in ticks/seconds.

This property is used to determine the units of the FrameDuration and the resulting frame rate.

See Also: CVideoProperties

Type: Int64

FrameDuration

See Also: CVideoProperties

Type: Int64

Caption Subtitle Converter [ccsc]

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

InsertReorderer

Inserts a metadata reorderer stage.

Note: Defaults to true.

Type: Bool

AribAncType

The ANC packet type for ARIB captions.

Select which ARIB captions ANC packet type to decode. See MetadataFormat:: AncillaryAribB37HDPacket (default), AncillaryAribB37SDPacket, AncillaryAribB37AnalogPacket, AncillaryAribB37MobilePacket

Note: Can be arbh (default), arbs, arba, or arbm

Type: Four

C608Field

Selects the desired C608 caption field.

When converting C608 to SCC this property determines which field is used.

Note: Can be c618 (default), of c628

Type: Four

Metadata Bitmap onverter [mdbm]

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

BitmapWidth

Gets or sets the width (in pixels) of the rendered bitmap subtitles.

Type: Int

FrameDuration

Gets or sets the sample duration of the rendered bitmap overlay.

Type: Int

TimeScale

Gets or sets the time scale of the rendered bitmap overlay.

Type: Int

BitmapHeight

Gets or sets the height (in pixels) of the rendered bitmap subtitles.

Type: Int

StringForegroundColor

Gets or sets the text foreground color.

This property contains a TTML <color> according to section 8.3.2:

  • #rrggbb
  • #rrggbbaa
  • rgb(r,g,b)
  • rgba(r,g,b,a)
  • <namedcolor>

Type: utf8[]

StringBackgroundColor

Gets or sets the text background color.

This property contains a TTML <color> according to section 8.3.2:

  • #rrggbb
  • #rrggbbaa
  • rgb(r,g,b)
  • rgba(r,g,b,a)
  • <namedcolor>

Type: utf8[]

RegionBackgroundColor

Gets or sets the region background color.

This property contains a TTML <color> according to section 8.3.2:

  • #rrggbb
  • #rrggbbaa
  • rgb(r,g,b)
  • rgba(r,g,b,a)
  • <namedcolor>

Type: utf8[]

FontSize

Gets or sets the font size in pixels.

Type: Int

UserText1

Gets or sets the first user text string.

Type: String

UserText2

Gets or sets the second user text string.

Type: String

UserText3

Gets or sets the third user text string.

Type: String

UserText4

Gets or sets the fourth user text string.

Type: String

OverlayMode

Gets or sets the overlay mode.

Initially used to switch to Tiq metadata only

Type: OverlayModeType

OverlayModeTopRight

Gets or sets the overlay mode.

Initially used to switch to Tiq metadata only

Type: OverlayModeType

OverlayModeBottomLeft

Gets or sets the overlay mode.

Initially used to switch to Tiq metadata only

Type: OverlayModeType

OverlayModeBottomRight

Gets or sets the overlay mode.

Initially used to switch to Tiq metadata only

Type: OverlayModeType

Enumerations:

OverlayModeType

Property values for OverlayMode.

Value Name Description
-1 All All
5 User3 User3
0 None None
1 Tiq Tiq
3 User1 User1
2 Timecode Timecode
4 User2 User2
6 User4 User4

Metadata Merge Converter [meta]

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

MergeMethod

The method used to merge metadata.

Note: Defaults to Merge.

Type: MergeMethodType

Enumerations:

MergeMethodType

Valid values for MergeMethod

Value Name Description
1 Secondary Take all metadata from the secondary input media.
0 Primary Take all metadata from the primary input media.
2 Merge Merge metadata from the secondary input media with the primary input media.

Stt Converter [sttc]

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

EngineType

Determines the type of internal Speech-to-text engine.

This property is used to select which STT api to use.

Note: Defaults to ET_CMU_SPHINX.

Type: ENGINE_TYPE

CommandLine

Determines the internal converter api command line parameters.

This property is used to configure the internal STT api. It is dependent on the internal STT converter api.

Type: String

Url

Determines the STT url.

Type: String

Enumerations:

ENGINE_TYPE

Engine type enumeration.

Value Name Description
0 ET_CMU_SPHINX CmuSphinx STT api.
1 ET_WATSON Watson STT api.
2 ET_APPTECK AppTek STT api.
3 ET_TELESTREAM_CLOUD Telestream Cloud

Subtitle Caption Converter [sccc]

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

SccFieldType

Four character code either c618 (field 1) or c628 (field 2).

Scc data only container C608 caption byte pairs. When converting the caption byte pairs to metadata, this property indicates the desired field. Set the property value to the FourCC of the metadata type ( MetadataType::C608Field1 or MetadataType::C608Field2).

Type: Four

FormatTo

Specifies the formatter’s ‘To’ operator.

If specified a metadata formatter will be added to the output. This property represents the destination metadata type to instert into. If left unspecified the resulting metadata will be placed at the root of the metadata tree.

Note: Defaults to 0.

Type: Bool

Time Code Bitmap Converter [tcbm]

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

Gets or sets the sample duration of the rendered bitmap timecode.

Type: Int

BitmapWidth

Gets or sets the width (in pixels) of the rendered bitmap subtitles.

Type: Int

TimeScale

Gets or sets the time scale of the rendered bitmap timecoede.

Type: Int

StringBackgroundColor

Gets or sets the text background color.

This property contains a TTML <color> according to section 8.3.2:

  • #rrggbb
  • #rrggbbaa
  • rgb(r,g,b)
  • rgba(r,g,b,a)
  • <namedcolor>

Type: utf8[]

BitmapHeight

Gets or sets the height (in pixels) of the rendered bitmap subtitles.

Type: Int

StringForegroundColor

Gets or sets the text foreground color.

This property contains a TTML <color> according to section 8.3.2:

  • #rrggbb
  • #rrggbbaa
  • rgb(r,g,b)
  • rgba(r,g,b,a)
  • <namedcolor>

Type: utf8[]

RegionBackgroundColor

Gets or sets the region background color.

This property contains a TTML <color> according to section 8.3.2:

  • #rrggbb
  • #rrggbbaa
  • rgb(r,g,b)
  • rgba(r,g,b,a)
  • <namedcolor>

Type: utf8[]

FontSize

Gets or sets the font size in pixels.

Type: Int

InitialTimeCode

Specifies the initial timecode

Type: String