Audio Compressors

Media Foundation Audio Compressor [mfa ]

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


DecodeDelay

Number of audio frames introduced or removed by the audio compressor.

A positive value indicates frames have been added, a negative value indicates frames have been removed. This property may be found on the audio compressor after Begin has been called.

Note: Read-only property.

Type: Int32


BitRate

Encoding bitrate in bits per second.

Type: Int32


Opus Compressor [opus]

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


DecodeDelay

Number of audio frames introduced or removed by the audio compressor.

A positive value indicates frames have been added, a negative value indicates frames have been removed. This property may be found on the audio compressor after Begin has been called.

Note: Read-only property.

Type: Int32


BitRate

Average bitrate (in bits per second).

Average bitrate of stream.

Type: Int32


Complexity

Specifies desired complexity.

Ranges from 1 to 10, where 1 is the lowest complexity and 10 is the highest.

Type: Int32


Vorbis Compressor [vorb]

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


DecodeDelay

Number of audio frames introduced or removed by the audio compressor.

A positive value indicates frames have been added, a negative value indicates frames have been removed. This property may be found on the audio compressor after Begin has been called.

Note: Read-only property.

Type: Int32


RateControlMode

Sets the rate control mode

Valid values include: 0 - CBR, constrained constant bit rate 1 - Quality quality based

Type: Int32


MaxBitRate

Maximum bitrate (in bits per second).

Used only in constrained mode.

Type: Int32


BitRate

Average bitrate (in bits per second).

Average bitrate of stream.

Type: Int32


NominalBitRate

Nominal (average) bitrate (in bits per second).

Used only in constrained mode.

Type: Int32


MinBitRate

Minimum bitrate (in bits per second).

Used only in constrained mode.

Type: Int32


Quality

A decimal float value requesting a desired quality.

Libvorbisenc 1.1 allows quality requests in the range of

  • 0.1(lowest quality, smallest files)through + 1.0(highest - quality, largest files).Quality - 0.1 is intended as an ultra - low setting in which low bitrate is much more important than quality consistency.Quality settings 0.0 and above are intended to produce consistent results at all times.

Type: Float


Ec3 JOC Compressor [ec3j]

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


DecodeDelay

Number of audio frames introduced or removed by the audio compressor.

A positive value indicates frames have been added, a negative value indicates frames have been removed. This property may be found on the audio compressor after Begin has been called.

Note: Read-only property.

Type: Int32


LoRoCenterMixLevel

The Lo/Ro center mix level

Specifies the level shift that a channel-based decoder should apply to the center channel when adding to the left and right channels while performing an Lo/Ro downmix.

Type: MixLevelType


BitRate

Encoder bitrate in bits/second.

Note: Allowed Bitrates: 384000, 448000, 640000, 768000, 1024000

Type: BitRateType


DynamicRangeLineModeProfile

The dynamic range line mode profile

Type: CompressionType


LtRtSurroundMixLevel

The Lt/Rt surround mix level

Specifies the level shift that a channel-based decoder should apply to the surround channels when adding to the left and right channels while performing an Lt/Rt downmix.

Type: MixLevelType


DynamicRangeRFModeProfile

The dynamic range RF mode profile

Type: CompressionType


LtRtCenterMixLevel

The Lt/Rt center mix level

Specifies the level shift that a channel-based decoder should apply to the center channel when adding to the left and right channels while performing an Lt/Rt downmix.

Type: MixLevelType


DownMixMode

The down mix mode.

Specifies the method a channel-based decoder should use when downmixing the audio for playback.

Type: DownMixModeType


LoRoSurroundMixLevel

The Lo/Ro surround mix level

Specifies the level shift that a channel-based decoder should apply to the surround channels when adding to the left and right channels while performing an Lo/Ro downmix.

Type: MixLevelType


ChannelConfiguration

Specifies the input channel configuration.

Used only in CBI mode. Channels not found in the configuration will be replaced with silence.

Note: Detaults to CBI_5_1_4 or the most appropriate configuration base on the available channel labels.

Type: ChannelConfigurationType


IntegratedSpeechGatedLoudness

Integrated speech-gated loudness.

Note: This property should be set from the IntegratedLoudness property found on the DolbyAtmosConverter. Deprecated 7/24/2020. This property is not necessary and will be removed.

Type: Float


IntegratedLevelGatedLoudness

Integrated level-gated loudness.

Note: This property should be set from the IntegratedLoudness property found on the DolbyAtmosConverter.

Type: Float


IntegratedSpeechPercentage

Speech content over the program, as a percentage.

Note: This property should be set from the IntegratedLoudness property found on the DolbyAtmosConverter.

Type: Float


IntegratedLoudness

Integrated loudness.

