Metadata Analyzers

Caption Analyzer [ccan]

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

EnableTtml

Specifies that the caption analyzer should produce TTML

Type: Bool

EnableWebVtt

Specifies that the caption analyzer should produce TTML

Type: Bool

Ttml

Specifies that the caption analyzer should produce TTML

Type: String

WebVtt

Specifies that the caption analyzer should produce TTML

Type: String

Ciem Analyzer [cian]

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

CaptionOutputFrameRate

Specifies the output frame rate for captions and subtitles.

Type: Double

SubtitleRegionMarginRight

Gets or sets the region right margin.

Note: Default 0.1 = 10% safe area margin.

Type: Double

CaptionRippleTimecode

Specifies the offset (in seconds) applied to caption and subtitle timecode values.

Type: Double

CaptionOffsetTime

Specifies the offset (in seconds) applied to caption and subtitle times.

Type: Double

SubtitleCodePage

Gets or sets the code page of the subtitles.

Type: Int

CaptionRetimeRate

Specifies the rate multiplier applied to caption and subtitle times. For example, a rate of 1.001 compensates for drop frame.

Type: Double

StartingTimecodeMode

Specifies the mode use to convert caption and subtitle timecode values to 0 based times.

Type: Int32

CaptionReformatRollUpToPopOn

Specifies the number of text lines used to reformat roll-up captions to pop-on captions.

Type: Int

SubtitleStringDropShadowDistance

Gets or sets the drop shadow distance setting.

Set as a multiplier of font size, e.g. 0.1 = 10% of font size.

Type: Double

CaptionOutputDropFrame

Indicates whether timecode values should be specified in drop frame format.

Type: Bool

SubtitlePositionSnapping

Gets or sets the options to snap subtitles to the top and/or bottom margin

Type: Int32

CaptionRetimeStartTime

Specifies the start time (in seconds) of the retimed captions and subtitles.

If a program begins at 01:00:00:00 and you set this to 3600.0, the program start time will be pinned to 01:00:00:00 even after applying retiming.

Type: Double

StartFrame

Specifies the starting frame number.

Type: Int32

SubtitleTeletextDisplayStandard

Specifies the Display Standard Code (DSC)

Type: Int

XdsProgramName

Specifies the XDS program name.

Type: utf8[]

SubtitleStringBackgroundPaddingType

Gets or sets the text background padding type.

Type: Int

SubtitleLanguageCode

Gets or sets the language code in ISO-639 packed format.

Type: UInt16

TtmlIncludeOffsetMetadata

Gets or sets the TTML include offset metadata option.

When true, TTML outputs will include metadata about the source start timecode and offset applied.

Type: Bool

XdsProgramType

Specifies the XDS program type(s)

A comma delimited string containing a list of XDS program types.

Type: utf8[]

SubtitleRegionBackgroundColorOverrideMode

Gets or sets whether the background color applies to all regions or only certain regions.

Type: Int

XdsRating

Specifies the XDS V-chip content rating.

Note: Rating flags are added in parentheses. For example, TV-MA (VSL)

Type: utf8[]

XdsCgms

Specifies the XDS CGMS value.

No copying is permitted PSP On; 4 PSP On; 2 PSP On; Split Burst Off One generation of copies may be made

Note: Optional: (Analog Source Bit)

Type: utf8[]

PadOutputDuration

Pads the output duration by 1 second to ensure that program ends on an empty frame rather than a caption or subtitle.

Used to ensure the output ends on an empty frame instead of a caption/subtitle frame.

Type: Bool

SubtitleDvbAncillaryPageNumber

Specifies the subtitle ancillary page number.

Type: Int

SubtitleTeletextVbiLine3

Specifies the VANC line number for Teletext VBI line 3.

Type: Int

Metadata

Gets or sets the metadata properties.

Type: Propeerties

Encode708WideMode

Enables or disables CEA-708 wide mode (42 column)

Note that some decoders do not properly handle wide mode.

Type: Bool

SubtitleStringDropShadow

Gets or sets the drop shadow setting.

Type: Bool

SubtitleLanguageTag

Gets or sets the language tag.

