mediaway-encoder 0.1.4

Hardware-accelerated video/audio encoding (OS-native backends)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
//! `open`-time D3D12 object creation: device/queue/allocator/list objects, feature-support
//! queries, and the `ID3D12VideoEncoder`/`ID3D12VideoEncoderHeap` pair.

use crate::{EncodeError, RateControlConfig};
use mediaway_common::NativeHandle;
use windows::Win32::Graphics::Direct3D12::{
    D3D12_COMMAND_LIST_FLAG_NONE, D3D12_COMMAND_LIST_TYPE, D3D12_COMMAND_QUEUE_DESC,
    D3D12_COMMAND_QUEUE_FLAG_NONE, D3D12_CPU_PAGE_PROPERTY_UNKNOWN, D3D12_HEAP_FLAG_NONE,
    D3D12_HEAP_PROPERTIES, D3D12_HEAP_TYPE, D3D12_HEAP_TYPE_DEFAULT, D3D12_MEMORY_POOL_UNKNOWN,
    D3D12_RESOURCE_DESC, D3D12_RESOURCE_DIMENSION_BUFFER, D3D12_RESOURCE_DIMENSION_TEXTURE2D,
    D3D12_RESOURCE_FLAG_DENY_SHADER_RESOURCE, D3D12_RESOURCE_FLAG_NONE,
    D3D12_RESOURCE_FLAG_VIDEO_ENCODE_REFERENCE_ONLY, D3D12_RESOURCE_FLAGS,
    D3D12_RESOURCE_STATE_COMMON, D3D12_RESOURCE_STATES, D3D12_TEXTURE_LAYOUT_ROW_MAJOR,
    D3D12_TEXTURE_LAYOUT_UNKNOWN, ID3D12CommandAllocator, ID3D12CommandQueue, ID3D12Device,
    ID3D12Device4, ID3D12Resource,
};
use windows::Win32::Graphics::Dxgi::Common::DXGI_RATIONAL;
use windows::Win32::Graphics::Dxgi::Common::{
    DXGI_FORMAT_NV12, DXGI_FORMAT_UNKNOWN, DXGI_SAMPLE_DESC,
};
use windows::Win32::Media::MediaFoundation::{
    D3D12_FEATURE_DATA_VIDEO_ENCODER_CODEC, D3D12_FEATURE_DATA_VIDEO_ENCODER_OUTPUT_RESOLUTION,
    D3D12_FEATURE_DATA_VIDEO_ENCODER_RESOLUTION_SUPPORT_LIMITS,
    D3D12_FEATURE_DATA_VIDEO_ENCODER_RESOURCE_REQUIREMENTS,
    D3D12_FEATURE_DATA_VIDEO_ENCODER_SUPPORT, D3D12_FEATURE_VIDEO_ENCODER_CODEC,
    D3D12_FEATURE_VIDEO_ENCODER_OUTPUT_RESOLUTION,
    D3D12_FEATURE_VIDEO_ENCODER_RESOURCE_REQUIREMENTS, D3D12_FEATURE_VIDEO_ENCODER_SUPPORT,
    D3D12_VIDEO_ENCODER_CODEC, D3D12_VIDEO_ENCODER_CODEC_CONFIGURATION,
    D3D12_VIDEO_ENCODER_CODEC_CONFIGURATION_0, D3D12_VIDEO_ENCODER_CODEC_CONFIGURATION_H264,
    D3D12_VIDEO_ENCODER_CODEC_CONFIGURATION_H264_DIRECT_MODES_DISABLED,
    D3D12_VIDEO_ENCODER_CODEC_CONFIGURATION_H264_FLAG_NONE,
    D3D12_VIDEO_ENCODER_CODEC_CONFIGURATION_H264_SLICES_DEBLOCKING_MODE_0_ALL_LUMA_CHROMA_SLICE_BLOCK_EDGES_ALWAYS_FILTERED,
    D3D12_VIDEO_ENCODER_CODEC_H264, D3D12_VIDEO_ENCODER_DESC, D3D12_VIDEO_ENCODER_FLAG_NONE,
    D3D12_VIDEO_ENCODER_FRAME_SUBREGION_LAYOUT_MODE_FULL_FRAME, D3D12_VIDEO_ENCODER_HEAP_DESC,
    D3D12_VIDEO_ENCODER_HEAP_FLAG_NONE, D3D12_VIDEO_ENCODER_INTRA_REFRESH_MODE,
    D3D12_VIDEO_ENCODER_LEVEL_SETTING, D3D12_VIDEO_ENCODER_LEVEL_SETTING_0,
    D3D12_VIDEO_ENCODER_LEVELS_H264, D3D12_VIDEO_ENCODER_LEVELS_H264_51,
    D3D12_VIDEO_ENCODER_MOTION_ESTIMATION_PRECISION_MODE_MAXIMUM,
    D3D12_VIDEO_ENCODER_PICTURE_RESOLUTION_DESC, D3D12_VIDEO_ENCODER_PROFILE_DESC,
    D3D12_VIDEO_ENCODER_PROFILE_DESC_0, D3D12_VIDEO_ENCODER_PROFILE_H264,
    D3D12_VIDEO_ENCODER_PROFILE_H264_MAIN, D3D12_VIDEO_ENCODER_RATE_CONTROL,
    D3D12_VIDEO_ENCODER_RATE_CONTROL_CBR, D3D12_VIDEO_ENCODER_RATE_CONTROL_CONFIGURATION_PARAMS,
    D3D12_VIDEO_ENCODER_RATE_CONTROL_CONFIGURATION_PARAMS_0, D3D12_VIDEO_ENCODER_RATE_CONTROL_CQP,
    D3D12_VIDEO_ENCODER_RATE_CONTROL_FLAG_NONE, D3D12_VIDEO_ENCODER_RATE_CONTROL_MODE,
    D3D12_VIDEO_ENCODER_RATE_CONTROL_MODE_CBR, D3D12_VIDEO_ENCODER_RATE_CONTROL_MODE_CQP,
    D3D12_VIDEO_ENCODER_SEQUENCE_GOP_STRUCTURE, D3D12_VIDEO_ENCODER_SEQUENCE_GOP_STRUCTURE_0,
    D3D12_VIDEO_ENCODER_SEQUENCE_GOP_STRUCTURE_H264,
    D3D12_VIDEO_ENCODER_SUPPORT_FLAG_GENERAL_SUPPORT_OK, D3D12_VIDEO_ENCODER_SUPPORT_FLAGS,
    D3D12_VIDEO_ENCODER_VALIDATION_FLAGS, ID3D12VideoDevice3, ID3D12VideoEncoder,
    ID3D12VideoEncoderHeap,
};
use windows::core::{BOOL, Interface};