Note: This property should be set from the IntegratedLoudness property found on the DolbyAtmosConverter or DolbyAtmosLoudnessAnalyzer.

Type: Float


SamplePeak

Peak absolute sample value, since reset or since it was last cleared. Units are dBFS.

Note: This property should be set from the IntegratedLoudness property found on the DolbyAtmosConverter or DolbyAtmosLoudnessAnalyzer

Type: Float


IntegratedLoudnessRange

Loudness range over the program, in LU.

Note: This property should be set from the IntegratedLoudness property found on the DolbyAtmosConverter or DolbyAtmosLoudnessAnalyzer

Type: Float


TruePeak

Maximum True Peak value, as per ITU-R BS.1770-2, since reset or since it was last cleared. Units are dBTP.

Note: This property should be set from the IntegratedLoudness property found on the DolbyAtmosConverter or DolbyAtmosLoudnessAnalyzer

Type: Float


Enumerations:

DownMixModeType

Down mix modes.

Value Name Description
0 NotIndicated Not indicated
1 ProLogic ProLogic
2 Stereo Stereo
3 ProLogicII ProLogicII

ChannelConfigurationType

Channel configurations.

Value Name Description
0 CBI_9_1_6 Channel mode is 9.1.6 with channels: L, R, C, LFE, Ls, Rs, Lrs, Rrs, Lw, Rw, Ltf, Rtf, Ltm, Rtm, Ltr, Rtr
1 CBI_7_1_4 Channel mode is 7.1.4 with channels: L, R, C, LFE, Ls, Rs, Lrs, Rrs, Ltf, Rtf, Ltr, Rtr
2 CBI_5_1_4 Channel mode is 5.1.4 with channels: L, R, C, LFE, Ls, Rs, Ltf, Rtf, Ltr, Rtr

BitRateType

Bit Rates.

Value Name Description
1024000 BitRate_1024_Kbps 1024 kbps data rate
384000 BitRate_384_Kbps 384 kbps data rate
448000 BitRate_448_Kbps 448 kbps data rate
640000 BitRate_640_Kbps 640 kbps data rate
576000 BitRate_576_Kbps 576 kbps data rate
768000 BitRate_768_Kbps 768 kbps data rate

MixLevelType

Mix levels.

Value Name Description
0 Plus_3_dB Mix level code 0: 1.414 (+3.0 DDPENC_PRO__dB)
4 Minus_3_dB Mix level code 4: 0.707 (-3.0 DDPENC_PRO__dB)
1 Plus_1_5_dB Mix level code 1: 1.189 (+1.5 DDPENC_PRO__dB)
3 Minus_1_5_dB Mix level code 3: 0.841 (-1.5 DDPENC_PRO__dB)
2 Zero_dB Mix level code 2: 1.000 ( 0.0 DDPENC_PRO__dB)
7 Minus_Infinity_dB Mix level code 7: 0.000 (-inf DDPENC_PRO__dB)
5 Minus_4_5_dB Mix level code 5: 0.595 (-4.5 DDPENC_PRO__dB)
6 Minus_6_dB Mix level code 6: 0.500 (-6.0 DDPENC_PRO__dB)

CompressionType

Dynamic Range Compression Profiles.

Value Name Description
0 None None
1 FilmStandard Film standard
2 FilmLight Film light
3 MusicStandard Music standard
4 MusicLight Music Light
5 Speech Speech

DolbyE Compressor [dlbe]

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


DecodeDelay

Number of audio frames introduced or removed by the audio compressor.

A positive value indicates frames have been added, a negative value indicates frames have been removed. This property may be found on the audio compressor after Begin has been called.

Note: Read-only property.

Type: Int32


FrameCount

Frame Count.

Type: Int


BitDepth

Specifies the output bit depth, either 16 or 20 bits.

Note: For 16 precision the program configuration is limited to a total of 6 channels.

Type: Int


DialogNormalization

Value in the range 1 to 31 representing a dialog normalization level between -1 and -31 dBFS.

Type: Int32


EncoderDelay

Encoder delay.

Type: Int


ProgramConfiguration

Specifies the program configuration.

Type: ProgramConfigurations


Position

Number of samples to use as prefix guardband.

Note: negative number will trigger automatic mode

Type: Int32


EnableLowFrequencyEffects

Enables or disables the LFE channel.

Type: Bool


FrameRate

Specifies the video frame rate.

Type: FrameRateType


KeyPresent

Indicates whether bitstream keys are present.

Type: Bool


ThreeDecibelAttenuation

Enables or disables the surround channel 3dB attenuator.


Timecode

Starting time code

Type: String


Program

Dolby digital metadata for each program.

Type: CVariantArray[8] of CProperties


Description

Program description, maximum 32 characters.

Type: String


CopyrightProtected

Sets the ‘Copyright Protection’ flag.

Type: Bool


