Fix incorrect FLT_MIN use
[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         int stack_assign(ShaderOutput *output);
99         int stack_assign(ShaderInput *input);
100         int stack_assign_if_linked(ShaderInput *input);
101         int stack_assign_if_linked(ShaderOutput *output);
102         int stack_find_offset(ShaderSocketType type);
103         void stack_clear_offset(ShaderSocketType type, int offset);
104         void stack_link(ShaderInput *input, ShaderOutput *output);
105
106         void add_node(NodeType type, int a = 0, int b = 0, int c = 0);
107         void add_node(int a = 0, int b = 0, int c = 0, int d = 0);
108         void add_node(NodeType type, const float3& f);
109         void add_node(const float4& f);
110         void add_array(float4 *f, int num);
111         uint attribute(ustring name);
112         uint attribute(AttributeStandard std);
113         uint encode_uchar4(uint x, uint y = 0, uint z = 0, uint w = 0);
114         uint closure_mix_weight_offset() { return mix_weight_offset; }
115
116         ShaderType output_type() { return current_type; }
117
118         ImageManager *image_manager;
119         ShaderManager *shader_manager;
120         bool background;
121
122 protected:
123         /* stack */
124         struct Stack {
125                 Stack() { memset(users, 0, sizeof(users)); }
126                 Stack(const Stack& other) { memcpy(users, other.users, sizeof(users)); }
127                 Stack& operator=(const Stack& other) { memcpy(users, other.users, sizeof(users)); return *this; }
128
129                 bool empty()
130                 {
131                         for(int i = 0; i < SVM_STACK_SIZE; i++)
132                                 if(users[i])
133                                         return false;
134
135                         return true;
136                 }
137
138                 void print()
139                 {
140                         printf("stack <");
141
142                         for(int i = 0; i < SVM_STACK_SIZE; i++)
143                                 printf((users[i])? "*": " ");
144
145                         printf(">\n");
146                 }
147
148                 int users[SVM_STACK_SIZE];
149         };
150
151         /* Global state of the compiler accessible from the compilation routines. */
152         struct CompilerState {
153                 CompilerState(ShaderGraph *graph);
154
155                 /* ** Global state, used by various compilation steps. ** */
156
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                 /* ** SVM nodes generation state ** */
164
165                 /* Flag whether the node with corresponding ID was already compiled or
166                  * not. Array element with index i corresponds to a node with such if.
167                  *
168                  * TODO(sergey): This is actually a copy of nodes_done just in another
169                  * notation. We can de-duplicate this storage actually after switching
170                  * all areas to use this flags array.
171                  */
172                 vector<bool> nodes_done_flag;
173         };
174
175         void stack_clear_temporary(ShaderNode *node);
176         int stack_size(ShaderSocketType type);
177         void stack_clear_users(ShaderNode *node, ShaderNodeSet& done);
178
179         bool node_skip_input(ShaderNode *node, ShaderInput *input);
180
181         /* single closure */
182         void find_dependencies(ShaderNodeSet& dependencies,
183                                const ShaderNodeSet& done,
184                                ShaderInput *input,
185                                ShaderNode *skip_node = NULL);
186         void generate_node(ShaderNode *node, ShaderNodeSet& done);
187         void generate_closure_node(ShaderNode *node, CompilerState *state);
188         void generated_shared_closure_nodes(ShaderNode *root_node,
189                                             ShaderNode *node,
190                                             CompilerState *state,
191                                             const ShaderNodeSet& shared);
192         void generate_svm_nodes(const ShaderNodeSet& nodes,
193                                 CompilerState *state);
194
195         /* multi closure */
196         void generate_multi_closure(ShaderNode *root_node,
197                                     ShaderNode *node,
198                                     CompilerState *state);
199
200         /* compile */
201         void compile_type(Shader *shader, ShaderGraph *graph, ShaderType type);
202
203         vector<int4> svm_nodes;
204         ShaderType current_type;
205         Shader *current_shader;
206         ShaderGraph *current_graph;
207         Stack active_stack;
208         int max_stack_use;
209         uint mix_weight_offset;
210         bool compile_failed;
211 };
212
213 CCL_NAMESPACE_END
214
215 #endif /* __SVM_H__ */
216