Cycles: Ensure order of shader nodes in the dependnecies set
[blender.git] / intern / cycles / render / svm.h
1 /*
2  * Copyright 2011-2013 Blender Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #ifndef __SVM_H__
18 #define __SVM_H__
19
20 #include "attribute.h"
21 #include "graph.h"
22 #include "shader.h"
23
24 #include "util_set.h"
25 #include "util_string.h"
26
27 CCL_NAMESPACE_BEGIN
28
29 class Device;
30 class DeviceScene;
31 class ImageManager;
32 class Scene;
33 class ShaderGraph;
34 class ShaderInput;
35 class ShaderNode;
36 class ShaderOutput;
37
38 /* Shader Manager */
39
40 class SVMShaderManager : public ShaderManager {
41 public:
42         SVMShaderManager();
43         ~SVMShaderManager();
44
45         void reset(Scene *scene);
46
47         void device_update(Device *device, DeviceScene *dscene, Scene *scene, Progress& progress);
48         void device_free(Device *device, DeviceScene *dscene, Scene *scene);
49 };
50
51 /* Graph Compiler */
52
53 class SVMCompiler {
54 public:
55         SVMCompiler(ShaderManager *shader_manager, ImageManager *image_manager);
56         void compile(Scene *scene,
57                      Shader *shader,
58                      vector<int4>& svm_nodes,
59                      int index);
60
61         void stack_assign(ShaderOutput *output);
62         void stack_assign(ShaderInput *input);
63         int stack_find_offset(ShaderSocketType type);
64         void stack_clear_offset(ShaderSocketType type, int offset);
65         void stack_link(ShaderInput *input, ShaderOutput *output);
66
67         void add_node(NodeType type, int a = 0, int b = 0, int c = 0);
68         void add_node(int a = 0, int b = 0, int c = 0, int d = 0);
69         void add_node(NodeType type, const float3& f);
70         void add_node(const float4& f);
71         void add_array(float4 *f, int num);
72         uint attribute(ustring name);
73         uint attribute(AttributeStandard std);
74         uint encode_uchar4(uint x, uint y = 0, uint z = 0, uint w = 0);
75         uint closure_mix_weight_offset() { return mix_weight_offset; }
76
77         ShaderType output_type() { return current_type; }
78
79         ImageManager *image_manager;
80         ShaderManager *shader_manager;
81         bool background;
82
83 protected:
84         /* stack */
85         struct Stack {
86                 Stack() { memset(users, 0, sizeof(users)); }
87                 Stack(const Stack& other) { memcpy(users, other.users, sizeof(users)); }
88                 Stack& operator=(const Stack& other) { memcpy(users, other.users, sizeof(users)); return *this; }
89
90                 bool empty()
91                 {
92                         for(int i = 0; i < SVM_STACK_SIZE; i++)
93                                 if(users[i])
94                                         return false;
95
96                         return true;
97                 }
98
99                 void print()
100                 {
101                         printf("stack <");
102
103                         for(int i = 0; i < SVM_STACK_SIZE; i++)
104                                 printf((users[i])? "*": " ");
105
106                         printf(">\n");
107                 }
108
109                 int users[SVM_STACK_SIZE];
110         };
111
112         struct StackBackup {
113                 Stack stack;
114                 vector<int> offsets;
115                 ShaderNodeSet done;
116         };
117
118         void stack_backup(StackBackup& backup, ShaderNodeSet& done);
119         void stack_restore(StackBackup& backup, ShaderNodeSet& done);
120
121         void stack_clear_temporary(ShaderNode *node);
122         int stack_size(ShaderSocketType type);
123         void stack_clear_users(ShaderNode *node, ShaderNodeSet& done);
124
125         bool node_skip_input(ShaderNode *node, ShaderInput *input);
126
127         /* single closure */
128         void find_dependencies(ShaderNodeSet& dependencies,
129                                const ShaderNodeSet& done,
130                                ShaderInput *input,
131                                ShaderNode *skip_node = NULL);
132         void generate_node(ShaderNode *node, ShaderNodeSet& done);
133         void generate_closure_node(ShaderNode *node, ShaderNodeSet& done);
134         void generated_shared_closure_nodes(ShaderNode *root_node, ShaderNode *node,
135                                             ShaderNodeSet& done,
136                                             ShaderNodeSet& closure_done,
137                                             const ShaderNodeSet& shared);
138         void generate_svm_nodes(const ShaderNodeSet& nodes, ShaderNodeSet& done);
139
140         /* multi closure */
141         void generate_multi_closure(ShaderNode *root_node,
142                                     ShaderNode *node,
143                                     ShaderNodeSet& done,
144                                     ShaderNodeSet& closure_done);
145
146         /* compile */
147         void compile_type(Shader *shader, ShaderGraph *graph, ShaderType type);
148
149         vector<int4> svm_nodes;
150         ShaderType current_type;
151         Shader *current_shader;
152         ShaderGraph *current_graph;
153         Stack active_stack;
154         int max_stack_use;
155         uint mix_weight_offset;
156         bool compile_failed;
157 };
158
159 CCL_NAMESPACE_END
160
161 #endif /* __SVM_H__ */
162