1 /* 2 * Copyright 2013 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 <ui/Size.h> 20 #include <utils/Errors.h> 21 #include <utils/RefBase.h> 22 #include <utils/StrongPointer.h> 23 24 namespace android { 25 26 class Fence; 27 class IGraphicBufferProducer; 28 class String8; 29 30 namespace compositionengine { 31 32 /** 33 * An abstraction for working with a display surface (buffer queue) 34 */ 35 class DisplaySurface : public virtual RefBase { 36 public: 37 virtual ~DisplaySurface(); 38 39 // beginFrame is called at the beginning of the composition loop, before 40 // the configuration is known. The DisplaySurface should do anything it 41 // needs to do to enable HWComposer to decide how to compose the frame. 42 // We pass in mustRecompose so we can keep VirtualDisplaySurface's state 43 // machine happy without actually queueing a buffer if nothing has changed. 44 virtual status_t beginFrame(bool mustRecompose) = 0; 45 46 // prepareFrame is called after the composition configuration is known but 47 // before composition takes place. The DisplaySurface can use the 48 // composition type to decide how to manage the flow of buffers between 49 // GPU and HWC for this frame. 50 enum CompositionType { 51 COMPOSITION_UNKNOWN = 0, 52 COMPOSITION_GPU = 1, 53 COMPOSITION_HWC = 2, 54 COMPOSITION_MIXED = COMPOSITION_GPU | COMPOSITION_HWC 55 }; 56 virtual status_t prepareFrame(CompositionType compositionType) = 0; 57 58 // Inform the surface that GPU composition is complete for this frame, and 59 // the surface should make sure that HWComposer has the correct buffer for 60 // this frame. Some implementations may only push a new buffer to 61 // HWComposer if GPU composition took place, others need to push a new 62 // buffer on every frame. 63 // 64 // advanceFrame must be followed by a call to onFrameCommitted before 65 // advanceFrame may be called again. 66 virtual status_t advanceFrame() = 0; 67 68 // onFrameCommitted is called after the frame has been committed to the 69 // hardware composer. The surface collects the release fence for this 70 // frame's buffer. 71 virtual void onFrameCommitted() = 0; 72 73 virtual void dumpAsString(String8& result) const = 0; 74 75 virtual void resizeBuffers(const ui::Size&) = 0; 76 77 virtual const sp<Fence>& getClientTargetAcquireFence() const = 0; 78 }; 79 80 } // namespace compositionengine 81 } // namespace android 82