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
#![doc(
html_logo_url = "https://cdn.rawgit.com/urschrei/rdp/6c84264fd9cdc0b8fdf974fc98e51fea4834ed05/rdp.svg",
html_root_url = "https://docs.rs/rdp"
)]
//! This crate provides FFI functions for accessing the Ramer–Douglas–Peucker and Visvalingam-Whyatt line simplification algorithms
use std::slice;
use std::{f64, ptr};
use self::geo::simplify::{Simplify, SimplifyIdx};
use self::geo::simplify_vw::{SimplifyVw, SimplifyVwIdx, SimplifyVwPreserve};
use self::geo::LineString;
use geo::{self, CoordFloat};
/// A C-compatible `struct` originating **outside** Rust
/// used for passing arrays across the FFI boundary
#[repr(C)]
pub struct ExternalArray {
pub data: *const libc::c_void,
pub len: libc::size_t,
}
/// A C-compatible `struct` originating **inside** Rust
/// used for passing arrays across the FFI boundary
#[repr(C)]
pub struct InternalArray {
pub data: *mut libc::c_void,
pub len: libc::size_t,
}
// Build an InternalArray from a LineString, so it can be leaked across the FFI boundary
impl<T> From<LineString<T>> for InternalArray
where
T: CoordFloat,
{
fn from(sl: LineString<T>) -> Self {
let v: Vec<[T; 2]> = sl.0.iter().map(|p| [p.x, p.y]).collect();
let boxed = v.into_boxed_slice();
let blen = boxed.len();
let rawp = Box::into_raw(boxed);
InternalArray {
data: rawp as *mut libc::c_void,
len: blen as libc::size_t,
}
}
}
// Build an ExternalArray from a LineString, so it can be leaked across the FFI boundary
impl<T> From<LineString<T>> for ExternalArray
where
T: CoordFloat,
{
fn from(sl: LineString<T>) -> Self {
let v: Vec<[T; 2]> = sl.0.iter().map(|p| [p.x, p.y]).collect();
let boxed = v.into_boxed_slice();
let blen = boxed.len();
let rawp = Box::into_raw(boxed);
ExternalArray {
data: rawp as *mut libc::c_void,
len: blen as libc::size_t,
}
}
}
// Build an InternalArray from a vec of usize, so it can be leaked across the FFI boundary
impl From<Vec<usize>> for InternalArray {
fn from(v: Vec<usize>) -> Self {
let boxed = v.into_boxed_slice();
let blen = boxed.len();
let rawp = Box::into_raw(boxed);
InternalArray {
data: rawp as *mut libc::c_void,
len: blen as libc::size_t,
}
}
}
// Build a LineString from an ExternalArray
impl From<ExternalArray> for LineString<f64> {
fn from(arr: ExternalArray) -> Self {
// we need to take ownership of this data, so slice -> vec
unsafe {
let v = slice::from_raw_parts(arr.data as *mut [f64; 2], arr.len).to_vec();
v.into()
}
}
}
// Build a LineString from an InternalArray
// Ideally this would be a LineString, but local types blah blah
impl From<InternalArray> for LineString<f64> {
fn from(arr: InternalArray) -> Self {
// we originated this data, so pointer-to-slice -> box -> vec
unsafe {
let p = ptr::slice_from_raw_parts_mut(arr.data as *mut [f64; 2], arr.len);
let v = Box::from_raw(p).to_vec();
v.into()
}
}
}
// Build a Vec of usize from an ExternalArray
impl From<ExternalArray> for Vec<usize> {
fn from(arr: ExternalArray) -> Self {
// we need to take ownership of this data, so slice -> vec
unsafe { slice::from_raw_parts(arr.data as *mut usize, arr.len).to_vec() }
}
}
// Build a Vec of usize from an InternalArray
impl From<InternalArray> for Vec<usize> {
fn from(arr: InternalArray) -> Self {
// we originated this data, so pointer-to-slice -> box -> vec
unsafe {
let p = ptr::slice_from_raw_parts_mut(arr.data as *mut usize, arr.len);
Box::from_raw(p).to_vec()
}
}
}
/// FFI wrapper for RDP, returning simplified geometry **coordinates**
///
/// Callers must pass two arguments:
///
/// - a [Struct](struct.Array.html) with two fields:
/// - `data`, a void pointer to an array of floating-point point coordinates: `[[1.0, 2.0], ...]`
/// - `len`, the length of the array being passed. Its type must be `size_t`
/// - a double-precision `float` for the tolerance
///
/// Implementations calling this function **must** call [`drop_float_array`](fn.drop_float_array.html)
/// with the returned `Array` pointer, in order to free the memory it allocates.
///
/// # Safety
///
/// This function is unsafe because it accesses a raw pointer which could contain arbitrary data
#[no_mangle]
pub extern "C" fn simplify_rdp_ffi(
coords: ExternalArray,
precision: libc::c_double,
) -> InternalArray {
let ls: LineString<_> = coords.into();
ls.simplify(&precision).into()
}
/// FFI wrapper for RDP, returning simplified geometry **indices**
///
/// Callers must pass two arguments:
///
/// - a [Struct](struct.Array.html) with two fields:
/// - `data`, a void pointer to an array of floating-point point coordinates: `[[1.0, 2.0], ...]`
/// - `len`, the length of the array being passed. Its type must be `size_t`
/// - a double-precision `float` for the tolerance
///
/// Implementations calling this function **must** call [`drop_usize_array`](fn.drop_usize_array.html)
/// with the returned `Array` pointer, in order to free the memory it allocates.
///
/// # Safety
///
/// This function is unsafe because it accesses a raw pointer which could contain arbitrary data
#[no_mangle]
pub extern "C" fn simplify_rdp_idx_ffi(
coords: ExternalArray,
precision: libc::c_double,
) -> InternalArray {
let ls: LineString<_> = coords.into();
ls.simplify_idx(&precision).into()
}
/// FFI wrapper for Visvalingam-Whyatt, returning simplified geometry **coordinates**
///
/// Callers must pass two arguments:
///
/// - a [Struct](struct.Array.html) with two fields:
/// - `data`, a void pointer to an array of floating-point point coordinates: `[[1.0, 2.0], ...]`
/// - `len`, the length of the array being passed. Its type must be `size_t`
/// - a double-precision `float` for the epsilon
///
/// Implementations calling this function **must** call [`drop_float_array`](fn.drop_float_array.html)
/// with the returned `Array` pointer, in order to free the memory it allocates.
///
/// # Safety
///
/// This function is unsafe because it accesses a raw pointer which could contain arbitrary data
#[no_mangle]
pub extern "C" fn simplify_visvalingam_ffi(
coords: ExternalArray,
precision: libc::c_double,
) -> InternalArray {
let ls: LineString<_> = coords.into();
ls.simplify_vw(&precision).into()
}
/// FFI wrapper for Visvalingam-Whyatt, returning simplified geometry **indices**
///
/// Callers must pass two arguments:
///
/// - a [Struct](struct.Array.html) with two fields:
/// - `data`, a void pointer to an array of floating-point point coordinates: `[[1.0, 2.0], ...]`
/// - `len`, the length of the array being passed. Its type must be `size_t`
/// - a double-precision `float` for the epsilon
///
/// Implementations calling this function **must** call [`drop_usize_array`](fn.drop_usize_array.html)
/// with the returned `Array` pointer, in order to free the memory it allocates.
///
/// # Safety
///
/// This function is unsafe because it accesses a raw pointer which could contain arbitrary data
#[no_mangle]
pub extern "C" fn simplify_visvalingam_idx_ffi(
coords: ExternalArray,
precision: libc::c_double,
) -> InternalArray {
let ls: LineString<_> = coords.into();
ls.simplify_vw_idx(&precision).into()
}
/// FFI wrapper for topology-preserving Visvalingam-Whyatt, returning simplified geometry **coordinates**.
///
/// Callers must pass two arguments:
///
/// - a [Struct](struct.Array.html) with two fields:
/// - `data`, a void pointer to an array of floating-point point coordinates: `[[1.0, 2.0], ...]`
/// - `len`, the length of the array being passed. Its type must be `size_t`
/// - a double-precision `float` for the epsilon
///
/// Implementations calling this function **must** call [`drop_float_array`](fn.drop_float_array.html)
/// with the returned `Array` pointer, in order to free the memory it allocates.
///
/// # Safety
///
/// This function is unsafe because it accesses a raw pointer which could contain arbitrary data
#[no_mangle]
pub extern "C" fn simplify_visvalingamp_ffi(
coords: ExternalArray,
precision: libc::c_double,
) -> InternalArray {
let ls: LineString<_> = coords.into();
ls.simplify_vw_preserve(&precision).into()
}
/// Free memory which has been allocated across the FFI boundary by:
/// - simplify_rdp_ffi
/// - simplify_visvalingam_ffi
/// - simplify_visvalingamp_ffi
///
/// # Safety
///
/// This function is unsafe because it accesses a raw pointer which could contain arbitrary data
#[no_mangle]
pub extern "C" fn drop_float_array(arr: InternalArray) {
if arr.data.is_null() {
return;
}
unsafe {
let p = ptr::slice_from_raw_parts_mut(arr.data as *mut [f64; 2], arr.len);
drop(Box::from_raw(p));
};
}
/// Free memory which has been allocated across the FFI boundary by:
/// - simplify_rdp_idx_ffi
/// - simplify_visvalingam_idx_ffi
///
/// # Safety
///
/// This function is unsafe because it accesses a raw pointer which could contain arbitrary data
#[no_mangle]
pub extern "C" fn drop_usize_array(arr: InternalArray) {
if arr.data.is_null() {
return;
}
unsafe {
let p = ptr::slice_from_raw_parts_mut(arr.data as *mut usize, arr.len);
drop(Box::from_raw(p));
};
}
#[cfg(test)]
mod tests {
use super::*;
use geo::{LineString, Point};
use std::ptr;
#[test]
fn test_linestring_to_array() {
let ls: LineString<_> = vec![Point::new(1.0, 2.0), Point::new(3.0, 4.0)].into();
let _: InternalArray = ls.into();
}
#[test]
fn test_array_conversion() {
let original = vec![
[0.0, 0.0],
[5.0, 4.0],
[11.0, 5.5],
[17.3, 3.2],
[27.8, 0.1],
];
let ls: LineString<_> = original.clone().into();
// move into an Array, and leak it
let arr: InternalArray = ls.into();
// move back into a Vec -- leaked value still needs to be dropped
let converted: LineString<_> = arr.into();
assert_eq!(converted, original.into());
// drop it
drop_float_array(converted.into());
}
#[test]
fn test_ffi_rdp_simplification() {
let input = vec![
[0.0, 0.0],
[5.0, 4.0],
[11.0, 5.5],
[17.3, 3.2],
[27.8, 0.1],
];
let ls: LineString<_> = input.into();
let output = vec![[0.0, 0.0], [5.0, 4.0], [11.0, 5.5], [27.8, 0.1]];
let transformed: LineString<_> = simplify_rdp_ffi(ls.into(), 1.0).into();
assert_eq!(transformed, output.into());
}
#[test]
fn test_ffi_rdp_idx_simplification() {
let input = vec![
[0.0, 0.0],
[5.0, 4.0],
[11.0, 5.5],
[17.3, 3.2],
[27.8, 0.1],
];
let ls: LineString<_> = input.into();
// let output = vec![[0.0, 0.0], [5.0, 4.0], [11.0, 5.5], [27.8, 0.1]];
let output = vec![0, 1, 2, 4];
let transformed: Vec<usize> = simplify_rdp_idx_ffi(ls.into(), 1.0).into();
assert_eq!(transformed, output);
}
#[test]
fn test_ffi_visvalingam_simplification() {
let input = vec![
[5.0, 2.0],
[3.0, 8.0],
[6.0, 20.0],
[7.0, 25.0],
[10.0, 10.0],
];
let ls: LineString<_> = input.into();
let output = vec![[5.0, 2.0], [7.0, 25.0], [10.0, 10.0]];
let transformed: LineString<_> = simplify_visvalingam_ffi(ls.into(), 30.0).into();
assert_eq!(transformed, output.into());
}
#[test]
fn test_ffi_visvalingam_idx_simplification() {
let input = vec![
[5.0, 2.0],
[3.0, 8.0],
[6.0, 20.0],
[7.0, 25.0],
[10.0, 10.0],
];
let ls: LineString<_> = input.into();
// let output = vec![[5.0, 2.0], [7.0, 25.0], [10.0, 10.0]];
let output = vec![0, 3, 4];
let transformed: Vec<usize> = simplify_visvalingam_idx_ffi(ls.into(), 30.0).into();
assert_eq!(transformed, output);
}
#[test]
fn test_ffi_visvalingamp_simplification() {
let input = vec![
[5.0, 2.0],
[3.0, 8.0],
[6.0, 20.0],
[7.0, 25.0],
[10.0, 10.0],
];
let ls: LineString<_> = input.into();
let output = vec![[5.0, 2.0], [7.0, 25.0], [10.0, 10.0]];
let transformed: LineString<_> = simplify_visvalingamp_ffi(ls.into(), 30.0).into();
assert_eq!(transformed, output.into());
}
#[test]
fn test_drop_empty_float_array() {
let original = vec![[1.0, 2.0], [3.0, 4.0]];
let ls: LineString<_> = original.into();
// move into an Array, and leak it
let mut arr: InternalArray = ls.into();
// zero Array contents
arr.data = ptr::null_mut();
drop_float_array(arr);
}
}