presentation-time: make API more flexible

The wlr_presentation_feedback struct now tracks presentation feedback
for multiple resources (but still a single surface content update). This
allows the compositor to properly send presentation events even when
there is more than one frame of latency or when it references a
surface's buffer.
This commit is contained in:
Simon Ser 2019-11-16 23:44:28 +01:00 committed by Drew DeVault
parent 3084cee7bc
commit 533ea6d7ef
2 changed files with 120 additions and 70 deletions

View file

@ -28,17 +28,19 @@ struct wlr_presentation {
}; };
struct wlr_presentation_feedback { struct wlr_presentation_feedback {
struct wl_resource *resource;
struct wlr_presentation *presentation; struct wlr_presentation *presentation;
struct wlr_surface *surface; struct wlr_surface *surface; // NULL if the surface has been destroyed
struct wl_list link; // wlr_presentation::feedbacks struct wl_list link; // wlr_presentation::feedbacks
struct wl_list resources; // wl_resource_get_link
// The surface contents were committed. // The surface contents were committed.
bool committed; bool committed;
// The surface contents were sampled by the compositor and are to be // The surface contents were sampled by the compositor and are to be
// presented on the next flip. Can become true only after committed becomes // presented on the next flip. Can become true only after committed becomes
// true. // true.
bool sampled; bool sampled;
bool presented;
struct wl_listener surface_commit; struct wl_listener surface_commit;
struct wl_listener surface_destroy; struct wl_listener surface_destroy;
@ -58,10 +60,25 @@ struct wlr_backend;
struct wlr_presentation *wlr_presentation_create(struct wl_display *display, struct wlr_presentation *wlr_presentation_create(struct wl_display *display,
struct wlr_backend *backend); struct wlr_backend *backend);
void wlr_presentation_destroy(struct wlr_presentation *presentation); void wlr_presentation_destroy(struct wlr_presentation *presentation);
void wlr_presentation_send_surface_presented( /**
struct wlr_presentation *presentation, struct wlr_surface *surface, * Mark the current surface's buffer as sampled.
struct wlr_presentation_event *event); *
void wlr_presentation_surface_sampled( * The compositor must call this function when it uses the surface's current
* contents (e.g. when rendering the surface's current texture, when
* referencing its current buffer, or when directly scanning out its current
* buffer). A wlr_presentation_feedback is returned. The compositor should call
* wlr_presentation_feedback_send_presented if this content has been displayed,
* then wlr_presentation_feedback_destroy.
*
* NULL is returned if the client hasn't requested presentation feedback for
* this surface.
*/
struct wlr_presentation_feedback *wlr_presentation_surface_sampled(
struct wlr_presentation *presentation, struct wlr_surface *surface); struct wlr_presentation *presentation, struct wlr_surface *surface);
void wlr_presentation_feedback_send_presented(
struct wlr_presentation_feedback *feedback,
struct wlr_presentation_event *event);
void wlr_presentation_feedback_destroy(
struct wlr_presentation_feedback *feedback);
#endif #endif

View file

@ -9,31 +9,19 @@
#define PRESENTATION_VERSION 1 #define PRESENTATION_VERSION 1
static struct wlr_presentation_feedback *presentation_feedback_from_resource(
struct wl_resource *resource) {
assert(wl_resource_instance_of(resource,
&wp_presentation_feedback_interface, NULL));
return wl_resource_get_user_data(resource);
}
static void feedback_handle_resource_destroy(struct wl_resource *resource) { static void feedback_handle_resource_destroy(struct wl_resource *resource) {
struct wlr_presentation_feedback *feedback = wl_list_remove(wl_resource_get_link(resource));
presentation_feedback_from_resource(resource);
wl_list_remove(&feedback->surface_commit.link);
wl_list_remove(&feedback->surface_destroy.link);
wl_list_remove(&feedback->link);
free(feedback);
} }
// Destroys the feedback static void feedback_resource_send_presented(
static void feedback_send_presented(struct wlr_presentation_feedback *feedback, struct wl_resource *feedback_resource,
struct wlr_presentation_event *event) { struct wlr_presentation_event *event) {
struct wl_client *client = wl_resource_get_client(feedback->resource); struct wl_client *client = wl_resource_get_client(feedback_resource);
struct wl_resource *resource; struct wl_resource *output_resource;
wl_resource_for_each(resource, &event->output->resources) { wl_resource_for_each(output_resource, &event->output->resources) {
if (wl_resource_get_client(resource) == client) { if (wl_resource_get_client(output_resource) == client) {
wp_presentation_feedback_send_sync_output(feedback->resource, wp_presentation_feedback_send_sync_output(feedback_resource,
resource); output_resource);
} }
} }
@ -41,18 +29,17 @@ static void feedback_send_presented(struct wlr_presentation_feedback *feedback,
uint32_t tv_sec_lo = event->tv_sec & 0xFFFFFFFF; uint32_t tv_sec_lo = event->tv_sec & 0xFFFFFFFF;
uint32_t seq_hi = event->seq >> 32; uint32_t seq_hi = event->seq >> 32;
uint32_t seq_lo = event->seq & 0xFFFFFFFF; uint32_t seq_lo = event->seq & 0xFFFFFFFF;
wp_presentation_feedback_send_presented(feedback->resource, wp_presentation_feedback_send_presented(feedback_resource,
tv_sec_hi, tv_sec_lo, event->tv_nsec, event->refresh, tv_sec_hi, tv_sec_lo, event->tv_nsec, event->refresh,
seq_hi, seq_lo, event->flags); seq_hi, seq_lo, event->flags);
wl_resource_destroy(feedback->resource); wl_resource_destroy(feedback_resource);
} }
// Destroys the feedback static void feedback_resource_send_discarded(
static void feedback_send_discarded( struct wl_resource *feedback_resource) {
struct wlr_presentation_feedback *feedback) { wp_presentation_feedback_send_discarded(feedback_resource);
wp_presentation_feedback_send_discarded(feedback->resource); wl_resource_destroy(feedback_resource);
wl_resource_destroy(feedback->resource);
} }
static void feedback_handle_surface_commit(struct wl_listener *listener, static void feedback_handle_surface_commit(struct wl_listener *listener,
@ -63,18 +50,33 @@ static void feedback_handle_surface_commit(struct wl_listener *listener,
if (feedback->committed) { if (feedback->committed) {
if (!feedback->sampled) { if (!feedback->sampled) {
// The content update has been superseded // The content update has been superseded
feedback_send_discarded(feedback); wlr_presentation_feedback_destroy(feedback);
} }
} else { } else {
feedback->committed = true; feedback->committed = true;
} }
} }
static void feedback_unset_surface(struct wlr_presentation_feedback *feedback) {
if (feedback->surface == NULL) {
return;
}
feedback->surface = NULL;
wl_list_remove(&feedback->surface_commit.link);
wl_list_remove(&feedback->surface_destroy.link);
}
static void feedback_handle_surface_destroy(struct wl_listener *listener, static void feedback_handle_surface_destroy(struct wl_listener *listener,
void *data) { void *data) {
struct wlr_presentation_feedback *feedback = struct wlr_presentation_feedback *feedback =
wl_container_of(listener, feedback, surface_destroy); wl_container_of(listener, feedback, surface_destroy);
feedback_send_discarded(feedback); if (feedback->sampled) {
// The compositor might have a handle on this feedback
feedback_unset_surface(feedback);
} else {
wlr_presentation_feedback_destroy(feedback);
}
} }
static const struct wp_presentation_interface presentation_impl; static const struct wp_presentation_interface presentation_impl;
@ -87,31 +89,29 @@ static struct wlr_presentation *presentation_from_resource(
} }
static void presentation_handle_feedback(struct wl_client *client, static void presentation_handle_feedback(struct wl_client *client,
struct wl_resource *resource, struct wl_resource *surface_resource, struct wl_resource *presentation_resource,
uint32_t id) { struct wl_resource *surface_resource, uint32_t id) {
struct wlr_presentation *presentation = struct wlr_presentation *presentation =
presentation_from_resource(resource); presentation_from_resource(presentation_resource);
struct wlr_surface *surface = wlr_surface_from_resource(surface_resource); struct wlr_surface *surface = wlr_surface_from_resource(surface_resource);
struct wlr_presentation_feedback *feedback = bool found = false;
calloc(1, sizeof(struct wlr_presentation_feedback)); struct wlr_presentation_feedback *feedback;
wl_list_for_each(feedback, &presentation->feedbacks, link) {
if (feedback->surface == surface && !feedback->committed) {
found = true;
break;
}
}
if (!found) {
feedback = calloc(1, sizeof(struct wlr_presentation_feedback));
if (feedback == NULL) { if (feedback == NULL) {
wl_client_post_no_memory(client); wl_client_post_no_memory(client);
return; return;
} }
uint32_t version = wl_resource_get_version(resource);
feedback->resource = wl_resource_create(client,
&wp_presentation_feedback_interface, version, id);
if (feedback->resource == NULL) {
free(feedback);
wl_client_post_no_memory(client);
return;
}
wl_resource_set_implementation(feedback->resource, NULL, feedback,
feedback_handle_resource_destroy);
feedback->surface = surface; feedback->surface = surface;
wl_list_init(&feedback->resources);
feedback->surface_commit.notify = feedback_handle_surface_commit; feedback->surface_commit.notify = feedback_handle_surface_commit;
wl_signal_add(&surface->events.commit, &feedback->surface_commit); wl_signal_add(&surface->events.commit, &feedback->surface_commit);
@ -120,6 +120,19 @@ static void presentation_handle_feedback(struct wl_client *client,
wl_signal_add(&surface->events.destroy, &feedback->surface_destroy); wl_signal_add(&surface->events.destroy, &feedback->surface_destroy);
wl_list_insert(&presentation->feedbacks, &feedback->link); wl_list_insert(&presentation->feedbacks, &feedback->link);
}
uint32_t version = wl_resource_get_version(presentation_resource);
struct wl_resource *resource = wl_resource_create(client,
&wp_presentation_feedback_interface, version, id);
if (resource == NULL) {
wl_client_post_no_memory(client);
return;
}
wl_resource_set_implementation(resource, NULL, feedback,
feedback_handle_resource_destroy);
wl_list_insert(&feedback->resources, wl_resource_get_link(resource));
} }
static void presentation_handle_destroy(struct wl_client *client, static void presentation_handle_destroy(struct wl_client *client,
@ -198,7 +211,7 @@ void wlr_presentation_destroy(struct wlr_presentation *presentation) {
struct wlr_presentation_feedback *feedback, *feedback_tmp; struct wlr_presentation_feedback *feedback, *feedback_tmp;
wl_list_for_each_safe(feedback, feedback_tmp, &presentation->feedbacks, wl_list_for_each_safe(feedback, feedback_tmp, &presentation->feedbacks,
link) { link) {
wl_resource_destroy(feedback->resource); wlr_presentation_feedback_destroy(feedback);
} }
struct wl_resource *resource, *resource_tmp; struct wl_resource *resource, *resource_tmp;
@ -211,27 +224,47 @@ void wlr_presentation_destroy(struct wlr_presentation *presentation) {
free(presentation); free(presentation);
} }
void wlr_presentation_send_surface_presented( void wlr_presentation_feedback_send_presented(
struct wlr_presentation *presentation, struct wlr_surface *surface, struct wlr_presentation_feedback *feedback,
struct wlr_presentation_event *event) { struct wlr_presentation_event *event) {
// TODO: maybe use a hashtable to optimize this function struct wl_resource *resource, *tmp;
struct wlr_presentation_feedback *feedback, *feedback_tmp; wl_resource_for_each_safe(resource, tmp, &feedback->resources) {
wl_list_for_each_safe(feedback, feedback_tmp, feedback_resource_send_presented(resource, event);
&presentation->feedbacks, link) {
if (feedback->surface == surface && feedback->sampled) {
feedback_send_presented(feedback, event);
}
} }
feedback->presented = true;
} }
void wlr_presentation_surface_sampled( struct wlr_presentation_feedback *wlr_presentation_surface_sampled(
struct wlr_presentation *presentation, struct wlr_surface *surface) { struct wlr_presentation *presentation, struct wlr_surface *surface) {
// TODO: maybe use a hashtable to optimize this function // TODO: maybe use a hashtable to optimize this function
struct wlr_presentation_feedback *feedback, *feedback_tmp; struct wlr_presentation_feedback *feedback, *feedback_tmp;
wl_list_for_each_safe(feedback, feedback_tmp, wl_list_for_each_safe(feedback, feedback_tmp,
&presentation->feedbacks, link) { &presentation->feedbacks, link) {
if (feedback->surface == surface && feedback->committed) { if (feedback->surface == surface && feedback->committed &&
!feedback->sampled) {
feedback->sampled = true; feedback->sampled = true;
return feedback;
} }
} }
return NULL;
}
void wlr_presentation_feedback_destroy(
struct wlr_presentation_feedback *feedback) {
if (feedback == NULL) {
return;
}
if (!feedback->presented) {
struct wl_resource *resource, *tmp;
wl_resource_for_each_safe(resource, tmp, &feedback->resources) {
feedback_resource_send_discarded(resource);
}
}
assert(wl_list_empty(&feedback->resources));
feedback_unset_surface(feedback);
wl_list_remove(&feedback->link);
free(feedback);
} }