use super::util::data_size;

/// Borrow `device_handle` as an owned `ID3D12Device` (COM `AddRef`d for this session).
pub(super) fn device_from_handle(device_handle: NativeHandle) -> Result<ID3D12Device, EncodeError> {
    let raw = device_handle.get() as *mut core::ffi::c_void;
    // SAFETY: caller guarantees a live `ID3D12Device*` for the session (config contract).
    let borrowed =
        unsafe { ID3D12Device::from_raw_borrowed(&raw) }.ok_or(EncodeError::InvalidInput)?;
    // clone: COM AddRef so we own the device for the session's lifetime
    Ok(borrowed.clone())
}

/// Check `D3D12_FEATURE_VIDEO_ENCODER_CODEC` for `codec`. Codec-generic (the query struct
/// only varies by the `Codec` field) — shared by [`super::hevc::check_codec_support`] as
/// well as this file's H.264 call site.
pub(super) fn check_codec_support(
    video_device: &ID3D12VideoDevice3,
    codec: D3D12_VIDEO_ENCODER_CODEC,
) -> Result<(), EncodeError> {
    let mut support = D3D12_FEATURE_DATA_VIDEO_ENCODER_CODEC {
        NodeIndex: 0,
        Codec: codec,
        IsSupported: BOOL::default(),
    };
    // SAFETY: `support` is sized/typed exactly as `D3D12_FEATURE_VIDEO_ENCODER_CODEC` expects.
    unsafe {
        video_device
            .CheckFeatureSupport(
                D3D12_FEATURE_VIDEO_ENCODER_CODEC,
                std::ptr::from_mut(&mut support).cast(),
                data_size::<D3D12_FEATURE_DATA_VIDEO_ENCODER_CODEC>(),
            )
            .map_err(|_| EncodeError::Unsupported)?;
    }
    if !support.IsSupported.as_bool() {
        return Err(EncodeError::Unsupported);
    }
    Ok(())
}

fn profile_desc_main(
    profile_h264: &mut D3D12_VIDEO_ENCODER_PROFILE_H264,
) -> D3D12_VIDEO_ENCODER_PROFILE_DESC {
    D3D12_VIDEO_ENCODER_PROFILE_DESC {
        DataSize: data_size::<D3D12_VIDEO_ENCODER_PROFILE_H264>(),
        Anonymous: D3D12_VIDEO_ENCODER_PROFILE_DESC_0 {
            pH264Profile: profile_h264,
        },
    }
}

