-
Notifications
You must be signed in to change notification settings - Fork 48
/
fast_path.rs
490 lines (430 loc) · 20.6 KB
/
fast_path.rs
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
use std::rc::Rc;
use ironrdp_core::decode_cursor;
use ironrdp_core::{DecodeErrorKind, ReadCursor, WriteBuf};
use ironrdp_graphics::image_processing::PixelFormat;
use ironrdp_graphics::pointer::{DecodedPointer, PointerBitmapTarget};
use ironrdp_graphics::rdp6::BitmapStreamDecoder;
use ironrdp_graphics::rle::RlePixelFormat;
use ironrdp_pdu::codecs::rfx::FrameAcknowledgePdu;
use ironrdp_pdu::fast_path::{FastPathHeader, FastPathUpdate, FastPathUpdatePdu, Fragmentation};
use ironrdp_pdu::geometry::{InclusiveRectangle, Rectangle as _};
use ironrdp_pdu::pointer::PointerUpdateData;
use ironrdp_pdu::rdp::headers::ShareDataPdu;
use ironrdp_pdu::surface_commands::{FrameAction, FrameMarkerPdu, SurfaceCommand};
use crate::image::DecodedImage;
use crate::pointer::PointerCache;
use crate::utils::CodecId;
use crate::{rfx, SessionError, SessionErrorExt, SessionResult};
#[derive(Debug)]
pub enum UpdateKind {
None,
Region(InclusiveRectangle),
PointerDefault,
PointerHidden,
PointerPosition { x: u16, y: u16 },
PointerBitmap(Rc<DecodedPointer>),
}
pub struct Processor {
complete_data: CompleteData,
rfx_handler: rfx::DecodingContext,
marker_processor: FrameMarkerProcessor,
bitmap_stream_decoder: BitmapStreamDecoder,
pointer_cache: PointerCache,
use_system_pointer: bool,
mouse_pos_update: Option<(u16, u16)>,
no_server_pointer: bool,
pointer_software_rendering: bool,
}
impl Processor {
pub fn update_mouse_pos(&mut self, x: u16, y: u16) {
self.mouse_pos_update = Some((x, y));
}
/// Process input fast path frame and return list of updates.
pub fn process(
&mut self,
image: &mut DecodedImage,
input: &[u8],
output: &mut WriteBuf,
) -> SessionResult<Vec<UpdateKind>> {
let mut processor_updates = Vec::new();
if let Some((x, y)) = self.mouse_pos_update.take() {
if let Some(rect) = image.move_pointer(x, y)? {
processor_updates.push(UpdateKind::Region(rect));
}
}
let mut input = ReadCursor::new(input);
let header = decode_cursor::<FastPathHeader>(&mut input).map_err(SessionError::decode)?;
debug!(fast_path_header = ?header, "Received Fast-Path packet");
let update_pdu = decode_cursor::<FastPathUpdatePdu<'_>>(&mut input).map_err(SessionError::decode)?;
trace!(fast_path_update_fragmentation = ?update_pdu.fragmentation);
let processed_complete_data = self
.complete_data
.process_data(update_pdu.data, update_pdu.fragmentation);
let update_code = update_pdu.update_code;
let Some(data) = processed_complete_data else {
return Ok(Vec::new());
};
let update = FastPathUpdate::decode_with_code(data.as_slice(), update_code);
match update {
Ok(FastPathUpdate::SurfaceCommands(surface_commands)) => {
trace!("Received Surface Commands: {} pieces", surface_commands.len());
let update_region = self.process_surface_commands(image, output, surface_commands)?;
processor_updates.push(UpdateKind::Region(update_region));
}
Ok(FastPathUpdate::Bitmap(bitmap_update)) => {
trace!("Received bitmap update");
let mut buf = Vec::new();
let mut update_kind = UpdateKind::None;
for update in bitmap_update.rectangles {
trace!("{update:?}");
buf.clear();
// Bitmap data is either compressed or uncompressed, depending
// on whether the BITMAP_COMPRESSION flag is present in the
// flags field.
let update_rectangle = if update
.compression_flags
.contains(ironrdp_pdu::bitmap::Compression::BITMAP_COMPRESSION)
{
if update.bits_per_pixel == 32 {
// Compressed bitmaps at a color depth of 32 bpp are compressed using RDP 6.0
// Bitmap Compression and stored inside an RDP 6.0 Bitmap Compressed Stream
// structure ([MS-RDPEGDI] section 2.2.2.5.1).
debug!("32 bpp compressed RDP6_BITMAP_STREAM");
match self.bitmap_stream_decoder.decode_bitmap_stream_to_rgb24(
update.bitmap_data,
&mut buf,
usize::from(update.width),
usize::from(update.height),
) {
Ok(()) => image.apply_rgb24_bitmap(&buf, &update.rectangle)?,
Err(err) => {
warn!("Invalid RDP6_BITMAP_STREAM: {err}");
update.rectangle.clone()
}
}
} else {
// Compressed bitmaps not in 32 bpp format are compressed using Interleaved
// RLE and encapsulated in an RLE Compressed Bitmap Stream structure (section
// 2.2.9.1.1.3.1.2.4).
debug!(bpp = update.bits_per_pixel, "Non-32 bpp compressed RLE_BITMAP_STREAM",);
match ironrdp_graphics::rle::decompress(
update.bitmap_data,
&mut buf,
usize::from(update.width),
usize::from(update.height),
usize::from(update.bits_per_pixel),
) {
Ok(RlePixelFormat::Rgb16) => image.apply_rgb16_bitmap(&buf, &update.rectangle)?,
// TODO: support other pixel formats…
Ok(format @ (RlePixelFormat::Rgb8 | RlePixelFormat::Rgb15 | RlePixelFormat::Rgb24)) => {
warn!("Received RLE-compressed bitmap with unsupported color depth: {format:?}");
update.rectangle.clone()
}
Err(e) => {
warn!("Invalid RLE-compressed bitmap: {e}");
update.rectangle.clone()
}
}
}
} else {
// Uncompressed bitmap data is formatted as a bottom-up, left-to-right series of
// pixels. Each pixel is a whole number of bytes. Each row contains a multiple of
// four bytes (including up to three bytes of padding, as necessary).
trace!("Uncompressed raw bitmap");
match update.bits_per_pixel {
16 => image.apply_rgb16_bitmap(update.bitmap_data, &update.rectangle)?,
// TODO: support other pixel formats…
unsupported => {
warn!("Invalid raw bitmap with {unsupported} bytes per pixels");
update.rectangle.clone()
}
}
};
match update_kind {
UpdateKind::Region(current) => {
update_kind = UpdateKind::Region(current.union(&update_rectangle))
}
_ => update_kind = UpdateKind::Region(update_rectangle),
}
}
processor_updates.push(update_kind);
}
Ok(FastPathUpdate::Pointer(update)) => {
if self.no_server_pointer {
return Ok(processor_updates);
}
let bitmap_target = if self.pointer_software_rendering {
PointerBitmapTarget::Software
} else {
PointerBitmapTarget::Accelerated
};
match update {
PointerUpdateData::SetHidden => {
processor_updates.push(UpdateKind::PointerHidden);
if self.pointer_software_rendering && !self.use_system_pointer {
self.use_system_pointer = true;
if let Some(rect) = image.hide_pointer()? {
processor_updates.push(UpdateKind::Region(rect));
}
}
}
PointerUpdateData::SetDefault => {
processor_updates.push(UpdateKind::PointerDefault);
if self.pointer_software_rendering && !self.use_system_pointer {
self.use_system_pointer = true;
if let Some(rect) = image.hide_pointer()? {
processor_updates.push(UpdateKind::Region(rect));
}
}
}
PointerUpdateData::SetPosition(position) => {
if self.use_system_pointer || !self.pointer_software_rendering {
processor_updates.push(UpdateKind::PointerPosition {
x: position.x,
y: position.y,
});
} else if let Some(rect) = image.move_pointer(position.x, position.y)? {
processor_updates.push(UpdateKind::Region(rect));
}
}
PointerUpdateData::Color(pointer) => {
let cache_index = pointer.cache_index;
let decoded_pointer = Rc::new(
DecodedPointer::decode_color_pointer_attribute(&pointer, bitmap_target)
.expect("Failed to decode color pointer attribute"),
);
let _ = self
.pointer_cache
.insert(usize::from(cache_index), Rc::clone(&decoded_pointer));
if !self.pointer_software_rendering {
processor_updates.push(UpdateKind::PointerBitmap(Rc::clone(&decoded_pointer)));
} else if let Some(rect) = image.update_pointer(decoded_pointer)? {
processor_updates.push(UpdateKind::Region(rect));
}
}
PointerUpdateData::Cached(cached) => {
let cache_index = cached.cache_index;
if let Some(cached_pointer) = self.pointer_cache.get(usize::from(cache_index)) {
// Disable system pointer
processor_updates.push(UpdateKind::PointerHidden);
self.use_system_pointer = false;
// Send graphics update
if !self.pointer_software_rendering {
processor_updates.push(UpdateKind::PointerBitmap(Rc::clone(&cached_pointer)));
} else if let Some(rect) = image.update_pointer(cached_pointer)? {
processor_updates.push(UpdateKind::Region(rect));
} else {
// In case pointer was hidden previously
if let Some(rect) = image.show_pointer()? {
processor_updates.push(UpdateKind::Region(rect));
}
}
} else {
warn!("Cached pointer not found {}", cache_index);
}
}
PointerUpdateData::New(pointer) => {
let cache_index = pointer.color_pointer.cache_index;
let decoded_pointer = Rc::new(
DecodedPointer::decode_pointer_attribute(&pointer, bitmap_target)
.expect("Failed to decode pointer attribute"),
);
let _ = self
.pointer_cache
.insert(usize::from(cache_index), Rc::clone(&decoded_pointer));
if !self.pointer_software_rendering {
processor_updates.push(UpdateKind::PointerBitmap(Rc::clone(&decoded_pointer)));
} else if let Some(rect) = image.update_pointer(decoded_pointer)? {
processor_updates.push(UpdateKind::Region(rect));
}
}
PointerUpdateData::Large(pointer) => {
let cache_index = pointer.cache_index;
let decoded_pointer: Rc<DecodedPointer> = Rc::new(
DecodedPointer::decode_large_pointer_attribute(&pointer, bitmap_target)
.expect("Failed to decode large pointer attribute"),
);
let _ = self
.pointer_cache
.insert(usize::from(cache_index), Rc::clone(&decoded_pointer));
if !self.pointer_software_rendering {
processor_updates.push(UpdateKind::PointerBitmap(Rc::clone(&decoded_pointer)));
} else if let Some(rect) = image.update_pointer(decoded_pointer)? {
processor_updates.push(UpdateKind::Region(rect));
}
}
};
}
Err(e) => {
if let DecodeErrorKind::InvalidField { field, reason } = e.kind {
warn!(field, reason, "Received invalid Fast-Path update");
processor_updates.push(UpdateKind::None);
} else {
return Err(custom_err!("Fast-Path", e));
}
}
};
Ok(processor_updates)
}
fn process_surface_commands(
&mut self,
image: &mut DecodedImage,
output: &mut WriteBuf,
surface_commands: Vec<SurfaceCommand<'_>>,
) -> SessionResult<InclusiveRectangle> {
let mut update_rectangle = InclusiveRectangle::empty();
for command in surface_commands {
match command {
SurfaceCommand::SetSurfaceBits(bits) | SurfaceCommand::StreamSurfaceBits(bits) => {
trace!("Surface bits");
let codec_id = CodecId::from_u8(bits.extended_bitmap_data.codec_id).ok_or_else(|| {
reason_err!(
"Fast-Path",
"unexpected codec ID: {:x}",
bits.extended_bitmap_data.codec_id
)
})?;
let destination = bits.destination;
// TODO(@pacmancoder): Correct rectangle conversion logic should
// be revisited when `rectangle_processing.rs` from
// `ironrdp-graphics` will be refactored to use generic `Rectangle`
// trait instead of hardcoded `InclusiveRectangle`.
let destination = InclusiveRectangle {
left: destination.left,
top: destination.top,
right: destination.right - 1,
bottom: destination.bottom - 1,
};
match codec_id {
CodecId::None => {
let ext_data = bits.extended_bitmap_data;
match ext_data.bpp {
32 => {
image.apply_rgb32_bitmap(ext_data.data, PixelFormat::BgrX32, &destination)?;
}
bpp => {
warn!("Unsupported bpp: {bpp}")
}
}
}
CodecId::RemoteFx => {
let mut data = bits.extended_bitmap_data.data;
while !data.is_empty() {
let (_frame_id, rectangle) = self.rfx_handler.decode(image, &destination, &mut data)?;
update_rectangle = update_rectangle.union(&rectangle);
}
}
}
}
SurfaceCommand::FrameMarker(marker) => {
trace!(
"Frame marker: action {:?} with ID #{}",
marker.frame_action,
marker.frame_id.unwrap_or(0)
);
self.marker_processor.process(&marker, output)?;
}
}
}
Ok(update_rectangle)
}
}
pub struct ProcessorBuilder {
pub io_channel_id: u16,
pub user_channel_id: u16,
/// Ignore server pointer updates.
pub no_server_pointer: bool,
/// Use software rendering mode for pointer bitmap generation. When this option is active,
/// `UpdateKind::PointerBitmap` will not be generated. Remote pointer will be drawn
/// via software rendering on top of the output image.
pub pointer_software_rendering: bool,
}
impl ProcessorBuilder {
pub fn build(self) -> Processor {
Processor {
complete_data: CompleteData::new(),
rfx_handler: rfx::DecodingContext::new(),
marker_processor: FrameMarkerProcessor::new(self.user_channel_id, self.io_channel_id),
bitmap_stream_decoder: BitmapStreamDecoder::default(),
pointer_cache: PointerCache::default(),
use_system_pointer: true,
mouse_pos_update: None,
no_server_pointer: self.no_server_pointer,
pointer_software_rendering: self.pointer_software_rendering,
}
}
}
#[derive(Debug, PartialEq)]
struct CompleteData {
fragmented_data: Option<Vec<u8>>,
}
impl CompleteData {
fn new() -> Self {
Self { fragmented_data: None }
}
fn process_data(&mut self, data: &[u8], fragmentation: Fragmentation) -> Option<Vec<u8>> {
match fragmentation {
Fragmentation::Single => {
self.check_data_is_empty();
Some(data.to_vec())
}
Fragmentation::First => {
self.check_data_is_empty();
self.fragmented_data = Some(data.to_vec());
None
}
Fragmentation::Next => {
self.append_data(data);
None
}
Fragmentation::Last => {
self.append_data(data);
let complete_data = self.fragmented_data.take().unwrap();
Some(complete_data)
}
}
}
fn check_data_is_empty(&mut self) {
if self.fragmented_data.is_some() {
warn!("Skipping pending Fast-Path Update internal multiple elements data");
self.fragmented_data = None;
}
}
fn append_data(&mut self, data: &[u8]) {
if let Some(fragmented_data) = self.fragmented_data.as_mut() {
fragmented_data.extend_from_slice(data);
} else {
warn!("Got unexpected Next fragmentation PDU without prior First fragmentation PDU");
}
}
}
struct FrameMarkerProcessor {
user_channel_id: u16,
io_channel_id: u16,
}
impl FrameMarkerProcessor {
fn new(user_channel_id: u16, io_channel_id: u16) -> Self {
Self {
user_channel_id,
io_channel_id,
}
}
fn process(&mut self, marker: &FrameMarkerPdu, output: &mut WriteBuf) -> SessionResult<()> {
match marker.frame_action {
FrameAction::Begin => Ok(()),
FrameAction::End => {
ironrdp_connector::legacy::encode_share_data(
self.user_channel_id,
self.io_channel_id,
0,
ShareDataPdu::FrameAcknowledge(FrameAcknowledgePdu {
frame_id: marker.frame_id.unwrap_or(0),
}),
output,
)
.map_err(crate::legacy::map_error)?;
Ok(())
}
}
}
}