@bitmovin/api-sdk/dist/models/H265VideoConfiguration.d.ts

Bitmovin JS/TS API SDK

import AdaptiveQuantMode from './AdaptiveQuantMode';
import AutoLevelSetup from './AutoLevelSetup';
import BAdapt from './BAdapt';
import Cea608708SubtitleConfiguration from './Cea608708SubtitleConfiguration';
import CodecConfigType from './CodecConfigType';
import ForceFlushMode from './ForceFlushMode';
import H265DynamicRangeFormat from './H265DynamicRangeFormat';
import LevelH265 from './LevelH265';
import LimitReferences from './LimitReferences';
import LimitTransformUnitDepthRecursionMode from './LimitTransformUnitDepthRecursionMode';
import MaxCtuSize from './MaxCtuSize';
import MaxTransformUnitSize from './MaxTransformUnitSize';
import MinCodingUnitSize from './MinCodingUnitSize';
import MotionSearch from './MotionSearch';
import PresetConfiguration from './PresetConfiguration';
import ProfileH265 from './ProfileH265';
import QuantizationGroupSize from './QuantizationGroupSize';
import RateDistortionLevelForQuantization from './RateDistortionLevelForQuantization';
import RateDistortionPenaltyMode from './RateDistortionPenaltyMode';
import TransformSkipMode from './TransformSkipMode';
import TuInterDepth from './TuInterDepth';
import TuIntraDepth from './TuIntraDepth';
import VideoConfiguration from './VideoConfiguration';
import VideoFormat from './VideoFormat';
/**
 * @export
 * @class H265VideoConfiguration
 */