AnalogToDigitalConverterType

Analog to digital converter type.

Type: AnalogToDigitalConverterTypes


AudioCodingMode

Audio coding mode

Type: AudioCodingModes


PreferredDownmixMode

Preferred downmix mode

Type: DownmixModes


BitstreamMode

Bitstream Mode

Type: BitstreamModes


DolbySurroundMode

Dolby surround mode.

Type: SurroundModes


DrcLineModeProfile

Dynamic range control (DRC) line mode profile.

Type: CompressionProfiles


EnableLfeLowPassFilter

Enables or disables the LFE low pass filter.

Type: Bool


DrcRfModeProfile

Dynamic range control (DRC) RF mode profile

Type: CompressionProfiles


EnableHighPassFilter

Enables or disables the DC high pass filter.

Type: Bool


EnableLowPassFilter

Enables or disables the bandwidth limiting low pass filter.

Type: Bool


LoRoCenterMixLevel

Specifies the center channel level for a conventional (LoRo) stereo down mix.

Type: MixLevels


LoRoSurroundMixLevel

Specifies the surround channel level for a conventional (LoRo) stereo down mix.

Type: MixLevels


LtRtCenterMixLevel

Specifies the center channel level for a matrix (LtRt) stereo down mix.

Type: MixLevels


LtRtSurroundMixLevel

Specifies the surround channel level for a matrix (LtRt) stereo down mix.

Type: MixLevels


MixingLevel

Audio production mixing level (80 - 111).

Type: Int


NinetyDegreePhaseShift

Enables or disables the surround channel 90 degree phase shift filter.

Type: Bool


OriginalBitstream

Sets the ‘Original Bitstream’ flag.

Type: Bool


RoomType

Audio production room type.

Type: RoomTypes


SuroundExMode

Surround EX mode

Type: SurroundModes


Enumerations:

DownmixModes

Property values for PreferredDownmixMode.

Value Name Description
1 Lt_Rt Lt/Rt downmix
2 Lo_Ro Lo/Ro downmix

CompressionProfiles

Property values for DrcLineModeProfile and DrcRfModeProfile.

Value Name Description
0 None None
1 FilmStandard Film standard compression
2 FilmLight Film Light compression
3 MusicStandard Music Standard compression
4 MusicLight Music Light compression
5 Speech Speech compression

MixLevels

Property values for LoRoCenterMixLevel, LoRoSurroundMixLevel, LtRtCenterMixLevel, and LtRtSurroundMixLevel;.

Value Name Description
0 Plus_3_0_dB 1.414 (+3.0 dB)
1 Plus_1_5_dB 1.189 (+1.5 dB)
3 Minus_1_5_dB 0.841 (-1.5 dB)
2 Zero_dB 1.000 (0.00 dB)
4 Minus_3_0_dB 0.707 (-3.0 dB)
7 Minus_Infinity_dB 0.000 (-inf dB)
5 Minus_4_5_dB 0.595 (-4.5 dB)
6 Minus_6_0_dB 0.500 (-6.0 dB)

SurroundModes

Property values for DolbySurroundMode and SuroundExMode.

Value Name Description
1 Disabled Disabled
2 Enabled Enabled

AudioCodingModes

Property values for AudioCodingMode.

Value Name Description
2 L_R 2/0 L R
1 C 1/0 C
3 L_C_R 3/0 L C R
4 L_R_Cs 2/1 L R Cs
5 L_C_R_Cs 3/1 L C R Cs
6 L_R_Ls_Rs 2/2 L R Ls Rs
7 L_C_R_Ls_Rs 3/2 L C R Ls Rs

AnalogToDigitalConverterTypes

Property values for AnalogToDigitalConverterType.

Value Name Description
1 HighDefinition High Definition
0 Standard Standard

BitstreamModes

Property values for BitstreamMode.

Value Name Description
7 VoiceOver Voice Over
4 Dialogue Dialogue
0 CompleteMain Complete main
1 MusicAndEffects Music and effects
2 VisuallyImpaired Visually Impaired
5 Commentary Commentary
3 HearingImpaired Hearing Impaired
6 Emergency Emergency

RoomTypes

Property values for RoomType.

Value Name Description
2 SmallRoom Small room
1 LargeRoom Large room

FrameRateType

Property values for FrameRate.

Value Name Description
2 TwentyFour 24
0 NotSpecified Not specified
1 TwentyThreeNineEight 23.976
3 TwentyFive 25
5 Thirty 30
4 TwentyNineNineSeven 29.97
7 FiftyNineNineFour 59.94
6 Fifty 50
8 Sixty 60

ProgramConfigurations

Property values for ProgramConfiguration.