/// Validate `resolution` against `D3D12_FEATURE_VIDEO_ENCODER_OUTPUT_RESOLUTION`'s real
/// per-driver min/max/multiple-of constraints.
///
/// Real hardware enforces a nonzero **minimum** encode resolution (observed: 160x64 on an
/// NVIDIA RTX 4090) — below it, `CreateVideoEncoderHeap` fails with a raw `E_INVALIDARG`
/// that gives the caller no indication *why*. Checking this upfront turns that into a
/// clear [`EncodeError::Unsupported`] instead.
/// Codec-generic sibling of [`check_codec_support`] — see that function's doc comment.
pub(super) fn check_output_resolution(
    video_device: &ID3D12VideoDevice3,
    codec: D3D12_VIDEO_ENCODER_CODEC,
    resolution: D3D12_VIDEO_ENCODER_PICTURE_RESOLUTION_DESC,
) -> Result<(), EncodeError> {
    let mut res = D3D12_FEATURE_DATA_VIDEO_ENCODER_OUTPUT_RESOLUTION {
        NodeIndex: 0,
        Codec: codec,
        ResolutionRatiosCount: 0,
        IsSupported: BOOL::default(),
        MinResolutionSupported: D3D12_VIDEO_ENCODER_PICTURE_RESOLUTION_DESC::default(),
        MaxResolutionSupported: D3D12_VIDEO_ENCODER_PICTURE_RESOLUTION_DESC::default(),
        ResolutionWidthMultipleRequirement: 0,
        ResolutionHeightMultipleRequirement: 0,
        pResolutionRatios: std::ptr::null_mut(),
    };
    // SAFETY: `res` is sized/typed exactly as `D3D12_FEATURE_VIDEO_ENCODER_OUTPUT_RESOLUTION` expects.
    unsafe {
        video_device
            .CheckFeatureSupport(
                D3D12_FEATURE_VIDEO_ENCODER_OUTPUT_RESOLUTION,
                std::ptr::from_mut(&mut res).cast(),
                data_size::<D3D12_FEATURE_DATA_VIDEO_ENCODER_OUTPUT_RESOLUTION>(),
            )
            .map_err(|_| EncodeError::Unsupported)?;
    }
    if !res.IsSupported.as_bool() {
        return Err(EncodeError::Unsupported);
    }
    let in_range = resolution.Width >= res.MinResolutionSupported.Width
        && resolution.Width <= res.MaxResolutionSupported.Width
        && resolution.Height >= res.MinResolutionSupported.Height
        && resolution.Height <= res.MaxResolutionSupported.Height;
    let width_mul_ok = res.ResolutionWidthMultipleRequirement == 0
        || resolution.Width % res.ResolutionWidthMultipleRequirement == 0;
    let height_mul_ok = res.ResolutionHeightMultipleRequirement == 0
        || resolution.Height % res.ResolutionHeightMultipleRequirement == 0;
    if !in_range || !width_mul_ok || !height_mul_ok {
        return Err(EncodeError::Unsupported);
    }
    Ok(())
}

pub(super) fn check_resource_requirements(
    video_device: &ID3D12VideoDevice3,
    resolution: D3D12_VIDEO_ENCODER_PICTURE_RESOLUTION_DESC,
) -> Result<D3D12_FEATURE_DATA_VIDEO_ENCODER_RESOURCE_REQUIREMENTS, EncodeError> {
    let mut profile_h264 = D3D12_VIDEO_ENCODER_PROFILE_H264_MAIN;
    let mut req = D3D12_FEATURE_DATA_VIDEO_ENCODER_RESOURCE_REQUIREMENTS {
        NodeIndex: 0,
        Codec: D3D12_VIDEO_ENCODER_CODEC_H264,
        Profile: profile_desc_main(&mut profile_h264),
        InputFormat: DXGI_FORMAT_NV12,
        PictureTargetResolution: resolution,
        IsSupported: BOOL::default(),
        CompressedBitstreamBufferAccessAlignment: 0,
        EncoderMetadataBufferAccessAlignment: 0,
        MaxEncoderOutputMetadataBufferSize: 0,
    };
    // SAFETY: `req` is sized/typed exactly as `D3D12_FEATURE_VIDEO_ENCODER_RESOURCE_REQUIREMENTS` expects.
    unsafe {
        video_device
            .CheckFeatureSupport(
                D3D12_FEATURE_VIDEO_ENCODER_RESOURCE_REQUIREMENTS,
                std::ptr::from_mut(&mut req).cast(),
                data_size::<D3D12_FEATURE_DATA_VIDEO_ENCODER_RESOURCE_REQUIREMENTS>(),
            )
            .map_err(|_| EncodeError::Unsupported)?;
    }
    if !req.IsSupported.as_bool() {
        return Err(EncodeError::Unsupported);
    }
    Ok(req)
}

