Merge branch 'blender2.7'
[blender.git] / source / blender / nodes / intern / node_exec.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): Nathan Letwory.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file blender/nodes/intern/node_exec.c
29  *  \ingroup nodes
30  */
31
32
33 #include "DNA_node_types.h"
34
35 #include "BLI_listbase.h"
36 #include "BLI_utildefines.h"
37
38 #include "BKE_global.h"
39 #include "BKE_node.h"
40
41 #include "MEM_guardedalloc.h"
42
43 #include "node_exec.h"
44 #include "node_util.h"
45
46
47 /* supported socket types in old nodes */
48 int node_exec_socket_use_stack(bNodeSocket *sock)
49 {
50         return ELEM(sock->type, SOCK_FLOAT, SOCK_VECTOR, SOCK_RGBA, SOCK_SHADER);
51 }
52
53 /* for a given socket, find the actual stack entry */
54 bNodeStack *node_get_socket_stack(bNodeStack *stack, bNodeSocket *sock)
55 {
56         if (stack && sock && sock->stack_index >= 0)
57                 return stack + sock->stack_index;
58         return NULL;
59 }
60
61 void node_get_stack(bNode *node, bNodeStack *stack, bNodeStack **in, bNodeStack **out)
62 {
63         bNodeSocket *sock;
64
65         /* build pointer stack */
66         if (in) {
67                 for (sock = node->inputs.first; sock; sock = sock->next) {
68                         *(in++) = node_get_socket_stack(stack, sock);
69                 }
70         }
71
72         if (out) {
73                 for (sock = node->outputs.first; sock; sock = sock->next) {
74                         *(out++) = node_get_socket_stack(stack, sock);
75                 }
76         }
77 }
78
79 static void node_init_input_index(bNodeSocket *sock, int *index)
80 {
81         /* Only consider existing link if from socket is valid! */
82         if (sock->link && sock->link->fromsock && sock->link->fromsock->stack_index >= 0) {
83                 sock->stack_index = sock->link->fromsock->stack_index;
84         }
85         else {
86                 if (node_exec_socket_use_stack(sock))
87                         sock->stack_index = (*index)++;
88                 else
89                         sock->stack_index = -1;
90         }
91 }
92
93 static void node_init_output_index(bNodeSocket *sock, int *index, ListBase *internal_links)
94 {
95         if (internal_links) {
96                 bNodeLink *link;
97                 /* copy the stack index from internally connected input to skip the node */
98                 for (link = internal_links->first; link; link = link->next) {
99                         if (link->tosock == sock) {
100                                 sock->stack_index = link->fromsock->stack_index;
101                                 /* set the link pointer to indicate that this socket
102                                  * should not overwrite the stack value!
103                                  */
104                                 sock->link = link;
105                                 break;
106                         }
107                 }
108                 /* if not internally connected, assign a new stack index anyway to avoid bad stack access */
109                 if (!link) {
110                         if (node_exec_socket_use_stack(sock))
111                                 sock->stack_index = (*index)++;
112                         else
113                                 sock->stack_index = -1;
114                 }
115         }
116         else {
117                 if (node_exec_socket_use_stack(sock))
118                         sock->stack_index = (*index)++;
119                 else
120                         sock->stack_index = -1;
121         }
122 }
123
124 /* basic preparation of socket stacks */
125 static struct bNodeStack *setup_stack(bNodeStack *stack, bNodeTree *ntree, bNode *node, bNodeSocket *sock)
126 {
127         bNodeStack *ns = node_get_socket_stack(stack, sock);
128         if (!ns)
129                 return NULL;
130
131         /* don't mess with remote socket stacks, these are initialized by other nodes! */
132         if (sock->link)
133                 return ns;
134
135         ns->sockettype = sock->type;
136
137         switch (sock->type) {
138                 case SOCK_FLOAT:
139                         ns->vec[0] = node_socket_get_float(ntree, node, sock);
140                         break;
141                 case SOCK_VECTOR:
142                         node_socket_get_vector(ntree, node, sock, ns->vec);
143                         break;
144                 case SOCK_RGBA:
145                         node_socket_get_color(ntree, node, sock, ns->vec);
146                         break;
147         }
148
149         return ns;
150 }
151
152 bNodeTreeExec *ntree_exec_begin(bNodeExecContext *context, bNodeTree *ntree, bNodeInstanceKey parent_key)
153 {
154         bNodeTreeExec *exec;
155         bNode *node;
156         bNodeExec *nodeexec;
157         bNodeInstanceKey nodekey;
158         bNodeSocket *sock;
159         bNodeStack *ns;
160         int index;
161         bNode **nodelist;
162         int totnodes, n;
163         /* XXX texnodes have threading issues with muting, have to disable it there ... */
164
165         /* ensure all sock->link pointers and node levels are correct */
166         /* Using global main here is likely totally wrong, not sure what to do about that one though...
167          * We cannot even check ntree is in global main, since most of the time it won't be (thanks to ntree design)!!! */
168         ntreeUpdateTree(G.main, ntree);
169
170         /* get a dependency-sorted list of nodes */
171         ntreeGetDependencyList(ntree, &nodelist, &totnodes);
172
173         /* XXX could let callbacks do this for specialized data */
174         exec = MEM_callocN(sizeof(bNodeTreeExec), "node tree execution data");
175         /* backpointer to node tree */
176         exec->nodetree = ntree;
177
178         /* set stack indices */
179         index = 0;
180         for (n = 0; n < totnodes; ++n) {
181                 node = nodelist[n];
182
183                 node->stack_index = index;
184
185                 /* init node socket stack indexes */
186                 for (sock = node->inputs.first; sock; sock = sock->next)
187                         node_init_input_index(sock, &index);
188
189                 if (node->flag & NODE_MUTED || node->type == NODE_REROUTE) {
190                         for (sock = node->outputs.first; sock; sock = sock->next)
191                                 node_init_output_index(sock, &index, &node->internal_links);
192                 }
193                 else {
194                         for (sock = node->outputs.first; sock; sock = sock->next)
195                                 node_init_output_index(sock, &index, NULL);
196                 }
197         }
198
199         /* allocated exec data pointers for nodes */
200         exec->totnodes = totnodes;
201         exec->nodeexec = MEM_callocN(exec->totnodes * sizeof(bNodeExec), "node execution data");
202         /* allocate data pointer for node stack */
203         exec->stacksize = index;
204         exec->stack = MEM_callocN(exec->stacksize * sizeof(bNodeStack), "bNodeStack");
205
206         /* all non-const results are considered inputs */
207         for (n = 0; n < exec->stacksize; ++n)
208                 exec->stack[n].hasinput = 1;
209
210         /* prepare all nodes for execution */
211         for (n = 0, nodeexec = exec->nodeexec; n < totnodes; ++n, ++nodeexec) {
212                 node = nodeexec->node = nodelist[n];
213                 nodeexec->freeexecfunc = node->typeinfo->freeexecfunc;
214
215                 /* tag inputs */
216                 for (sock = node->inputs.first; sock; sock = sock->next) {
217                         /* disable the node if an input link is invalid */
218                         if (sock->link && !(sock->link->flag & NODE_LINK_VALID))
219                                 node->need_exec = 0;
220
221                         ns = setup_stack(exec->stack, ntree, node, sock);
222                         if (ns)
223                                 ns->hasoutput = 1;
224                 }
225
226                 /* tag all outputs */
227                 for (sock = node->outputs.first; sock; sock = sock->next) {
228                         /* ns = */ setup_stack(exec->stack, ntree, node, sock);
229                 }
230
231                 nodekey = BKE_node_instance_key(parent_key, ntree, node);
232                 nodeexec->data.preview = context->previews ? BKE_node_instance_hash_lookup(context->previews, nodekey) : NULL;
233                 if (node->typeinfo->initexecfunc)
234                         nodeexec->data.data = node->typeinfo->initexecfunc(context, node, nodekey);
235         }
236
237         if (nodelist)
238                 MEM_freeN(nodelist);
239
240         return exec;
241 }
242
243 void ntree_exec_end(bNodeTreeExec *exec)
244 {
245         bNodeExec *nodeexec;
246         int n;
247
248         if (exec->stack)
249                 MEM_freeN(exec->stack);
250
251         for (n = 0, nodeexec = exec->nodeexec; n < exec->totnodes; ++n, ++nodeexec) {
252                 if (nodeexec->freeexecfunc)
253                         nodeexec->freeexecfunc(nodeexec->data.data);
254         }
255
256         if (exec->nodeexec)
257                 MEM_freeN(exec->nodeexec);
258
259         MEM_freeN(exec);
260 }
261
262 /**** Material/Texture trees ****/
263
264 bNodeThreadStack *ntreeGetThreadStack(bNodeTreeExec *exec, int thread)
265 {
266         ListBase *lb = &exec->threadstack[thread];
267         bNodeThreadStack *nts;
268
269         for (nts = lb->first; nts; nts = nts->next) {
270                 if (!nts->used) {
271                         nts->used = true;
272                         break;
273                 }
274         }
275
276         if (!nts) {
277                 nts = MEM_callocN(sizeof(bNodeThreadStack), "bNodeThreadStack");
278                 nts->stack = MEM_dupallocN(exec->stack);
279                 nts->used = true;
280                 BLI_addtail(lb, nts);
281         }
282
283         return nts;
284 }
285
286 void ntreeReleaseThreadStack(bNodeThreadStack *nts)
287 {
288         nts->used = 0;
289 }
290
291 bool ntreeExecThreadNodes(bNodeTreeExec *exec, bNodeThreadStack *nts, void *callerdata, int thread)
292 {
293         bNodeStack *nsin[MAX_SOCKET] = {NULL};   /* arbitrary... watch this */
294         bNodeStack *nsout[MAX_SOCKET] = {NULL};  /* arbitrary... watch this */
295         bNodeExec *nodeexec;
296         bNode *node;
297         int n;
298
299         /* nodes are presorted, so exec is in order of list */
300
301         for (n = 0, nodeexec = exec->nodeexec; n < exec->totnodes; ++n, ++nodeexec) {
302                 node = nodeexec->node;
303                 if (node->need_exec) {
304                         node_get_stack(node, nts->stack, nsin, nsout);
305                         /* Handle muted nodes...
306                          * If the mute func is not set, assume the node should never be muted,
307                          * and hence execute it!
308                          */
309                         if (node->typeinfo->execfunc && !(node->flag & NODE_MUTED))
310                                 node->typeinfo->execfunc(callerdata, thread, node, &nodeexec->data, nsin, nsout);
311                 }
312         }
313
314         /* signal to that all went OK, for render */
315         return true;
316 }