]> git.sesse.net Git - movit/blobdiff - effect_chain.h
Use UBOs instead of glUniform. Work in progress; no clear wins seen yet.
[movit] / effect_chain.h
index 505e55a26a0b80d3e4492786d8d046530b6ed329..de50512f204b7f15fd67f9620307026c44fad528 100644 (file)
 // 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.
+//
+// Memory management (only relevant if you use multiple contexts):
+// See corresponding comment in resource_pool.h. This holds even if you don't
+// allocate your own ResourcePool, but let EffectChain hold its own.
 
-#include <GL/glew.h>
+#include <epoxy/gl.h>
 #include <stdio.h>
+#include <list>
 #include <map>
 #include <set>
 #include <string>
 #include <vector>
+#include <Eigen/Core>
 
+#include "effect.h"
 #include "image_format.h"
+#include "ycbcr.h"
 
 namespace movit {
 
@@ -48,6 +56,49 @@ enum OutputAlphaFormat {
        OUTPUT_ALPHA_FORMAT_POSTMULTIPLIED,
 };
 
+// RGBA output is nearly always packed; Y'CbCr, however, is often planar
+// due to chroma subsampling. This enum controls how add_ycbcr_output()
+// distributes the color channels between the fragment shader outputs.
+// Obviously, anything except YCBCR_OUTPUT_INTERLEAVED will be meaningless
+// unless you use render_to_fbo() and have an FBO with multiple render
+// targets attached (the other outputs will be discarded).
+enum YCbCrOutputSplitting {
+       // Only one output: Store Y'CbCr into the first three output channels,
+       // respectively, plus alpha. This is also called “chunked” or
+       // ”packed” mode.
+       YCBCR_OUTPUT_INTERLEAVED,
+
+       // Store Y' and alpha into the first output (in the red and alpha
+       // channels; effect to the others is undefined), and Cb and Cr into
+       // the first two channels of the second output. This is particularly
+       // useful if you want to end up in a format like NV12, where all the
+       // Y' samples come first and then Cb and Cr come interlevaed afterwards.
+       // You will still need to do the chroma subsampling yourself to actually
+       // get down to NV12, though.
+       YCBCR_OUTPUT_SPLIT_Y_AND_CBCR,
+
+       // Store Y' and alpha into the first output, Cb into the first channel
+       // of the second output and Cr into the first channel of the third output.
+       // (Effect on the other channels is undefined.) Essentially gives you
+       // 4:4:4 planar, or ”yuv444p”.
+       YCBCR_OUTPUT_PLANAR,
+};
+
+// Where (0,0) is taken to be in the output. If you want to render to an
+// OpenGL screen, you should keep the default of bottom-left, as that is
+// OpenGL's natural coordinate system. However, there are cases, such as if you
+// render to an FBO and read the pixels back into some other system, where
+// you'd want a top-left origin; if so, an additional flip step will be added
+// at the very end (but done in a vertex shader, so it will have zero extra
+// cost).
+//
+// Note that Movit's coordinate system in general consistently puts (0,0) in
+// the top left for _input_, no matter what you set as output origin.
+enum OutputOrigin {
+       OUTPUT_ORIGIN_BOTTOM_LEFT,
+       OUTPUT_ORIGIN_TOP_LEFT,
+};
+
 // A node in the graph; basically an effect and some associated information.
 class Node {
 public:
@@ -58,6 +109,10 @@ public:
        std::vector<Node *> outgoing_links;
        std::vector<Node *> incoming_links;
 
+       // For unit tests only. Do not use from other code.
+       // Will contain an arbitrary choice if the node is in multiple phases.
+       Phase *containing_phase;
+
 private:
        // 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
@@ -79,6 +134,11 @@ private:
        Colorspace output_color_space;
        GammaCurve output_gamma_curve;
        AlphaType output_alpha_type;
+       bool needs_mipmaps;  // Directly or indirectly.
+
+       // Set if this effect, and all effects consuming output from this node
+       // (in the same phase) have one_to_one_sampling() set.
+       bool one_to_one_sampling;
 
        friend class EffectChain;
 };
@@ -88,17 +148,46 @@ struct Phase {
        Node *output_node;
 
        GLuint glsl_program_num;  // Owned by the resource_pool.
+
+       // Position and texcoord attribute indexes, although it doesn't matter
+       // which is which, because they contain the same data.
+       std::set<GLint> attribute_indexes;
+
        bool input_needs_mipmaps;
 
        // Inputs are only inputs from other phases (ie., those that come from RTT);
        // input textures are counted as part of <effects>.
        std::vector<Phase *> inputs;
+       // Bound sampler numbers for each input. Redundant in a sense
+       // (it always corresponds to the index), but we need somewhere
+       // to hold the value for the uniform.
+       std::vector<int> input_samplers;
        std::vector<Node *> effects;  // In order.
        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<Node *, std::string> effect_ids;
+
+       // Uniforms for this phase; combined from all the effects.
+       std::vector<Uniform<int> > uniforms_sampler2d;
+       std::vector<Uniform<bool> > uniforms_bool;
+       std::vector<Uniform<int> > uniforms_int;
+       std::vector<Uniform<float> > uniforms_float;
+       std::vector<Uniform<float> > uniforms_vec2;
+       std::vector<Uniform<float> > uniforms_vec3;
+       std::vector<Uniform<float> > uniforms_vec4;
+       std::vector<Uniform<Eigen::Matrix3d> > uniforms_mat3;
+
+       GLuint ubo;  // GL_INVALID_INDEX if not using UBOs.
+       GLuint uniform_block_index;
+       std::vector<char> ubo_data;
+
+       // For measurement of GPU time used.
+       std::list<GLuint> timer_query_objects_running;
+       std::list<GLuint> timer_query_objects_free;
+       uint64_t time_elapsed_ns;
+       uint64_t num_measured_iterations;
 };
 
 class EffectChain {
@@ -109,7 +198,7 @@ public:
        // 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(float aspect_nom, float aspect_denom, ResourcePool *resource_pool = NULL, GLenum intermediate_format = GL_RGBA16F);
        ~EffectChain();
 
        // User API:
@@ -142,10 +231,40 @@ public:
                inputs.push_back(input3);
                return add_effect(effect, inputs);
        }
+       Effect *add_effect(Effect *effect, Effect *input1, Effect *input2, Effect *input3, Effect *input4) {
+               std::vector<Effect *> inputs;
+               inputs.push_back(input1);
+               inputs.push_back(input2);
+               inputs.push_back(input3);
+               inputs.push_back(input4);
+               return add_effect(effect, inputs);
+       }
+       Effect *add_effect(Effect *effect, Effect *input1, Effect *input2, Effect *input3, Effect *input4, Effect *input5) {
+               std::vector<Effect *> inputs;
+               inputs.push_back(input1);
+               inputs.push_back(input2);
+               inputs.push_back(input3);
+               inputs.push_back(input4);
+               inputs.push_back(input5);
+               return add_effect(effect, inputs);
+       }
        Effect *add_effect(Effect *effect, const std::vector<Effect *> &inputs);
 
+       // Adds an RGBA output. Note that you can have at most one RGBA output and one
+       // Y'CbCr output (see below for details).
        void add_output(const ImageFormat &format, OutputAlphaFormat alpha_format);
 
+       // Adds an YCbCr output. Note that you can only have one output.
+       // Currently, only chunked packed output is supported, and only 4:4:4
+       // (so chroma_subsampling_x and chroma_subsampling_y must both be 1).
+       //
+       // If you have both RGBA and Y'CbCr output, the RGBA output will come
+       // in the last draw buffer. Also, <format> and <alpha_format> must be
+       // identical between the two.
+       void add_ycbcr_output(const ImageFormat &format, OutputAlphaFormat alpha_format,
+                             const YCbCrFormat &ycbcr_format,
+                             YCbCrOutputSplitting output_splitting = YCBCR_OUTPUT_INTERLEAVED);
+
        // Set number of output bits, to scale the dither.
        // 8 is the right value for most outputs.
        // The default, 0, is a special value that means no dither.
@@ -154,8 +273,24 @@ public:
                this->num_dither_bits = num_bits;
        }
 
