Commit graph

362 commits

Author SHA1 Message Date
Sebastian Wick
adf88cc13d color: Move color-management protocol from unstable to staging
Signed-off-by: Sebastian Wick <sebastian.wick@redhat.com>
2023-10-12 17:11:13 +02:00
Pekka Paalanen
a6aab6b835 color: whitespace fixes
Consistently set blank lines. Fix more indenting. Linewrap some.

Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.com>
2023-10-12 17:11:13 +02:00
Pekka Paalanen
e548868819 color: delete zwp_color_space_v1 interface
zwp_color_space_v1 was replaced with zwp_image_description_v1, but we
need this one paragraph too.

Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.com>
2023-10-12 17:11:13 +02:00
Pekka Paalanen
0a764e3919 color: convert tabs to spaces, fix indenting
vscode really does not handle tab width being different from indent
width. Simpler is better, let's not mix tabs and spaces especially when
indent is not 8 wide.

Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.com>
2023-10-12 17:11:13 +02:00
Pekka Paalanen
2152441198 color: delete white point enum
White point is part of cicp_color_primaries_id already.

Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.com>
2023-10-12 17:11:13 +02:00
Bhawanpreet Lakha
e1fe860243 color management: Add CICP API definitions
Adds the API definitions for the Coding-independent code point spec.

Based on the discussions here:
	https://gitlab.freedesktop.org/swick/wayland-protocols/-/merge_requests/18#note_1271085

This patch is adding an image state creator to define the transfer
function, primaries, and matrix coefficients for a Wayland surface,
either via coding-independent code points defined in ITU-T H.273, via
custom gamma or primaries definitions, or via an ICC profile.

Describes the API definitions for the following
zwp_image_description_creator_icc_v1/zwp_image_description_creator_params_v1
	*Image state creator

request create_image_description_params()
	*iCreate a image state object based on params.

request create_image_description_icc()
	*Create a image state object based on icc profile.

request set_tf_cicp(uint cicp_transfer_characteristics)
	*Set the OETF/EOTF^-1

request set_tf_gamma(uint gamma)
	*Sets the Gamma curve

request set_primaries_cicp(uint cicp_color_primaries)
	*Sets the CICP color primaries

request set_primaries(uint r_x, uint r_y, uint g_x, uint g_y, uint b_x, uint b_y, uint w_x, uint w_y)
	*Sets the color primaries

request set_icc(fd icc_profile)
	*Set the ICC profile

v2:
 - Add errors enum for creation errors
 - Clean up some descriptions

v3:
 - split icc/param into 2 interfaces
 - fix protocol/graceful failures errors
 - remove ycbcr matrix an corresponding requests
 - add create_image_description_* requests

v4:
 - Remove create_color_space_* requests
 - Remove zwp_color_space_creator_v1 and zwp_color_space_v1
 - rename color_space related requests/interfaces to image state
 - move set_extended_dynamic_range into image state

v5:
 - Moved Extended dynamic range from color_managment to image_description
 - Fixed some typos and updated descriptions
 - Added CICP enums for transfer characteristics and color primaries

v6:
 - Reworked CICP enums for transfer characteristics and color primaries

v7:
 - Renamed "image state" to "image description"
 - Removed unnessasry ENUMS
 - Updated descptions/summaries

v8:
 - Re add zwp_color_space_v1

Signed-off-by: Bhawanpreet Lakha <Bhawanpreet.Lakha@amd.com>
2023-10-12 17:11:13 +02:00
Pekka Paalanen
447c0459d3 color: color.rst moved into a new repository
See https://gitlab.freedesktop.org/swick/wayland-protocols/-/issues/6 .

The file color.rst is left as a pointer to the new place for now, as
there are likely links to it circulating.

Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.com>
2023-10-12 17:11:13 +02:00
Pekka Paalanen
2048caaee6 color: put alpha mode into a request of its own
Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.com>
2023-10-12 17:11:13 +02:00
Pekka Paalanen
b2c3dc8291 color: fix my misunderstanding of content EDR
Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.com>
2023-10-12 17:11:13 +02:00
Pekka Paalanen
102bb28309 color: address review comments from Jonas
Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.com>
2023-10-12 17:11:13 +02:00
Naveen Kumar
9ff54f2026 color management: add support for well-known names
This patch:
* Addresses feedback & suggestions from Pekka, Swick
* This adds well-known EOTF, chromaticity and whitepoint names in
the protocol
* updates color.rst doc with list of tables & short description for
most of the well-known names