export declare class H265VideoConfiguration extends VideoConfiguration {
    /**
     * Discriminator property for CodecConfiguration
     * @type {string}
     * @memberof H265VideoConfiguration
     */
    readonly type: CodecConfigType;
    /**
     * Choose from a set of preset configurations tailored for common use cases. Check out [H265 Presets](https://bitmovin.com/docs/encoding/tutorials/h265-presets) to see which values get applied by each preset. Explicitly setting a property to a different value will override the preset's value for that property.
     * @type {PresetConfiguration}
     * @memberof H265VideoConfiguration
     */
    presetConfiguration?: PresetConfiguration;
    /**
     * Automatically configures the H265 Video Codec to be compatible with the given SDR/HDR format. Bitmovin recommends to use the dynamic range format together with a preset configuration to achieve good results. Explicitly configured properties will take precedence over dynamic range format settings, which in turn will take precedence over preset configurations.
     * @type {H265DynamicRangeFormat}
     * @memberof H265VideoConfiguration
     */
    dynamicRangeFormat?: H265DynamicRangeFormat;
    /**
     * Constant rate factor for quality-based variable bitrate. Either bitrate or crf is required.
     * @type {number}
     * @memberof H265VideoConfiguration
     */
    crf?: number;
    /**
     * @type {ProfileH265}
     * @memberof H265VideoConfiguration
     */
    profile?: ProfileH265;
    /**
     * Amount of b frames
     * @type {number}
     * @memberof H265VideoConfiguration
     */
    bframes?: number;
    /**
     * Amount of reference frames
     * @type {number}
     * @memberof H265VideoConfiguration
     */
    refFrames?: number;
    /**
     * Quantization factor
     * @type {number}
     * @memberof H265VideoConfiguration
     */
    qp?: number;
    /**
     * Maximum Bitrate (bps)
     * @type {number}
     * @memberof H265VideoConfiguration
     */
    maxBitrate?: number;
    /**
     * Minimum Bitrate (bps)
     * @type {number}
     * @memberof H265VideoConfiguration
     */
    minBitrate?: number;
    /**
     * Size of the VBV buffer (bits)
     * @type {number}
     * @memberof H265VideoConfiguration
     */
    bufsize?: number;
    /**
     * Minimum GOP length, the minimum distance between I-frames
     * @type {number}
     * @memberof H265VideoConfiguration
     */
    minGop?: number;
    /**
     * Maximum GOP length, the maximum distance between I-frames
     * @type {number}
     * @memberof H265VideoConfiguration
     */
    maxGop?: number;
    /**
     * Enable open-gop, allows referencing frames from a previous gop
     * @type {boolean}
     * @memberof H265VideoConfiguration
     */
    openGop?: boolean;
    /**
     * Minimum interval in seconds between key frames
     * @type {number}
     * @memberof H265VideoConfiguration
     */
    minKeyframeInterval?: number;
    /**
     * Maximum interval in seconds between key frames
     * @type {number}
     * @memberof H265VideoConfiguration
     */
    maxKeyframeInterval?: number;
    /**
     * @type {LevelH265}
     * @memberof H265VideoConfiguration
     */
    level?: LevelH265;
    /**
     * Number of frames for slice-type decision lookahead
     * @type {number}
     * @memberof H265VideoConfiguration
     */
    rcLookahead?: number;
    /**
     * Set the level of effort in determining B frame placement
     * @type {BAdapt}
     * @memberof H265VideoConfiguration
     */
    bAdapt?: BAdapt;
    /**
     * @type {MaxCtuSize}
     * @memberof H265VideoConfiguration
     */
    maxCTUSize?: MaxCtuSize;
    /**
     * @type {TuIntraDepth}
     * @memberof H265VideoConfiguration
     */
    tuIntraDepth?: TuIntraDepth;
    /**
     * @type {TuInterDepth}
     * @memberof H265VideoConfiguration
     */
    tuInterDepth?: TuInterDepth;
    /**
     * @type {MotionSearch}
     * @memberof H265VideoConfiguration
     */
    motionSearch?: MotionSearch;
    /**
     * Set the amount of subpel refinement to perform.
     * @type {number}
     * @memberof H265VideoConfiguration
     */
    subMe?: number;
    /**
     * Set the Motion search range.
     * @type {number}
     * @memberof H265VideoConfiguration
     */
    motionSearchRange?: number;
    /**
     * Enable weighted prediction in P slices
     * @type {boolean}
     * @memberof H265VideoConfiguration
     */
    weightPredictionOnPSlice?: boolean;
    /**
     * Enable weighted prediction in B slices
     * @type {boolean}
     * @memberof H265VideoConfiguration
     */
    weightPredictionOnBSlice?: boolean;
    /**
     * Toggle sample adaptive offset loop filter
     * @type {boolean}
     * @memberof H265VideoConfiguration
     */
    sao?: boolean;
    /**
     * Set the mastering display color volume SEI info (SMPTE ST 2086). For example `G(13250,34500)B(7500,3000)R(34000,16000)WP(15635,16450)L(10000000,1)` describes a P3D65 1000-nits monitor, where G(x=0.265, y=0.690), B(x=0.150, y=0.060), R(x=0.680, y=0.320), WP(x=0.3127, y=0.3290), L(max=1000, min=0.0001). Part of HDR-10 metadata. If used on a Dolby Vision stream, this value must be set to `G(13250,34500)B(7500,3000)R(34000,16000)WP(15635,16450)L(10000000,1)`.
     * @type {string}
     * @memberof H265VideoConfiguration
     */
    masterDisplay?: string;
    /**
     * Set the max content light level (MaxCLL). Use together with maxPictureAverageLightLevel (which will be 0 if not set). Part of HDR-10 metadata.
     * @type {number}
     * @memberof H265VideoConfiguration
     */
    maxContentLightLevel?: number;
    /**
     * Set the maximum picture average light level (MaxFALL). Use together with maxContentLightLevel (which will be 0 if not set). Part of HDR-10 metadata.
     * @type {number}
     * @memberof H265VideoConfiguration
     */
    maxPictureAverageLightLevel?: number;
    /**
     * Force signaling of HDR parameters in SEI packets. Enabled automatically when masterDisplay or maxContentLightLevel/maxPictureAverageLightLevel are set. Useful when there is a desire to signal 0 values for maxContentLightLevel and maxPictureAverageLightLevel.
     * @type {boolean}
     * @memberof H265VideoConfiguration
     */
    hdr?: boolean;
    /**
     * Scene Change sensitivity. The higher the value, the more likely an I-Frame will be inserted. Set to 0 to disable it.
     * @type {number}
     * @memberof H265VideoConfiguration
     */
    sceneCutThreshold?: number;
    /**
     * Controls the adaptive quantization algorithm
     * @type {AdaptiveQuantMode}
     * @memberof H265VideoConfiguration
     */
    adaptiveQuantizationMode?: AdaptiveQuantMode;
    /**
     * Enable SDR compatible HLG signaling. The container and bitstream will indicate BT.2020 but ARIB STD-B67 will be signaled in the alternative transfer characteristics SEI message.
     * @type {boolean}
     * @memberof H265VideoConfiguration
     */
    enableHlgSignaling?: boolean;
    /**
     * Specifies the source format of the original analog video prior to digitizing and encoding
     * @type {VideoFormat}
     * @memberof H265VideoConfiguration
     */
    videoFormat?: VideoFormat;
    /**
     * Psycho-visual rate-distortion retains fine details like film grain at the expense of more blocking artifacts. Higher values make the video appear sharper and more detailed but with a higher risk of blocking artifacts. Needs to have subMe with RD_IP, RD_ALL, RD_REF_IP, RD_REF_ALL, QPRD or FULL_RD
     * @type {number}
     * @memberof H265VideoConfiguration
     */
    psyRateDistortionOptimization?: number;
    /**
     * Strength of psycho-visual optimizations in quantization. Only has an effect in presets which use RDOQ (rd-levels 4 and 5). The value must be between 0 and 50, 1.0 is typical
     * @type {number}
     * @memberof H265VideoConfiguration
     */
    psyRateDistortionOptimizedQuantization?: number;
    /**
     * Signal hypothetical reference decoder (HRD) information
     * @type {boolean}
     * @memberof H265VideoConfiguration
     */
    enableHrdSignaling?: boolean;
    /**
     * Enables the use of lookahead’s lowres motion vector fields to determine the amount of reuse of each block to tune adaptive quantization factors.
     * @type {boolean}
     * @memberof H265VideoConfiguration
     */
    cutree?: boolean;
    /**
     * Minimum CU size (width and height). By using 16 or 32 the encoder will not analyze the cost of CUs below that minimum threshold, saving considerable amounts of compute with a predictable increase in bitrate. This setting has a large effect on performance on the faster presets.
     * @type {MinCodingUnitSize}
     * @memberof H265VideoConfiguration
     */
    minCodingUnitSize?: MinCodingUnitSize;
    /**
     * Use multiple worker threads to measure the estimated cost of each frame within the lookahead. The higher this parameter, the less accurate the frame costs will be which will result in less accurate B-frame and scene-cut decisions. Valid range: 0 - 16
     * @type {number}
     * @memberof H265VideoConfiguration
     */
    lookaheadSlices?: number;
    /**
     * If enabled, limit references per depth, CU or both.
     * @type {LimitReferences}
     * @memberof H265VideoConfiguration
     */
    limitReferences?: LimitReferences;
    /**
     * Enable analysis of rectangular motion partitions Nx2N and 2NxN.
     * @type {boolean}
     * @memberof H265VideoConfiguration
     */
    rectangularMotionPartitionsAnalysis?: boolean;
    /**
     * Enable analysis of asymmetric motion partitions.
     * @type {boolean}
     * @memberof H265VideoConfiguration
     */
    asymetricMotionPartitionsAnalysis?: boolean;
    /**
     * When enabled, will limit modes analyzed for each CU using cost metrics from the 4 sub-CUs. This can significantly improve performance when `rectangularMotionPartitionsAnalysis` and/or `asymetricMotionPartitionsAnalysis` are enabled at minimal compression efficiency loss.
     * @type {boolean}
     * @memberof H265VideoConfiguration
     */
    limitModes?: boolean;
    /**
     * Maximum number of neighbor (spatial and temporal) candidate blocks that the encoder may consider for merging motion predictions. Valid range: 1 - 5
     * @type {number}
     * @memberof H265VideoConfiguration
     */
    maxMerge?: number;
    /**
     * Measure 2Nx2N merge candidates first; if no residual is found, additional modes at that depth are not analysed.
     * @type {boolean}
     * @memberof H265VideoConfiguration
     */
    earlySkip?: boolean;
    /**
     * If enabled exits early from CU depth recursion. When a skip CU is found, additional heuristics are used to decide whether to terminate recursion.
     * @type {boolean}
     * @memberof H265VideoConfiguration
     */
    recursionSkip?: boolean;
    /**
     * Enable faster search method for angular intra predictions.
     * @type {boolean}
     * @memberof H265VideoConfiguration
     */
    fastSearchForAngularIntraPredictions?: boolean;
    /**
     * Enables the evaluation of intra modes in B slices.
     * @type {boolean}
     * @memberof H265VideoConfiguration
     */
    evaluationOfIntraModesInBSlices?: boolean;
    /**
     * Hide sign bit of one coefficient per coding tree unit.
     * @type {boolean}
     * @memberof H265VideoConfiguration
     */
    signHide?: boolean;
    /**
     * Level of rate-distortion optimization in mode decision. The lower the value the faster the encode, the higher the value higher the compression efficiency. Valid range: 0 - 4
     * @type {number}
     * @memberof H265VideoConfiguration
     */
    rateDistortionLevelForModeDecision?: number;
    /**
     * Specifies the amount of rate-distortion analysis to use within quantization.
     * @type {RateDistortionLevelForQuantization}
     * @memberof H265VideoConfiguration
     */
    rateDistortionLevelForQuantization?: RateDistortionLevelForQuantization;
    /**
     * Minimum quantization factor. Valid value range: 0 - 69
     * @type {number}
     * @memberof H265VideoConfiguration
     */
    qpMin?: number;
    /**
     * Maximum quantization factor. Valid value range: 0 - 69
     * @type {number}
     * @memberof H265VideoConfiguration
     */
    qpMax?: number;
    /**
     * The encoder may begin encoding a row as soon as the row above it is at least two CTUs ahead in the encode process. Default is enabled.
     * @type {boolean}
     * @memberof H265VideoConfiguration
     */
    wavefrontParallelProcessing?: boolean;
    /**
     * Encode each incoming frame as multiple parallel slices that may be decoded independently. Default is 1.
     * @type {number}
     * @memberof H265VideoConfiguration
     */
    slices?: number;
    /**
     * Copy buffers of input picture in frame. Default is enabled.
     * @type {boolean}
     * @memberof H265VideoConfiguration
     */
    copyPicture?: boolean;
    /**
     * If high tier is disabled the encoder will attempt to encode only at the main tier. Default is enabled.
     * @type {boolean}
     * @memberof H265VideoConfiguration
     */
    levelHighTier?: boolean;
    /**
     * Enable skipping split rate distortion analysis when sum of split CU RD cost larger than one split CU RD cost for intra CU. Default disabled.
     * @type {boolean}
     * @memberof H265VideoConfiguration
     */
    skipSplitRateDistortionAnalysis?: boolean;
    /**
     * If enabled, consider lossless mode in CU RDO decisions. Default is disabled.
     * @type {boolean}
     * @memberof H265VideoConfiguration
     */
    codingUnitLossless?: boolean;
    /**
     * Enable evaluation of transform skip (bypass DCT but still use quantization) coding for 4x4 TU coded blocks. Default is NONE.
     * @type {TransformSkipMode}
     * @memberof H265VideoConfiguration
     */
    transformSkip?: TransformSkipMode;
    /**
     * Enable QP based rate distortion refinement. Default is disabled.
     * @type {boolean}
     * @memberof H265VideoConfiguration
     */
    refineRateDistortionCost?: boolean;
    /**
     * Enables early exit from transform unit depth recursion, for inter coded blocks. Default is DISABLED.
     * @type {LimitTransformUnitDepthRecursionMode}
     * @memberof H265VideoConfiguration
     */
    limitTransformUnitDepthRecursion?: LimitTransformUnitDepthRecursionMode;
    /**
     * An integer value, which denotes strength of noise reduction in intra CUs. Default 0.
     * @type {number}
     * @memberof H265VideoConfiguration
     */
    noiseReductionIntra?: number;
    /**
     * An integer value, which denotes strength of noise reduction in inter CUs. Default 0.
     * @type {number}
     * @memberof H265VideoConfiguration
     */
    noiseReductionInter?: number;
    /**
     * Penalty for 32x32 intra transform units in non-I slices. Default DISABLED.
     * @type {RateDistortionPenaltyMode}
     * @memberof H265VideoConfiguration
     */
    rateDistortionPenalty?: RateDistortionPenaltyMode;
    /**
     * Penalty for 32x32 intra transform units in non-I slices. Default DISABLED.
     * @type {MaxTransformUnitSize}
     * @memberof H265VideoConfiguration
     */
    maximumTransformUnitSize?: MaxTransformUnitSize;
    /**
     * Increases the RD level at points where quality drops due to VBV rate control enforcement. Default 0.
     * @type {number}
     * @memberof H265VideoConfiguration
     */
    dynamicRateDistortionStrength?: number;
    /**
     * It is used for mode selection during analysis of CTUs and can achieve significant gain in terms of objective quality metrics SSIM and PSNR. Default false.
     * @type {boolean}
     * @memberof H265VideoConfiguration
     */
    ssimRateDistortionOptimization?: boolean;
    /**
     * Enable temporal motion vector predictors in P and B slices. Default true.
     * @type {boolean}
     * @memberof H265VideoConfiguration
     */
    temporalMotionVectorPredictors?: boolean;
    /**
     * Enable motion estimation with source frame pixels, in this mode, motion estimation can be computed independently. Default false.
     * @type {boolean}
     * @memberof H265VideoConfiguration
     */
    analyzeSourceFramePixels?: boolean;
    /**
     * Enable strong intra smoothing for 32x32 intra blocks. Default true.
     * @type {boolean}
     * @memberof H265VideoConfiguration
     */
    strongIntraSmoothing?: boolean;
    /**
     * When generating intra predictions for blocks in inter slices, only intra-coded reference pixels are used. Default false.
     * @type {boolean}
     * @memberof H265VideoConfiguration
     */
    constrainedIntraPrediction?: boolean;
    /**
     * This value represents the percentage difference between the inter cost and intra cost of a frame used in scenecut detection. Default 5.0.
     * @type {number}
     * @memberof H265VideoConfiguration
     */
    scenecutBias?: number;
    /**
     * Number of RADL pictures allowed infront of IDR. Requires fixed keyframe interval. Valid values 0 - `bframes`. Default 0.
     * @type {number}
     * @memberof H265VideoConfiguration
     */
    allowedRADLBeforeIDR?: number;
    /**
     * Number of frames for GOP boundary decision lookahead. Valid values 0 - `rcLookahead`. Default 0
     * @type {number}
     * @memberof H265VideoConfiguration
     */
    gopLookahead?: number;
    /**
     * Bias towards B frames in slicetype decision. The higher the bias the more likely the encoder is to use B frames. Default 0
     * @type {number}
     * @memberof H265VideoConfiguration
     */
    bframeBias?: number;
    /**
     * Force the encoder to flush frames. Default is DISABLED.
     * @type {ForceFlushMode}
     * @memberof H265VideoConfiguration
     */
    forceFlush?: ForceFlushMode;
    /**
     * Adjust the strength of the adaptive quantization offsets. Default 1.0.
     * @type {number}
     * @memberof H265VideoConfiguration
     */
    adaptiveQuantizationStrength?: number;
    /**
     * Adjust the AQ offsets based on the relative motion of each block with respect to the motion of the frame. Default false.
     * @type {boolean}
     * @memberof H265VideoConfiguration
     */
    adaptiveQuantizationMotion?: boolean;
    /**
     * Enable adaptive quantization for sub-CTUs. This parameter specifies the minimum CU size at which QP can be adjusted. Default is same as `maxCTUSize`.
     * @type {QuantizationGroupSize}
     * @memberof H265VideoConfiguration
     */
    quantizationGroupSize?: QuantizationGroupSize;
    /**
     * Enables stricter conditions to control bitrate deviance from the target bitrate in ABR mode. Bit rate adherence is prioritised over quality. Default false.
     * @type {boolean}
     * @memberof H265VideoConfiguration
     */
    strictCbr?: boolean;
    /**
     * Offset of Cb chroma QP from the luma QP selected by rate control. This is a general way to spend more or less bits on the chroma channel. Default 0
     * @type {number}
     * @memberof H265VideoConfiguration
     */
    qpOffsetChromaCb?: number;
    /**
     * Offset of Cr chroma QP from the luma QP selected by rate control. This is a general way to spend more or less bits on the chroma channel. Default 0
     * @type {number}
     * @memberof H265VideoConfiguration
     */
    qpOffsetChromaCr?: number;
    /**
     * QP ratio factor between I and P slices. This ratio is used in all of the rate control modes. Default 1.4
     * @type {number}
     * @memberof H265VideoConfiguration
     */
    ipRatio?: number;
    /**
     * QP ratio factor between P and B slices. This ratio is used in all of the rate control modes. Default 1.3
     * @type {number}
     * @memberof H265VideoConfiguration
     */
    pbRatio?: number;
    /**
     * Quantizer curve compression factor. It weights the frame quantizer based on the complexity of residual (measured by lookahead). Default 0.6
     * @type {number}
     * @memberof H265VideoConfiguration
     */
    quantizerCurveCompressionFactor?: number;
    /**
     * The maximum single adjustment in QP allowed to rate control. Default 4
     * @type {number}
     * @memberof H265VideoConfiguration
     */
    qpStep?: number;
    /**
     * Enables a specialised ratecontrol algorithm for film grain content. Default false.
     * @type {boolean}
     * @memberof H265VideoConfiguration
     */
    grainOptimizedRateControl?: boolean;
    /**
     * Temporally blur quants. Default 0.5
     * @type {number}
     * @memberof H265VideoConfiguration
     */
    blurQuants?: number;
    /**
     * Temporally blur complexity. Default 20.0
     * @type {number}
     * @memberof H265VideoConfiguration
     */
    blurComplexity?: number;
    /**
     * Specify how to handle depencency between SAO and deblocking filter. When enabled, non-deblocked pixels are used for SAO analysis. When disabled, SAO analysis skips the right/bottom boundary areas. Default false.
     * @type {boolean}
     * @memberof H265VideoConfiguration
     */
    saoNonDeblock?: boolean;
    /**
     * Limit SAO filter computation by early terminating SAO process based on inter prediction mode, CTU spatial-domain correlations, and relations between luma and chroma. Default false.
     * @type {boolean}
     * @memberof H265VideoConfiguration
     */
    limitSao?: boolean;
    /**
     * Will use low-pass subband dct approximation instead of the standard dct for 16x16 and 32x32 blocks. Default false.
     * @type {boolean}
     * @memberof H265VideoConfiguration
     */
    lowpassDct?: boolean;
    /**
     * Defines whether CEA 608/708 subtitles are extracted from the input video stream
     * @type {Cea608708SubtitleConfiguration}
     * @memberof H265VideoConfiguration
     */
    cea608708SubtitleConfig?: Cea608708SubtitleConfiguration;
    /**
     * Enable/disable automatic calculation of level, maxBitrate, and bufsize based on the least level that satisfies maximum property values for picture resolution, frame rate, and bit rate. In the case the target level is set explicitly, the maximum bitrate and buffer size are calculated based on the defined level. Explicitly setting maxBitrate, or bufsize properties will disable the automatic calculation.
     * @type {AutoLevelSetup}
     * @memberof H265VideoConfiguration
     */
    autoLevelSetup?: AutoLevelSetup;
    constructor(obj?: Partial<H265VideoConfiguration>);
}
export default H265VideoConfiguration;