rack 0.4.8

A modern Rust library for hosting audio plugins
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

//! Shared utilities for VST3 FFI interop

use crate::{Error, Result};
use std::ffi::CStr;

use super::ffi;

/// Convert C API error code to Rust Error
///
/// The C API returns negative error codes for errors
pub(crate) fn map_error(code: i32) -> Error {
    match code {
        ffi::RACK_VST3_ERROR_GENERIC => Error::Other("Generic VST3 error".to_string()),
        ffi::RACK_VST3_ERROR_NOT_FOUND => Error::PluginNotFound("VST3 plugin not found".to_string()),
        ffi::RACK_VST3_ERROR_INVALID_PARAM => Error::Other("Invalid parameter".to_string()),
        ffi::RACK_VST3_ERROR_NOT_INITIALIZED => Error::NotInitialized,
        ffi::RACK_VST3_ERROR_LOAD_FAILED => Error::Other("Failed to load VST3 plugin".to_string()),
        ffi::RACK_VST3_ERROR_NOT_SUPPORTED => Error::Other("Feature not supported by this plugin".to_string()),
        _ => Error::Other(format!("Unknown VST3 error code: {}", code)),
    }
}

/// Safely convert a fixed-size C char array to a Rust String
///
/// This uses bounded string conversion to prevent UB even if the C++ code
/// has a bug and fails to null-terminate within the array bounds.
///
/// # Safety
///
/// The caller must ensure the array pointer is valid and the size is correct.
pub(crate) unsafe fn c_array_to_string(arr: &[i8], field_name: &str) -> Result<String> {
    // Cast to u8 slice for CStr::from_bytes_until_nul
    let bytes = std::slice::from_raw_parts(arr.as_ptr() as *const u8, arr.len());

    // Find null terminator within bounds (defense against C++ bugs)
    let cstr = CStr::from_bytes_until_nul(bytes).map_err(|_| {
        Error::Other(format!(
            "{} not null-terminated within buffer (potential C++ bug)",
            field_name
        ))
    })?;

    // Convert to UTF-8 string
    cstr.to_str()
        .map_err(|e| Error::Other(format!("Invalid UTF-8 in {}: {}", field_name, e)))
        .map(|s| s.to_string())
}