• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2021 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  * Idealy IComposerHal should use aidl NativeHandle not native_handle_t/buffer_handle_t.
20  * However current patten is the HWC lib does not own buffer resources (HWC lib
21  * does own the fences).
22  */
23 #include <aidl/android/hardware/common/NativeHandle.h>
24 #include <aidl/android/hardware/graphics/common/BlendMode.h>
25 #include <aidl/android/hardware/graphics/common/ColorTransform.h>
26 #include <aidl/android/hardware/graphics/common/Dataspace.h>
27 #include <aidl/android/hardware/graphics/common/FRect.h>
28 #include <aidl/android/hardware/graphics/common/Hdr.h>
29 #include <aidl/android/hardware/graphics/common/HdrConversionCapability.h>
30 #include <aidl/android/hardware/graphics/common/HdrConversionStrategy.h>
31 #include <aidl/android/hardware/graphics/common/PixelFormat.h>
32 #include <aidl/android/hardware/graphics/common/Point.h>
33 #include <aidl/android/hardware/graphics/common/Rect.h>
34 #include <aidl/android/hardware/graphics/common/Transform.h>
35 #include <aidl/android/hardware/graphics/composer3/Buffer.h>
36 #include <aidl/android/hardware/graphics/composer3/Capability.h>
37 #include <aidl/android/hardware/graphics/composer3/ChangedCompositionTypes.h>
38 #include <aidl/android/hardware/graphics/composer3/ClientTarget.h>
39 #include <aidl/android/hardware/graphics/composer3/ClientTargetProperty.h>
40 #include <aidl/android/hardware/graphics/composer3/ClientTargetPropertyWithBrightness.h>
41 #include <aidl/android/hardware/graphics/composer3/Color.h>
42 #include <aidl/android/hardware/graphics/composer3/ColorMode.h>
43 #include <aidl/android/hardware/graphics/composer3/CommandError.h>
44 #include <aidl/android/hardware/graphics/composer3/CommandResultPayload.h>
45 #include <aidl/android/hardware/graphics/composer3/Composition.h>
46 #include <aidl/android/hardware/graphics/composer3/ContentType.h>
47 #include <aidl/android/hardware/graphics/composer3/DimmingStage.h>
48 #include <aidl/android/hardware/graphics/composer3/DisplayAttribute.h>
49 #include <aidl/android/hardware/graphics/composer3/DisplayBrightness.h>
50 #include <aidl/android/hardware/graphics/composer3/DisplayCapability.h>
51 #include <aidl/android/hardware/graphics/composer3/DisplayCommand.h>
52 #include <aidl/android/hardware/graphics/composer3/DisplayConnectionType.h>
53 #include <aidl/android/hardware/graphics/composer3/DisplayContentSample.h>
54 #include <aidl/android/hardware/graphics/composer3/DisplayContentSamplingAttributes.h>
55 #include <aidl/android/hardware/graphics/composer3/DisplayIdentification.h>
56 #include <aidl/android/hardware/graphics/composer3/DisplayRequest.h>
57 #include <aidl/android/hardware/graphics/composer3/FormatColorComponent.h>
58 #include <aidl/android/hardware/graphics/composer3/HdrCapabilities.h>
59 #include <aidl/android/hardware/graphics/composer3/LayerBrightness.h>
60 #include <aidl/android/hardware/graphics/composer3/LayerCommand.h>
61 #include <aidl/android/hardware/graphics/composer3/OverlayProperties.h>
62 #include <aidl/android/hardware/graphics/composer3/ParcelableBlendMode.h>
63 #include <aidl/android/hardware/graphics/composer3/ParcelableComposition.h>
64 #include <aidl/android/hardware/graphics/composer3/ParcelableDataspace.h>
65 #include <aidl/android/hardware/graphics/composer3/ParcelableTransform.h>
66 #include <aidl/android/hardware/graphics/composer3/PerFrameMetadata.h>
67 #include <aidl/android/hardware/graphics/composer3/PerFrameMetadataBlob.h>
68 #include <aidl/android/hardware/graphics/composer3/PerFrameMetadataKey.h>
69 #include <aidl/android/hardware/graphics/composer3/PlaneAlpha.h>
70 #include <aidl/android/hardware/graphics/composer3/PowerMode.h>
71 #include <aidl/android/hardware/graphics/composer3/PresentFence.h>
72 #include <aidl/android/hardware/graphics/composer3/PresentOrValidate.h>
73 #include <aidl/android/hardware/graphics/composer3/ReadbackBufferAttributes.h>
74 #include <aidl/android/hardware/graphics/composer3/RefreshRateChangedDebugData.h>
75 #include <aidl/android/hardware/graphics/composer3/ReleaseFences.h>
76 #include <aidl/android/hardware/graphics/composer3/RenderIntent.h>
77 #include <aidl/android/hardware/graphics/composer3/VirtualDisplay.h>
78 #include <aidl/android/hardware/graphics/composer3/VsyncPeriodChangeConstraints.h>
79 #include <aidl/android/hardware/graphics/composer3/VsyncPeriodChangeTimeline.h>
80 #include <aidl/android/hardware/graphics/composer3/ZOrder.h>
81 #include <cutils/native_handle.h>
82 
83 // avoid naming conflict
84 using AidlPixelFormat = aidl::android::hardware::graphics::common::PixelFormat;
85 using AidlNativeHandle = aidl::android::hardware::common::NativeHandle;
86 
87 namespace aidl::android::hardware::graphics::composer3::impl {
88 
89 // Abstraction of ComposerHal. Returned error code is compatible with AIDL
90 // IComposerClient interface.
91 class IComposerHal {
92  public:
93     static std::unique_ptr<IComposerHal> create();
94     virtual ~IComposerHal() = default;
95 
96     virtual void getCapabilities(std::vector<Capability>* caps) = 0;
97     virtual void dumpDebugInfo(std::string* output) = 0;
98     virtual bool hasCapability(Capability cap) = 0;
99 
100     class EventCallback {
101       public:
102         virtual ~EventCallback() = default;
103         virtual void onHotplug(int64_t display, bool connected) = 0;
104         virtual void onRefresh(int64_t display) = 0;
105         virtual void onVsync(int64_t display, int64_t timestamp, int32_t vsyncPeriodNanos) = 0;
106         virtual void onVsyncPeriodTimingChanged(int64_t display,
107                                                 const VsyncPeriodChangeTimeline& timeline) = 0;
108         virtual void onVsyncIdle(int64_t display) = 0;
109         virtual void onSeamlessPossible(int64_t display) = 0;
110         virtual void onRefreshRateChangedDebug(const RefreshRateChangedDebugData& data) = 0;
111     };
112     virtual void registerEventCallback(EventCallback* callback) = 0;
113     virtual void unregisterEventCallback() = 0;
114 
115     virtual int32_t acceptDisplayChanges(int64_t display) = 0;
116     virtual int32_t createLayer(int64_t display, int64_t* outLayer) = 0;
117     virtual int32_t createVirtualDisplay(uint32_t width, uint32_t height, AidlPixelFormat format,
118                                          VirtualDisplay* outDisplay) = 0;
119     virtual int32_t destroyLayer(int64_t display, int64_t layer) = 0;
120     virtual int32_t destroyVirtualDisplay(int64_t display) = 0;
121     virtual int32_t flushDisplayBrightnessChange(int64_t display) = 0;
122     virtual int32_t getActiveConfig(int64_t display, int32_t* outConfig) = 0;
123     virtual int32_t getColorModes(int64_t display, std::vector<ColorMode>* outModes) = 0;
124     virtual int32_t getDataspaceSaturationMatrix(common::Dataspace dataspace,
125                                                  std::vector<float>* matrix) = 0;
126     virtual int32_t getDisplayAttribute(int64_t display, int32_t config,
127                                       DisplayAttribute attribute, int32_t* outValue) = 0;
128     virtual int32_t getDisplayBrightnessSupport(int64_t display, bool& outSupport) = 0;
129     virtual int32_t getDisplayIdleTimerSupport(int64_t display, bool& outSupport) = 0;
130     virtual int32_t getDisplayMultiThreadedPresentSupport(const int64_t& display,
131                                                           bool& outSupport) = 0;
132     virtual int32_t getDisplayCapabilities(int64_t display,
133                                            std::vector<DisplayCapability>* caps) = 0;
134     virtual int32_t getDisplayConfigs(int64_t display, std::vector<int32_t>* configs) = 0;
135     virtual int32_t getDisplayConnectionType(int64_t display, DisplayConnectionType* outType) = 0;
136     virtual int32_t getDisplayIdentificationData(int64_t display, DisplayIdentification *id) = 0;
137     virtual int32_t getDisplayName(int64_t display, std::string* outName) = 0;
138     virtual int32_t getDisplayVsyncPeriod(int64_t display, int32_t* outVsyncPeriod) = 0;
139     virtual int32_t getDisplayedContentSample(int64_t display, int64_t maxFrames,
140                                             int64_t timestamp, DisplayContentSample* samples) = 0;
141     virtual int32_t getDisplayedContentSamplingAttributes(
142             int64_t display, DisplayContentSamplingAttributes* attrs) = 0;
143     virtual int32_t getDisplayPhysicalOrientation(int64_t display,
144                                                   common::Transform* orientation) = 0;
145     virtual int32_t getDozeSupport(int64_t display, bool& outSupport) = 0;
146     virtual int32_t getHdrCapabilities(int64_t display, HdrCapabilities* caps) = 0;
147     virtual int32_t getOverlaySupport(OverlayProperties* caps) = 0;
148     virtual int32_t getMaxVirtualDisplayCount(int32_t* count) = 0;
149     virtual int32_t getPerFrameMetadataKeys(int64_t display,
150                                             std::vector<PerFrameMetadataKey>* keys) = 0;
151     virtual int32_t getReadbackBufferAttributes(int64_t display,
152                                                 ReadbackBufferAttributes* attrs) = 0;
153     virtual int32_t getReadbackBufferFence(int64_t display,
154                                            ndk::ScopedFileDescriptor* aqcuireFence) = 0;
155     virtual int32_t getRenderIntents(int64_t display, ColorMode mode,
156                                      std::vector<RenderIntent>* intents) = 0;
157     virtual int32_t getSupportedContentTypes(int64_t display, std::vector<ContentType>* types) = 0;
158     virtual int32_t presentDisplay(int64_t display, ndk::ScopedFileDescriptor& fence,
159                                    std::vector<int64_t>* outLayers,
160                                    std::vector<ndk::ScopedFileDescriptor>* outReleaseFences) = 0;
161     virtual int32_t setActiveConfig(int64_t display, int32_t config) = 0;
162     virtual int32_t setActiveConfigWithConstraints(
163             int64_t display, int32_t config,
164             const VsyncPeriodChangeConstraints& vsyncPeriodChangeConstraints,
165             VsyncPeriodChangeTimeline* timeline) = 0;
166     virtual int32_t setBootDisplayConfig(int64_t display, int32_t config) = 0;
167     virtual int32_t clearBootDisplayConfig(int64_t display) = 0;
168     virtual int32_t getPreferredBootDisplayConfig(int64_t display, int32_t* config) = 0;
169     virtual int32_t getHdrConversionCapabilities(std::vector<common::HdrConversionCapability>*) = 0;
170     virtual int32_t setHdrConversionStrategy(const common::HdrConversionStrategy&,
171                                              common::Hdr*) = 0;
172     virtual int32_t setAutoLowLatencyMode(int64_t display, bool on) = 0;
173     virtual int32_t setClientTarget(int64_t display, buffer_handle_t target,
174                                     const ndk::ScopedFileDescriptor& fence,
175                                     common::Dataspace dataspace,
176                                     const std::vector<common::Rect>& damage) = 0; // cmd
177     virtual int32_t getHasClientComposition(int64_t display, bool& outHasClientComp) = 0;
178     virtual int32_t setColorMode(int64_t display, ColorMode mode, RenderIntent intent) = 0;
179     virtual int32_t setColorTransform(int64_t display, const std::vector<float>& matrix) = 0; // cmd
180     virtual int32_t setContentType(int64_t display, ContentType contentType) = 0;
181     virtual int32_t setDisplayBrightness(int64_t display, float brightness) = 0;
182     virtual int32_t setDisplayedContentSamplingEnabled(int64_t display, bool enable,
183                                                        FormatColorComponent componentMask,
184                                                        int64_t maxFrames) = 0;
185     virtual int32_t setLayerBlendMode(int64_t display, int64_t layer, common::BlendMode mode) = 0;
186     virtual int32_t setLayerBuffer(int64_t display, int64_t layer, buffer_handle_t buffer,
187                                    const ndk::ScopedFileDescriptor& acquireFence) = 0;
188     virtual int32_t setLayerColor(int64_t display, int64_t layer, Color color) = 0;
189     virtual int32_t setLayerColorTransform(int64_t display, int64_t layer,
190                                            const std::vector<float>& matrix) = 0;
191     virtual int32_t setLayerCompositionType(int64_t display, int64_t layer, Composition type) = 0;
192     virtual int32_t setLayerCursorPosition(int64_t display, int64_t layer, int32_t x,
193                                            int32_t y) = 0;
194     virtual int32_t setLayerDataspace(int64_t display, int64_t layer,
195                                       common::Dataspace dataspace) = 0;
196     virtual int32_t setLayerDisplayFrame(int64_t display, int64_t layer,
197                                          const common::Rect& frame) = 0;
198     virtual int32_t setLayerPerFrameMetadata(int64_t display, int64_t layer,
199                             const std::vector<std::optional<PerFrameMetadata>>& metadata) = 0;
200     virtual int32_t setLayerPerFrameMetadataBlobs(int64_t display, int64_t layer,
201                             const std::vector<std::optional<PerFrameMetadataBlob>>& blobs) = 0;
202     virtual int32_t setLayerPlaneAlpha(int64_t display, int64_t layer, float alpha) = 0;
203     virtual int32_t setLayerSidebandStream(int64_t display, int64_t layer,
204                                            buffer_handle_t stream) = 0;
205     virtual int32_t setLayerSourceCrop(int64_t display, int64_t layer,
206                                        const common::FRect& crop) = 0;
207     virtual int32_t setLayerSurfaceDamage(int64_t display, int64_t layer,
208                         const std::vector<std::optional<common::Rect>>& damage) = 0;
209     virtual int32_t setLayerTransform(int64_t display, int64_t layer,
210                                       common::Transform transform) = 0;
211     virtual int32_t setLayerVisibleRegion(int64_t display, int64_t layer,
212                                  const std::vector<std::optional<common::Rect>>& visible) = 0;
213     virtual int32_t setLayerBrightness(int64_t display, int64_t layer, float brightness) = 0;
214     virtual int32_t setLayerZOrder(int64_t display, int64_t layer, uint32_t z) = 0;
215     virtual int32_t setOutputBuffer(int64_t display, buffer_handle_t buffer,
216                                     const ndk::ScopedFileDescriptor& releaseFence) = 0;
217     virtual int32_t setPowerMode(int64_t display, PowerMode mode) = 0;
218     virtual int32_t setReadbackBuffer(int64_t display, buffer_handle_t buffer,
219                                       const ndk::ScopedFileDescriptor& releaseFence) = 0;
220     virtual int32_t setVsyncEnabled(int64_t display, bool enabled) = 0;
221     virtual int32_t validateDisplay(int64_t display, std::vector<int64_t>* outChangedLayers,
222                                     std::vector<Composition>* outCompositionTypes,
223                                     uint32_t* outDisplayRequestMask,
224                                     std::vector<int64_t>* outRequestedLayers,
225                                     std::vector<int32_t>* outRequestMasks,
226                                     ClientTargetProperty* outClientTargetProperty,
227                                     DimmingStage* outDimmingStage) = 0;
228     virtual int32_t setExpectedPresentTime(
229             int64_t display, const std::optional<ClockMonotonicTimestamp> expectedPresentTime) = 0;
230     virtual int32_t setIdleTimerEnabled(int64_t display, int32_t timeout) = 0;
231     virtual int32_t getRCDLayerSupport(int64_t display, bool& outSupport) = 0;
232     virtual int32_t setLayerBlockingRegion(
233             int64_t display, int64_t layer,
234             const std::vector<std::optional<common::Rect>>& blockingRegion) = 0;
235     virtual int32_t setRefreshRateChangedCallbackDebugEnabled(int64_t display, bool enabled) = 0;
236 };
237 
238 } // namespace aidl::android::hardware::graphics::composer3::detail
239