39a9f74dea4cfe5810a2f5d97ccf7ed9f3586ced
[blender.git] / source / blender / nodes / composite / node_composite_tree.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version. 
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2007 Blender Foundation.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s):
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file blender/nodes/composite/node_composite_tree.c
29  *  \ingroup nodes
30  */
31
32
33 #include <stdio.h>
34
35 #include "DNA_anim_types.h"
36 #include "DNA_color_types.h"
37 #include "DNA_scene_types.h"
38 #include "DNA_node_types.h"
39
40 #include "BLI_listbase.h"
41 #include "BLI_threads.h"
42
43 #include "BLF_translation.h"
44
45 #include "BKE_animsys.h"
46 #include "BKE_colortools.h"
47 #include "BKE_context.h"
48 #include "BKE_fcurve.h"
49 #include "BKE_global.h"
50 #include "BKE_main.h"
51 #include "BKE_node.h"
52 #include "BKE_tracking.h"
53
54 #include "node_common.h"
55 #include "node_util.h"
56
57 #include "PIL_time.h"
58
59 #include "RNA_access.h"
60
61 #include "NOD_composite.h"
62 #include "node_composite_util.h"
63
64 #ifdef WITH_COMPOSITOR
65 #  include "COM_compositor.h"
66 #endif
67
68 static void composite_get_from_context(const bContext *C, bNodeTreeType *UNUSED(treetype), bNodeTree **r_ntree, ID **r_id, ID **r_from)
69 {
70         Scene *scene = CTX_data_scene(C);
71         
72         *r_from = NULL;
73         *r_id = &scene->id;
74         *r_ntree = scene->nodetree;
75         
76         /* update output sockets based on available layers */
77         ntreeCompositForceHidden(scene->nodetree);
78         
79 }
80
81 static void foreach_nodeclass(Scene *UNUSED(scene), void *calldata, bNodeClassCallback func)
82 {
83         func(calldata, NODE_CLASS_INPUT, N_("Input"));
84         func(calldata, NODE_CLASS_OUTPUT, N_("Output"));
85         func(calldata, NODE_CLASS_OP_COLOR, N_("Color"));
86         func(calldata, NODE_CLASS_OP_VECTOR, N_("Vector"));
87         func(calldata, NODE_CLASS_OP_FILTER, N_("Filter"));
88         func(calldata, NODE_CLASS_CONVERTOR, N_("Convertor"));
89         func(calldata, NODE_CLASS_MATTE, N_("Matte"));
90         func(calldata, NODE_CLASS_DISTORT, N_("Distort"));
91         func(calldata, NODE_CLASS_GROUP, N_("Group"));
92         func(calldata, NODE_CLASS_INTERFACE, N_("Interface"));
93         func(calldata, NODE_CLASS_LAYOUT, N_("Layout"));
94 }
95
96 static void free_node_cache(bNodeTree *UNUSED(ntree), bNode *node)
97 {
98         bNodeSocket *sock;
99         
100         for (sock = node->outputs.first; sock; sock = sock->next) {
101                 if (sock->cache) {
102                         sock->cache = NULL;
103                 }
104         }
105 }
106
107 static void free_cache(bNodeTree *ntree)
108 {
109         bNode *node;
110         for (node = ntree->nodes.first; node; node = node->next)
111                 free_node_cache(ntree, node);
112 }
113
114 /* local tree then owns all compbufs */
115 static void localize(bNodeTree *localtree, bNodeTree *ntree)
116 {
117         bNode *node, *node_next;
118         bNodeSocket *sock;
119         
120         for (node = ntree->nodes.first; node; node = node->next) {
121                 /* ensure new user input gets handled ok */
122                 node->need_exec = 0;
123                 node->new_node->original = node;
124                 
125                 /* move over the compbufs */
126                 /* right after ntreeCopyTree() oldsock pointers are valid */
127                 
128                 if (ELEM(node->type, CMP_NODE_VIEWER, CMP_NODE_SPLITVIEWER)) {
129                         if (node->id) {
130                                 if (node->flag & NODE_DO_OUTPUT)
131                                         node->new_node->id = (ID *)node->id;
132                                 else
133                                         node->new_node->id = NULL;
134                         }
135                 }
136                 
137                 for (sock = node->outputs.first; sock; sock = sock->next) {
138                         sock->new_sock->cache = sock->cache;
139                         sock->cache = NULL;
140                         sock->new_sock->new_sock = sock;
141                 }
142         }
143         
144         /* replace muted nodes and reroute nodes by internal links */
145         for (node = localtree->nodes.first; node; node = node_next) {
146                 node_next = node->next;
147                 
148                 if (node->flag & NODE_MUTED || node->type == NODE_REROUTE) {
149                         /* make sure the update tag isn't lost when removing the muted node.
150                          * propagate this to all downstream nodes.
151                          */
152                         if (node->need_exec) {
153                                 bNodeLink *link;
154                                 for (link = localtree->links.first; link; link = link->next)
155                                         if (link->fromnode == node && link->tonode)
156                                                 link->tonode->need_exec = 1;
157                         }
158                         
159                         nodeInternalRelink(localtree, node);
160                         nodeFreeNode(localtree, node);
161                 }
162         }
163 }
164
165 static void local_sync(bNodeTree *localtree, bNodeTree *ntree)
166 {
167         BKE_node_preview_sync_tree(ntree, localtree);
168 }
169
170 static void local_merge(bNodeTree *localtree, bNodeTree *ntree)
171 {
172         bNode *lnode;
173         bNodeSocket *lsock;
174         
175         /* move over the compbufs and previews */
176         BKE_node_preview_merge_tree(ntree, localtree, true);
177         
178         for (lnode = localtree->nodes.first; lnode; lnode = lnode->next) {
179                 if (ntreeNodeExists(ntree, lnode->new_node)) {
180                         if (ELEM(lnode->type, CMP_NODE_VIEWER, CMP_NODE_SPLITVIEWER)) {
181                                 if (lnode->id && (lnode->flag & NODE_DO_OUTPUT)) {
182                                         /* image_merge does sanity check for pointers */
183                                         BKE_image_merge((Image *)lnode->new_node->id, (Image *)lnode->id);
184                                 }
185                         }
186                         else if (lnode->type == CMP_NODE_MOVIEDISTORTION) {
187                                 /* special case for distortion node: distortion context is allocating in exec function
188                                  * and to achieve much better performance on further calls this context should be
189                                  * copied back to original node */
190                                 if (lnode->storage) {
191                                         if (lnode->new_node->storage)
192                                                 BKE_tracking_distortion_free(lnode->new_node->storage);
193
194                                         lnode->new_node->storage = BKE_tracking_distortion_copy(lnode->storage);
195                                 }
196                         }
197                         
198                         for (lsock = lnode->outputs.first; lsock; lsock = lsock->next) {
199                                 if (ntreeOutputExists(lnode->new_node, lsock->new_sock)) {
200                                         lsock->new_sock->cache = lsock->cache;
201                                         lsock->cache = NULL;
202                                         lsock->new_sock = NULL;
203                                 }
204                         }
205                 }
206         }
207 }
208
209 static void update(bNodeTree *ntree)
210 {
211         ntreeSetOutput(ntree);
212         
213         ntree_update_reroute_nodes(ntree);
214         
215         if (ntree->update & NTREE_UPDATE_NODES) {
216                 /* clean up preview cache, in case nodes have been removed */
217                 BKE_node_preview_remove_unused(ntree);
218         }
219 }
220
221 static void composite_node_add_init(bNodeTree *UNUSED(bnodetree), bNode *bnode)
222 {
223         /* Composite node will only show previews for input classes 
224          * by default, other will be hidden 
225          * but can be made visible with the show_preview option */
226         if (bnode->typeinfo->nclass != NODE_CLASS_INPUT) {
227                 bnode->flag &= ~NODE_PREVIEW;
228         }       
229 }
230
231 bNodeTreeType *ntreeType_Composite;
232
233 void register_node_tree_type_cmp(void)
234 {
235         bNodeTreeType *tt = ntreeType_Composite = MEM_callocN(sizeof(bNodeTreeType), "compositor node tree type");
236         
237         tt->type = NTREE_COMPOSIT;
238         strcpy(tt->idname, "CompositorNodeTree");
239         strcpy(tt->ui_name, "Compositing");
240         tt->ui_icon = 0;    /* defined in drawnode.c */
241         strcpy(tt->ui_description, "Compositing nodes");
242         
243         tt->free_cache = free_cache;
244         tt->free_node_cache = free_node_cache;
245         tt->foreach_nodeclass = foreach_nodeclass;
246         tt->localize = localize;
247         tt->local_sync = local_sync;
248         tt->local_merge = local_merge;
249         tt->update = update;
250         tt->get_from_context = composite_get_from_context;
251         tt->node_add_init = composite_node_add_init;
252         
253         tt->ext.srna = &RNA_CompositorNodeTree;
254         
255         ntreeTypeAdd(tt);
256 }
257
258 void *COM_linker_hack = NULL;
259
260 void ntreeCompositExecTree(bNodeTree *ntree, RenderData *rd, int rendering, int do_preview,
261                            const ColorManagedViewSettings *view_settings,
262                            const ColorManagedDisplaySettings *display_settings)
263 {
264 #ifdef WITH_COMPOSITOR
265         COM_execute(rd, ntree, rendering, view_settings, display_settings);
266 #else
267         (void)ntree, (void)rd, (void)rendering, (void)do_preview;
268         (void)view_settings, (void)display_settings;
269 #endif
270
271         (void)do_preview;
272 }
273
274 /* *********************************************** */
275
276 /* based on rules, force sockets hidden always */
277 void ntreeCompositForceHidden(bNodeTree *ntree)
278 {
279         bNode *node;
280
281         if (ntree == NULL) return;
282
283         for (node = ntree->nodes.first; node; node = node->next) {
284                 if (node->type == CMP_NODE_R_LAYERS)
285                         node_cmp_rlayers_force_hidden_passes(node);
286                 
287                 /* XXX this stuff is called all the time, don't want that.
288                  * Updates should only happen when actually necessary.
289                  */
290 #if 0
291                 else if (node->type == CMP_NODE_IMAGE) {
292                         nodeUpdate(ntree, node);
293                 }
294 #endif
295         }
296
297 }
298
299 /* called from render pipeline, to tag render input and output */
300 /* need to do all scenes, to prevent errors when you re-render 1 scene */
301 void ntreeCompositTagRender(Scene *curscene)
302 {
303         Scene *sce;
304
305         for (sce = G.main->scene.first; sce; sce = sce->id.next) {
306                 if (sce->nodetree) {
307                         bNode *node;
308
309                         for (node = sce->nodetree->nodes.first; node; node = node->next) {
310                                 if (node->id == (ID *)curscene || node->type == CMP_NODE_COMPOSITE)
311                                         nodeUpdate(sce->nodetree, node);
312                                 else if (node->type == CMP_NODE_TEXTURE) /* uses scene sizex/sizey */
313                                         nodeUpdate(sce->nodetree, node);
314                         }
315                 }
316         }
317 }
318
319 static int node_animation_properties(bNodeTree *ntree, bNode *node)
320 {
321         bNodeSocket *sock;
322         const ListBase *lb;
323         Link *link;
324         PointerRNA ptr;
325         PropertyRNA *prop;
326
327         /* check to see if any of the node's properties have fcurves */
328         RNA_pointer_create((ID *)ntree, &RNA_Node, node, &ptr);
329         lb = RNA_struct_type_properties(ptr.type);
330
331         for (link = lb->first; link; link = link->next) {
332                 prop = (PropertyRNA *)link;
333
334                 if (RNA_property_animated(&ptr, prop)) {
335                         nodeUpdate(ntree, node);
336                         return 1;
337                 }
338         }
339
340         /* now check node sockets */
341         for (sock = node->inputs.first; sock; sock = sock->next) {
342                 RNA_pointer_create((ID *)ntree, &RNA_NodeSocket, sock, &ptr);
343                 prop = RNA_struct_find_property(&ptr, "default_value");
344
345                 if (RNA_property_animated(&ptr, prop)) {
346                         nodeUpdate(ntree, node);
347                         return 1;
348                 }
349         }
350
351         return 0;
352 }
353
354 /* tags nodes that have animation capabilities */
355 int ntreeCompositTagAnimated(bNodeTree *ntree)
356 {
357         bNode *node;
358         int tagged = 0;
359
360         if (ntree == NULL) return 0;
361
362         for (node = ntree->nodes.first; node; node = node->next) {
363
364                 tagged = node_animation_properties(ntree, node);
365
366                 /* otherwise always tag these node types */
367                 if (node->type == CMP_NODE_IMAGE) {
368                         Image *ima = (Image *)node->id;
369                         if (ima && BKE_image_is_animated(ima)) {
370                                 nodeUpdate(ntree, node);
371                                 tagged = 1;
372                         }
373                 }
374                 else if (node->type == CMP_NODE_TIME) {
375                         nodeUpdate(ntree, node);
376                         tagged = 1;
377                 }
378                 /* here was tag render layer, but this is called after a render, so re-composites fail */
379                 else if (node->type == NODE_GROUP) {
380                         if (ntreeCompositTagAnimated((bNodeTree *)node->id) ) {
381                                 nodeUpdate(ntree, node);
382                         }
383                 }
384                 else if (ELEM(node->type, CMP_NODE_MOVIECLIP, CMP_NODE_TRANSFORM)) {
385                         nodeUpdate(ntree, node);
386                         tagged = 1;
387                 }
388                 else if (node->type == CMP_NODE_MASK) {
389                         nodeUpdate(ntree, node);
390                         tagged = 1;
391                 }
392         }
393
394         return tagged;
395 }
396
397
398 /* called from image window preview */
399 void ntreeCompositTagGenerators(bNodeTree *ntree)
400 {
401         bNode *node;
402
403         if (ntree == NULL) return;
404
405         for (node = ntree->nodes.first; node; node = node->next) {
406                 if (ELEM(node->type, CMP_NODE_R_LAYERS, CMP_NODE_IMAGE))
407                         nodeUpdate(ntree, node);
408         }
409 }
410
411 /* XXX after render animation system gets a refresh, this call allows composite to end clean */
412 void ntreeCompositClearTags(bNodeTree *ntree)
413 {
414         bNode *node;
415
416         if (ntree == NULL) return;
417
418         for (node = ntree->nodes.first; node; node = node->next) {
419                 node->need_exec = 0;
420                 if (node->type == NODE_GROUP)
421                         ntreeCompositClearTags((bNodeTree *)node->id);
422         }
423 }