chore: prepare asio-sys v0.2.3 release (#1071)

* docs: add README, CHANGELOG, and metadata for asio-sys
* refactor: replace SampleRate newtype with type alias

Author: roderickvd

asio-sys/CHANGELOG.md

@@ -0,0 +1,73 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.2.3] - 2025-12-11
+
+### Added
+- Added `edition = "2021"` and `rust-version = "1.70"` to Cargo.toml
+- Added README.md with usage documentation
+- Added CHANGELOG.md following Keep a Changelog format
+- Added rustfmt.toml for consistent formatting
+
+### Changed
+- Update `bindgen` to 0.72
+- Update `cc` to 1.2
+- Update `parse_cfg` to 4.1
+- Update enumerate example to use `pub type SampleRate = u32` instead of `pub struct SampleRate(pub u32)` for consistency with cpal
+
+### Fixed
+- Fix linker flags for MinGW cross-compilation
+- Add `packed(4)` to representation of ASIO time structs in bindings
+- Fix handling for `kAsioResetRequest` message to prevent driver UI becoming unresponsive
+- Fix timeinfo flags type
+
+## [0.2.2] - 2024-03-04
+
+### Added
+- Automate ASIO SDK download during build (no longer requires manual download)
+- Add support for `CPAL_ASIO_DIR` environment variable to use local SDK
+
+### Changed
+- Update `bindgen` to 0.59
+- Switch to `once_cell` from `lazy_static`
+- Improve build script error messages and SDK detection
+- Clean up build script structure
+- Re-run build script when `CPAL_ASIO_DIR` changes
+
+### Fixed
+- Fix segmentation fault during build on some systems
+- Fix various compiler warnings
+- Fix typos in code and comments
+
+## [0.2.1] - 2021-11-26
+
+### Changed
+- Update `bindgen` to 0.56
+
+### Fixed
+- Fix some typos and warnings
+
+## [0.2.0] - 2020-07-22
+
+### Changed
+- Update repository URL to https://github.com/RustAudio/cpal/
+
+## [0.1.0] - 2020-07-22
+
+Initial release.
+
+### Added
+- FFI bindings to Steinberg ASIO SDK
+- Automatic binding generation using bindgen
+- Support for MSVC toolchain on Windows
+- Basic error types: `AsioError`, `LoadDriverError`
+
+[0.2.3]: https://github.com/RustAudio/cpal/compare/asio-sys-v0.2.2...asio-sys-v0.2.3
+[0.2.2]: https://github.com/RustAudio/cpal/compare/asio-sys-v0.2.1...asio-sys-v0.2.2
+[0.2.1]: https://github.com/RustAudio/cpal/compare/asio-sys-v0.2.0...asio-sys-v0.2.1
+[0.2.0]: https://github.com/RustAudio/cpal/compare/asio-sys-v0.1.0...asio-sys-v0.2.0
+[0.1.0]: https://github.com/RustAudio/cpal/releases/tag/asio-sys-v0.1.0

asio-sys/Cargo.toml

@@ -7,6 +7,8 @@ repository = "https://github.com/RustAudio/cpal/"
 documentation = "https://docs.rs/asio-sys"
 license = "Apache-2.0"
 keywords = ["audio", "sound", "asio", "steinberg"]
+edition = "2021"
+rust-version = "1.70"
 build = "build.rs"
 
 [build-dependencies]

asio-sys/README.md

