sdif-sys 0.5.2

Raw FFI bindings to the IRCAM SDIF (Sound Description Interchange Format) C library
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

# Publishing sdif-sys to crates.io

## Summary

The `sdif-sys` crate has been configured to successfully build and publish to crates.io even without the SDIF C library being available. This is accomplished through a stub bindings system.

## How It Works

1. **Build Script Intelligence**: The `build.rs` script attempts to find the SDIF library in this order:
   - pkg-config (system library)
   - Bundled source in `sdif/` directory
   - **Stub bindings** (fallback when library is not available)

2. **Stub Bindings**: When the SDIF library isn't found:
   - Generates minimal type definitions and function declarations
   - Sets `sdif_stub_bindings` cfg flag
   - Allows the crate to compile successfully
   - Tests that require the actual library are disabled

3. **Conditional Testing**: Tests are organized as:
   - Always available: Type conversion, constant checks
   - Conditionally disabled: Tests calling actual SDIF functions (disabled with stub bindings)

## Publishing to crates.io

The crate is ready to publish. To publish:

```bash
# Verify the package builds
cargo package -p sdif-sys --allow-dirty

# Publish to crates.io
cargo publish -p sdif-sys
```

## For End Users

Users who download this crate from crates.io will see:

1. **Without SDIF library**: Compiles with stub bindings and warnings
2. **With system SDIF**: Compiles with full bindings via pkg-config  
3. **With bundled source**: Compiles with full bindings from bundled C code

## Important Notes

- The README clearly states this is a placeholder requiring the actual SDIF library
- Build warnings inform users when stub bindings are being used
- The crate metadata includes docs.rs configuration
- All tests pass (3 tests run, others conditionally disabled)

## Files Modified

- `build.rs`: Added stub bindings generation and graceful fallback
- `src/lib.rs`: Removed duplicate SdifSignature type, added conditional test compilation
- `tests/integration.rs`: Disabled all tests when using stub bindings
- `Cargo.toml`: Added readme and docs.rs metadata
- `README.md`: Added warning about stub bindings and requirements