Value Name Description
11 L1_C1_Ls1_R1_LFE1_Rs1 5.1
0 L1_C1_Ls1_L2_R1_LFE1_Rs1_R2 5.1 + 2
1 L1_C1_Ls1_C2_R1_LFE1_Rs1_C3 5.1 + 1 + 1
2 L1_C1_L2_C2_R1_Cs1_R2_Cs2 4 + 4
23 L1_C1_Ls1_Lc1_R1_LFE1_Rs1_Rc1 7.1 Screen
3 L1_C1_L2_L3_R1_Cs1_R2_R2 4 + 2 + 2
15 L1_L2_C3_R1_R2_C3 2 + 2 + 1 + 1
6 L1_L2_L3_L4_R1_R2_R3_R4 2 + 2 + 2 + 2
4 L1_C1_L2_C3_R1_Cs1_R2_C4 4 + 2 + 1 + 1
5 L1_C1_C2_C4_R1_Cs1_C3_C5 4 + 1 + 1 + 1 + 1
7 L1_L2_L3_C4_R1_R2_R3_C5 2 + 2 + 2 + 1 + 1
8 L1_L2_C3_C5_R1_R2_C4_C6 2 + 2 + 1 + 1 + 1 + 1
18 L1_C1_R1_Cs1 4
9 L1_C2_C4_C6_R1_C3_C5_C7 2 + 1 + 1 + 1 + 1 + 1 + 1
10 C1_C3_C5_C7_C2_C4_C6_C8 1 + 1 + 1 + 1 + 1 + 1 + 1 + 1
17 C1_C3_C5_C2_C4_C6 1 + 1 + 1 + 1 + 1 + 1
12 L1_C1_L2_R1_Cs1_R2 4 + 2
19 L1_L2_R1_R2 2 + 2
13 L1_C1_C2_R1_Cs1_C3 4 + 1 + 1
14 L1_L2_L3_R1_R2_R3 2 + 2 + 2
22 L1_C1_Ls1_Lrs1_R1_LFE1_Rs1_Rrs1 7.1
16 L1_C2_C4_R1_C3_C5 2 + 1 + 1 + 1 + 1
20 L1_C2_R1_C3 2 + 1 + 1
21 C1_C3_C2_C4 1 + 1 + 1 + 1

Ec3 Compressor [ec3 ]

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


DecodeDelay

Number of audio frames introduced by the audio compressor.

A positive value indicates frames have been added, a negative value indicates frames have been removed. This property may be found on the audio compressor after Begin has been called.

Note: Read-only property.

Type: Int32


CenterMixLevel

Center downmix level. Deprecated.

Note: Valid values:

Value Meaning
Mix level code 0 0.707 (-3.0 DDPENC_PRO__dB)
Mix level code 1 0.595 (-4.5 DDPENC_PRO__dB)
Mix level code 2 0.500 (-6.0 DDPENC_PRO__dB)

Type: Int


AudioCodingMode

Sets the audio coding mode (ACMOD).

By default the acmod is determined by the number of channels. Set this property to override the output audio coding mode.

Channels ACMOD LFE
1 ACMOD_10 off
2 ACMOD_20 off
3 ACMOD_30 off
4 ACMOD_22 off
5 ACMOD_32 off
6 ACMOD_32 on
7 CHCFG_21 off
8 CHCFG_21 on

Type: AudioCodingModes


EnableLowFrequencyEffects

Enables the LFE channel.

By default the lfe is determined by the number of channels. Set this property to override the inclusion of the lfe channel.

Channels ACMOD LFE
1 ACMOD_10 off
2 ACMOD_20 off
3 ACMOD_30 off
4 ACMOD_22 off
5 ACMOD_32 off
6 ACMOD_32 on
7 CHCFG_21 off
8 CHCFG_21 on

Type: Bool


DrcLineModeProfile

Dynamic Range Profile.

Note: Valid values:

Value Meaning
0 none
1 film standard compression
2 film light compression
3 music standard compression
4 music light compression
5 speech compression

Type: Int


BitRate

Encoder bitrate in bits/second.

Bitrates include: 32000 40000 48000 56000 64000 80000 96000 112000 128000 160000 192000 224000 256000 320000 384000 448000 512000 576000 640000

Type: Int64


EvolutionEnable

Evolution/RTLL

Type: Bool


SurroundMixLevel

Surround downmix level. Deprecated.

Note: Valid values:

Value Meaning
Mix level code 0 0.707 (-3.0 DDPENC_PRO__dB)
Mix level code 1 0.500 (-6.0 DDPENC_PRO__dB)
Mix level code 2 0.000 (-infinity)

Type: Int


NinetyDegreePhaseShift

Phase 90 filter enabled.

Type: Bool


EncoderInformation

Gets the encoder version. Property is set on the output properties of the compressor.

Type: String


BitstreamMode

Bitstream mode options