/// Fixed H.264 codec configuration for this backend: CAVLC (no CABAC), standard
/// deblocking, no direct-mode B-frame prediction (no B-frames are ever requested).
pub(super) const fn default_codec_config_h264() -> D3D12_VIDEO_ENCODER_CODEC_CONFIGURATION_H264 {
    D3D12_VIDEO_ENCODER_CODEC_CONFIGURATION_H264 {
        ConfigurationFlags: D3D12_VIDEO_ENCODER_CODEC_CONFIGURATION_H264_FLAG_NONE,
        DirectModeConfig: D3D12_VIDEO_ENCODER_CODEC_CONFIGURATION_H264_DIRECT_MODES_DISABLED,
        DisableDeblockingFilterConfig:
            D3D12_VIDEO_ENCODER_CODEC_CONFIGURATION_H264_SLICES_DEBLOCKING_MODE_0_ALL_LUMA_CHROMA_SLICE_BLOCK_EDGES_ALWAYS_FILTERED,
    }
}

/// Which `D3D12_VIDEO_ENCODER_RATE_CONTROL_MODE` this session uses, holding
/// exactly the codec-agnostic config that mode's own struct needs. `Cqp` is
/// this backend's original, always-available mode; `Cbr` is real, driver
/// feedback-gated (see `d3d12_video_encode.rs::open`'s selection logic) and
/// is the only mode [`crate::VideoEncoder::set_bitrate`] can retarget live —
/// see that method's D3D12 impl.
#[derive(Debug, Clone, Copy)]
pub(super) enum RateControlState {
    Cqp(D3D12_VIDEO_ENCODER_RATE_CONTROL_CQP),
    Cbr(D3D12_VIDEO_ENCODER_RATE_CONTROL_CBR),
}

/// Build the `Mode`/`ConfigParams` portion of `D3D12_VIDEO_ENCODER_RATE_CONTROL` from
/// `state`. The returned `ConfigParams` union pointer borrows `state` itself (never a
/// local of this function), so it stays valid for exactly as long as the caller's own
/// `state` does — safe to embed directly into a `D3D12_VIDEO_ENCODER_RATE_CONTROL` the
/// caller builds and uses in the same scope (matches every other C-union builder in this
/// module: the pointee always lives in the same stack frame as its use).
pub(super) fn rate_control_mode_and_params(
    state: &RateControlState,
) -> (
    D3D12_VIDEO_ENCODER_RATE_CONTROL_MODE,
    D3D12_VIDEO_ENCODER_RATE_CONTROL_CONFIGURATION_PARAMS,
) {
    match state {
        RateControlState::Cqp(cqp) => (
            D3D12_VIDEO_ENCODER_RATE_CONTROL_MODE_CQP,
            D3D12_VIDEO_ENCODER_RATE_CONTROL_CONFIGURATION_PARAMS {
                DataSize: data_size::<D3D12_VIDEO_ENCODER_RATE_CONTROL_CQP>(),
                Anonymous: D3D12_VIDEO_ENCODER_RATE_CONTROL_CONFIGURATION_PARAMS_0 {
                    pConfiguration_CQP: std::ptr::from_ref(cqp),
                },
            },
        ),
        RateControlState::Cbr(cbr) => (
            D3D12_VIDEO_ENCODER_RATE_CONTROL_MODE_CBR,
            D3D12_VIDEO_ENCODER_RATE_CONTROL_CONFIGURATION_PARAMS {
                DataSize: data_size::<D3D12_VIDEO_ENCODER_RATE_CONTROL_CBR>(),
                Anonymous: D3D12_VIDEO_ENCODER_RATE_CONTROL_CONFIGURATION_PARAMS_0 {
                    pConfiguration_CBR: std::ptr::from_ref(cbr),
                },
            },
        ),
    }
}

/// Build a `D3D12_VIDEO_ENCODER_RATE_CONTROL_CBR` from a target [`RateControlConfig`].
/// `InitialQP`/`MinQP`/`MaxQP`/`MaxFrameBitSize` are left `0` — this backend never sets
/// `ENABLE_INITIAL_QP`/`ENABLE_QP_RANGE`/`ENABLE_MAX_FRAME_SIZE` in `Flags`, so the driver
/// ignores those fields regardless (spec § 4.4); `InitialVBVFullness` similarly stays `0`
/// (start empty, matching this backend's "let the driver pick a default" convention for
/// `vbv_buffer_size_bytes: None`).
pub(super) fn cbr_from_config(rc: RateControlConfig) -> D3D12_VIDEO_ENCODER_RATE_CONTROL_CBR {
    D3D12_VIDEO_ENCODER_RATE_CONTROL_CBR {
        InitialQP: 0,
        MinQP: 0,
        MaxQP: 0,
        MaxFrameBitSize: 0,
        TargetBitRate: u64::from(rc.target_bitrate_bps),
        VBVCapacity: rc
            .vbv_buffer_size_bytes
            .map_or(0, |bytes| u64::from(bytes) * 8),
        InitialVBVFullness: 0,
    }
}