+       // Set where (0,0) is taken to be in the output. The default is
+       // OUTPUT_ORIGIN_BOTTOM_LEFT, which is usually what you want
+       // (see OutputOrigin above for more details).
+       void set_output_origin(OutputOrigin output_origin)
+       {
+               this->output_origin = output_origin;
+       }
+
        void finalize();
 
+       // Measure the GPU time used for each actual phase during rendering.
+       // Note that this is only available if GL_ARB_timer_query
+       // (or, equivalently, OpenGL 3.3) is available. Also note that measurement
+       // will incur a performance cost, as we wait for the measurements to
+       // complete at the end of rendering.
+       void enable_phase_timing(bool enable);
+       void reset_phase_timing();
+       void print_phase_timing();
 
        //void render(unsigned char *src, unsigned char *dst);
        void render_to_screen()
@@ -196,6 +331,13 @@ public:
        // single-sampler input, or from an RTT texture.
        GLenum get_input_sampler(Node *node, unsigned input_num) const;
 
+       // Whether input <input_num> of <node> corresponds to a single sampler
+       // (see get_input_sampler()). Normally, you should not need to call this;
+       // however, if the input Effect has set override_texture_bounce(),
+       // this will return false, and you could be flexible and check it first
+       // if you want.
+       GLenum has_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
@@ -228,6 +370,18 @@ private:
        // as the last effect. Also pushes all phases in order onto <phases>.
        Phase *construct_phase(Node *output, std::map<Node *, Phase *> *completed_effects);
 
