Fix T43427: Particle system children sometimes not generated on reload
[blender.git] / source / blender / nodes / shader / node_shader_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/shader/node_shader_tree.c
29  *  \ingroup nodes
30  */
31
32
33 #include <string.h>
34
35 #include "DNA_lamp_types.h"
36 #include "DNA_material_types.h"
37 #include "DNA_node_types.h"
38 #include "DNA_scene_types.h"
39 #include "DNA_space_types.h"
40 #include "DNA_world_types.h"
41 #include "DNA_linestyle_types.h"
42
43 #include "BLI_listbase.h"
44 #include "BLI_threads.h"
45 #include "BLI_utildefines.h"
46
47 #include "BLF_translation.h"
48
49 #include "BKE_context.h"
50 #include "BKE_linestyle.h"
51 #include "BKE_node.h"
52 #include "BKE_scene.h"
53
54 #include "RNA_access.h"
55
56 #include "GPU_material.h"
57
58 #include "RE_shader_ext.h"
59
60 #include "node_common.h"
61 #include "node_exec.h"
62 #include "node_util.h"
63 #include "node_shader_util.h"
64
65 static int shader_tree_poll(const bContext *C, bNodeTreeType *UNUSED(treetype))
66 {
67         Scene *scene = CTX_data_scene(C);
68         /* allow empty engine string too, this is from older versions that didn't have registerable engines yet */
69         return (scene->r.engine[0] == '\0' ||
70                 STREQ(scene->r.engine, RE_engine_id_BLENDER_RENDER) ||
71                 STREQ(scene->r.engine, RE_engine_id_BLENDER_GAME) ||
72                 STREQ(scene->r.engine, RE_engine_id_CYCLES));
73 }
74
75 static void shader_get_from_context(const bContext *C, bNodeTreeType *UNUSED(treetype), bNodeTree **r_ntree, ID **r_id, ID **r_from)
76 {
77         SpaceNode *snode = CTX_wm_space_node(C);
78         Scene *scene = CTX_data_scene(C);
79         Object *ob = OBACT;
80         
81         if ((snode->shaderfrom == SNODE_SHADER_OBJECT) ||
82             (BKE_scene_use_new_shading_nodes(scene) == false))
83         {
84                 if (ob) {
85                         *r_from = &ob->id;
86                         if (ob->type == OB_LAMP) {
87                                 *r_id = ob->data;
88                                 *r_ntree = ((Lamp *)ob->data)->nodetree;
89                         }
90                         else {
91                                 Material *ma = give_current_material(ob, ob->actcol);
92                                 if (ma) {
93                                         *r_id = &ma->id;
94                                         *r_ntree = ma->nodetree;
95                                 }
96                         }
97                 }
98         }
99 #ifdef WITH_FREESTYLE
100         else if (snode->shaderfrom == SNODE_SHADER_LINESTYLE) {
101                 FreestyleLineStyle *linestyle = BKE_linestyle_active_from_scene(scene);
102                 if (linestyle) {
103                         *r_from = NULL;
104                         *r_id = &linestyle->id;
105                         *r_ntree = linestyle->nodetree;
106                 }
107         }
108 #endif
109         else { /* SNODE_SHADER_WORLD */
110                 if (scene->world) {
111                         *r_from = NULL;
112                         *r_id = &scene->world->id;
113                         *r_ntree = scene->world->nodetree;
114                 }
115         }
116 }
117
118 static void foreach_nodeclass(Scene *scene, void *calldata, bNodeClassCallback func)
119 {
120         func(calldata, NODE_CLASS_INPUT, N_("Input"));
121         func(calldata, NODE_CLASS_OUTPUT, N_("Output"));
122
123         if (BKE_scene_use_new_shading_nodes(scene)) {
124                 func(calldata, NODE_CLASS_SHADER, N_("Shader"));
125                 func(calldata, NODE_CLASS_TEXTURE, N_("Texture"));
126         }
127         
128         func(calldata, NODE_CLASS_OP_COLOR, N_("Color"));
129         func(calldata, NODE_CLASS_OP_VECTOR, N_("Vector"));
130         func(calldata, NODE_CLASS_CONVERTOR, N_("Convertor"));
131         func(calldata, NODE_CLASS_SCRIPT, N_("Script"));
132         func(calldata, NODE_CLASS_GROUP, N_("Group"));
133         func(calldata, NODE_CLASS_INTERFACE, N_("Interface"));
134         func(calldata, NODE_CLASS_LAYOUT, N_("Layout"));
135 }
136
137 static void localize(bNodeTree *localtree, bNodeTree *UNUSED(ntree))
138 {
139         bNode *node, *node_next;
140         
141         /* replace muted nodes and reroute nodes by internal links */
142         for (node = localtree->nodes.first; node; node = node_next) {
143                 node_next = node->next;
144                 
145                 if (node->flag & NODE_MUTED || node->type == NODE_REROUTE) {
146                         nodeInternalRelink(localtree, node);
147                         nodeFreeNode(localtree, node);
148                 }
149         }
150 }
151
152 static void local_sync(bNodeTree *localtree, bNodeTree *ntree)
153 {
154         BKE_node_preview_sync_tree(ntree, localtree);
155 }
156
157 static void local_merge(bNodeTree *localtree, bNodeTree *ntree)
158 {
159         BKE_node_preview_merge_tree(ntree, localtree, true);
160 }
161
162 static void update(bNodeTree *ntree)
163 {
164         ntreeSetOutput(ntree);
165         
166         ntree_update_reroute_nodes(ntree);
167         
168         if (ntree->update & NTREE_UPDATE_NODES) {
169                 /* clean up preview cache, in case nodes have been removed */
170                 BKE_node_preview_remove_unused(ntree);
171         }
172 }
173
174 bNodeTreeType *ntreeType_Shader;
175
176 void register_node_tree_type_sh(void)
177 {
178         bNodeTreeType *tt = ntreeType_Shader = MEM_callocN(sizeof(bNodeTreeType), "shader node tree type");
179         
180         tt->type = NTREE_SHADER;
181         strcpy(tt->idname, "ShaderNodeTree");
182         strcpy(tt->ui_name, "Shader");
183         tt->ui_icon = 0;    /* defined in drawnode.c */
184         strcpy(tt->ui_description, "Shader nodes");
185         
186         tt->foreach_nodeclass = foreach_nodeclass;
187         tt->localize = localize;
188         tt->local_sync = local_sync;
189         tt->local_merge = local_merge;
190         tt->update = update;
191         tt->poll = shader_tree_poll;
192         tt->get_from_context = shader_get_from_context;
193         
194         tt->ext.srna = &RNA_ShaderNodeTree;
195         
196         ntreeTypeAdd(tt);
197 }
198
199 /* GPU material from shader nodes */
200
201 void ntreeGPUMaterialNodes(bNodeTree *ntree, GPUMaterial *mat, short compatibility)
202 {
203         /* localize tree to create links for reroute and mute */
204         bNodeTree *localtree = ntreeLocalize(ntree);
205         bNodeTreeExec *exec;
206
207         exec = ntreeShaderBeginExecTree(localtree);
208         ntreeExecGPUNodes(exec, mat, 1, compatibility);
209         ntreeShaderEndExecTree(exec);
210
211         ntreeFreeTree_ex(localtree, false);
212         MEM_freeN(localtree);
213 }
214
215 /* **************** call to switch lamploop for material node ************ */
216
217 void (*node_shader_lamp_loop)(struct ShadeInput *, struct ShadeResult *);
218
219 void set_node_shader_lamp_loop(void (*lamp_loop_func)(ShadeInput *, ShadeResult *))
220 {
221         node_shader_lamp_loop = lamp_loop_func;
222 }
223
224
225 bNodeTreeExec *ntreeShaderBeginExecTree_internal(bNodeExecContext *context, bNodeTree *ntree, bNodeInstanceKey parent_key)
226 {
227         bNodeTreeExec *exec;
228         bNode *node;
229         
230         /* ensures only a single output node is enabled */
231         ntreeSetOutput(ntree);
232         
233         /* common base initialization */
234         exec = ntree_exec_begin(context, ntree, parent_key);
235         
236         /* allocate the thread stack listbase array */
237         exec->threadstack = MEM_callocN(BLENDER_MAX_THREADS * sizeof(ListBase), "thread stack array");
238         
239         for (node = exec->nodetree->nodes.first; node; node = node->next)
240                 node->need_exec = 1;
241         
242         return exec;
243 }
244
245 bNodeTreeExec *ntreeShaderBeginExecTree(bNodeTree *ntree)
246 {
247         bNodeExecContext context;
248         bNodeTreeExec *exec;
249         
250         /* XXX hack: prevent exec data from being generated twice.
251          * this should be handled by the renderer!
252          */
253         if (ntree->execdata)
254                 return ntree->execdata;
255         
256         context.previews = ntree->previews;
257         
258         exec = ntreeShaderBeginExecTree_internal(&context, ntree, NODE_INSTANCE_KEY_BASE);
259         
260         /* XXX this should not be necessary, but is still used for cmp/sha/tex nodes,
261          * which only store the ntree pointer. Should be fixed at some point!
262          */
263         ntree->execdata = exec;
264         
265         return exec;
266 }
267
268 void ntreeShaderEndExecTree_internal(bNodeTreeExec *exec)
269 {
270         bNodeThreadStack *nts;
271         int a;
272         
273         if (exec->threadstack) {
274                 for (a = 0; a < BLENDER_MAX_THREADS; a++) {
275                         for (nts = exec->threadstack[a].first; nts; nts = nts->next)
276                                 if (nts->stack) MEM_freeN(nts->stack);
277                         BLI_freelistN(&exec->threadstack[a]);
278                 }
279                 
280                 MEM_freeN(exec->threadstack);
281                 exec->threadstack = NULL;
282         }
283         
284         ntree_exec_end(exec);
285 }
286
287 void ntreeShaderEndExecTree(bNodeTreeExec *exec)
288 {
289         if (exec) {
290                 /* exec may get freed, so assign ntree */
291                 bNodeTree *ntree = exec->nodetree;
292                 ntreeShaderEndExecTree_internal(exec);
293                 
294                 /* XXX clear nodetree backpointer to exec data, same problem as noted in ntreeBeginExecTree */
295                 ntree->execdata = NULL;
296         }
297 }
298
299 /* only for Blender internal */
300 bool ntreeShaderExecTree(bNodeTree *ntree, ShadeInput *shi, ShadeResult *shr)
301 {
302         ShaderCallData scd;
303         /**
304          * \note: preserve material from ShadeInput for material id, nodetree execs change it
305          * fix for bug "[#28012] Mat ID messy with shader nodes"
306          */
307         Material *mat = shi->mat;
308         bNodeThreadStack *nts = NULL;
309         bNodeTreeExec *exec = ntree->execdata;
310         int compat;
311         
312         /* convert caller data to struct */
313         scd.shi = shi;
314         scd.shr = shr;
315         
316         /* each material node has own local shaderesult, with optional copying */
317         memset(shr, 0, sizeof(ShadeResult));
318         
319         /* ensure execdata is only initialized once */
320         if (!exec) {
321                 BLI_lock_thread(LOCK_NODES);
322                 if (!ntree->execdata)
323                         ntree->execdata = ntreeShaderBeginExecTree(ntree);
324                 BLI_unlock_thread(LOCK_NODES);
325
326                 exec = ntree->execdata;
327         }
328         
329         nts = ntreeGetThreadStack(exec, shi->thread);
330         compat = ntreeExecThreadNodes(exec, nts, &scd, shi->thread);
331         ntreeReleaseThreadStack(nts);
332         
333         // \note: set material back to preserved material
334         shi->mat = mat;
335                 
336         /* better not allow negative for now */
337         if (shr->combined[0] < 0.0f) shr->combined[0] = 0.0f;
338         if (shr->combined[1] < 0.0f) shr->combined[1] = 0.0f;
339         if (shr->combined[2] < 0.0f) shr->combined[2] = 0.0f;
340         
341         /* if compat is zero, it has been using non-compatible nodes */
342         return compat;
343 }