Use a language tag format appropriate for the output format, e.g. IETF BCP 47 (‘en’ or ‘en-US’) for TTML/XML. For EBU-STL, use: ‘Latin’, ‘Latin/Cyrillic’, ‘Latin/Arabic’, ‘Latin/Greek’, or ‘Latin/Hebrew’. For Teletext, use: ‘Latin’, ‘Cyrillic-1’, ‘Cyrillic-2’, ‘Cyrillic-3’, ‘Arabic’, ‘Greek’, or ‘Hebrew’.

Type: utf8[]

FrameDuration

The sample duration of the rendered subtitle bitmap.

Type: Int

IgnoreTimeCode

Indicates whether timecode metadata in source samples should be ignored.

Type: Bool

SccSourceField

Specifies the field number used when decoding SCC captions.

Type: Int

SubtitleStringOutlineSizeSecondary

Gets or sets the text outline size used for secondary subtitles.

Range: 0 (no outline) to 100 (outline size 100% of font size)

Type: Double

SccOutputField

Gets or sets the field (0 or 1) for outputting SCC samples.

Type: Int

SubtitleBitmapWidth

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

Type: Int

SubtitleTeletextVancLine1

Specifies the VANC line number for Teletext VANC line 1.

Type: Int

SubtitleBitmapHeight

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

Type: Int

SubtitleStringFontFamily

Gets or sets the font family name.

Type: utf8[]

SubtitleDvbPageNumber

Specifies the subtitle page number.

Type: Int

SubtitleStringFontFamilySecondary

Gets or sets the font family name used for secondary subtitles.

Type: utf8[]

SubtitleStringForegroundColor

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[]

SubtitleStringForegroundColorSecondary

Gets or sets the text foreground color used for secondary subtitles.

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[]

SubtitleStringBackgroundColor

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[]

SubtitleStringBackgroundColorOverrideMode

Gets or sets whether the background color applies to all strings or only certain strings.

Type: Int

SubtitleTtmlProfile

Specifies a particular TTML output variant

Note: Defaults to Basic when input is a subtitle format, or SMPTE-2052 when the input is a caption format.

Type: Int32

SubtitleStringOutlineColor

Gets or sets the text outline color in TTML <color> format.

Type: utf8[]

SubtitleStringOutlineColorSecondary

Gets or sets the text outline color used for secondary subtitles in TTML <color> format.

Type: utf8[]

SubtitleDvbType

Specifies the DVB subtitle type according to ETSI EN 300 468 Table 26

Type: Byte

SubtitleDvbColorDepth

Specifies the size of the bitmap color palette in bits, allowable values are 4, 16 or 256.

Type: Int

SubtitleStringOutlineSize

Gets or sets the text outline size as a percentage of the font size.

Range: 0 (no outline) to 100 (outline size 100% of font size)

Type: Double

SubtitleRegionBackgroundColor

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[]

SubtitleTeletextVancLine2

Specifies the VANC line number for Teletext VANC line 2.

Type: Int

SubtitleStringForceBold

Gets or sets the force bold setting.

Type: Bool

SourceTimecodeType

Sets the timecode metadata type to be used for caption extraction from video sources.

When not specified, the CiemConverter uses a default list of timecode formats. When specified, the CiemConverter will only look for the specified timecode format.

Type: Four

SubtitleRegionMarginBottom

Gets or sets the region bottom margin.

Note: Default 0.1 = 10% safe area margin.

Type: Double

SubtitleCaptionChannel

Specifies the caption channel, caption service or Teletext page to decode

Type: Int

SubtitleNormalizeColors

Gets or sets the subtitle normalize colors option.

When true, subtitle colors will be normalized to the nearest matching TTML named color.

Type: Bool

SubtitleTeletextHeight

Enables or disables double height mode.

Note: Default is true.

Type: Bool

SubtitleSourceEncoding

Gets or sets the name of the character set encoding used to parse a subtitle source.

Type: utf8[]

RemoveSlate

Gets or sets the Remove Slate option.

Note: Default = false

When set to true, a first subtitle which is detected as a slate subtitle will be removed. See: SlateKeyword and SlateMinLines properties.

