Miroirs/libdisplay-info
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/emersion/libdisplay-info.git synced 2024-12-25 21:59:08 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
Mirror of https://gitlab.freedesktop.org/emersion/libdisplay-info.git
218 commits 15 branches 3 tags 909 KiB
C 95.7%
Python 2.5%
Shell 0.9%
Meson 0.9%
Find a file
Simon Ser 795494b571 build: add subproject for edid-decode 
Signed-off-by: Simon Ser <contact@emersion.fr>
2023-03-02 20:15:29 +01:00
di-edid-decode cta: add support for InfoFrame Data Block 2023-01-31 14:58:50 +01:00
include cta: add support for InfoFrame Data Block 2023-01-31 14:58:50 +01:00
subprojects build: add subproject for edid-decode 2023-03-02 20:15:29 +01:00
test build: add subproject for edid-decode 2023-03-02 20:15:29 +01:00
tool cta: add VIC table 2023-01-13 02:37:01 +01:00
.editorconfig editorconfig: add python rules 2022-11-09 14:18:24 +02:00
.gitlab-ci.yml ci: remove unnecessary "Testing checks" stage 2023-02-27 11:56:27 +00:00
cta-vic-table.c cta: add VIC table 2023-01-13 02:37:01 +01:00
cta.c cta: add support for InfoFrame Data Block 2023-01-31 14:58:50 +01:00
cvt.c Introduce di_cvt_compute() 2022-12-16 15:37:38 +01:00
displayid.c displayid: add support for tiled display topology data block 2023-01-09 22:49:01 +00:00
dmt-table.c dmt: add reduced_blanking field 2022-11-23 15:30:33 +01:00
edid.c edid: Sync On Green Signal only is set if the bit is 0 and not 1 2023-01-30 17:10:40 +01:00
gcovr.cfg Add code coverage configuration file 2023-01-07 13:47:28 +01:00
gtf.c Introduce di_gtf_compute() 2022-09-29 11:50:09 +00:00
info.c info: ignore empty model/serial descriptors 2023-02-27 10:32:12 +01:00
libdisplay-info.map build: set symbol visibility 2022-06-14 11:40:07 +00:00
LICENSE Initial commit 2022-03-24 01:49:00 +01:00
log.c info: introduce di_logger 2022-08-04 08:40:36 +02:00
memory-stream.c memory-stream: Add memory_stream_cleanup helper 2022-11-25 12:15:14 +00:00
meson.build build: add subproject for edid-decode 2023-03-02 20:15:29 +01:00
README.md readme: add IRC channel 2023-02-15 11:20:36 +00:00
release.sh release: Add release instructions and script 2023-02-10 17:06:13 +01:00
releasing.md release: Add release instructions and script 2023-02-10 17:06:13 +01:00

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