Note: Valid values:

Value Meaning
0 Complete Main (CM)
1 Music and Effects (ME)
2 Visually Impaired (VI)
3 Hearing Impaired (HI)
4 Dialogue (D)
5 Commentary (C)
6 Emergency (E)
7 Voice Over (VO)

Type: Int32


DialogNormalization

Value in the range 1 to 31 representing a dialog normalization level between -1 and -31 dBFS.

Type: Int


StereoDownmixPreference

Preferred stereo downmix mode.

Note: Valid values:

Value Meaning
Dmixmod 0 Not indicated
Dmixmod 1 Pro Logic downmix preferred
Dmixmod 2 Stereo downmix preferred
Dmixmod 3 Pro Logic II downmix preferred

Type: Int


CopyrightProtected

Copyright Protected.

Type: Bool


DolbySurroundMode

Dolby surround mode.

Note: Valid values:

Value Meaning
0 not indicated
1 disabled
2 enabled

Type: Int32


ThreeDecibelAttenuation

Surround attenuation enabled.

Type: Bool


EnableLfeLowPassFilter

Enables or disables the LFE low pass filter.

Type: Bool


DrcRfModeProfile

Compression Profile.

Note: Valid values:

Value Meaning
0 none
1 film standard compression
2 film light compression
3 DRC profile 3: music standard compression
4 music light compression
5 speech compression

Type: Int


OriginalBitstream

Oringial Bitstream.

Type: Bool


AnalogToDigitalConverterType

A/D Converter Type.

Note: Valid values:

Value Meaning
0 Standard
1 High Definition

Type: Int


SurroundExMode

Surround EX mode flag.

Note: Valid values:

Value Meaning
0 not indicated
1 disabled
2 enabled

Type: Int


LtRtCenterMixLevel

Specifies the center channel level for a matrix (LtRt) stereo down mix.

Note: Valid values:

Value Meaning
0 1.414 (+3.0 dB)
1 1.189 (+1.5 dB)
2 1.000 ( 0.0 dB)
3 0.841 (-1.5 dB)
4 0.707 (-3.0 dB)
5 0.595 (-4.5 dB)
6 0.500 (-6.0 dB)
7 0.000 (-inf dB)

Type: Int32


ByteOrder

Byte order of word (UInt16) based output stream

Note: Valid values:

Value Meaning
0 (no change) NativeOrder
1 LittleEndian
2 BigEndian

Type: Int


LtRtSurroundMixLevel

Specifies the surround channel level for a matrix (LtRt) stereo down mix.

Note: Valid values:

Value Meaning
3 0.841 (-1.5 dB)
4 0.707 (-3.0 dB)
5 0.595 (-4.5 dB)
6 0.500 (-6.0 dB)
7 0.000 (-inf dB)

Type: Int32


RoomType

Room type.

Note: Valid values:

Value Meaning
0 Not Indicated
1 Large Room, X curve monitor
2 Small room, flat monitor

Type: Int


LoRoCenterMixLevel

Specifies the center channel level for a conventional (LoRo) stereo down mix.

Note: Valid values:

Value Meaning
0 1.414 (+3.0 dB)
1 1.189 (+1.5 dB)
2 1.000 ( 0.0 dB)
3 0.841 (-1.5 dB)
4 0.707 (-3.0 dB)
5 0.595 (-4.5 dB)
6 0.500 (-6.0 dB)
7 0.000 (-inf dB)

Type: Int32


LoRoSurroundMixLevel

Specifies the surround channel level for a conventional (LoRo) stereo down mix.

Note: Valid values:

Value Meaning
3 0.841 (-1.5 dB)
4 0.707 (-3.0 dB)
5 0.595 (-4.5 dB)
6 0.500 (-6.0 dB)
7 0.000 (-inf dB)

Type: Int32


MixingLevel

Audio production mixing level.

Note: Valid values: 80 (80 DDPENC_PRO__dB) to 111 (111 DDPENC_PRO__dB)

Type: Int


Enumerations:

ChannelConfigs

Encoder channel configuration

Value Name Description
0 CC_11_0 1+1
2 CC_10_0 Mono
9 CC_21_1 2/1, lfe
4 CC_20_0 Stero
6 CC_30_0 3/0
10 CC_31_0 3/1
7 CC_30_1 3/0, lfe
8 CC_21_0 2/1
11 CC_31_1 3/1, lfe
12 CC_22_0 2/2
13 CC_22_1 2/2, lfe
14 CC_32_0 3/2
15 CC_32_1 3/2, lfe
42 CC_34_0 3/4,
43 CC_34_1 3/4, lfe

AudioCodingModes

Encoder channel configuration.

