blob: 145e8400b035de1d2ce7f350fd1490a537269e1b [file] [log] [blame]
// Copyright 2019 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef ASH_PUBLIC_CPP_PRESENTATION_TIME_RECORDER_H_
#define ASH_PUBLIC_CPP_PRESENTATION_TIME_RECORDER_H_
#include "ash/public/cpp/ash_public_export.h"
#include "base/gtest_prod_util.h"
#include "base/macros.h"
#include "base/memory/weak_ptr.h"
#include "base/metrics/histogram_macros.h"
#include "base/time/time.h"
#include "ui/compositor/compositor.h"
#include "ui/display/display.h"
namespace ash {
// PresentationTimeRecorder records the time between when an UI update is
// requested, and the requested UI change has been presented to the user
// (screen). This measure the longest presentation time for each commit by
// skipping updates made after the last request and next commit. Use this if
// you want to measure the drawing performance in continuous operation that
// doesn't involve animations (such as window dragging). Call |RequestNext()|
// when you made modification to UI that should expect it will be presented.
// TODO(oshima): Move this to ash/metrics after crbug.com/942564 is resolved.
class ASH_PUBLIC_EXPORT PresentationTimeRecorder {
public:
class PresentationTimeRecorderInternal;
class TestApi {
public:
explicit TestApi(PresentationTimeRecorder* recorder);
void OnCompositingDidCommit(ui::Compositor* compositor);
void OnPresented(int count,
base::TimeTicks requested_time,
const gfx::PresentationFeedback& feedback);
int GetMaxLatencyMs() const;
int GetSuccessCount() const;
int GetFailureRatio() const;
private:
PresentationTimeRecorder* recorder_;
DISALLOW_COPY_AND_ASSIGN(TestApi);
};
explicit PresentationTimeRecorder(
std::unique_ptr<PresentationTimeRecorderInternal> internal);
~PresentationTimeRecorder();
// Start recording next frame. It skips requesting next frame and returns
// false if the previous frame has not been committed yet.
bool RequestNext();
// Enable this to report the presentation time immediately with
// fake value when RequestNext is called.
static void SetReportPresentationTimeImmediatelyForTest(bool enable);
private:
std::unique_ptr<PresentationTimeRecorderInternal> recorder_internal_;
DISALLOW_COPY_AND_ASSIGN(PresentationTimeRecorder);
};
// Creates a PresentationTimeRecorder that records timing histograms of
// presentation time and max latency. The time range is 1 to 200 ms, with 50
// buckets.
ASH_PUBLIC_EXPORT std::unique_ptr<PresentationTimeRecorder>
CreatePresentationTimeHistogramRecorder(
ui::Compositor* compositor,
const char* presentation_time_histogram_name,
const char* max_latency_histogram_name);
} // namespace ash
#endif // ASH_PUBLIC_CPP_PRESENTATION_TIME_RECORDER_H_