-
Notifications
You must be signed in to change notification settings - Fork 6
Expand file tree
/
Copy pathframe.rs
More file actions
2642 lines (2424 loc) · 99.7 KB
/
Copy pathframe.rs
File metadata and controls
2642 lines (2424 loc) · 99.7 KB
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
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
use std::num::{NonZeroU16, NonZeroUsize};
use std::sync::Arc;
use std::time::{Duration, Instant};
use bytes::Bytes;
use ironrdp_server::{BitmapUpdate, DesktopSize, DisplayUpdate, PixelFormat};
use tokio::sync::mpsc;
use crate::egfx::{
avc444_dimensions_supported, EgfxFrameCodec as EgfxCodec, EgfxFrameFlowSnapshot,
EgfxFrameReadiness, EgfxShared, EncodedFrameState, H264RateControl,
};
use super::damage::{
clamp_damage_region, damage_area_pixels, merge_damage_region, FrameDiffDamageDetector,
};
/// Maximum consecutive encode failures before falling back to software encoder.
const MAX_ENCODE_FAILURES: u32 = 5;
/// Common frame processing: EGFX H.264/RFX encoding or bitmap fallback.
pub(super) struct FrameProcessor {
egfx_shared: Option<Arc<EgfxShared>>,
pub(super) h264_encoder: Option<crate::egfx::FrameEncoder>,
egfx_handle: Option<ironrdp_server::GfxServerHandle>,
pub(super) egfx_sender: Option<tokio::sync::mpsc::UnboundedSender<ironrdp_server::ServerEvent>>,
pub(super) egfx_surface_id: Option<u16>,
egfx_active: bool,
egfx_ready: bool,
pub(super) egfx_generation: u32,
pub(super) egfx_codec: Option<EgfxCodec>,
width: u32,
height: u32,
pixel_format: PixelFormat,
stride: u32,
bitrate: u32,
quality: u8,
rate_control: H264RateControl,
fps: u32,
/// Whether we've sent at least one frame (first frame always sent)
pub(super) sent_first_frame: bool,
/// Consecutive encode failure count for runtime VAAPI -> software fallback.
encode_failures: u32,
pub(super) pending_damage_regions: Vec<(i32, i32, i32, i32)>,
damage_detector: FrameDiffDamageDetector,
pub(super) stats: FrameStats,
pending_initial_resize: Option<DesktopSize>,
}
pub(super) struct FrameStats {
window_start: Instant,
captured_frames: u32,
sent_frames: u32,
skipped_no_damage: u32,
skipped_pacer: u32,
skipped_encoder: u32,
skipped_backpressure: u32,
skipped_local_backpressure: u32,
skipped_transport_unavailable: u32,
skipped_transport_not_ready: u32,
skipped_transport_no_channel: u32,
skipped_transport_backpressure: u32,
bytes: u64,
encode_us_total: u128,
send_us_total: u128,
damage_pixels: u64,
capture_damage_regions: u32,
promoted_full_scans: u32,
damage_regions: u32,
last_codec: Option<EgfxCodec>,
last_surface_id: Option<u16>,
last_frame_id: u32,
last_acked_frame_id: u32,
frames_in_flight: u32,
client_queue_depth: u32,
frame_ack_suspended: bool,
frame_ack_stream_established: bool,
total_queued_frames: u64,
total_acked_frames: u64,
}
struct SentFrameStats<'a> {
width: u32,
height: u32,
codec: EgfxCodec,
surface_id: u16,
damage_regions: &'a [(i32, i32, i32, i32)],
bytes: usize,
encode_elapsed: Duration,
send_elapsed: Duration,
flow: EgfxFrameFlowSnapshot,
}
fn egfx_perf_logging_enabled() -> bool {
egfx_perf_logging_enabled_with(|name| std::env::var_os(name).is_some())
}
pub(super) fn egfx_perf_logging_enabled_with(mut is_set: impl FnMut(&str) -> bool) -> bool {
is_set("HYPR_RDP_EGFX_PERF")
}
impl FrameStats {
fn new() -> Self {
Self {
window_start: Instant::now(),
captured_frames: 0,
sent_frames: 0,
skipped_no_damage: 0,
skipped_pacer: 0,
skipped_encoder: 0,
skipped_backpressure: 0,
skipped_local_backpressure: 0,
skipped_transport_unavailable: 0,
skipped_transport_not_ready: 0,
skipped_transport_no_channel: 0,
skipped_transport_backpressure: 0,
bytes: 0,
encode_us_total: 0,
send_us_total: 0,
damage_pixels: 0,
capture_damage_regions: 0,
promoted_full_scans: 0,
damage_regions: 0,
last_codec: None,
last_surface_id: None,
last_frame_id: 0,
last_acked_frame_id: 0,
frames_in_flight: 0,
client_queue_depth: 0,
frame_ack_suspended: false,
frame_ack_stream_established: false,
total_queued_frames: 0,
total_acked_frames: 0,
}
}
pub(super) fn record_capture(
&mut self,
width: u32,
height: u32,
capture_damage_regions: usize,
promoted_full_scan: bool,
) {
self.captured_frames = self.captured_frames.saturating_add(1);
self.capture_damage_regions = self
.capture_damage_regions
.saturating_add(capture_damage_regions as u32);
if promoted_full_scan {
self.promoted_full_scans = self.promoted_full_scans.saturating_add(1);
}
self.maybe_log(width, height);
}
pub(super) fn record_no_damage_skip(&mut self, width: u32, height: u32) {
self.skipped_no_damage = self.skipped_no_damage.saturating_add(1);
self.maybe_log(width, height);
}
pub(super) fn record_pacer_skip(&mut self, width: u32, height: u32) {
self.skipped_pacer = self.skipped_pacer.saturating_add(1);
self.maybe_log(width, height);
}
pub(super) fn record_encoder_skip(&mut self, width: u32, height: u32) {
self.skipped_encoder = self.skipped_encoder.saturating_add(1);
self.maybe_log(width, height);
}
fn record_sent(&mut self, sent: SentFrameStats<'_>) {
self.sent_frames = self.sent_frames.saturating_add(1);
self.bytes = self.bytes.saturating_add(sent.bytes as u64);
self.encode_us_total = self
.encode_us_total
.saturating_add(sent.encode_elapsed.as_micros());
self.send_us_total = self
.send_us_total
.saturating_add(sent.send_elapsed.as_micros());
self.damage_pixels = self.damage_pixels.saturating_add(damage_area_pixels(
sent.damage_regions,
sent.width,
sent.height,
));
self.damage_regions = self
.damage_regions
.saturating_add(sent.damage_regions.len() as u32);
self.last_codec = Some(sent.codec);
self.last_surface_id = Some(sent.surface_id);
self.record_flow_snapshot(sent.flow);
self.maybe_log(sent.width, sent.height);
}
pub(super) fn record_send_unavailable(
&mut self,
readiness: EgfxFrameReadiness,
flow: EgfxFrameFlowSnapshot,
width: u32,
height: u32,
) {
self.skipped_backpressure = self.skipped_backpressure.saturating_add(1);
match readiness {
EgfxFrameReadiness::Ready => {}
EgfxFrameReadiness::LocalBackpressure { .. } => {
self.skipped_local_backpressure = self.skipped_local_backpressure.saturating_add(1);
}
EgfxFrameReadiness::TransportUnavailable => {
self.skipped_transport_unavailable =
self.skipped_transport_unavailable.saturating_add(1);
}
EgfxFrameReadiness::TransportNotReady => {
self.skipped_transport_not_ready =
self.skipped_transport_not_ready.saturating_add(1);
}
EgfxFrameReadiness::TransportNoChannel => {
self.skipped_transport_no_channel =
self.skipped_transport_no_channel.saturating_add(1);
}
EgfxFrameReadiness::TransportBackpressure { .. } => {
self.skipped_transport_backpressure =
self.skipped_transport_backpressure.saturating_add(1);
}
}
self.record_flow_snapshot(flow);
self.maybe_log(width, height);
}
fn record_flow_snapshot(&mut self, flow: EgfxFrameFlowSnapshot) {
self.last_frame_id = flow.last_queued_frame_id;
self.last_acked_frame_id = flow.last_acked_frame_id;
self.frames_in_flight = flow.frames_in_flight;
self.client_queue_depth = flow.client_queue_depth;
self.frame_ack_suspended = flow.frame_ack_suspended;
self.frame_ack_stream_established = flow.frame_ack_stream_established;
self.total_queued_frames = flow.total_queued_frames;
self.total_acked_frames = flow.total_acked_frames;
}
fn maybe_log(&mut self, width: u32, height: u32) {
let elapsed = self.window_start.elapsed();
if elapsed < Duration::from_secs(1) {
return;
}
let seconds = elapsed.as_secs_f64();
let frames = self.sent_frames.max(1);
let frame_pixels = u64::from(width) * u64::from(height);
let avg_damage_pct = if frame_pixels == 0 || self.sent_frames == 0 {
0.0
} else {
(self.damage_pixels as f64 * 100.0) / (frame_pixels as f64 * self.sent_frames as f64)
};
let avg_damage_regions = if self.sent_frames == 0 {
0.0
} else {
f64::from(self.damage_regions) / f64::from(self.sent_frames)
};
let avg_capture_damage_regions = if self.captured_frames == 0 {
0.0
} else {
f64::from(self.capture_damage_regions) / f64::from(self.captured_frames)
};
let ack_gap = self
.total_queued_frames
.saturating_sub(self.total_acked_frames);
if egfx_perf_logging_enabled() {
tracing::info!(
target: "hypr_rdp::egfx_perf",
captured_fps = self.captured_frames as f64 / seconds,
fps = self.sent_frames as f64 / seconds,
last_codec = ?self.last_codec,
last_surface_id = ?self.last_surface_id,
last_frame_id = self.last_frame_id,
last_acked_frame_id = self.last_acked_frame_id,
frames_in_flight = self.frames_in_flight,
client_queue_depth = self.client_queue_depth,
frame_ack_suspended = self.frame_ack_suspended,
frame_ack_stream_established = self.frame_ack_stream_established,
total_queued_frames = self.total_queued_frames,
total_acked_frames = self.total_acked_frames,
ack_gap,
mbps = (self.bytes as f64 * 8.0) / seconds / 1_000_000.0,
avg_encode_ms = self.encode_us_total as f64 / f64::from(frames) / 1000.0,
avg_send_ms = self.send_us_total as f64 / f64::from(frames) / 1000.0,
avg_damage_pct,
avg_damage_regions,
avg_capture_damage_regions,
promoted_full_scans = self.promoted_full_scans,
skipped_no_damage = self.skipped_no_damage,
skipped_pacer = self.skipped_pacer,
skipped_encoder = self.skipped_encoder,
skipped_backpressure = self.skipped_backpressure,
skipped_local_backpressure = self.skipped_local_backpressure,
skipped_transport_unavailable = self.skipped_transport_unavailable,
skipped_transport_not_ready = self.skipped_transport_not_ready,
skipped_transport_no_channel = self.skipped_transport_no_channel,
skipped_transport_backpressure = self.skipped_transport_backpressure,
"EGFX frame stats"
);
}
*self = Self::new();
}
}
/// Capture frame pacer using an absolute deadline while tolerating compositor
/// frame-time quantization.
pub(super) struct FramePacer {
base_interval: Duration,
frame_interval: Duration,
next_send_at: Option<Instant>,
last_send_at: Option<Instant>,
}
impl FramePacer {
const SEND_EARLY_FRACTION: f64 = 0.10;
fn interval_for(target_fps: u32) -> Duration {
Duration::from_secs_f64(1.0 / f64::from(target_fps.max(1)))
}
pub(super) fn new(target_fps: u32, now: Instant) -> Self {
let frame_interval = Self::interval_for(target_fps);
Self {
base_interval: frame_interval,
frame_interval,
next_send_at: Some(now),
last_send_at: None,
}
}
pub(super) fn should_send(
&mut self,
now: Instant,
sent_first_frame: bool,
has_damage: bool,
target_fps: u32,
) -> bool {
self.frame_interval = Self::interval_for(target_fps);
if !sent_first_frame {
self.next_send_at = Some(now + self.frame_interval);
self.last_send_at = Some(now);
return true;
}
if !has_damage {
return false;
}
if self.frame_interval > self.base_interval {
let next_send_at = self
.last_send_at
.map(|last| last + self.frame_interval)
.unwrap_or(now);
let send_early = self.frame_interval.mul_f64(Self::SEND_EARLY_FRACTION);
if now + send_early < next_send_at {
return false;
}
self.last_send_at = Some(now);
self.next_send_at = Some(now + self.frame_interval);
return true;
}
let next_send_at = self.next_send_at.unwrap_or(now);
let send_early = self.frame_interval.mul_f64(Self::SEND_EARLY_FRACTION);
if now + send_early < next_send_at {
return false;
}
let mut next = next_send_at + self.frame_interval;
while next <= now {
next += self.frame_interval;
}
self.next_send_at = Some(next);
self.last_send_at = Some(now);
true
}
}
impl FrameProcessor {
#[allow(clippy::too_many_arguments)]
pub(super) fn new(
egfx_shared: Option<Arc<EgfxShared>>,
width: u32,
height: u32,
pixel_format: PixelFormat,
stride: u32,
bitrate: u32,
quality: u8,
rate_control: H264RateControl,
fps: u32,
) -> Self {
Self {
egfx_shared,
h264_encoder: None,
egfx_handle: None,
egfx_sender: None,
egfx_surface_id: None,
egfx_active: false,
egfx_ready: false,
egfx_generation: 0,
egfx_codec: None,
width,
height,
pixel_format,
stride,
bitrate,
quality,
rate_control,
fps,
sent_first_frame: false,
encode_failures: 0,
pending_damage_regions: Vec::new(),
damage_detector: FrameDiffDamageDetector::new(),
stats: FrameStats::new(),
pending_initial_resize: None,
}
}
pub(super) fn set_pending_initial_resize(&mut self, resize: Option<DesktopSize>) {
self.pending_initial_resize = resize;
}
pub(super) fn has_pending_damage(&self) -> bool {
!self.pending_damage_regions.is_empty()
}
pub(super) fn pacing_fps(&self) -> u32 {
self.egfx_shared.as_ref().map_or(self.fps.max(1), |shared| {
shared.preferred_frame_rate(self.fps)
})
}
fn metadata_qp(&self) -> u8 {
match self.rate_control {
H264RateControl::Vbr => 0,
H264RateControl::Cqp => self.quality.min(51),
}
}
fn handle_encoder_skip(
encode_failures: &mut u32,
stats: &mut FrameStats,
width: u32,
height: u32,
) {
*encode_failures = 0;
stats.record_encoder_skip(width, height);
tracing::trace!("H.264 encoder skipped frame; preserving pending damage for retry");
}
pub(super) fn queue_damage(&mut self, damage_regions: &[(i32, i32, i32, i32)]) {
for &(x, y, w, h) in damage_regions {
let Some(region) = clamp_damage_region(x, y, w, h, self.width, self.height) else {
continue;
};
merge_damage_region(&mut self.pending_damage_regions, region);
}
}
/// Process a captured frame. Returns true if the capture loop should continue.
pub(super) fn process(&mut self, data: &[u8], tx: &mpsc::Sender<DisplayUpdate>) -> bool {
let force_egfx_full_frame = self
.egfx_shared
.as_ref()
.is_some_and(|shared| shared.full_frame_requested());
// Skip frames with no damage (except the very first frame)
if self.sent_first_frame && !self.has_pending_damage() && !force_egfx_full_frame {
return true;
}
if let Some(size) = self.pending_initial_resize {
let graphics_ready = self
.egfx_shared
.as_ref()
.is_none_or(|shared| shared.is_ready());
if graphics_ready {
tracing::info!(
width = size.width,
height = size.height,
"Sending initial resize after graphics channel is ready"
);
self.pending_initial_resize = None;
if tx.blocking_send(DisplayUpdate::Resize(size)).is_err() {
tracing::info!("Display update channel closed");
}
return false;
}
}
let mut sent_via_egfx = false;
if let Some(shared) = &self.egfx_shared {
let egfx_ready = shared.is_ready();
let avc_enabled = shared.is_avc_enabled();
let ready = egfx_ready && avc_enabled;
let codec = if shared.is_avc444_enabled()
&& avc444_dimensions_supported(self.width, self.height)
{
Some(EgfxCodec::Avc444)
} else if avc_enabled {
Some(EgfxCodec::Avc420)
} else {
None
};
let gen = shared.generation();
if ready != self.egfx_ready {
self.egfx_ready = ready;
if !ready {
self.egfx_active = false;
self.egfx_handle = None;
self.egfx_sender = None;
self.egfx_surface_id = None;
self.h264_encoder = None;
self.egfx_codec = None;
self.sent_first_frame = false;
self.damage_detector.invalidate();
if !egfx_ready {
tracing::trace!("EGFX channel became unavailable");
}
}
}
if gen != self.egfx_generation || (ready && codec != self.egfx_codec) {
self.egfx_generation = gen;
self.egfx_surface_id = None;
self.h264_encoder = None;
self.egfx_codec = None;
self.sent_first_frame = false;
self.damage_detector.invalidate();
if ready {
let selected_codec = codec.unwrap_or(EgfxCodec::Avc420);
let encoder_result = crate::egfx::FrameEncoder::new_for_egfx_codec(
selected_codec,
self.width,
self.height,
self.bitrate,
self.fps,
self.quality,
self.rate_control,
);
match encoder_result {
Ok(enc) => {
tracing::info!(
width = self.width,
height = self.height,
backend = enc.backend_name(),
codec = ?selected_codec,
gen,
bitrate = self.bitrate,
"H.264 encoder initialized"
);
self.egfx_codec = Some(selected_codec);
self.h264_encoder = Some(enc);
}
Err(e) => tracing::warn!("Failed to initialize H.264 encoder: {:#}", e),
}
}
}
if ready && shared.full_frame_requested() {
let readiness = shared.full_frame_refresh_readiness();
if !readiness.is_ready() {
tracing::trace!(
?readiness,
reason = readiness.reason(),
"EGFX full-frame refresh waiting for ACK window to drain"
);
self.stats.record_send_unavailable(
readiness,
shared.frame_flow_snapshot(),
self.width,
self.height,
);
return true;
}
}
let force_full_frame = if ready {
shared.take_full_frame_request()
} else {
false
};
let frame_damage_regions = if force_full_frame {
vec![(0, 0, self.width as i32, self.height as i32)]
} else if self.sent_first_frame {
self.damage_detector.detect(
data,
self.width,
self.height,
self.stride as usize,
&self.pending_damage_regions,
)
} else {
self.damage_detector.detect(
data,
self.width,
self.height,
self.stride as usize,
&[(0, 0, self.width as i32, self.height as i32)],
)
};
if self.sent_first_frame && frame_damage_regions.is_empty() {
self.pending_damage_regions.clear();
self.stats.record_no_damage_skip(self.width, self.height);
return true;
}
if ready && !self.egfx_active {
self.egfx_handle = shared.get_handle();
self.egfx_sender = shared.get_event_sender();
if self.h264_encoder.is_some()
&& self.egfx_handle.is_some()
&& self.egfx_sender.is_some()
{
self.egfx_active = true;
tracing::trace!("EGFX transport ready, switching to H.264 encoding");
}
}
if self.egfx_active {
// Surface initialization (separate borrow scope)
if self.egfx_surface_id.is_none() {
if let (Some(handle), Some(sender)) = (&self.egfx_handle, &self.egfx_sender) {
if let Some(sid) = shared.init_or_reuse_surface(
handle,
sender,
self.width as u16,
self.height as u16,
) {
self.egfx_surface_id = Some(sid);
}
}
}
// Encode and send (encoder borrow released before fallback check)
if let Some(sid) = self.egfx_surface_id {
if let Some(handle) = &self.egfx_handle {
let readiness = shared.frame_readiness(handle);
if !readiness.is_ready() {
tracing::trace!(
?readiness,
reason = readiness.reason(),
"EGFX frame skipped before encode"
);
self.stats.record_send_unavailable(
readiness,
shared.frame_flow_snapshot(),
self.width,
self.height,
);
return true;
}
}
let encode_start = Instant::now();
let codec = self.egfx_codec.unwrap_or(EgfxCodec::Avc420);
if force_full_frame {
if let Some(enc) = &mut self.h264_encoder {
enc.force_idr();
}
}
let encode_result = self.h264_encoder.as_mut().map(|enc| {
enc.encode_egfx_frame(
codec,
data,
self.stride as usize,
&frame_damage_regions,
)
});
let encode_elapsed = encode_start.elapsed();
match encode_result {
Some(Ok(ref encoded)) if encoded.state() == EncodedFrameState::Sendable => {
self.encode_failures = 0;
if let (Some(handle), Some(sender)) =
(&self.egfx_handle, &self.egfx_sender)
{
let timestamp = std::time::SystemTime::now()
.duration_since(std::time::UNIX_EPOCH)
.unwrap_or_default()
.as_millis()
as u32;
let send_start = Instant::now();
sent_via_egfx = shared.send_tracked_encoded_egfx_frame(
handle,
sender,
sid,
encoded,
&frame_damage_regions,
timestamp,
self.width as u16,
self.height as u16,
self.metadata_qp(),
);
let send_elapsed = send_start.elapsed();
if !sent_via_egfx {
if let Some(enc) = &mut self.h264_encoder {
enc.force_idr();
}
} else {
let flow = shared.frame_flow_snapshot();
encoded.log_sent_frame(
flow.last_queued_frame_id,
sid,
self.width,
self.height,
&frame_damage_regions,
);
if let Some(enc) = &mut self.h264_encoder {
encoded.commit_after_send(enc);
}
self.damage_detector.update_reference_regions(
data,
self.width,
self.height,
self.stride as usize,
&frame_damage_regions,
);
self.stats.record_sent(SentFrameStats {
width: self.width,
height: self.height,
codec,
surface_id: sid,
damage_regions: &frame_damage_regions,
bytes: encoded.len(),
encode_elapsed,
send_elapsed,
flow,
});
}
}
}
Some(Ok(ref encoded)) if encoded.state() == EncodedFrameState::Skipped => {
Self::handle_encoder_skip(
&mut self.encode_failures,
&mut self.stats,
self.width,
self.height,
);
}
Some(Ok(_)) => {
self.encode_failures += 1;
tracing::trace!(
failures = self.encode_failures,
max = MAX_ENCODE_FAILURES,
"H.264 encode produced no usable output"
);
if let Some(enc) = &mut self.h264_encoder {
enc.force_idr();
}
}
Some(Err(e)) => {
self.encode_failures += 1;
tracing::warn!(
failures = self.encode_failures,
max = MAX_ENCODE_FAILURES,
"H.264 encode failed: {:#}",
e
);
if let Some(enc) = &mut self.h264_encoder {
enc.force_idr();
}
}
None => {}
}
if force_full_frame && !sent_via_egfx {
shared.request_full_frame();
}
// Dynamic fallback: VAAPI -> software after repeated failures
if self.encode_failures >= MAX_ENCODE_FAILURES
&& self.h264_encoder.as_ref().is_some_and(|e| e.is_vaapi())
{
tracing::warn!(
"VA-API encode failed {} consecutive times, switching to software encoder",
self.encode_failures
);
let fallback_result =
crate::egfx::FrameEncoder::new_software_only_for_egfx_codec(
self.egfx_codec.unwrap_or(EgfxCodec::Avc420),
self.width,
self.height,
self.bitrate,
self.fps,
self.quality,
self.rate_control,
);
match fallback_result {
Ok(enc) => {
self.h264_encoder = Some(enc);
self.encode_failures = 0;
self.egfx_surface_id = None; // Force surface re-init
}
Err(e) => {
tracing::error!("Software encoder fallback failed: {:#}", e);
self.h264_encoder = None;
self.egfx_active = false;
}
}
}
}
}
// RFX-over-EGFX is not available through the current server API.
// AVC-disabled clients fall through to bitmap fallback below.
}
if sent_via_egfx {
self.sent_first_frame = true;
self.pending_damage_regions.clear();
}
// Send bitmaps only when EGFX is unavailable or negotiated without AVC.
// If EGFX is configured but capability negotiation has not completed yet,
// keep the damage pending so startup does not mix legacy bitmap updates
// with the graphics pipeline activation sequence.
let egfx_state = self
.egfx_shared
.as_ref()
.map(|s| (s.is_ready(), s.is_avc_enabled()));
let egfx_runtime_available =
self.egfx_active && self.h264_encoder.is_some() && self.egfx_surface_id.is_some();
let should_send_bitmap = match egfx_state {
None => true,
Some((false, _)) => false,
Some((true, avc_enabled)) => !avc_enabled || !egfx_runtime_available,
};
if !sent_via_egfx && should_send_bitmap {
self.sent_first_frame = true;
let update = DisplayUpdate::Bitmap(BitmapUpdate {
x: 0,
y: 0,
width: NonZeroU16::new(self.width as u16).expect("width is non-zero"),
height: NonZeroU16::new(self.height as u16).expect("height is non-zero"),
format: self.pixel_format,
data: Bytes::copy_from_slice(data),
stride: NonZeroUsize::new(self.stride as usize).expect("stride is non-zero"),
});
if tx.blocking_send(update).is_err() {
tracing::info!("Display update channel closed");
return false;
}
self.damage_detector
.update_reference(data, self.height, self.stride as usize);
self.pending_damage_regions.clear();
}
true
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::capture::scale::prepare_presentation_frame;
use crate::display::geometry::{PresentationGeometry, Size};
use crate::egfx::test_support::{
ack_frame, drain_gfx_pdus, negotiated_avc444_egfx, negotiated_egfx_with_policy,
negotiated_no_avc_egfx, process_avc444_capabilities, start_gfx_channel,
tracked_avc444_session, unnegotiated_egfx_shared, Avc444PresentationOracle,
ExpectedAvc444Encoding, TestQueueDepth,
};
use crate::egfx::{
EgfxCodecPolicy, H264RateControl, HyprGfxFactory, DEFAULT_MAX_FRAMES_IN_FLIGHT,
};
use crate::input::OutputLayoutSnapshot;
use ironrdp_server::{DisplayUpdate, PixelFormat};
use ironrdp_server::{GfxServerFactory, ServerEventSender};
use std::sync::Arc;
use std::time::{Duration, Instant};
use tokio::sync::mpsc;
#[test]
fn frame_processor_encoder_skip_preserves_retry_without_forcing_idr() {
let width = 64;
let height = 64;
let stride = width * 4;
let mut processor = FrameProcessor::new(
None,
width as u32,
height as u32,
PixelFormat::BgrA32,
stride as u32,
1_000_000,
23,
H264RateControl::Cqp,
30,
);
processor.h264_encoder = Some(
crate::egfx::FrameEncoder::new_avc444_software_only(
width as u32,
height as u32,
1_000_000,
30,
23,
H264RateControl::Cqp,
)
.expect("AVC444 encoder initializes"),
);
processor.encode_failures = 2;
FrameProcessor::handle_encoder_skip(
&mut processor.encode_failures,
&mut processor.stats,
processor.width,
processor.height,
);
assert_eq!(processor.encode_failures, 0);
assert_eq!(
processor
.h264_encoder
.as_ref()
.and_then(crate::egfx::FrameEncoder::force_idr_requests_for_test),
Some(0)
);
}
fn gradient_bgra_frame(width: usize, height: usize, stride: usize) -> Vec<u8> {
let mut frame = vec![0; stride * height];
for y in 0..height {
for x in 0..width {
let offset = y * stride + x * 4;
frame[offset] = (x * 11 + y * 3) as u8;
frame[offset + 1] = (x * 5 + y * 17) as u8;
frame[offset + 2] = (x * 19 + y * 7) as u8;
frame[offset + 3] = 255;
}
}
frame
}
fn solid_bgra_frame(
width: usize,
height: usize,
stride: usize,
r: u8,
g: u8,
b: u8,
) -> Vec<u8> {
let mut frame = vec![0; stride * height];
for y in 0..height {
for x in 0..width {
write_bgra_pixel(&mut frame, stride, x, y, r, g, b);
}
}
frame
}
fn write_bgra_pixel(frame: &mut [u8], stride: usize, x: usize, y: usize, r: u8, g: u8, b: u8) {
let offset = y * stride + x * 4;
frame[offset] = b;
frame[offset + 1] = g;
frame[offset + 2] = r;
frame[offset + 3] = 255;
}
fn output_layout_snapshot(
source: (u32, u32),
presentation: (u32, u32),
) -> OutputLayoutSnapshot {
let source_size = Size::new(source.0, source.1).unwrap();
let presentation_size = Size::new(presentation.0, presentation.1).unwrap();
OutputLayoutSnapshot {
output_name: "DP-1".into(),
output_w: source.0,
output_h: source.1,
layout_extent_w: source.0,
layout_extent_h: source.1,
output_offset_x: 0,
output_offset_y: 0,
presentation_geometry: PresentationGeometry::new(source_size, presentation_size),
geometry_generation: 0,
}
}
fn mutate_bgra_tile(
frame: &mut [u8],
width: usize,
height: usize,
stride: usize,
index: usize,
) {
let start_x = 8 + (index * 7) % (width - 24);
let start_y = 8 + (index * 5) % (height - 24);
for y in start_y..start_y + 16 {
for x in start_x..start_x + 16 {
let offset = y * stride + x * 4;
frame[offset] = frame[offset].wrapping_add((index as u8).wrapping_mul(17));
frame[offset + 1] ^= 0x5a;
frame[offset + 2] = frame[offset + 2].wrapping_sub(0x33);
}
}
}
fn assert_bitmap_update(