Value Name Description
0 ACMOD_11 0 1+1 C C
7 ACMOD_32 7 3/2 L C R Ls Rs LFE
1 ACMOD_10 1 1/0 C
2 ACMOD_20 2 2/0 L R
3 ACMOD_30 3 3/0 L C R LFE
4 ACMOD_21 4 2/1 L R S LFE
5 ACMOD_31 5 3/1 L C R S LFE
6 ACMOD_22 6 2/2 L R Ls Rs LFE
21 CHCFG_21 21 3/4 L C R Ls Rs Lrs Rrs

Lame Mp3 Compressor [lame]

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


DecodeDelay

Number of audio frames introduced by the audio compressor.

A positive value indicates frames have been added, a negative value indicates frames have been removed. This property may be found on the audio compressor after Begin has been called.

Note: Read-only property.

Type: Int32


Performance

The internal preformance algorithm selection.

True quality is determined by the bit rate but this variable will effect quality by selecting expensive or cheap algorithms.

Note: Range [0, 9]. 0=best (very slow). 9=worst (very fast). Defaults to 2.

Type: Int


RateControlMode

The desired rate control algorithm.

Note: Defaults to CBR.

Type: RateControlModes


BitRate

The desired target bit rate for ABR/CBR mode.

Note: Defaults to 192000.

Type: Int32


Quality

The VBR quality.

Note: Range [0, 9]. 0=best (very slow). 9=worst (very fast). Defaults to 4.

Type: Float


MaximumBitRate

The maximum bit rate for ABR mode.

Note: Defaults to ref BitRate.

Type: Int32


MinimumBitRate

The minimum bit rate for ABR mode.

Note: Defaults to ref BitRate.

Type: Int32


Enumerations:

RateControlModes

Rate control modes.

Value Name Description
0 CBR Constant bit rate
1 ABR Adaptive bit rate
2 VBR Variable bit rate

Apple Lossless Compressor [alac]

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


DecodeDelay

Number of audio frames introduced or removed by the audio compressor.

A positive value indicates frames have been added, a negative value indicates frames have been removed. This property may be found on the audio compressor after Begin has been called.

Note: Read-only property.

Type: Int32


Flac ompressor [flac]

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


DecodeDelay

Number of audio frames introduced or removed by the audio compressor.

A positive value indicates frames have been added, a negative value indicates frames have been removed. This property may be found on the audio compressor after Begin has been called.

Note: Read-only property.

Type: Int32


CompressionLevel

Sets the compression level

The compression level is roughly proportional to the amount of effort the encoder expends to compress the file. A higher level usually means more computation but higher compression. The default level is suitable for most applications.

Currently the levels range from 0 (fastest, least compression) to 8 (slowest, most compression). A value larger than 8 will be treated as 8.

Type: Int32


Main Concept Aac Compressor [mcac]

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


DecodeDelay

Number of audio frames introduced or removed by the audio compressor.

A positive value indicates frames have been added, a negative value indicates frames have been removed. This property may be found on the audio compressor after Begin has been called.

Note: Read-only property.

Type: Int32


Profile

AAC profile as Audio Object Type.

Type: Profiles


BitRate

Encoding bitrate in bits per second.

Can be: 6000, 7000, 8000, 10000, 12000, 14000, 16000, 20000, 24000, 28000, 32000, 40000, 48000, 56000, 64000, 80000, 96000, 112000, 128000, 160000, 192000, 224000, 256000, 320000, 384000, 448000, 512000, 640000 768000, 896000, 1024000.

HEv1 allowd bitrates.

sampling frequency channels minimum bitrate maximum bitrate
16000 1 10000 40000
22050 1 10000 48000
24000 1 10000 48000
32000 1 16000 56000
44100 1 16000 64000
48000 1 16000 64000
16000 2 16000 56000
22050 2 16000 64000
24000 2 16000 64000
32000 2 24000 80000
44100 2 32000 96000
48000 2 32000 96000
16000 3 28000 80000
22050 3 28000 96000
24000 3 28000 96000
32000 3 48000 128000
44100 3 56000 128000
48000 3 56000 128000
16000 4 40000 112000
22050 4 40000 128000
24000 4 40000 128000
32000 4 64000 160000
44100 4 80000 192000
48000 4 80000 192000
16000 5 48000 128000
22050 5 48000 160000
24000 5 48000 160000
32000 5 80000 192000
44100 5 96000 224000
48000 5 96000 224000
16000 6 48000 128000
22050 6 48000 160000
24000 6 48000 160000
32000 6 80000 192000
44100 6 96000 256000
48000 6 96000 256000

HEv2 allowd bitrates.

sampling frequency channels minimum bitrate maximum bitrate
16000 2 10000 40000
22050 2 10000 48000
24000 2 10000 48000
32000 2 16000 56000
44100 2 16000 64000
48000 2 16000 64000

Note: Not all bit rates are valid for all profiles/sample rates.

