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
use std::path::Path;

use super::*;
use ::serde::{de::DeserializeOwned, Deserialize, Serialize};

// ----------------------------------------------------------------------------
// Serde Error type

/// Error type for serialization and deserialization.
#[derive(Debug)]
pub enum SerdeError {
    /// Failed to deserialize the data via rmp-serde.
    SerializationFailed,
    /// Failed to deserialize or deserialize the data via rmp-serde.
    DeserializationFailed,
    /// Failed to read or write the file.
    IoError(std::io::Error),
}

impl From<std::io::Error> for SerdeError {
    fn from(e: std::io::Error) -> Self {
        SerdeError::IoError(e)
    }
}

impl From<rmp_serde::encode::Error> for SerdeError {
    fn from(_: rmp_serde::encode::Error) -> Self {
        SerdeError::SerializationFailed
    }
}

impl From<rmp_serde::decode::Error> for SerdeError {
    fn from(_: rmp_serde::decode::Error) -> Self {
        SerdeError::DeserializationFailed
    }
}

// ----------------------------------------------------------------------------
// Serialization structs

/// Serialize signed distance fields struct.
#[derive(Serialize)]
#[serde(bound = "V: Serialize + DeserializeOwned")]
pub enum SerializeSdf<'a, V: Point> {
    /// Serialize a generic signed distance fields computed with `generate_sdf`.
    Generic(SerializeGeneric<'a, V>),
    /// Serialize a grid signed distance fields computed with `generate_grid_sdf`.
    Grid(SerializeGrid<'a, V>),
}

/// Serialize a generic signed distance fields computed with `generate_sdf`.
/// Should be used with `SerializeSdf::Generic`.
#[derive(Serialize)]
#[serde(bound = "V: Serialize + DeserializeOwned")]
pub struct SerializeGeneric<'a, V: Point> {
    /// Query points used to generate the signed distance field.
    pub query_points: &'a [V],
    /// Computed distances to the query points.
    pub distances: &'a [f32],
}

/// Serialize a grid signed distance fields computed with `generate_grid_sdf`.
/// Should be used with `SerializeSdf::Grid`.
#[derive(Serialize)]
#[serde(bound = "V: Serialize + DeserializeOwned")]
pub struct SerializeGrid<'a, V: Point> {
    /// Grid used to generate the signed distance field.
    pub grid: &'a Grid<V>,
    /// Computed distances to the grid cells.
    pub distances: &'a [f32],
}

/// Version of the serialization format.
/// This is used to ensure backward compatibility when deserializing.
#[derive(Serialize)]
#[serde(bound = "V: Serialize + DeserializeOwned")]
enum SerializeVersion<'a, V: Point> {
    V1(&'a SerializeSdf<'a, V>),
}

// ----------------------------------------------------------------------------
// Deserialization structs

/// Deserialize signed distance fields struct.
#[derive(Deserialize)]
#[serde(bound = "V: Serialize + DeserializeOwned")]
pub enum DeserializeSdf<V: Point> {
    /// Deserialized generic signed distance fields computed with `generate_sdf`.
    Generic(DeserializeGeneric<V>),
    /// Deserialized grid signed distance fields computed with `generate_grid_sdf`.
    Grid(DeserializeGrid<V>),
}

/// Deserializd generic signed distance fields computed with `generate_sdf`.
/// Should be used with `DeserializeSdf::Generic`.
#[derive(Deserialize)]
#[serde(bound = "V: Serialize + DeserializeOwned")]
pub struct DeserializeGeneric<V: Point> {
    /// Query points used to generate the signed distance field.
    pub query_points: Vec<V>,
    /// Computed distances to the query points.
    pub distances: Vec<f32>,
}

