Google Git
Sign in
android / platform / external / libdisplay-info / 8ec4aa2c84a509ef75ee3cb190309157bd088eca
commit8ec4aa2c84a509ef75ee3cb190309157bd088eca[log] [tgz]
authorSebastian Wick <[email protected]>Wed Feb 15 12:50:09 2023 +0100
committerSebastian Wick <[email protected]>Wed Feb 22 22:23:03 2023 +0100
treed3792960dfb4c6e55177e34760a0688253c84189
parent5a4a28e2268f0cfdca419dd0c9d2b3e3ac95e55b [diff]
ci: create new stage for checking the testing data

We will add more checks in the next commit which require an image which
can run meson and ninja.

Signed-off-by: Sebastian Wick <[email protected]>
1 file changed
tree: d3792960dfb4c6e55177e34760a0688253c84189
  1. di-edid-decode/
  2. include/
  3. test/
  4. tool/
  5. .editorconfig
  6. .gitlab-ci.yml
  7. cta-vic-table.c
  8. cta.c
  9. cvt.c
  10. displayid.c
  11. dmt-table.c
  12. edid.c
  13. gcovr.cfg
  14. gtf.c
  15. info.c
  16. libdisplay-info.map
  17. LICENSE
  18. log.c
  19. memory-stream.c
  20. meson.build
  21. README.md
  22. release.sh
  23. releasing.md
README.md

libdisplay-info

EDID and DisplayID library.

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.

Documentation is available on the website.

Using

The public API headers are categorised as either high-level or low-level API as per the comments in the header files. Users of libdisplay-info should prefer high-level API over low-level API when possible.

If high-level API lacks needed features, please propose additions to the high-level API upstream before using low-level API to get what you need. If the additions are rejected, you are welcome to use the low-level API.

This policy is aimed to propagate best practises when interpreting EDID and DisplayID information which can often be cryptic or even inconsistent.

libdisplay-info uses semantic versioning. The public API is not yet stable.

Contributing

Open issues and merge requests on the GitLab project. Discuss and ask questions in the #wayland IRC channel on OFTC.

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.

Building

libdisplay-info has the following dependencies:

  • hwdata for the PNP ID database used at build-time only.

libdisplay-info is built using Meson:

meson setup build/
ninja -C build/

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 re-generate the test data, run ninja -C build/ gen-test-data.

To run the test suite locally, you need to use edid-decode of the git revision mentioned in .gitlab-ci.yml. Otherwise you may experience false failures.

The latest code coverage report is available on GitLab CI.

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/di-edid-decode