Type: Bool

SubtitleRegionMarginLeft

Gets or sets the region left margin.

Note: Default 0.1 = 10% safe area margin.

Type: Double

SubtitleStringDropShadowBlurRadius

Gets or sets the drop shadow blur radius setting.

Units are in pixels, e.g. 5.0 pixel blur radius

Type: Bool

SubtitleRegionMarginTop

Gets or sets the region top margin.

Note: Default 0.1 = 10% safe area margin.

Type: Double

SubtitleTeletextVbiLine1

Specifies the VANC line number for Teletext VBI line 1.

Type: Int

SubtitleRegionFontScale

Gets or sets the region font scaling.

Values in the range of (0, 4.0) are treated as a multiplier, e.g. 2.0 = 200% of default font size. Values >= 4.0 are treated as an absolute pixel size, e.g. 48.0 = 48px font size.

Type: Double

SubtitleRegionFontScaleSecondary

Gets or sets the region font scaling used for secondary subtitles.

Values in the range of (0, 4.0) are treated as a multiplier, e.g. 2.0 = 200% of default font size. Values >= 4.0 are treated as an absolute pixel size, e.g. 48.0 = 48px font size.

Type: Double

SubtitleStringDropShadowAngle

Gets or sets the drop shadow angle setting.

Units are degrees with 0 being Right, 90 being Up, 315 is Down & Right.

Type: Double

SubtitleStringDropShadowColor

Gets or sets the drop shadow color setting in TTML <color> format.

Type: utf8[]

SubtitleTeletextPage

Specifies the page number (e.g. 888).

Type: Int

SubtitleTeletextVbiLine2

Specifies the VANC line number for Teletext VBI line 2.

Type: Int

SubtitleTeletextVbiLine4

Specifies the VANC line number for Teletext VBI line 4.

Type: Int

SubtitleTeletextVbiLine5

Specifies the VANC line number for Teletext VANC line 5.

Type: Int

SubtitleTeletextFillType

Specifies the type of filler data.

Type: Int

SubtitleTeletextNationalOption

Specifies the national option character set.

Note: Default is 0 (English). See ETS 300 706 for values.

Type: Int

SubtitleWebVttTimestampMap

Sets the value of the X-TIMESTAMP-MAP=MPEGTS: header.

Type: utf8[]

TtmlTimeExpressionMode

Specifies the TTML time expression mode

Note: Default is HHMMSSFF for ST2052 and iTT, HHMMSSsss for other profiles.

Type: Int

TtmlForceIncludeFrameRate

Indicates whether to include the frame rate in the TTML.

Type: Bool

TtmlIncludeAspectRatio

Indicates whether to include the aspect ratio in the TTML.

Type: Bool

OmitStyleTags

Gets or sets the omit style tags property.

By default, WebVTT and SRT outputs include HTML-like style tags for underline, italics, and bold. Setting this property to true will disable adding these style tags.

Note: Default = False

Type: Bool

VttUseLineNumbers

Gets or sets the VTT Use Line Numbers option.

Note: Default = false (cue vertical position is written as % of vertical height)

When set to true, cue vertical position will be expressed as a line number 1 - 15. Negative line numbers count up from the bottom of the screen.

Type: Bool

VttUseLineAlignment

Gets or sets the VTT Use Line Alignment option.

Note: Default = false (line position is always computed assuming line aligment = ‘start’)

When set to true, cue line alignment will be specified in the cue settings. E.g. line:50%,center

Type: Bool

SlateKeyword

Gets or sets the slate keyword option.

Sets a keyword used to detect a slate first subtitle, e.g. ‘TITLE:’ or ‘TRANSLATOR:’ If RemoveSlate is set to true and the first subtitle contains this word, the subtitle will be removed.

Note: Default = (none)

Type: utf8[]

SlateMinLines

Gets or sets the slate minimum number of lines option.

Sets the minimum number of text lines needed to detect that the first subtitle is a slate. If RemoveSlate is set to true and the first subtitle contains at least this number of lines, it will be removed.

Note: Default = 0

Type: Int

AccurateDecoding

Gets or sets the Teletext ‘accurate decoding’ mode.

