Formalize the notion of messing with sampler state.
[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 #include <GL/glew.h>
21 #include <stdio.h>
22 #include <map>
23 #include <set>
24 #include <string>
25 #include <vector>
26
27 #include "image_format.h"
28
29 namespace movit {
30
31 class Effect;
32 class Input;
33 struct Phase;
34 class ResourcePool;
35
36 // For internal use within Node.
37 enum AlphaType {
38         ALPHA_INVALID = -1,
39         ALPHA_BLANK,
40         ALPHA_PREMULTIPLIED,
41         ALPHA_POSTMULTIPLIED,
42 };
43
44 // Whether you want pre- or postmultiplied alpha in the output
45 // (see effect.h for a discussion of pre- versus postmultiplied alpha).
46 enum OutputAlphaFormat {
47         OUTPUT_ALPHA_FORMAT_PREMULTIPLIED,
48         OUTPUT_ALPHA_FORMAT_POSTMULTIPLIED,
49 };
50
51 // A node in the graph; basically an effect and some associated information.
52 class Node {
53 public:
54         Effect *effect;
55         bool disabled;
56
57         // Edges in the graph (forward and backward).
58         std::vector<Node *> outgoing_links;
59         std::vector<Node *> incoming_links;
60
61 private:
62         // Logical size of the output of this effect, ie. the resolution
63         // you would get if you sampled it as a texture. If it is undefined
64         // (since the inputs differ in resolution), it will be 0x0.
65         // If both this and output_texture_{width,height} are set,
66         // they will be equal.
67         unsigned output_width, output_height;
68
69         // If output goes to RTT, which phase it is in (otherwise unset).
70         // This is a bit ugly; we should probably fix so that Phase takes other
71         // phases as inputs, instead of Node.
72         Phase *phase;
73
74         // If the effect has is_single_texture(), or if the output went to RTT
75         // and that texture has been bound to a sampler, the sampler number
76         // will be stored here.
77         //
78         // TODO: Can an RTT texture be used as inputs to multiple effects
79         // within the same phase? If so, we have a problem with modifying
80         // sampler state here.
81         int bound_sampler_num;
82
83         // Used during the building of the effect chain.
84         Colorspace output_color_space;
85         GammaCurve output_gamma_curve;
86         AlphaType output_alpha_type;
87
88         friend class EffectChain;
89 };
90
91 // A rendering phase; a single GLSL program rendering a single quad.
92 struct Phase {
93         GLuint glsl_program_num;  // Owned by the resource_pool.
94         bool input_needs_mipmaps;
95
96         // Inputs are only inputs from other phases (ie., those that come from RTT);
97         // input textures are not counted here.
98         std::vector<Node *> inputs;
99
100         std::vector<Node *> effects;  // In order.
101         unsigned output_width, output_height, virtual_output_width, virtual_output_height;
102
103         // Identifier used to create unique variables in GLSL.
104         // Unique per-phase to increase cacheability of compiled shaders.
105         std::map<Node *, std::string> effect_ids;
106 };
107
108 class EffectChain {
109 public:
110         // Aspect: e.g. 16.0f, 9.0f for 16:9.
111         // resource_pool is a pointer to a ResourcePool with which to share shaders
112         // and other resources (see resource_pool.h). If NULL (the default),
113         // will create its own that is not shared with anything else. Does not take
114         // ownership of the passed-in ResourcePool, but will naturally take ownership
115         // of its own internal one if created.
116         EffectChain(float aspect_nom, float aspect_denom, ResourcePool *resource_pool = NULL);
117         ~EffectChain();
118
119         // User API:
120         // input, effects, output, finalize need to come in that specific order.
121
122         // EffectChain takes ownership of the given input.
123         // input is returned back for convenience.
124         Input *add_input(Input *input);
125
126         // EffectChain takes ownership of the given effect.
127         // effect is returned back for convenience.
128         Effect *add_effect(Effect *effect) {
129                 return add_effect(effect, last_added_effect());
130         }
131         Effect *add_effect(Effect *effect, Effect *input) {
132                 std::vector<Effect *> inputs;
133                 inputs.push_back(input);
134                 return add_effect(effect, inputs);
135         }
136         Effect *add_effect(Effect *effect, Effect *input1, Effect *input2) {
137                 std::vector<Effect *> inputs;
138                 inputs.push_back(input1);
139                 inputs.push_back(input2);
140                 return add_effect(effect, inputs);
141         }
142         Effect *add_effect(Effect *effect, const std::vector<Effect *> &inputs);
143
144         void add_output(const ImageFormat &format, OutputAlphaFormat alpha_format);
145
146         // Set number of output bits, to scale the dither.
147         // 8 is the right value for most outputs.
148         // The default, 0, is a special value that means no dither.
149         void set_dither_bits(unsigned num_bits)
150         {
151                 this->num_dither_bits = num_bits;
152         }
153
154         void finalize();
155
156
157         //void render(unsigned char *src, unsigned char *dst);
158         void render_to_screen()
159         {
160                 render_to_fbo(0, 0, 0);
161         }
162
163         // Render the effect chain to the given FBO. If width=height=0, keeps
164         // the current viewport.
165         void render_to_fbo(GLuint fbo, unsigned width, unsigned height);
166
167         Effect *last_added_effect() {
168                 if (nodes.empty()) {
169                         return NULL;
170                 } else {
171                         return nodes.back()->effect;
172                 }       
173         }
174
175         // API for manipulating the graph directly. Intended to be used from
176         // effects and by EffectChain itself.
177         //
178         // Note that for nodes with multiple inputs, the order of calls to
179         // connect_nodes() will matter.
180         Node *add_node(Effect *effect);
181         void connect_nodes(Node *sender, Node *receiver);
182         void replace_receiver(Node *old_receiver, Node *new_receiver);
183         void replace_sender(Node *new_sender, Node *receiver);
184         void insert_node_between(Node *sender, Node *middle, Node *receiver);
185         Node *find_node_for_effect(Effect *effect) { return node_map[effect]; }
186
187         // Get the OpenGL sampler (GL_TEXTURE0, GL_TEXTURE1, etc.) for the
188         // input of the given node, so that one can modify the sampler state
189         // directly. Only valid to call during set_gl_state().
190         //
191         // Also, for this to be allowed, <node>'s effect must have
192         // needs_texture_bounce() set, so that it samples directly from a
193         // single-sampler input, or from an RTT texture.
194         GLenum get_input_sampler(Node *node, unsigned input_num) const;
195
196         // Get the current resource pool assigned to this EffectChain.
197         // Primarily to let effects allocate textures as needed.
198         // Any resources you get from the pool must be returned to the pool
199         // no later than in the Effect's destructor.
200         ResourcePool *get_resource_pool() { return resource_pool; }
201
202 private:
203         // Make sure the output rectangle is at least large enough to hold
204         // the given input rectangle in both dimensions, and is of the
205         // current aspect ratio (aspect_nom/aspect_denom).
206         void size_rectangle_to_fit(unsigned width, unsigned height, unsigned *output_width, unsigned *output_height);
207
208         // Compute the input sizes for all inputs for all effects in a given phase,
209         // and inform the effects about the results.    
210         void inform_input_sizes(Phase *phase);
211
212         // Determine the preferred output size of a given phase.
213         // Requires that all input phases (if any) already have output sizes set.
214         void find_output_size(Phase *phase);
215
216         // Find all inputs eventually feeding into this effect that have
217         // output gamma different from GAMMA_LINEAR.
218         void find_all_nonlinear_inputs(Node *effect, std::vector<Node *> *nonlinear_inputs);
219
220         // Create a GLSL program computing the given effects in order.
221         Phase *compile_glsl_program(const std::vector<Node *> &inputs,
222                                     const std::vector<Node *> &effects);
223
224         // Create all GLSL programs needed to compute the given effect, and all outputs
225         // that depends on it (whenever possible).
226         void construct_glsl_programs(Node *output);
227
228         // Output the current graph to the given file in a Graphviz-compatible format;
229         // only useful for debugging.
230         void output_dot(const char *filename);
231         std::vector<std::string> get_labels_for_edge(const Node *from, const Node *to);
232         void output_dot_edge(FILE *fp,
233                              const std::string &from_node_id,
234                              const std::string &to_node_id,
235                              const std::vector<std::string> &labels);
236
237         // Some of the graph algorithms assume that the nodes array is sorted
238         // topologically (inputs are always before outputs), but some operations
239         // (like graph rewriting) can change that. This function restores that order.
240         void sort_all_nodes_topologically();
241
242         // Do the actual topological sort. <nodes> must be a connected, acyclic subgraph;
243         // links that go to nodes not in the set will be ignored.
244         std::vector<Node *> topological_sort(const std::vector<Node *> &nodes);
245
246         // Utility function used by topological_sort() to do a depth-first search.
247         // The reason why we store nodes left to visit instead of a more conventional
248         // list of nodes to visit is that we want to be able to limit ourselves to
249         // a subgraph instead of all nodes. The set thus serves a dual purpose.
250         void topological_sort_visit_node(Node *node, std::set<Node *> *nodes_left_to_visit, std::vector<Node *> *sorted_list);
251
252         // Used during finalize().
253         void find_color_spaces_for_inputs();
254         void propagate_alpha();
255         void propagate_gamma_and_color_space();
256         Node *find_output_node();
257
258         bool node_needs_colorspace_fix(Node *node);
259         void fix_internal_color_spaces();
260         void fix_output_color_space();
261
262         bool node_needs_alpha_fix(Node *node);
263         void fix_internal_alpha(unsigned step);
264         void fix_output_alpha();
265
266         bool node_needs_gamma_fix(Node *node);
267         void fix_internal_gamma_by_asking_inputs(unsigned step);
268         void fix_internal_gamma_by_inserting_nodes(unsigned step);
269         void fix_output_gamma();
270         void add_dither_if_needed();
271
272         float aspect_nom, aspect_denom;
273         ImageFormat output_format;
274         OutputAlphaFormat output_alpha_format;
275
276         std::vector<Node *> nodes;
277         std::map<Effect *, Node *> node_map;
278         Effect *dither_effect;
279
280         std::vector<Input *> inputs;  // Also contained in nodes.
281         std::vector<Phase *> phases;
282
283         unsigned num_dither_bits;
284         bool finalized;
285
286         ResourcePool *resource_pool;
287         bool owns_resource_pool;
288 };
289
290 }  // namespace movit
291
292 #endif // !defined(_MOVIT_EFFECT_CHAIN_H)