wayk_proto 0.1.0

WaykNow packet encoder-decoder and sequencing utilities
Documentation 
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

// NOW_UPDATE_MSG

use crate::{
    container::{Bytes32, Vec8},
    message::{common, Codec, SizeRect},
};
use num_derive::FromPrimitive;

#[derive(Encode, Decode, FromPrimitive, Debug, PartialEq, Clone, Copy)]
#[repr(u8)]
pub enum UpdateMessageType {
    UpdateGraphics = 0x01,
    UpdateRefresh = 0x02,
    UpdateSuppress = 0x03,
}

__flags_struct! {
    UpdateGraphicsFlags: u32 => {
        frame_first = FRAME_FIRST = 0x0000_0001,
        frame_last = FRAME_LAST = 0x0000_0002,
    }
}

#[derive(Encode, Decode, FromPrimitive, Debug, PartialEq, Clone, Copy)]
#[repr(u8)]
pub enum UpdateRegionFlag {
    Null = 0x01,
    Full = 0x02,
}

#[derive(Decode, Encode, Debug, Clone)]
pub struct NowUpdateRegion {
    pub surface_id: u16,
    pub flags: UpdateRegionFlag,
    pub rects: Vec8<SizeRect>,
}

#[derive(Debug, Clone, Encode, Decode)]
#[meta_enum = "UpdateMessageType"]
pub enum NowUpdateMsg<'a> {
    UpdateGraphics(NowUpdateGraphicsMsg<'a>),
    UpdateRefresh(NowUpdateRefreshMsg),
    UpdateSuppress(NowUpdateSuppressMsg),
}

#[derive(Encode, Decode, Debug, Clone)]
pub struct NowUpdateGraphicsMsg<'a> {
    pub subtype: UpdateMessageType,
    flags: u8,

    pub codec_id: Codec,
    pub surface_id: u16,
    pub frame_id: u16,
    pub update_flags: UpdateGraphicsFlags,
    pub update_rect: common::SizeRect,
    pub update_data: Bytes32<'a>,
}

impl<'a> NowUpdateGraphicsMsg<'a> {
    pub const REQUIRED_SIZE: usize = 24;
}

#[derive(Decode, Encode, Debug, Clone)]
pub struct NowUpdateRefreshMsg {
    pub subtype: UpdateMessageType,
    flags: u8,

    reserved: u8,
    pub regions: Vec8<NowUpdateRegion>,
}

#[derive(Decode, Encode, Debug, Clone)]
#[repr(C)]
pub struct NowUpdateSuppressMsg {
    pub subtype: UpdateMessageType,
    flags: u8,

    reserved: u8,
    pub regions: Vec8<NowUpdateRegion>,
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{
        header::{AbstractNowHeader, NowHeader},
        serialization::Decode,
    };

    #[rustfmt::skip]
    const WAYK_NOW_UPDATE_GRAPHIC_MSG: [u8; 35] = [
        // header
        0x1d, 0x03, 0x00, 0x00, // msgSize
        0x00, // msgFlags
        0x42, // msgType
        // update graphic
        0x01, // subtype
        0x00, // flags
        0x02, 0x00, // codecId
        0x00, 0x00, // surfaceID
        0x01, 0x00, // frameID
        0x03, 0x00, 0x00, 0x00, // updateFlags
        0x60, 0x07, /* X pos */ 0x24, 0x04, /* Y pos */ 0x0c, 0x00,
        /* width */ 0x0c, 0x00, /* height */
        // updateRect
        0x05, 0x00, 0x00, 0x00, // updateSize
      	0x01, 0x02, 0x03, 0x04, 0x05,
    ];

    #[test]
    fn update_graphics_decoding() {
        let header = NowHeader::decode(&WAYK_NOW_UPDATE_GRAPHIC_MSG).unwrap();
        let update_graphic_payload = &WAYK_NOW_UPDATE_GRAPHIC_MSG[header.len()..];
        let ugm = NowUpdateGraphicsMsg::decode(update_graphic_payload).unwrap();
        assert_eq!(ugm.flags, 0x00);
        assert_eq!(ugm.codec_id, Codec::JPEG);
        assert_eq!(ugm.surface_id, 0x0000);
        assert_eq!(ugm.frame_id, 0x0001);
        assert_eq!(ugm.update_flags.value, 0x00000003);
        assert_eq!(ugm.update_data.len(), 5);
        assert_eq!(ugm.update_data[0], 0x01);
    }
}