+       // Execute one phase, ie. set up all inputs, effects and outputs, and render the quad.
+       void execute_phase(Phase *phase, bool last_phase,
+                          std::set<GLint> *bound__attribute_indices,
+                          std::map<Phase *, GLuint> *output_textures,
+                          std::set<Phase *> *generated_mipmaps);
+
+       // Set up uniforms for one phase. The program must already be bound.
+       void setup_uniforms(Phase *phase);
+
+       // Set up the given sampler number for sampling from an RTT texture.
+       void setup_rtt_sampler(int sampler_num, bool use_mipmaps);
+
        // Output the current graph to the given file in a Graphviz-compatible format;
        // only useful for debugging.
        void output_dot(const char *filename);
@@ -270,25 +424,34 @@ private:
        void fix_internal_gamma_by_asking_inputs(unsigned step);
        void fix_internal_gamma_by_inserting_nodes(unsigned step);
        void fix_output_gamma();
+       void add_ycbcr_conversion_if_needed();
        void add_dither_if_needed();
 
        float aspect_nom, aspect_denom;
        ImageFormat output_format;
        OutputAlphaFormat output_alpha_format;
 
+       bool output_color_rgba, output_color_ycbcr;
+       YCbCrFormat output_ycbcr_format;              // If output_color_ycbcr is true.
+       YCbCrOutputSplitting output_ycbcr_splitting;  // If output_color_ycbcr is true.
+
        std::vector<Node *> nodes;
        std::map<Effect *, Node *> node_map;
        Effect *dither_effect;
 
-       std::map<void *, GLuint> fbos;  // One for each OpenGL context.
        std::vector<Input *> inputs;  // Also contained in nodes.
        std::vector<Phase *> phases;
 
+       GLenum intermediate_format;
        unsigned num_dither_bits;
+       OutputOrigin output_origin;
        bool finalized;
+       GLuint vbo;  // Contains vertex and texture coordinate data.
 
        ResourcePool *resource_pool;
        bool owns_resource_pool;
+
+       bool do_phase_timing;
 };
 
 }  // namespace movit