D3D12_VIDEO_ENCODER_SEQUENCE_CONTROL_DESC structure (d3d12video.h)

Represents parameters for the input of the video encoding operation at a sequence level.

Syntax

typedef struct D3D12_VIDEO_ENCODER_SEQUENCE_CONTROL_DESC {
  D3D12_VIDEO_ENCODER_SEQUENCE_CONTROL_FLAGS                 Flags;
  D3D12_VIDEO_ENCODER_INTRA_REFRESH                          IntraRefreshConfig;
  D3D12_VIDEO_ENCODER_RATE_CONTROL                           RateControl;
  D3D12_VIDEO_ENCODER_PICTURE_RESOLUTION_DESC                PictureTargetResolution;
  D3D12_VIDEO_ENCODER_FRAME_SUBREGION_LAYOUT_MODE            SelectedLayoutMode;
  D3D12_VIDEO_ENCODER_PICTURE_CONTROL_SUBREGIONS_LAYOUT_DATA FrameSubregionsLayoutData;
  D3D12_VIDEO_ENCODER_SEQUENCE_GOP_STRUCTURE                 CodecGopSequence;
} D3D12_VIDEO_ENCODER_SEQUENCE_CONTROL_DESC;

Members

Flags

A bitwise OR combination of values from the D3D12_VIDEO_ENCODER_SEQUENCE_CONTROL_FLAGS enumeration specifying the sequence control descriptor flags for the current operation.

IntraRefreshConfig

A D3D12_VIDEO_ENCODER_INTRA_REFRESH structure specifying the parameters for the intra-refresh mode that should be used when triggering intra-refresh sessions.

The use of bidirectional reference frames (B Frames) is mutually exclusive with intra-refresh. Callers should verify that the GOP structure doesn't contain B frames if intra-refresh modes are active. When querying for D3D12_FEATURE_DATA_VIDEO_ENCODER_SUPPORT with an intra-refresh mode other than D3D12_VIDEO_ENCODER_INTRA_REFRESH_MODE_NONE, the specified D3D12_VIDEO_ENCODER_SEQUENCE_GOP_STRUCTURE set must not contain B frames, or the query will return no support.

The usage of infinite intra-refresh is possible by requesting periodically a new wave of intra-refresh after each of them finishes.

When starting an intra-refresh of N frames of duration, the hosts sets the corresponding picture control flag to start intra-refresh and controls the frame index between [0..N) also in the picture control structure to hint the driver about the progress about the intra refresh session.

Expected behaviour when explicitly requesting an intra refresh wave with duration N frames:

• If the request for intra-refresh happens at the beginning of a GOP, the intra refresh ocurrs for N frames and then a new GOP is started with an I frame.

• If the request for intra-refresh happens in the middle of a GOP, the group of pictures will be ended until the last EncodeFrame command submitted and restarted after the intra-refresh session with a new GOP starting with an I frame. For example, when the GOP is IPPPP...IPPPP..., if the intra-refresh start is requested at the "IPP" partial submission of the GOP, the last two P frames of that GOP will be ignored, the intra-refresh session will be issued for the N next frames and then a new key-frame that restarts the GOP structure is expected.

• For row-based intra-refresh, the configured GOP structure will have to be reconfigured to Infinite IPPP...P... GOP (GOPLength = 0u and PPicturePeriod = 1u) for the duration of the intra refresh session. It can then be reconfigured again after the IR wave finished.

• For row based intra-refresh, the configured subregion partitioning mode will be reconfigured to correspond with N uniform slices partitioning per frame for a duration of N EncodeFrame commands. This is particularly important for when the subregion partitioning is set to an incompatible mode with IR requirements, for example when the row of intra coded units in a slice will disrupt the limitation set to bytes per slice. The expectation for row-based intra refresh is that the resulting frame contains N slices, all P slices, except the current intra refresh row slice, which has to be an I slice.

RateControl

A D3D12_VIDEO_ENCODER_RATE_CONTROL structure specifying the rate control configuration.

Check support for rate control dynamic reconfiguration in D3D12_VIDEO_ENCODER_SUPPORT_FLAG_RATE_CONTROL_RECONFIGURATION_AVAILABLE. If rate control dynamic reconfiguration is allowed, by modifying RateControl, the rate control algorithm is restarted with the new configuration starting from the execution of the associated EncodeFrame. Otherwise this should be set at the beginning of the encoding session and not changed after.

PictureTargetResolution

A D3D12_VIDEO_ENCODER_PICTURE_RESOLUTION_DESC structure describing the resolution to use when encoding this frame.

Check support for resolution dynamic reconfiguration in D3D12_VIDEO_ENCODER_SUPPORT_FLAG_RESOLUTION_RECONFIGURATION_AVAILABLE. If no support is given for this, PictureTargetResolution indicates the target resolution of the full encoding session and must not be changed during the encoding session. Otherwise this indicates the resolution used for the associated EncodeFrame command.

The target must be set based on the list of resolutions specified when creating the associated encoder heap for this operation.

For some codecs, A change in resolution in the middle of the encoding session might require a GOP to be reset with a potential force IDR/Key frame request, and also might require resetting the DPB buffer/frame management algorithms.

SelectedLayoutMode

A value from the D3D12_VIDEO_ENCODER_FRAME_SUBREGION_LAYOUT_MODE enumeration specifying which layout mode is being used and therefore which union members to use in pFrameSubregionsLayoutData.

Check support for subregion dynamic reconfiguration in [D3D12_VIDEO_ENCODER_SUPPORT_FLAG_SUBREGION_LAYOUT_RECONFIGURATION_AVAILABLE]((ne-d3d12video-d3d12_video_encoder_support_flags.md). If no support is given for this, this indicates the target subregion mode of the full encoding session and must not be changed during the encoding session. Otherwise this indicates the subregion partitioning mode used for the associated EncodeFrame command.

FrameSubregionsLayoutData

A D3D12_VIDEO_ENCODER_PICTURE_CONTROL_SUBREGIONS_LAYOUT_DATA structure specifying picture subregions layout optional codec-specific data. If the specified SelectedLayoutMode value indicates that such that there are no subregions, null is expected.

CodecGopSequence

A D3D12_VIDEO_ENCODER_SEQUENCE_GOP_STRUCTURE structure specifying the current GOP used in the video sequence, in display order. Calls to EncodeFrame must follow this GOP but in encode order after B-Frames reordering.

Check support for GOP dynamic reconfiguration in D3D12_VIDEO_ENCODER_SUPPORT_FLAG_SEQUENCE_GOP_RECONFIGURATION_AVAILABLE. If no support is given for this, CodecGopSequence indicates the target GOP pattern (in display order) of the full encoding session and must not be changed during the encoding session. Otherwise this indicates the new GOP subregion mode used starting at the associated EncodeFrame command.

Requirements

Requirement	Value
Minimum supported client	Windows Build 22000
Minimum supported server	Windows Build 22000
Header	d3d12video.h