Cycles: Wrap SVM compiler state variables into a single struct
[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         struct Summary {
56                 Summary();
57
58                 /* Number of SVM nodes shader was compiled into. */
59                 int num_svm_nodes;
60
61                 /* Peak stack usage during shader evaluation. */
62                 int peak_stack_usage;
63
64                 /* Time spent on surface graph finalization. */
65                 double time_finalize;
66
67                 /* Time spent on bump graph finalization. */
68                 double time_finalize_bump;
69
70                 /* Time spent on generating SVM nodes for surface shader. */
71                 double time_generate_surface;
72
73                 /* Time spent on generating SVM nodes for bump shader. */
74                 double time_generate_bump;
75
76                 /* Time spent on generating SVM nodes for volume shader. */
77                 double time_generate_volume;
78
79                 /* Time spent on generating SVM nodes for displacement shader. */
80                 double time_generate_displacement;
81
82                 /* Total time spent on all routines. */
83                 double time_total;
84
85                 /* A full multiline description of the state of the compiler after
86                  * compilation.
87                  */
88                 string full_report() const;
89         };
90
91         SVMCompiler(ShaderManager *shader_manager, ImageManager *image_manager);
92         void compile(Scene *scene,
93                      Shader *shader,
94                      vector<int4>& svm_nodes,
95                      int index,
96                      Summary *summary = NULL);
97
98         void stack_assign(ShaderOutput *output);
99         void stack_assign(ShaderInput *input);
100         int stack_find_offset(ShaderSocketType type);
101         void stack_clear_offset(ShaderSocketType type, int offset);
102         void stack_link(ShaderInput *input, ShaderOutput *output);
103
104         void add_node(NodeType type, int a = 0, int b = 0, int c = 0);
105         void add_node(int a = 0, int b = 0, int c = 0, int d = 0);
106         void add_node(NodeType type, const float3& f);
107         void add_node(const float4& f);
108         void add_array(float4 *f, int num);
109         uint attribute(ustring name);
110         uint attribute(AttributeStandard std);
111         uint encode_uchar4(uint x, uint y = 0, uint z = 0, uint w = 0);
112         uint closure_mix_weight_offset() { return mix_weight_offset; }
113
114         ShaderType output_type() { return current_type; }
115
116         ImageManager *image_manager;
117         ShaderManager *shader_manager;
118         bool background;
119
120 protected:
121         /* stack */
122         struct Stack {
123                 Stack() { memset(users, 0, sizeof(users)); }
124                 Stack(const Stack& other) { memcpy(users, other.users, sizeof(users)); }
125                 Stack& operator=(const Stack& other) { memcpy(users, other.users, sizeof(users)); return *this; }
126
127                 bool empty()
128                 {
129                         for(int i = 0; i < SVM_STACK_SIZE; i++)
130                                 if(users[i])
131                                         return false;
132
133                         return true;
134                 }
135
136                 void print()
137                 {
138                         printf("stack <");
139
140                         for(int i = 0; i < SVM_STACK_SIZE; i++)
141                                 printf((users[i])? "*": " ");
142
143                         printf(">\n");
144                 }
145
146                 int users[SVM_STACK_SIZE];
147         };
148
149         struct StackBackup {
150                 Stack stack;
151                 vector<int> offsets;
152                 ShaderNodeSet done;
153         };
154
155         /* Global state of the compiler accessible from the compilation routines. */
156         struct CompilerState {
157                 /* Set of nodes which were already compiled. */
158                 ShaderNodeSet nodes_done;
159
160                 /* Set of closures which were already compiled. */
161                 ShaderNodeSet closure_done;
162         };
163
164         void stack_backup(StackBackup& backup, ShaderNodeSet& done);
165         void stack_restore(StackBackup& backup, ShaderNodeSet& done);
166
167         void stack_clear_temporary(ShaderNode *node);
168         int stack_size(ShaderSocketType type);
169         void stack_clear_users(ShaderNode *node, ShaderNodeSet& done);
170
171         bool node_skip_input(ShaderNode *node, ShaderInput *input);
172
173         /* single closure */
174         void find_dependencies(ShaderNodeSet& dependencies,
175                                const ShaderNodeSet& done,
176                                ShaderInput *input,
177                                ShaderNode *skip_node = NULL);
178         void generate_node(ShaderNode *node, ShaderNodeSet& done);
179         void generate_closure_node(ShaderNode *node, CompilerState *state);
180         void generated_shared_closure_nodes(ShaderNode *root_node,
181                                             ShaderNode *node,
182                                             CompilerState *state,
183                                             const ShaderNodeSet& shared);
184         void generate_svm_nodes(const ShaderNodeSet& nodes,
185                                 CompilerState *state);
186
187         /* multi closure */
188         void generate_multi_closure(ShaderNode *root_node,
189                                     ShaderNode *node,
190                                     CompilerState *state);
191
192         /* compile */
193         void compile_type(Shader *shader, ShaderGraph *graph, ShaderType type);
194
195         vector<int4> svm_nodes;
196         ShaderType current_type;
197         Shader *current_shader;
198         ShaderGraph *current_graph;
199         Stack active_stack;
200         int max_stack_use;
201         uint mix_weight_offset;
202         bool compile_failed;
203 };
204
205 CCL_NAMESPACE_END
206
207 #endif /* __SVM_H__ */
208