X-Git-Url: https://git.sesse.net/?p=movit;a=blobdiff_plain;f=effect_chain.h;h=905119546911e094d2819dbf0dfb99a21da57300;hp=b51c2bb56cc0d97222ddf7ca99c98d5d8988df38;hb=45955bca8c14dd8cac4fa922e45fb0f8be507d58;hpb=0b13d5089c5967a7a5706f20c1fbb6e98ca40f72 diff --git a/effect_chain.h b/effect_chain.h index b51c2bb..9051195 100644 --- a/effect_chain.h +++ b/effect_chain.h @@ -1,15 +1,37 @@ -#ifndef _EFFECT_CHAIN_H -#define _EFFECT_CHAIN_H 1 - +#ifndef _MOVIT_EFFECT_CHAIN_H +#define _MOVIT_EFFECT_CHAIN_H 1 + +// An EffectChain is the largest basic entity in Movit; it contains everything +// needed to connects a series of effects, from inputs to outputs, and render +// them. Generally you set up your effect chain once and then call its render +// functions once per frame; setting one up can be relatively expensive, +// but rendering is fast. +// +// Threading considerations: EffectChain is “thread-compatible”; you can use +// different EffectChains in multiple threads at the same time (assuming the +// threads do not use the same OpenGL context, but this is a good idea anyway), +// but you may not use one EffectChain from multiple threads simultaneously. +// You _are_ allowed to use one EffectChain from multiple threads as long as +// you only use it from one at a time (possibly by doing your own locking), +// but if so, the threads' contexts need to be set up to share resources, since +// the EffectChain holds textures and other OpenGL objects that are tied to the +// context. + +#include +#include +#include #include +#include #include -#include "effect.h" #include "image_format.h" -#include "input.h" -class EffectChain; -class Phase; +namespace movit { + +class Effect; +class Input; +struct Phase; +class ResourcePool; // For internal use within Node. enum AlphaType { @@ -22,8 +44,8 @@ enum AlphaType { // Whether you want pre- or postmultiplied alpha in the output // (see effect.h for a discussion of pre- versus postmultiplied alpha). enum OutputAlphaFormat { - OUTPUT_ALPHA_PREMULTIPLIED, - OUTPUT_ALPHA_POSTMULTIPLIED, + OUTPUT_ALPHA_FORMAT_PREMULTIPLIED, + OUTPUT_ALPHA_FORMAT_POSTMULTIPLIED, }; // A node in the graph; basically an effect and some associated information. @@ -37,9 +59,6 @@ public: std::vector incoming_links; private: - // Identifier used to create unique variables in GLSL. - std::string effect_id; - // Logical size of the output of this effect, ie. the resolution // you would get if you sampled it as a texture. If it is undefined // (since the inputs differ in resolution), it will be 0x0. @@ -47,12 +66,14 @@ private: // they will be equal. unsigned output_width, output_height; - // If output goes to RTT (otherwise, none of these are set). - // The Phase pointer is a but ugly; we should probably fix so - // that Phase takes other phases as inputs, instead of Node. - GLuint output_texture; - unsigned output_texture_width, output_texture_height; - Phase *phase; + // If the effect has is_single_texture(), or if the output went to RTT + // and that texture has been bound to a sampler, the sampler number + // will be stored here. + // + // TODO: Can an RTT texture be used as inputs to multiple effects + // within the same phase? If so, we have a problem with modifying + // sampler state here. + int bound_sampler_num; // Used during the building of the effect chain. Colorspace output_color_space; @@ -64,20 +85,38 @@ private: // A rendering phase; a single GLSL program rendering a single quad. struct Phase { - GLint glsl_program_num, vertex_shader, fragment_shader; + Node *output_node; + + GLuint glsl_program_num; // Owned by the resource_pool. bool input_needs_mipmaps; // Inputs are only inputs from other phases (ie., those that come from RTT); - // input textures are not counted here. - std::vector inputs; - + // input textures are counted as part of . + std::vector inputs; std::vector effects; // In order. - unsigned output_width, output_height; + unsigned output_width, output_height, virtual_output_width, virtual_output_height; + + // Identifier used to create unique variables in GLSL. + // Unique per-phase to increase cacheability of compiled shaders. + std::map effect_ids; + + // The geometry needed to draw this quad, bound to the vertex array + // object. (Seemingly it's actually a win not to upload geometry every + // frame, even for something as small as a quad, due to fewer state + // changes.) + GLuint vao; + GLuint position_vbo, texcoord_vbo; }; class EffectChain { public: - EffectChain(float aspect_nom, float aspect_denom); // E.g., 16.0f, 9.0f for 16:9. + // Aspect: e.g. 16.0f, 9.0f for 16:9. + // resource_pool is a pointer to a ResourcePool with which to share shaders + // and other resources (see resource_pool.h). If NULL (the default), + // will create its own that is not shared with anything else. Does not take + // ownership of the passed-in ResourcePool, but will naturally take ownership + // of its own internal one if created. + EffectChain(float aspect_nom, float aspect_denom, ResourcePool *resource_pool = NULL); ~EffectChain(); // User API: @@ -103,6 +142,13 @@ public: inputs.push_back(input2); return add_effect(effect, inputs); } + Effect *add_effect(Effect *effect, Effect *input1, Effect *input2, Effect *input3) { + std::vector inputs; + inputs.push_back(input1); + inputs.push_back(input2); + inputs.push_back(input3); + return add_effect(effect, inputs); + } Effect *add_effect(Effect *effect, const std::vector &inputs); void add_output(const ImageFormat &format, OutputAlphaFormat alpha_format); @@ -146,11 +192,28 @@ public: void replace_receiver(Node *old_receiver, Node *new_receiver); void replace_sender(Node *new_sender, Node *receiver); void insert_node_between(Node *sender, Node *middle, Node *receiver); + Node *find_node_for_effect(Effect *effect) { return node_map[effect]; } + + // Get the OpenGL sampler (GL_TEXTURE0, GL_TEXTURE1, etc.) for the + // input of the given node, so that one can modify the sampler state + // directly. Only valid to call during set_gl_state(). + // + // Also, for this to be allowed, 's effect must have + // needs_texture_bounce() set, so that it samples directly from a + // single-sampler input, or from an RTT texture. + GLenum get_input_sampler(Node *node, unsigned input_num) const; + + // Get the current resource pool assigned to this EffectChain. + // Primarily to let effects allocate textures as needed. + // Any resources you get from the pool must be returned to the pool + // no later than in the Effect's destructor. + ResourcePool *get_resource_pool() { return resource_pool; } private: - // Fits a rectangle of the given size to the current aspect ratio - // (aspect_nom/aspect_denom) and returns the new width and height. - unsigned fit_rectangle_to_aspect(unsigned width, unsigned height); + // Make sure the output rectangle is at least large enough to hold + // the given input rectangle in both dimensions, and is of the + // current aspect ratio (aspect_nom/aspect_denom). + void size_rectangle_to_fit(unsigned width, unsigned height, unsigned *output_width, unsigned *output_height); // Compute the input sizes for all inputs for all effects in a given phase, // and inform the effects about the results. @@ -164,17 +227,22 @@ private: // output gamma different from GAMMA_LINEAR. void find_all_nonlinear_inputs(Node *effect, std::vector *nonlinear_inputs); - // Create a GLSL program computing the given effects in order. - Phase *compile_glsl_program(const std::vector &inputs, - const std::vector &effects); + // Create a GLSL program computing the effects for this phase in order. + void compile_glsl_program(Phase *phase); // Create all GLSL programs needed to compute the given effect, and all outputs - // that depends on it (whenever possible). - void construct_glsl_programs(Node *output); + // that depend on it (whenever possible). Returns the phase that has + // as the last effect. Also pushes all phases in order onto . + Phase *construct_phase(Node *output, std::map *completed_effects); // Output the current graph to the given file in a Graphviz-compatible format; // only useful for debugging. void output_dot(const char *filename); + std::vector get_labels_for_edge(const Node *from, const Node *to); + void output_dot_edge(FILE *fp, + const std::string &from_node_id, + const std::string &to_node_id, + const std::vector &labels); // Some of the graph algorithms assume that the nodes array is sorted // topologically (inputs are always before outputs), but some operations @@ -219,14 +287,17 @@ private: std::map node_map; Effect *dither_effect; + std::map fbos; // One for each OpenGL context. std::vector inputs; // Also contained in nodes. - - GLuint fbo; std::vector phases; - GLenum format; - unsigned bytes_per_pixel, num_dither_bits; + unsigned num_dither_bits; bool finalized; + + ResourcePool *resource_pool; + bool owns_resource_pool; }; -#endif // !defined(_EFFECT_CHAIN_H) +} // namespace movit + +#endif // !defined(_MOVIT_EFFECT_CHAIN_H)