xref: /aosp_15_r20/external/drm_hwcomposer/hwc3/ComposerClient.h (revision 0a9764fe0a15e71ebbeb85e87e10990c23aab47f)
1 /*
2  * Copyright (C) 2024 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 <memory>
20 
21 #include "aidl/android/hardware/graphics/composer3/BnComposerClient.h"
22 #include "aidl/android/hardware/graphics/composer3/LayerCommand.h"
23 #include "hwc3/CommandResultWriter.h"
24 #include "hwc3/ComposerResources.h"
25 #include "hwc3/Utils.h"
26 #include "utils/Mutex.h"
27 
28 using AidlHdcpLevels = aidl::android::hardware::drm::HdcpLevels;
29 using AidlPixelFormat = aidl::android::hardware::graphics::common::PixelFormat;
30 using AidlNativeHandle = aidl::android::hardware::common::NativeHandle;
31 
32 namespace android {
33 
34 class HwcDisplay;
35 class HwcLayer;
36 
37 }  // namespace android
38 
39 namespace aidl::android::hardware::graphics::composer3::impl {
40 
41 class DrmHwcThree;
42 
43 class ComposerClient : public BnComposerClient {
44  public:
45   ComposerClient();
46   ~ComposerClient() override;
47 
48   bool Init();
49   std::string Dump();
50 
51   // composer3 interface
52   ndk::ScopedAStatus createLayer(int64_t display, int32_t buffer_slot_count,
53                                  int64_t* layer) override;
54   ndk::ScopedAStatus createVirtualDisplay(int32_t width, int32_t height,
55                                           AidlPixelFormat format_hint,
56                                           int32_t output_buffer_slot_count,
57                                           VirtualDisplay* display) override;
58   ndk::ScopedAStatus destroyLayer(int64_t display, int64_t layer) override;
59   ndk::ScopedAStatus destroyVirtualDisplay(int64_t display) override;
60   ndk::ScopedAStatus executeCommands(
61       const std::vector<DisplayCommand>& commands,
62       std::vector<CommandResultPayload>* results) override;
63   ndk::ScopedAStatus getActiveConfig(int64_t display, int32_t* config) override;
64   ndk::ScopedAStatus getColorModes(
65       int64_t display, std::vector<ColorMode>* color_modes) override;
66   ndk::ScopedAStatus getDataspaceSaturationMatrix(
67       common::Dataspace dataspace, std::vector<float>* matrix) override;
68   ndk::ScopedAStatus getDisplayAttribute(int64_t display, int32_t config,
69                                          DisplayAttribute attribute,
70                                          int32_t* value) override;
71   ndk::ScopedAStatus getDisplayCapabilities(
72       int64_t display, std::vector<DisplayCapability>* caps) override;
73   ndk::ScopedAStatus getDisplayConfigs(int64_t display,
74                                        std::vector<int32_t>* configs) override;
75   ndk::ScopedAStatus getDisplayConnectionType(
76       int64_t display, DisplayConnectionType* type) override;
77   ndk::ScopedAStatus getDisplayIdentificationData(
78       int64_t display, DisplayIdentification* id) override;
79   ndk::ScopedAStatus getDisplayName(int64_t display,
80                                     std::string* name) override;
81   ndk::ScopedAStatus getDisplayVsyncPeriod(int64_t display,
82                                            int32_t* vsync_period) override;
83   ndk::ScopedAStatus getDisplayedContentSample(
84       int64_t display, int64_t max_frames, int64_t timestamp,
85       DisplayContentSample* samples) override;
86   ndk::ScopedAStatus getDisplayedContentSamplingAttributes(
87       int64_t display, DisplayContentSamplingAttributes* attrs) override;
88   ndk::ScopedAStatus getDisplayPhysicalOrientation(
89       int64_t display, common::Transform* orientation) override;
90   ndk::ScopedAStatus getHdrCapabilities(int64_t display,
91                                         HdrCapabilities* caps) override;
92   ndk::ScopedAStatus getMaxVirtualDisplayCount(int32_t* count) override;
93   ndk::ScopedAStatus getPerFrameMetadataKeys(
94       int64_t display, std::vector<PerFrameMetadataKey>* keys) override;
95   ndk::ScopedAStatus getReadbackBufferAttributes(
96       int64_t display, ReadbackBufferAttributes* attrs) override;
97   ndk::ScopedAStatus getReadbackBufferFence(
98       int64_t display, ndk::ScopedFileDescriptor* acquire_fence) override;
99   ndk::ScopedAStatus getRenderIntents(
100       int64_t display, ColorMode mode,
101       std::vector<RenderIntent>* intents) override;
102   ndk::ScopedAStatus getSupportedContentTypes(
103       int64_t display, std::vector<ContentType>* types) override;
104   ndk::ScopedAStatus getDisplayDecorationSupport(
105       int64_t display,
106       std::optional<common::DisplayDecorationSupport>* support) override;
107   ndk::ScopedAStatus registerCallback(
108       const std::shared_ptr<IComposerCallback>& callback) override;
109   ndk::ScopedAStatus setActiveConfig(int64_t display, int32_t config) override;
110   ndk::ScopedAStatus setActiveConfigWithConstraints(
111       int64_t display, int32_t config,
112       const VsyncPeriodChangeConstraints& constraints,
113       VsyncPeriodChangeTimeline* timeline) override;
114   ndk::ScopedAStatus setBootDisplayConfig(int64_t display,
115                                           int32_t config) override;
116   ndk::ScopedAStatus clearBootDisplayConfig(int64_t display) override;
117   ndk::ScopedAStatus getPreferredBootDisplayConfig(int64_t display,
118                                                    int32_t* config) override;
119   ndk::ScopedAStatus setAutoLowLatencyMode(int64_t display, bool on) override;
120   ndk::ScopedAStatus setClientTargetSlotCount(int64_t display,
121                                               int32_t count) override;
122   ndk::ScopedAStatus setColorMode(int64_t display, ColorMode mode,
123                                   RenderIntent intent) override;
124   ndk::ScopedAStatus setContentType(int64_t display, ContentType type) override;
125   ndk::ScopedAStatus setDisplayedContentSamplingEnabled(
126       int64_t display, bool enable, FormatColorComponent component_mask,
127       int64_t max_frames) override;
128   ndk::ScopedAStatus setPowerMode(int64_t display, PowerMode mode) override;
129   ndk::ScopedAStatus setReadbackBuffer(
130       int64_t display, const AidlNativeHandle& buffer,
131       const ndk::ScopedFileDescriptor& release_fence) override;
132   ndk::ScopedAStatus setVsyncEnabled(int64_t display, bool enabled) override;
133   ndk::ScopedAStatus setIdleTimerEnabled(int64_t display,
134                                          int32_t timeout) override;
135 
136 #if __ANDROID_API__ >= 34
137 
138   ndk::ScopedAStatus getOverlaySupport(
139       OverlayProperties* out_overlay_properties) override;
140   ndk::ScopedAStatus getHdrConversionCapabilities(
141       std::vector<common::HdrConversionCapability>* out_capabilities) override;
142   ndk::ScopedAStatus setHdrConversionStrategy(
143       const common::HdrConversionStrategy& conversion_strategy,
144       common::Hdr* out_hdr) override;
145   ndk::ScopedAStatus setRefreshRateChangedCallbackDebugEnabled(
146       int64_t display, bool enabled) override;
147 
148 #endif
149 
150 #if __ANDROID_API__ >= 35
151 
152   ndk::ScopedAStatus getDisplayConfigurations(
153       int64_t display, int32_t max_frame_interval_ns,
154       std::vector<DisplayConfiguration>* configurations) override;
155   ndk::ScopedAStatus notifyExpectedPresent(
156       int64_t display, const ClockMonotonicTimestamp& expected_present_time,
157       int32_t frame_interval_ns) override;
158   ndk::ScopedAStatus startHdcpNegotiation(int64_t display,
159       const AidlHdcpLevels& levels) override;
160 
161 #endif
162 
163   ndk::ScopedAStatus getMaxLayerPictureProfiles(
164       int64_t display, int32_t* maxProfiles) override;
165   ndk::ScopedAStatus getLuts(int64_t, const std::vector<Buffer>&,
166                              std::vector<Luts>* out_luts) override;
167 
168  protected:
169   ::ndk::SpAIBinder createBinder() override;
170 
171  private:
172   hwc3::Error ImportLayerBuffer(int64_t display_id, int64_t layer_id,
173                                 const Buffer& buffer,
174                                 buffer_handle_t* out_imported_buffer);
175 
176   // Layer commands
177   void DispatchLayerCommand(int64_t display_id, const LayerCommand& command);
178 
179   // Display commands
180   void ExecuteDisplayCommand(const DisplayCommand& command);
181   void ExecuteSetDisplayColorTransform(uint64_t display_id,
182                                        const std::vector<float>& matrix);
183   void ExecuteSetDisplayClientTarget(uint64_t display_id,
184                                      const ClientTarget& command);
185   void ExecuteSetDisplayOutputBuffer(uint64_t display_id, const Buffer& buffer);
186   void ExecuteValidateDisplay(
187       int64_t display_id,
188       std::optional<ClockMonotonicTimestamp> expected_present_time);
189   void ExecuteAcceptDisplayChanges(int64_t display_id);
190   void ExecutePresentDisplay(int64_t display_id);
191   void ExecutePresentOrValidateDisplay(
192       int64_t display_id,
193       std::optional<ClockMonotonicTimestamp> expected_present_time);
194 
195   static hwc3::Error ValidateDisplayInternal(
196       ::android::HwcDisplay& display, std::vector<int64_t>* out_changed_layers,
197       std::vector<Composition>* out_composition_types,
198       int32_t* out_display_request_mask,
199       std::vector<int64_t>* out_requested_layers,
200       std::vector<int32_t>* out_request_masks,
201       ClientTargetProperty* out_client_target_property,
202       DimmingStage* out_dimming_stage);
203 
204   hwc3::Error PresentDisplayInternal(
205       uint64_t display_id, ::android::base::unique_fd& out_display_fence,
206       std::unordered_map<int64_t, ::android::base::unique_fd>&
207           out_release_fences);
208 
209   ::android::HwcDisplay* GetDisplay(uint64_t display_id);
210 
211   std::unique_ptr<CommandResultWriter> cmd_result_writer_;
212 
213   // Manages importing and caching gralloc buffers for displays and layers.
214   std::unique_ptr<ComposerResources> composer_resources_;
215 
216   std::unique_ptr<DrmHwcThree> hwc_;
217 };
218 
219 }  // namespace aidl::android::hardware::graphics::composer3::impl
220