Type: Int32


MpegVersion

AAC Mpeg version.

Type: MpegVersions


Enumerations:

Profiles

AAC profiles.

Value Name Description
2 LC Low Complexity
5 HEv1 AAC+SBR (Spectral Band Replication) which doubles the core sample rate
29 HEv2 AAC+SBR+PS (Parameteric Stereo) which uses sparse coding to produce stereo from the core mono channel

MpegVersions

AAC mpeg versions.

Value Name Description
0 Mpeg2 AAC as defined in MPEG-2 (ISO 13818-7)
1 Mpeg4 AAC as defined in MPEG-4 (ISO 14496-3)

Main Concept Layer2 Compressor [mc2a]

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


DecodeDelay

Number of audio frames introduced or removed by the audio compressor.

A positive value indicates frames have been added, a negative value indicates frames have been removed. This property may be found on the audio compressor after Begin has been called.

Note: Read-only property.

Type: Int32


Version

The MPEG audio version.

Type: MPEG_VERSION


Layer

The MPEG audio layer.

Type: MPEG_LAYER


BitRate

The desired audio bit rate.

Layer1 Bit Rates Layer2 Bit Rates
32 kbit/sec (mono only) 32 kbit/sec (mono only)
64 kbit/sec 48 kbit/sec (mono only)
96 kbit/sec (mono only) 56 kbit/sec (mono only)
128 kbit/sec 64 kbit/sec
160 kbit/sec 80 kbit/sec (mono only)
192 kbit/sec 96 kbit/sec
224 kbit/sec 112 kbit/sec
256 kbit/sec 128 kbit/sec
288 kbit/sec 160 kbit/sec
320 kbit/sec 192 kbit/sec
352 kbit/sec 224 kbit/sec (stereo only)
384 kbit/sec 256 kbit/sec (stereo only)
416 kbit/sec 320 kbit/sec (stereo only)
448 kbit/sec 384 kbit/sec (stereo only)

Type: Int64


Enumerations:

MPEG_VERSION

Valid values for the Version property.

Value Name Description
0 MPEG2 MPEG-2
1 MPEG1 MPEG-1

MPEG_LAYER

Valid values for the Layer property.

Value Name Description
3 Layer1 MPEG Layer 1
2 Layer2 MPEG Layer 2

DTS-HD Audio Compressor [dtsh]

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


DecodeDelay

Number of audio frames introduced or removed by the audio compressor.

A positive value indicates frames have been added, a negative value indicates frames have been removed. This property may be found on the audio compressor after Begin has been called.

Note: Read-only property.

Type: Int32


BitRate

Target bitrate for the encode.

The supported bitrate must be one of 255000, 384000, or 768000. Any other values will result in the SDK rejecting the configuration. When the bitrate is 768000, the SDK will encode to DTS Digital Surround Audio. For bitrates of 255000 or 384000, the SDK will encode to DTS Express Audio.

Type: Int64


EnableT1CC

Embed T1CC flag in encoded bitstream.

When non-zero, the Type One Certified Content (T1CC) flag will be set in the encoded audio.

Note: Defaults to false.

Type: Bool


FrameRate

SMPTE Frame Rate.

The encoded audio file generated with the SDK contains an SMPTE Timecode and associated SMPTE Frame Rate. tcRate may be 0 to 7, inclusive, 9 or 11.

Note: Default is 0 (FrameRate_23_976).

Type: FrameRateType


StartTimeCode

SMPTE Start Timecode

The encoded audio generated contains an SMPTE Timecode. By default the timecode is ‘00:00:00:00’. The Timecode may be set to a valid drop (00:00:01;00) or non-drop SMPTE Timecode (00:00:01:00).

Note: Default is ‘00:00:00:00’.

Type: String


Enumerations:

FrameRateType

Property values for FrameRate.

Value Name Description
11 FrameRate_60 60
3 FrameRate_29_97_Drop 29.97 Drop Frame
1 FrameRate_24 24
0 FrameRate_23_976 23.976
7 FrameRate_50 50
2 FrameRate_25 24
4 FrameRate_29_97 29.97
5 FrameRate_30_Drop 30 Drop Frame
6 FrameRate_30 30
9 FrameRate_59_94 59.94

DTS:X Audio Compressor [dtsx]

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


DecodeDelay

Number of audio frames introduced or removed by the audio compressor.

A positive value indicates frames have been added, a negative value indicates frames have been removed. This property may be found on the audio compressor after Begin has been called.

Note: Read-only property.

Type: Int32


LoudnessMeasurement

Loudness measurement mode.

The DTS:X audio output may containe an embedded loudness value from -40.0 LKFS to 0.0 LKFS. For some of the loudness modes (Input, Target), the LKFS property will be used. For other modes, the LKFS member will be ignored.