@@ -0,0 +1,109 @@
+# asio-sys
+
+[![Crates.io](https://img.shields.io/crates/v/asio-sys.svg)](https://crates.io/crates/asio-sys)
+[![Documentation](https://docs.rs/asio-sys/badge.svg)](https://docs.rs/asio-sys)
+[![License](https://img.shields.io/crates/l/asio-sys.svg)](https://github.com/RustAudio/cpal/blob/master/LICENSE)
+
+Low-level Rust bindings for the [Steinberg ASIO SDK](https://www.steinberg.net/developers/).
+
+ASIO (Audio Stream Input/Output) is a low-latency audio API for Windows that provides direct hardware access, bypassing the Windows audio stack for minimal latency.
+
+## Overview
+
+`asio-sys` provides raw FFI bindings to the ASIO SDK, automatically generated using [bindgen](https://rust-lang.github.io/rust-bindgen/). This crate is used by [cpal](https://crates.io/crates/cpal)'s ASIO backend to provide low-latency audio on Windows.
+
+**Note:** Most users should use [cpal](https://crates.io/crates/cpal)'s safe, cross-platform API rather than using `asio-sys` directly.
+
+## Features
+
+- Automatic binding generation from ASIO SDK headers
+- Low-level access to ASIO driver functionality
+- Support for both MSVC and MinGW toolchains
+- Automated ASIO SDK download and setup during build
+
+## Requirements
+
+### Windows
+
+- **LLVM/Clang**: Required for bindgen to generate bindings
+  - Install via [LLVM downloads](https://releases.llvm.org/) or `choco install llvm`
+- **ASIO SDK**: Automatically downloaded during build from Steinberg
+  - Or set `CPAL_ASIO_DIR` environment variable to point to a local SDK
+
+### Build Dependencies
+
+- `bindgen` - Generates Rust bindings from C/C++ headers
+- `cc` - Compiles the ASIO SDK C++ files
+- `walkdir` - Finds SDK files
+
+## Usage
+
+Add to your `Cargo.toml`:
+
+```toml
+[dependencies]
+asio-sys = "0.2"
+```
+
+### Example
+
+```rust
+use asio_sys as sys;
+
+fn main() {
+    // Load ASIO driver
+    let driver_name = "ASIO4ALL v2"; // Your ASIO driver name
+
+    unsafe {
+        // Initialize ASIO
+        let drivers = sys::get_driver_names();
+        println!("Available drivers: {drivers:?}");
+
+        // Load a driver
+        match sys::load_asio_driver(driver_name) {
+            Ok(driver) => println!("Loaded driver: {driver_name}"),
+            Err(e) => eprintln!("Failed to load driver: {e:?}"),
+        }
+    }
+}
+```
+
+## Environment Variables
+
+- `CPAL_ASIO_DIR`: Path to ASIO SDK directory (optional)
+  - If not set, the SDK is automatically downloaded during build
+  - Example: `set CPAL_ASIO_DIR=C:\path\to\asiosdk`
+
+## Platform Support
+
+- **Windows** (MSVC and MinGW)
+  - x86_64 (64-bit)
+  - i686 (32-bit)
+
+ASIO is Windows-only. This crate will not build on other platforms.
+
+## Safety
+
+This crate provides raw FFI bindings to C++ code. Almost all functions are `unsafe` and require careful handling:
+
+- Memory management is manual
+- Callbacks must be properly synchronized
+- Driver state must be carefully managed
+- See [ASIO SDK documentation](https://www.steinberg.net/developers/) for details
+
+## License
+
+Licensed under the Apache License, Version 2.0. See [LICENSE](../LICENSE) for details.
+
+The ASIO SDK is owned by Steinberg Media Technologies GmbH. Users must comply with Steinberg's licensing terms.
+
+## Contributing
+
+Contributions are welcome! Please submit issues and pull requests to the [cpal repository](https://github.com/RustAudio/cpal).
+
+## Resources
+
+- [ASIO SDK Documentation](https://www.steinberg.net/developers/)
+- [cpal Documentation](https://docs.rs/cpal)
+- [RustAudio Community](https://github.com/RustAudio)
+- [Discord: #cpal Channel](https://discordapp.com/channels/590254806208217089/672897096826748948)

asio-sys/examples/enumerate.rs

@@ -23,8 +23,7 @@ pub enum SampleFormat {
 pub type ChannelCount = u16;
 
 // The number of samples processed per second for a single channel of audio.
-#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
-pub struct SampleRate(pub u32);
+pub type SampleRate = u32;
 
 #[derive(Debug, Clone, PartialEq, Eq)]
 pub struct Format {
@@ -46,12 +45,12 @@ fn main() {
             .expect("failed to retrieve sample rate");
         let in_fmt = Format {
             channels: channels.ins as _,
-            sample_rate: SampleRate(sample_rate as _),
+            sample_rate: sample_rate as _,
             data_type: SampleFormat::F32,
         };
         let out_fmt = Format {
             channels: channels.outs as _,
-            sample_rate: SampleRate(sample_rate as _),
+            sample_rate: sample_rate as _,
             data_type: SampleFormat::F32,
         };
         println!("  Input {:?}", in_fmt);

asio-sys/rustfmt.toml

@@ -0,0 +1 @@
+edition = "2021"