2013-02-28 18:55:02 +00:00
|
|
|
/*
|
2013-09-09 16:37:33 +00:00
|
|
|
* This file is part of mpv video player.
|
2013-02-28 18:55:02 +00:00
|
|
|
*
|
Relicense some non-MPlayer source files to LGPL 2.1 or later
This covers source files which were added in mplayer2 and mpv times
only, and where all code is covered by LGPL relicensing agreements.
There are probably more files to which this applies, but I'm being
conservative here.
A file named ao_sdl.c exists in MPlayer too, but the mpv one is a
complete rewrite, and was added some time after the original ao_sdl.c
was removed. The same applies to vo_sdl.c, for which the SDL2 API is
radically different in addition (MPlayer supports SDL 1.2 only).
common.c contains only code written by me. But common.h is a strange
case: although it originally was named mp_common.h and exists in MPlayer
too, by now it contains only definitions written by uau and me. The
exceptions are the CONTROL_ defines - thus not changing the license of
common.h yet.
codec_tags.c contained once large tables generated from MPlayer's
codecs.conf, but all of these tables were removed.
From demux_playlist.c I'm removing a code fragment from someone who was
not asked; this probably could be done later (see commit 15dccc37).
misc.c is a bit complicated to reason about (it was split off mplayer.c
and thus contains random functions out of this file), but actually all
functions have been added post-MPlayer. Except get_relative_time(),
which was written by uau, but looks similar to 3 different versions of
something similar in each of the Unix/win32/OSX timer source files. I'm
not sure what that means in regards to copyright, so I've just moved it
into another still-GPL source file for now.
screenshot.c once had some minor parts of MPlayer's vf_screenshot.c, but
they're all gone.
2016-01-19 17:36:06 +00:00
|
|
|
* mpv is free software; you can redistribute it and/or
|
|
|
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
|
|
|
* License as published by the Free Software Foundation; either
|
|
|
|
|
* version 2.1 of the License, or (at your option) any later version.
|
2013-02-28 18:55:02 +00:00
|
|
|
*
|
2013-09-09 16:37:33 +00:00
|
|
|
* mpv is distributed in the hope that it will be useful,
|
2013-02-28 18:55:02 +00:00
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
Relicense some non-MPlayer source files to LGPL 2.1 or later
This covers source files which were added in mplayer2 and mpv times
only, and where all code is covered by LGPL relicensing agreements.
There are probably more files to which this applies, but I'm being
conservative here.
A file named ao_sdl.c exists in MPlayer too, but the mpv one is a
complete rewrite, and was added some time after the original ao_sdl.c
was removed. The same applies to vo_sdl.c, for which the SDL2 API is
radically different in addition (MPlayer supports SDL 1.2 only).
common.c contains only code written by me. But common.h is a strange
case: although it originally was named mp_common.h and exists in MPlayer
too, by now it contains only definitions written by uau and me. The
exceptions are the CONTROL_ defines - thus not changing the license of
common.h yet.
codec_tags.c contained once large tables generated from MPlayer's
codecs.conf, but all of these tables were removed.
From demux_playlist.c I'm removing a code fragment from someone who was
not asked; this probably could be done later (see commit 15dccc37).
misc.c is a bit complicated to reason about (it was split off mplayer.c
and thus contains random functions out of this file), but actually all
functions have been added post-MPlayer. Except get_relative_time(),
which was written by uau, but looks similar to 3 different versions of
something similar in each of the Unix/win32/OSX timer source files. I'm
not sure what that means in regards to copyright, so I've just moved it
into another still-GPL source file for now.
screenshot.c once had some minor parts of MPlayer's vf_screenshot.c, but
they're all gone.
2016-01-19 17:36:06 +00:00
|
|
|
* GNU Lesser General Public License for more details.
|
2013-02-28 18:55:02 +00:00
|
|
|
*
|
Relicense some non-MPlayer source files to LGPL 2.1 or later
This covers source files which were added in mplayer2 and mpv times
only, and where all code is covered by LGPL relicensing agreements.
There are probably more files to which this applies, but I'm being
conservative here.
A file named ao_sdl.c exists in MPlayer too, but the mpv one is a
complete rewrite, and was added some time after the original ao_sdl.c
was removed. The same applies to vo_sdl.c, for which the SDL2 API is
radically different in addition (MPlayer supports SDL 1.2 only).
common.c contains only code written by me. But common.h is a strange
case: although it originally was named mp_common.h and exists in MPlayer
too, by now it contains only definitions written by uau and me. The
exceptions are the CONTROL_ defines - thus not changing the license of
common.h yet.
codec_tags.c contained once large tables generated from MPlayer's
codecs.conf, but all of these tables were removed.
From demux_playlist.c I'm removing a code fragment from someone who was
not asked; this probably could be done later (see commit 15dccc37).
misc.c is a bit complicated to reason about (it was split off mplayer.c
and thus contains random functions out of this file), but actually all
functions have been added post-MPlayer. Except get_relative_time(),
which was written by uau, but looks similar to 3 different versions of
something similar in each of the Unix/win32/OSX timer source files. I'm
not sure what that means in regards to copyright, so I've just moved it
into another still-GPL source file for now.
screenshot.c once had some minor parts of MPlayer's vf_screenshot.c, but
they're all gone.
2016-01-19 17:36:06 +00:00
|
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
|
|
|
* License along with mpv. If not, see <http://www.gnu.org/licenses/>.
|
2013-02-28 18:55:02 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#ifndef MPLAYER_WAYLAND_COMMON_H
|
|
|
|
|
#define MPLAYER_WAYLAND_COMMON_H
|
|
|
|
|
|
|
|
|
|
#include <wayland-client.h>
|
|
|
|
|
#include <wayland-cursor.h>
|
|
|
|
|
#include <xkbcommon/xkbcommon.h>
|
|
|
|
|
|
2017-10-01 20:16:49 +00:00
|
|
|
#include "vo.h"
|
|
|
|
|
#include "input/event.h"
|
2013-02-28 18:55:02 +00:00
|
|
|
|
2019-10-14 17:16:42 +00:00
|
|
|
struct wayland_opts {
|
|
|
|
|
int disable_vsync;
|
2019-11-26 23:36:35 +00:00
|
|
|
int edge_pixels_pointer;
|
|
|
|
|
int edge_pixels_touch;
|
2019-10-14 17:16:42 +00:00
|
|
|
};
|
|
|
|
|
|
2019-10-10 19:14:40 +00:00
|
|
|
struct vo_wayland_sync {
|
|
|
|
|
int64_t ust;
|
|
|
|
|
int64_t msc;
|
|
|
|
|
int64_t sbc;
|
|
|
|
|
bool filled;
|
|
|
|
|
};
|
|
|
|
|
|
2013-02-28 18:55:02 +00:00
|
|
|
struct vo_wayland_output {
|
2017-10-09 01:08:36 +00:00
|
|
|
struct vo_wayland_state *wl;
|
2017-10-01 20:16:49 +00:00
|
|
|
uint32_t id;
|
2013-02-28 18:55:02 +00:00
|
|
|
struct wl_output *output;
|
2017-10-01 20:16:49 +00:00
|
|
|
struct mp_rect geometry;
|
2017-10-09 01:08:36 +00:00
|
|
|
int phys_width;
|
|
|
|
|
int phys_height;
|
2017-10-01 20:16:49 +00:00
|
|
|
int scale;
|
2013-02-28 18:55:02 +00:00
|
|
|
uint32_t flags;
|
2017-10-01 20:16:49 +00:00
|
|
|
double refresh_rate;
|
2017-10-09 01:08:36 +00:00
|
|
|
char *make;
|
|
|
|
|
char *model;
|
|
|
|
|
bool has_surface;
|
2013-02-28 18:55:02 +00:00
|
|
|
struct wl_list link;
|
|
|
|
|
};
|
|
|
|
|
|
2013-07-18 15:35:28 +00:00
|
|
|
struct vo_wayland_state {
|
2017-10-01 20:16:49 +00:00
|
|
|
struct mp_log *log;
|
|
|
|
|
struct vo *vo;
|
|
|
|
|
struct wl_display *display;
|
|
|
|
|
struct wl_shm *shm;
|
|
|
|
|
struct wl_compositor *compositor;
|
|
|
|
|
struct wl_registry *registry;
|
2019-10-14 17:16:42 +00:00
|
|
|
struct wayland_opts *opts;
|
2017-10-01 20:16:49 +00:00
|
|
|
|
2019-11-30 02:00:49 +00:00
|
|
|
struct m_config_cache *vo_opts_cache;
|
|
|
|
|
struct mp_vo_opts *vo_opts;
|
|
|
|
|
|
2017-10-01 20:16:49 +00:00
|
|
|
/* State */
|
|
|
|
|
struct mp_rect geometry;
|
|
|
|
|
struct mp_rect window_size;
|
2020-08-18 17:55:01 +00:00
|
|
|
struct mp_rect vdparams;
|
2020-02-12 18:26:24 +00:00
|
|
|
int gcd;
|
|
|
|
|
int reduced_width;
|
|
|
|
|
int reduced_height;
|
2019-10-10 19:14:40 +00:00
|
|
|
bool frame_wait;
|
2020-08-18 17:55:01 +00:00
|
|
|
bool state_change;
|
|
|
|
|
bool toplevel_configured;
|
2020-09-07 16:22:25 +00:00
|
|
|
bool activated;
|
|
|
|
|
bool has_keyboard_input;
|
|
|
|
|
bool focused;
|
2020-10-13 15:36:08 +00:00
|
|
|
int timeout_count;
|
2016-07-21 11:25:30 +00:00
|
|
|
int wakeup_pipe[2];
|
2017-10-01 20:16:49 +00:00
|
|
|
int pending_vo_events;
|
|
|
|
|
int mouse_x;
|
|
|
|
|
int mouse_y;
|
2019-11-25 23:52:53 +00:00
|
|
|
int mouse_unscaled_x;
|
|
|
|
|
int mouse_unscaled_y;
|
2017-10-01 20:16:49 +00:00
|
|
|
int scaling;
|
|
|
|
|
int touch_entries;
|
2020-02-06 02:47:10 +00:00
|
|
|
int toplevel_width;
|
|
|
|
|
int toplevel_height;
|
2017-10-01 20:16:49 +00:00
|
|
|
uint32_t pointer_id;
|
|
|
|
|
int display_fd;
|
|
|
|
|
struct wl_callback *frame_callback;
|
|
|
|
|
struct wl_list output_list;
|
|
|
|
|
struct vo_wayland_output *current_output;
|
|
|
|
|
|
|
|
|
|
/* Shell */
|
|
|
|
|
struct wl_surface *surface;
|
2019-02-15 11:52:15 +00:00
|
|
|
struct xdg_wm_base *wm_base;
|
2018-04-23 14:10:40 +00:00
|
|
|
struct xdg_toplevel *xdg_toplevel;
|
|
|
|
|
struct xdg_surface *xdg_surface;
|
2019-10-10 19:14:40 +00:00
|
|
|
struct wp_presentation *presentation;
|
|
|
|
|
struct wp_presentation_feedback *feedback;
|
2018-11-07 12:53:46 +00:00
|
|
|
struct zxdg_decoration_manager_v1 *xdg_decoration_manager;
|
|
|
|
|
struct zxdg_toplevel_decoration_v1 *xdg_toplevel_decoration;
|
2017-10-01 20:16:49 +00:00
|
|
|
struct zwp_idle_inhibit_manager_v1 *idle_inhibit_manager;
|
|
|
|
|
struct zwp_idle_inhibitor_v1 *idle_inhibitor;
|
|
|
|
|
|
2019-10-10 19:14:40 +00:00
|
|
|
/* Presentation Feedback */
|
|
|
|
|
struct vo_wayland_sync *sync;
|
|
|
|
|
int sync_size;
|
|
|
|
|
int64_t last_ust;
|
|
|
|
|
int64_t last_msc;
|
|
|
|
|
int64_t last_skipped_vsyncs;
|
|
|
|
|
int64_t last_queue_display_time;
|
2021-04-16 19:55:15 +00:00
|
|
|
int64_t refresh_interval;
|
wayland: only render if we have frame callback
Back in the olden days, mpv's wayland backend was driven by the frame
callback. This had several issues and was removed in favor of the
current approach which allowed some advanced features (like
display-resample and presentation time) to actually work properly.
However as a consequence, it meant that mpv always rendered, even if the
surface was hidden. Wayland people consider this "wasteful" (and well
they aren't wrong). This commit aims to avoid wasteful rendering by
doing some additional checks in the swapchain. There's three main parts
to this.
1. Wayland EGL now uses an external swapchain (like the drm context).
Before we start a new frame, we check to see if we are waiting on a
callback from the compositor. If there is no wait, then go ahead and
proceed to render the frame, swap buffers, and then initiate
vo_wayland_wait_frame to poll (with a timeout) for the next potential
callback. If we are still waiting on callback from the compositor when
starting a new frame, then we simple skip rendering it entirely until
the surface comes back into view.
2. Wayland on vulkan has essentially the same approach although the
details are a little different. The ra_vk_ctx does not have support for
an external swapchain and although such a mechanism could theoretically
be added, it doesn't make much sense with libplacebo. Instead,
start_frame was added as a param and used to check for callback.
3. For wlshm, it's simply a matter of adding frame callback to it,
leveraging vo_wayland_wait_frame, and using the frame callback value to
whether or not to draw the image.
2020-09-18 17:29:53 +00:00
|
|
|
int64_t vsync_duration;
|
2019-10-10 19:14:40 +00:00
|
|
|
|
2017-10-01 20:16:49 +00:00
|
|
|
/* Input */
|
2020-11-07 19:47:26 +00:00
|
|
|
uint32_t keyboard_code;
|
2017-10-01 20:16:49 +00:00
|
|
|
struct wl_seat *seat;
|
|
|
|
|
struct wl_pointer *pointer;
|
|
|
|
|
struct wl_touch *touch;
|
|
|
|
|
struct wl_keyboard *keyboard;
|
|
|
|
|
struct xkb_context *xkb_context;
|
|
|
|
|
struct xkb_keymap *xkb_keymap;
|
|
|
|
|
struct xkb_state *xkb_state;
|
|
|
|
|
|
|
|
|
|
/* DND */
|
|
|
|
|
struct wl_data_device_manager *dnd_devman;
|
|
|
|
|
struct wl_data_device *dnd_ddev;
|
|
|
|
|
struct wl_data_offer *dnd_offer;
|
|
|
|
|
enum mp_dnd_action dnd_action;
|
|
|
|
|
char *dnd_mime_type;
|
|
|
|
|
int dnd_mime_score;
|
|
|
|
|
int dnd_fd;
|
|
|
|
|
|
|
|
|
|
/* Cursor */
|
|
|
|
|
struct wl_cursor_theme *cursor_theme;
|
|
|
|
|
struct wl_cursor *default_cursor;
|
|
|
|
|
struct wl_surface *cursor_surface;
|
2017-10-22 04:45:23 +00:00
|
|
|
int allocated_cursor_scale;
|
2019-02-04 10:27:49 +00:00
|
|
|
bool cursor_visible;
|
2013-02-28 18:55:02 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
int vo_wayland_init(struct vo *vo);
|
2017-10-01 20:16:49 +00:00
|
|
|
int vo_wayland_reconfig(struct vo *vo);
|
2013-05-15 16:17:18 +00:00
|
|
|
int vo_wayland_control(struct vo *vo, int *events, int request, void *arg);
|
2019-10-10 19:14:40 +00:00
|
|
|
int last_available_sync(struct vo_wayland_state *wl);
|
2017-10-01 20:16:49 +00:00
|
|
|
void vo_wayland_uninit(struct vo *vo);
|
2016-07-21 11:25:30 +00:00
|
|
|
void vo_wayland_wakeup(struct vo *vo);
|
|
|
|
|
void vo_wayland_wait_events(struct vo *vo, int64_t until_time_us);
|
wayland: simplify render loop
This is actually a very nice simplification that should have been
thought of years ago (sue me). In a nutshell, the story with the
wayland code is that the frame callback and swap buffer behavior doesn't
fit very well with mpv's rendering loop. It's been refactored/changed
quite a few times over the years and works well enough but things could
be better. The current iteration works with an external swapchain to
check if we have frame callback before deciding whether or not to
render. This logic was implemented in both egl and vulkan.
This does have its warts however. There's some hidden state detection
logic which works but is kind of ugly. Since wayland doesn't allow
clients to know if they are actually visible (questionable but
whatever), you can just reasonably assume that if a bunch of callbacks
are missed in a row, you're probably not visible. That's fine, but it is
indeed less than ideal since the threshold is basically entirely
arbitrary and mpv does do a few wasteful renders before it decides that
the window is actually hidden.
The biggest urk in the vo_wayland_wait_frame is the use of
wl_display_roundtrip. Wayland developers would probably be offended by
the way mpv abuses that function, but essentially it was a way to have
semi-blocking behavior needed for display-resample to work. Since the
swap interval must be 0 on wayland (otherwise it will block the entire
player's rendering loop), we need some other way to wait on vsync. The
idea here was to dispatch and poll a bunch of wayland events, wait (with
a timeout) until we get frame callback, and then wait for the compositor
to process it. That pretty much perfectly waits on vsync and lets us
keep all the good timings and all that jazz that we want for mpv. The
problem is that wl_display_roundtrip is conceptually a bad function. It
can internally call wl_display_dispatch which in certain instances,
empty event queue, will block forever. Now strictly speaking, this
probably will never, ever happen (once I was able to to trigger it by
hardcoding an error into a compositor), but ideally
vo_wayland_wait_frame should never infinitely block and stall the
player. Unfortunately, removing that function always lead to problems
with timings and unsteady vsync intervals so it survived many refactors.
Until now, of course. In wayland, the ideal is to never do wasteful
rendering (i.e. don't render if the window isn't visible). Instead of
wrestling around with hidden states and possible missed vblanks, let's
rearrange the wayland rendering logic so we only ever draw a frame when
the frame callback is returned to use (within a reasonable timeout to
avoid blocking forever).
This slight rearrangement of the wait allows for several simplifications
to be made. Namely, wl_display_roundtrip stops being needed. Instead, we
can rely entirely on totally nonblocking calls (dispatch_pending, flush,
and so on). We still need to poll the fd here to actually get the frame
callback event from the compositor, but there's no longer any reason to
do extra waiting. As soon as we get the callback, we immediately draw.
This works quite well and has stable vsync (display-resample and audio).
Additionally, all of the logic about hidden states is no longer needed.
If vo_wayland_wait_frame times out, it's okay to assume immediately that
the window is not visible and skip rendering.
Unfortunately, there's one limitation on this new approach. It will only
work correctly if the compositor implements presentation time. That
means a reduced version of the old way still has to be carried around in
vo_wayland_wait_frame. So if the compositor has no presentation time,
then we are forced to use wl_display_roundtrip and juggle some funny
assumptions about whether or not the window is hidden or not. Plasma is
the only real notable compositor without presentation time at this stage
so perhaps this "legacy" mechanism could be removed in the future.
2021-05-17 19:36:59 +00:00
|
|
|
bool vo_wayland_wait_frame(struct vo_wayland_state *wl);
|
2020-10-05 15:28:37 +00:00
|
|
|
void vo_wayland_set_opaque_region(struct vo_wayland_state *wl, int alpha);
|
2019-10-10 19:14:40 +00:00
|
|
|
void wayland_sync_swap(struct vo_wayland_state *wl);
|
|
|
|
|
void vo_wayland_sync_shift(struct vo_wayland_state *wl);
|
|
|
|
|
void queue_new_sync(struct vo_wayland_state *wl);
|
2013-02-28 18:55:02 +00:00
|
|
|
|
|
|
|
|
#endif /* MPLAYER_WAYLAND_COMMON_H */
|