Signed-off-by: Naveen Kumar <naveen1.kumar@intel.com>
2023-10-12 17:11:13 +02:00
Pekka Paalanen
b7d5274405 color: split color space information events
Fixes: https://gitlab.freedesktop.org/swick/wayland-protocols/-/issues/1
Fixes: https://gitlab.freedesktop.org/wayland/wayland-protocols/-/merge_requests/14#note_616851

Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.com>
2023-10-12 17:11:13 +02:00
Pekka Paalanen
1686e82ce7 color: forbid using compositor as ICC file factory
Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.com>
2023-10-12 17:11:13 +02:00
Pekka Paalanen
27407c684a color: overall
Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.com>
2023-10-12 17:11:13 +02:00
Vitaly Prosyak
66a730fe8a color management: add EDR event and request
Signed-off-by: Vitaly Prosyak <vitaly.prosyak@amd.com>
2023-10-12 17:11:13 +02:00
Sebastian Wick
44c1076823 color management: introduce alpha mode and make it double buffered
Signed-off-by: Sebastian Wick <sebastian@sebastianwick.net>
2023-10-12 17:11:13 +02:00
Sebastian Wick
f3ae628860 color management: seperate ICC fd property violations into protocol...
... error and creation failure

Signed-off-by: Sebastian Wick <sebastian@sebastianwick.net>
2023-10-12 17:11:13 +02:00
Sebastian Wick
d6cbfe1b9a color management: require compositors to understand all EOTF, ...
... chromaticity and whitepoint names from the protocol

Signed-off-by: Sebastian Wick <sebastian@sebastianwick.net>
2023-10-12 17:11:13 +02:00
Sebastian Wick
116f64cf67 color management: protocol fixes and color_space_creator object
* creating a color space now leads through the color_space_creator
  object which allows us to fail at ceating the color space
* there are now three ways to create a color space. From an ICC profile,
  from well-known names and parametrically.
* multiple color_management_outputs can now be created for a single
  wl_output
* color_space_changed is not send when the object is created anymore
* clearify that destroying a color space has no effect on the color
  space state associated with surfaces and outputs
* preferred color space is send only after it is determined or changed
* preferred color space is send to all matching wl_outputs

Signed-off-by: Sebastian Wick <sebastian@sebastianwick.net>
2023-10-12 17:11:13 +02:00
Pekka Paalanen
c281462b02 color management: doc color pipelines
This adds a very high level overview of how color management is supposed
to work on Wayland, compared to how it worked on X11. The aim is to get
people discussing this protocol extension to the same page about the
general approach which is fundamentally different from X11.

Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.com>
2023-10-12 17:11:13 +02:00
Sebastian Wick
b204f89cb3 unstable: add color management protocol
This protocol specifies a way for a client to set the color space and
HDR metadata of a surface and to get information about the color spaces
and HDR capabilities of outputs.

For more information, see color.rst.

Signed-off-by: Sebastian Wick <sebastian@sebastianwick.net>
[Pekka: added color.rst]
Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.com>
2023-10-12 17:11:13 +02:00
Simon Ser
51bee6e074 linux-dmabuf: mark as stable
This protocol extension is ubiquitous. It's time to mark it as
stable.

The interface names are left unchanged, so that compositors and
clients don't need to be updated. In particular, the legacy "z"
prefix is still part of the interface name.

Signed-off-by: Simon Ser <contact@emersion.fr>
2023-10-10 14:43:25 +02:00
Simon Ser
a113a93d83 build: add version for stable protocols
Stable protocols used to not have a version. But with the new
rules, they have one. Accomodate the build script for the new
rules.

