Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/l1npengtul/nokhwa
Cross Platform Rust Library for Powerful Webcam/Camera Capture
https://github.com/l1npengtul/nokhwa
avfoundation camera camera-api cross-platform linux macos mediafoundation rust v4l2 webcam webcam-capture windows
Last synced: 24 days ago
JSON representation
Cross Platform Rust Library for Powerful Webcam/Camera Capture
- Host: GitHub
- URL: https://github.com/l1npengtul/nokhwa
- Owner: l1npengtul
- License: apache-2.0
- Created: 2021-05-17T06:15:12.000Z (over 3 years ago)
- Default Branch: senpai
- Last Pushed: 2024-10-12T14:30:20.000Z (26 days ago)
- Last Synced: 2024-10-12T18:56:32.681Z (26 days ago)
- Topics: avfoundation, camera, camera-api, cross-platform, linux, macos, mediafoundation, rust, v4l2, webcam, webcam-capture, windows
- Language: Rust
- Homepage:
- Size: 7.03 MB
- Stars: 513
- Watchers: 18
- Forks: 131
- Open Issues: 56
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-rust-list - l1npengtul/nokhwa
- awesome-rust-list - l1npengtul/nokhwa
README
[](https://crates.io/crates/nokhwa) [](https://docs.rs/nokhwa/latest/nokhwa/)
# nokhwa
Nokhwa(녹화): Korean word meaning "to record".
A Simple-to-use, cross-platform Rust Webcam Capture Library
## Using nokhwa
Nokhwa can be added to your crate by adding it to your `Cargo.toml`:
```toml
[dependencies.nokhwa]
version = "0.10.0"
# Use the native input backends, enable WGPU integration
features = ["input-native", "output-wgpu"]
```
Most likely, you will only use functionality provided by the `Camera` struct. If you need lower-level access, you may instead opt to use the raw capture backends found at `nokhwa::backends::capture::*`.
## Example
```rust
// first camera in system
let index = CameraIndex::Index(0);
// request the absolute highest resolution CameraFormat that can be decoded to RGB.
let requested = RequestedFormat::new::(RequestedFormatType::AbsoluteHighestFrameRate);
// make the camera
let mut camera = Camera::new(index, requested).unwrap();
// get a frame
let frame = camera.frame().unwrap();
println!("Captured Single Frame of {}", frame.buffer().len());
// decode into an ImageBuffer
let decoded = frame.decode_image::().unwrap();
println!("Decoded Frame of {}", decoded.len());
```
A command line app made with `nokhwa` can be found in the `examples` folder.
## API Support
The table below lists current Nokhwa API support.
- The `Backend` column signifies the backend.
- The `Input` column signifies reading frames from the camera
- The `Query` column signifies system device list support
- The `Query-Device` column signifies reading device capabilities
- The `Platform` column signifies what Platform this is availible on.
| Backend | Input | Query | Query-Device | Platform |
|-----------------------------------------|-------------------|--------------------|-------------------|--------------------|
| Video4Linux(`input-native`) | ✅ | ✅ | ✅ | Linux |
| MSMF(`input-native`) | ✅ | ✅ | ✅ | Windows |
| AVFoundation(`input-native`) | ✅ | ✅ | ✅ | Mac |
| OpenCV(`input-opencv`)^ | ✅ | ❌ | ❌ | Linux, Windows, Mac |
| WASM(`input-wasm`) | ✅ | ✅ | ✅ | Browser(Web) |
✅: Working, 🔮 : Experimental, ❌ : Not Supported, 🚧: Planned/WIP
^ = May be bugged. Also supports IP Cameras.
## Feature
The default feature includes nothing. Anything starting with `input-*` is a feature that enables the specific backend.
`input-*` features:
- `input-native`: Uses either V4L2(Linux), MSMF(Windows), or AVFoundation(Mac OS)
- `input-opencv`: Enables the `opencv` backend. (cross-platform)
- `input-jscam`: Enables the use of the `JSCamera` struct, which uses browser APIs. (Web)
Conversely, anything that starts with `output-*` controls a feature that controls the output of something (usually a frame from the camera)
`output-*` features:
- `output-wgpu`: Enables the API to copy a frame directly into a `wgpu` texture.
- `output-threaded`: Enable the threaded/callback based camera.
Other features:
- `decoding`: Enables `mozjpeg` decoding. Enabled by default.
- `docs-only`: Documentation feature. Enabled for docs.rs builds.
- `docs-nolink`: Build documentation **without** linking to any libraries. Enabled for docs.rs builds.
- `test-fail-warning`: Fails on warning. Enabled in CI.
You many want to pick and choose to reduce bloat.
## Issues
If you are making an issue, please make sure that
- It has not been made yet
- Attach what you were doing, your environment, steps to reproduce, and backtrace.
Thank you!
## Contributing
Contributions are welcome!
- Please `rustfmt` all your code and adhere to the clippy lints (unless necessary not to do so)
- Please limit use of `unsafe`
- All contributions are under the Apache 2.0 license unless otherwise specified
## Minimum Service Rust Version
`nokhwa` may build on older versions of `rustc`, but there is no guarantee except for the latest stable rust.
## Sponsors
- $10/mo sponsors:
- [yunho-c](https://github.com/yunho-c)
- $5/mo sponsors:
- [patte](https://github.com/patte)
- [mason-bially](https://github.com/mason-bially)
Please consider [donating](https://github.com/sponsors/l1npengtul)! It helps me not look like a failure to my parents!