Merge branch 'blender2.7'
[blender.git] / source / blender / blenkernel / BKE_node.h
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) 2005 Blender Foundation.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): Bob Holcomb.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 #ifndef __BKE_NODE_H__
29 #define __BKE_NODE_H__
30
31 /** \file BKE_node.h
32  *  \ingroup bke
33  */
34
35 #include "BLI_compiler_compat.h"
36 #include "BLI_ghash.h"
37
38 #include "DNA_listBase.h"
39
40 /* for FOREACH_NODETREE_BEGIN */
41 #include "DNA_lamp_types.h"
42 #include "DNA_material_types.h"
43 #include "DNA_node_types.h"
44 #include "DNA_scene_types.h"
45 #include "DNA_texture_types.h"
46 #include "DNA_world_types.h"
47 #include "DNA_linestyle_types.h"
48
49 #include "RNA_types.h"
50
51 /* not very important, but the stack solver likes to know a maximum */
52 #define MAX_SOCKET      512
53
54 struct bContext;
55 struct bNode;
56 struct bNodeLink;
57 struct bNodeSocket;
58 struct bNodeStack;
59 struct bNodeTree;
60 struct bNodeTreeType;
61 struct bNodeTreeExec;
62 struct bNodeExecContext;
63 struct bNodeExecData;
64 struct GPUMaterial;
65 struct GPUNodeStack;
66 struct ID;
67 struct ImBuf;
68 struct ImageFormatData;
69 struct ListBase;
70 struct Main;
71 struct uiLayout;
72 struct MTex;
73 struct PointerRNA;
74 struct RenderData;
75 struct Scene;
76 struct Tex;
77 struct ViewRender;
78 struct SpaceNode;
79 struct ARegion;
80 struct ColorManagedViewSettings;
81 struct ColorManagedDisplaySettings;
82 struct bNodeInstanceHash;
83
84 /* -------------------------------------------------------------------- */
85 /** \name Node Type Definitions
86  * \{ */
87
88 /** Compact definition of a node socket.
89  * Can be used to quickly define a list of static sockets for a node,
90  * which are added to each new node of that type.
91  *
92  * \deprecated This struct is used by C nodes to define templates as simple
93  * static struct lists. These are converted to the new template collections
94  * in RNA types automatically.
95  */
96 typedef struct bNodeSocketTemplate {
97         int type, limit;
98         char name[64];  /* MAX_NAME */
99         float val1, val2, val3, val4;   /* default alloc value for inputs */
100         float min, max;
101         int subtype;  /* would use PropertySubType but this is a bad level include to use RNA */
102         int flag;
103
104         /* after this line is used internal only */
105         struct bNodeSocket *sock;               /* used to hold verified socket */
106         char identifier[64];                    /* generated from name */
107 } bNodeSocketTemplate;
108
109 /** Defines a socket type.
110  * Defines the appearance and behavior of a socket in the UI.
111  */
112 typedef struct bNodeSocketType {
113         char idname[64];                                /* identifier name */
114
115         void (*draw)(struct bContext *C, struct uiLayout *layout, struct PointerRNA *ptr, struct PointerRNA *node_ptr, const char *text);
116         void (*draw_color)(struct bContext *C, struct PointerRNA *ptr, struct PointerRNA *node_ptr, float *r_color);
117
118         void (*interface_draw)(struct bContext *C, struct uiLayout *layout, struct PointerRNA *ptr);
119         void (*interface_draw_color)(struct bContext *C, struct PointerRNA *ptr, float *r_color);
120         void (*interface_register_properties)(struct bNodeTree *ntree, struct bNodeSocket *stemp, struct StructRNA *data_srna);
121         void (*interface_init_socket)(struct bNodeTree *ntree, struct bNodeSocket *stemp, struct bNode *node, struct bNodeSocket *sock, const char *data_path);
122         void (*interface_verify_socket)(struct bNodeTree *ntree, struct bNodeSocket *stemp, struct bNode *node, struct bNodeSocket *sock, const char *data_path);
123         void (*interface_from_socket)(struct bNodeTree *ntree, struct bNodeSocket *stemp, struct bNode *node, struct bNodeSocket *sock);
124
125         /* RNA integration */
126         ExtensionRNA ext_socket;
127         ExtensionRNA ext_interface;
128
129         /* for standard socket types in C */
130         int type, subtype;
131 } bNodeSocketType;
132
133 typedef void *(*NodeInitExecFunction)(struct bNodeExecContext *context, struct bNode *node, bNodeInstanceKey key);
134 typedef void (*NodeFreeExecFunction)(void *nodedata);
135 typedef void (*NodeExecFunction)(void *data, int thread, struct bNode *, struct bNodeExecData *execdata, struct bNodeStack **in, struct bNodeStack **out);
136 typedef int (*NodeGPUExecFunction)(struct GPUMaterial *mat, struct bNode *node, struct bNodeExecData *execdata, struct GPUNodeStack *in, struct GPUNodeStack *out);
137
138 /** Defines a node type.
139  * Initial attributes and constants for a node as well as callback functions
140  * implementing the node behavior.
141  */
142 typedef struct bNodeType {
143         void *next, *prev;
144         short needs_free;               /* set for allocated types that need to be freed */
145
146         char idname[64];                                /* identifier name */
147         int type;
148
149         char ui_name[64];       /* MAX_NAME */
150         char ui_description[256];
151         int ui_icon;
152
153         float width, minwidth, maxwidth;
154         float height, minheight, maxheight;
155         short nclass, flag;
156
157         /* templates for static sockets */
158         bNodeSocketTemplate *inputs, *outputs;
159
160         char storagename[64];                   /* struct name for DNA */
161
162         /* Main draw function for the node */
163         void (*draw_nodetype)(const struct bContext *C, struct ARegion *ar, struct SpaceNode *snode,
164                          struct bNodeTree *ntree, struct bNode *node, bNodeInstanceKey key);
165         /* Updates the node geometry attributes according to internal state before actual drawing */
166         void (*draw_nodetype_prepare)(const struct bContext *C, struct bNodeTree *ntree, struct bNode *node);
167
168         /* Draw the option buttons on the node */
169         void (*draw_buttons)(struct uiLayout *, struct bContext *C, struct PointerRNA *ptr);
170         /* Additional parameters in the side panel */
171         void (*draw_buttons_ex)(struct uiLayout *, struct bContext *C, struct PointerRNA *ptr);
172
173         /* Additional drawing on backdrop */
174         void (*draw_backdrop)(struct SpaceNode *snode, struct ImBuf *backdrop, struct bNode *node, int x, int y);
175
176         /**
177          * Optional custom label function for the node header.
178          * \note Used as a fallback when #bNode.label isn't set.
179          */
180         void (*labelfunc)(struct bNodeTree *ntree, struct bNode *node, char *label, int maxlen);
181         /// Optional custom resize handle polling.
182         int (*resize_area_func)(struct bNode *node, int x, int y);
183         /// Optional selection area polling.
184         int (*select_area_func)(struct bNode *node, int x, int y);
185         /// Optional tweak area polling (for grabbing).
186         int (*tweak_area_func)(struct bNode *node, int x, int y);
187
188         /// Called when the node is updated in the editor.
189         void (*updatefunc)(struct bNodeTree *ntree, struct bNode *node);
190         /// Check and update if internal ID data has changed.
191         void (*verifyfunc)(struct bNodeTree *ntree, struct bNode *node, struct ID *id);
192
193         /// Initialize a new node instance of this type after creation.
194         void (*initfunc)(struct bNodeTree *ntree, struct bNode *node);
195         /// Free the node instance.
196         void (*freefunc)(struct bNode *node);
197         /// Make a copy of the node instance.
198         void (*copyfunc)(struct bNodeTree *dest_ntree, struct bNode *dest_node, struct bNode *src_node);
199
200         /* Registerable API callback versions, called in addition to C callbacks */
201         void (*initfunc_api)(const struct bContext *C, struct PointerRNA *ptr);
202         void (*freefunc_api)(struct PointerRNA *ptr);
203         void (*copyfunc_api)(struct PointerRNA *ptr, struct bNode *src_node);
204
205         /* can this node type be added to a node tree */
206         bool (*poll)(struct bNodeType *ntype, struct bNodeTree *nodetree);
207         /* can this node be added to a node tree */
208         bool (*poll_instance)(struct bNode *node, struct bNodeTree *nodetree);
209
210         /* optional handling of link insertion */
211         void (*insert_link)(struct bNodeTree *ntree, struct bNode *node, struct bNodeLink *link);
212         /* Update the internal links list, for muting and disconnect operators. */
213         void (*update_internal_links)(struct bNodeTree *, struct bNode *node);
214
215         /* **** execution callbacks **** */
216         NodeInitExecFunction initexecfunc;
217         NodeFreeExecFunction freeexecfunc;
218         NodeExecFunction execfunc;
219         /* gpu */
220         NodeGPUExecFunction gpufunc;
221
222         /* RNA integration */
223         ExtensionRNA ext;
224 } bNodeType;
225
226 /* nodetype->nclass, for add-menu and themes */
227 #define NODE_CLASS_INPUT                        0
228 #define NODE_CLASS_OUTPUT                       1
229 #define NODE_CLASS_OP_COLOR                     3
230 #define NODE_CLASS_OP_VECTOR            4
231 #define NODE_CLASS_OP_FILTER            5
232 #define NODE_CLASS_GROUP                        6
233 // #define NODE_CLASS_FILE                              7
234 #define NODE_CLASS_CONVERTOR            8
235 #define NODE_CLASS_MATTE                        9
236 #define NODE_CLASS_DISTORT                      10
237 // #define NODE_CLASS_OP_DYNAMIC                11 /* deprecated */
238 #define NODE_CLASS_PATTERN                      12
239 #define NODE_CLASS_TEXTURE                      13
240 // #define NODE_CLASS_EXECUTION         14
241 // #define NODE_CLASS_GETDATA                   15
242 // #define NODE_CLASS_SETDATA                   16
243 // #define NODE_CLASS_MATH                              17
244 // #define NODE_CLASS_MATH_VECTOR               18
245 // #define NODE_CLASS_MATH_ROTATION     19
246 // #define NODE_CLASS_PARTICLES         25
247 // #define NODE_CLASS_TRANSFORM         30
248 // #define NODE_CLASS_COMBINE                   31
249 #define NODE_CLASS_SCRIPT                       32
250 #define NODE_CLASS_INTERFACE            33
251 #define NODE_CLASS_SHADER                       40
252 #define NODE_CLASS_LAYOUT                       100
253
254 /* node resize directions */
255 #define NODE_RESIZE_TOP         1
256 #define NODE_RESIZE_BOTTOM      2
257 #define NODE_RESIZE_RIGHT       4
258 #define NODE_RESIZE_LEFT        8
259
260 typedef enum eNodeSizePreset {
261         NODE_SIZE_DEFAULT,
262         NODE_SIZE_SMALL,
263         NODE_SIZE_MIDDLE,
264         NODE_SIZE_LARGE
265 } eNodeSizePreset;
266
267 struct bNodeTreeExec;
268
269 typedef void (*bNodeClassCallback)(void *calldata, int nclass, const char *name);
270 typedef struct bNodeTreeType {
271         int type;                                               /* type identifier */
272         char idname[64];                                /* identifier name */
273
274         char ui_name[64];
275         char ui_description[256];
276         int ui_icon;
277
278         /* callbacks */
279         void (*free_cache)(struct bNodeTree *ntree);
280         void (*free_node_cache)(struct bNodeTree *ntree, struct bNode *node);
281         void (*foreach_nodeclass)(struct Scene *scene, void *calldata, bNodeClassCallback func);        /* iteration over all node classes */
282         /* Check visibility in the node editor */
283         bool (*poll)(const struct bContext *C, struct bNodeTreeType *ntreetype);
284         /* Select a node tree from the context */
285         void (*get_from_context)(const struct bContext *C, struct bNodeTreeType *ntreetype,
286                                  struct bNodeTree **r_ntree, struct ID **r_id, struct ID **r_from);
287
288         /* calls allowing threaded composite */
289         void (*localize)(struct bNodeTree *localtree, struct bNodeTree *ntree);
290         void (*local_sync)(struct bNodeTree *localtree, struct bNodeTree *ntree);
291         void (*local_merge)(struct Main *bmain, struct bNodeTree *localtree, struct bNodeTree *ntree);
292
293         /* Tree update. Overrides nodetype->updatetreefunc! */
294         void (*update)(struct bNodeTree *ntree);
295
296         bool (*validate_link)(struct bNodeTree *ntree, struct bNodeLink *link);
297
298         void (*node_add_init)(struct bNodeTree *ntree, struct bNode *bnode);
299
300         /* RNA integration */
301         ExtensionRNA ext;
302 } bNodeTreeType;
303
304 /** \} */
305
306 /* -------------------------------------------------------------------- */
307 /** \name Generic API, Trees
308  * \{ */
309
310 struct bNodeTreeType *ntreeTypeFind(const char *idname);
311 void ntreeTypeAdd(struct bNodeTreeType *nt);
312 void ntreeTypeFreeLink(const struct bNodeTreeType *nt);
313 bool ntreeIsRegistered(struct bNodeTree *ntree);
314 struct GHashIterator *ntreeTypeGetIterator(void);
315
316 /* helper macros for iterating over tree types */
317 #define NODE_TREE_TYPES_BEGIN(ntype) \
318 { \
319         GHashIterator *__node_tree_type_iter__ = ntreeTypeGetIterator(); \
320         for (; !BLI_ghashIterator_done(__node_tree_type_iter__); BLI_ghashIterator_step(__node_tree_type_iter__)) { \
321                 bNodeTreeType *ntype = BLI_ghashIterator_getValue(__node_tree_type_iter__);
322
323 #define NODE_TREE_TYPES_END \
324         } \
325         BLI_ghashIterator_free(__node_tree_type_iter__); \
326 } (void)0
327
328 void ntreeSetTypes(const struct bContext *C, struct bNodeTree *ntree);
329
330 void ntreeInitDefault(struct bNodeTree *ntree);
331 struct bNodeTree *ntreeAddTree(struct Main *bmain, const char *name, const char *idname);
332
333 /* copy/free funcs, need to manage ID users */
334 void              ntreeFreeTree(struct bNodeTree *ntree);
335 /* Free tree which is owned byt another datablock. */
336 void              ntreeFreeNestedTree(struct bNodeTree *ntree);
337 void BKE_node_tree_copy_data(struct Main *bmain, struct bNodeTree *ntree_dst, const struct bNodeTree *ntree_src, const int flag);
338 struct bNodeTree *ntreeCopyTree_ex(const struct bNodeTree *ntree, struct Main *bmain, const bool do_id_user);
339 struct bNodeTree *ntreeCopyTree(struct Main *bmain, const struct bNodeTree *ntree);
340 /* node->id user count */
341 void              ntreeUserIncrefID(struct bNodeTree *ntree);
342 void              ntreeUserDecrefID(struct bNodeTree *ntree);
343
344
345 struct bNodeTree *ntreeFromID(const struct ID *id);
346
347 void              ntreeMakeLocal(struct Main *bmain, struct bNodeTree *ntree, bool id_in_mainlist, const bool lib_local);
348 void              ntreeFreeLocalTree(struct bNodeTree *ntree);
349 struct bNode     *ntreeFindType(const struct bNodeTree *ntree, int type);
350 bool              ntreeHasType(const struct bNodeTree *ntree, int type);
351 bool              ntreeHasTree(const struct bNodeTree *ntree, const struct bNodeTree *lookup);
352 void              ntreeUpdateTree(struct Main *main, struct bNodeTree *ntree);
353 /* XXX Currently each tree update call does call to ntreeVerifyNodes too.
354  * Some day this should be replaced by a decent depsgraph automatism!
355  */
356 void              ntreeVerifyNodes(struct Main *main, struct ID *id);
357
358 void              ntreeGetDependencyList(struct bNodeTree *ntree, struct bNode ***deplist, int *totnodes);
359
360 /* XXX old trees handle output flags automatically based on special output node types and last active selection.
361  * new tree types have a per-output socket flag to indicate the final output to use explicitly.
362  */
363 void            ntreeSetOutput(struct bNodeTree *ntree);
364
365 void            ntreeFreeCache(struct bNodeTree *ntree);
366
367 int             ntreeNodeExists(struct bNodeTree *ntree, struct bNode *testnode);
368 int             ntreeOutputExists(struct bNode *node, struct bNodeSocket *testsock);
369 void            ntreeNodeFlagSet(const bNodeTree *ntree, const int flag, const bool enable);
370 struct bNodeTree *ntreeLocalize(struct bNodeTree *ntree);
371 void            ntreeLocalSync(struct bNodeTree *localtree, struct bNodeTree *ntree);
372 void            ntreeLocalMerge(struct Main *bmain, struct bNodeTree *localtree, struct bNodeTree *ntree);
373
374 /** \} */
375
376
377 /* -------------------------------------------------------------------- */
378 /** \name Node Tree Interface
379  * \{ */
380 struct bNodeSocket *ntreeFindSocketInterface(struct bNodeTree *ntree, int in_out, const char *identifier);
381 struct bNodeSocket *ntreeAddSocketInterface(struct bNodeTree *ntree, int in_out, const char *idname, const char *name);
382 struct bNodeSocket *ntreeInsertSocketInterface(struct bNodeTree *ntree, int in_out, const char *idname,
383                                                struct bNodeSocket *next_sock, const char *name);
384 struct bNodeSocket *ntreeAddSocketInterfaceFromSocket(struct bNodeTree *ntree, struct bNode *from_node, struct bNodeSocket *from_sock);
385 struct bNodeSocket *ntreeInsertSocketInterfaceFromSocket(struct bNodeTree *ntree, struct bNodeSocket *next_sock,
386                                                          struct bNode *from_node, struct bNodeSocket *from_sock);
387 void            ntreeRemoveSocketInterface(struct bNodeTree *ntree, struct bNodeSocket *sock);
388
389 struct StructRNA *ntreeInterfaceTypeGet(struct bNodeTree *ntree, int create);
390 void ntreeInterfaceTypeFree(struct bNodeTree *ntree);
391 void ntreeInterfaceTypeUpdate(struct bNodeTree *ntree);
392
393 /** \} */
394
395
396 /* -------------------------------------------------------------------- */
397 /** \name Generic API, Nodes
398  * \{ */
399
400 struct bNodeType *nodeTypeFind(const char *idname);
401 void                    nodeRegisterType(struct bNodeType *ntype);
402 void                    nodeUnregisterType(struct bNodeType *ntype);
403 bool                    nodeIsRegistered(struct bNode *node);
404 struct GHashIterator *nodeTypeGetIterator(void);
405
406 /* helper macros for iterating over node types */
407 #define NODE_TYPES_BEGIN(ntype) \
408 { \
409         GHashIterator *__node_type_iter__ = nodeTypeGetIterator(); \
410         for (; !BLI_ghashIterator_done(__node_type_iter__); BLI_ghashIterator_step(__node_type_iter__)) { \
411                 bNodeType *ntype = BLI_ghashIterator_getValue(__node_type_iter__);
412
413 #define NODE_TYPES_END \
414         } \
415         BLI_ghashIterator_free(__node_type_iter__); \
416 } ((void)0)
417
418 struct bNodeSocketType *nodeSocketTypeFind(const char *idname);
419 void                    nodeRegisterSocketType(struct bNodeSocketType *stype);
420 void                    nodeUnregisterSocketType(struct bNodeSocketType *stype);
421 bool                    nodeSocketIsRegistered(struct bNodeSocket *sock);
422 struct GHashIterator *nodeSocketTypeGetIterator(void);
423 const char *nodeStaticSocketType(int type, int subtype);
424 const char *nodeStaticSocketInterfaceType(int type, int subtype);
425
426 /* helper macros for iterating over node types */
427 #define NODE_SOCKET_TYPES_BEGIN(stype) \
428 { \
429         GHashIterator *__node_socket_type_iter__ = nodeSocketTypeGetIterator(); \
430         for (; !BLI_ghashIterator_done(__node_socket_type_iter__); BLI_ghashIterator_step(__node_socket_type_iter__)) { \
431                 bNodeSocketType *stype = BLI_ghashIterator_getValue(__node_socket_type_iter__);
432
433 #define NODE_SOCKET_TYPES_END \
434         } \
435         BLI_ghashIterator_free(__node_socket_type_iter__); \
436 }
437
438 struct bNodeSocket *nodeFindSocket(struct bNode *node, int in_out, const char *identifier);
439 struct bNodeSocket *nodeAddSocket(struct bNodeTree *ntree, struct bNode *node, int in_out, const char *idname,
440                                   const char *identifier, const char *name);
441 struct bNodeSocket *nodeInsertSocket(struct bNodeTree *ntree, struct bNode *node, int in_out, const char *idname,
442                                      struct bNodeSocket *next_sock, const char *identifier, const char *name);
443 struct bNodeSocket *nodeAddStaticSocket(struct bNodeTree *ntree, struct bNode *node, int in_out, int type, int subtype,
444                                         const char *identifier, const char *name);
445 struct bNodeSocket *nodeInsertStaticSocket(struct bNodeTree *ntree, struct bNode *node, int in_out, int type, int subtype,
446                                            struct bNodeSocket *next_sock, const char *identifier, const char *name);
447 void nodeRemoveSocket(struct bNodeTree *ntree, struct bNode *node, struct bNodeSocket *sock);
448 void nodeRemoveAllSockets(struct bNodeTree *ntree, struct bNode *node);
449 void nodeModifySocketType(struct bNodeTree *ntree, struct bNode *node, struct bNodeSocket *sock, int type, int subtype);
450
451 struct bNode    *nodeAddNode(const struct bContext *C, struct bNodeTree *ntree, const char *idname);
452 struct bNode    *nodeAddStaticNode(const struct bContext *C, struct bNodeTree *ntree, int type);
453 void            nodeUnlinkNode(struct bNodeTree *ntree, struct bNode *node);
454 void            nodeUniqueName(struct bNodeTree *ntree, struct bNode *node);
455
456 /* Frees the node itself, without affect to anything else. */
457 void            nodeFreeNode(struct bNodeTree *ntree, struct bNode *node);
458 /* Will additionally cleanup things like f-curves which uses this node. */
459 void            nodeDeleteNode(struct Main *bmain, struct bNodeTree *ntree, struct bNode *node);
460
461 struct bNode    *BKE_node_copy_ex(struct bNodeTree *ntree, struct bNode *node_src, const int flag);
462 struct bNode    *nodeCopyNode(struct bNodeTree *ntree, struct bNode *node);
463
464 struct bNodeLink *nodeAddLink(struct bNodeTree *ntree, struct bNode *fromnode, struct bNodeSocket *fromsock, struct bNode *tonode, struct bNodeSocket *tosock);
465 void            nodeRemLink(struct bNodeTree *ntree, struct bNodeLink *link);
466 void            nodeRemSocketLinks(struct bNodeTree *ntree, struct bNodeSocket *sock);
467 bool            nodeLinkIsHidden(struct bNodeLink *link);
468 void            nodeInternalRelink(struct bNodeTree *ntree, struct bNode *node);
469
470 void            nodeToView(struct bNode *node, float x, float y, float *rx, float *ry);
471 void            nodeFromView(struct bNode *node, float x, float y, float *rx, float *ry);
472 bool            nodeAttachNodeCheck(struct bNode *node, struct bNode *parent);
473 void            nodeAttachNode(struct bNode *node, struct bNode *parent);
474 void            nodeDetachNode(struct bNode *node);
475
476 void            nodePositionRelative(struct bNode *from_node, struct bNode *to_node,
477                                      struct bNodeSocket *from_sock, struct bNodeSocket *to_sock);
478 void            nodePositionPropagate(struct bNode *node);
479
480 struct bNode   *nodeFindNodebyName(struct bNodeTree *ntree, const char *name);
481 int             nodeFindNode(struct bNodeTree *ntree, struct bNodeSocket *sock, struct bNode **nodep, int *sockindex);
482 struct bNode   *nodeFindRootParent(bNode *node);
483
484 bool            nodeIsChildOf(const bNode *parent, const bNode *child);
485
486 void nodeChainIter(
487         const bNodeTree *ntree, const bNode *node_start,
488         bool (*callback)(bNode *, bNode *, void *, const bool), void *userdata,
489         const bool reversed);
490 void nodeParentsIter(bNode *node, bool (*callback)(bNode *, void *), void *userdata);
491
492 struct bNodeLink *nodeFindLink(struct bNodeTree *ntree, struct bNodeSocket *from, struct bNodeSocket *to);
493 int             nodeCountSocketLinks(struct bNodeTree *ntree, struct bNodeSocket *sock);
494
495 void            nodeSetSelected(struct bNode *node, bool select);
496 void            nodeSetActive(struct bNodeTree *ntree, struct bNode *node);
497 struct bNode   *nodeGetActive(struct bNodeTree *ntree);
498 struct bNode   *nodeGetActiveID(struct bNodeTree *ntree, short idtype);
499 bool            nodeSetActiveID(struct bNodeTree *ntree, short idtype, struct ID *id);
500 void            nodeClearActive(struct bNodeTree *ntree);
501 void            nodeClearActiveID(struct bNodeTree *ntree, short idtype);
502 struct bNode   *nodeGetActiveTexture(struct bNodeTree *ntree);
503
504 void            nodeUpdate(struct bNodeTree *ntree, struct bNode *node);
505 bool            nodeUpdateID(struct bNodeTree *ntree, struct ID *id);
506 void            nodeUpdateInternalLinks(struct bNodeTree *ntree, struct bNode *node);
507
508 int             nodeSocketIsHidden(struct bNodeSocket *sock);
509 void            ntreeTagUsedSockets(struct bNodeTree *ntree);
510
511 /* Node Clipboard */
512 void                   BKE_node_clipboard_init(struct bNodeTree *ntree);
513 void                   BKE_node_clipboard_clear(void);
514 bool                   BKE_node_clipboard_validate(void);
515 void                   BKE_node_clipboard_add_node(struct bNode *node);
516 void                   BKE_node_clipboard_add_link(struct bNodeLink *link);
517 const struct ListBase *BKE_node_clipboard_get_nodes(void);
518 const struct ListBase *BKE_node_clipboard_get_links(void);
519 int                    BKE_node_clipboard_get_type(void);
520
521 /* Node Instance Hash */
522 typedef struct bNodeInstanceHash {
523         GHash *ghash;   /* XXX should be made a direct member, GHash allocation needs to support it */
524 } bNodeInstanceHash;
525
526 typedef void (*bNodeInstanceValueFP)(void *value);
527
528 extern const bNodeInstanceKey NODE_INSTANCE_KEY_BASE;
529 extern const bNodeInstanceKey NODE_INSTANCE_KEY_NONE;
530
531 bNodeInstanceKey       BKE_node_instance_key(bNodeInstanceKey parent_key, struct bNodeTree *ntree, struct bNode *node);
532
533 bNodeInstanceHash     *BKE_node_instance_hash_new(const char *info);
534 void                   BKE_node_instance_hash_free(bNodeInstanceHash *hash, bNodeInstanceValueFP valfreefp);
535 void                   BKE_node_instance_hash_insert(bNodeInstanceHash *hash, bNodeInstanceKey key, void *value);
536 void                  *BKE_node_instance_hash_lookup(bNodeInstanceHash *hash, bNodeInstanceKey key);
537 int                    BKE_node_instance_hash_remove(bNodeInstanceHash *hash, bNodeInstanceKey key, bNodeInstanceValueFP valfreefp);
538 void                   BKE_node_instance_hash_clear(bNodeInstanceHash *hash, bNodeInstanceValueFP valfreefp);
539 void                  *BKE_node_instance_hash_pop(bNodeInstanceHash *hash, bNodeInstanceKey key);
540 int                    BKE_node_instance_hash_haskey(bNodeInstanceHash *hash, bNodeInstanceKey key);
541 int                    BKE_node_instance_hash_size(bNodeInstanceHash *hash);
542
543 void                   BKE_node_instance_hash_clear_tags(bNodeInstanceHash *hash);
544 void                   BKE_node_instance_hash_tag(bNodeInstanceHash *hash, void *value);
545 bool                   BKE_node_instance_hash_tag_key(bNodeInstanceHash *hash, bNodeInstanceKey key);
546 void                   BKE_node_instance_hash_remove_untagged(bNodeInstanceHash *hash, bNodeInstanceValueFP valfreefp);
547
548 typedef GHashIterator bNodeInstanceHashIterator;
549
550 BLI_INLINE bNodeInstanceHashIterator *BKE_node_instance_hash_iterator_new(bNodeInstanceHash *hash) { return BLI_ghashIterator_new(hash->ghash); }
551 BLI_INLINE void                       BKE_node_instance_hash_iterator_init(bNodeInstanceHashIterator *iter, bNodeInstanceHash *hash) { BLI_ghashIterator_init(iter, hash->ghash); }
552 BLI_INLINE void                       BKE_node_instance_hash_iterator_free(bNodeInstanceHashIterator *iter) { BLI_ghashIterator_free(iter); }
553 BLI_INLINE bNodeInstanceKey           BKE_node_instance_hash_iterator_get_key(bNodeInstanceHashIterator *iter) { return *(bNodeInstanceKey *)BLI_ghashIterator_getKey(iter); }
554 BLI_INLINE void                      *BKE_node_instance_hash_iterator_get_value(bNodeInstanceHashIterator *iter) { return BLI_ghashIterator_getValue(iter); }
555 BLI_INLINE void                       BKE_node_instance_hash_iterator_step(bNodeInstanceHashIterator *iter) { BLI_ghashIterator_step(iter); }
556 BLI_INLINE bool                       BKE_node_instance_hash_iterator_done(bNodeInstanceHashIterator *iter) { return BLI_ghashIterator_done(iter); }
557
558 #define NODE_INSTANCE_HASH_ITER(iter_, hash_) \
559         for (BKE_node_instance_hash_iterator_init(&iter_, hash_); \
560              BKE_node_instance_hash_iterator_done(&iter_) == false; \
561              BKE_node_instance_hash_iterator_step(&iter_))
562
563
564 /* Node Previews */
565
566 int             BKE_node_preview_used(struct bNode *node);
567 bNodePreview   *BKE_node_preview_verify(struct bNodeInstanceHash *previews, bNodeInstanceKey key, int xsize, int ysize, bool create);
568 bNodePreview   *BKE_node_preview_copy(struct bNodePreview *preview);
569 void            BKE_node_preview_free(struct bNodePreview *preview);
570 void            BKE_node_preview_init_tree(struct bNodeTree *ntree, int xsize, int ysize, int create_previews);
571 void            BKE_node_preview_free_tree(struct bNodeTree *ntree);
572 void            BKE_node_preview_remove_unused(struct bNodeTree *ntree);
573 void            BKE_node_preview_clear(struct bNodePreview *preview);
574 void            BKE_node_preview_clear_tree(struct bNodeTree *ntree);
575
576 void            BKE_node_preview_sync_tree(struct bNodeTree *to_ntree, struct bNodeTree *from_ntree);
577 void            BKE_node_preview_merge_tree(struct bNodeTree *to_ntree, struct bNodeTree *from_ntree, bool remove_old);
578
579 void            BKE_node_preview_set_pixel(struct bNodePreview *preview, const float col[4], int x, int y, bool do_manage);
580
581 /** \} */
582
583 /* -------------------------------------------------------------------- */
584 /** \name Node Type Access
585  * \{ */
586
587 void            nodeLabel(struct bNodeTree *ntree, struct bNode *node, char *label, int maxlen);
588
589 int                             nodeGroupPoll(struct bNodeTree *nodetree, struct bNodeTree *grouptree);
590
591 /* Init a new node type struct with default values and callbacks */
592 void            node_type_base(struct bNodeType *ntype, int type, const char *name, short nclass, short flag);
593 void            node_type_base_custom(struct bNodeType *ntype, const char *idname, const char *name, short nclass, short flag);
594 void            node_type_socket_templates(struct bNodeType *ntype, struct bNodeSocketTemplate *inputs, struct bNodeSocketTemplate *outputs);
595 void            node_type_size(struct bNodeType *ntype, int width, int minwidth, int maxwidth);
596 void            node_type_size_preset(struct bNodeType *ntype, eNodeSizePreset size);
597 void            node_type_init(struct bNodeType *ntype, void (*initfunc)(struct bNodeTree *ntree, struct bNode *node));
598 void            node_type_storage(struct bNodeType *ntype,
599                                   const char *storagename,
600                                   void (*freefunc)(struct bNode *node),
601                                   void (*copyfunc)(struct bNodeTree *dest_ntree, struct bNode *dest_node, struct bNode *src_node));
602 void            node_type_label(struct bNodeType *ntype, void (*labelfunc)(struct bNodeTree *ntree, struct bNode *, char *label, int maxlen));
603 void            node_type_update(struct bNodeType *ntype,
604                                  void (*updatefunc)(struct bNodeTree *ntree, struct bNode *node),
605                                  void (*verifyfunc)(struct bNodeTree *ntree, struct bNode *node, struct ID *id));
606
607 void            node_type_exec(struct bNodeType *ntype, NodeInitExecFunction initexecfunc, NodeFreeExecFunction freeexecfunc, NodeExecFunction execfunc);
608 void            node_type_gpu(struct bNodeType *ntype, NodeGPUExecFunction gpufunc);
609 void            node_type_internal_links(struct bNodeType *ntype, void (*update_internal_links)(struct bNodeTree *, struct bNode *));
610
611 /** \} */
612
613 /* -------------------------------------------------------------------- */
614 /** \name Node Generic Functions
615  * \{ */
616
617 bool BKE_node_is_connected_to_output(struct bNodeTree *ntree, struct bNode *node);
618
619 /* ************** COMMON NODES *************** */
620
621 #define NODE_UNDEFINED  -2              /* node type is not registered */
622 #define NODE_CUSTOM             -1              /* for dynamically registered custom types */
623 #define NODE_GROUP              2
624 // #define NODE_FORLOOP 3               /* deprecated */
625 // #define NODE_WHILELOOP       4       /* deprecated */
626 #define NODE_FRAME              5
627 #define NODE_REROUTE    6
628 #define NODE_GROUP_INPUT        7
629 #define NODE_GROUP_OUTPUT       8
630
631 void BKE_node_tree_unlink_id(ID *id, struct bNodeTree *ntree);
632
633 /** \} */
634
635 /* -------------------------------------------------------------------- */
636 /** \name Node Tree Iterator
637  *
638  * Utility macro for visiting every node tree in the library data, including local bNodeTree blocks in other IDs.
639  * This avoids the need for callback functions and allows executing code in a single inner code block.
640  *
641  * Variables:
642  *
643  *   nodetree:  The actual bNodeTree data block.
644  *              Check nodetree->idname or nodetree->typeinfo to use only specific types.
645  *
646  *   id:        The owner of the bNodeTree data block.
647  *              Same as nodetree if it's a linkable node tree from the library.
648  *
649  * Examples:
650  *
651  * \code{.c}
652  * FOREACH_NODETREE_BEGIN(bmain, nodetree, id) {
653  *     if (id == nodetree)
654  *         printf("This is a linkable node tree");
655  * } FOREACH_NODETREE_END;
656  *
657  * FOREACH_NODETREE_BEGIN(bmain, nodetree, id) {
658  *     if (nodetree->idname == "ShaderNodeTree")
659  *         printf("This is a shader node tree);
660  *     if (GS(id) == ID_MA)
661  *         printf(" and it's owned by a material");
662  * } FOREACH_NODETREE_END;
663  * \endcode
664  *
665  * \{
666  */
667
668 /* should be an opaque type, only for internal use by BKE_node_tree_iter_*** */
669 struct NodeTreeIterStore {
670         bNodeTree *ngroup;
671         Scene *scene;
672         Material *mat;
673         Tex *tex;
674         Lamp *lamp;
675         World *world;
676         FreestyleLineStyle *linestyle;
677 };
678
679 void BKE_node_tree_iter_init(struct NodeTreeIterStore *ntreeiter, struct Main *bmain);
680 bool BKE_node_tree_iter_step(struct NodeTreeIterStore *ntreeiter,
681                              struct bNodeTree **r_nodetree, struct ID **r_id);
682
683 #define FOREACH_NODETREE_BEGIN(bmain, _nodetree, _id) \
684 { \
685         struct NodeTreeIterStore _nstore; \
686         bNodeTree *_nodetree; \
687         ID *_id; \
688         /* avoid compiler warning about unused variables */ \
689         BKE_node_tree_iter_init(&_nstore, bmain); \
690         while (BKE_node_tree_iter_step(&_nstore, &_nodetree, &_id) == true) { \
691                 if (_nodetree) {
692
693 #define FOREACH_NODETREE_END \
694                 } \
695         } \
696 } ((void)0)
697 /** \} */
698
699
700 /* -------------------------------------------------------------------- */
701 /** \name Node Tree
702  */
703
704 void BKE_nodetree_remove_layer_n(struct bNodeTree *ntree, struct Scene *scene, const int layer_index);
705
706 /* -------------------------------------------------------------------- */
707 /** \name Shader Nodes
708  * \{ */
709
710 /* note: types are needed to restore callbacks, don't change values */
711 /* range 1 - 100 is reserved for common nodes */
712 /* using toolbox, we add node groups by assuming the values below don't exceed NODE_GROUP_MENU for now */
713
714 //#define SH_NODE_OUTPUT                1
715
716 //#define SH_NODE_MATERIAL      100
717 #define SH_NODE_RGB                     101
718 #define SH_NODE_VALUE           102
719 #define SH_NODE_MIX_RGB         103
720 #define SH_NODE_VALTORGB        104
721 #define SH_NODE_RGBTOBW         105
722 #define SH_NODE_SHADERTORGB     106
723 //#define SH_NODE_TEXTURE               106
724 #define SH_NODE_NORMAL          107
725 //#define SH_NODE_GEOMETRY      108
726 #define SH_NODE_MAPPING         109
727 #define SH_NODE_CURVE_VEC       110
728 #define SH_NODE_CURVE_RGB       111
729 #define SH_NODE_CAMERA          114
730 #define SH_NODE_MATH            115
731 #define SH_NODE_VECT_MATH       116
732 #define SH_NODE_SQUEEZE         117
733 //#define SH_NODE_MATERIAL_EXT  118
734 #define SH_NODE_INVERT          119
735 #define SH_NODE_SEPRGB          120
736 #define SH_NODE_COMBRGB         121
737 #define SH_NODE_HUE_SAT         122
738 #define NODE_DYNAMIC            123
739
740 #define SH_NODE_OUTPUT_MATERIAL                 124
741 #define SH_NODE_OUTPUT_WORLD                    125
742 #define SH_NODE_OUTPUT_LIGHT                    126
743 #define SH_NODE_FRESNEL                                 127
744 #define SH_NODE_MIX_SHADER                              128
745 #define SH_NODE_ATTRIBUTE                               129
746 #define SH_NODE_BACKGROUND                              130
747 #define SH_NODE_BSDF_ANISOTROPIC                131
748 #define SH_NODE_BSDF_DIFFUSE                    132
749 #define SH_NODE_BSDF_GLOSSY                             133
750 #define SH_NODE_BSDF_GLASS                              134
751 #define SH_NODE_BSDF_TRANSLUCENT                137
752 #define SH_NODE_BSDF_TRANSPARENT                138
753 #define SH_NODE_BSDF_VELVET                             139
754 #define SH_NODE_EMISSION                                140
755 #define SH_NODE_NEW_GEOMETRY                    141
756 #define SH_NODE_LIGHT_PATH                              142
757 #define SH_NODE_TEX_IMAGE                               143
758 #define SH_NODE_TEX_SKY                                 145
759 #define SH_NODE_TEX_GRADIENT                    146
760 #define SH_NODE_TEX_VORONOI                             147
761 #define SH_NODE_TEX_MAGIC                               148
762 #define SH_NODE_TEX_WAVE                                149
763 #define SH_NODE_TEX_NOISE                               150
764 #define SH_NODE_TEX_MUSGRAVE                    152
765 #define SH_NODE_TEX_COORD                               155
766 #define SH_NODE_ADD_SHADER                              156
767 #define SH_NODE_TEX_ENVIRONMENT                 157
768 #define SH_NODE_OUTPUT_TEXTURE                  158
769 #define SH_NODE_HOLDOUT                                 159
770 #define SH_NODE_LAYER_WEIGHT                    160
771 #define SH_NODE_VOLUME_ABSORPTION               161
772 #define SH_NODE_VOLUME_SCATTER                  162
773 #define SH_NODE_GAMMA                                   163
774 #define SH_NODE_TEX_CHECKER                             164
775 #define SH_NODE_BRIGHTCONTRAST                  165
776 #define SH_NODE_LIGHT_FALLOFF                   166
777 #define SH_NODE_OBJECT_INFO                             167
778 #define SH_NODE_PARTICLE_INFO                   168
779 #define SH_NODE_TEX_BRICK                               169
780 #define SH_NODE_BUMP                                    170
781 #define SH_NODE_SCRIPT                                  171
782 #define SH_NODE_AMBIENT_OCCLUSION               172
783 #define SH_NODE_BSDF_REFRACTION                 173
784 #define SH_NODE_TANGENT                                 174
785 #define SH_NODE_NORMAL_MAP                              175
786 #define SH_NODE_HAIR_INFO                               176
787 #define SH_NODE_SUBSURFACE_SCATTERING   177
788 #define SH_NODE_WIREFRAME                               178
789 #define SH_NODE_BSDF_TOON                               179
790 #define SH_NODE_WAVELENGTH                              180
791 #define SH_NODE_BLACKBODY                               181
792 #define SH_NODE_VECT_TRANSFORM                  182
793 #define SH_NODE_SEPHSV                                  183
794 #define SH_NODE_COMBHSV                                 184
795 #define SH_NODE_BSDF_HAIR                               185
796 #define SH_NODE_LAMP                                    186
797 #define SH_NODE_UVMAP                                   187
798 #define SH_NODE_SEPXYZ                                  188
799 #define SH_NODE_COMBXYZ                                 189
800 #define SH_NODE_OUTPUT_LINESTYLE                190
801 #define SH_NODE_UVALONGSTROKE                   191
802 #define SH_NODE_TEX_POINTDENSITY                192
803 #define SH_NODE_BSDF_PRINCIPLED         193
804 #define SH_NODE_TEX_IES                 194
805 #define SH_NODE_EEVEE_SPECULAR                  195
806 #define SH_NODE_BEVEL                   197
807 #define SH_NODE_DISPLACEMENT            198
808 #define SH_NODE_VECTOR_DISPLACEMENT     199
809 #define SH_NODE_VOLUME_PRINCIPLED       200
810 /* 201..700 occupied by other node types, continue from 701 */
811 #define SH_NODE_BSDF_HAIR_PRINCIPLED    701
812
813 /* custom defines options for Material node */
814 #define SH_NODE_MAT_DIFF   1
815 #define SH_NODE_MAT_SPEC   2
816 #define SH_NODE_MAT_NEG    4
817
818 /* API */
819
820 struct bNodeTreeExec *ntreeShaderBeginExecTree(struct bNodeTree *ntree);
821 void            ntreeShaderEndExecTree(struct bNodeTreeExec *exec);
822 bool            ntreeShaderExecTree(struct bNodeTree *ntree, int thread);
823 struct bNode   *ntreeShaderOutputNode(struct bNodeTree *ntree, int target);
824
825 void            ntreeGPUMaterialNodes(struct bNodeTree *localtree, struct GPUMaterial *mat,
826                                       bool *has_surface_output, bool *has_volume_output);
827
828 /** \} */
829
830 /* -------------------------------------------------------------------- */
831 /** \name Composite Nodes
832  * \{ */
833
834 /* output socket defines */
835 #define RRES_OUT_IMAGE                                  0
836 #define RRES_OUT_ALPHA                                  1
837 #define RRES_OUT_Z                                              2
838 #define RRES_OUT_NORMAL                                 3
839 #define RRES_OUT_UV                                             4
840 #define RRES_OUT_VEC                                    5
841 #define RRES_OUT_RGBA                                   6
842 #define RRES_OUT_DIFF                                   7
843 #define RRES_OUT_SPEC                                   8
844 #define RRES_OUT_SHADOW                                 9
845 #define RRES_OUT_AO                                             10
846 #define RRES_OUT_REFLECT                                11
847 #define RRES_OUT_REFRACT                                12
848 #define RRES_OUT_INDIRECT                               13
849 #define RRES_OUT_INDEXOB                                14
850 #define RRES_OUT_INDEXMA                                15
851 #define RRES_OUT_MIST                                   16
852 #define RRES_OUT_EMIT                                   17
853 #define RRES_OUT_ENV                                    18
854 #define RRES_OUT_DIFF_DIRECT                    19
855 #define RRES_OUT_DIFF_INDIRECT                  20
856 #define RRES_OUT_DIFF_COLOR                             21
857 #define RRES_OUT_GLOSSY_DIRECT                  22
858 #define RRES_OUT_GLOSSY_INDIRECT                23
859 #define RRES_OUT_GLOSSY_COLOR                   24
860 #define RRES_OUT_TRANSM_DIRECT                  25
861 #define RRES_OUT_TRANSM_INDIRECT                26
862 #define RRES_OUT_TRANSM_COLOR                   27
863 #define RRES_OUT_SUBSURFACE_DIRECT              28
864 #define RRES_OUT_SUBSURFACE_INDIRECT    29
865 #define RRES_OUT_SUBSURFACE_COLOR               30
866 #define RRES_OUT_DEBUG                          31
867
868 /* note: types are needed to restore callbacks, don't change values */
869 #define CMP_NODE_VIEWER         201
870 #define CMP_NODE_RGB            202
871 #define CMP_NODE_VALUE          203
872 #define CMP_NODE_MIX_RGB        204
873 #define CMP_NODE_VALTORGB       205
874 #define CMP_NODE_RGBTOBW        206
875 #define CMP_NODE_NORMAL         207
876 #define CMP_NODE_CURVE_VEC      208
877 #define CMP_NODE_CURVE_RGB      209
878 #define CMP_NODE_ALPHAOVER      210
879 #define CMP_NODE_BLUR           211
880 #define CMP_NODE_FILTER         212
881 #define CMP_NODE_MAP_VALUE      213
882 #define CMP_NODE_TIME           214
883 #define CMP_NODE_VECBLUR        215
884 #define CMP_NODE_SEPRGBA        216
885 #define CMP_NODE_SEPHSVA        217
886 #define CMP_NODE_SETALPHA       218
887 #define CMP_NODE_HUE_SAT        219
888 #define CMP_NODE_IMAGE          220
889 #define CMP_NODE_R_LAYERS       221
890 #define CMP_NODE_COMPOSITE      222
891 #define CMP_NODE_OUTPUT_FILE    223
892 #define CMP_NODE_TEXTURE        224
893 #define CMP_NODE_TRANSLATE      225
894 #define CMP_NODE_ZCOMBINE       226
895 #define CMP_NODE_COMBRGBA       227
896 #define CMP_NODE_DILATEERODE    228
897 #define CMP_NODE_ROTATE         229
898 #define CMP_NODE_SCALE          230
899 #define CMP_NODE_SEPYCCA        231
900 #define CMP_NODE_COMBYCCA       232
901 #define CMP_NODE_SEPYUVA        233
902 #define CMP_NODE_COMBYUVA       234
903 #define CMP_NODE_DIFF_MATTE     235
904 #define CMP_NODE_COLOR_SPILL    236
905 #define CMP_NODE_CHROMA_MATTE   237
906 #define CMP_NODE_CHANNEL_MATTE  238
907 #define CMP_NODE_FLIP           239
908 #define CMP_NODE_SPLITVIEWER    240
909 // #define CMP_NODE_INDEX_MASK  241
910 #define CMP_NODE_MAP_UV         242
911 #define CMP_NODE_ID_MASK        243
912 #define CMP_NODE_DEFOCUS        244
913 #define CMP_NODE_DISPLACE       245
914 #define CMP_NODE_COMBHSVA       246
915 #define CMP_NODE_MATH           247
916 #define CMP_NODE_LUMA_MATTE     248
917 #define CMP_NODE_BRIGHTCONTRAST 249
918 #define CMP_NODE_GAMMA          250
919 #define CMP_NODE_INVERT         251
920 #define CMP_NODE_NORMALIZE      252
921 #define CMP_NODE_CROP           253
922 #define CMP_NODE_DBLUR          254
923 #define CMP_NODE_BILATERALBLUR  255
924 #define CMP_NODE_PREMULKEY  256
925 #define CMP_NODE_DIST_MATTE     257
926 #define CMP_NODE_VIEW_LEVELS    258
927 #define CMP_NODE_COLOR_MATTE 259
928 #define CMP_NODE_COLORBALANCE 260
929 #define CMP_NODE_HUECORRECT 261
930 #define CMP_NODE_MOVIECLIP      262
931 #define CMP_NODE_STABILIZE2D    263
932 #define CMP_NODE_TRANSFORM      264
933 #define CMP_NODE_MOVIEDISTORTION        265
934 #define CMP_NODE_DOUBLEEDGEMASK    266
935 #define CMP_NODE_OUTPUT_MULTI_FILE__DEPRECATED  267     /* DEPRECATED multi file node has been merged into regular CMP_NODE_OUTPUT_FILE */
936 #define CMP_NODE_MASK           268
937 #define CMP_NODE_KEYINGSCREEN           269
938 #define CMP_NODE_KEYING                 270
939 #define CMP_NODE_TRACKPOS               271
940 #define CMP_NODE_INPAINT    272
941 #define CMP_NODE_DESPECKLE  273
942
943 #define CMP_NODE_GLARE          301
944 #define CMP_NODE_TONEMAP        302
945 #define CMP_NODE_LENSDIST       303
946 #define CMP_NODE_SUNBEAMS       304
947
948 #define CMP_NODE_COLORCORRECTION 312
949 #define CMP_NODE_MASK_BOX       313
950 #define CMP_NODE_MASK_ELLIPSE   314
951 #define CMP_NODE_BOKEHIMAGE     315
952 #define CMP_NODE_BOKEHBLUR      316
953 #define CMP_NODE_SWITCH         317
954 #define CMP_NODE_PIXELATE       318
955
956 #define CMP_NODE_MAP_RANGE      319
957 #define CMP_NODE_PLANETRACKDEFORM       320
958 #define CMP_NODE_CORNERPIN          321
959 #define CMP_NODE_SWITCH_VIEW    322
960 #define CMP_NODE_CRYPTOMATTE    323
961
962 /* channel toggles */
963 #define CMP_CHAN_RGB            1
964 #define CMP_CHAN_A                      2
965
966 /* filter types */
967 #define CMP_FILT_SOFT           0
968 #define CMP_FILT_SHARP          1
969 #define CMP_FILT_LAPLACE        2
970 #define CMP_FILT_SOBEL          3
971 #define CMP_FILT_PREWITT        4
972 #define CMP_FILT_KIRSCH         5
973 #define CMP_FILT_SHADOW         6
974
975 /* scale node type, in custom1 */
976 #define CMP_SCALE_RELATIVE              0
977 #define CMP_SCALE_ABSOLUTE              1
978 #define CMP_SCALE_SCENEPERCENT  2
979 #define CMP_SCALE_RENDERPERCENT 3
980 /* custom2 */
981 #define CMP_SCALE_RENDERSIZE_FRAME_ASPECT  (1 << 0)
982 #define CMP_SCALE_RENDERSIZE_FRAME_CROP    (1 << 1)
983
984 /* track position node, in custom1 */
985 #define CMP_TRACKPOS_ABSOLUTE                   0
986 #define CMP_TRACKPOS_RELATIVE_START     1
987 #define CMP_TRACKPOS_RELATIVE_FRAME     2
988 #define CMP_TRACKPOS_ABSOLUTE_FRAME     3
989
990 /* API */
991 void ntreeCompositExecTree(struct Scene *scene, struct bNodeTree *ntree, struct RenderData *rd, int rendering, int do_previews,
992                            const struct ColorManagedViewSettings *view_settings, const struct ColorManagedDisplaySettings *display_settings,
993                            const char *view_name);
994 void ntreeCompositTagRender(struct Scene *sce);
995 int ntreeCompositTagAnimated(struct bNodeTree *ntree);
996 void ntreeCompositTagGenerators(struct bNodeTree *ntree);
997 void ntreeCompositUpdateRLayers(struct bNodeTree *ntree);
998 void ntreeCompositRegisterPass(struct bNodeTree *ntree, struct Scene *scene, struct ViewLayer *view_layer, const char *name, int type);
999 void ntreeCompositClearTags(struct bNodeTree *ntree);
1000
1001 struct bNodeSocket *ntreeCompositOutputFileAddSocket(struct bNodeTree *ntree, struct bNode *node,
1002                                                      const char *name, struct ImageFormatData *im_format);
1003 int ntreeCompositOutputFileRemoveActiveSocket(struct bNodeTree *ntree, struct bNode *node);
1004 void ntreeCompositOutputFileSetPath(struct bNode *node, struct bNodeSocket *sock, const char *name);
1005 void ntreeCompositOutputFileSetLayer(struct bNode *node, struct bNodeSocket *sock, const char *name);
1006 /* needed in do_versions */
1007 void ntreeCompositOutputFileUniquePath(struct ListBase *list, struct bNodeSocket *sock, const char defname[], char delim);
1008 void ntreeCompositOutputFileUniqueLayer(struct ListBase *list, struct bNodeSocket *sock, const char defname[], char delim);
1009
1010 void ntreeCompositColorBalanceSyncFromLGG(bNodeTree *ntree, bNode *node);
1011 void ntreeCompositColorBalanceSyncFromCDL(bNodeTree *ntree, bNode *node);
1012
1013 void ntreeCompositCryptomatteSyncFromAdd(bNodeTree *ntree, bNode *node);
1014 void ntreeCompositCryptomatteSyncFromRemove(bNodeTree *ntree, bNode *node);
1015 struct bNodeSocket *ntreeCompositCryptomatteAddSocket(struct bNodeTree *ntree, struct bNode *node);
1016 int ntreeCompositCryptomatteRemoveSocket(struct bNodeTree *ntree, struct bNode *node);
1017
1018 /** \} */
1019
1020 /* -------------------------------------------------------------------- */
1021 /** \name Texture Nodes
1022  * \{ */
1023
1024 struct TexResult;
1025
1026 #define TEX_NODE_OUTPUT     401
1027 #define TEX_NODE_CHECKER    402
1028 #define TEX_NODE_TEXTURE    403
1029 #define TEX_NODE_BRICKS     404
1030 #define TEX_NODE_MATH       405
1031 #define TEX_NODE_MIX_RGB    406
1032 #define TEX_NODE_RGBTOBW    407
1033 #define TEX_NODE_VALTORGB   408
1034 #define TEX_NODE_IMAGE      409
1035 #define TEX_NODE_CURVE_RGB  410
1036 #define TEX_NODE_INVERT     411
1037 #define TEX_NODE_HUE_SAT    412
1038 #define TEX_NODE_CURVE_TIME 413
1039 #define TEX_NODE_ROTATE     414
1040 #define TEX_NODE_VIEWER     415
1041 #define TEX_NODE_TRANSLATE  416
1042 #define TEX_NODE_COORD      417
1043 #define TEX_NODE_DISTANCE   418
1044 #define TEX_NODE_COMPOSE    419
1045 #define TEX_NODE_DECOMPOSE  420
1046 #define TEX_NODE_VALTONOR   421
1047 #define TEX_NODE_SCALE      422
1048 #define TEX_NODE_AT         423
1049
1050 /* 501-599 reserved. Use like this: TEX_NODE_PROC + TEX_CLOUDS, etc */
1051 #define TEX_NODE_PROC      500
1052 #define TEX_NODE_PROC_MAX  600
1053
1054 /* API */
1055 int  ntreeTexTagAnimated(struct bNodeTree *ntree);
1056 void ntreeTexCheckCyclics(struct bNodeTree *ntree);
1057
1058 struct bNodeTreeExec *ntreeTexBeginExecTree(struct bNodeTree *ntree);
1059 void ntreeTexEndExecTree(struct bNodeTreeExec *exec);
1060 int ntreeTexExecTree(struct bNodeTree *ntree, struct TexResult *target,
1061                      float coord[3], float dxt[3], float dyt[3], int osatex, const short thread,
1062                      struct Tex *tex, short which_output, int cfra, int preview, struct MTex *mtex);
1063 /** \} */
1064
1065 void init_nodesystem(void);
1066 void free_nodesystem(void);
1067
1068 /* -------------------------------------------------------------------- */
1069 /* evaluation support, */
1070
1071 struct Depsgraph;
1072
1073 void BKE_nodetree_shading_params_eval(struct Depsgraph *depsgraph,
1074                                       struct bNodeTree *ntree_dst,
1075                                       const struct bNodeTree *ntree_src);
1076
1077 #endif  /* __BKE_NODE_H__ */