Type: LoudnessMeasurementType


BitRate

Target bitrate for the encode.

The supported bitrate must be one of 160000, 192000, 224000, 256000, 288000, 320000, 384000, or 448000. Any other values will result in the SDK rejecting the configuration.

Type: Int64


StartTimeCode

SMPTE Start Timecode

The encoded audio generated contains an SMPTE Timecode. The Timecode may be set to a valid drop (00:00:01;00) or non-drop SMPTE Timecode (00:00:01:00).

Note: By default the timecode is ‘00:00:00:00’.

Type: String


LKFS

Loudness, K-weighted, relative to full scale.

The value in LKFS may range from -40.0 to 0.0. Depending on the setting for the LoudnessMeasurement, the LKFS value may be ignored, stored directly as the embedded loudness value in the output DTS:X audio bitstream, or the output DTS:X audio may have its loudness adjusted to have the loudess specified in LKFS.

Type: Float


SyncInterval

Sync internval in seconds.

DTS:X Profile 2 audio contains periodic synchronization frames, separated by some number of non-synchronization frames. When SyncInterval is set to a value greater than zero, synchronization frames will be generated as close to that number of seconds as possible, dithering where necessary. A value of 1 in SyncInterval will generate a synchronization frame in the output DTS:X Profile 2 audio every second.

Note: Valid values for SyncInterval are 0 to 10, inclusive. SyncInterval will not be used if it is zero or if SyncIntervalFrames is non-zero. Should both SyncIntervalFrames and SyncInterval be zero, a default synchronization frame interval of 47 will be used.

Type: Int32


SyncIntervalFrames

Sync interval in DTS:X Profile 2 frames.

DTS:X Profile 2 audio contains periodic synchronization frames, separated by some number of non-synchronization frames. If a specific synchronization interval is required, set SyncIntervalFrames to that interval. Setting SyncIntervalFrames to 47 will generate a synchronization frame in the output DTS:X Profile 2 audio every 47 frames.

Note: Valid values for SyncIntervalFrames are: 0, 47, 94, 141, 188, 235, 282, 329, 376, 423, and 470 SyncIntervalFrames will not be used if it is zero. Should both SyncIntervalFrames and SyncInterval be zero, a default synchronization frame interval of 47 will be used.

Type: Int32


EnableT1CC

Embed T1CC flag in encoded bitstream.

When non-zero, the Type One Certified Content (T1CC) flag will be set in the encoded audio.

Note: Defaults to false.

Type: Bool


FrameRate

SMPTE Frame Rate.

The encoded audio file generated with the SDK contains an SMPTE Timecode and associated SMPTE Frame Rate. tcRate may be 0 to 7, inclusive, 9 or 11.

Note: Default is 0 (FrameRate_23_976).

Type: FrameRateType


Enumerations:

FrameRateType

Property values for FrameRate.

Value Name Description
11 FrameRate_60 60
3 FrameRate_29_97_Drop 29.97 Drop Frame
1 FrameRate_24 24
0 FrameRate_23_976 23.976
7 FrameRate_50 50
2 FrameRate_25 24
4 FrameRate_29_97 29.97
5 FrameRate_30_Drop 30 Drop Frame
6 FrameRate_30 30
9 FrameRate_59_94 59.94

LoudnessMeasurementType

Property values for LoudnessMeasurement.

Value Name Description
0 LoudnessMeasurement_None Loudness information will not be stored in the encoded .dtsx file.
1 LoudnessMeasurement_Detect Loudness of the source audio will be determined and stored in the encoded .dtsx file.
2 LoudnessMeasurement_Input The LKFS value supplied by the client in the config structure will be stored in the encoded .dtsx file.
3 LoudnessMeasurement_Target Loudness of the source audio will be adjusted to the LKFS value supplied by the client in the config structure. The resulting loudness value will be stored in the encoded .dtsx file.

Wma Compressor [wma ]

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


DecodeDelay

Number of audio frames introduced or removed by the audio compressor.

A positive value indicates frames have been added, a negative value indicates frames have been removed. This property may be found on the audio compressor after Begin has been called.

Note: Read-only property.

Type: Int32


Quality

Encoding quality.

Used only in VBR modes. Valid values range from 0-100.

Note: Default value is 90.

Type: Int32


CodingMethod

Rate control method.

Valid values include:

Value Meaning
0 AudioCodingOnePassCBR
1 AudioCodingTwoPassCBR
2 AudioCodingOnePassVBR
3 AudioCodingTwoPassVBR
4 AudioCodingTwoPassConstrainedVBR

Note: Default is AudioCodingOnePassCBR. Currently, two pass encoding is not supported.

Type: Int32


BitRate

Encoding bitrate.

Note: Default is 128000.

Type: Int32