doxygen: prevent GPL license block from being parsed as doxygen comment.
[blender.git] / source / blender / nodes / intern / TEX_nodes / TEX_proc.c
1 /*
2  *
3  * ***** BEGIN GPL LICENSE BLOCK *****
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version. 
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software Foundation,
17  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18  *
19  * The Original Code is Copyright (C) 2005 Blender Foundation.
20  * All rights reserved.
21  *
22  * The Original Code is: all of this file.
23  *
24  * Contributor(s): Robin Allen
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 #include "../TEX_util.h"
30 #include "RE_shader_ext.h"
31
32 /* 
33         In this file: wrappers to use procedural textures as nodes
34 */
35
36
37 static bNodeSocketType outputs_both[]= {
38         { SOCK_RGBA, 0, "Color",  1.0f, 0.0f, 0.0f, 1.0f, 0.0f, 1.0f },
39         { SOCK_VECTOR, 0, "Normal", 0.0f, 0.0f, 1.0f, 0.0f, 0.0f, 1.0f },
40         { -1, 0, "" }
41 };
42 static bNodeSocketType outputs_color_only[]= {
43         { SOCK_RGBA, 0, "Color",  1.0f, 0.0f, 0.0f, 1.0f, 0.0f, 1.0f },
44         { -1, 0, "" }
45 };
46
47 /* Inputs common to all, #defined because nodes will need their own inputs too */
48 #define I 2 /* count */
49 #define COMMON_INPUTS \
50         { SOCK_RGBA, 1, "Color 1", 0.0f, 0.0f, 0.0f, 1.0f, 0.0f, 1.0f }, \
51         { SOCK_RGBA, 1, "Color 2", 1.0f, 1.0f, 1.0f, 1.0f, 0.0f, 1.0f }
52
53 /* Calls multitex and copies the result to the outputs. Called by xxx_exec, which handles inputs. */
54 static void do_proc(float *result, TexParams *p, float *col1, float *col2, char is_normal, Tex *tex, short thread)
55 {
56         TexResult texres;
57         int textype;
58         
59         if(is_normal) {
60                 texres.nor = result;
61         }
62         else
63                 texres.nor = NULL;
64         
65         textype = multitex_nodes(tex, p->co, p->dxt, p->dyt, p->osatex,
66                 &texres, thread, 0, p->shi, p->mtex);
67         
68         if(is_normal)
69                 return;
70         
71         if(textype & TEX_RGB) {
72                 QUATCOPY(result, &texres.tr);
73         }
74         else {
75                 QUATCOPY(result, col1);
76                 ramp_blend(MA_RAMP_BLEND, result, result+1, result+2, texres.tin, col2);
77         }
78 }
79
80 typedef void (*MapFn) (Tex *tex, bNodeStack **in, TexParams *p, short thread);
81
82 static void texfn(
83         float *result, 
84         TexParams *p,
85         bNode *node, 
86         bNodeStack **in,
87         char is_normal, 
88         MapFn map_inputs,
89         short thread)
90 {
91         Tex tex = *((Tex*)(node->storage));
92         float col1[4], col2[4];
93         tex_input_rgba(col1, in[0], p, thread);
94         tex_input_rgba(col2, in[1], p, thread);
95         
96         map_inputs(&tex, in, p, thread);
97         
98         do_proc(result, p, col1, col2, is_normal, &tex, thread);
99 }
100
101 static int count_outputs(bNode *node)
102 {
103         bNodeSocket *sock;
104         int num = 0;
105         for(sock= node->outputs.first; sock; sock= sock->next) {
106                 num++;
107         }
108         return num;
109 }
110
111 /* Boilerplate generators */
112
113 #define ProcNoInputs(name) \
114                 static void name##_map_inputs(Tex *UNUSED(tex), bNodeStack **UNUSED(in), TexParams *UNUSED(p), short UNUSED(thread)) \
115                 {}
116
117 #define ProcDef(name) \
118                 static void name##_colorfn(float *result, TexParams *p, bNode *node, bNodeStack **in, short thread)  \
119                 {                                                                                                    \
120                                 texfn(result, p, node, in, 0, &name##_map_inputs, thread);                               \
121                 }                                                                                                    \
122                 static void name##_normalfn(float *result, TexParams *p, bNode *node, bNodeStack **in, short thread) \
123                 {                                                                                                    \
124                                 texfn(result, p, node, in, 1, &name##_map_inputs, thread);                               \
125                 }                                                                                                    \
126                 static void name##_exec(void *data, bNode *node, bNodeStack **in, bNodeStack **out)                  \
127                 {                                                                                                    \
128                                 int outs = count_outputs(node);                                                              \
129                                 if(outs >= 1) tex_output(node, in, out[0], &name##_colorfn, data);                                 \
130                                 if(outs >= 2) tex_output(node, in, out[1], &name##_normalfn, data);                                \
131                 }
132
133
134 /* --- VORONOI -- */
135 static bNodeSocketType voronoi_inputs[]= {
136         COMMON_INPUTS,
137         { SOCK_VALUE, 1, "W1", 1.0f, 0.0f, 0.0f, 0.0f,   -2.0f, 2.0f },
138         { SOCK_VALUE, 1, "W2", 0.0f, 0.0f, 0.0f, 0.0f,   -2.0f, 2.0f },
139         { SOCK_VALUE, 1, "W3", 0.0f, 0.0f, 0.0f, 0.0f,   -2.0f, 2.0f },
140         { SOCK_VALUE, 1, "W4", 0.0f, 0.0f, 0.0f, 0.0f,   -2.0f, 2.0f },
141         
142         { SOCK_VALUE, 1, "iScale", 1.0f, 0.0f, 0.0f, 0.0f,    0.01f,  10.0f },
143         { SOCK_VALUE, 1, "Size",   0.25f, 0.0f, 0.0f, 0.0f,   0.0001f, 4.0f },
144         
145         { -1, 0, "" }
146 };
147 static void voronoi_map_inputs(Tex *tex, bNodeStack **in, TexParams *p, short thread)
148 {
149         tex->vn_w1 = tex_input_value(in[I+0], p, thread);
150         tex->vn_w2 = tex_input_value(in[I+1], p, thread);
151         tex->vn_w3 = tex_input_value(in[I+2], p, thread);
152         tex->vn_w4 = tex_input_value(in[I+3], p, thread);
153         
154         tex->ns_outscale = tex_input_value(in[I+4], p, thread);
155         tex->noisesize   = tex_input_value(in[I+5], p, thread);
156 }
157 ProcDef(voronoi)
158
159 /* --- BLEND -- */
160 static bNodeSocketType blend_inputs[]= {
161         COMMON_INPUTS,
162         { -1, 0, "" }
163 };
164 ProcNoInputs(blend)
165 ProcDef(blend)
166
167 /* -- MAGIC -- */
168 static bNodeSocketType magic_inputs[]= {
169         COMMON_INPUTS,
170         { SOCK_VALUE, 1, "Turbulence", 5.0f, 0.0f, 0.0f, 0.0f,   0.0f, 200.0f },
171         { -1, 0, "" }
172 };
173 static void magic_map_inputs(Tex *tex, bNodeStack **in, TexParams *p, short thread)
174 {
175         tex->turbul = tex_input_value(in[I+0], p, thread);
176 }
177 ProcDef(magic)
178
179 /* --- MARBLE --- */
180 static bNodeSocketType marble_inputs[]= {
181         COMMON_INPUTS,
182         { SOCK_VALUE, 1, "Size",       0.25f, 0.0f, 0.0f, 0.0f,   0.0001f, 2.0f },
183         { SOCK_VALUE, 1, "Turbulence", 5.0f,  0.0f, 0.0f, 0.0f,   0.0f, 200.0f },
184         { -1, 0, "" }
185 };
186 static void marble_map_inputs(Tex *tex, bNodeStack **in, TexParams *p, short thread)
187 {
188         tex->noisesize = tex_input_value(in[I+0], p, thread);
189         tex->turbul    = tex_input_value(in[I+1], p, thread);
190 }
191 ProcDef(marble)
192
193 /* --- CLOUDS --- */
194 static bNodeSocketType clouds_inputs[]= {
195         COMMON_INPUTS,
196         { SOCK_VALUE, 1, "Size",       0.25f, 0.0f, 0.0f, 0.0f,   0.0001f, 2.0f },
197         { -1, 0, "" }
198 };
199 static void clouds_map_inputs(Tex *tex, bNodeStack **in, TexParams *p, short thread)
200 {
201         tex->noisesize = tex_input_value(in[I+0], p, thread);
202 }
203 ProcDef(clouds)
204
205 /* --- DISTORTED NOISE --- */
206 static bNodeSocketType distnoise_inputs[]= {
207         COMMON_INPUTS,
208         { SOCK_VALUE, 1, "Size",       0.25f, 0.0f, 0.0f, 0.0f,   0.0001f,  2.0f },
209         { SOCK_VALUE, 1, "Distortion", 1.00f, 0.0f, 0.0f, 0.0f,   0.0000f, 10.0f },
210         { -1, 0, "" }
211 };
212 static void distnoise_map_inputs(Tex *tex, bNodeStack **in, TexParams *p, short thread)
213 {
214         tex->noisesize   = tex_input_value(in[I+0], p, thread);
215         tex->dist_amount = tex_input_value(in[I+1], p, thread);
216 }
217 ProcDef(distnoise)
218
219 /* --- WOOD --- */
220 static bNodeSocketType wood_inputs[]= {
221         COMMON_INPUTS,
222         { SOCK_VALUE, 1, "Size",       0.25f, 0.0f, 0.0f, 0.0f,   0.0001f, 2.0f },
223         { SOCK_VALUE, 1, "Turbulence", 5.0f,  0.0f, 0.0f, 0.0f,   0.0f, 200.0f },
224         { -1, 0, "" }
225 };
226 static void wood_map_inputs(Tex *tex, bNodeStack **in, TexParams *p, short thread)
227 {
228         tex->noisesize = tex_input_value(in[I+0], p, thread);
229         tex->turbul    = tex_input_value(in[I+1], p, thread);
230 }
231 ProcDef(wood)
232
233 /* --- MUSGRAVE --- */
234 static bNodeSocketType musgrave_inputs[]= {
235         COMMON_INPUTS,
236         { SOCK_VALUE, 1, "H",          1.0f, 0.0f, 0.0f, 0.0f,   0.0001f, 2.0f },
237         { SOCK_VALUE, 1, "Lacunarity", 2.0f, 0.0f, 0.0f, 0.0f,   0.0f,    6.0f },
238         { SOCK_VALUE, 1, "Octaves",    2.0f, 0.0f, 0.0f, 0.0f,   0.0f,    8.0f },
239         
240         { SOCK_VALUE, 1, "iScale",     1.0f,  0.0f, 0.0f, 0.0f,  0.0f,   10.0f },
241         { SOCK_VALUE, 1, "Size",       0.25f, 0.0f, 0.0f, 0.0f,  0.0001f, 2.0f },
242         { -1, 0, "" }
243 };
244 static void musgrave_map_inputs(Tex *tex, bNodeStack **in, TexParams *p, short thread)
245 {
246         tex->mg_H          = tex_input_value(in[I+0], p, thread);
247         tex->mg_lacunarity = tex_input_value(in[I+1], p, thread);
248         tex->mg_octaves    = tex_input_value(in[I+2], p, thread);
249         tex->ns_outscale   = tex_input_value(in[I+3], p, thread);
250         tex->noisesize     = tex_input_value(in[I+4], p, thread);
251 }
252 ProcDef(musgrave)
253
254 /* --- NOISE --- */
255 static bNodeSocketType noise_inputs[]= {
256         COMMON_INPUTS,
257         { -1, 0, "" }
258 };
259 ProcNoInputs(noise)
260 ProcDef(noise)
261
262 /* --- STUCCI --- */
263 static bNodeSocketType stucci_inputs[]= {
264         COMMON_INPUTS,
265         { SOCK_VALUE, 1, "Size",       0.25f, 0.0f, 0.0f, 0.0f,   0.0001f, 2.0f },
266         { SOCK_VALUE, 1, "Turbulence", 5.0f,  0.0f, 0.0f, 0.0f,   0.0f, 200.0f },
267         { -1, 0, "" }
268 };
269 static void stucci_map_inputs(Tex *tex, bNodeStack **in, TexParams *p, short thread)
270 {
271         tex->noisesize = tex_input_value(in[I+0], p, thread);
272         tex->turbul    = tex_input_value(in[I+1], p, thread);
273 }
274 ProcDef(stucci)
275
276 /* --- */
277
278 static void init(bNode *node)
279 {
280         Tex *tex = MEM_callocN(sizeof(Tex), "Tex");
281         node->storage= tex;
282         
283         default_tex(tex);
284         tex->type = node->type - TEX_NODE_PROC;
285         
286         if(tex->type == TEX_WOOD)
287                 tex->stype = TEX_BANDNOISE;
288         
289 }
290
291 /* Node type definitions */
292 #define TexDef(TEXTYPE, outputs, name, Name) \
293 void register_node_type_tex_proc_##name(ListBase *lb) \
294 { \
295         static bNodeType ntype; \
296         \
297         node_type_base(&ntype, TEX_NODE_PROC+TEXTYPE, Name, NODE_CLASS_TEXTURE, NODE_PREVIEW|NODE_OPTIONS, name##_inputs, outputs); \
298         node_type_size(&ntype, 140, 80, 140); \
299         node_type_init(&ntype, init); \
300         node_type_storage(&ntype, "Tex", node_free_standard_storage, node_copy_standard_storage); \
301         node_type_exec(&ntype, name##_exec); \
302         \
303         nodeRegisterType(lb, &ntype); \
304 }
305         
306 #define C outputs_color_only
307 #define CV outputs_both
308         
309 TexDef(TEX_VORONOI,   CV, voronoi,   "Voronoi"  );
310 TexDef(TEX_BLEND,     C,  blend,     "Blend"    );
311 TexDef(TEX_MAGIC,     C,  magic,     "Magic"    );
312 TexDef(TEX_MARBLE,    CV, marble,    "Marble"   );
313 TexDef(TEX_CLOUDS,    CV, clouds,    "Clouds"   );
314 TexDef(TEX_WOOD,      CV, wood,      "Wood"     );
315 TexDef(TEX_MUSGRAVE,  CV, musgrave,  "Musgrave" );
316 TexDef(TEX_NOISE,     C,  noise,     "Noise"    );
317 TexDef(TEX_STUCCI,    CV, stucci,    "Stucci"   );
318 TexDef(TEX_DISTNOISE, CV, distnoise, "Distorted Noise" );