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