8bceaeeb0a1ca8eed9b960fbf62c62d3a1760a0a
[movit] / effect_chain.h
1 #ifndef _MOVIT_EFFECT_CHAIN_H
2 #define _MOVIT_EFFECT_CHAIN_H 1
3
4 // An EffectChain is the largest basic entity in Movit; it contains everything
5 // needed to connects a series of effects, from inputs to outputs, and render
6 // them. Generally you set up your effect chain once and then call its render
7 // functions once per frame; setting one up can be relatively expensive,
8 // but rendering is fast.
9 //
10 // Threading considerations: EffectChain is “thread-compatible”; you can use
11 // different EffectChains in multiple threads at the same time (assuming the
12 // threads do not use the same OpenGL context, but this is a good idea anyway),
13 // but you may not use one EffectChain from multiple threads simultaneously.
14 // You _are_ allowed to use one EffectChain from multiple threads as long as
15 // you only use it from one at a time (possibly by doing your own locking),
16 // but if so, the threads' contexts need to be set up to share resources, since
17 // the EffectChain holds textures and other OpenGL objects that are tied to the
18 // context.
19 //
20 // Memory management (only relevant if you use multiple contexts):
21 // See corresponding comment in resource_pool.h. This holds even if you don't
22 // allocate your own ResourcePool, but let EffectChain hold its own.
23
24 #include <epoxy/gl.h>
25 #include <stdio.h>
26 #include <map>
27 #include <set>
28 #include <string>
29 #include <vector>
30 #include <Eigen/Core>
31
32 #include "effect.h"
33 #include "image_format.h"
34 #include "ycbcr.h"
35
36 namespace movit {
37
38 class Effect;
39 class Input;
40 struct Phase;
41 class ResourcePool;
42
43 // For internal use within Node.
44 enum AlphaType {
45         ALPHA_INVALID = -1,
46         ALPHA_BLANK,
47         ALPHA_PREMULTIPLIED,
48         ALPHA_POSTMULTIPLIED,
49 };
50
51 // Whether you want pre- or postmultiplied alpha in the output
52 // (see effect.h for a discussion of pre- versus postmultiplied alpha).
53 enum OutputAlphaFormat {
54         OUTPUT_ALPHA_FORMAT_PREMULTIPLIED,
55         OUTPUT_ALPHA_FORMAT_POSTMULTIPLIED,
56 };
57
58 // A node in the graph; basically an effect and some associated information.
59 class Node {
60 public:
61         Effect *effect;
62         bool disabled;
63
64         // Edges in the graph (forward and backward).
65         std::vector<Node *> outgoing_links;
66         std::vector<Node *> incoming_links;
67
68         // For unit tests only. Do not use from other code.
69         // Will contain an arbitrary choice if the node is in multiple phases.
70         Phase *containing_phase;
71
72 private:
73         // Logical size of the output of this effect, ie. the resolution
74         // you would get if you sampled it as a texture. If it is undefined
75         // (since the inputs differ in resolution), it will be 0x0.
76         // If both this and output_texture_{width,height} are set,
77         // they will be equal.
78         unsigned output_width, output_height;
79
80         // If the effect has is_single_texture(), or if the output went to RTT
81         // and that texture has been bound to a sampler, the sampler number
82         // will be stored here.
83         //
84         // TODO: Can an RTT texture be used as inputs to multiple effects
85         // within the same phase? If so, we have a problem with modifying
86         // sampler state here.
87         int bound_sampler_num;
88
89         // Used during the building of the effect chain.
90         Colorspace output_color_space;
91         GammaCurve output_gamma_curve;
92         AlphaType output_alpha_type;
93         bool needs_mipmaps;  // Directly or indirectly.
94
95         // Set if this effect, and all effects consuming output from this node
96         // (in the same phase) have one_to_one_sampling() set.
97         bool one_to_one_sampling;
98
99         friend class EffectChain;
100 };
101
102 // A rendering phase; a single GLSL program rendering a single quad.
103 struct Phase {
104         Node *output_node;
105
106         GLuint glsl_program_num;  // Owned by the resource_pool.
107         bool input_needs_mipmaps;
108
109         // Inputs are only inputs from other phases (ie., those that come from RTT);
110         // input textures are counted as part of <effects>.
111         std::vector<Phase *> inputs;
112         std::vector<Node *> effects;  // In order.
113         unsigned output_width, output_height, virtual_output_width, virtual_output_height;
114
115         // Identifier used to create unique variables in GLSL.
116         // Unique per-phase to increase cacheability of compiled shaders.
117         std::map<Node *, std::string> effect_ids;
118
119         // Uniforms for this phase; combined from all the effects.
120         std::vector<Uniform<int> > uniforms_sampler2d;
121         std::vector<Uniform<bool> > uniforms_bool;
122         std::vector<Uniform<int> > uniforms_int;
123         std::vector<Uniform<float> > uniforms_float;
124         std::vector<Uniform<float> > uniforms_vec2;
125         std::vector<Uniform<float> > uniforms_vec3;
126         std::vector<Uniform<float> > uniforms_vec4;
127         std::vector<Uniform<Eigen::Matrix3d> > uniforms_mat3;
128
129         // For measurement of GPU time used.
130         GLuint timer_query_object;
131         uint64_t time_elapsed_ns;
132         uint64_t num_measured_iterations;
133 };
134
135 class EffectChain {
136 public:
137         // Aspect: e.g. 16.0f, 9.0f for 16:9.
138         // resource_pool is a pointer to a ResourcePool with which to share shaders
139         // and other resources (see resource_pool.h). If NULL (the default),
140         // will create its own that is not shared with anything else. Does not take
141         // ownership of the passed-in ResourcePool, but will naturally take ownership
142         // of its own internal one if created.
143         EffectChain(float aspect_nom, float aspect_denom, ResourcePool *resource_pool = NULL);
144         ~EffectChain();
145
146         // User API:
147         // input, effects, output, finalize need to come in that specific order.
148
149         // EffectChain takes ownership of the given input.
150         // input is returned back for convenience.
151         Input *add_input(Input *input);
152
153         // EffectChain takes ownership of the given effect.
154         // effect is returned back for convenience.
155         Effect *add_effect(Effect *effect) {
156                 return add_effect(effect, last_added_effect());
157         }
158         Effect *add_effect(Effect *effect, Effect *input) {
159                 std::vector<Effect *> inputs;
160                 inputs.push_back(input);
161                 return add_effect(effect, inputs);
162         }
163         Effect *add_effect(Effect *effect, Effect *input1, Effect *input2) {
164                 std::vector<Effect *> inputs;
165                 inputs.push_back(input1);
166                 inputs.push_back(input2);
167                 return add_effect(effect, inputs);
168         }
169         Effect *add_effect(Effect *effect, Effect *input1, Effect *input2, Effect *input3) {
170                 std::vector<Effect *> inputs;
171                 inputs.push_back(input1);
172                 inputs.push_back(input2);
173                 inputs.push_back(input3);
174                 return add_effect(effect, inputs);
175         }
176         Effect *add_effect(Effect *effect, const std::vector<Effect *> &inputs);
177
178         // Adds an RGB output. Note that you can only have one output.
179         void add_output(const ImageFormat &format, OutputAlphaFormat alpha_format);
180
181         // Adds an YCbCr output. Note that you can only have one output.
182         // Currently, only chunked packed output is supported, and only 4:4:4
183         // (so chroma_subsampling_x and chroma_subsampling_y must both be 1).
184         void add_ycbcr_output(const ImageFormat &format, OutputAlphaFormat alpha_format,
185                               const YCbCrFormat &ycbcr_format);
186
187         // Set number of output bits, to scale the dither.
188         // 8 is the right value for most outputs.
189         // The default, 0, is a special value that means no dither.
190         void set_dither_bits(unsigned num_bits)
191         {
192                 this->num_dither_bits = num_bits;
193         }
194
195         void finalize();
196
197         // Measure the GPU time used for each actual phase during rendering.
198         // Note that this is only available if GL_ARB_timer_query
199         // (or, equivalently, OpenGL 3.3) is available. Also note that measurement
200         // will incur a performance cost, as we wait for the measurements to
201         // complete at the end of rendering.
202         void enable_phase_timing(bool enable);
203         void reset_phase_timing();
204         void print_phase_timing();
205
206         //void render(unsigned char *src, unsigned char *dst);
207         void render_to_screen()
208         {
209                 render_to_fbo(0, 0, 0);
210         }
211
212         // Render the effect chain to the given FBO. If width=height=0, keeps
213         // the current viewport.
214         void render_to_fbo(GLuint fbo, unsigned width, unsigned height);
215
216         Effect *last_added_effect() {
217                 if (nodes.empty()) {
218                         return NULL;
219                 } else {
220                         return nodes.back()->effect;
221                 }       
222         }
223
224         // API for manipulating the graph directly. Intended to be used from
225         // effects and by EffectChain itself.
226         //
227         // Note that for nodes with multiple inputs, the order of calls to
228         // connect_nodes() will matter.
229         Node *add_node(Effect *effect);
230         void connect_nodes(Node *sender, Node *receiver);
231         void replace_receiver(Node *old_receiver, Node *new_receiver);
232         void replace_sender(Node *new_sender, Node *receiver);
233         void insert_node_between(Node *sender, Node *middle, Node *receiver);
234         Node *find_node_for_effect(Effect *effect) { return node_map[effect]; }
235
236         // Get the OpenGL sampler (GL_TEXTURE0, GL_TEXTURE1, etc.) for the
237         // input of the given node, so that one can modify the sampler state
238         // directly. Only valid to call during set_gl_state().
239         //
240         // Also, for this to be allowed, <node>'s effect must have
241         // needs_texture_bounce() set, so that it samples directly from a
242         // single-sampler input, or from an RTT texture.
243         GLenum get_input_sampler(Node *node, unsigned input_num) const;
244
245         // Get the current resource pool assigned to this EffectChain.
246         // Primarily to let effects allocate textures as needed.
247         // Any resources you get from the pool must be returned to the pool
248         // no later than in the Effect's destructor.
249         ResourcePool *get_resource_pool() { return resource_pool; }
250
251 private:
252         // Make sure the output rectangle is at least large enough to hold
253         // the given input rectangle in both dimensions, and is of the
254         // current aspect ratio (aspect_nom/aspect_denom).
255         void size_rectangle_to_fit(unsigned width, unsigned height, unsigned *output_width, unsigned *output_height);
256
257         // Compute the input sizes for all inputs for all effects in a given phase,
258         // and inform the effects about the results.    
259         void inform_input_sizes(Phase *phase);
260
261         // Determine the preferred output size of a given phase.
262         // Requires that all input phases (if any) already have output sizes set.
263         void find_output_size(Phase *phase);
264
265         // Find all inputs eventually feeding into this effect that have
266         // output gamma different from GAMMA_LINEAR.
267         void find_all_nonlinear_inputs(Node *effect, std::vector<Node *> *nonlinear_inputs);
268
269         // Create a GLSL program computing the effects for this phase in order.
270         void compile_glsl_program(Phase *phase);
271
272         // Create all GLSL programs needed to compute the given effect, and all outputs
273         // that depend on it (whenever possible). Returns the phase that has <output>
274         // as the last effect. Also pushes all phases in order onto <phases>.
275         Phase *construct_phase(Node *output, std::map<Node *, Phase *> *completed_effects);
276
277         // Execute one phase, ie. set up all inputs, effects and outputs, and render the quad.
278         void execute_phase(Phase *phase, bool last_phase, std::map<Phase *, GLuint> *output_textures, std::set<Phase *> *generated_mipmaps);
279
280         // Set up uniforms for one phase. The program must already be bound.
281         void setup_uniforms(Phase *phase);
282
283         // Set up the given sampler number for sampling from an RTT texture,
284         // and bind it to "tex_" plus the given GLSL variable.
285         void setup_rtt_sampler(GLuint glsl_program_num, int sampler_num, const std::string &effect_id, bool use_mipmaps);
286
287         // Output the current graph to the given file in a Graphviz-compatible format;
288         // only useful for debugging.
289         void output_dot(const char *filename);
290         std::vector<std::string> get_labels_for_edge(const Node *from, const Node *to);
291         void output_dot_edge(FILE *fp,
292                              const std::string &from_node_id,
293                              const std::string &to_node_id,
294                              const std::vector<std::string> &labels);
295
296         // Some of the graph algorithms assume that the nodes array is sorted
297         // topologically (inputs are always before outputs), but some operations
298         // (like graph rewriting) can change that. This function restores that order.
299         void sort_all_nodes_topologically();
300
301         // Do the actual topological sort. <nodes> must be a connected, acyclic subgraph;
302         // links that go to nodes not in the set will be ignored.
303         std::vector<Node *> topological_sort(const std::vector<Node *> &nodes);
304
305         // Utility function used by topological_sort() to do a depth-first search.
306         // The reason why we store nodes left to visit instead of a more conventional
307         // list of nodes to visit is that we want to be able to limit ourselves to
308         // a subgraph instead of all nodes. The set thus serves a dual purpose.
309         void topological_sort_visit_node(Node *node, std::set<Node *> *nodes_left_to_visit, std::vector<Node *> *sorted_list);
310
311         // Used during finalize().
312         void find_color_spaces_for_inputs();
313         void propagate_alpha();
314         void propagate_gamma_and_color_space();
315         Node *find_output_node();
316
317         bool node_needs_colorspace_fix(Node *node);
318         void fix_internal_color_spaces();
319         void fix_output_color_space();
320
321         bool node_needs_alpha_fix(Node *node);
322         void fix_internal_alpha(unsigned step);
323         void fix_output_alpha();
324
325         bool node_needs_gamma_fix(Node *node);
326         void fix_internal_gamma_by_asking_inputs(unsigned step);
327         void fix_internal_gamma_by_inserting_nodes(unsigned step);
328         void fix_output_gamma();
329         void add_ycbcr_conversion_if_needed();
330         void add_dither_if_needed();
331
332         float aspect_nom, aspect_denom;
333         ImageFormat output_format;
334         OutputAlphaFormat output_alpha_format;
335
336         enum OutputColorType { OUTPUT_COLOR_RGB, OUTPUT_COLOR_YCBCR };
337         OutputColorType output_color_type;
338         YCbCrFormat output_ycbcr_format;  // If output_color_type == OUTPUT_COLOR_YCBCR.
339
340         std::vector<Node *> nodes;
341         std::map<Effect *, Node *> node_map;
342         Effect *dither_effect;
343
344         std::vector<Input *> inputs;  // Also contained in nodes.
345         std::vector<Phase *> phases;
346
347         unsigned num_dither_bits;
348         bool finalized;
349
350         ResourcePool *resource_pool;
351         bool owns_resource_pool;
352
353         bool do_phase_timing;
354 };
355
356 }  // namespace movit
357
358 #endif // !defined(_MOVIT_EFFECT_CHAIN_H)