Add support for compute shaders.
[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 <list>
27 #include <map>
28 #include <set>
29 #include <string>
30 #include <vector>
31 #include <Eigen/Core>
32
33 #include "effect.h"
34 #include "image_format.h"
35 #include "ycbcr.h"
36
37 namespace movit {
38
39 class Effect;
40 class Input;
41 struct Phase;
42 class ResourcePool;
43
44 // For internal use within Node.
45 enum AlphaType {
46         ALPHA_INVALID = -1,
47         ALPHA_BLANK,
48         ALPHA_PREMULTIPLIED,
49         ALPHA_POSTMULTIPLIED,
50 };
51
52 // Whether you want pre- or postmultiplied alpha in the output
53 // (see effect.h for a discussion of pre- versus postmultiplied alpha).
54 enum OutputAlphaFormat {
55         OUTPUT_ALPHA_FORMAT_PREMULTIPLIED,
56         OUTPUT_ALPHA_FORMAT_POSTMULTIPLIED,
57 };
58
59 // RGBA output is nearly always packed; Y'CbCr, however, is often planar
60 // due to chroma subsampling. This enum controls how add_ycbcr_output()
61 // distributes the color channels between the fragment shader outputs.
62 // Obviously, anything except YCBCR_OUTPUT_INTERLEAVED will be meaningless
63 // unless you use render_to_fbo() and have an FBO with multiple render
64 // targets attached (the other outputs will be discarded).
65 enum YCbCrOutputSplitting {
66         // Only one output: Store Y'CbCr into the first three output channels,
67         // respectively, plus alpha. This is also called “chunked” or
68         // ”packed” mode.
69         YCBCR_OUTPUT_INTERLEAVED,
70
71         // Store Y' and alpha into the first output (in the red and alpha
72         // channels; effect to the others is undefined), and Cb and Cr into
73         // the first two channels of the second output. This is particularly
74         // useful if you want to end up in a format like NV12, where all the
75         // Y' samples come first and then Cb and Cr come interlevaed afterwards.
76         // You will still need to do the chroma subsampling yourself to actually
77         // get down to NV12, though.
78         YCBCR_OUTPUT_SPLIT_Y_AND_CBCR,
79
80         // Store Y' and alpha into the first output, Cb into the first channel
81         // of the second output and Cr into the first channel of the third output.
82         // (Effect on the other channels is undefined.) Essentially gives you
83         // 4:4:4 planar, or ”yuv444p”.
84         YCBCR_OUTPUT_PLANAR,
85 };
86
87 // Where (0,0) is taken to be in the output. If you want to render to an
88 // OpenGL screen, you should keep the default of bottom-left, as that is
89 // OpenGL's natural coordinate system. However, there are cases, such as if you
90 // render to an FBO and read the pixels back into some other system, where
91 // you'd want a top-left origin; if so, an additional flip step will be added
92 // at the very end (but done in a vertex shader, so it will have zero extra
93 // cost).
94 //
95 // Note that Movit's coordinate system in general consistently puts (0,0) in
96 // the top left for _input_, no matter what you set as output origin.
97 enum OutputOrigin {
98         OUTPUT_ORIGIN_BOTTOM_LEFT,
99         OUTPUT_ORIGIN_TOP_LEFT,
100 };
101
102 // Transformation to apply (if any) to pixel data in temporary buffers.
103 // See set_intermediate_format() below for more information.
104 enum FramebufferTransformation {
105         // The default; just store the value. This is what you usually want.
106         NO_FRAMEBUFFER_TRANSFORMATION,
107
108         // If the values are in linear light, store sqrt(x) to the framebuffer
109         // instead of x itself, of course undoing it with x² on read. Useful as
110         // a rough approximation to the sRGB curve. (If the values are not in
111         // linear light, just store them as-is.)
112         SQUARE_ROOT_FRAMEBUFFER_TRANSFORMATION,
113 };
114
115 // A node in the graph; basically an effect and some associated information.
116 class Node {
117 public:
118         Effect *effect;
119         bool disabled;
120
121         // Edges in the graph (forward and backward).
122         std::vector<Node *> outgoing_links;
123         std::vector<Node *> incoming_links;
124
125         // For unit tests only. Do not use from other code.
126         // Will contain an arbitrary choice if the node is in multiple phases.
127         Phase *containing_phase;
128
129 private:
130         // Logical size of the output of this effect, ie. the resolution
131         // you would get if you sampled it as a texture. If it is undefined
132         // (since the inputs differ in resolution), it will be 0x0.
133         // If both this and output_texture_{width,height} are set,
134         // they will be equal.
135         unsigned output_width, output_height;
136
137         // If the effect has is_single_texture(), or if the output went to RTT
138         // and that texture has been bound to a sampler, the sampler number
139         // will be stored here.
140         //
141         // TODO: Can an RTT texture be used as inputs to multiple effects
142         // within the same phase? If so, we have a problem with modifying
143         // sampler state here.
144         int bound_sampler_num;
145
146         // Used during the building of the effect chain.
147         Colorspace output_color_space;
148         GammaCurve output_gamma_curve;
149         AlphaType output_alpha_type;
150         bool needs_mipmaps;  // Directly or indirectly.
151
152         // Set if this effect, and all effects consuming output from this node
153         // (in the same phase) have one_to_one_sampling() set.
154         bool one_to_one_sampling;
155
156         friend class EffectChain;
157 };
158
159 // A rendering phase; a single GLSL program rendering a single quad.
160 struct Phase {
161         Node *output_node;
162
163         GLuint glsl_program_num;  // Owned by the resource_pool.
164
165         // Position and texcoord attribute indexes, although it doesn't matter
166         // which is which, because they contain the same data.
167         std::set<GLint> attribute_indexes;
168
169         bool input_needs_mipmaps;
170
171         // Inputs are only inputs from other phases (ie., those that come from RTT);
172         // input textures are counted as part of <effects>.
173         std::vector<Phase *> inputs;
174         // Bound sampler numbers for each input. Redundant in a sense
175         // (it always corresponds to the index), but we need somewhere
176         // to hold the value for the uniform.
177         std::vector<int> input_samplers;
178         std::vector<Node *> effects;  // In order.
179         unsigned output_width, output_height, virtual_output_width, virtual_output_height;
180
181         // Whether this phase is compiled as a compute shader, ie., the last effect is
182         // marked as one.
183         bool is_compute_shader;
184
185         // If <is_compute_shader>, which image unit the output buffer is bound to.
186         // This is used as source for a Uniform<int> below.
187         int outbuf_image_unit;
188
189         // These are used in transforming from unnormalized to normalized coordinates
190         // in compute shaders.
191         Point2D inv_output_size, output_texcoord_adjust;
192
193         // Identifier used to create unique variables in GLSL.
194         // Unique per-phase to increase cacheability of compiled shaders.
195         std::map<Node *, std::string> effect_ids;
196
197         // Uniforms for this phase; combined from all the effects.
198         std::vector<Uniform<int> > uniforms_image2d;
199         std::vector<Uniform<int> > uniforms_sampler2d;
200         std::vector<Uniform<bool> > uniforms_bool;
201         std::vector<Uniform<int> > uniforms_int;
202         std::vector<Uniform<float> > uniforms_float;
203         std::vector<Uniform<float> > uniforms_vec2;
204         std::vector<Uniform<float> > uniforms_vec3;
205         std::vector<Uniform<float> > uniforms_vec4;
206         std::vector<Uniform<Eigen::Matrix3d> > uniforms_mat3;
207
208         // For measurement of GPU time used.
209         std::list<GLuint> timer_query_objects_running;
210         std::list<GLuint> timer_query_objects_free;
211         uint64_t time_elapsed_ns;
212         uint64_t num_measured_iterations;
213 };
214
215 class EffectChain {
216 public:
217         // Aspect: e.g. 16.0f, 9.0f for 16:9.
218         // resource_pool is a pointer to a ResourcePool with which to share shaders
219         // and other resources (see resource_pool.h). If NULL (the default),
220         // will create its own that is not shared with anything else. Does not take
221         // ownership of the passed-in ResourcePool, but will naturally take ownership
222         // of its own internal one if created.
223         EffectChain(float aspect_nom, float aspect_denom, ResourcePool *resource_pool = NULL);
224         ~EffectChain();
225
226         // User API:
227         // input, effects, output, finalize need to come in that specific order.
228
229         // EffectChain takes ownership of the given input.
230         // input is returned back for convenience.
231         Input *add_input(Input *input);
232
233         // EffectChain takes ownership of the given effect.
234         // effect is returned back for convenience.
235         Effect *add_effect(Effect *effect) {
236                 return add_effect(effect, last_added_effect());
237         }
238         Effect *add_effect(Effect *effect, Effect *input) {
239                 std::vector<Effect *> inputs;
240                 inputs.push_back(input);
241                 return add_effect(effect, inputs);
242         }
243         Effect *add_effect(Effect *effect, Effect *input1, Effect *input2) {
244                 std::vector<Effect *> inputs;
245                 inputs.push_back(input1);
246                 inputs.push_back(input2);
247                 return add_effect(effect, inputs);
248         }
249         Effect *add_effect(Effect *effect, Effect *input1, Effect *input2, Effect *input3) {
250                 std::vector<Effect *> inputs;
251                 inputs.push_back(input1);
252                 inputs.push_back(input2);
253                 inputs.push_back(input3);
254                 return add_effect(effect, inputs);
255         }
256         Effect *add_effect(Effect *effect, Effect *input1, Effect *input2, Effect *input3, Effect *input4) {
257                 std::vector<Effect *> inputs;
258                 inputs.push_back(input1);
259                 inputs.push_back(input2);
260                 inputs.push_back(input3);
261                 inputs.push_back(input4);
262                 return add_effect(effect, inputs);
263         }
264         Effect *add_effect(Effect *effect, Effect *input1, Effect *input2, Effect *input3, Effect *input4, Effect *input5) {
265                 std::vector<Effect *> inputs;
266                 inputs.push_back(input1);
267                 inputs.push_back(input2);
268                 inputs.push_back(input3);
269                 inputs.push_back(input4);
270                 inputs.push_back(input5);
271                 return add_effect(effect, inputs);
272         }
273         Effect *add_effect(Effect *effect, const std::vector<Effect *> &inputs);
274
275         // Adds an RGBA output. Note that you can have at most one RGBA output and two
276         // Y'CbCr outputs (see below for details).
277         void add_output(const ImageFormat &format, OutputAlphaFormat alpha_format);
278
279         // Adds an YCbCr output. Note that you can only have at most two Y'CbCr
280         // outputs, and they must have the same <ycbcr_format> and <type>.
281         // (This limitation may be lifted in the future, to allow e.g. simultaneous
282         // 8- and 10-bit output. Currently, multiple Y'CbCr outputs are only
283         // useful in some very limited circumstances, like if one texture goes
284         // to some place you cannot easily read from later.)
285         //
286         // Only 4:4:4 output is supported due to fragment shader limitations,
287         // so chroma_subsampling_x and chroma_subsampling_y must both be 1.
288         // <type> should match the data type of the FBO you are rendering to,
289         // so that if you use 16-bit output (GL_UNSIGNED_SHORT), you will get
290         // 8-, 10- or 12-bit output correctly as determined by <ycbcr_format.num_levels>.
291         // Using e.g. ycbcr_format.num_levels == 1024 with GL_UNSIGNED_BYTE is
292         // nonsensical and invokes undefined behavior.
293         //
294         // If you have both RGBA and Y'CbCr output(s), the RGBA output will come
295         // in the last draw buffer. Also, <format> and <alpha_format> must be
296         // identical between the two.
297         void add_ycbcr_output(const ImageFormat &format, OutputAlphaFormat alpha_format,
298                               const YCbCrFormat &ycbcr_format,
299                               YCbCrOutputSplitting output_splitting = YCBCR_OUTPUT_INTERLEAVED,
300                               GLenum output_type = GL_UNSIGNED_BYTE);
301
302         // Change Y'CbCr output format. (This can be done also after finalize()).
303         // Note that you are not allowed to change subsampling parameters;
304         // however, you can change the color space parameters, ie.,
305         // luma_coefficients, full_range and num_levels.
306         void change_ycbcr_output_format(const YCbCrFormat &ycbcr_format);
307
308         // Set number of output bits, to scale the dither.
309         // 8 is the right value for most outputs.
310         //
311         // Special note for 10- and 12-bit Y'CbCr packed into GL_UNSIGNED_SHORT:
312         // This is relative to the actual output, not the logical one, so you should
313         // specify 16 here, not 10 or 12.
314         //
315         // The default, 0, is a special value that means no dither.
316         void set_dither_bits(unsigned num_bits)
317         {
318                 this->num_dither_bits = num_bits;
319         }
320
321         // Set where (0,0) is taken to be in the output. The default is
322         // OUTPUT_ORIGIN_BOTTOM_LEFT, which is usually what you want
323         // (see OutputOrigin above for more details).
324         void set_output_origin(OutputOrigin output_origin)
325         {
326                 this->output_origin = output_origin;
327         }
328
329         // Set intermediate format for framebuffers used when we need to bounce
330         // to a temporary texture. The default, GL_RGBA16F, is good for most uses;
331         // it is precise, has good range, and is relatively efficient. However,
332         // if you need even more speed and your chain can do with some loss of
333         // accuracy, you can change the format here (before calling finalize).
334         // Calculations between bounce buffers are still in 32-bit floating-point
335         // no matter what you specify.
336         //
337         // Of special interest is GL_SRGB8_ALPHA8, which stores sRGB-encoded RGB
338         // and linear alpha; this is half the memory bandwidth of GL_RGBA16F,
339         // while retaining reasonable precision for typical image data. It will,
340         // however, cause some gamut clipping if your colorspace is far from sRGB,
341         // as it cannot represent values outside [0,1]. NOTE: If you construct
342         // a chain where you end up bouncing pixels in non-linear light
343         // (gamma different from GAMMA_LINEAR), this will be the wrong thing.
344         // However, it's hard to see how this could happen in a non-contrived
345         // chain; few effects ever need texture bounce or resizing without also
346         // combining multiple pixels, which really needs linear light and thus
347         // triggers a conversion before the bounce.
348         //
349         // If you don't need alpha (or can do with very little of it), GL_RGB10_A2
350         // is even better, as it has two more bits for each color component. There
351         // is no GL_SRGB10, unfortunately, so on its own, it is somewhat worse than
352         // GL_SRGB8, but you can set <transformation> to SQUARE_ROOT_FRAMEBUFFER_TRANSFORMATION,
353         // and sqrt(x) will be stored instead of x. This is a rough approximation to
354         // the sRGB curve, and reduces maximum error (in sRGB distance) by almost an
355         // order of magnitude, well below what you can get from 8-bit true sRGB.
356         // (Note that this strategy avoids the problem with bounced non-linear data
357         // above, since the square root is turned off in that case.) However, texture
358         // filtering will happen on the transformed values, so if you have heavy
359         // downscaling or the likes (e.g. mipmaps), you could get subtly bad results.
360         // You'll need to see which of the two that works the best for you in practice.
361         void set_intermediate_format(
362                 GLenum intermediate_format,
363                 FramebufferTransformation transformation = NO_FRAMEBUFFER_TRANSFORMATION)
364         {
365                 this->intermediate_format = intermediate_format;
366                 this->intermediate_transformation = transformation;
367         }
368
369         void finalize();
370
371         // Measure the GPU time used for each actual phase during rendering.
372         // Note that this is only available if GL_ARB_timer_query
373         // (or, equivalently, OpenGL 3.3) is available. Also note that measurement
374         // will incur a performance cost, as we wait for the measurements to
375         // complete at the end of rendering.
376         void enable_phase_timing(bool enable);
377         void reset_phase_timing();
378         void print_phase_timing();
379
380         // Note: If you already know the width and height of the viewport,
381         // calling render_to_fbo() directly will be slightly more efficient,
382         // as it saves it from getting it from OpenGL.
383         void render_to_screen()
384         {
385                 render_to_fbo(0, 0, 0);
386         }
387
388         // Render the effect chain to the given FBO. If width=height=0, keeps
389         // the current viewport.
390         void render_to_fbo(GLuint fbo, unsigned width, unsigned height);
391
392         Effect *last_added_effect() {
393                 if (nodes.empty()) {
394                         return NULL;
395                 } else {
396                         return nodes.back()->effect;
397                 }       
398         }
399
400         // API for manipulating the graph directly. Intended to be used from
401         // effects and by EffectChain itself.
402         //
403         // Note that for nodes with multiple inputs, the order of calls to
404         // connect_nodes() will matter.
405         Node *add_node(Effect *effect);
406         void connect_nodes(Node *sender, Node *receiver);
407         void replace_receiver(Node *old_receiver, Node *new_receiver);
408         void replace_sender(Node *new_sender, Node *receiver);
409         void insert_node_between(Node *sender, Node *middle, Node *receiver);
410         Node *find_node_for_effect(Effect *effect) { return node_map[effect]; }
411
412         // Get the OpenGL sampler (GL_TEXTURE0, GL_TEXTURE1, etc.) for the
413         // input of the given node, so that one can modify the sampler state
414         // directly. Only valid to call during set_gl_state().
415         //
416         // Also, for this to be allowed, <node>'s effect must have
417         // needs_texture_bounce() set, so that it samples directly from a
418         // single-sampler input, or from an RTT texture.
419         GLenum get_input_sampler(Node *node, unsigned input_num) const;
420
421         // Whether input <input_num> of <node> corresponds to a single sampler
422         // (see get_input_sampler()). Normally, you should not need to call this;
423         // however, if the input Effect has set override_texture_bounce(),
424         // this will return false, and you could be flexible and check it first
425         // if you want.
426         GLenum has_input_sampler(Node *node, unsigned input_num) const;
427
428         // Get the current resource pool assigned to this EffectChain.
429         // Primarily to let effects allocate textures as needed.
430         // Any resources you get from the pool must be returned to the pool
431         // no later than in the Effect's destructor.
432         ResourcePool *get_resource_pool() { return resource_pool; }
433
434 private:
435         // Make sure the output rectangle is at least large enough to hold
436         // the given input rectangle in both dimensions, and is of the
437         // current aspect ratio (aspect_nom/aspect_denom).
438         void size_rectangle_to_fit(unsigned width, unsigned height, unsigned *output_width, unsigned *output_height);
439
440         // Compute the input sizes for all inputs for all effects in a given phase,
441         // and inform the effects about the results.    
442         void inform_input_sizes(Phase *phase);
443
444         // Determine the preferred output size of a given phase.
445         // Requires that all input phases (if any) already have output sizes set.
446         void find_output_size(Phase *phase);
447
448         // Find all inputs eventually feeding into this effect that have
449         // output gamma different from GAMMA_LINEAR.
450         void find_all_nonlinear_inputs(Node *effect, std::vector<Node *> *nonlinear_inputs);
451
452         // Create a GLSL program computing the effects for this phase in order.
453         void compile_glsl_program(Phase *phase);
454
455         // Create all GLSL programs needed to compute the given effect, and all outputs
456         // that depend on it (whenever possible). Returns the phase that has <output>
457         // as the last effect. Also pushes all phases in order onto <phases>.
458         Phase *construct_phase(Node *output, std::map<Node *, Phase *> *completed_effects);
459
460         // Execute one phase, ie. set up all inputs, effects and outputs, and render the quad.
461         void execute_phase(Phase *phase, bool last_phase,
462                            std::map<Phase *, GLuint> *output_textures,
463                            std::set<Phase *> *generated_mipmaps);
464
465         // Set up uniforms for one phase. The program must already be bound.
466         void setup_uniforms(Phase *phase);
467
468         // Set up the given sampler number for sampling from an RTT texture.
469         void setup_rtt_sampler(int sampler_num, bool use_mipmaps);
470
471         // Output the current graph to the given file in a Graphviz-compatible format;
472         // only useful for debugging.
473         void output_dot(const char *filename);
474         std::vector<std::string> get_labels_for_edge(const Node *from, const Node *to);
475         void output_dot_edge(FILE *fp,
476                              const std::string &from_node_id,
477                              const std::string &to_node_id,
478                              const std::vector<std::string> &labels);
479
480         // Some of the graph algorithms assume that the nodes array is sorted
481         // topologically (inputs are always before outputs), but some operations
482         // (like graph rewriting) can change that. This function restores that order.
483         void sort_all_nodes_topologically();
484
485         // Do the actual topological sort. <nodes> must be a connected, acyclic subgraph;
486         // links that go to nodes not in the set will be ignored.
487         std::vector<Node *> topological_sort(const std::vector<Node *> &nodes);
488
489         // Utility function used by topological_sort() to do a depth-first search.
490         // The reason why we store nodes left to visit instead of a more conventional
491         // list of nodes to visit is that we want to be able to limit ourselves to
492         // a subgraph instead of all nodes. The set thus serves a dual purpose.
493         void topological_sort_visit_node(Node *node, std::set<Node *> *nodes_left_to_visit, std::vector<Node *> *sorted_list);
494
495         // Used during finalize().
496         void find_color_spaces_for_inputs();
497         void propagate_alpha();
498         void propagate_gamma_and_color_space();
499         Node *find_output_node();
500
501         bool node_needs_colorspace_fix(Node *node);
502         void fix_internal_color_spaces();
503         void fix_output_color_space();
504
505         bool node_needs_alpha_fix(Node *node);
506         void fix_internal_alpha(unsigned step);
507         void fix_output_alpha();
508
509         bool node_needs_gamma_fix(Node *node);
510         void fix_internal_gamma_by_asking_inputs(unsigned step);
511         void fix_internal_gamma_by_inserting_nodes(unsigned step);
512         void fix_output_gamma();
513         void add_ycbcr_conversion_if_needed();
514         void add_dither_if_needed();
515         void add_dummy_effect_if_needed();
516
517         float aspect_nom, aspect_denom;
518         ImageFormat output_format;
519         OutputAlphaFormat output_alpha_format;
520
521         bool output_color_rgba;
522         int num_output_color_ycbcr;                      // Max 2.
523         YCbCrFormat output_ycbcr_format;                 // If num_output_color_ycbcr is > 0.
524         GLenum output_ycbcr_type;                        // If num_output_color_ycbcr is > 0.
525         YCbCrOutputSplitting output_ycbcr_splitting[2];  // If num_output_color_ycbcr is > N.
526
527         std::vector<Node *> nodes;
528         std::map<Effect *, Node *> node_map;
529         Effect *dither_effect;
530         Node *ycbcr_conversion_effect_node;
531
532         std::vector<Input *> inputs;  // Also contained in nodes.
533         std::vector<Phase *> phases;
534
535         GLenum intermediate_format;
536         FramebufferTransformation intermediate_transformation;
537         unsigned num_dither_bits;
538         OutputOrigin output_origin;
539         bool finalized;
540         GLuint vbo;  // Contains vertex and texture coordinate data.
541
542         ResourcePool *resource_pool;
543         bool owns_resource_pool;
544
545         bool do_phase_timing;
546 };
547
548 }  // namespace movit
549
550 #endif // !defined(_MOVIT_EFFECT_CHAIN_H)