/// Deserialized grid signed distance fields computed with `generate_grid_sdf`.
/// Should be used with `DeserializeSdf::Grid`.
#[derive(Deserialize)]
#[serde(bound = "V: Serialize + DeserializeOwned")]
pub struct DeserializeGrid<V: Point> {
    /// Grid used to generate the signed distance field.
    pub grid: Grid<V>,
    /// Computed distances to the grid cells.
    pub distances: Vec<f32>,
}

/// Version of the deserialization format.
/// This is used to ensure backward compatibility when deserializing.
#[derive(Deserialize)]
#[serde(bound = "V: Serialize + DeserializeOwned")]
enum DeserializeVersion<V: Point> {
    V1(DeserializeSdf<V>),
}

// ----------------------------------------------------------------------------
// Functions

/// Serialize a signed distance fields struct to a byte array.
fn serialize<V: Point + Serialize + DeserializeOwned>(
    sdf: &SerializeSdf<V>,
) -> Result<Vec<u8>, rmp_serde::encode::Error> {
    // Serialize using the latest version
    rmp_serde::to_vec(&SerializeVersion::V1(sdf))
}

/// Deserialize a byte array to a signed distance fields struct.
fn deserialize<V: Point + Serialize + DeserializeOwned>(
    data: &[u8],
) -> Result<DeserializeSdf<V>, SerdeError> {
    let versioned_sdf: DeserializeVersion<V> = rmp_serde::from_slice(data)?;
    Ok(match versioned_sdf {
        DeserializeVersion::V1(sdf) => sdf,
    })
}

/// Save a signed distance fields struct to a file.
///
/// ```no_run
/// use mesh_to_sdf::*;
/// let query_points = [cgmath::Vector3::new(0., 0., 0.)];
/// let distances = [1.];
/// let ser = SerializeSdf::Generic(SerializeGeneric {
///     query_points: &query_points,
///     distances: &distances,
/// });
/// let path = "path/to/sdf.bin";
/// save_to_file(&ser, path).expect("Failed to save sdf");
/// ```
pub fn save_to_file<V: Point + Serialize + DeserializeOwned, P: AsRef<Path>>(
    sdf: &SerializeSdf<V>,
    path: P,
) -> Result<(), SerdeError> {
    std::fs::write(path, serialize(sdf)?)?;
    Ok(())
}

/// Read a signed distance fields struct from a file.
/// You need to make sure the Point type is the same as the one used to serialize the data.
///
/// ```no_run
/// use mesh_to_sdf::*;
/// let path = "path/to/sdf.bin";
/// let deserialized = read_from_file::<cgmath::Vector3<f32>, _>(path).expect("Failed to read sdf");
/// match deserialized {
///     DeserializeSdf::Generic(DeserializeGeneric { query_points, distances }) => {
///         // ...
///     },
///     DeserializeSdf::Grid(DeserializeGrid { grid, distances }) => {
///         // ...
///     },
/// }
/// ```
pub fn read_from_file<V: Point + Serialize + DeserializeOwned, P: AsRef<Path>>(
    path: P,
) -> Result<DeserializeSdf<V>, SerdeError> {
    deserialize(&std::fs::read(path)?)
}

// ----------------------------------------------------------------------------
// Tests

#[cfg(test)]
mod tests {
    use super::*;

    use tempfile::*;

    #[test]
    fn test_serde() -> Result<(), SerdeError> {
        let queries = [
            cgmath::Vector3::new(1., 2., 3.),
            cgmath::Vector3::new(6., 5., 4.),
        ];
        let distances = [1.0, 3.0];
        let ser = SerializeSdf::Generic(SerializeGeneric {
            query_points: &queries,
            distances: &distances,
        });

        let data = serialize(&ser)?;
        let de: DeserializeSdf<cgmath::Vector3<f32>> = deserialize(&data)?;

        match (&ser, &de) {
            (SerializeSdf::Generic(ser), DeserializeSdf::Generic(de)) => {
                assert_eq!(ser.query_points, &de.query_points);
                assert_eq!(ser.distances, de.distances);
            }
            _ => panic!("Mismatch"),
        }

        Ok(())
    }

