You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
README: Use GitHub Actions badge instead of dysfunct Travis (#81)
Seems the last successful build there was 2 years ago, and the badge now
says "Build: No longer available". Switch the badge over to reflect the
CI status on GitHub Actions instead.
Also add a badge linking to the documentation of the main `v4l` crate,
wrap some crate names in backticks, and format the markdown documents
to have proper spacing around headings.
This crate provides safe bindings to the Video for Linux (V4L) stack. Modern device drivers will usually implement the `v4l2` API while older ones may depend on the legacy `v4l` API. Such legacy devices may be used with this crate by choosing the `libv4l` feature for this crate.
8
9
9
10
## Goals
10
-
This crate shall provide the v4l-sys package to enable full (but unsafe) access to libv4l\*.
11
+
12
+
This crate shall provide the `v4l-sys` package to enable full (but unsafe) access to `libv4l*`.
11
13
On top of that, there will be a high level, more idiomatic API to use video capture devices in Linux.
12
14
13
15
There will be simple utility applications to list devices and capture frames.
14
16
A minimalistic OpenGL/Vulkan viewer to display frames is planned for the future.
15
17
16
18
## Changelog
17
-
See [CHANGELOG.md](https://github.com/raymanfx/libv4l-rs/blob/master/CHANGELOG.md)
19
+
20
+
See [CHANGELOG.md](./CHANGELOG.md)
18
21
19
22
## Dependencies
23
+
20
24
You have the choice between two dependencies (both provided by this crate internally):
21
-
* libv4l-sys
25
+
26
+
*`libv4l-sys`
22
27
> Link against the libv4l* stack including libv4l1, libv4l2, libv4lconvert.
23
28
> This has the advantage of emulating common capture formats such as RGB3 in userspace through libv4lconvert and more.
24
29
> However, some features like userptr buffers are not supported in libv4l.
25
-
*v4l2-sys
30
+
*`v4l2-sys`
26
31
> Use only the Linux kernel provided v4l2 API provided by videodev2.h.
27
32
> You get support for all v4l2 features such as userptr buffers, but may need to do format conversion yourself if you require e.g. RGB/BGR buffers which may not be supported by commodity devices such as webcams.
28
33
29
34
Enable either the `libv4l` or the `v4l2` backend by choosing the it as feature for this crate.
30
35
31
36
## Usage
37
+
32
38
Below you can find a quick example usage of this crate. It introduces the basics necessary to do frame capturing from a streaming device (e.g. webcam).
0 commit comments