components/exo/wayland/clients/simple.cc

// Copyright 2017 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.


#include "components/exo/wayland/clients/simple.h"

#include <presentation-time-client-protocol.h>
#include <single-pixel-buffer-v1-client-protocol.h>

#include <algorithm>
#include <climits>
#include <cstdint>
#include <iostream>

#include "base/command_line.h"
#include "base/containers/circular_deque.h"
#include "base/time/time.h"
#include "components/exo/wayland/clients/client_helper.h"
#include "third_party/skia/include/core/SkCanvas.h"
#include "third_party/skia/include/core/SkSurface.h"
#include "third_party/skia/include/gpu/ganesh/GrDirectContext.h"
#include "ui/gl/gl_bindings.h"

namespace exo {
namespace wayland {
namespace clients {
namespace {

void FrameCallback(void* data, wl_callback* callback, uint32_t time) {
  bool* frame_callback_pending = static_cast<bool*>(data);
  *frame_callback_pending = false;
}

struct Frame {
  base::TimeTicks submit_time;
  std::unique_ptr<struct wp_presentation_feedback> feedback;
};

struct Presentation {
  base::circular_deque<Frame> submitted_frames;
  Simple::PresentationFeedback feedback;
};

void FeedbackSyncOutput(void* data,
                        struct wp_presentation_feedback* feedback,
                        wl_output* output) {}

void FeedbackPresented(void* data,
                       struct wp_presentation_feedback* feedback,
                       uint32_t tv_sec_hi,
                       uint32_t tv_sec_lo,
                       uint32_t tv_nsec,
                       uint32_t refresh,
                       uint32_t seq_hi,
                       uint32_t seq_lo,
                       uint32_t flags) {
  Presentation* presentation = static_cast<Presentation*>(data);
  DCHECK_GT(presentation->submitted_frames.size(), 0u);

  Frame& frame = presentation->submitted_frames.front();
  DCHECK_EQ(frame.feedback.get(), feedback);

  int64_t seconds = (static_cast<int64_t>(tv_sec_hi) << 32) + tv_sec_lo;
  int64_t microseconds = seconds * base::Time::kMicrosecondsPerSecond +
                         tv_nsec / base::Time::kNanosecondsPerMicrosecond;
  base::TimeTicks presentation_time =
      base::TimeTicks() + base::Microseconds(microseconds);
  presentation->feedback.total_presentation_latency +=
      presentation_time - frame.submit_time;
  ++presentation->feedback.num_frames_presented;
  presentation->submitted_frames.pop_front();
}

void FeedbackDiscarded(void* data, struct wp_presentation_feedback* feedback) {
  Presentation* presentation = static_cast<Presentation*>(data);
  DCHECK_GT(presentation->submitted_frames.size(), 0u);
  auto it =
      std::ranges::find(presentation->submitted_frames, feedback,
                        [](Frame& frame) { return frame.feedback.get(); });
  CHECK(it != presentation->submitted_frames.end());
  presentation->submitted_frames.erase(it);
}

void VSyncTimingUpdate(void* data,
                       struct zcr_vsync_timing_v1* zcr_vsync_timing_v1,
                       uint32_t timebase_l,
                       uint32_t timebase_h,
                       uint32_t interval_l,
                       uint32_t interval_h) {
  uint64_t timebase = static_cast<uint64_t>(timebase_h) << 32 | timebase_l;
  uint64_t interval = static_cast<uint64_t>(interval_h) << 32 | interval_l;
  std::cout << "Received new VSyncTimingUpdate. Timebase: " << timebase
            << ". Interval: " << interval << std::endl;
}

}  // namespace

Simple::Simple() = default;

void Simple::Run(int frames,
                 const RunParam& run_param,
                 PresentationFeedback* feedback) {
  wl_display_roundtrip(display_.get());
  // We always send this bug fix ID as a sanity check.
  DCHECK(bug_fix_ids_.find(1151508) != bug_fix_ids_.end());

  wl_callback_listener frame_listener = {FrameCallback};
  wp_presentation_feedback_listener feedback_listener = {
      FeedbackSyncOutput, FeedbackPresented, FeedbackDiscarded};

  std::unique_ptr<zcr_vsync_timing_v1> vsync_timing;
  if (run_param.log_vsync_timing_updates) {
    if (globals_.vsync_feedback) {
      vsync_timing.reset(zcr_vsync_feedback_v1_get_vsync_timing(
          globals_.vsync_feedback.get(), globals_.outputs.back().get()));
      DCHECK(vsync_timing);
      static zcr_vsync_timing_v1_listener vsync_timing_listener = {
          VSyncTimingUpdate};
      zcr_vsync_timing_v1_add_listener(vsync_timing.get(),
                                       &vsync_timing_listener, this);
    } else {
      LOG(WARNING)
          << "VSync timing updates requested but zcr_vsync_feedback_v1 "
             "protocol is not available on the server.";
    }
  }

  Presentation presentation;
  int frame_count = 0;

  std::unique_ptr<wl_callback> frame_callback;
  bool frame_callback_pending = false;
  wp_viewport* viewport =
      wp_viewporter_get_viewport(globals_.wp_viewporter.get(), surface_.get());

  int dispatch_res = 0;
  do {
    DCHECK(dispatch_res != -1);

    if (frame_callback_pending)
      continue;

    if (frame_count == frames)
      break;

    wl_buffer* buffer;
    static const SkColor kColors[] = {SK_ColorRED, SK_ColorBLACK};
    SkColor color = kColors[++frame_count % std::size(kColors)];
    if (run_param.single_pixel_buffer) {
      SkColor4f precise_color = SkColor4f::FromColor(color);
      // Single Pixel Buffer protocol uses premultiplied color.
      uint32_t red =
          UINT_MAX * (double)precise_color.fR * (double)precise_color.fA;
      uint32_t green =
          UINT_MAX * (double)precise_color.fG * (double)precise_color.fA;
      uint32_t blue =
          UINT_MAX * (double)precise_color.fB * (double)precise_color.fA;
      uint32_t alpha = UINT_MAX * (double)precise_color.fA;
      buffer = wp_single_pixel_buffer_manager_v1_create_u32_rgba_buffer(
          globals_.wp_single_pixel_buffer_manager_v1.get(), red, green, blue,
          alpha);
      wp_viewport_set_destination(viewport, surface_size_.width(),
                                  surface_size_.height());
    } else {
      Buffer* dequeued_buffer = DequeueBuffer();
      if (!dequeued_buffer) {
        continue;
      }

      SkCanvas* canvas = dequeued_buffer->sk_surface->getCanvas();

      canvas->clear(color);
      buffer = dequeued_buffer->buffer.get();
    }

    if (gr_context_) {
      gr_context_->flushAndSubmit();
      glFinish();
    }

    wl_surface_set_buffer_scale(surface_.get(), scale_);
    wl_surface_set_buffer_transform(surface_.get(), transform_);
    wl_surface_damage(surface_.get(), 0, 0, surface_size_.width(),
                      surface_size_.height());

    wl_surface_attach(surface_.get(), buffer, 0, 0);

    // Set up the frame callback.
    frame_callback_pending = true;
    frame_callback.reset(wl_surface_frame(surface_.get()));
    wl_callback_add_listener(frame_callback.get(), &frame_listener,
                             &frame_callback_pending);

    // Set up presentation feedback.
    Frame frame;
    frame.feedback.reset(
        wp_presentation_feedback(globals_.presentation.get(), surface_.get()));
    wp_presentation_feedback_add_listener(frame.feedback.get(),
                                          &feedback_listener, &presentation);
    frame.submit_time = base::TimeTicks::Now();
    presentation.submitted_frames.push_back(std::move(frame));

    wl_surface_commit(surface_.get());
    wl_display_flush(display_.get());
  } while ((dispatch_res = wl_display_dispatch(display_.get())));

  wp_viewport_destroy(viewport);

  if (feedback)
    *feedback = presentation.feedback;
}

}  // namespace clients
}  // namespace wayland
}  // namespace exo