Forgot to increment version.h for bounce override; doing so now.
[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 // RGBA output is nearly always packed; Y'CbCr, however, is often planar
59 // due to chroma subsampling. This enum controls how add_ycbcr_output()
60 // distributes the color channels between the fragment shader outputs.
61 // Obviously, anything except YCBCR_OUTPUT_INTERLEAVED will be meaningless
62 // unless you use render_to_fbo() and have an FBO with multiple render
63 // targets attached (the other outputs will be discarded).
64 enum YCbCrOutputSplitting {
65         // Only one output: Store Y'CbCr into the first three output channels,
66         // respectively, plus alpha. This is also called “chunked” or
67         // ”packed” mode.
68         YCBCR_OUTPUT_INTERLEAVED,
69
70         // Store Y' and alpha into the first output (in the red and alpha
71         // channels; effect to the others is undefined), and Cb and Cr into
72         // the first two channels of the second output. This is particularly
73         // useful if you want to end up in a format like NV12, where all the
74         // Y' samples come first and then Cb and Cr come interlevaed afterwards.
75         // You will still need to do the chroma subsampling yourself to actually
76         // get down to NV12, though.
77         YCBCR_OUTPUT_SPLIT_Y_AND_CBCR,
78
79         // Store Y' and alpha into the first output, Cb into the first channel
80         // of the second output and Cr into the first channel of the third output.
81         // (Effect on the other channels is undefined.) Essentially gives you
82         // 4:4:4 planar, or ”yuv444p”.
83         YCBCR_OUTPUT_PLANAR,
84 };
85
86 // Where (0,0) is taken to be in the output. If you want to render to an
87 // OpenGL screen, you should keep the default of bottom-left, as that is
88 // OpenGL's natural coordinate system. However, there are cases, such as if you
89 // render to an FBO and read the pixels back into some other system, where
90 // you'd want a top-left origin; if so, an additional flip step will be added
91 // at the very end (but done in a vertex shader, so it will have zero extra
92 // cost).
93 //
94 // Note that Movit's coordinate system in general consistently puts (0,0) in
95 // the top left for _input_, no matter what you set as output origin.
96 enum OutputOrigin {
97         OUTPUT_ORIGIN_BOTTOM_LEFT,
98         OUTPUT_ORIGIN_TOP_LEFT,
99 };
100
101 // A node in the graph; basically an effect and some associated information.
102 class Node {
103 public:
104         Effect *effect;
105         bool disabled;
106
107         // Edges in the graph (forward and backward).
108         std::vector<Node *> outgoing_links;
109         std::vector<Node *> incoming_links;
110
111         // For unit tests only. Do not use from other code.
112         // Will contain an arbitrary choice if the node is in multiple phases.
113         Phase *containing_phase;
114
115 private:
116         // Logical size of the output of this effect, ie. the resolution
117         // you would get if you sampled it as a texture. If it is undefined
118         // (since the inputs differ in resolution), it will be 0x0.
119         // If both this and output_texture_{width,height} are set,
120         // they will be equal.
121         unsigned output_width, output_height;
122
123         // If the effect has is_single_texture(), or if the output went to RTT
124         // and that texture has been bound to a sampler, the sampler number
125         // will be stored here.
126         //
127         // TODO: Can an RTT texture be used as inputs to multiple effects
128         // within the same phase? If so, we have a problem with modifying
129         // sampler state here.
130         int bound_sampler_num;
131
132         // Used during the building of the effect chain.
133         Colorspace output_color_space;
134         GammaCurve output_gamma_curve;
135         AlphaType output_alpha_type;
136         bool needs_mipmaps;  // Directly or indirectly.
137
138         // Set if this effect, and all effects consuming output from this node
139         // (in the same phase) have one_to_one_sampling() set.
140         bool one_to_one_sampling;
141
142         friend class EffectChain;
143 };
144
145 // A rendering phase; a single GLSL program rendering a single quad.
146 struct Phase {
147         Node *output_node;
148
149         GLuint glsl_program_num;  // Owned by the resource_pool.
150         bool input_needs_mipmaps;
151
152         // Inputs are only inputs from other phases (ie., those that come from RTT);
153         // input textures are counted as part of <effects>.
154         std::vector<Phase *> inputs;
155         // Bound sampler numbers for each input. Redundant in a sense
156         // (it always corresponds to the index), but we need somewhere
157         // to hold the value for the uniform.
158         std::vector<int> input_samplers;
159         std::vector<Node *> effects;  // In order.
160         unsigned output_width, output_height, virtual_output_width, virtual_output_height;
161
162         // Identifier used to create unique variables in GLSL.
163         // Unique per-phase to increase cacheability of compiled shaders.
164         std::map<Node *, std::string> effect_ids;
165
166         // Uniforms for this phase; combined from all the effects.
167         std::vector<Uniform<int> > uniforms_sampler2d;
168         std::vector<Uniform<bool> > uniforms_bool;
169         std::vector<Uniform<int> > uniforms_int;
170         std::vector<Uniform<float> > uniforms_float;
171         std::vector<Uniform<float> > uniforms_vec2;
172         std::vector<Uniform<float> > uniforms_vec3;
173         std::vector<Uniform<float> > uniforms_vec4;
174         std::vector<Uniform<Eigen::Matrix3d> > uniforms_mat3;
175
176         // For measurement of GPU time used.
177         GLuint timer_query_object;
178         uint64_t time_elapsed_ns;
179         uint64_t num_measured_iterations;
180 };
181
182 class EffectChain {
183 public:
184         // Aspect: e.g. 16.0f, 9.0f for 16:9.
185         // resource_pool is a pointer to a ResourcePool with which to share shaders
186         // and other resources (see resource_pool.h). If NULL (the default),
187         // will create its own that is not shared with anything else. Does not take
188         // ownership of the passed-in ResourcePool, but will naturally take ownership
189         // of its own internal one if created.
190         EffectChain(float aspect_nom, float aspect_denom, ResourcePool *resource_pool = NULL);
191         ~EffectChain();
192
193         // User API:
194         // input, effects, output, finalize need to come in that specific order.
195
196         // EffectChain takes ownership of the given input.
197         // input is returned back for convenience.
198         Input *add_input(Input *input);
199
200         // EffectChain takes ownership of the given effect.
201         // effect is returned back for convenience.
202         Effect *add_effect(Effect *effect) {
203                 return add_effect(effect, last_added_effect());
204         }
205         Effect *add_effect(Effect *effect, Effect *input) {
206                 std::vector<Effect *> inputs;
207                 inputs.push_back(input);
208                 return add_effect(effect, inputs);
209         }
210         Effect *add_effect(Effect *effect, Effect *input1, Effect *input2) {
211                 std::vector<Effect *> inputs;
212                 inputs.push_back(input1);
213                 inputs.push_back(input2);
214                 return add_effect(effect, inputs);
215         }
216         Effect *add_effect(Effect *effect, Effect *input1, Effect *input2, Effect *input3) {
217                 std::vector<Effect *> inputs;
218                 inputs.push_back(input1);
219                 inputs.push_back(input2);
220                 inputs.push_back(input3);
221                 return add_effect(effect, inputs);
222         }
223         Effect *add_effect(Effect *effect, const std::vector<Effect *> &inputs);
224
225         // Adds an RGBA output. Note that you can have at most one RGBA output and one
226         // Y'CbCr output (see below for details).
227         void add_output(const ImageFormat &format, OutputAlphaFormat alpha_format);
228
229         // Adds an YCbCr output. Note that you can only have one output.
230         // Currently, only chunked packed output is supported, and only 4:4:4
231         // (so chroma_subsampling_x and chroma_subsampling_y must both be 1).
232         //
233         // If you have both RGBA and Y'CbCr output, the RGBA output will come
234         // in the last draw buffer. Also, <format> and <alpha_format> must be
235         // identical between the two.
236         void add_ycbcr_output(const ImageFormat &format, OutputAlphaFormat alpha_format,
237                               const YCbCrFormat &ycbcr_format,
238                               YCbCrOutputSplitting output_splitting = YCBCR_OUTPUT_INTERLEAVED);
239
240         // Set number of output bits, to scale the dither.
241         // 8 is the right value for most outputs.
242         // The default, 0, is a special value that means no dither.
243         void set_dither_bits(unsigned num_bits)
244         {
245                 this->num_dither_bits = num_bits;
246         }
247
248         // Set where (0,0) is taken to be in the output. The default is
249         // OUTPUT_ORIGIN_BOTTOM_LEFT, which is usually what you want
250         // (see OutputOrigin above for more details).
251         void set_output_origin(OutputOrigin output_origin)
252         {
253                 this->output_origin = output_origin;
254         }
255
256         void finalize();
257
258         // Measure the GPU time used for each actual phase during rendering.
259         // Note that this is only available if GL_ARB_timer_query
260         // (or, equivalently, OpenGL 3.3) is available. Also note that measurement
261         // will incur a performance cost, as we wait for the measurements to
262         // complete at the end of rendering.
263         void enable_phase_timing(bool enable);
264         void reset_phase_timing();
265         void print_phase_timing();
266
267         //void render(unsigned char *src, unsigned char *dst);
268         void render_to_screen()
269         {
270                 render_to_fbo(0, 0, 0);
271         }
272
273         // Render the effect chain to the given FBO. If width=height=0, keeps
274         // the current viewport.
275         void render_to_fbo(GLuint fbo, unsigned width, unsigned height);
276
277         Effect *last_added_effect() {
278                 if (nodes.empty()) {
279                         return NULL;
280                 } else {
281                         return nodes.back()->effect;
282                 }       
283         }
284
285         // API for manipulating the graph directly. Intended to be used from
286         // effects and by EffectChain itself.
287         //
288         // Note that for nodes with multiple inputs, the order of calls to
289         // connect_nodes() will matter.
290         Node *add_node(Effect *effect);
291         void connect_nodes(Node *sender, Node *receiver);
292         void replace_receiver(Node *old_receiver, Node *new_receiver);
293         void replace_sender(Node *new_sender, Node *receiver);
294         void insert_node_between(Node *sender, Node *middle, Node *receiver);
295         Node *find_node_for_effect(Effect *effect) { return node_map[effect]; }
296
297         // Get the OpenGL sampler (GL_TEXTURE0, GL_TEXTURE1, etc.) for the
298         // input of the given node, so that one can modify the sampler state
299         // directly. Only valid to call during set_gl_state().
300         //
301         // Also, for this to be allowed, <node>'s effect must have
302         // needs_texture_bounce() set, so that it samples directly from a
303         // single-sampler input, or from an RTT texture.
304         GLenum get_input_sampler(Node *node, unsigned input_num) const;
305
306         // Whether input <input_num> of <node> corresponds to a single sampler
307         // (see get_input_sampler()). Normally, you should not need to call this;
308         // however, if the input Effect has set override_texture_bounce(),
309         // this will return false, and you could be flexible and check it first
310         // if you want.
311         GLenum has_input_sampler(Node *node, unsigned input_num) const;
312
313         // Get the current resource pool assigned to this EffectChain.
314         // Primarily to let effects allocate textures as needed.
315         // Any resources you get from the pool must be returned to the pool
316         // no later than in the Effect's destructor.
317         ResourcePool *get_resource_pool() { return resource_pool; }
318
319 private:
320         // Make sure the output rectangle is at least large enough to hold
321         // the given input rectangle in both dimensions, and is of the
322         // current aspect ratio (aspect_nom/aspect_denom).
323         void size_rectangle_to_fit(unsigned width, unsigned height, unsigned *output_width, unsigned *output_height);
324
325         // Compute the input sizes for all inputs for all effects in a given phase,
326         // and inform the effects about the results.    
327         void inform_input_sizes(Phase *phase);
328
329         // Determine the preferred output size of a given phase.
330         // Requires that all input phases (if any) already have output sizes set.
331         void find_output_size(Phase *phase);
332
333         // Find all inputs eventually feeding into this effect that have
334         // output gamma different from GAMMA_LINEAR.
335         void find_all_nonlinear_inputs(Node *effect, std::vector<Node *> *nonlinear_inputs);
336
337         // Create a GLSL program computing the effects for this phase in order.
338         void compile_glsl_program(Phase *phase);
339
340         // Create all GLSL programs needed to compute the given effect, and all outputs
341         // that depend on it (whenever possible). Returns the phase that has <output>
342         // as the last effect. Also pushes all phases in order onto <phases>.
343         Phase *construct_phase(Node *output, std::map<Node *, Phase *> *completed_effects);
344
345         // Execute one phase, ie. set up all inputs, effects and outputs, and render the quad.
346         void execute_phase(Phase *phase, bool last_phase, std::map<Phase *, GLuint> *output_textures, std::set<Phase *> *generated_mipmaps);
347
348         // Set up uniforms for one phase. The program must already be bound.
349         void setup_uniforms(Phase *phase);
350
351         // Set up the given sampler number for sampling from an RTT texture.
352         void setup_rtt_sampler(int sampler_num, bool use_mipmaps);
353
354         // Output the current graph to the given file in a Graphviz-compatible format;
355         // only useful for debugging.
356         void output_dot(const char *filename);
357         std::vector<std::string> get_labels_for_edge(const Node *from, const Node *to);
358         void output_dot_edge(FILE *fp,
359                              const std::string &from_node_id,
360                              const std::string &to_node_id,
361                              const std::vector<std::string> &labels);
362
363         // Some of the graph algorithms assume that the nodes array is sorted
364         // topologically (inputs are always before outputs), but some operations
365         // (like graph rewriting) can change that. This function restores that order.
366         void sort_all_nodes_topologically();
367
368         // Do the actual topological sort. <nodes> must be a connected, acyclic subgraph;
369         // links that go to nodes not in the set will be ignored.
370         std::vector<Node *> topological_sort(const std::vector<Node *> &nodes);
371
372         // Utility function used by topological_sort() to do a depth-first search.
373         // The reason why we store nodes left to visit instead of a more conventional
374         // list of nodes to visit is that we want to be able to limit ourselves to
375         // a subgraph instead of all nodes. The set thus serves a dual purpose.
376         void topological_sort_visit_node(Node *node, std::set<Node *> *nodes_left_to_visit, std::vector<Node *> *sorted_list);
377
378         // Used during finalize().
379         void find_color_spaces_for_inputs();
380         void propagate_alpha();
381         void propagate_gamma_and_color_space();
382         Node *find_output_node();
383
384         bool node_needs_colorspace_fix(Node *node);
385         void fix_internal_color_spaces();
386         void fix_output_color_space();
387
388         bool node_needs_alpha_fix(Node *node);
389         void fix_internal_alpha(unsigned step);
390         void fix_output_alpha();
391
392         bool node_needs_gamma_fix(Node *node);
393         void fix_internal_gamma_by_asking_inputs(unsigned step);
394         void fix_internal_gamma_by_inserting_nodes(unsigned step);
395         void fix_output_gamma();
396         void add_ycbcr_conversion_if_needed();
397         void add_dither_if_needed();
398
399         float aspect_nom, aspect_denom;
400         ImageFormat output_format;
401         OutputAlphaFormat output_alpha_format;
402
403         bool output_color_rgba, output_color_ycbcr;
404         YCbCrFormat output_ycbcr_format;              // If output_color_ycbcr is true.
405         YCbCrOutputSplitting output_ycbcr_splitting;  // If output_color_ycbcr is true.
406
407         std::vector<Node *> nodes;
408         std::map<Effect *, Node *> node_map;
409         Effect *dither_effect;
410
411         std::vector<Input *> inputs;  // Also contained in nodes.
412         std::vector<Phase *> phases;
413
414         unsigned num_dither_bits;
415         OutputOrigin output_origin;
416         bool finalized;
417
418         ResourcePool *resource_pool;
419         bool owns_resource_pool;
420
421         bool do_phase_timing;
422 };
423
424 }  // namespace movit
425
426 #endif // !defined(_MOVIT_EFFECT_CHAIN_H)