Signed-off-by: Simon Ser <contact@emersion.fr>
2023-10-10 14:42:05 +02:00
Simon Ser
78e38c57bf build: simplify dict loops
Instead of iterating on the keys and then using get(), iterate on
both keys and values.

Signed-off-by: Simon Ser <contact@emersion.fr>
2023-10-10 14:42:05 +02:00
Andri Yngvason
e1abed62d5 Add the transient seat protocol
Signed-off-by: Andri Yngvason <andri@yngvason.is>
2023-10-07 16:54:24 +00:00
Simon Ser
90d13c1112 members: remove EFL/Enlightenment
EFL/Enlightenment hasn't been active in a while, doesn't seem to
have interest in the near future, and Mike is fine with ceasing
their membership. They can always be added back when interest
sparks again.

Signed-off-by: Simon Ser <contact@emersion.fr>
Closes: https://gitlab.freedesktop.org/wayland/wayland-protocols/-/issues/146
2023-09-30 01:30:59 +00:00
Simon Ser
e1d61ce940 linux-dmabuf: add note about implicit sync
Make it clear that implicit sync is the expectation without another
protocol extension.

Signed-off-by: Simon Ser <contact@emersion.fr>
2023-08-14 14:32:02 +02:00
Sebastian Wick
5293896cce security-context-v1: Document what can be done with the open sockets
Specifically that after calling create_listener the only valid operation
on the sockets is to close them. They also must stay open and valid
until a round-trip after the call.

Signed-off-by: Sebastian Wick <sebastian.wick@redhat.com>
2023-07-11 15:27:14 +02:00
Sebastian Wick
b19ee1a7e3 security-context-v1: Document out of band metadata for flatpak
and specify when the invalid_metadata error will be sent.

Signed-off-by: Sebastian Wick <sebastian.wick@redhat.com>
2023-07-11 15:27:02 +02:00
Jonas Ådahl
681c33c854 build: Bump version to 1.32
Signed-off-by: Jonas Ådahl <jadahl@gmail.com>
2023-07-03 11:26:25 +02:00
Kirill Chibisov
174b3487a2 stable/xdg-shell: clarify initial wl_surface acknowledgement
Clarify how and when initial wl_surface state provided by the core
protocol or by extensions to the wl_surface, like as
wp_fractional_scale_v1, is being delivered.

The motivation for such change is to make it clear that the first frame
for xdg-shell will be perfect, which implies that scaling and similar
properties affecting presentation would be delivered in time.

Signed-off-by: Kirill Chibisov <contact@kchibisov.com>
2023-07-03 09:17:26 +00:00
David Redondo
3c1fb30817 xdg-activation: Clarify that the token stays valid if the object is destroyed
Signed-off-by: David Redondo <kde@david-redondo.de>
2023-07-03 09:15:34 +00:00
Simon Ser
12c063088e security-context-v1: new protocol
This is a variation of the unveil protocol I suggested in the Weston
issue about security contexts. This lets sandbox engines such as Flatpak
attach a security context to sandboxed clients. The compositor can then
restrict which features are made available to that client.

The protocol is designed around the assumption that the sandbox engine
uses this protocol when setting up the sandboxed application. After this
inital setup, the sandbox engine isn't necessarily running anymore.
For this reason, a special "close FD" is used to indicate when to stop
the security context listener: the sandbox engine can leak the FD into
the sandboxed app's process, and the OS will automatically close the FD
when the sandboxed app exits.

Signed-off-by: Simon Ser <contact@emersion.fr>
References: https://gitlab.freedesktop.org/wayland/weston/-/issues/206
2023-07-03 09:13:08 +00:00
Daniel Stone
c124b641b3 xdg-shell: Add suspended toplevel state
Add a toplevel state to indicate that surface repaints have been
suspended. This may arise due to occlusion, output power state, etc.

In this state, clients can choose to take meaningful action such as
suspending any processing which would drive a repaint loop, or
communicating to the active browser tab that the tab is not
system-visible, or any other action that would be taken by a client not
expecting to repaint until further notice.

cf. discussion in wayland/wayland-protocols!99

