Fix build

Author: Daninet

.github/workflows/test_cli.yml

@@ -49,5 +49,8 @@ jobs:
       - name: Lint with Clippy
         run: cargo clippy -- -D warnings
 
+      - name: Lint with Clippy (C API)
+        run: cargo clippy --features c-api -- -D warnings
+
       # - name: Cargo Test
       #   run: cargo test

Cargo.toml

@@ -24,3 +24,4 @@ crate-type = ["cdylib", "staticlib", "rlib"]
 default = ["wasm-api"]
 std = []
 wasm-api = ["std"]
+c-api = []

examples/c_api/CMakeLists.txt

@@ -18,7 +18,7 @@ message(STATUS "Looking for library in ${LIB_DIR}")
 find_library(SEA_LIB NAMES sea_codec libsea_codec sea_codec.dll PATHS ${LIB_DIR} NO_DEFAULT_PATH)
 
 if(NOT SEA_LIB)
-    message(WARNING "sea-codec library not found in ${LIB_DIR}. Please build the rust project first (cargo build).")
+    message(WARNING "sea-codec library not found in ${LIB_DIR}. Please build the rust project first (cargo build --features c-api).")
 endif()
 
 add_executable(c_example main.c)

examples/c_api/README.md

@@ -58,5 +58,5 @@ To build a static library for a different platform (e.g., ARM Cortex-M3), use `r
 
 ```sh
 rustup target add thumbv7m-none-eabi
-cargo build --release --target thumbv7m-none-eabi
+cargo build --release --target thumbv7m-none-eabi --features c-api
 ```

src/c_api.rs

@@ -39,6 +39,12 @@ pub extern "C" fn sea_encoder_default_settings() -> CSeaEncoderSettings {
 }
 
 #[no_mangle]
+/// # Safety
+///
+/// * `input_samples` must be a valid pointer to an array of `i16` of length `input_length`.
+/// * `output_data` must be a valid pointer to a pointer where the output buffer address will be stored.
+/// * `output_length` must be a valid pointer where the output length will be stored.
+/// * If `settings` is not null, it must point to a valid `CSeaEncoderSettings` struct.
 pub unsafe extern "C" fn sea_encode(
     input_samples: *const i16,
     input_length: usize,
@@ -73,6 +79,12 @@ pub unsafe extern "C" fn sea_encode(
 }
 
 #[no_mangle]
+/// # Safety
+///
+/// * `encoded_data` must be a valid pointer to a byte array of length `encoded_length`.
+/// * `output_samples` must be a valid pointer to a pointer where the decoded samples address will be stored.
+/// * `output_sample_count` must be a valid pointer where the sample count will be stored.
+/// * `output_sample_rate` and `output_channels` may be null, but if provided must be valid pointers.
 pub unsafe extern "C" fn sea_decode(
     encoded_data: *const u8,
     encoded_length: usize,
@@ -109,13 +121,21 @@ pub unsafe extern "C" fn sea_decode(
 }
 
 #[no_mangle]
+/// # Safety
+///
+/// * `data` must be a pointer to a memory block allocated by `sea_encode` (or compatible Rust allocator).
+/// * `length` must match the length of the allocated block.
 pub unsafe extern "C" fn sea_free_packet(data: *mut u8, length: usize) {
     if !data.is_null() {
         let _ = Vec::from_raw_parts(data, length, length);
     }
 }
 
 #[no_mangle]
+/// # Safety
+///
+/// * `samples` must be a pointer to a memory block allocated by `sea_decode` (or compatible Rust allocator).
+/// * `length` must match the length of the allocated block.
 pub unsafe extern "C" fn sea_free_samples(samples: *mut i16, length: usize) {
     if !samples.is_null() {
         let _ = Vec::from_raw_parts(samples, length, length);

src/lib.rs

@@ -13,6 +13,7 @@ pub mod encoder;
 #[cfg(all(target_arch = "wasm32", feature = "wasm-api"))]
 pub mod wasm_api;
 
+#[cfg(feature = "c-api")]
 pub mod c_api;
 
 pub fn sea_encode(