882c843f317a4f415b9b51e1f6d0d765158b0ecc
[blender.git] / source / blender / nodes / texture / node_texture_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/texture/node_texture_tree.c
29  *  \ingroup nodes
30  */
31
32
33 #include <string.h>
34
35 #include "DNA_texture_types.h"
36 #include "DNA_node_types.h"
37 #include "DNA_space_types.h"
38
39 #include "BLI_listbase.h"
40 #include "BLI_threads.h"
41 #include "BLI_utildefines.h"
42
43 #include "BLF_translation.h"
44
45 #include "BKE_context.h"
46 #include "BKE_global.h"
47 #include "BKE_main.h"
48 #include "BKE_node.h"
49 #include "BKE_paint.h"
50
51 #include "node_common.h"
52 #include "node_exec.h"
53 #include "node_util.h"
54 #include "NOD_texture.h"
55 #include "node_texture_util.h"
56
57 #include "RNA_access.h"
58
59 #include "RE_pipeline.h"
60 #include "RE_shader_ext.h"
61
62
63 static void texture_get_from_context(const bContext *C, bNodeTreeType *UNUSED(treetype), bNodeTree **r_ntree, ID **r_id, ID **r_from)
64 {
65         SpaceNode *snode = CTX_wm_space_node(C);
66         Scene *scene = CTX_data_scene(C);
67         Object *ob = OBACT;
68         Tex *tx = NULL;
69
70         if (snode->texfrom == SNODE_TEX_OBJECT) {
71                 if (ob) {
72                         tx = give_current_object_texture(ob);
73                         if (tx) {
74                                 if (ob->type == OB_LAMP)
75                                         *r_from = (ID *)ob->data;
76                                 else
77                                         *r_from = (ID *)give_current_material(ob, ob->actcol);
78                                 
79                                 /* from is not set fully for material nodes, should be ID + Node then */
80                                 *r_id = &tx->id;
81                                 *r_ntree = tx->nodetree;
82                         }
83                 }
84         }
85         else if (snode->texfrom == SNODE_TEX_WORLD) {
86                 if (scene->world) {
87                         *r_from = (ID *)scene->world;
88                         tx = give_current_world_texture(scene->world);
89                         if (tx) {
90                                 *r_id = &tx->id;
91                                 *r_ntree = tx->nodetree;
92                         }
93                 }
94         }
95         else if (snode->texfrom == SNODE_TEX_BRUSH) {
96                 struct Brush *brush = NULL;
97                 
98                 if (ob && (ob->mode & OB_MODE_SCULPT))
99                         brush = BKE_paint_brush(&scene->toolsettings->sculpt->paint);
100                 else
101                         brush = BKE_paint_brush(&scene->toolsettings->imapaint.paint);
102
103                 if (brush) {
104                         *r_from = (ID *)brush;
105                         tx = give_current_brush_texture(brush);
106                         if (tx) {
107                                 *r_id = &tx->id;
108                                 *r_ntree = tx->nodetree;
109                         }
110                 }
111         }
112         else if (snode->texfrom == SNODE_TEX_LINESTYLE) {
113                 FreestyleLineStyle *linestyle = CTX_data_linestyle_from_scene(scene);
114                 if (linestyle) {
115                         *r_from = (ID *)linestyle;
116                         tx = give_current_linestyle_texture(linestyle);
117                         if (tx) {
118                                 *r_id = &tx->id;
119                                 *r_ntree = tx->nodetree;
120                         }
121                 }
122         }
123 }
124
125 static void foreach_nodeclass(Scene *UNUSED(scene), void *calldata, bNodeClassCallback func)
126 {
127         func(calldata, NODE_CLASS_INPUT, N_("Input"));
128         func(calldata, NODE_CLASS_OUTPUT, N_("Output"));
129         func(calldata, NODE_CLASS_OP_COLOR, N_("Color"));
130         func(calldata, NODE_CLASS_PATTERN, N_("Patterns"));
131         func(calldata, NODE_CLASS_TEXTURE, N_("Textures"));
132         func(calldata, NODE_CLASS_CONVERTOR, N_("Convertor"));
133         func(calldata, NODE_CLASS_DISTORT, N_("Distort"));
134         func(calldata, NODE_CLASS_GROUP, N_("Group"));
135         func(calldata, NODE_CLASS_INTERFACE, N_("Interface"));
136         func(calldata, NODE_CLASS_LAYOUT, N_("Layout"));
137 }
138
139 static void localize(bNodeTree *localtree, bNodeTree *UNUSED(ntree))
140 {
141         bNode *node, *node_next;
142         
143         /* replace muted nodes and reroute nodes by internal links */
144         for (node = localtree->nodes.first; node; node = node_next) {
145                 node_next = node->next;
146                 
147                 if (node->flag & NODE_MUTED || node->type == NODE_REROUTE) {
148                         nodeInternalRelink(localtree, node);
149                         nodeFreeNode(localtree, node);
150                 }
151         }
152 }
153
154 static void local_sync(bNodeTree *localtree, bNodeTree *ntree)
155 {
156         BKE_node_preview_sync_tree(ntree, localtree);
157 }
158
159 static void local_merge(bNodeTree *localtree, bNodeTree *ntree)
160 {
161         BKE_node_preview_merge_tree(ntree, localtree, true);
162 }
163
164 static void update(bNodeTree *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_Texture;
175
176 void register_node_tree_type_tex(void)
177 {
178         bNodeTreeType *tt = ntreeType_Texture = MEM_callocN(sizeof(bNodeTreeType), "texture node tree type");
179         
180         tt->type = NTREE_TEXTURE;
181         strcpy(tt->idname, "TextureNodeTree");
182         strcpy(tt->ui_name, "Texture");
183         tt->ui_icon = 0;    /* defined in drawnode.c */
184         strcpy(tt->ui_description, "Texture nodes");
185         
186         tt->foreach_nodeclass = foreach_nodeclass;
187         tt->update = update;
188         tt->localize = localize;
189         tt->local_sync = local_sync;
190         tt->local_merge = local_merge;
191         tt->get_from_context = texture_get_from_context;
192         
193         tt->ext.srna = &RNA_TextureNodeTree;
194         
195         ntreeTypeAdd(tt);
196 }
197
198 int ntreeTexTagAnimated(bNodeTree *ntree)
199 {
200         bNode *node;
201         
202         if (ntree == NULL) return 0;
203         
204         for (node = ntree->nodes.first; node; node = node->next) {
205                 if (node->type == TEX_NODE_CURVE_TIME) {
206                         nodeUpdate(ntree, node);
207                         return 1;
208                 }
209                 else if (node->type == NODE_GROUP) {
210                         if (ntreeTexTagAnimated((bNodeTree *)node->id) ) {
211                                 return 1;
212                         }
213                 }
214         }
215         
216         return 0;
217 }
218
219 bNodeTreeExec *ntreeTexBeginExecTree_internal(bNodeExecContext *context, bNodeTree *ntree, bNodeInstanceKey parent_key)
220 {
221         bNodeTreeExec *exec;
222         bNode *node;
223         
224         /* common base initialization */
225         exec = ntree_exec_begin(context, ntree, parent_key);
226         
227         /* allocate the thread stack listbase array */
228         exec->threadstack = MEM_callocN(BLENDER_MAX_THREADS * sizeof(ListBase), "thread stack array");
229         
230         for (node = exec->nodetree->nodes.first; node; node = node->next)
231                 node->need_exec = 1;
232         
233         return exec;
234 }
235
236 bNodeTreeExec *ntreeTexBeginExecTree(bNodeTree *ntree)
237 {
238         bNodeExecContext context;
239         bNodeTreeExec *exec;
240         
241         /* XXX hack: prevent exec data from being generated twice.
242          * this should be handled by the renderer!
243          */
244         if (ntree->execdata)
245                 return ntree->execdata;
246         
247         context.previews = ntree->previews;
248         
249         exec = ntreeTexBeginExecTree_internal(&context, ntree, NODE_INSTANCE_KEY_BASE);
250         
251         /* XXX this should not be necessary, but is still used for cmp/sha/tex nodes,
252          * which only store the ntree pointer. Should be fixed at some point!
253          */
254         ntree->execdata = exec;
255         
256         return exec;
257 }
258
259 /* free texture delegates */
260 static void tex_free_delegates(bNodeTreeExec *exec)
261 {
262         bNodeThreadStack *nts;
263         bNodeStack *ns;
264         int th, a;
265         
266         for (th = 0; th < BLENDER_MAX_THREADS; th++)
267                 for (nts = exec->threadstack[th].first; nts; nts = nts->next)
268                         for (ns = nts->stack, a = 0; a < exec->stacksize; a++, ns++)
269                                 if (ns->data && !ns->is_copy)
270                                         MEM_freeN(ns->data);
271 }
272
273 void ntreeTexEndExecTree_internal(bNodeTreeExec *exec)
274 {
275         bNodeThreadStack *nts;
276         int a;
277         
278         if (exec->threadstack) {
279                 tex_free_delegates(exec);
280                 
281                 for (a = 0; a < BLENDER_MAX_THREADS; a++) {
282                         for (nts = exec->threadstack[a].first; nts; nts = nts->next)
283                                 if (nts->stack) MEM_freeN(nts->stack);
284                         BLI_freelistN(&exec->threadstack[a]);
285                 }
286                 
287                 MEM_freeN(exec->threadstack);
288                 exec->threadstack = NULL;
289         }
290         
291         ntree_exec_end(exec);
292 }
293
294 void ntreeTexEndExecTree(bNodeTreeExec *exec)
295 {
296         if (exec) {
297                 /* exec may get freed, so assign ntree */
298                 bNodeTree *ntree = exec->nodetree;
299                 ntreeTexEndExecTree_internal(exec);
300                 
301                 /* XXX clear nodetree backpointer to exec data, same problem as noted in ntreeBeginExecTree */
302                 ntree->execdata = NULL;
303         }
304 }
305
306 int ntreeTexExecTree(
307         bNodeTree *nodes,
308         TexResult *texres,
309         float co[3],
310         float dxt[3], float dyt[3],
311         int osatex,
312         const short thread,
313         Tex *UNUSED(tex),
314         short which_output,
315         int cfra,
316         int preview,
317         ShadeInput *shi,
318         MTex *mtex)
319 {
320         TexCallData data;
321         float *nor = texres->nor;
322         int retval = TEX_INT;
323         bNodeThreadStack *nts = NULL;
324         bNodeTreeExec *exec = nodes->execdata;
325
326         data.co = co;
327         data.dxt = dxt;
328         data.dyt = dyt;
329         data.osatex = osatex;
330         data.target = texres;
331         data.do_preview = preview;
332         data.do_manage = (shi) ? shi->do_manage : 0;
333         data.thread = thread;
334         data.which_output = which_output;
335         data.cfra = cfra;
336         data.mtex = mtex;
337         data.shi = shi;
338         
339         /* ensure execdata is only initialized once */
340         if (!exec) {
341                 BLI_lock_thread(LOCK_NODES);
342                 if (!nodes->execdata)
343                         ntreeTexBeginExecTree(nodes);
344                 BLI_unlock_thread(LOCK_NODES);
345
346                 exec = nodes->execdata;
347         }
348         
349         nts = ntreeGetThreadStack(exec, thread);
350         ntreeExecThreadNodes(exec, nts, &data, thread);
351         ntreeReleaseThreadStack(nts);
352
353         if (texres->nor) retval |= TEX_NOR;
354         retval |= TEX_RGB;
355         /* confusing stuff; the texture output node sets this to NULL to indicate no normal socket was set
356          * however, the texture code checks this for other reasons (namely, a normal is required for material) */
357         texres->nor = nor;
358
359         return retval;
360 }