Mathias Agopian | 3f84483 | 2013-08-07 21:24:32 -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 | |
| 17 | #ifndef SF_RENDER_ENGINE_PROGRAMCACHE_H |
| 18 | #define SF_RENDER_ENGINE_PROGRAMCACHE_H |
| 19 | |
Chia-I Wu | d3b13cb | 2018-09-13 13:31:26 -0700 | [diff] [blame] | 20 | #include <memory> |
Chia-I Wu | 56d7b0a | 2018-10-01 15:13:11 -0700 | [diff] [blame] | 21 | #include <unordered_map> |
| 22 | |
Peiyong Lin | fb530cf | 2018-12-15 05:07:38 +0000 | [diff] [blame] | 23 | #include <EGL/egl.h> |
Mathias Agopian | 3f84483 | 2013-08-07 21:24:32 -0700 | [diff] [blame] | 24 | #include <GLES2/gl2.h> |
Peiyong Lin | 833074a | 2018-08-28 11:53:54 -0700 | [diff] [blame] | 25 | #include <renderengine/private/Description.h> |
Chia-I Wu | b027f80 | 2017-11-29 14:00:52 -0800 | [diff] [blame] | 26 | #include <utils/Singleton.h> |
Mathias Agopian | 3f84483 | 2013-08-07 21:24:32 -0700 | [diff] [blame] | 27 | #include <utils/TypeHelpers.h> |
| 28 | |
Mathias Agopian | 3f84483 | 2013-08-07 21:24:32 -0700 | [diff] [blame] | 29 | namespace android { |
| 30 | |
Peiyong Lin | 833074a | 2018-08-28 11:53:54 -0700 | [diff] [blame] | 31 | class String8; |
| 32 | |
| 33 | namespace renderengine { |
| 34 | |
Peiyong Lin | 70b26ce | 2018-09-18 19:02:39 -0700 | [diff] [blame] | 35 | struct Description; |
Peiyong Lin | 833074a | 2018-08-28 11:53:54 -0700 | [diff] [blame] | 36 | |
| 37 | namespace gl { |
| 38 | |
Peiyong Lin | 2542cb0 | 2018-04-30 17:29:53 -0700 | [diff] [blame] | 39 | class Formatter; |
Mathias Agopian | 3f84483 | 2013-08-07 21:24:32 -0700 | [diff] [blame] | 40 | class Program; |
Mathias Agopian | 3f84483 | 2013-08-07 21:24:32 -0700 | [diff] [blame] | 41 | |
| 42 | /* |
| 43 | * This class generates GLSL programs suitable to handle a given |
| 44 | * Description. It's responsible for figuring out what to |
| 45 | * generate from a Description. |
| 46 | * It also maintains a cache of these Programs. |
| 47 | */ |
| 48 | class ProgramCache : public Singleton<ProgramCache> { |
| 49 | public: |
| 50 | /* |
| 51 | * Key is used to retrieve a Program in the cache. |
| 52 | * A Key is generated from a Description. |
| 53 | */ |
| 54 | class Key { |
| 55 | friend class ProgramCache; |
| 56 | typedef uint32_t key_t; |
| 57 | key_t mKey; |
Chia-I Wu | b027f80 | 2017-11-29 14:00:52 -0800 | [diff] [blame] | 58 | |
Mathias Agopian | 3f84483 | 2013-08-07 21:24:32 -0700 | [diff] [blame] | 59 | public: |
| 60 | enum { |
Chia-I Wu | 7e65bc0 | 2018-01-11 14:31:38 -0800 | [diff] [blame] | 61 | BLEND_SHIFT = 0, |
| 62 | BLEND_MASK = 1 << BLEND_SHIFT, |
| 63 | BLEND_PREMULT = 1 << BLEND_SHIFT, |
| 64 | BLEND_NORMAL = 0 << BLEND_SHIFT, |
Mathias Agopian | 3f84483 | 2013-08-07 21:24:32 -0700 | [diff] [blame] | 65 | |
Chia-I Wu | 7e65bc0 | 2018-01-11 14:31:38 -0800 | [diff] [blame] | 66 | OPACITY_SHIFT = 1, |
| 67 | OPACITY_MASK = 1 << OPACITY_SHIFT, |
| 68 | OPACITY_OPAQUE = 1 << OPACITY_SHIFT, |
| 69 | OPACITY_TRANSLUCENT = 0 << OPACITY_SHIFT, |
Mathias Agopian | 3f84483 | 2013-08-07 21:24:32 -0700 | [diff] [blame] | 70 | |
Chia-I Wu | 7e65bc0 | 2018-01-11 14:31:38 -0800 | [diff] [blame] | 71 | ALPHA_SHIFT = 2, |
| 72 | ALPHA_MASK = 1 << ALPHA_SHIFT, |
| 73 | ALPHA_LT_ONE = 1 << ALPHA_SHIFT, |
| 74 | ALPHA_EQ_ONE = 0 << ALPHA_SHIFT, |
Mathias Agopian | 3f84483 | 2013-08-07 21:24:32 -0700 | [diff] [blame] | 75 | |
Chia-I Wu | 7e65bc0 | 2018-01-11 14:31:38 -0800 | [diff] [blame] | 76 | TEXTURE_SHIFT = 3, |
| 77 | TEXTURE_MASK = 3 << TEXTURE_SHIFT, |
| 78 | TEXTURE_OFF = 0 << TEXTURE_SHIFT, |
| 79 | TEXTURE_EXT = 1 << TEXTURE_SHIFT, |
| 80 | TEXTURE_2D = 2 << TEXTURE_SHIFT, |
Mathias Agopian | ff2ed70 | 2013-09-01 21:36:12 -0700 | [diff] [blame] | 81 | |
Lucas Dupin | 1b6531c | 2018-07-05 17:18:21 -0700 | [diff] [blame] | 82 | ROUNDED_CORNERS_SHIFT = 5, |
| 83 | ROUNDED_CORNERS_MASK = 1 << ROUNDED_CORNERS_SHIFT, |
| 84 | ROUNDED_CORNERS_OFF = 0 << ROUNDED_CORNERS_SHIFT, |
| 85 | ROUNDED_CORNERS_ON = 1 << ROUNDED_CORNERS_SHIFT, |
| 86 | |
| 87 | INPUT_TRANSFORM_MATRIX_SHIFT = 6, |
Peiyong Lin | a296b0c | 2018-04-30 16:55:29 -0700 | [diff] [blame] | 88 | INPUT_TRANSFORM_MATRIX_MASK = 1 << INPUT_TRANSFORM_MATRIX_SHIFT, |
| 89 | INPUT_TRANSFORM_MATRIX_OFF = 0 << INPUT_TRANSFORM_MATRIX_SHIFT, |
| 90 | INPUT_TRANSFORM_MATRIX_ON = 1 << INPUT_TRANSFORM_MATRIX_SHIFT, |
Romain Guy | 88d37dd | 2017-05-26 17:57:05 -0700 | [diff] [blame] | 91 | |
Lucas Dupin | 1b6531c | 2018-07-05 17:18:21 -0700 | [diff] [blame] | 92 | OUTPUT_TRANSFORM_MATRIX_SHIFT = 7, |
Peiyong Lin | a296b0c | 2018-04-30 16:55:29 -0700 | [diff] [blame] | 93 | OUTPUT_TRANSFORM_MATRIX_MASK = 1 << OUTPUT_TRANSFORM_MATRIX_SHIFT, |
| 94 | OUTPUT_TRANSFORM_MATRIX_OFF = 0 << OUTPUT_TRANSFORM_MATRIX_SHIFT, |
| 95 | OUTPUT_TRANSFORM_MATRIX_ON = 1 << OUTPUT_TRANSFORM_MATRIX_SHIFT, |
| 96 | |
Lucas Dupin | 1b6531c | 2018-07-05 17:18:21 -0700 | [diff] [blame] | 97 | INPUT_TF_SHIFT = 8, |
Chia-I Wu | 7e65bc0 | 2018-01-11 14:31:38 -0800 | [diff] [blame] | 98 | INPUT_TF_MASK = 3 << INPUT_TF_SHIFT, |
| 99 | INPUT_TF_LINEAR = 0 << INPUT_TF_SHIFT, |
| 100 | INPUT_TF_SRGB = 1 << INPUT_TF_SHIFT, |
Chia-I Wu | 131d376 | 2018-01-11 14:35:27 -0800 | [diff] [blame] | 101 | INPUT_TF_ST2084 = 2 << INPUT_TF_SHIFT, |
Peiyong Lin | a3fb7d6 | 2018-04-11 17:41:47 -0700 | [diff] [blame] | 102 | INPUT_TF_HLG = 3 << INPUT_TF_SHIFT, |
Chia-I Wu | 7e65bc0 | 2018-01-11 14:31:38 -0800 | [diff] [blame] | 103 | |
Lucas Dupin | 1b6531c | 2018-07-05 17:18:21 -0700 | [diff] [blame] | 104 | OUTPUT_TF_SHIFT = 10, |
Chia-I Wu | 7e65bc0 | 2018-01-11 14:31:38 -0800 | [diff] [blame] | 105 | OUTPUT_TF_MASK = 3 << OUTPUT_TF_SHIFT, |
| 106 | OUTPUT_TF_LINEAR = 0 << OUTPUT_TF_SHIFT, |
| 107 | OUTPUT_TF_SRGB = 1 << OUTPUT_TF_SHIFT, |
Chia-I Wu | 131d376 | 2018-01-11 14:35:27 -0800 | [diff] [blame] | 108 | OUTPUT_TF_ST2084 = 2 << OUTPUT_TF_SHIFT, |
Peiyong Lin | a3fb7d6 | 2018-04-11 17:41:47 -0700 | [diff] [blame] | 109 | OUTPUT_TF_HLG = 3 << OUTPUT_TF_SHIFT, |
Chia-I Wu | 131d376 | 2018-01-11 14:35:27 -0800 | [diff] [blame] | 110 | |
Lucas Dupin | 1b6531c | 2018-07-05 17:18:21 -0700 | [diff] [blame] | 111 | Y410_BT2020_SHIFT = 12, |
Chia-I Wu | 131d376 | 2018-01-11 14:35:27 -0800 | [diff] [blame] | 112 | Y410_BT2020_MASK = 1 << Y410_BT2020_SHIFT, |
| 113 | Y410_BT2020_OFF = 0 << Y410_BT2020_SHIFT, |
| 114 | Y410_BT2020_ON = 1 << Y410_BT2020_SHIFT, |
Vishnu Nair | 16efdbf | 2019-12-10 11:55:42 -0800 | [diff] [blame] | 115 | |
| 116 | SHADOW_SHIFT = 13, |
| 117 | SHADOW_MASK = 1 << SHADOW_SHIFT, |
| 118 | SHADOW_OFF = 0 << SHADOW_SHIFT, |
| 119 | SHADOW_ON = 1 << SHADOW_SHIFT, |
KaiChieh Chuang | 436fc19 | 2020-09-07 13:48:42 +0800 | [diff] [blame] | 120 | |
| 121 | DISPLAY_COLOR_TRANSFORM_MATRIX_SHIFT = 14, |
| 122 | DISPLAY_COLOR_TRANSFORM_MATRIX_MASK = 1 << DISPLAY_COLOR_TRANSFORM_MATRIX_SHIFT, |
| 123 | DISPLAY_COLOR_TRANSFORM_MATRIX_OFF = 0 << DISPLAY_COLOR_TRANSFORM_MATRIX_SHIFT, |
| 124 | DISPLAY_COLOR_TRANSFORM_MATRIX_ON = 1 << DISPLAY_COLOR_TRANSFORM_MATRIX_SHIFT, |
Mathias Agopian | 3f84483 | 2013-08-07 21:24:32 -0700 | [diff] [blame] | 125 | }; |
| 126 | |
Chia-I Wu | b027f80 | 2017-11-29 14:00:52 -0800 | [diff] [blame] | 127 | inline Key() : mKey(0) {} |
| 128 | inline Key(const Key& rhs) : mKey(rhs.mKey) {} |
Mathias Agopian | 3f84483 | 2013-08-07 21:24:32 -0700 | [diff] [blame] | 129 | |
| 130 | inline Key& set(key_t mask, key_t value) { |
| 131 | mKey = (mKey & ~mask) | value; |
| 132 | return *this; |
| 133 | } |
| 134 | |
Chia-I Wu | b027f80 | 2017-11-29 14:00:52 -0800 | [diff] [blame] | 135 | inline bool isTexturing() const { return (mKey & TEXTURE_MASK) != TEXTURE_OFF; } |
Vishnu Nair | f19544f | 2020-02-03 11:23:26 -0800 | [diff] [blame] | 136 | inline bool hasTextureCoords() const { return isTexturing() && !drawShadows(); } |
Chia-I Wu | b027f80 | 2017-11-29 14:00:52 -0800 | [diff] [blame] | 137 | inline int getTextureTarget() const { return (mKey & TEXTURE_MASK); } |
| 138 | inline bool isPremultiplied() const { return (mKey & BLEND_MASK) == BLEND_PREMULT; } |
| 139 | inline bool isOpaque() const { return (mKey & OPACITY_MASK) == OPACITY_OPAQUE; } |
| 140 | inline bool hasAlpha() const { return (mKey & ALPHA_MASK) == ALPHA_LT_ONE; } |
Lucas Dupin | 1b6531c | 2018-07-05 17:18:21 -0700 | [diff] [blame] | 141 | inline bool hasRoundedCorners() const { |
| 142 | return (mKey & ROUNDED_CORNERS_MASK) == ROUNDED_CORNERS_ON; |
| 143 | } |
Vishnu Nair | 16efdbf | 2019-12-10 11:55:42 -0800 | [diff] [blame] | 144 | inline bool drawShadows() const { return (mKey & SHADOW_MASK) == SHADOW_ON; } |
Peiyong Lin | a296b0c | 2018-04-30 16:55:29 -0700 | [diff] [blame] | 145 | inline bool hasInputTransformMatrix() const { |
| 146 | return (mKey & INPUT_TRANSFORM_MATRIX_MASK) == INPUT_TRANSFORM_MATRIX_ON; |
| 147 | } |
| 148 | inline bool hasOutputTransformMatrix() const { |
| 149 | return (mKey & OUTPUT_TRANSFORM_MATRIX_MASK) == OUTPUT_TRANSFORM_MATRIX_ON; |
| 150 | } |
KaiChieh Chuang | 436fc19 | 2020-09-07 13:48:42 +0800 | [diff] [blame] | 151 | inline bool hasDisplayColorMatrix() const { |
| 152 | return (mKey & DISPLAY_COLOR_TRANSFORM_MATRIX_MASK) == |
| 153 | DISPLAY_COLOR_TRANSFORM_MATRIX_ON; |
| 154 | } |
Peiyong Lin | a296b0c | 2018-04-30 16:55:29 -0700 | [diff] [blame] | 155 | inline bool hasTransformMatrix() const { |
| 156 | return hasInputTransformMatrix() || hasOutputTransformMatrix(); |
| 157 | } |
Chia-I Wu | 7e65bc0 | 2018-01-11 14:31:38 -0800 | [diff] [blame] | 158 | inline int getInputTF() const { return (mKey & INPUT_TF_MASK); } |
| 159 | inline int getOutputTF() const { return (mKey & OUTPUT_TF_MASK); } |
Peiyong Lin | 53f320e | 2018-04-23 17:31:06 -0700 | [diff] [blame] | 160 | |
| 161 | // When HDR and non-HDR contents are mixed, or different types of HDR contents are |
| 162 | // mixed, we will do a tone mapping process to tone map the input content to output |
| 163 | // content. Currently, the following conversions handled, they are: |
| 164 | // * SDR -> HLG |
| 165 | // * SDR -> PQ |
| 166 | // * HLG -> PQ |
| 167 | inline bool needsToneMapping() const { |
| 168 | int inputTF = getInputTF(); |
| 169 | int outputTF = getOutputTF(); |
| 170 | |
| 171 | // Return false when converting from SDR to SDR. |
| 172 | if (inputTF == Key::INPUT_TF_SRGB && outputTF == Key::OUTPUT_TF_LINEAR) { |
| 173 | return false; |
| 174 | } |
| 175 | if (inputTF == Key::INPUT_TF_LINEAR && outputTF == Key::OUTPUT_TF_SRGB) { |
| 176 | return false; |
| 177 | } |
| 178 | |
| 179 | inputTF >>= Key::INPUT_TF_SHIFT; |
| 180 | outputTF >>= Key::OUTPUT_TF_SHIFT; |
| 181 | return inputTF != outputTF; |
| 182 | } |
Chia-I Wu | 131d376 | 2018-01-11 14:35:27 -0800 | [diff] [blame] | 183 | inline bool isY410BT2020() const { return (mKey & Y410_BT2020_MASK) == Y410_BT2020_ON; } |
Mathias Agopian | 3f84483 | 2013-08-07 21:24:32 -0700 | [diff] [blame] | 184 | |
Chia-I Wu | 56d7b0a | 2018-10-01 15:13:11 -0700 | [diff] [blame] | 185 | // for use by std::unordered_map |
| 186 | |
Peiyong Lin | 46080ef | 2018-10-26 18:43:14 -0700 | [diff] [blame] | 187 | bool operator==(const Key& other) const { return mKey == other.mKey; } |
Chia-I Wu | 56d7b0a | 2018-10-01 15:13:11 -0700 | [diff] [blame] | 188 | |
| 189 | struct Hash { |
Peiyong Lin | 46080ef | 2018-10-26 18:43:14 -0700 | [diff] [blame] | 190 | size_t operator()(const Key& key) const { return static_cast<size_t>(key.mKey); } |
Chia-I Wu | 56d7b0a | 2018-10-01 15:13:11 -0700 | [diff] [blame] | 191 | }; |
Mathias Agopian | 3f84483 | 2013-08-07 21:24:32 -0700 | [diff] [blame] | 192 | }; |
| 193 | |
Chia-I Wu | d3b13cb | 2018-09-13 13:31:26 -0700 | [diff] [blame] | 194 | ProgramCache() = default; |
| 195 | ~ProgramCache() = default; |
Mathias Agopian | 3f84483 | 2013-08-07 21:24:32 -0700 | [diff] [blame] | 196 | |
Chia-I Wu | 93e14df | 2018-06-04 10:10:17 -0700 | [diff] [blame] | 197 | // Generate shaders to populate the cache |
Chong Zhang | 8ddb04e | 2019-10-02 14:20:02 -0700 | [diff] [blame] | 198 | void primeCache(const EGLContext context, bool useColorManagement, bool toneMapperShaderOnly); |
Chia-I Wu | 93e14df | 2018-06-04 10:10:17 -0700 | [diff] [blame] | 199 | |
Peiyong Lin | fb530cf | 2018-12-15 05:07:38 +0000 | [diff] [blame] | 200 | size_t getSize(const EGLContext context) { return mCaches[context].size(); } |
Chia-I Wu | 56d7b0a | 2018-10-01 15:13:11 -0700 | [diff] [blame] | 201 | |
Mathias Agopian | 3f84483 | 2013-08-07 21:24:32 -0700 | [diff] [blame] | 202 | // useProgram lookup a suitable program in the cache or generates one |
| 203 | // if none can be found. |
Peiyong Lin | fb530cf | 2018-12-15 05:07:38 +0000 | [diff] [blame] | 204 | void useProgram(const EGLContext context, const Description& description); |
Mathias Agopian | 3f84483 | 2013-08-07 21:24:32 -0700 | [diff] [blame] | 205 | |
Alec Mouri | 2725c09 | 2020-11-25 09:53:56 -0800 | [diff] [blame] | 206 | void purgeCaches() { mCaches.clear(); } |
| 207 | |
Mathias Agopian | 3f84483 | 2013-08-07 21:24:32 -0700 | [diff] [blame] | 208 | private: |
Mathias Agopian | 3f84483 | 2013-08-07 21:24:32 -0700 | [diff] [blame] | 209 | // compute a cache Key from a Description |
| 210 | static Key computeKey(const Description& description); |
Peiyong Lin | 2542cb0 | 2018-04-30 17:29:53 -0700 | [diff] [blame] | 211 | // Generate EOTF based from Key. |
| 212 | static void generateEOTF(Formatter& fs, const Key& needs); |
Peiyong Lin | 53f320e | 2018-04-23 17:31:06 -0700 | [diff] [blame] | 213 | // Generate necessary tone mapping methods for OOTF. |
| 214 | static void generateToneMappingProcess(Formatter& fs, const Key& needs); |
Peiyong Lin | 2542cb0 | 2018-04-30 17:29:53 -0700 | [diff] [blame] | 215 | // Generate OOTF based from Key. |
| 216 | static void generateOOTF(Formatter& fs, const Key& needs); |
| 217 | // Generate OETF based from Key. |
| 218 | static void generateOETF(Formatter& fs, const Key& needs); |
Mathias Agopian | 3f84483 | 2013-08-07 21:24:32 -0700 | [diff] [blame] | 219 | // generates a program from the Key |
Chia-I Wu | d3b13cb | 2018-09-13 13:31:26 -0700 | [diff] [blame] | 220 | static std::unique_ptr<Program> generateProgram(const Key& needs); |
Mathias Agopian | 3f84483 | 2013-08-07 21:24:32 -0700 | [diff] [blame] | 221 | // generates the vertex shader from the Key |
| 222 | static String8 generateVertexShader(const Key& needs); |
| 223 | // generates the fragment shader from the Key |
| 224 | static String8 generateFragmentShader(const Key& needs); |
| 225 | |
| 226 | // Key/Value map used for caching Programs. Currently the cache |
Chia-I Wu | d3b13cb | 2018-09-13 13:31:26 -0700 | [diff] [blame] | 227 | // is never shrunk (and the GL program objects are never deleted). |
Peiyong Lin | fb530cf | 2018-12-15 05:07:38 +0000 | [diff] [blame] | 228 | std::unordered_map<EGLContext, std::unordered_map<Key, std::unique_ptr<Program>, Key::Hash>> |
| 229 | mCaches; |
Mathias Agopian | 3f84483 | 2013-08-07 21:24:32 -0700 | [diff] [blame] | 230 | }; |
| 231 | |
Peiyong Lin | 46080ef | 2018-10-26 18:43:14 -0700 | [diff] [blame] | 232 | } // namespace gl |
| 233 | } // namespace renderengine |
Mathias Agopian | 3f84483 | 2013-08-07 21:24:32 -0700 | [diff] [blame] | 234 | |
Peiyong Lin | 833074a | 2018-08-28 11:53:54 -0700 | [diff] [blame] | 235 | ANDROID_BASIC_TYPES_TRAITS(renderengine::gl::ProgramCache::Key) |
| 236 | |
Peiyong Lin | 46080ef | 2018-10-26 18:43:14 -0700 | [diff] [blame] | 237 | } // namespace android |
Mathias Agopian | 3f84483 | 2013-08-07 21:24:32 -0700 | [diff] [blame] | 238 | |
| 239 | #endif /* SF_RENDER_ENGINE_PROGRAMCACHE_H */ |