1 /* 2 * Copyright (C) 2016 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 #pragma once 18 19 #include <utils/RefBase.h> 20 21 namespace android { 22 namespace uirenderer { 23 24 class FrameMetricsObserver : public VirtualLightRefBase { 25 public: 26 virtual void notify(const int64_t* buffer) = 0; waitForPresentTime()27 bool waitForPresentTime() const { return mWaitForPresentTime; }; 28 reportMetricsFrom(uint64_t frameNumber,int32_t surfaceControlId)29 void reportMetricsFrom(uint64_t frameNumber, int32_t surfaceControlId) { 30 mAttachedFrameNumber = frameNumber; 31 mSurfaceControlId = surfaceControlId; 32 }; attachedFrameNumber()33 uint64_t attachedFrameNumber() const { return mAttachedFrameNumber; }; attachedSurfaceControlId()34 int32_t attachedSurfaceControlId() const { return mSurfaceControlId; }; 35 36 /** 37 * Create a new metrics observer. An observer that watches present time gets notified at a 38 * different time than the observer that doesn't. 39 * 40 * The observer that doesn't want present time is notified about metrics just after the frame 41 * is completed. This is the default behaviour that's used by public API's. 42 * 43 * An observer that watches present time is notified about metrics after the actual display 44 * present time is known. 45 * WARNING! This observer may not receive metrics for the last several frames that the app 46 * produces. 47 */ FrameMetricsObserver(bool waitForPresentTime)48 FrameMetricsObserver(bool waitForPresentTime) 49 : mWaitForPresentTime(waitForPresentTime) 50 , mSurfaceControlId(INT32_MAX) 51 , mAttachedFrameNumber(UINT64_MAX) {} 52 53 private: 54 const bool mWaitForPresentTime; 55 56 // The id of the surface control (mSurfaceControlGenerationId in CanvasContext) 57 // for which the mAttachedFrameNumber applies to. We rely on this value being 58 // an increasing counter. We will report metrics: 59 // - for all frames if the frame comes from a surface with a surfaceControlId 60 // that is strictly greater than mSurfaceControlId. 61 // - for all frames with a frame number greater than or equal to mAttachedFrameNumber 62 // if the frame comes from a surface with a surfaceControlId that is equal to the 63 // mSurfaceControlId. 64 // We will never report metrics if the frame comes from a surface with a surfaceControlId 65 // that is strictly smaller than mSurfaceControlId. 66 int32_t mSurfaceControlId; 67 68 // The frame number the metrics observer was attached on. Metrics will be sent from this frame 69 // number (inclusive) onwards in the case that the surface id is equal to mSurfaceControlId. 70 uint64_t mAttachedFrameNumber; 71 }; 72 73 } // namespace uirenderer 74 } // namespace android 75