    #[test]
    fn test_serde_grid() -> Result<(), SerdeError> {
        let grid = Grid::new([1.0, 2.0, 3.0], [4.0, 5.0, 6.0], [7, 8, 9]);
        let distances = (0..grid.get_total_cell_count())
            .map(|i| i as f32)
            .collect::<Vec<_>>();

        let ser = SerializeSdf::Grid(SerializeGrid {
            grid: &grid,
            distances: &distances,
        });

        let data = serialize(&ser)?;
        let de: DeserializeSdf<[f32; 3]> = deserialize(&data)?;

        match (&ser, &de) {
            (SerializeSdf::Grid(ser), DeserializeSdf::Grid(de)) => {
                assert_eq!(ser.grid, &de.grid);
                assert_eq!(ser.distances, de.distances);
            }
            _ => panic!("Mismatch"),
        }

        Ok(())
    }

    #[test]
    fn test_serde_file() -> Result<(), SerdeError> {
        let dir = tempdir()?;
        let file_path = dir.path().join("sdf.bin");

        let queries = [
            cgmath::Vector3::new(1., 2., 3.),
            cgmath::Vector3::new(6., 5., 4.),
        ];
        let distances = [1.0, 3.0];
        let ser = SerializeSdf::Generic(SerializeGeneric {
            query_points: &queries,
            distances: &distances,
        });

        save_to_file(&ser, &file_path)?;

        let de: DeserializeSdf<cgmath::Vector3<f32>> = read_from_file(&file_path)?;

        match (&ser, &de) {
            (SerializeSdf::Generic(ser), DeserializeSdf::Generic(de)) => {
                assert_eq!(ser.query_points, &de.query_points);
                assert_eq!(ser.distances, de.distances);
            }
            _ => panic!("Mismatch"),
        }

        Ok(())
    }

    #[test]
    fn test_backward_compatibility_serde_generic_v1() -> Result<(), SerdeError> {
        let queries = [
            cgmath::Vector3::new(1., 2., 3.),
            cgmath::Vector3::new(6., 5., 4.),
        ];
        let distances = [1.0, 3.0];
        let ser = SerializeSdf::Generic(SerializeGeneric {
            query_points: &queries,
            distances: &distances,
        });

        let path = "tests/sdf_generic_v1.bin";

        // This was done with the version V1 of the serialization format
        // save_to_file(&ser, path);

        // Now we make sure we can read it with the current version
        let de: DeserializeSdf<cgmath::Vector3<f32>> = read_from_file(path)?;

        match (&ser, &de) {
            (SerializeSdf::Generic(ser), DeserializeSdf::Generic(de)) => {
                assert_eq!(ser.query_points, &de.query_points);
                assert_eq!(ser.distances, de.distances);
            }
            _ => panic!("Mismatch"),
        }

        Ok(())
    }

    #[test]
    fn test_backward_compatibility_serde_grid_v1() -> Result<(), SerdeError> {
        let grid = Grid::new([1.0, 2.0, 3.0], [4.0, 5.0, 6.0], [7, 8, 9]);
        let distances = (0..grid.get_total_cell_count())
            .map(|i| i as f32)
            .collect::<Vec<_>>();

        let ser = SerializeSdf::Grid(SerializeGrid {
            grid: &grid,
            distances: &distances,
        });

        let path = "tests/sdf_grid_v1.bin";

        // This was done with the version V1 of the serialization format
        // save_to_file(&ser, path)?;

        // Now we make sure we can read it with the current version
        let de: DeserializeSdf<[f32; 3]> = read_from_file(path)?;

        match (&ser, &de) {
            (SerializeSdf::Grid(ser), DeserializeSdf::Grid(de)) => {
                assert_eq!(ser.grid, &de.grid);
                assert_eq!(ser.distances, de.distances);
            }
            _ => panic!("Mismatch"),
        }

        Ok(())
    }
}