/// Query `D3D12_FEATURE_VIDEO_ENCODER_SUPPORT` for the exact codec/GOP/rate-control/
/// resolution combination this session will use, returning the driver's `SuggestedLevel`
/// (the level actually valid for this configuration on this hardware — a hardcoded guess
/// reliably fails `CreateVideoEncoderHeap` with `E_INVALIDARG` on real drivers) and the
/// resolution-dependent `MaxIntraRefreshFrameDuration` (real hardware finding: this is
/// `0` — i.e. row-based intra refresh is unusable at *any* nonzero duration — at some
/// resolutions even when the coarser mode-level `GENERAL_SUPPORT_OK` check above already
/// passed; `EncodeFrame` itself then rejects the request, so callers must check this
/// value, not just this function's `Ok`/`Err`, before committing to intra-refresh mode).
pub(super) fn check_encoder_support(
    video_device: &ID3D12VideoDevice3,
    resolution: D3D12_VIDEO_ENCODER_PICTURE_RESOLUTION_DESC,
    mut gop: D3D12_VIDEO_ENCODER_SEQUENCE_GOP_STRUCTURE_H264,
    rate_control: &RateControlState,
    frame_rate: (u32, u32),
    max_reference_frames_in_dpb: u32,
    intra_refresh: D3D12_VIDEO_ENCODER_INTRA_REFRESH_MODE,
) -> Result<(D3D12_VIDEO_ENCODER_LEVELS_H264, u32), EncodeError> {
    let mut codec_conf_h264 = default_codec_config_h264();
    let mut resolution_limits =
        D3D12_FEATURE_DATA_VIDEO_ENCODER_RESOLUTION_SUPPORT_LIMITS::default();
    let mut suggested_profile_h264 = D3D12_VIDEO_ENCODER_PROFILE_H264_MAIN;
    let mut suggested_level_h264 = D3D12_VIDEO_ENCODER_LEVELS_H264_51;
    let (rate_control_mode, rate_control_params) = rate_control_mode_and_params(rate_control);

    let mut support = D3D12_FEATURE_DATA_VIDEO_ENCODER_SUPPORT {
        NodeIndex: 0,
        Codec: D3D12_VIDEO_ENCODER_CODEC_H264,
        InputFormat: DXGI_FORMAT_NV12,
        CodecConfiguration: D3D12_VIDEO_ENCODER_CODEC_CONFIGURATION {
            DataSize: data_size::<D3D12_VIDEO_ENCODER_CODEC_CONFIGURATION_H264>(),
            Anonymous: D3D12_VIDEO_ENCODER_CODEC_CONFIGURATION_0 {
                pH264Config: &raw mut codec_conf_h264,
            },
        },
        CodecGopSequence: D3D12_VIDEO_ENCODER_SEQUENCE_GOP_STRUCTURE {
            DataSize: data_size::<D3D12_VIDEO_ENCODER_SEQUENCE_GOP_STRUCTURE_H264>(),
            Anonymous: D3D12_VIDEO_ENCODER_SEQUENCE_GOP_STRUCTURE_0 {
                pH264GroupOfPictures: &raw mut gop,
            },
        },
        RateControl: D3D12_VIDEO_ENCODER_RATE_CONTROL {
            Mode: rate_control_mode,
            Flags: D3D12_VIDEO_ENCODER_RATE_CONTROL_FLAG_NONE,
            ConfigParams: rate_control_params,
            TargetFrameRate: DXGI_RATIONAL {
                Numerator: frame_rate.0,
                Denominator: frame_rate.1,
            },
        },
        IntraRefresh: intra_refresh,
        SubregionFrameEncoding: D3D12_VIDEO_ENCODER_FRAME_SUBREGION_LAYOUT_MODE_FULL_FRAME,
        ResolutionsListCount: 1,
        pResolutionList: &raw const resolution,
        MaxReferenceFramesInDPB: max_reference_frames_in_dpb,
        ValidationFlags: D3D12_VIDEO_ENCODER_VALIDATION_FLAGS::default(),
        SupportFlags: D3D12_VIDEO_ENCODER_SUPPORT_FLAGS::default(),
        SuggestedProfile: D3D12_VIDEO_ENCODER_PROFILE_DESC {
            DataSize: data_size::<D3D12_VIDEO_ENCODER_PROFILE_H264>(),
            Anonymous: D3D12_VIDEO_ENCODER_PROFILE_DESC_0 {
                pH264Profile: &raw mut suggested_profile_h264,
            },
        },
        SuggestedLevel: D3D12_VIDEO_ENCODER_LEVEL_SETTING {
            DataSize: data_size::<D3D12_VIDEO_ENCODER_LEVELS_H264>(),
            Anonymous: D3D12_VIDEO_ENCODER_LEVEL_SETTING_0 {
                pH264LevelSetting: &raw mut suggested_level_h264,
            },
        },
        pResolutionDependentSupport: &raw mut resolution_limits,
    };
    // SAFETY: `support` is sized/typed exactly as `D3D12_FEATURE_VIDEO_ENCODER_SUPPORT`
    // expects; every embedded pointer targets a same-scope local valid for the call.
    unsafe {
        video_device
            .CheckFeatureSupport(
                D3D12_FEATURE_VIDEO_ENCODER_SUPPORT,
                std::ptr::from_mut(&mut support).cast(),
                data_size::<D3D12_FEATURE_DATA_VIDEO_ENCODER_SUPPORT>(),
            )
            .map_err(|_| EncodeError::Unsupported)?;
    }
    let _ = suggested_profile_h264; // driver-suggested profile — we always request Main, ignored
    if !support
        .SupportFlags
        .contains(D3D12_VIDEO_ENCODER_SUPPORT_FLAG_GENERAL_SUPPORT_OK)
    {
        return Err(EncodeError::Unsupported);
    }
    Ok((
        suggested_level_h264,
        resolution_limits.MaxIntraRefreshFrameDuration,
    ))
}

