X-Git-Url: https://git.sesse.net/?p=movit;a=blobdiff_plain;f=effect.h;h=235558f8e1c4cf9f480361f0f428916885b1e0e5;hp=f1520b797f9f658a3218838b379fd5c9b281ed8c;hb=29072985d0a00a53e5b578a1444cee61a0c9e1f2;hpb=f99ad333a7acbb6c8c995dbb036484ae8940c490 diff --git a/effect.h b/effect.h index f1520b7..235558f 100644 --- a/effect.h +++ b/effect.h @@ -16,9 +16,13 @@ #include -#include "opengl.h" +#include + +#include +#include "util.h" class EffectChain; +class Node; // Can alias on a float[2]. struct Point2D { @@ -40,15 +44,17 @@ struct RGBTriplet { GLint get_uniform_location(GLuint glsl_program_num, const std::string &prefix, const std::string &key); void set_uniform_int(GLuint glsl_program_num, const std::string &prefix, const std::string &key, int value); void set_uniform_float(GLuint glsl_program_num, const std::string &prefix, const std::string &key, float value); -void set_uniform_float_array(GLuint glsl_program_num, const std::string &prefix, const std::string &key, const float *values, size_t num_values); void set_uniform_vec2(GLuint glsl_program_num, const std::string &prefix, const std::string &key, const float *values); void set_uniform_vec3(GLuint glsl_program_num, const std::string &prefix, const std::string &key, const float *values); void set_uniform_vec4_array(GLuint glsl_program_num, const std::string &prefix, const std::string &key, const float *values, size_t num_values); +void set_uniform_mat3(GLuint glsl_program_num, const std::string &prefix, const std::string &key, const Eigen::Matrix3d &matrix); class Effect { public: + virtual ~Effect() {} + // An identifier for this type of effect, mostly used for debug output - // (but some special names, like "ColorSpaceConversionEffect", holds special + // (but some special names, like "ColorspaceConversionEffect", holds special // meaning). Same as the class name is fine. virtual std::string effect_type_id() const = 0; @@ -86,7 +92,7 @@ public: // 2. You rely on previous effects, possibly including gamma // expansion, to happen pre-filtering instead of post-filtering. // (This is only relevant if you actually need the filtering; if - // you sample on whole input pixels only, it makes no difference.) + // you sample 1:1 between pixels and texels, it makes no difference.) // // Note that in some cases, you might get post-filtered gamma expansion // even when setting this option. More specifically, if you are the @@ -104,9 +110,9 @@ public: virtual bool needs_mipmaps() const { return false; } // Whether this effect wants to output to a different size than - // its input(s). If you set this to true, the output will be - // bounced to a texture (similarly to if the next effect set - // needs_texture_bounce()). + // its input(s) (see inform_input_size(), below). If you set this to + // true, the output will be bounced to a texture (similarly to if the + // next effect set needs_texture_bounce()). virtual bool changes_output_size() const { return false; } // If changes_output_size() is true, you must implement this to tell @@ -118,16 +124,36 @@ public: assert(false); } + // Tells the effect the resolution of each of its input. + // This will be called every frame, and always before get_output_size(), + // so you can change your output size based on the input if so desired. + // + // Note that in some cases, an input might not have a single well-defined + // resolution (for instance if you fade between two inputs with + // different resolutions). In this case, you will get width=0 and height=0 + // for that input. If you cannot handle that, you will need to set + // needs_texture_bounce() to true, which will force a render to a single + // given resolution before you get the input. + virtual void inform_input_size(unsigned input_num, unsigned width, unsigned height) {} + // How many inputs this effect will take (a fixed number). // If you have only one input, it will be called INPUT() in GLSL; // if you have several, they will be INPUT1(), INPUT2(), and so on. virtual unsigned num_inputs() const { return 1; } - // Requests that this effect adds itself to the given effect chain. - // For most effects, the default will be fine, but for effects that - // consist of multiple passes, it is often useful to replace this - // with something that adds completely different things to the chain. - virtual void add_self_to_effect_chain(EffectChain *graph, const std::vector &inputs); + // Let the effect rewrite the effect chain as it sees fit. + // Most effects won't need to do this, but this is very useful + // if you have an effect that consists of multiple sub-effects + // (for instance, two passes). The effect is given to its own + // pointer, and it can add new ones (by using add_node() + // and connect_node()) as it sees fit. This is called at + // EffectChain::finalize() time, when the entire graph is known, + // in the order that the effects were originally added. + // + // Note that if the effect wants to take itself entirely out + // of the chain, it must set “disabled” to true and then disconnect + // itself from all other effects. + virtual void rewrite_graph(EffectChain *graph, Node *self) {} // Outputs one GLSL uniform declaration for each registered parameter // (see below), with the right prefix prepended to each uniform name. @@ -153,10 +179,10 @@ public: // Set a parameter; intended to be called from user code. // Neither of these take ownership of the pointer. - virtual bool set_int(const std::string&, int value); - virtual bool set_float(const std::string &key, float value); - virtual bool set_vec2(const std::string &key, const float *values); - virtual bool set_vec3(const std::string &key, const float *values); + virtual bool set_int(const std::string&, int value) MUST_CHECK_RESULT; + virtual bool set_float(const std::string &key, float value) MUST_CHECK_RESULT; + virtual bool set_vec2(const std::string &key, const float *values) MUST_CHECK_RESULT; + virtual bool set_vec3(const std::string &key, const float *values) MUST_CHECK_RESULT; protected: // Register a parameter. Whenever set_*() is called with the same key,