2022-03-24 01:41:19 +01:00
|
|
|
# libdisplay-info
|
|
|
|
|
|
|
|
|
|
EDID and DisplayID library.
|
|
|
|
|
|
2022-03-24 13:52:11 +01:00
|
|
|
Goals:
|
|
|
|
|
|
|
|
|
|
- Provide a set of high-level, easy-to-use, opinionated functions as well as
|
|
|
|
|
low-level functions to access detailed information.
|
|
|
|
|
- Simplicity and correctness over performance and resource usage.
|
|
|
|
|
- Well-tested and fuzzed.
|
|
|
|
|
|
2022-10-04 18:35:35 +02:00
|
|
|
Documentation is available on the [website].
|
|
|
|
|
|
2022-03-24 01:41:19 +01:00
|
|
|
## Contributing
|
|
|
|
|
|
|
|
|
|
Open issues and merge requests on the [GitLab project].
|
|
|
|
|
|
|
|
|
|
In general, the [Wayland contribution guidelines] should be followed. In
|
|
|
|
|
particular, each commit must carry a Signed-off-by tag to denote that the
|
|
|
|
|
submitter adheres to the [Developer Certificate of Origin 1.1]. This project
|
|
|
|
|
follows the [freedesktop.org Contributor Covenant].
|
|
|
|
|
|
2022-06-10 14:23:40 +02:00
|
|
|
## Building
|
|
|
|
|
|
|
|
|
|
libdisplay-info is built using [Meson]. It has no dependencies.
|
|
|
|
|
|
2022-08-23 23:14:31 +02:00
|
|
|
meson setup build/
|
2022-06-10 14:23:40 +02:00
|
|
|
ninja -C build/
|
|
|
|
|
|
2022-03-28 11:17:07 +02:00
|
|
|
## Testing
|
|
|
|
|
|
|
|
|
|
The low-level EDID library is tested against [edid-decode]. `test/data/`
|
|
|
|
|
contains a small collection of EDID blobs and diffs between upstream
|
|
|
|
|
`edid-decode` and our `di-edid-decode` clone. Our CI ensures the diffs are
|
|
|
|
|
up-to-date. A patch should never make the diffs grow larger. To add a new EDID
|
|
|
|
|
blob or update a diff, use `test/edid-decode-diff.sh test/data/<edid>`.
|
|
|
|
|
|
2022-10-07 07:20:18 +02:00
|
|
|
The latest code coverage report is available on [GitLab CI][coverage].
|
|
|
|
|
|
2022-06-10 14:28:57 +02:00
|
|
|
## Fuzzing
|
|
|
|
|
|
|
|
|
|
To fuzz libdisplay-info with [AFL], the library needs to be instrumented:
|
|
|
|
|
|
|
|
|
|
CC=afl-gcc meson build/
|
|
|
|
|
ninja -C build/
|
|
|
|
|
afl-fuzz -i test/data/ -o afl/ build/di-edid-decode
|
|
|
|
|
|
2022-10-04 18:35:35 +02:00
|
|
|
[website]: https://emersion.pages.freedesktop.org/libdisplay-info/
|
2022-03-24 01:41:19 +01:00
|
|
|
[GitLab project]: https://gitlab.freedesktop.org/emersion/libdisplay-info
|
|
|
|
|
[Wayland contribution guidelines]: https://gitlab.freedesktop.org/wayland/wayland/-/blob/main/CONTRIBUTING.md
|
|
|
|
|
[Developer Certificate of Origin 1.1]: https://developercertificate.org/
|
|
|
|
|
[freedesktop.org Contributor Covenant]: https://www.freedesktop.org/wiki/CodeOfConduct/
|
2022-06-10 14:23:40 +02:00
|
|
|
[Meson]: https://mesonbuild.com/
|
2022-10-07 07:20:18 +02:00
|
|
|
[coverage]: https://gitlab.freedesktop.org/emersion/libdisplay-info/-/jobs/artifacts/main/file/build/meson-logs/coveragereport/index.html?job=build-gcc
|
2022-03-28 11:17:07 +02:00
|
|
|
[edid-decode]: https://git.linuxtv.org/edid-decode.git/
|
2022-06-10 14:28:57 +02:00
|
|
|
[AFL]: https://lcamtuf.coredump.cx/afl/
|
