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 #include "FrameInfo.h" 22 23 namespace android { 24 namespace uirenderer { 25 26 class FrameMetricsObserver : public VirtualLightRefBase { 27 public: 28 virtual void notify(const FrameInfoBuffer& buffer) = 0; waitForPresentTime()29 bool waitForPresentTime() const { return mWaitForPresentTime; }; 30 reportMetricsFrom(uint64_t frameNumber,int32_t surfaceControlId)31 void reportMetricsFrom(uint64_t frameNumber, int32_t surfaceControlId) { 32 mAttachedFrameNumber = frameNumber; 33 mSurfaceControlId = surfaceControlId; 34 }; attachedFrameNumber()35 uint64_t attachedFrameNumber() const { return mAttachedFrameNumber; }; attachedSurfaceControlId()36 int32_t attachedSurfaceControlId() const { return mSurfaceControlId; }; 37 38 /** 39 * Create a new metrics observer. An observer that watches present time gets notified at a 40 * different time than the observer that doesn't. 41 * 42 * The observer that doesn't want present time is notified about metrics just after the frame 43 * is completed. This is the default behaviour that's used by public API's. 44 * 45 * An observer that watches present time is notified about metrics after the actual display 46 * present time is known. 47 * WARNING! This observer may not receive metrics for the last several frames that the app 48 * produces. 49 */ FrameMetricsObserver(bool waitForPresentTime)50 FrameMetricsObserver(bool waitForPresentTime) 51 : mWaitForPresentTime(waitForPresentTime) 52 , mSurfaceControlId(INT32_MAX) 53 , mAttachedFrameNumber(UINT64_MAX) {} 54 55 private: 56 const bool mWaitForPresentTime; 57 58 // The id of the surface control (mSurfaceControlGenerationId in CanvasContext) 59 // for which the mAttachedFrameNumber applies to. We rely on this value being 60 // an increasing counter. We will report metrics: 61 // - for all frames if the frame comes from a surface with a surfaceControlId 62 // that is strictly greater than mSurfaceControlId. 63 // - for all frames with a frame number greater than or equal to mAttachedFrameNumber 64 // if the frame comes from a surface with a surfaceControlId that is equal to the 65 // mSurfaceControlId. 66 // We will never report metrics if the frame comes from a surface with a surfaceControlId 67 // that is strictly smaller than mSurfaceControlId. 68 int32_t mSurfaceControlId; 69 70 // The frame number the metrics observer was attached on. Metrics will be sent from this frame 71 // number (inclusive) onwards in the case that the surface id is equal to mSurfaceControlId. 72 uint64_t mAttachedFrameNumber; 73 }; 74 75 } // namespace uirenderer 76 } // namespace android 77