blob: dcc8cc601bdb9c98b3e69c76eba4341b9ba8d15f [file] [log] [blame]
Mathias Agopian3f844832013-08-07 21:24:32 -07001/*
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
20#include <GLES2/gl2.h>
21
Mathias Agopian3f844832013-08-07 21:24:32 -070022#include <utils/KeyedVector.h>
Chia-I Wub027f802017-11-29 14:00:52 -080023#include <utils/Singleton.h>
Mathias Agopian3f844832013-08-07 21:24:32 -070024#include <utils/TypeHelpers.h>
25
26#include "Description.h"
27
28namespace android {
29
30class Description;
31class Program;
32class String8;
33
34/*
35 * This class generates GLSL programs suitable to handle a given
36 * Description. It's responsible for figuring out what to
37 * generate from a Description.
38 * It also maintains a cache of these Programs.
39 */
40class ProgramCache : public Singleton<ProgramCache> {
41public:
42 /*
43 * Key is used to retrieve a Program in the cache.
44 * A Key is generated from a Description.
45 */
46 class Key {
47 friend class ProgramCache;
48 typedef uint32_t key_t;
49 key_t mKey;
Chia-I Wub027f802017-11-29 14:00:52 -080050
Mathias Agopian3f844832013-08-07 21:24:32 -070051 public:
52 enum {
Chia-I Wu7e65bc02018-01-11 14:31:38 -080053 BLEND_SHIFT = 0,
54 BLEND_MASK = 1 << BLEND_SHIFT,
55 BLEND_PREMULT = 1 << BLEND_SHIFT,
56 BLEND_NORMAL = 0 << BLEND_SHIFT,
Mathias Agopian3f844832013-08-07 21:24:32 -070057
Chia-I Wu7e65bc02018-01-11 14:31:38 -080058 OPACITY_SHIFT = 1,
59 OPACITY_MASK = 1 << OPACITY_SHIFT,
60 OPACITY_OPAQUE = 1 << OPACITY_SHIFT,
61 OPACITY_TRANSLUCENT = 0 << OPACITY_SHIFT,
Mathias Agopian3f844832013-08-07 21:24:32 -070062
Chia-I Wu7e65bc02018-01-11 14:31:38 -080063 ALPHA_SHIFT = 2,
64 ALPHA_MASK = 1 << ALPHA_SHIFT,
65 ALPHA_LT_ONE = 1 << ALPHA_SHIFT,
66 ALPHA_EQ_ONE = 0 << ALPHA_SHIFT,
Mathias Agopian3f844832013-08-07 21:24:32 -070067
Chia-I Wu7e65bc02018-01-11 14:31:38 -080068 TEXTURE_SHIFT = 3,
69 TEXTURE_MASK = 3 << TEXTURE_SHIFT,
70 TEXTURE_OFF = 0 << TEXTURE_SHIFT,
71 TEXTURE_EXT = 1 << TEXTURE_SHIFT,
72 TEXTURE_2D = 2 << TEXTURE_SHIFT,
Mathias Agopianff2ed702013-09-01 21:36:12 -070073
Chia-I Wu7e65bc02018-01-11 14:31:38 -080074 COLOR_MATRIX_SHIFT = 5,
75 COLOR_MATRIX_MASK = 1 << COLOR_MATRIX_SHIFT,
76 COLOR_MATRIX_OFF = 0 << COLOR_MATRIX_SHIFT,
77 COLOR_MATRIX_ON = 1 << COLOR_MATRIX_SHIFT,
Romain Guy88d37dd2017-05-26 17:57:05 -070078
Chia-I Wu7e65bc02018-01-11 14:31:38 -080079 INPUT_TF_SHIFT = 6,
80 INPUT_TF_MASK = 3 << INPUT_TF_SHIFT,
81 INPUT_TF_LINEAR = 0 << INPUT_TF_SHIFT,
82 INPUT_TF_SRGB = 1 << INPUT_TF_SHIFT,
Chia-I Wu131d3762018-01-11 14:35:27 -080083 INPUT_TF_ST2084 = 2 << INPUT_TF_SHIFT,
Chia-I Wu7e65bc02018-01-11 14:31:38 -080084
85 OUTPUT_TF_SHIFT = 8,
86 OUTPUT_TF_MASK = 3 << OUTPUT_TF_SHIFT,
87 OUTPUT_TF_LINEAR = 0 << OUTPUT_TF_SHIFT,
88 OUTPUT_TF_SRGB = 1 << OUTPUT_TF_SHIFT,
Chia-I Wu131d3762018-01-11 14:35:27 -080089 OUTPUT_TF_ST2084 = 2 << OUTPUT_TF_SHIFT,
90
91 TONE_MAPPING_SHIFT = 10,
92 TONE_MAPPING_MASK = 1 << TONE_MAPPING_SHIFT,
93 TONE_MAPPING_OFF = 0 << TONE_MAPPING_SHIFT,
94 TONE_MAPPING_ON = 1 << TONE_MAPPING_SHIFT,
95
96 Y410_BT2020_SHIFT = 11,
97 Y410_BT2020_MASK = 1 << Y410_BT2020_SHIFT,
98 Y410_BT2020_OFF = 0 << Y410_BT2020_SHIFT,
99 Y410_BT2020_ON = 1 << Y410_BT2020_SHIFT,
Mathias Agopian3f844832013-08-07 21:24:32 -0700100 };
101
Chia-I Wub027f802017-11-29 14:00:52 -0800102 inline Key() : mKey(0) {}
103 inline Key(const Key& rhs) : mKey(rhs.mKey) {}
Mathias Agopian3f844832013-08-07 21:24:32 -0700104
105 inline Key& set(key_t mask, key_t value) {
106 mKey = (mKey & ~mask) | value;
107 return *this;
108 }
109
Chia-I Wub027f802017-11-29 14:00:52 -0800110 inline bool isTexturing() const { return (mKey & TEXTURE_MASK) != TEXTURE_OFF; }
111 inline int getTextureTarget() const { return (mKey & TEXTURE_MASK); }
112 inline bool isPremultiplied() const { return (mKey & BLEND_MASK) == BLEND_PREMULT; }
113 inline bool isOpaque() const { return (mKey & OPACITY_MASK) == OPACITY_OPAQUE; }
114 inline bool hasAlpha() const { return (mKey & ALPHA_MASK) == ALPHA_LT_ONE; }
115 inline bool hasColorMatrix() const { return (mKey & COLOR_MATRIX_MASK) == COLOR_MATRIX_ON; }
Chia-I Wu7e65bc02018-01-11 14:31:38 -0800116 inline int getInputTF() const { return (mKey & INPUT_TF_MASK); }
117 inline int getOutputTF() const { return (mKey & OUTPUT_TF_MASK); }
Chia-I Wu131d3762018-01-11 14:35:27 -0800118 inline bool hasToneMapping() const { return (mKey & TONE_MAPPING_MASK) == TONE_MAPPING_ON; }
119 inline bool isY410BT2020() const { return (mKey & Y410_BT2020_MASK) == Y410_BT2020_ON; }
Mathias Agopian3f844832013-08-07 21:24:32 -0700120
121 // this is the definition of a friend function -- not a method of class Needs
122 friend inline int strictly_order_type(const Key& lhs, const Key& rhs) {
Romain Guy88d37dd2017-05-26 17:57:05 -0700123 return (lhs.mKey < rhs.mKey) ? 1 : 0;
Mathias Agopian3f844832013-08-07 21:24:32 -0700124 }
125 };
126
127 ProgramCache();
128 ~ProgramCache();
129
130 // useProgram lookup a suitable program in the cache or generates one
131 // if none can be found.
132 void useProgram(const Description& description);
133
134private:
Riley Andrewsa51fafc2014-09-29 13:29:40 -0700135 // Generate shaders to populate the cache
136 void primeCache();
Mathias Agopian3f844832013-08-07 21:24:32 -0700137 // compute a cache Key from a Description
138 static Key computeKey(const Description& description);
139 // generates a program from the Key
140 static Program* generateProgram(const Key& needs);
141 // generates the vertex shader from the Key
142 static String8 generateVertexShader(const Key& needs);
143 // generates the fragment shader from the Key
144 static String8 generateFragmentShader(const Key& needs);
145
146 // Key/Value map used for caching Programs. Currently the cache
147 // is never shrunk.
148 DefaultKeyedVector<Key, Program*> mCache;
149};
150
Mathias Agopian3f844832013-08-07 21:24:32 -0700151ANDROID_BASIC_TYPES_TRAITS(ProgramCache::Key)
152
153} /* namespace android */
154
155#endif /* SF_RENDER_ENGINE_PROGRAMCACHE_H */