Accurate Mode is intended for decoding Teletext to bitmaps (subtitle overlay, burn-in) as a reference monitor would. For example, double height text will be vertically stretched, and text will be constrained to a 4x3 canvas within wider aspect ratio outputs. This mode is not ideal when converting to other subtitle formats such as TTML or WebVTT.

Note: Defaults = False

Type: Bool

NationalOption

Gets or sets the National Option character set.

The National Option character set adds additional special characters to the base Latin set. Unless the file contains metadata to specify the desired national option set, the user must specify the desired national option set, otherwise some special characters may be decoded incorrectly.

Note: Default = 0 (English)

Type: int

VttOmitCueSettings

Gets or sets the WebVTT omit cue settings mode.

By default, WebVTT outputs include cue settings for positioning. Setting this property to true will disable adding these cue settings.

Note: Default = False

Type: Bool

NormalizeRegions

Gets or sets the subtitle normalize regions option.

When true, subtitle regions will be normalized to commonly used region definitions, where possible.

Type: Bool

CaptionDataStartFrame

Sets the frame number from which caption data will be emitted. No active caption data will be emitted prior to this frame. Any prior frames will contain empty caption packets only.

Default = 0 This value should be specified in the output frame rate.

Type: int

EbuMetadata

Sets the EBU metadata strings for EBU-STL.

property keys: OriginalProgramTitle, OriginalEpisodeTitle, TranslatedProgramTitle, TranslatedEpisodeTitle, TranslatorName, TranslatorContactDetails, SubtitleListReferenceCode, CreationDate, RevisionDate, RevisionNumber, TotalNumberOfDisks, DiskSequenceNumber, CountryOfOrigin, Publisher, EditorName, EditorContactDetails

Type: Properties

EbuTimeCodeStatus

Sets the Time Code Status (TCS) for EBU-STL.

Default = 0 (not used)

Type: int

EbuTimeCodeStartOfProgram

Sets the Time Code Start-of-Program (TCP) for EBU-STL.

Default = empty string

Type: string

TreatChevronsAsItalics

@brief Treat EBU-STL chevrons as italics markers.

@details By default, chevrons (< and >) in EBU-STL are treated as text. When set to true, chevrons will be treated as italics markers instead.

@type Bool

EbuUseJustification

@brief Sets the EBU-STL use grid alignment setting.

@details By default, EBU-STL outputs will use Left/Center/Right Justifcation when outputting in Open Subtitles mode (see SubtitleTeletextDisplayStandard ), or Not Justified (grid alignment) when using the Teletext mode. Setting this property overrides the default behavior.

@type Bool

EbuForceCenter

@brief Sets the EBU-STL force center alignment setting.

@details By default, EBU-STL outputs will use Left/Center/Right Justifcation depending on the position of the source subtitle. Setting this property overrides the justification to always be center.

@type Bool

TtmlVerticalSplitPosition

@brief Sets the TTML vertical split position.

@details Some TTML profiles place subtitles into a top or bottom region depending on the position of the source subtitle. By default, subtitles higher than the middle (0.5) are placed in the top region. Set this value to control the split between top and bottom subtitles. E.g. 0.2 = subtitles in the top 20% of screen height will be placed in the top region.

@type Double

EbuDiskFormatCode

@brief Sets the EBU-STL format code setting.

@details By default, EBU-STL outputs will set the Disk Format Code (DFC) based on the output framerate. Standard values are STL30.01 and STL25.01 for 30/25fps respectively, non-standard values include STL23.01, STL24.01, STL29.01, STL50.01, STL59.01, and STL60.01 for 23.976, 24, 29.97, 50, 59.94, and 60fps respectively. This setting will override the default value. The string must be 8 characters long.

@type string

Enumerations:

TimecodeOptions

Plain text timecode options.

TimecodeFormats

Plain text timecode formats.

LineDelimiters

Plain text line delimiters.

Scc Analyzer [scan]

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

Service Analyzer [svan]

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

PreserveOrder

Preserves the original sample order.

Note: Defaults to true.

Type: Bool

Teletext Analyzer [ttan]

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