-#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 <GL/glew.h>
+#include <stdio.h>
+#include <map>
#include <set>
+#include <string>
#include <vector>
-#include "effect.h"
#include "image_format.h"
-#include "input.h"
-class EffectChain;
-class Phase;
+class Effect;
+class Input;
+struct Phase;
+class ResourcePool;
// For internal use within Node.
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.
// A rendering phase; a single GLSL program rendering a single quad.
struct Phase {
- GLint glsl_program_num, vertex_shader, fragment_shader;
+ 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);
std::vector<Node *> inputs;
std::vector<Node *> effects; // In order.
- unsigned output_width, output_height;
+ unsigned output_width, output_height, virtual_output_width, virtual_output_height;
};
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:
void insert_node_between(Node *sender, Node *middle, Node *receiver);
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.
// 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<std::string> 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<std::string> &labels);
// Some of the graph algorithms assume that the nodes array is sorted
// topologically (inputs are always before outputs), but some operations
Effect *dither_effect;
std::vector<Input *> inputs; // Also contained in nodes.
-
- GLuint fbo;
std::vector<Phase *> 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)
+#endif // !defined(_MOVIT_EFFECT_CHAIN_H)
projects / movit / blobdiff