In overlay matte, use the luminance as a matte instead of each individual color compo...
[movit] / effect.h
1 #ifndef _EFFECT_H
2 #define _EFFECT_H 1
3
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.
6 //
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.
12
13 #include <map>
14 #include <string>
15 #include <vector>
16
17 #include <GL/gl.h>
18
19 class EffectChain;
20
21 // Can alias on a float[2].
22 struct Point2D {
23         Point2D(float x, float y)
24                 : x(x), y(y) {}
25
26         float x, y;
27 };
28
29 // Can alias on a float[3].
30 struct RGBTriplet {
31         RGBTriplet(float r, float g, float b)
32                 : r(r), g(g), b(b) {}
33
34         float r, g, b;
35 };
36
37 // Convenience functions that deal with prepending the prefix.
38 GLint get_uniform_location(GLuint glsl_program_num, const std::string &prefix, const std::string &key);
39 void set_uniform_int(GLuint glsl_program_num, const std::string &prefix, const std::string &key, int value);
40 void set_uniform_float(GLuint glsl_program_num, const std::string &prefix, const std::string &key, float value);
41 void set_uniform_float_array(GLuint glsl_program_num, const std::string &prefix, const std::string &key, const float *values, size_t num_values);
42 void set_uniform_vec2(GLuint glsl_program_num, const std::string &prefix, const std::string &key, const float *values);
43 void set_uniform_vec3(GLuint glsl_program_num, const std::string &prefix, const std::string &key, const float *values);
44 void set_uniform_vec4_array(GLuint glsl_program_num, const std::string &prefix, const std::string &key, const float *values, size_t num_values);
45
46 class Effect {
47 public: 
48         // Whether this effects expects its input (and output) to be in
49         // linear gamma, ie. without an applied gamma curve. Most effects
50         // will want this, although the ones that never actually look at
51         // the pixels, e.g. mirror, won't need to care, and can set this
52         // to false. If so, the input gamma will be undefined.
53         //
54         // Also see the note on needs_texture_bounce(), below.
55         virtual bool needs_linear_light() const { return true; }
56
57         // Whether this effect expects its input to be in the sRGB
58         // color space, ie. use the sRGB/Rec. 709 RGB primaries.
59         // (If not, it would typically come in as some slightly different
60         // set of RGB primaries; you would currently not get YCbCr
61         // or something similar).
62         //
63         // Again, most effects will want this, but you can set it to false
64         // if you process each channel independently, equally _and_
65         // in a linear fashion.
66         virtual bool needs_srgb_primaries() const { return true; }
67
68         // Whether this effect expects its input to come directly from
69         // a texture. If this is true, the framework will not chain the
70         // input from other effects, but will store the results of the
71         // chain to a temporary (RGBA fp16) texture and let this effect
72         // sample directly from that.
73         //
74         // There are two good reasons why you might want to set this:
75         //
76         //  1. You are sampling more than once from the input,
77         //     in which case computing all the previous steps might
78         //     be more expensive than going to a memory intermediate.
79         //  2. You rely on previous effects, possibly including gamma
80         //     expansion, to happen pre-filtering instead of post-filtering.
81         //     (This is only relevant if you actually need the filtering; if
82         //     you sample on whole input pixels only, it makes no difference.)
83         //
84         // Note that in some cases, you might get post-filtered gamma expansion
85         // even when setting this option. More specifically, if you are the
86         // first effect in the chain, and the GPU is doing sRGB gamma
87         // expansion, it is undefined (from OpenGL's side) whether expansion
88         // happens pre- or post-filtering. For most uses, however,
89         // either will be fine.
90         virtual bool needs_texture_bounce() const { return false; }
91
92         // Whether this effect expects mipmaps or not. If you set this to
93         // true, you will be sampling with bilinear filtering; if not,
94         // you could be sampling with simple linear filtering and no mipmaps
95         // (although there is no guarantee; if a different effect in the chain
96         // needs mipmaps, you will also get them).
97         virtual bool needs_mipmaps() const { return false; }
98
99         // How many inputs this effect will take (a fixed number).
100         // If you have only one input, it will be called INPUT() in GLSL;
101         // if you have several, they will be INPUT1(), INPUT2(), and so on.
102         virtual unsigned num_inputs() const { return 1; }
103
104         // Requests that this effect adds itself to the given effect chain.
105         // For most effects, the default will be fine, but for effects that
106         // consist of multiple passes, it is often useful to replace this
107         // with something that adds completely different things to the chain.
108         virtual void add_self_to_effect_chain(EffectChain *graph, const std::vector<Effect *> &inputs);
109
110         // Outputs one GLSL uniform declaration for each registered parameter
111         // (see below), with the right prefix prepended to each uniform name.
112         // If you do not want this behavior, you can override this function.
113         virtual std::string output_convenience_uniforms() const;
114
115         // Returns the GLSL fragment shader string for this effect.
116         virtual std::string output_fragment_shader() = 0;
117
118         // Set all OpenGL state that this effect needs before rendering.
119         // The default implementation sets one uniform per registered parameter,
120         // but no other state.
121         //
122         // <sampler_num> is the first free texture sampler. If you want to use
123         // textures, you can bind a texture to GL_TEXTURE0 + <sampler_num>,
124         // and then increment the number (so that the next effect in the chain
125         // will use a different sampler).
126         virtual void set_gl_state(GLuint glsl_program_num, const std::string& prefix, unsigned *sampler_num);
127
128         // If you set any special OpenGL state in set_gl_state(), you can clear it
129         // after rendering here. The default implementation does nothing.
130         virtual void clear_gl_state();
131
132         // Set a parameter; intended to be called from user code.
133         // Neither of these take ownership of the pointer.
134         virtual bool set_int(const std::string&, int value);
135         virtual bool set_float(const std::string &key, float value);
136         virtual bool set_vec2(const std::string &key, const float *values);
137         virtual bool set_vec3(const std::string &key, const float *values);
138
139 protected:
140         // Register a parameter. Whenever set_*() is called with the same key,
141         // it will update the value in the given pointer (typically a pointer
142         // to some private member variable in your effect).
143         //
144         // Neither of these take ownership of the pointer.
145
146         // int is special since GLSL pre-1.30 doesn't have integer uniforms.
147         // Thus, ints that you register will _not_ be converted to GLSL uniforms.
148         void register_int(const std::string &key, int *value);
149
150         // These correspond directly to float/vec2/vec3 in GLSL.
151         void register_float(const std::string &key, float *value);
152         void register_vec2(const std::string &key, float *values);
153         void register_vec3(const std::string &key, float *values);
154
155         // This will register a 1D texture, which will be bound to a sampler
156         // when your GLSL code runs (so it corresponds 1:1 to a sampler2D uniform
157         // in GLSL).
158         //
159         // Note that if you change the contents of <values>, you will need to
160         // call invalidate_1d_texture() to have the picture re-uploaded on the
161         // next frame. This is in contrast to all the other parameters, which are
162         // set anew every frame.
163         void register_1d_texture(const std::string &key, float *values, size_t size);
164         void invalidate_1d_texture(const std::string &key);
165         
166 private:
167         struct Texture1D {
168                 float *values;
169                 size_t size;
170                 bool needs_update;
171                 GLuint texture_num;
172         };
173
174         std::map<std::string, int *> params_int;
175         std::map<std::string, float *> params_float;
176         std::map<std::string, float *> params_vec2;
177         std::map<std::string, float *> params_vec3;
178         std::map<std::string, Texture1D> params_tex_1d;
179 };
180
181 #endif // !defined(_EFFECT_H)