4 // Effect is the base class for every effect. It basically represents a single
5 // GLSL function, with an optional set of user-settable parameters.
7 // A note on naming: Since all effects run in the same GLSL namespace,
8 // you can't use any name you want for global variables (e.g. uniforms).
9 // The framework assigns a prefix to you which will be unique for each
10 // effect instance; use the macro PREFIX() around your identifiers to
11 // automatically prepend that prefix.
26 // Can alias on a float[2].
28 Point2D(float x, float y)
34 // Can alias on a float[3].
36 RGBTriplet(float r, float g, float b)
42 // Can alias on a float[4].
44 RGBATriplet(float r, float g, float b, float a)
45 : r(r), g(g), b(b), a(a) {}
50 // Convenience functions that deal with prepending the prefix.
51 GLint get_uniform_location(GLuint glsl_program_num, const std::string &prefix, const std::string &key);
52 void set_uniform_int(GLuint glsl_program_num, const std::string &prefix, const std::string &key, int value);
53 void set_uniform_float(GLuint glsl_program_num, const std::string &prefix, const std::string &key, float value);
54 void set_uniform_vec2(GLuint glsl_program_num, const std::string &prefix, const std::string &key, const float *values);
55 void set_uniform_vec3(GLuint glsl_program_num, const std::string &prefix, const std::string &key, const float *values);
56 void set_uniform_vec4(GLuint glsl_program_num, const std::string &prefix, const std::string &key, const float *values);
57 void set_uniform_vec4_array(GLuint glsl_program_num, const std::string &prefix, const std::string &key, const float *values, size_t num_values);
58 void set_uniform_mat3(GLuint glsl_program_num, const std::string &prefix, const std::string &key, const Eigen::Matrix3d &matrix);
64 // An identifier for this type of effect, mostly used for debug output
65 // (but some special names, like "ColorspaceConversionEffect", holds special
66 // meaning). Same as the class name is fine.
67 virtual std::string effect_type_id() const = 0;
69 // Whether this effects expects its input (and output) to be in
70 // linear gamma, ie. without an applied gamma curve. Most effects
71 // will want this, although the ones that never actually look at
72 // the pixels, e.g. mirror, won't need to care, and can set this
73 // to false. If so, the input gamma will be undefined.
75 // Also see the note on needs_texture_bounce(), below.
76 virtual bool needs_linear_light() const { return true; }
78 // Whether this effect expects its input to be in the sRGB
79 // color space, ie. use the sRGB/Rec. 709 RGB primaries.
80 // (If not, it would typically come in as some slightly different
81 // set of RGB primaries; you would currently not get YCbCr
82 // or something similar).
84 // Again, most effects will want this, but you can set it to false
85 // if you process each channel independently, equally _and_
86 // in a linear fashion.
87 virtual bool needs_srgb_primaries() const { return true; }
89 // How this effect handles alpha, ie. what it outputs in its
90 // alpha channel. The choices are basically blank (alpha is always 1.0),
91 // premultiplied and postmultiplied.
93 // Premultiplied alpha is when the alpha value has been be multiplied
94 // into the three color components, so e.g. 100% red at 50% alpha
95 // would be (0.5, 0.0, 0.0, 0.5) instead of (1.0, 0.0, 0.0, 0.5)
96 // as it is stored in most image formats (postmultiplied alpha).
97 // The multiplication is taken to have happened in linear light.
98 // This is the most natural format for processing, and the default in
99 // most of Movit (just like linear light is).
101 // If you set INPUT_AND_OUTPUT_PREMULTIPLIED_ALPHA or
102 // INPUT_PREMULTIPLIED_ALPHA_KEEP_BLANK, all of your inputs
103 // (if any) are guaranteed to also be in premultiplied alpha.
104 // Otherwise, you can get postmultiplied or premultiplied alpha;
105 // you won't know. If you have multiple inputs, you will get the same
106 // (pre- or postmultiplied) for all inputs, although most likely,
107 // you will want to combine them in a premultiplied fashion anyway
110 // Always outputs blank alpha (ie. alpha=1.0). Only appropriate
111 // for inputs that do not output an alpha channel.
112 // Blank alpha is special in that it can be treated as both
113 // pre- and postmultiplied.
116 // Always outputs postmultiplied alpha. Only appropriate for inputs.
117 OUTPUT_POSTMULTIPLIED_ALPHA,
119 // Always outputs premultiplied alpha. As noted above,
120 // you will then also get all inputs in premultiplied alpha.
121 // If you set this, you should also set needs_linear_light().
122 INPUT_AND_OUTPUT_PREMULTIPLIED_ALPHA,
124 // Like INPUT_AND_OUTPUT_PREMULTIPLIED_ALPHA, but also guarantees
125 // that if you get blank alpha in, you also keep blank alpha out.
126 // This is a somewhat weaker guarantee than DONT_CARE_ALPHA_TYPE,
127 // but is still useful in many situations, and appropriate when
128 // e.g. you don't touch alpha at all.
130 // Does not make sense for inputs.
131 INPUT_PREMULTIPLIED_ALPHA_KEEP_BLANK,
133 // Keeps the type of alpha (premultiplied, postmultiplied, blank)
134 // unchanged from input to output. Usually appropriate if you
135 // process all color channels in a linear fashion, do not change
136 // alpha, and do not produce any new pixels thare have alpha != 1.0.
138 // Does not make sense for inputs.
139 DONT_CARE_ALPHA_TYPE,
141 virtual AlphaHandling alpha_handling() const { return INPUT_AND_OUTPUT_PREMULTIPLIED_ALPHA; }
143 // Whether this effect expects its input to come directly from
144 // a texture. If this is true, the framework will not chain the
145 // input from other effects, but will store the results of the
146 // chain to a temporary (RGBA fp16) texture and let this effect
147 // sample directly from that.
149 // There are two good reasons why you might want to set this:
151 // 1. You are sampling more than once from the input,
152 // in which case computing all the previous steps might
153 // be more expensive than going to a memory intermediate.
154 // 2. You rely on previous effects, possibly including gamma
155 // expansion, to happen pre-filtering instead of post-filtering.
156 // (This is only relevant if you actually need the filtering; if
157 // you sample 1:1 between pixels and texels, it makes no difference.)
159 // Note that in some cases, you might get post-filtered gamma expansion
160 // even when setting this option. More specifically, if you are the
161 // first effect in the chain, and the GPU is doing sRGB gamma
162 // expansion, it is undefined (from OpenGL's side) whether expansion
163 // happens pre- or post-filtering. For most uses, however,
164 // either will be fine.
165 virtual bool needs_texture_bounce() const { return false; }
167 // Whether this effect expects mipmaps or not. If you set this to
168 // true, you will be sampling with bilinear filtering; if not,
169 // you could be sampling with simple linear filtering and no mipmaps
170 // (although there is no guarantee; if a different effect in the chain
171 // needs mipmaps, you will also get them).
172 virtual bool needs_mipmaps() const { return false; }
174 // Whether this effect wants to output to a different size than
175 // its input(s) (see inform_input_size(), below). If you set this to
176 // true, the output will be bounced to a texture (similarly to if the
177 // next effect set needs_texture_bounce()).
178 virtual bool changes_output_size() const { return false; }
180 // If changes_output_size() is true, you must implement this to tell
181 // the framework what output size you want. Also, you can set a
182 // virtual width/height, which is the size the next effect (if any)
183 // will _think_ your data is in. This is primarily useful if you are
184 // relying on getting OpenGL's bilinear resizing for free; otherwise,
185 // your virtual_width/virtual_height should be the same as width/height.
187 // Note that it is explicitly allowed to change width and height
188 // from frame to frame; EffectChain will reallocate textures as needed.
189 virtual void get_output_size(unsigned *width, unsigned *height,
190 unsigned *virtual_width, unsigned *virtual_height) const {
194 // Tells the effect the resolution of each of its input.
195 // This will be called every frame, and always before get_output_size(),
196 // so you can change your output size based on the input if so desired.
198 // Note that in some cases, an input might not have a single well-defined
199 // resolution (for instance if you fade between two inputs with
200 // different resolutions). In this case, you will get width=0 and height=0
201 // for that input. If you cannot handle that, you will need to set
202 // needs_texture_bounce() to true, which will force a render to a single
203 // given resolution before you get the input.
204 virtual void inform_input_size(unsigned input_num, unsigned width, unsigned height) {}
206 // How many inputs this effect will take (a fixed number).
207 // If you have only one input, it will be called INPUT() in GLSL;
208 // if you have several, they will be INPUT1(), INPUT2(), and so on.
209 virtual unsigned num_inputs() const { return 1; }
211 // Let the effect rewrite the effect chain as it sees fit.
212 // Most effects won't need to do this, but this is very useful
213 // if you have an effect that consists of multiple sub-effects
214 // (for instance, two passes). The effect is given to its own
215 // pointer, and it can add new ones (by using add_node()
216 // and connect_node()) as it sees fit. This is called at
217 // EffectChain::finalize() time, when the entire graph is known,
218 // in the order that the effects were originally added.
220 // Note that if the effect wants to take itself entirely out
221 // of the chain, it must set “disabled” to true and then disconnect
222 // itself from all other effects.
223 virtual void rewrite_graph(EffectChain *graph, Node *self) {}
225 // Outputs one GLSL uniform declaration for each registered parameter
226 // (see below), with the right prefix prepended to each uniform name.
227 // If you do not want this behavior, you can override this function.
228 virtual std::string output_convenience_uniforms() const;
230 // Returns the GLSL fragment shader string for this effect.
231 virtual std::string output_fragment_shader() = 0;
233 // Set all OpenGL state that this effect needs before rendering.
234 // The default implementation sets one uniform per registered parameter,
235 // but no other state.
237 // <sampler_num> is the first free texture sampler. If you want to use
238 // textures, you can bind a texture to GL_TEXTURE0 + <sampler_num>,
239 // and then increment the number (so that the next effect in the chain
240 // will use a different sampler).
241 virtual void set_gl_state(GLuint glsl_program_num, const std::string& prefix, unsigned *sampler_num);
243 // If you set any special OpenGL state in set_gl_state(), you can clear it
244 // after rendering here. The default implementation does nothing.
245 virtual void clear_gl_state();
247 // Set a parameter; intended to be called from user code.
248 // Neither of these take ownership of the pointer.
249 virtual bool set_int(const std::string&, int value) MUST_CHECK_RESULT;
250 virtual bool set_float(const std::string &key, float value) MUST_CHECK_RESULT;
251 virtual bool set_vec2(const std::string &key, const float *values) MUST_CHECK_RESULT;
252 virtual bool set_vec3(const std::string &key, const float *values) MUST_CHECK_RESULT;
253 virtual bool set_vec4(const std::string &key, const float *values) MUST_CHECK_RESULT;
256 // Register a parameter. Whenever set_*() is called with the same key,
257 // it will update the value in the given pointer (typically a pointer
258 // to some private member variable in your effect).
260 // Neither of these take ownership of the pointer.
262 // int is special since GLSL pre-1.30 doesn't have integer uniforms.
263 // Thus, ints that you register will _not_ be converted to GLSL uniforms.
264 void register_int(const std::string &key, int *value);
266 // These correspond directly to float/vec2/vec3/vec4 in GLSL.
267 void register_float(const std::string &key, float *value);
268 void register_vec2(const std::string &key, float *values);
269 void register_vec3(const std::string &key, float *values);
270 void register_vec4(const std::string &key, float *values);
272 // This will register a 1D texture, which will be bound to a sampler
273 // when your GLSL code runs (so it corresponds 1:1 to a sampler2D uniform
276 // Note that if you change the contents of <values>, you will need to
277 // call invalidate_1d_texture() to have the picture re-uploaded on the
278 // next frame. This is in contrast to all the other parameters, which are
279 // set anew every frame.
280 void register_1d_texture(const std::string &key, float *values, size_t size);
281 void invalidate_1d_texture(const std::string &key);
291 std::map<std::string, int *> params_int;
292 std::map<std::string, float *> params_float;
293 std::map<std::string, float *> params_vec2;
294 std::map<std::string, float *> params_vec3;
295 std::map<std::string, float *> params_vec4;
296 std::map<std::string, Texture1D> params_tex_1d;
299 #endif // !defined(_EFFECT_H)