pub(super) fn create_encoder(
    video_device: &ID3D12VideoDevice3,
    resolution: D3D12_VIDEO_ENCODER_PICTURE_RESOLUTION_DESC,
    level: D3D12_VIDEO_ENCODER_LEVELS_H264,
) -> Result<(ID3D12VideoEncoder, ID3D12VideoEncoderHeap), EncodeError> {
    let mut profile_h264 = D3D12_VIDEO_ENCODER_PROFILE_H264_MAIN;
    let mut codec_conf_h264 = default_codec_config_h264();
    let encoder_desc = D3D12_VIDEO_ENCODER_DESC {
        NodeMask: 0,
        Flags: D3D12_VIDEO_ENCODER_FLAG_NONE,
        EncodeCodec: D3D12_VIDEO_ENCODER_CODEC_H264,
        EncodeProfile: profile_desc_main(&mut profile_h264),
        InputFormat: DXGI_FORMAT_NV12,
        CodecConfiguration: D3D12_VIDEO_ENCODER_CODEC_CONFIGURATION {
            DataSize: data_size::<D3D12_VIDEO_ENCODER_CODEC_CONFIGURATION_H264>(),
            Anonymous: D3D12_VIDEO_ENCODER_CODEC_CONFIGURATION_0 {
                pH264Config: &raw mut codec_conf_h264,
            },
        },
        MaxMotionEstimationPrecision: D3D12_VIDEO_ENCODER_MOTION_ESTIMATION_PRECISION_MODE_MAXIMUM,
    };
    // SAFETY: `encoder_desc` embeds valid pointers to same-scope locals for the call's duration.
    let encoder: ID3D12VideoEncoder =
        unsafe { video_device.CreateVideoEncoder(&raw const encoder_desc) }
            .map_err(|_| EncodeError::Backend)?;

    let mut level_h264 = level;
    let heap_desc = D3D12_VIDEO_ENCODER_HEAP_DESC {
        NodeMask: 0,
        Flags: D3D12_VIDEO_ENCODER_HEAP_FLAG_NONE,
        EncodeCodec: D3D12_VIDEO_ENCODER_CODEC_H264,
        EncodeProfile: profile_desc_main(&mut profile_h264),
        EncodeLevel: D3D12_VIDEO_ENCODER_LEVEL_SETTING {
            DataSize: data_size::<D3D12_VIDEO_ENCODER_LEVELS_H264>(),
            Anonymous: D3D12_VIDEO_ENCODER_LEVEL_SETTING_0 {
                pH264LevelSetting: &raw mut level_h264,
            },
        },
        ResolutionsListCount: 1,
        pResolutionList: &raw const resolution,
    };
    // SAFETY: `heap_desc` embeds valid pointers to same-scope locals for the call's duration.
    let encoder_heap: ID3D12VideoEncoderHeap =
        unsafe { video_device.CreateVideoEncoderHeap(&raw const heap_desc) }
            .map_err(|_| EncodeError::Backend)?;

    Ok((encoder, encoder_heap))
}

/// H.264 `level_idc` (as written into the SPS, `level * 10`) for a
/// `D3D12_VIDEO_ENCODER_LEVELS_H264` value. Level 1b (`level_idc == 9`, needs
/// `constraint_set3_flag`) is rounded up to Level 1.1 (`11`) — this backend's minimal SPS
/// never sets that constraint flag, and declaring a slightly higher level than strictly
/// necessary is always spec-safe (never a decode-compatibility issue).
pub(super) const fn level_h264_to_idc(level: D3D12_VIDEO_ENCODER_LEVELS_H264) -> u8 {
    match level.0 {
        0 => 10,     // 1
        1 | 2 => 11, // 1b (rounded up) / 1.1
        3 => 12,     // 1.2
        4 => 13,     // 1.3
        5 => 20,     // 2
        6 => 21,     // 2.1
        7 => 22,     // 2.2
        8 => 30,     // 3
        9 => 31,     // 3.1
        10 => 32,    // 3.2
        11 => 40,    // 4
        12 => 41,    // 4.1
        13 => 42,    // 4.2
        14 => 50,    // 5
        15 => 51,    // 5.1
        16 => 52,    // 5.2
        17 => 60,    // 6
        18 => 61,    // 6.1
        _ => 62,     // 6.2 (and any future/unknown value — highest known level)
    }
}

