4 // A Scene is an equivalent of an EffectChain, but each part is not a single
5 // Effect. (The name itself does not carry any specific meaning above that
6 // of what an EffectChain is; it was just chosen as a more intuitive name than
7 // an EffectChain when we had to change anyway.) Instead, it is a “block”,
8 // which can hold one or more effect alternatives, e.g., one block could hold
9 // ResizeEffect or IdentityEffect (effectively doing nothing), or many
10 // different input types. On finalization, every different combination of
11 // block alternatives are tried, and one EffectChain is generated for each.
12 // This also goes for whether the scene is destined for preview outputs
13 // (directly to screen, RGBA) or live (Y'CbCr output).
26 struct EffectBlueprint;
30 class LiveInputWrapper;
41 // Index into the parent Scene's list of blocks.
45 // Each instantiation is indexed by the chosen alternative for each block.
46 // These are combined into one big variable-base number, ranging from 0
47 // to (B_0*B_1*B_2*...*B_n)-1, where B_i is the number of alternatives for
48 // block number i and n is the index of the last block.
50 // The actual index, given alternatives A_0, A_1, A_2, ..., is given as
52 // A_0 + B_0 * (A_1 + B_1 * (A_2 + B_2 * (...)))
54 // where each A_i can of course range from 0 to B_i-1. In other words,
55 // the first block gets the lowest “bits” (or trits, or quats...) of the
56 // index number, the second block gets the ones immediately above,
57 // and so on. Thus, there are no holes in the sequence.
59 // Expanding the formula above gives the equivalent index
61 // A_0 + A_1 * B_0 + A_2 * B_0 * B_1 + A_3 * ...
65 // A_0 * C_0 + A_1 * C_1 + A_2 * C_2 + A_3 * ...
67 // where C_0 = 0 and C_(i+1) = C_i * B_i. In other words, C_i is
68 // the product of the cardinalities of each previous effect; if we
69 // are e.g. at the third index and there have been C_2 = 3 * 5 = 15
70 // different alternatives for constructing the scene so far
71 // (with possible indexes 0..14), it is only logical that if we
72 // want three new options (B_2 = 3), we must add 0, 15 or 30 to
73 // the index. (Then the local possible indexes become 0..44 and
74 // C_3 = 45, of course.) Given an index number k, we can then get our
75 // own local “bits” of the index, giving the alternative for this
76 // block, by doing (k / 15) % 3.
78 // This specific member contains the value of C_i for this block.
79 // (B_i is alternatives.size().) Not set before finalize() has run.
80 size_t cardinality_base = 0;
82 // Find the chosen alternative for this block in a given instance.
83 int chosen_alternative(size_t chain_idx) const {
84 if (chain_idx == size_t(-1)) {
85 return currently_chosen_alternative;
87 return (chain_idx / cardinality_base) % alternatives.size();
91 std::vector<EffectBlueprint *> alternatives; // Must all have the same amount of inputs. Pointers to make things easier for Lua.
92 std::vector<Index> inputs; // One for each input of alternatives[0] (ie., typically 0 or 1, occasionally 2).
94 // If any of these effects are disabled (IdentityEffect chosen)
95 // or enabled (not chosen) as determined by <condition>, so should this one.
99 DISABLE_IF_OTHER_DISABLED,
101 // This a promise from the user; ie., we don't disable automatically
102 // (see comments in find_disabled_blocks()).
103 DISABLE_IF_OTHER_ENABLED
105 std::string declaration_point; // For error messages.
107 std::vector<Disabler> disablers;
108 int currently_chosen_alternative = 0;
109 // What alternative to use if the block is disabled.
110 // Points to an alternative with IDENTITY_EFFECT if it exists
111 // (to disable as much as possible), otherwise 0.
112 int canonical_alternative = 0;
113 bool is_input = false;
115 // For LIVE_INPUT* only. We can't just always populate signal_to_connect,
116 // since when we set this, CEF and video signals may not have numbers yet.
117 // FIXME: Perhaps it would be simpler if they just did?
118 enum { CONNECT_NONE, CONNECT_SIGNAL, CONNECT_CEF, CONNECT_VIDEO } signal_type_to_connect = CONNECT_NONE;
119 int signal_to_connect = 0; // For CONNECT_SIGNAL.
121 CEFCapture *cef_to_connect = nullptr; // For CONNECT_CEF.
123 FFmpegCapture *video_to_connect = nullptr; // For CONNECT_VIDEO.
125 std::string pathname; // For IMAGE_INPUT only.
127 // Parameters to set on the effect prior to render.
128 // Will be set _before_ the ones from the EffectBlueprint, so that
129 // the latter takes priority.
130 std::map<std::string, int> int_parameters;
131 std::map<std::string, float> float_parameters;
132 std::map<std::string, std::array<float, 3>> vec3_parameters;
133 std::map<std::string, std::array<float, 4>> vec4_parameters;
135 std::string declaration_point; // For error messages.
137 // Only for AUTO_WHITE_BALANCE_EFFECT. Points to the parent block with is_input = true,
138 // so that we know which signal to get the white balance from.
139 const Block *white_balance_controller_block = nullptr;
142 int Block_display(lua_State* L);
143 int Block_choose(lua_State* L);
144 int Block_enable(lua_State *L);
145 int Block_enable_if(lua_State *L);
146 int Block_disable(lua_State *L);
147 int Block_always_disable_if_disabled(lua_State *L);
148 int Block_promise_to_disable_if_enabled(lua_State *L);
149 int Block_set_int(lua_State *L);
150 int Block_set_float(lua_State *L);
151 int Block_set_vec3(lua_State *L);
152 int Block_set_vec4(lua_State *L);
156 std::vector<Block *> blocks; // The last one represents the output node (after finalization). Pointers to make things easier for Lua.
157 struct Instantiation {
158 std::unique_ptr<movit::EffectChain> chain;
159 std::map<Block::Index, movit::Effect *> effects; // So that we can set parameters.
160 std::map<Block::Index, LiveInputWrapper *> inputs; // So that we can connect signals.
161 std::map<Block::Index, ImageInput *> image_inputs; // So that we can connect signals.
163 std::vector<Instantiation> chains; // Indexed by combination of each block's chosen alternative. See Block for information.
166 float aspect_nom, aspect_denom;
167 movit::ResourcePool *resource_pool;
169 movit::Effect *instantiate_effects(const Block *block, size_t chain_idx, Instantiation *instantiation);
170 size_t compute_chain_number_for_block(size_t block_idx, const std::bitset<256> &disabled) const;
171 static void find_inputs_for_block(lua_State *L, Scene *scene, Block *block, int first_input_idx = 3);
172 static Block *find_block_from_arg(lua_State *L, Scene *scene, int idx);
174 // Find out which blocks (indexed by position in the “blocks” array),
175 // if any, are disabled in a given instantiation. A disabled block is
176 // one that will not be instantiated at all, because it is a secondary
177 // (ie., not the first) input of some multi-input effect that was replaced
178 // with IdentityEffect in the given instantiation.
180 // Set chain_idx to size_t(-1) to use whatever is in each block's
181 // currently_chosen_alternative.
182 std::bitset<256> find_disabled_blocks(size_t chain_idx) const;
183 void find_disabled_blocks(size_t chain_idx, size_t block_idx, bool currently_disabled, std::bitset<256> *disabled) const;
185 // If a block is disabled, it should always have canonical_alternative chosen,
186 // so that we don't instantiate a bunch of irrelevant duplicates that
187 // differ only in disabled blocks. You can check this property with
188 // is_noncanonical_chain() and then avoid instantiating the ones where
190 bool is_noncanonical_chain(size_t chain_idx) const;
192 // For a given block, find any parents it may have that are inputs.
193 // If there is more than one, throws an error. If there are zero,
194 // returns nullptr (should probably also be an error).
195 const Block *find_root_input_block(lua_State *L, const Block *block);
198 Scene(Theme *theme, float aspect_nom, float aspect_denom);
199 size_t compute_chain_number(bool is_main_chain) const;
201 std::pair<movit::EffectChain *, std::function<void()>>
202 get_chain(Theme *theme, lua_State *L, unsigned num, const InputState &input_state);
204 static int add_input(lua_State *L);
205 static int add_effect(lua_State *L);
206 static int add_optional_effect(lua_State *L);
207 static int add_white_balance(lua_State *L);
208 static int finalize(lua_State *L);
211 #endif // !defined(_SCENE_H)