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 #ifndef SF_RENDERENGINE_H_ 18 #define SF_RENDERENGINE_H_ 19 20 #include <memory> 21 22 #include <stdint.h> 23 #include <sys/types.h> 24 25 #include <EGL/egl.h> 26 #include <EGL/eglext.h> 27 #include <Transform.h> 28 #include <android-base/unique_fd.h> 29 #include <gui/SurfaceControl.h> 30 #include <math/mat4.h> 31 32 #define EGL_NO_CONFIG ((EGLConfig)0) 33 34 struct ANativeWindowBuffer; 35 36 // --------------------------------------------------------------------------- 37 namespace android { 38 // --------------------------------------------------------------------------- 39 40 class String8; 41 class Rect; 42 class Region; 43 class Mesh; 44 class Texture; 45 46 namespace RE { 47 48 class Image; 49 class Surface; 50 class BindNativeBufferAsFramebuffer; 51 52 namespace impl { 53 class RenderEngine; 54 } 55 56 class RenderEngine { 57 public: 58 enum FeatureFlag { 59 WIDE_COLOR_SUPPORT = 1 << 0 // Platform has a wide color display 60 }; 61 62 virtual ~RenderEngine() = 0; 63 64 virtual std::unique_ptr<RE::Surface> createSurface() = 0; 65 virtual std::unique_ptr<RE::Image> createImage() = 0; 66 67 virtual void primeCache() const = 0; 68 69 // dump the extension strings. always call the base class. 70 virtual void dump(String8& result) = 0; 71 72 virtual bool supportsImageCrop() const = 0; 73 74 virtual bool isCurrent() const = 0; 75 virtual bool setCurrentSurface(const RE::Surface& surface) = 0; 76 virtual void resetCurrentSurface() = 0; 77 78 // helpers 79 // flush submits RenderEngine command stream for execution and returns a 80 // native fence fd that is signaled when the execution has completed. It 81 // returns -1 on errors. 82 virtual base::unique_fd flush() = 0; 83 // finish waits until RenderEngine command stream has been executed. It 84 // returns false on errors. 85 virtual bool finish() = 0; 86 // waitFence inserts a wait on an external fence fd to RenderEngine 87 // command stream. It returns false on errors. 88 virtual bool waitFence(base::unique_fd fenceFd) = 0; 89 90 virtual void clearWithColor(float red, float green, float blue, float alpha) = 0; 91 virtual void fillRegionWithColor(const Region& region, uint32_t height, float red, float green, 92 float blue, float alpha) = 0; 93 94 // common to all GL versions 95 virtual void setScissor(uint32_t left, uint32_t bottom, uint32_t right, uint32_t top) = 0; 96 virtual void disableScissor() = 0; 97 virtual void genTextures(size_t count, uint32_t* names) = 0; 98 virtual void deleteTextures(size_t count, uint32_t const* names) = 0; 99 virtual void bindExternalTextureImage(uint32_t texName, const RE::Image& image) = 0; 100 virtual void readPixels(size_t l, size_t b, size_t w, size_t h, uint32_t* pixels) = 0; 101 virtual void bindNativeBufferAsFrameBuffer(ANativeWindowBuffer* buffer, 102 RE::BindNativeBufferAsFramebuffer* bindHelper) = 0; 103 virtual void unbindNativeBufferAsFrameBuffer(RE::BindNativeBufferAsFramebuffer* bindHelper) = 0; 104 105 // set-up 106 virtual void checkErrors() const; 107 virtual void setViewportAndProjection(size_t vpw, size_t vph, Rect sourceCrop, size_t hwh, 108 bool yswap, Transform::orientation_flags rotation) = 0; 109 virtual void setupLayerBlending(bool premultipliedAlpha, bool opaque, bool disableTexture, 110 const half4& color) = 0; 111 virtual void setupLayerTexturing(const Texture& texture) = 0; 112 virtual void setupLayerBlackedOut() = 0; 113 virtual void setupFillWithColor(float r, float g, float b, float a) = 0; 114 115 virtual void setupColorTransform(const mat4& /* colorTransform */) = 0; 116 virtual void setSaturationMatrix(const mat4& /* saturationMatrix */) = 0; 117 118 virtual void disableTexturing() = 0; 119 virtual void disableBlending() = 0; 120 121 // HDR and wide color gamut support 122 virtual void setSourceY410BT2020(bool enable) = 0; 123 virtual void setSourceDataSpace(ui::Dataspace source) = 0; 124 virtual void setOutputDataSpace(ui::Dataspace dataspace) = 0; 125 virtual void setDisplayMaxLuminance(const float maxLuminance) = 0; 126 127 // drawing 128 virtual void drawMesh(const Mesh& mesh) = 0; 129 130 // queries 131 virtual size_t getMaxTextureSize() const = 0; 132 virtual size_t getMaxViewportDims() const = 0; 133 }; 134 135 class BindNativeBufferAsFramebuffer { 136 public: 137 BindNativeBufferAsFramebuffer(RenderEngine& engine, ANativeWindowBuffer* buffer) 138 : mEngine(engine) { 139 mEngine.bindNativeBufferAsFrameBuffer(buffer, this); 140 } 141 ~BindNativeBufferAsFramebuffer() { mEngine.unbindNativeBufferAsFrameBuffer(this); } 142 status_t getStatus() const { return mStatus; } 143 144 protected: 145 friend impl::RenderEngine; 146 147 RenderEngine& mEngine; 148 EGLImageKHR mImage; 149 uint32_t mTexName, mFbName; 150 status_t mStatus; 151 }; 152 153 namespace impl { 154 155 class Image; 156 class Surface; 157 158 class RenderEngine : public RE::RenderEngine { 159 enum GlesVersion { 160 GLES_VERSION_1_0 = 0x10000, 161 GLES_VERSION_1_1 = 0x10001, 162 GLES_VERSION_2_0 = 0x20000, 163 GLES_VERSION_3_0 = 0x30000, 164 }; 165 static GlesVersion parseGlesVersion(const char* str); 166 167 EGLDisplay mEGLDisplay; 168 EGLConfig mEGLConfig; 169 EGLContext mEGLContext; 170 void setEGLHandles(EGLDisplay display, EGLConfig config, EGLContext ctxt); 171 172 static bool overrideUseContextPriorityFromConfig(bool useContextPriority); 173 174 protected: 175 RenderEngine(uint32_t featureFlags); 176 177 const uint32_t mFeatureFlags; 178 179 public: 180 virtual ~RenderEngine() = 0; 181 182 static std::unique_ptr<RenderEngine> create(int hwcFormat, uint32_t featureFlags); 183 184 static EGLConfig chooseEglConfig(EGLDisplay display, int format, bool logConfig); 185 186 // RenderEngine interface implementation 187 188 std::unique_ptr<RE::Surface> createSurface() override; 189 std::unique_ptr<RE::Image> createImage() override; 190 191 void primeCache() const override; 192 193 // dump the extension strings. always call the base class. 194 void dump(String8& result) override; 195 196 bool supportsImageCrop() const override; 197 198 bool isCurrent() const; 199 bool setCurrentSurface(const RE::Surface& surface) override; 200 void resetCurrentSurface() override; 201 202 // synchronization 203 204 // flush submits RenderEngine command stream for execution and returns a 205 // native fence fd that is signaled when the execution has completed. It 206 // returns -1 on errors. 207 base::unique_fd flush() override; 208 // finish waits until RenderEngine command stream has been executed. It 209 // returns false on errors. 210 bool finish() override; 211 // waitFence inserts a wait on an external fence fd to RenderEngine 212 // command stream. It returns false on errors. 213 bool waitFence(base::unique_fd fenceFd) override; 214 215 // helpers 216 void clearWithColor(float red, float green, float blue, float alpha) override; 217 void fillRegionWithColor(const Region& region, uint32_t height, float red, float green, 218 float blue, float alpha) override; 219 220 // common to all GL versions 221 void setScissor(uint32_t left, uint32_t bottom, uint32_t right, uint32_t top) override; 222 void disableScissor() override; 223 void genTextures(size_t count, uint32_t* names) override; 224 void deleteTextures(size_t count, uint32_t const* names) override; 225 void bindExternalTextureImage(uint32_t texName, const RE::Image& image) override; 226 void readPixels(size_t l, size_t b, size_t w, size_t h, uint32_t* pixels) override; 227 228 void checkErrors() const override; 229 230 void setupColorTransform(const mat4& /* colorTransform */) override {} 231 void setSaturationMatrix(const mat4& /* saturationMatrix */) override {} 232 233 // internal to RenderEngine 234 EGLDisplay getEGLDisplay() const; 235 EGLConfig getEGLConfig() const; 236 237 // Common implementation 238 bool setCurrentSurface(const RE::impl::Surface& surface); 239 void bindExternalTextureImage(uint32_t texName, const RE::impl::Image& image); 240 241 void bindNativeBufferAsFrameBuffer(ANativeWindowBuffer* buffer, 242 RE::BindNativeBufferAsFramebuffer* bindHelper) override; 243 void unbindNativeBufferAsFrameBuffer(RE::BindNativeBufferAsFramebuffer* bindHelper) override; 244 245 // Overriden by each specialization 246 virtual void bindImageAsFramebuffer(EGLImageKHR image, uint32_t* texName, uint32_t* fbName, 247 uint32_t* status) = 0; 248 virtual void unbindFramebuffer(uint32_t texName, uint32_t fbName) = 0; 249 }; 250 251 } // namespace impl 252 } // namespace RE 253 } // namespace android 254 255 #endif /* SF_RENDERENGINE_H_ */ 256
