git.sesse.net Git - movit/blob - effect_chain.h

   1 #ifndef _EFFECT_CHAIN_H
   2 #define _EFFECT_CHAIN_H 1
   3
   4 #include <set>
   5 #include <vector>
   6
   7 #include "effect.h"
   8 #include "image_format.h"
   9 #include "input.h"
  10
  11 class EffectChain;
  12 class Phase;
  13
  14 // A node in the graph; basically an effect and some associated information.
  15 class Node {
  16 public:
  17         Effect *effect;
  18         bool disabled;
  19
  20         // Edges in the graph (forward and backward).
  21         std::vector<Node *> outgoing_links;
  22         std::vector<Node *> incoming_links;
  23
  24 private:
  25         // Identifier used to create unique variables in GLSL.
  26         std::string effect_id;
  27
  28         // Logical size of the output of this effect, ie. the resolution
  29         // you would get if you sampled it as a texture. If it is undefined
  30         // (since the inputs differ in resolution), it will be 0x0.
  31         // If both this and output_texture_{width,height} are set,
  32         // they will be equal.
  33         unsigned output_width, output_height;
  34
  35         // If output goes to RTT (otherwise, none of these are set).
  36         // The Phase pointer is a but ugly; we should probably fix so
  37         // that Phase takes other phases as inputs, instead of Node.
  38         GLuint output_texture;
  39         unsigned output_texture_width, output_texture_height;
  40         Phase *phase;
  41
  42         // Used during the building of the effect chain.
  43         Colorspace output_color_space;
  44         GammaCurve output_gamma_curve;
  45
  46         friend class EffectChain;
  47 };
  48
  49 // A rendering phase; a single GLSL program rendering a single quad.
  50 struct Phase {
  51         GLint glsl_program_num, vertex_shader, fragment_shader;
  52         bool input_needs_mipmaps;
  53
  54         // Inputs are only inputs from other phases (ie., those that come from RTT);
  55         // input textures are not counted here.
  56         std::vector<Node *> inputs;
  57
  58         std::vector<Node *> effects;  // In order.
  59         unsigned output_width, output_height;
  60 };
  61
  62 class EffectChain {
  63 public:
  64         EffectChain(float aspect_nom, float aspect_denom);  // E.g., 16.0f, 9.0f for 16:9.
  65         ~EffectChain();
  66
  67         // User API:
  68         // input, effects, output, finalize need to come in that specific order.
  69
  70         // EffectChain takes ownership of the given input.
  71         // input is returned back for convenience.
  72         Input *add_input(Input *input);
  73
  74         // EffectChain takes ownership of the given effect.
  75         // effect is returned back for convenience.
  76         Effect *add_effect(Effect *effect) {
  77                 return add_effect(effect, last_added_effect());
  78         }
  79         Effect *add_effect(Effect *effect, Effect *input) {
  80                 std::vector<Effect *> inputs;
  81                 inputs.push_back(input);
  82                 return add_effect(effect, inputs);
  83         }
  84         Effect *add_effect(Effect *effect, Effect *input1, Effect *input2) {
  85                 std::vector<Effect *> inputs;
  86                 inputs.push_back(input1);
  87                 inputs.push_back(input2);
  88                 return add_effect(effect, inputs);
  89         }
  90         Effect *add_effect(Effect *effect, const std::vector<Effect *> &inputs);
  91
  92         void add_output(const ImageFormat &format);
  93         void finalize();
  94
  95         //void render(unsigned char *src, unsigned char *dst);
  96         void render_to_screen()
  97         {
  98                 render_to_fbo(0, 0, 0);
  99         }
 100
 101         // Render the effect chain to the given FBO. If width=height=0, keeps
 102         // the current viewport.
 103         void render_to_fbo(GLuint fbo, unsigned width, unsigned height);
 104
 105         Effect *last_added_effect() {
 106                 if (nodes.empty()) {
 107                         return NULL;
 108                 } else {
 109                         return nodes.back()->effect;
 110                 }
 111         }
 112
 113         // API for manipulating the graph directly. Intended to be used from
 114         // effects and by EffectChain itself.
 115         //
 116         // Note that for nodes with multiple inputs, the order of calls to
 117         // connect_nodes() will matter.
 118         Node *add_node(Effect *effect);
 119         void connect_nodes(Node *sender, Node *receiver);
 120         void replace_receiver(Node *old_receiver, Node *new_receiver);
 121         void replace_sender(Node *new_sender, Node *receiver);
 122         void insert_node_between(Node *sender, Node *middle, Node *receiver);
 123
 124 private:
 125         // Fits a rectangle of the given size to the current aspect ratio
 126         // (aspect_nom/aspect_denom) and returns the new width and height.
 127         unsigned fit_rectangle_to_aspect(unsigned width, unsigned height);
 128
 129         // Compute the input sizes for all inputs for all effects in a given phase,
 130         // and inform the effects about the results.
 131         void inform_input_sizes(Phase *phase);
 132
 133         // Determine the preferred output size of a given phase.
 134         // Requires that all input phases (if any) already have output sizes set.
 135         void find_output_size(Phase *phase);
 136
 137         // Find all inputs eventually feeding into this effect that have
 138         // output gamma different from GAMMA_LINEAR.
 139         void find_all_nonlinear_inputs(Node *effect, std::vector<Node *> *nonlinear_inputs);
 140
 141         // Create a GLSL program computing the given effects in order.
 142         Phase *compile_glsl_program(const std::vector<Node *> &inputs,
 143                                     const std::vector<Node *> &effects);
 144
 145         // Create all GLSL programs needed to compute the given effect, and all outputs
 146         // that depends on it (whenever possible).
 147         void construct_glsl_programs(Node *output);
 148
 149         // Output the current graph to the given file in a Graphviz-compatible format;
 150         // only useful for debugging.
 151         void output_dot(const char *filename);
 152
 153         // Some of the graph algorithms assume that the nodes array is sorted
 154         // topologically (inputs are always before outputs), but some operations
 155         // (like graph rewriting) can change that. This function restores that order.
 156         void sort_nodes_topologically();
 157         void topological_sort_visit_node(Node *node, std::set<Node *> *visited_nodes, std::vector<Node *> *sorted_list);
 158
 159         // Used during finalize().
 160         void propagate_gamma_and_color_space();
 161         Node *find_output_node();
 162
 163         bool node_needs_colorspace_fix(Node *node);
 164         void fix_internal_color_spaces();
 165         void fix_output_color_space();
 166
 167         bool node_needs_gamma_fix(Node *node);
 168         void fix_internal_gamma_by_asking_inputs(unsigned step);
 169         void fix_internal_gamma_by_inserting_nodes(unsigned step);
 170         void fix_output_gamma();
 171
 172         float aspect_nom, aspect_denom;
 173         ImageFormat output_format;
 174
 175         std::vector<Node *> nodes;
 176         std::map<Effect *, Node *> node_map;
 177
 178         std::vector<Input *> inputs;  // Also contained in nodes.
 179
 180         GLuint fbo;
 181         std::vector<Phase *> phases;
 182
 183         GLenum format, bytes_per_pixel;
 184         bool finalized;
 185 };
 186
 187 #endif // !defined(_EFFECT_CHAIN_H)