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
use std::{
borrow::Cow,
collections::{BTreeMap, HashMap},
io::{self, prelude::*, Cursor, SeekFrom},
mem::size_of,
};
use binrw::prelude::*;
use byteorder::{WriteBytesExt, LE};
use crate::{
io_utils::CountingCrcWriter,
records::{self, op, MessageHeader, Record},
Attachment, Channel, Compression, McapError, McapResult, Message, Schema, MAGIC,
};
pub use records::Metadata;
enum WriteMode<W: Write + Seek> {
Raw(W),
Chunk(ChunkWriter<W>),
}
fn op_and_len<W: Write>(w: &mut W, op: u8, len: usize) -> io::Result<()> {
w.write_u8(op)?;
w.write_u64::<LE>(len as u64)?;
Ok(())
}
fn write_record<W: Write>(w: &mut W, r: &Record) -> io::Result<()> {
macro_rules! record {
($op:expr, $b:ident) => {{
let mut rec_buf = Vec::new();
Cursor::new(&mut rec_buf).write_le($b).unwrap();
op_and_len(w, $op, rec_buf.len())?;
w.write_all(&rec_buf)?;
}};
}
match r {
Record::Header(h) => record!(op::HEADER, h),
Record::Footer(_) => {
unreachable!("Footer handles its own serialization because its CRC is self-referencing")
}
Record::Schema { header, data } => {
let mut header_buf = Vec::new();
Cursor::new(&mut header_buf).write_le(header).unwrap();
op_and_len(
w,
op::SCHEMA,
header_buf.len() + size_of::<u32>() + data.len(),
)?;
w.write_all(&header_buf)?;
w.write_u32::<LE>(data.len() as u32)?;
w.write_all(data)?;
}
Record::Channel(c) => record!(op::CHANNEL, c),
Record::Message { header, data } => {
let mut header_buf = Vec::new();
Cursor::new(&mut header_buf).write_le(header).unwrap();
op_and_len(w, op::MESSAGE, header_buf.len() + data.len())?;
w.write_all(&header_buf)?;
w.write_all(data)?;
}
Record::Chunk { .. } => {
unreachable!("Chunks handle their own serialization due to seeking shenanigans")
}
Record::MessageIndex(_) => {
unreachable!("MessageIndexes handle their own serialization to recycle the buffer between indexes")
}
Record::ChunkIndex(c) => record!(op::CHUNK_INDEX, c),
Record::Attachment { header, data } => {
let mut header_buf = Vec::new();
Cursor::new(&mut header_buf).write_le(header).unwrap();
op_and_len(
w,
op::ATTACHMENT,
header_buf.len() + size_of::<u64>() + data.len() + size_of::<u32>(), )?;
let mut checksummer = CountingCrcWriter::new(w);
checksummer.write_all(&header_buf)?;
checksummer.write_u64::<LE>(data.len() as u64)?;
checksummer.write_all(data)?;
let (w, crc) = checksummer.finalize();
w.write_u32::<LE>(crc)?;
}
Record::AttachmentIndex(ai) => record!(op::ATTACHMENT_INDEX, ai),
Record::Statistics(s) => record!(op::STATISTICS, s),
Record::Metadata(m) => record!(op::METADATA, m),
Record::MetadataIndex(mi) => record!(op::METADATA_INDEX, mi),
Record::SummaryOffset(so) => record!(op::SUMMARY_OFFSET, so),
Record::DataEnd(eod) => record!(op::DATA_END, eod),
_ => todo!(),
};
Ok(())
}
#[derive(Debug, Clone)]
pub struct WriteOptions {
compression: Option<Compression>,
profile: String,
}
impl Default for WriteOptions {
fn default() -> Self {
Self {
compression: Some(Compression::Zstd),
profile: String::new(),
}
}
}
impl WriteOptions {
pub fn new() -> Self {
Self::default()
}
pub fn compression(self, compression: Option<Compression>) -> Self {
Self {
compression,
..self
}
}
pub fn profile<S: Into<String>>(self, profile: S) -> Self {
Self {
profile: profile.into(),
..self
}
}
pub fn create<'a, W: Write + Seek>(self, w: W) -> McapResult<Writer<'a, W>> {
Writer::with_options(w, self)
}
}
pub struct Writer<'a, W: Write + Seek> {
writer: Option<WriteMode<W>>,
compression: Option<Compression>,
schemas: HashMap<Schema<'a>, u16>,
channels: HashMap<Channel<'a>, u16>,
stats: records::Statistics,
chunk_indexes: Vec<records::ChunkIndex>,
attachment_indexes: Vec<records::AttachmentIndex>,
metadata_indexes: Vec<records::MetadataIndex>,
}
impl<'a, W: Write + Seek> Writer<'a, W> {
pub fn new(writer: W) -> McapResult<Self> {
Self::with_options(writer, WriteOptions::default())
}
fn with_options(mut writer: W, opts: WriteOptions) -> McapResult<Self> {
writer.write_all(MAGIC)?;
write_record(
&mut writer,
&Record::Header(records::Header {
profile: opts.profile,
library: String::from("mcap-rs-") + env!("CARGO_PKG_VERSION"),
}),
)?;
Ok(Self {
writer: Some(WriteMode::Raw(writer)),
compression: opts.compression,
schemas: HashMap::new(),
channels: HashMap::new(),
stats: records::Statistics::default(),
chunk_indexes: Vec::new(),
attachment_indexes: Vec::new(),
metadata_indexes: Vec::new(),
})
}
pub fn add_channel(&mut self, chan: &Channel<'a>) -> McapResult<u16> {
let schema_id = match &chan.schema {
Some(s) => self.add_schema(s)?,
None => 0,
};
if let Some(id) = self.channels.get(chan) {
return Ok(*id);
}
self.stats.channel_count += 1;
let next_channel_id = self.channels.len() as u16;
assert!(self
.channels
.insert(chan.clone(), next_channel_id)
.is_none());
self.chunkin_time()?
.write_channel(next_channel_id, schema_id, chan)?;
Ok(next_channel_id)
}
fn add_schema(&mut self, schema: &Schema<'a>) -> McapResult<u16> {
if let Some(id) = self.schemas.get(schema) {
return Ok(*id);
}
self.stats.schema_count += 1;
let next_schema_id = self.schemas.len() as u16 + 1;
assert!(self
.schemas
.insert(schema.clone(), next_schema_id)
.is_none());
self.chunkin_time()?.write_schema(next_schema_id, schema)?;
Ok(next_schema_id)
}
pub fn write(&mut self, message: &Message<'a>) -> McapResult<()> {
let channel_id = self.add_channel(&message.channel)?;
let header = MessageHeader {
channel_id,
sequence: message.sequence,
log_time: message.log_time,
publish_time: message.publish_time,
};
let data: &[u8] = &message.data;
self.write_to_known_channel(&header, data)
}
pub fn write_to_known_channel(
&mut self,
header: &MessageHeader,
data: &[u8],
) -> McapResult<()> {
if !self.channels.values().any(|id| *id == header.channel_id) {
return Err(McapError::UnknownChannel(
header.sequence,
header.channel_id,
));
}
self.stats.message_count += 1;
self.stats.message_start_time = match self.stats.message_start_time {
0 => header.log_time,
nz => nz.min(header.log_time),
};
self.stats.message_end_time = match self.stats.message_end_time {
0 => header.log_time,
nz => nz.max(header.log_time),
};
*self
.stats
.channel_message_counts
.entry(header.channel_id)
.or_insert(0) += 1;
self.chunkin_time()?.write_message(header, data)?;
Ok(())
}
pub fn attach(&mut self, attachment: &Attachment) -> McapResult<()> {
self.stats.attachment_count += 1;
let header = records::AttachmentHeader {
log_time: attachment.log_time,
create_time: attachment.create_time,
name: attachment.name.clone(),
media_type: attachment.media_type.clone(),
};
let w = self.finish_chunk()?;
let offset = w.stream_position()?;
write_record(
w,
&Record::Attachment {
header,
data: Cow::Borrowed(&attachment.data),
},
)?;
let length = w.stream_position()? - offset;
self.attachment_indexes.push(records::AttachmentIndex {
offset,
length,
log_time: attachment.log_time,
create_time: attachment.create_time,
data_size: attachment.data.len() as u64,
name: attachment.name.clone(),
media_type: attachment.media_type.clone(),
});
Ok(())
}
pub fn write_metadata(&mut self, metadata: &Metadata) -> McapResult<()> {
self.stats.metadata_count += 1;
let w = self.finish_chunk()?;
let offset = w.stream_position()?;
write_record(w, &Record::Metadata(metadata.clone()))?;
let length = w.stream_position()? - offset;
self.metadata_indexes.push(records::MetadataIndex {
offset,
length,
name: metadata.name.clone(),
});
Ok(())
}
pub fn flush(&mut self) -> McapResult<()> {
self.finish_chunk()?.flush()?;
Ok(())
}
const WHERE_WRITER: &'static str = "Trying to write a record on a finished MCAP";
fn chunkin_time(&mut self) -> McapResult<&mut ChunkWriter<W>> {
let prev_writer = self.writer.take().expect(Self::WHERE_WRITER);
self.writer = Some(match prev_writer {
WriteMode::Raw(w) => {
self.stats.chunk_count += 1;
WriteMode::Chunk(ChunkWriter::new(w, self.compression)?)
}
chunk => chunk,
});
match &mut self.writer {
Some(WriteMode::Chunk(c)) => Ok(c),
_ => unreachable!(),
}
}
fn finish_chunk(&mut self) -> McapResult<&mut W> {
let prev_writer = self.writer.take().expect(Self::WHERE_WRITER);
self.writer = Some(match prev_writer {
WriteMode::Chunk(c) => {
let (w, index) = c.finish()?;
self.chunk_indexes.push(index);
WriteMode::Raw(w)
}
raw => raw,
});
match &mut self.writer {
Some(WriteMode::Raw(w)) => Ok(w),
_ => unreachable!(),
}
}
pub fn finish(&mut self) -> McapResult<()> {
if self.writer.is_none() {
return Ok(());
}
self.finish_chunk()?;
let mut writer = match self.writer.take() {
Some(WriteMode::Raw(w)) => w,
_ => unreachable!(),
};
let writer = &mut writer;
write_record(writer, &Record::DataEnd(records::DataEnd::default()))?;
let mut stats = records::Statistics::default();
std::mem::swap(&mut stats, &mut self.stats);
let mut chunk_indexes = Vec::new();
std::mem::swap(&mut chunk_indexes, &mut self.chunk_indexes);
let mut attachment_indexes = Vec::new();
std::mem::swap(&mut attachment_indexes, &mut self.attachment_indexes);
let mut metadata_indexes = Vec::new();
std::mem::swap(&mut metadata_indexes, &mut self.metadata_indexes);
struct ChannelSummary<'a> {
channel: Channel<'a>,
channel_id: u16,
schema_id: u16,
}
let mut all_channels: Vec<ChannelSummary<'_>> = self
.channels
.drain()
.map(|(channel, channel_id)| {
let schema_id = match &channel.schema {
Some(s) => *self.schemas.get(s).unwrap(),
None => 0,
};
ChannelSummary {
channel,
channel_id,
schema_id,
}
})
.collect();
all_channels.sort_unstable_by_key(|cs| cs.channel_id);
let mut all_schemas: Vec<(Schema<'_>, u16)> = self.schemas.drain().collect();
all_schemas.sort_unstable_by_key(|(_, v)| *v);
let mut offsets = Vec::new();
let summary_start = writer.stream_position()?;
let mut ccw = CountingCrcWriter::new(writer);
fn posit<W: Write + Seek>(ccw: &mut CountingCrcWriter<W>) -> io::Result<u64> {
ccw.get_mut().stream_position()
}
let schemas_start = summary_start;
for (schema, id) in all_schemas {
let header = records::SchemaHeader {
id,
name: schema.name,
encoding: schema.encoding,
};
let data = schema.data;
write_record(&mut ccw, &Record::Schema { header, data })?;
}
let schemas_end = posit(&mut ccw)?;
if schemas_end - schemas_start > 0 {
offsets.push(records::SummaryOffset {
group_opcode: op::SCHEMA,
group_start: schemas_start,
group_length: schemas_end - schemas_start,
});
}
let channels_start = schemas_end;
for cs in all_channels {
let rec = records::Channel {
id: cs.channel_id,
schema_id: cs.schema_id,
topic: cs.channel.topic,
message_encoding: cs.channel.message_encoding,
metadata: cs.channel.metadata,
};
write_record(&mut ccw, &Record::Channel(rec))?;
}
let channels_end = posit(&mut ccw)?;
if channels_end - channels_start > 0 {
offsets.push(records::SummaryOffset {
group_opcode: op::CHANNEL,
group_start: channels_start,
group_length: channels_end - channels_start,
});
}
let chunk_indexes_start = channels_end;
for index in chunk_indexes {
write_record(&mut ccw, &Record::ChunkIndex(index))?;
}
let chunk_indexes_end = posit(&mut ccw)?;
if chunk_indexes_end - chunk_indexes_start > 0 {
offsets.push(records::SummaryOffset {
group_opcode: op::CHUNK_INDEX,
group_start: chunk_indexes_start,
group_length: chunk_indexes_end - chunk_indexes_start,
});
}
let attachment_indexes_start = chunk_indexes_end;
for index in attachment_indexes {
write_record(&mut ccw, &Record::AttachmentIndex(index))?;
}
let attachment_indexes_end = posit(&mut ccw)?;
if attachment_indexes_end - attachment_indexes_start > 0 {
offsets.push(records::SummaryOffset {
group_opcode: op::ATTACHMENT_INDEX,
group_start: attachment_indexes_start,
group_length: attachment_indexes_end - attachment_indexes_start,
});
}
let metadata_indexes_start = attachment_indexes_end;
for index in metadata_indexes {
write_record(&mut ccw, &Record::MetadataIndex(index))?;
}
let metadata_indexes_end = posit(&mut ccw)?;
if metadata_indexes_end - metadata_indexes_start > 0 {
offsets.push(records::SummaryOffset {
group_opcode: op::METADATA_INDEX,
group_start: metadata_indexes_start,
group_length: metadata_indexes_end - metadata_indexes_start,
});
}
let stats_start = metadata_indexes_end;
write_record(&mut ccw, &Record::Statistics(stats))?;
let stats_end = posit(&mut ccw)?;
assert!(stats_end > stats_start);
offsets.push(records::SummaryOffset {
group_opcode: op::STATISTICS,
group_start: stats_start,
group_length: stats_end - stats_start,
});
let summary_offset_start = stats_end;
for offset in offsets {
write_record(&mut ccw, &Record::SummaryOffset(offset))?;
}
op_and_len(&mut ccw, op::FOOTER, 20)?;
ccw.write_u64::<LE>(summary_start)?;
ccw.write_u64::<LE>(summary_offset_start)?;
let (writer, summary_crc) = ccw.finalize();
writer.write_u32::<LE>(summary_crc)?;
writer.write_all(MAGIC)?;
writer.flush()?;
Ok(())
}
}
impl<'a, W: Write + Seek> Drop for Writer<'a, W> {
fn drop(&mut self) {
self.finish().unwrap()
}
}
enum Compressor<W: Write> {
Null(W),
Zstd(zstd::Encoder<'static, W>),
Lz4(lz4::Encoder<W>),
}
impl<W: Write> Compressor<W> {
fn finish(self) -> io::Result<W> {
Ok(match self {
Compressor::Null(w) => w,
Compressor::Zstd(w) => w.finish()?,
Compressor::Lz4(w) => {
let (w, err) = w.finish();
err?;
w
}
})
}
}
impl<W: Write> Write for Compressor<W> {
fn write(&mut self, buf: &[u8]) -> io::Result<usize> {
match self {
Compressor::Null(w) => w.write(buf),
Compressor::Zstd(w) => w.write(buf),
Compressor::Lz4(w) => w.write(buf),
}
}
fn flush(&mut self) -> io::Result<()> {
match self {
Compressor::Null(w) => w.flush(),
Compressor::Zstd(w) => w.flush(),
Compressor::Lz4(w) => w.flush(),
}
}
}
struct ChunkWriter<W: Write> {
header_start: u64,
stream_start: u64,
header: records::ChunkHeader,
compressor: CountingCrcWriter<Compressor<W>>,
indexes: BTreeMap<u16, Vec<records::MessageIndexEntry>>,
}
impl<W: Write + Seek> ChunkWriter<W> {
fn new(mut writer: W, compression: Option<Compression>) -> McapResult<Self> {
let header_start = writer.stream_position()?;
op_and_len(&mut writer, op::CHUNK, !0)?;
let compression_name = match compression {
Some(Compression::Zstd) => "zstd",
Some(Compression::Lz4) => "lz4",
None => "",
};
let header = records::ChunkHeader {
message_start_time: 0,
message_end_time: 0,
uncompressed_size: !0,
uncompressed_crc: !0,
compression: String::from(compression_name),
compressed_size: !0,
};
writer.write_le(&header)?;
let stream_start = writer.stream_position()?;
let compressor = match compression {
Some(Compression::Zstd) => {
let mut enc = zstd::Encoder::new(writer, 0)?;
enc.multithread(num_cpus::get_physical() as u32)?;
Compressor::Zstd(enc)
}
Some(Compression::Lz4) => {
let b = lz4::EncoderBuilder::new();
Compressor::Lz4(b.build(writer)?)
}
None => Compressor::Null(writer),
};
let compressor = CountingCrcWriter::new(compressor);
Ok(Self {
compressor,
header_start,
stream_start,
header,
indexes: BTreeMap::new(),
})
}
fn write_schema(&mut self, id: u16, schema: &Schema) -> McapResult<()> {
let header = records::SchemaHeader {
id,
name: schema.name.clone(),
encoding: schema.encoding.clone(),
};
write_record(
&mut self.compressor,
&Record::Schema {
header,
data: Cow::Borrowed(&schema.data),
},
)?;
Ok(())
}
fn write_channel(&mut self, id: u16, schema_id: u16, chan: &Channel) -> McapResult<()> {
assert_eq!(schema_id == 0, chan.schema.is_none());
let rec = records::Channel {
id,
schema_id,
topic: chan.topic.clone(),
message_encoding: chan.message_encoding.clone(),
metadata: chan.metadata.clone(),
};
write_record(&mut self.compressor, &Record::Channel(rec))?;
Ok(())
}
fn write_message(&mut self, header: &MessageHeader, data: &[u8]) -> McapResult<()> {
self.header.message_start_time = match self.header.message_start_time {
0 => header.log_time,
nz => nz.min(header.log_time),
};
self.header.message_end_time = match self.header.message_end_time {
0 => header.log_time,
nz => nz.max(header.log_time),
};
self.indexes
.entry(header.channel_id)
.or_default()
.push(records::MessageIndexEntry {
log_time: header.log_time,
offset: self.compressor.position(),
});
write_record(
&mut self.compressor,
&Record::Message {
header: *header,
data: Cow::Borrowed(data),
},
)?;
Ok(())
}
fn finish(mut self) -> McapResult<(W, records::ChunkIndex)> {
self.header.uncompressed_size = self.compressor.position();
let (stream, crc) = self.compressor.finalize();
self.header.uncompressed_crc = crc;
let mut writer = stream.finish()?;
let end_of_stream = writer.stream_position()?;
self.header.compressed_size = end_of_stream - self.stream_start;
let record_size = (end_of_stream - self.header_start) as usize - 9; writer.seek(SeekFrom::Start(self.header_start))?;
op_and_len(&mut writer, op::CHUNK, record_size)?;
writer.write_le(&self.header)?;
assert_eq!(self.stream_start, writer.stream_position()?);
assert_eq!(writer.seek(SeekFrom::End(0))?, end_of_stream);
let mut message_index_offsets: BTreeMap<u16, u64> = BTreeMap::new();
let mut index_buf = Vec::new();
for (channel_id, records) in self.indexes {
assert!(message_index_offsets
.insert(channel_id, writer.stream_position()?)
.is_none());
index_buf.clear();
let index = records::MessageIndex {
channel_id,
records,
};
Cursor::new(&mut index_buf).write_le(&index)?;
op_and_len(&mut writer, op::MESSAGE_INDEX, index_buf.len())?;
writer.write_all(&index_buf)?;
}
let end_of_indexes = writer.stream_position()?;
let index = records::ChunkIndex {
message_start_time: self.header.message_start_time,
message_end_time: self.header.message_end_time,
chunk_start_offset: self.header_start,
chunk_length: end_of_stream - self.header_start,
message_index_offsets,
message_index_length: end_of_indexes - end_of_stream,
compression: self.header.compression,
compressed_size: self.header.compressed_size,
uncompressed_size: self.header.uncompressed_size,
};
Ok((writer, index))
}
}