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
use std::io::Read;
#[allow(dead_code, unused_imports)]
#[path = "./ioheader_generated.rs"]
mod ioheader_generated;
#[allow(dead_code, unused_imports)]
#[path = "./events_generated.rs"]
mod events_generated;
#[allow(dead_code, unused_imports)]
#[path = "./frame_generated.rs"]
mod frame_generated;
#[allow(dead_code, unused_imports)]
#[path = "./imus_generated.rs"]
mod imus_generated;
#[allow(dead_code, unused_imports)]
#[path = "./triggers_generated.rs"]
mod triggers_generated;
const MAGIC_NUMBER: &str = "#!AER-DAT4.0\r\n";
#[derive(Debug)]
pub struct ParseError {
message: String,
}
impl ParseError {
pub fn new(message: &str) -> ParseError {
ParseError {
message: message.to_string(),
}
}
}
impl std::fmt::Display for ParseError {
fn fmt(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
write!(formatter, "{}", self.message)
}
}
impl std::convert::From<std::io::Error> for ParseError {
fn from(error: std::io::Error) -> Self {
ParseError {
message: error.to_string(),
}
}
}
impl std::convert::From<flatbuffers::InvalidFlatbuffer> for ParseError {
fn from(error: flatbuffers::InvalidFlatbuffer) -> Self {
ParseError {
message: error.to_string(),
}
}
}
impl std::convert::From<std::str::Utf8Error> for ParseError {
fn from(error: std::str::Utf8Error) -> Self {
ParseError {
message: error.to_string(),
}
}
}
impl std::convert::From<roxmltree::Error> for ParseError {
fn from(error: roxmltree::Error) -> Self {
ParseError {
message: error.to_string(),
}
}
}
impl std::convert::From<std::num::ParseIntError> for ParseError {
fn from(error: std::num::ParseIntError) -> Self {
ParseError {
message: error.to_string(),
}
}
}
pub enum StreamContent {
Events,
Frame,
Imus,
Triggers,
}
impl StreamContent {
fn from(identifier: &str) -> Result<Self, ParseError> {
match identifier {
"EVTS" => Ok(StreamContent::Events),
"FRME" => Ok(StreamContent::Frame),
"IMUS" => Ok(StreamContent::Imus),
"TRIG" => Ok(StreamContent::Triggers),
_ => Err(ParseError::new("unsupported stream type")),
}
}
}
impl std::fmt::Display for StreamContent {
fn fmt(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
write!(
formatter,
"{}",
match self {
StreamContent::Events => "EVTS",
StreamContent::Frame => "FRME",
StreamContent::Imus => "IMUS",
StreamContent::Triggers => "TRIG",
}
)
}
}
pub struct Stream {
pub content: StreamContent,
pub width: u16,
pub height: u16,
}
pub struct Decoder {
pub id_to_stream: std::collections::HashMap<u32, Stream>,
file: std::fs::File,
position: i64,
compression: ioheader_generated::Compression,
file_data_position: i64,
}
impl Decoder {
pub fn new<P: std::convert::AsRef<std::path::Path>>(path: P) -> Result<Self, ParseError> {
let mut decoder = Decoder {
id_to_stream: std::collections::HashMap::new(),
file: std::fs::File::open(path)?,
position: 0i64,
file_data_position: 0,
compression: ioheader_generated::Compression::None,
};
{
let mut magic_number_buffer = [0; MAGIC_NUMBER.len()];
decoder.file.read_exact(&mut magic_number_buffer)?;
if std::str::from_utf8(&magic_number_buffer)? != MAGIC_NUMBER {
return Err(ParseError::new(
"the file does not contain AEDAT4 data (wrong magic number)",
));
}
decoder.position += MAGIC_NUMBER.len() as i64;
}
let length = {
let mut bytes = [0; 4];
decoder.file.read_exact(&mut bytes)?;
u32::from_le_bytes(bytes)
};
decoder.position += 4i64 + length as i64;
{
let mut buffer = std::vec![0; length as usize];
decoder.file.read_exact(&mut buffer)?;
let ioheader = unsafe { ioheader_generated::root_as_ioheader_unchecked(&buffer) };
decoder.compression = ioheader.compression();
decoder.file_data_position = ioheader.file_data_position();
let description = match ioheader.description() {
Some(content) => content,
None => return Err(ParseError::new("the description is empty")),
};
let document = roxmltree::Document::parse(description)?;
let dv_node = match document.root().first_child() {
Some(content) => content,
None => return Err(ParseError::new("the description has no dv node")),
};
if !dv_node.has_tag_name("dv") {
return Err(ParseError::new("unexpected dv node tag"));
}
let output_node = match dv_node.children().find(|node| {
node.is_element()
&& node.has_tag_name("node")
&& node.attribute("name") == Some("outInfo")
}) {
Some(content) => content,
None => return Err(ParseError::new("the description has no output node")),
};
for stream_node in output_node.children() {
if stream_node.is_element() && stream_node.has_tag_name("node") {
if !stream_node.has_tag_name("node") {
return Err(ParseError::new("unexpected stream node tag"));
}
let stream_id = match stream_node.attribute("name") {
Some(content) => content,
None => return Err(ParseError::new("missing stream node id")),
}
.parse::<u32>()?;
let identifier = match stream_node.children().find(|node| {
node.is_element()
&& node.has_tag_name("attr")
&& node.attribute("key") == Some("typeIdentifier")
}) {
Some(content) => match content.text() {
Some(content) => content,
None => {
return Err(ParseError::new("empty stream node type identifier"))
}
},
None => return Err(ParseError::new("missing stream node type identifier")),
}
.to_string();
let mut width = 0u16;
let mut height = 0u16;
if identifier == "EVTS" || identifier == "FRME" {
let info_node = match stream_node.children().find(|node| {
node.is_element()
&& node.has_tag_name("node")
&& node.attribute("name") == Some("info")
}) {
Some(content) => content,
None => return Err(ParseError::new("missing info node")),
};
width = match info_node.children().find(|node| {
node.is_element()
&& node.has_tag_name("attr")
&& node.attribute("key") == Some("sizeX")
}) {
Some(content) => match content.text() {
Some(content) => content,
None => return Err(ParseError::new("empty sizeX attribute")),
},
None => return Err(ParseError::new("missing sizeX attribute")),
}
.parse::<u16>()?;
height = match info_node.children().find(|node| {
node.is_element()
&& node.has_tag_name("attr")
&& node.attribute("key") == Some("sizeY")
}) {
Some(content) => match content.text() {
Some(content) => content,
None => return Err(ParseError::new("empty sizeX attribute")),
},
None => return Err(ParseError::new("missing sizeX attribute")),
}
.parse::<u16>()?;
}
if decoder
.id_to_stream
.insert(
stream_id,
Stream {
content: StreamContent::from(&identifier)?,
width,
height,
},
)
.is_some()
{
return Err(ParseError::new("duplicated stream id"));
}
}
}
}
if decoder.id_to_stream.is_empty() {
return Err(ParseError::new("no stream found in the description"));
}
Ok(decoder)
}
}
#[derive(Debug, Clone)]
pub struct Packet {
pub buffer: std::vec::Vec<u8>,
pub stream_id: u32,
}
impl Iterator for Decoder {
type Item = Result<Packet, ParseError>;
fn next(&mut self) -> Option<Self::Item> {
if self.file_data_position > -1 && self.position == self.file_data_position {
return None;
}
let mut packet = Packet {
buffer: Vec::new(),
stream_id: {
let mut bytes = [0; 4];
match self.file.read_exact(&mut bytes) {
Ok(()) => (),
Err(_) => return None,
}
u32::from_le_bytes(bytes)
},
};
let length = {
let mut bytes = [0; 4];
if let Err(error) = self.file.read_exact(&mut bytes) {
return Some(Err(ParseError::from(error)));
}
u32::from_le_bytes(bytes)
};
self.position += 8i64 + length as i64;
let mut raw_buffer = std::vec![0; length as usize];
if let Err(error) = self.file.read_exact(&mut raw_buffer) {
return Some(Err(ParseError::from(error)));
}
match self.compression {
ioheader_generated::Compression::None => {
std::mem::swap(&mut raw_buffer, &mut packet.buffer)
}
ioheader_generated::Compression::Lz4 | ioheader_generated::Compression::Lz4High => {
match lz4::Decoder::new(&raw_buffer[..]) {
Ok(mut result) => {
if let Err(error) = result.read_to_end(&mut packet.buffer) {
return Some(Err(ParseError::from(error)));
}
}
Err(error) => return Some(Err(ParseError::from(error))),
}
}
ioheader_generated::Compression::Zstd | ioheader_generated::Compression::ZstdHigh => {
match zstd::stream::Decoder::new(&raw_buffer[..]) {
Ok(mut result) => {
if let Err(error) = result.read_to_end(&mut packet.buffer) {
return Some(Err(ParseError::from(error)));
}
}
Err(error) => return Some(Err(ParseError::from(error))),
}
}
_ => return Some(Err(ParseError::new("unknown compression algorithm"))),
}
let expected_content = &(match self.id_to_stream.get(&packet.stream_id) {
Some(content) => content,
None => return Some(Err(ParseError::new("unknown stream id"))),
}
.content);
if !flatbuffers::buffer_has_identifier(&packet.buffer, &expected_content.to_string(), true)
{
return Some(Err(ParseError::new(
"the stream id and the identifier do not match",
)));
}
Some(Ok(packet))
}
}