Signed-off-by: Daniel Stone <daniels@collabora.com>
2023-06-15 17:43:00 +01:00
Xaver Hugl
bbe9298e85 stable/xdg-shell: clarify when which protocol errors are used
Signed-off-by: Xaver Hugl <xaver.hugl@gmail.com>
2023-05-22 15:47:47 +02:00
Simon Ser
60c6b51097 build: add Wayland subproject
This allows developers to work on a new wayland-scanner feature and
test it with wayland-protocols without too much hassle.

Depends on https://gitlab.freedesktop.org/wayland/wayland/-/merge_requests/313

Signed-off-by: Simon Ser <contact@emersion.fr>
2023-05-19 23:34:18 +00:00
Simon Ser
f89eb17d55 cursor-shape-v1: new protocol
This is based on the Chromium protocol [1].

[1]: https://chromium.googlesource.com/chromium/src/+/main/third_party/wayland-protocols/unstable/cursor-shapes/cursor-shapes-unstable-v1.xml

Signed-off-by: Simon Ser <contact@emersion.fr>
Closes: https://gitlab.freedesktop.org/wayland/wayland-protocols/-/issues/58
References: https://gitlab.freedesktop.org/wayland/wayland-protocols/-/merge_requests/21
2023-05-18 10:22:22 +02:00
Pekka Paalanen
14ae0a9b15 CI: bump ci-templates
This should fix the following problem when I targeted a MR to
branch 'color' in Sebastian's fork of wayland-protocols:

$ ci-fairy check-commits --signed-off-by --junit-xml=results.xml
Traceback (most recent call last):
  File "/usr/bin/ci-fairy", line 33, in <module>
    sys.exit(load_entry_point('ci-fairy==0.1', 'console_scripts', 'ci-fairy')())
  File "/usr/lib/python3.9/site-packages/click/core.py", line 1137, in __call__
    return self.main(*args, **kwargs)
  File "/usr/lib/python3.9/site-packages/click/core.py", line 1062, in main
    rv = self.invoke(ctx)
  File "/usr/lib/python3.9/site-packages/click/core.py", line 1668, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/usr/lib/python3.9/site-packages/click/core.py", line 1404, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "/usr/lib/python3.9/site-packages/click/core.py", line 763, in invoke
    return __callback(*args, **kwargs)
  File "/usr/lib/python3.9/site-packages/click/decorators.py", line 26, in new_func
    return f(get_current_context(), *args, **kwargs)
  File "/usr/lib/python3.9/site-packages/ci_fairy.py", line 1335, in check_commits
    for commit in repo.iter_commits(commit_range):
  File "/usr/lib/python3.9/site-packages/git/objects/commit.py", line 318, in _iter_from_process_or_stream
    finalize_process(proc_or_stream)
  File "/usr/lib/python3.9/site-packages/git/util.py", line 370, in finalize_process
    proc.wait(**kwargs)
  File "/usr/lib/python3.9/site-packages/git/cmd.py", line 447, in wait
    raise GitCommandError(remove_password_if_present(self.args), status, errstr)
git.exc.GitCommandError: Cmd('git') failed due to: exit code(128)
  cmdline: git rev-list cifairy/color..HEAD --
  stderr: 'fatal: bad revision 'cifairy/color..HEAD'
'

Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.com>
2023-05-11 15:10:45 +03:00
Simon Ser
18aa7b27f7 tablet-v2: fix typo in set_cursor serial description
This interface has no "enter" event. This was likely copy-pasted
from wl_pointer.set_cursor.

The event which indicates focus is proximity_in.

Signed-off-by: Simon Ser <contact@emersion.fr>
2023-05-09 11:59:35 +02:00
Simon Ser
cc0cd4addf ci: skip ci-fairy checks on main branch
We merged a commit by mistake which doesn't have S-o-b. ci-fairy is
unhappy about it and will fail the check. Skip it if we aren't
running in a merge request context.

Signed-off-by: Simon Ser <contact@emersion.fr>
2023-04-25 13:41:06 +02:00
Simon Ser
fbf7fc3517 ci: use detached CI pipelines
See [1], required to allow contributors to trigger CI pipelines
for MRs. Example failure can be found at [2].

