Jesse Hall | 99c7dbb | 2013-03-14 14:29:29 -0700 | [diff] [blame] | 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 | |
Lloyd Pique | 542307f | 2018-10-19 13:24:08 -0700 | [diff] [blame] | 17 | #pragma once |
Jesse Hall | 99c7dbb | 2013-03-14 14:29:29 -0700 | [diff] [blame] | 18 | |
| 19 | #include <utils/Errors.h> |
| 20 | #include <utils/RefBase.h> |
| 21 | #include <utils/StrongPointer.h> |
| 22 | |
Jesse Hall | 99c7dbb | 2013-03-14 14:29:29 -0700 | [diff] [blame] | 23 | namespace android { |
Jesse Hall | 99c7dbb | 2013-03-14 14:29:29 -0700 | [diff] [blame] | 24 | |
Chia-I Wu | 06d63de | 2017-01-04 14:58:51 +0800 | [diff] [blame] | 25 | class Fence; |
Jesse Hall | 99c7dbb | 2013-03-14 14:29:29 -0700 | [diff] [blame] | 26 | class IGraphicBufferProducer; |
| 27 | class String8; |
| 28 | |
Lloyd Pique | 542307f | 2018-10-19 13:24:08 -0700 | [diff] [blame] | 29 | namespace compositionengine { |
| 30 | |
| 31 | /** |
| 32 | * An abstraction for working with a display surface (buffer queue) |
| 33 | */ |
Jesse Hall | 99c7dbb | 2013-03-14 14:29:29 -0700 | [diff] [blame] | 34 | class DisplaySurface : public virtual RefBase { |
| 35 | public: |
Lloyd Pique | 542307f | 2018-10-19 13:24:08 -0700 | [diff] [blame] | 36 | virtual ~DisplaySurface(); |
| 37 | |
Jesse Hall | 028dc8f | 2013-08-20 16:35:32 -0700 | [diff] [blame] | 38 | // beginFrame is called at the beginning of the composition loop, before |
| 39 | // the configuration is known. The DisplaySurface should do anything it |
| 40 | // needs to do to enable HWComposer to decide how to compose the frame. |
Dan Stoza | 7143316 | 2014-02-04 16:22:36 -0800 | [diff] [blame] | 41 | // We pass in mustRecompose so we can keep VirtualDisplaySurface's state |
| 42 | // machine happy without actually queueing a buffer if nothing has changed. |
| 43 | virtual status_t beginFrame(bool mustRecompose) = 0; |
Jesse Hall | 028dc8f | 2013-08-20 16:35:32 -0700 | [diff] [blame] | 44 | |
Jesse Hall | 38efe86 | 2013-04-06 23:12:29 -0700 | [diff] [blame] | 45 | // prepareFrame is called after the composition configuration is known but |
| 46 | // before composition takes place. The DisplaySurface can use the |
| 47 | // composition type to decide how to manage the flow of buffers between |
| 48 | // GLES and HWC for this frame. |
| 49 | enum CompositionType { |
| 50 | COMPOSITION_UNKNOWN = 0, |
Lloyd Pique | 542307f | 2018-10-19 13:24:08 -0700 | [diff] [blame] | 51 | COMPOSITION_GLES = 1, |
| 52 | COMPOSITION_HWC = 2, |
| 53 | COMPOSITION_MIXED = COMPOSITION_GLES | COMPOSITION_HWC |
Jesse Hall | 38efe86 | 2013-04-06 23:12:29 -0700 | [diff] [blame] | 54 | }; |
| 55 | virtual status_t prepareFrame(CompositionType compositionType) = 0; |
| 56 | |
Jesse Hall | 99c7dbb | 2013-03-14 14:29:29 -0700 | [diff] [blame] | 57 | // Inform the surface that GLES composition is complete for this frame, and |
| 58 | // the surface should make sure that HWComposer has the correct buffer for |
| 59 | // this frame. Some implementations may only push a new buffer to |
| 60 | // HWComposer if GLES composition took place, others need to push a new |
| 61 | // buffer on every frame. |
Jesse Hall | 7414965 | 2013-03-19 17:18:09 -0700 | [diff] [blame] | 62 | // |
| 63 | // advanceFrame must be followed by a call to onFrameCommitted before |
| 64 | // advanceFrame may be called again. |
Jesse Hall | 99c7dbb | 2013-03-14 14:29:29 -0700 | [diff] [blame] | 65 | virtual status_t advanceFrame() = 0; |
| 66 | |
Jesse Hall | 7414965 | 2013-03-19 17:18:09 -0700 | [diff] [blame] | 67 | // onFrameCommitted is called after the frame has been committed to the |
Jesse Hall | 851cfe8 | 2013-03-20 13:44:00 -0700 | [diff] [blame] | 68 | // hardware composer. The surface collects the release fence for this |
| 69 | // frame's buffer. |
| 70 | virtual void onFrameCommitted() = 0; |
Jesse Hall | 99c7dbb | 2013-03-14 14:29:29 -0700 | [diff] [blame] | 71 | |
Dan Stoza | f10c46e | 2014-11-11 10:32:31 -0800 | [diff] [blame] | 72 | virtual void dumpAsString(String8& result) const = 0; |
Jesse Hall | 99c7dbb | 2013-03-14 14:29:29 -0700 | [diff] [blame] | 73 | |
Michael Lentine | 47e4540 | 2014-07-18 15:34:25 -0700 | [diff] [blame] | 74 | virtual void resizeBuffers(const uint32_t w, const uint32_t h) = 0; |
| 75 | |
Dan Stoza | 9e56aa0 | 2015-11-02 13:00:03 -0800 | [diff] [blame] | 76 | virtual const sp<Fence>& getClientTargetAcquireFence() const = 0; |
Jesse Hall | 99c7dbb | 2013-03-14 14:29:29 -0700 | [diff] [blame] | 77 | }; |
| 78 | |
Lloyd Pique | 542307f | 2018-10-19 13:24:08 -0700 | [diff] [blame] | 79 | } // namespace compositionengine |
Jesse Hall | 99c7dbb | 2013-03-14 14:29:29 -0700 | [diff] [blame] | 80 | } // namespace android |