pub(super) fn create_command_objects<T: Interface>(
    device: &ID3D12Device,
    device4: &ID3D12Device4,
    list_type: D3D12_COMMAND_LIST_TYPE,
) -> Result<(ID3D12CommandQueue, ID3D12CommandAllocator, T), EncodeError> {
    let queue_desc = D3D12_COMMAND_QUEUE_DESC {
        Type: list_type,
        Priority: 0,
        Flags: D3D12_COMMAND_QUEUE_FLAG_NONE,
        NodeMask: 0,
    };
    // SAFETY: plain POD desc, no borrowed pointers.
    let queue: ID3D12CommandQueue = unsafe { device.CreateCommandQueue(&raw const queue_desc) }
        .map_err(|_| EncodeError::Backend)?;
    // SAFETY: `list_type` is a valid `D3D12_COMMAND_LIST_TYPE`.
    let allocator: ID3D12CommandAllocator =
        unsafe { device.CreateCommandAllocator(list_type) }.map_err(|_| EncodeError::Backend)?;
    // SAFETY: `device4` was obtained via `cast` from the same live device.
    let list: T = unsafe { device4.CreateCommandList1(0, list_type, D3D12_COMMAND_LIST_FLAG_NONE) }
        .map_err(|_| EncodeError::Backend)?;
    Ok((queue, allocator, list))
}

pub(super) fn create_nv12_texture(
    device: &ID3D12Device,
    width: u32,
    height: u32,
    flags: D3D12_RESOURCE_FLAGS,
) -> Result<ID3D12Resource, EncodeError> {
    create_nv12_texture_array(device, width, height, 1, flags)
}

/// Like [`create_nv12_texture`] but with `array_size` array slices in one resource —
/// real hardware (NVIDIA, confirmed via `D3D12_FEATURE_VIDEO_ENCODER_SUPPORT`'s
/// `D3D12_VIDEO_ENCODER_SUPPORT_FLAG_RECONSTRUCTED_FRAMES_REQUIRE_TEXTURE_ARRAYS`)
/// rejects reconstructed-picture/reference-frame textures as separate individual
/// resources with an undefined-operation device removal, not a clean validation
/// error — see [`create_recon_pool`], which always uses this even when the flag
/// isn't set (a texture array is spec-documented as valid either way, just not
/// mandatory when the flag is clear).
pub(super) fn create_nv12_texture_array(
    device: &ID3D12Device,
    width: u32,
    height: u32,
    array_size: u16,
    flags: D3D12_RESOURCE_FLAGS,
) -> Result<ID3D12Resource, EncodeError> {
    let heap_props = D3D12_HEAP_PROPERTIES {
        Type: D3D12_HEAP_TYPE_DEFAULT,
        CPUPageProperty: D3D12_CPU_PAGE_PROPERTY_UNKNOWN,
        MemoryPoolPreference: D3D12_MEMORY_POOL_UNKNOWN,
        CreationNodeMask: 1,
        VisibleNodeMask: 1,
    };
    let desc = D3D12_RESOURCE_DESC {
        Dimension: D3D12_RESOURCE_DIMENSION_TEXTURE2D,
        Alignment: 0,
        Width: u64::from(width),
        Height: height,
        DepthOrArraySize: array_size,
        MipLevels: 1,
        Format: DXGI_FORMAT_NV12,
        SampleDesc: DXGI_SAMPLE_DESC {
            Count: 1,
            Quality: 0,
        },
        Layout: D3D12_TEXTURE_LAYOUT_UNKNOWN,
        Flags: flags,
    };
    let mut resource: Option<ID3D12Resource> = None;
    // SAFETY: `CreateCommittedResource` with a DEFAULT-heap NV12 texture; caller-owned.
    unsafe {
        device
            .CreateCommittedResource(
                &raw const heap_props,
                D3D12_HEAP_FLAG_NONE,
                &raw const desc,
                D3D12_RESOURCE_STATE_COMMON,
                None,
                &raw mut resource,
            )
            .map_err(|_| EncodeError::Backend)?;
    }
    resource.ok_or(EncodeError::Backend)
}