[1]: https://gitlab.freedesktop.org/freedesktop/freedesktop/-/issues/540#what-it-means-for-me-a-maintainer-of-a-project-part-of-gitlabfreedesktoporg
[2]: https://gitlab.freedesktop.org/i509VCB/wayland-protocols/-/jobs/40117393

Signed-off-by: Simon Ser <contact@emersion.fr>
2023-04-25 09:39:46 +00:00
i509VCB
77b4681f16 Add ext-foreign-toplevel-list protocol 2023-04-25 09:30:56 +00:00
Vlad Zahorodnii
fefd185994 linux-dmabuf: Fix a couple of typos
There are no interfaces such as zlinux_dmabuf_params and zlinux_buffer_params.

Signed-off-by: Vlad Zahorodnii <vlad.zahorodnii@kde.org>
2023-04-18 15:06:04 +03:00
Jonas Ådahl
f9ef5fdba5 xdg-shell: Clarify window geometry bounds
The xdg_surface window geometry can extend outside the base wl_surface
to e.g. accompany subsurfaces that extend outside it but is part of the
window itself. Spell out this bit explicitly.

Signed-off-by: Jonas Ådahl <jadahl@gmail.com>
2023-04-04 11:14:27 +00:00
Jonas Ådahl
fce1d30318 xdg-shell: Clarify that geometry doesn't automatically change
The spec says that

	When applied, the effective window geometry will be the set
	window geometry clamped to the bounding rectangle of the combined
	geometry of the surface of the xdg_surface and the associated
	subsurfaces.

Thus, a client cannot assume the geometry will adapt to any subsequent
changes to any conditions that constrained the geometry.

Signed-off-by: Jonas Ådahl <jadahl@gmail.com>
2023-04-04 11:14:27 +00:00
Mikhail Gusarov
275fce4af9 xdg-shell: Clarify relationship between [un]set_maximized and configure
Make it explicit in the protocol that [un]set_maximized and
the following configure event can't be reliably matched, and the
clients shouldn't try to do it.

Closes #106

Signed-off-by: Mikhail Gusarov <dottedmag@dottedmag.net>
2023-03-30 20:47:28 +00:00
Xaver Hugl
5c274ffc90 unstable/xdg-shell v6: clarify when which errors are used
Signed-off-by: Xaver Hugl <xaver.hugl@gmail.com>
2023-03-30 15:44:07 +00:00
Faith Ekstrand
c622ae7f91 Add a .mailmap file
This will let command-line Git tools re-map my name and e-mail address properly.
I'm using my personal e-mail address and not my Collabora address because I'm
not actively contributing to Wayland anymore and this is mostly for letting
people find me should they dig me up in the project history.

Signed-off-by: Faith Ekstrand <faith@gfxstrand.net>
2023-03-25 11:17:49 -05:00
Jonas Ådahl
94482ceaf9 xdg-output: Remove and tweak contradicting examples
The "logical size" as stated by the first paragraph corresponds to the
monitor size in the global compositor space.

To most clients, this is unnecessary information, and should be ignored,
but some used the listed examples to derive information that contradicts
the very definition of what this event communicates.

One example tried to add surface size assumptions, which was not
correct. Remove this part completely, clients should not try to
configure their surface sizes from the logical size of a monitor.

The other is the list of size examples; it tried to communicate that a
compositor sometimes may not scale the viewport of the monitor in its
global compositor coordinate space, in which case, the logical size
itself matches the actual resolution. Tweak this wording to make that
clear that it does not related to any surface size.

Signed-off-by: Jonas Ådahl <jadahl@gmail.com>
2023-02-27 11:26:25 +00:00
Simon Ser
cf838fd316 xdg-output: clarify goal
In the past, xdg-output had only the logical_position and
logical_size events, then the name and description events were
added. Later on, they were moved inside wl_output since they aren't
desktop-specific. However the goals section of the protocol overview
hasn't been updated accordingly.

Make it clear that this protocol's name and description events should
not be preferred over wl_output.

Signed-off-by: Simon Ser <contact@emersion.fr>
2023-02-21 12:31:18 +00:00