tmf 0.2.1

TMF is a 3D model compression format achieving compression ratio of between 4.2 and 1.95, while being very fast to read and having no visual difference between compressed and uncompressed models.
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
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
use crate::read_extension::ReadExt;
use crate::tmf::CompressionType;
use crate::tmf::{DecodedSegment, EncodedSegment, SectionType};
use crate::unaligned_rw::UnalignedRWMode;
use crate::unaligned_rw::UnalignedReader;
use crate::CustomDataSegment;
use crate::IndexType;
use crate::MAX_SEG_SIZE;
use crate::{TMFImportError, TMFMesh, TMF_MAJOR, TMF_MINOR};
use futures::future::join_all;
use std::io::Read;
#[derive(Clone, Copy)]
pub(crate) enum SegLenWidth {
    U32,
    U64,
}
impl SegLenWidth {
    fn from_header(header: &TMFHeader) -> Self {
        if header.min_minor > 1 {
            Self::U32
        } else {
            Self::U64
        }
    }
    pub(crate) fn read<R: Read>(&self, src: &mut R) -> std::io::Result<usize> {
        Ok(match self {
            Self::U32 => src.read_u32()? as usize,
            Self::U64 => src.read_u64()? as usize,
        })
    }
}
#[derive(Clone, Copy)]
pub(crate) enum SegTypeWidth {
    U16,
    U8,
}
impl SegTypeWidth {
    fn from_header(header: &TMFHeader) -> Self {
        if header.min_minor > 1 {
            Self::U8
        } else {
            Self::U16
        }
    }
    pub(crate) fn read<R: Read>(&self, src: &mut R) -> std::io::Result<SectionType> {
        Ok(match self {
            Self::U8 => SectionType::from_u8(src.read_u8()?),
            Self::U16 => SectionType::from_u16(src.read_u16()?),
        })
    }
}
#[derive(Clone)]
pub(crate) struct TMFImportContext {
    segment_length_width: SegLenWidth,
    segment_type_width: SegTypeWidth,
    should_read_min_index: bool,
}
// While some of those fileds are not read yet, they may be relevant in the future.
#[allow(dead_code)]
struct TMFHeader {
    major: u16,
    minor: u16,
    min_major: u16,
    min_minor: u16,
}
pub(crate) fn read_string<R: Read>(src: &mut R) -> std::io::Result<String> {
    let byte_len = src.read_u16()?;
    let mut bytes = vec![0; byte_len as usize];
    src.read_exact(&mut bytes)?;
    match std::str::from_utf8(&bytes) {
        Ok(string) => Ok(string.to_owned()),
        Err(_) => Err(std::io::Error::new(
            std::io::ErrorKind::Other,
            "Mesh name not valid UTF-8",
        )),
    }
}
async fn read_tmf_header<R: Read>(src: &mut R) -> Result<TMFHeader, TMFImportError> {
    let mut magic = [0; 3];
    src.read_exact(&mut magic)?;
    if magic != *b"TMF" {
        return Err(TMFImportError::NotTMFFile);
    }
    let major = src.read_u16()?;
    let minor = src.read_u16()?;
    // Minimum version of reader required to read
    let min_major = src.read_u16()?;
    let min_minor = src.read_u16()?;

    if min_major > TMF_MAJOR || (min_major == TMF_MAJOR && min_minor > TMF_MINOR) {
        Err(TMFImportError::NewerVersionRequired)
    } else {
        Ok(TMFHeader {
            major,
            minor,
            min_major,
            min_minor,
        })
    }
}
impl TMFImportContext {
    pub(crate) fn segment_type_width(&self) -> &SegTypeWidth {
        &self.segment_type_width
    }
    pub(crate) fn segment_length_width(&self) -> &SegLenWidth {
        &self.segment_length_width
    }
    pub(crate) fn read_traingle_min<R: Read>(&self, src: &mut R) -> std::io::Result<u64> {
        if self.should_read_min_index {
            src.read_u64()
        } else {
            Ok(0)
        }
    }
    fn init_header(hdr: TMFHeader) -> Self {
        Self {
            segment_length_width: SegLenWidth::from_header(&hdr),
            segment_type_width: SegTypeWidth::from_header(&hdr),
            should_read_min_index: (hdr.min_minor > 1),
        }
    }
    async fn import_mesh<R: Read>(
        &self,
        mut src: R,
        ctx: &Self,
    ) -> Result<(TMFMesh, String), TMFImportError> {
        let name = read_string(&mut src)?;
        let segment_count = src.read_u16()?;
        //self.segment_length_width.read(&mut src)?;
        let mut decoded_segs = Vec::with_capacity(segment_count as usize);
        for _ in 0..segment_count {
            let encoded = EncodedSegment::read(self, &mut src)?;
            //println!("encoded_type:{:?}",encoded.seg_type());
            let ctx = ctx.clone();
            let decoded = async move { DecodedSegment::decode(encoded, &ctx).await };

            #[cfg(feature = "tokio_runtime")]
            let decoded = { tokio::task::spawn(decoded) };

            decoded_segs.push(decoded);
        }
        let mut res = TMFMesh::empty();
        let joined = join_all(decoded_segs).await;
        #[cfg(feature = "tokio_runtime")]
        let joined = { joined.into_iter().collect::<Result<Vec<_>, _>>().unwrap() };
        joined
            .into_iter()
            .collect::<Result<Vec<_>, _>>()?
            .iter()
            .for_each(|seg| {
                seg.apply(&mut res);
            });
        Ok((res, name))
    }
    async fn analize_mesh<R: Read>(&self, mut src: R, _ctx: &Self) -> Result<(), TMFImportError> {
        let name = read_string(&mut src)?;
        println!("############################\nMesh {name}:");
        let segment_count = src.read_u16()?;
        let mut results = [0; 256];
        for _ in 0..segment_count {
            let encoded = EncodedSegment::read(self, &mut src)?;
            results[encoded.seg_type() as u8 as usize] += encoded.data().len();
        }
        let mut res = Vec::new();
        let mut total = 0;
        for (index, result) in results.iter().enumerate() {
            let byte_len = *result;
            total += byte_len;
            if byte_len != 0 {
                res.push((format!("{:?}", SectionType::from_u8(index as u8)), byte_len));
            }
        }
        res.sort_by(|a, b| a.1.cmp(&b.1));
        println!("res:{res:?}, total_len:{total}");
        Ok(())
    }
    pub(crate) async fn import<R: Read>(
        mut src: R,
    ) -> Result<Vec<(TMFMesh, String)>, TMFImportError> {
        let header = read_tmf_header(&mut src).await?;
        let res = Self::init_header(header);
        let mesh_count = src.read_u32()?;
        let mut meshes = Vec::with_capacity((u16::MAX as usize).min(mesh_count as usize));
        for _ in 0..mesh_count {
            meshes.push(res.import_mesh(&mut src, &res).await?);
        }
        Ok(meshes)
    }
    #[allow(dead_code)]
    pub(crate) async fn analize<R: Read>(mut src: R) -> Result<(), TMFImportError> {
        let header = read_tmf_header(&mut src).await?;
        let res = Self::init_header(header);
        let mesh_count = src.read_u32()?;
        for _ in 0..mesh_count {
            res.analize_mesh(&mut src, &res).await?;
        }
        Ok(())
    }
}
pub(crate) fn import_sync<R: std::io::Read>(
    src: R,
) -> Result<Vec<(TMFMesh, String)>, TMFImportError> {
    runtime_agnostic_block_on!(TMFImportContext::import(src))
}
pub(crate) async fn decode_vertex_seg(
    seg: EncodedSegment,
) -> Result<DecodedSegment, TMFImportError> {
    if SectionType::VertexSegment == seg.seg_type() {
        let mut data: &[u8] = seg.data();
        Ok(DecodedSegment::AppendVertex(
            crate::vertices::read_tmf_vertices(&mut data)?,
        ))
    } else {
        panic!("Unreachable condition reached!");
    }
}
pub(crate) async fn decode_uv_seg(seg: EncodedSegment) -> Result<DecodedSegment, TMFImportError> {
    if SectionType::UvSegment == seg.seg_type() {
        let mut data: &[u8] = seg.data();
        Ok(DecodedSegment::AppendUV(crate::uv::read_uvs(&mut data)?))
    } else {
        panic!("Unreachable condition reached!");
    }
}
pub(crate) async fn decode_normal_seg(
    seg: EncodedSegment,
) -> Result<DecodedSegment, TMFImportError> {
    if SectionType::NormalSegment == seg.seg_type() {
        let mut data: &[u8] = seg.data();
        Ok(DecodedSegment::AppendNormal(
            crate::normals::read_normal_array(&mut data)?,
        ))
    } else {
        panic!("Unreachable condition reached!");
    }
}
pub(crate) async fn decode_custom_seg(
    seg: EncodedSegment,
    ctx: &crate::tmf_importer::TMFImportContext,
) -> Result<DecodedSegment, TMFImportError> {
    if matches!(
        seg.seg_type(),
        SectionType::CustomIndexSegment
            | SectionType::CustomFloatSegment
            | SectionType::CustomIntigerSegment
            | SectionType::CustomColorRGBASegment
    ) {
        let mut data: &[u8] = seg.data();
        Ok(DecodedSegment::AppendCustom(CustomDataSegment::read(
            &mut data,
            seg.seg_type(),
            ctx,
        )?))
    } else {
        panic!("Unreachable condition reached!");
    }
}
pub(crate) fn read_default_triangles<R: std::io::Read>(
    mut src: R,
    data: &mut Vec<IndexType>,
    ctx: &crate::tmf_importer::TMFImportContext,
) -> Result<(), TMFImportError> {
    let precision_bits = src.read_u8()?;
    let length = src.read_u64()?;
    let min = ctx.read_traingle_min(&mut src)?;
    if length > MAX_SEG_SIZE as u64 {
        return Err(TMFImportError::SegmentTooLong);
    }
    data.reserve(length as usize);
    let buf = data.spare_capacity_mut();
    let precision = UnalignedRWMode::precision_bits(precision_bits);
    let mut reader = UnalignedReader::new(src);
    if precision_bits == 0 {
        use std::mem::MaybeUninit;
        buf.fill(MaybeUninit::new(0));
    } else {
        for index in 0..(length as usize) / 2 {
            let (i1, i2) = reader.read2_unaligned(precision)?;
            buf[index * 2].write((i1 + min) as IndexType);
            buf[index * 2 + 1].write((i2 + min) as IndexType);
        }
        if length % 2 != 0 {
            let i = reader.read_unaligned(precision)?;
            buf[(length - 1) as usize].write((i + min) as IndexType);
        }
    }
    unsafe { data.set_len(length as usize) }
    Ok(())
}
#[allow(dead_code)]
fn read_triangle_sequence<R: std::io::Read>(
    _src: R,
    _data: &mut Vec<IndexType>,
) -> Result<(), TMFImportError> {
    todo!();
}
pub(crate) async fn decode_triangle_seg(
    seg: EncodedSegment,
    ctx: &crate::tmf_importer::TMFImportContext,
) -> Result<DecodedSegment, TMFImportError> {
    if seg.seg_type().is_triangle() {
        let data: &[u8] = seg.data();
        let mut indices = Vec::new();
        match seg.compresion_type() {
            CompressionType::None => read_default_triangles(data, &mut indices, ctx)?,
            CompressionType::Sequence => {
                return Err(TMFImportError::UnsuportedCompressionType(
                    CompressionType::Ommited as u8,
                ))
            } //read_triangle_sequence(data, &mut indices)?,
            CompressionType::Ommited => {
                return Err(TMFImportError::UnsuportedCompressionType(
                    CompressionType::Ommited as u8,
                ))
            }
            CompressionType::UnalignedLZZ => {
                return Err(TMFImportError::UnsuportedCompressionType(
                    CompressionType::UnalignedLZZ as u8,
                ))
            }
        };
        Ok(match seg.seg_type() {
            SectionType::VertexTriangleSegment => {
                DecodedSegment::AppendTriangleVertex(indices.into())
            }
            SectionType::NormalTriangleSegment => {
                DecodedSegment::AppendTriangleNormal(indices.into())
            }
            SectionType::UvTriangleSegment => DecodedSegment::AppendTriangleUV(indices.into()),
            SectionType::TangentTriangleSegment => {
                DecodedSegment::AppendTriangleTangent(indices.into())
            }
            _ => panic!("Unsupported section type {:?}", seg.seg_type()),
        })
    } else {
        panic!("Unreachable condition reached!");
    }
}
#[cfg(test)]
fn init_test_env() {
    std::fs::create_dir_all("target/test_res").unwrap();
}
#[cfg(test)]
#[test]
fn test() {
    use crate::TMFPrecisionInfo;
    init_test_env();
    let mut file = std::fs::File::open("testing/susan.obj").unwrap();
    let (tmf_mesh, name) = TMFMesh::read_from_obj_one(&mut file).unwrap();
    tmf_mesh.verify().unwrap();
    assert!(name == "Suzanne", "Name should be Suzanne but is {name}");
    let prec = TMFPrecisionInfo::default();
    let mut out = Vec::new();
    {
        tmf_mesh.write_tmf_one(&mut out, &prec, name).unwrap();
    }
    let _imported = runtime_agnostic_block_on!(TMFImportContext::import(&out[..])).unwrap();
}
#[cfg(test)]
#[test]
fn test_triangles_opt() {
    use crate::tmf_exporter::EncodeInfo;
    use crate::TMFPrecisionInfo;
    let mut tmp = Vec::with_capacity(1_000_000);
    for i in 0..1000 {
        tmp.push(i);
    }
    let tris = DecodedSegment::AppendTriangleVertex(tmp.into());
    let tris = runtime_agnostic_block_on!(tris.optimize());
    let tris: Vec<EncodedSegment> = tris
        .into_iter()
        .map(|seg| {
            runtime_agnostic_block_on!(
                seg.encode(&TMFPrecisionInfo::default(), &EncodeInfo::default())
            )
            .unwrap()
        })
        .collect();
    let ctx = TMFImportContext::init_header(TMFHeader {
        major: crate::TMF_MAJOR,
        minor: crate::TMF_MINOR,
        min_major: crate::MIN_TMF_MAJOR,
        min_minor: crate::MIN_TMF_MINOR,
    });
    let tris: Vec<DecodedSegment> = tris
        .into_iter()
        .map(|seg| {
            let seg: DecodedSegment =
                runtime_agnostic_block_on!(DecodedSegment::decode(seg, &ctx)).unwrap();
            seg
        })
        .collect();
    let mut curr = 0;
    for seg in tris.iter() {
        let values = if let DecodedSegment::AppendTriangleVertex(vals) = seg {
            vals
        } else {
            panic!()
        };
        for value in values.iter() {
            assert_eq!(*value, curr);
            curr += 1;
        }
    }
}