/// Two-slot ping-pong pool of reconstructed pictures for GOP mode (single forward
/// reference: at most one live reference at a time, so two slots — one being
/// written this frame, one being read as the previous frame's reference — are
/// always enough). **One** `ID3D12Resource` texture array with 2 array slices
/// (not two separate resources — see [`create_nv12_texture_array`]'s doc for
/// why), slot `N` addressed as array-slice/subresource `N`. Allocated with
/// `D3D12_RESOURCE_FLAG_VIDEO_ENCODE_REFERENCE_ONLY`, the driver-required flag
/// for textures used via `ReconstructedPicture`/`ReferenceFrames`.
///
/// Both subresources start `D3D12_RESOURCE_STATE_COMMON`, and this backend's
/// per-frame recording always transitions each slot back to `COMMON` before
/// the frame's command list closes — every `encode_frame_h264` call can rely
/// on a slot being `COMMON` on entry without a separate runtime state field.
pub(super) struct ReconPool {
    pub(super) texture: ID3D12Resource,
    pub(super) write_slot: u32,
}

/// D3D12's debug layer rejects a texture with only `VIDEO_ENCODE_REFERENCE_ONLY` set
/// (real hardware validation message: "you must also set the following flags: 0x88" —
/// `0x88 = VIDEO_ENCODE_REFERENCE_ONLY (0x80) | DENY_SHADER_RESOURCE (0x08)`).
/// `VIDEO_DECODE_REFERENCE_ONLY` is a **separate**, mutually exclusive flag for decode
/// output textures — real hardware rejects combining it with `VIDEO_ENCODE_REFERENCE_ONLY`
/// ("Unsupported flags specified: 0x80"), confirmed on the same device.
const RECON_TEXTURE_FLAGS: D3D12_RESOURCE_FLAGS = D3D12_RESOURCE_FLAGS(
    D3D12_RESOURCE_FLAG_VIDEO_ENCODE_REFERENCE_ONLY.0 | D3D12_RESOURCE_FLAG_DENY_SHADER_RESOURCE.0,
);

pub(super) fn create_recon_pool(
    device: &ID3D12Device,
    width: u32,
    height: u32,
) -> Result<ReconPool, EncodeError> {
    let texture = create_nv12_texture_array(device, width, height, 2, RECON_TEXTURE_FLAGS)?;
    Ok(ReconPool {
        texture,
        write_slot: 0,
    })
}

/// Create a linear buffer on the `D3D12_HEAP_TYPE_CUSTOM` equivalent of `heap_type`
/// (via `GetCustomHeapProperties`), rather than passing `heap_type` (e.g.
/// `D3D12_HEAP_TYPE_READBACK`) straight through.
///
/// This matters specifically for buffers this backend later transitions to
/// `D3D12_RESOURCE_STATE_VIDEO_ENCODE_WRITE`/`_READ` (the compressed-bitstream and
/// resolved-metadata outputs): the D3D12 debug layer enforces "resources on
/// `D3D12_HEAP_TYPE_READBACK` heaps support only `COMMON`/`COPY_DEST`/`RESOLVE_DEST`" —
/// a restriction keyed on the **abstract** heap-type enum value, not the underlying
/// memory's actual CPU-visibility/pool characteristics. Resolving to the concrete
/// `D3D12_HEAP_TYPE_CUSTOM` properties upfront (same physical memory, same CPU
/// `Map`/`Unmap` behavior) sidesteps that abstract-type check entirely — this is the
/// same trick `FFmpeg`'s shipped `d3d12va_encode.c` uses for its output/metadata buffers.
pub(super) fn create_linear_buffer(
    device: &ID3D12Device,
    heap_type: D3D12_HEAP_TYPE,
    size: u64,
    initial_state: D3D12_RESOURCE_STATES,
) -> Result<ID3D12Resource, EncodeError> {
    // SAFETY: plain getter, no borrowed pointers.
    let heap_props = unsafe { device.GetCustomHeapProperties(0, heap_type) };
    let desc = D3D12_RESOURCE_DESC {
        Dimension: D3D12_RESOURCE_DIMENSION_BUFFER,
        Alignment: 0,
        Width: size.max(1),
        Height: 1,
        DepthOrArraySize: 1,
        MipLevels: 1,
        Format: DXGI_FORMAT_UNKNOWN,
        SampleDesc: DXGI_SAMPLE_DESC {
            Count: 1,
            Quality: 0,
        },
        Layout: D3D12_TEXTURE_LAYOUT_ROW_MAJOR,
        Flags: D3D12_RESOURCE_FLAG_NONE,
    };
    let mut resource: Option<ID3D12Resource> = None;
    // SAFETY: `CreateCommittedResource` with a linear buffer on `heap_type`; caller-owned.
    unsafe {
        device
            .CreateCommittedResource(
                &raw const heap_props,
                D3D12_HEAP_FLAG_NONE,
                &raw const desc,
                initial_state,
                None,
                &raw mut resource,
            )
            .map_err(|_| EncodeError::Backend)?;
    }
    resource.ok_or(EncodeError::Backend)
}