Fix T60434: crash with OSL and viewport + preview render at the same time.
[blender.git] / intern / cycles / render / osl.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 __OSL_H__
18 #define __OSL_H__
19
20 #include "util/util_array.h"
21 #include "util/util_set.h"
22 #include "util/util_string.h"
23 #include "util/util_thread.h"
24
25 #include "render/graph.h"
26 #include "render/nodes.h"
27 #include "render/shader.h"
28
29 #ifdef WITH_OSL
30 #include <OSL/llvm_util.h>
31 #include <OSL/oslcomp.h>
32 #include <OSL/oslexec.h>
33 #include <OSL/oslquery.h>
34 #endif
35
36 CCL_NAMESPACE_BEGIN
37
38 class Device;
39 class DeviceScene;
40 class ImageManager;
41 class OSLRenderServices;
42 struct OSLGlobals;
43 class Scene;
44 class ShaderGraph;
45 class ShaderNode;
46 class ShaderInput;
47 class ShaderOutput;
48
49 #ifdef WITH_OSL
50
51 /* OSL Shader Info
52  * to auto detect closures in the shader for MIS and transparent shadows */
53
54 struct OSLShaderInfo {
55         OSLShaderInfo()
56         : has_surface_emission(false), has_surface_transparent(false),
57           has_surface_bssrdf(false)
58         {}
59
60         OSL::OSLQuery query;
61         bool has_surface_emission;
62         bool has_surface_transparent;
63         bool has_surface_bssrdf;
64 };
65
66 /* Shader Manage */
67
68 class OSLShaderManager : public ShaderManager {
69 public:
70         OSLShaderManager();
71         ~OSLShaderManager();
72
73         static void free_memory();
74
75         void reset(Scene *scene);
76
77         bool use_osl() { return true; }
78
79         void device_update(Device *device, DeviceScene *dscene, Scene *scene, Progress& progress);
80         void device_free(Device *device, DeviceScene *dscene, Scene *scene);
81
82         /* osl compile and query */
83         static bool osl_compile(const string& inputfile, const string& outputfile);
84         static bool osl_query(OSL::OSLQuery& query, const string& filepath);
85
86         /* shader file loading, all functions return pointer to hash string if found */
87         const char *shader_test_loaded(const string& hash);
88         const char *shader_load_bytecode(const string& hash, const string& bytecode);
89         const char *shader_load_filepath(string filepath);
90         OSLShaderInfo *shader_loaded_info(const string& hash);
91
92         /* create OSL node using OSLQuery */
93         OSLNode *osl_node(const std::string& filepath,
94                           const std::string& bytecode_hash = "",
95                           const std::string& bytecode = "");
96
97 protected:
98         void texture_system_init();
99         void texture_system_free();
100
101         void shading_system_init();
102         void shading_system_free();
103
104         OSL::ShadingSystem *ss;
105         OSL::TextureSystem *ts;
106         OSLRenderServices *services;
107         OSL::ErrorHandler errhandler;
108         map<string, OSLShaderInfo> loaded_shaders;
109
110         static OSL::TextureSystem *ts_shared;
111         static thread_mutex ts_shared_mutex;
112         static int ts_shared_users;
113
114         static OSL::ShadingSystem *ss_shared;
115         static OSLRenderServices *services_shared;
116         static thread_mutex ss_shared_mutex;
117         static thread_mutex ss_mutex;
118         static int ss_shared_users;
119 };
120
121 #endif
122
123 /* Graph Compiler */
124
125 class OSLCompiler {
126 public:
127         OSLCompiler(void *manager, void *shadingsys,
128                     ImageManager *image_manager,
129                     LightManager *light_manager);
130         void compile(Scene *scene, OSLGlobals *og, Shader *shader);
131
132         void add(ShaderNode *node, const char *name, bool isfilepath = false);
133
134         void parameter(ShaderNode *node, const char *name);
135
136         void parameter(const char *name, float f);
137         void parameter_color(const char *name, float3 f);
138         void parameter_vector(const char *name, float3 f);
139         void parameter_normal(const char *name, float3 f);
140         void parameter_point(const char *name, float3 f);
141         void parameter(const char *name, int f);
142         void parameter(const char *name, const char *s);
143         void parameter(const char *name, ustring str);
144         void parameter(const char *name, const Transform& tfm);
145
146         void parameter_array(const char *name, const float f[], int arraylen);
147         void parameter_color_array(const char *name, const array<float3>& f);
148
149         void parameter_attribute(const char *name, ustring s);
150
151         ShaderType output_type() { return current_type; }
152
153         bool background;
154         ImageManager *image_manager;
155         LightManager *light_manager;
156
157 private:
158 #ifdef WITH_OSL
159         string id(ShaderNode *node);
160         OSL::ShaderGroupRef compile_type(Shader *shader, ShaderGraph *graph, ShaderType type);
161         bool node_skip_input(ShaderNode *node, ShaderInput *input);
162         string compatible_name(ShaderNode *node, ShaderInput *input);
163         string compatible_name(ShaderNode *node, ShaderOutput *output);
164
165         void find_dependencies(ShaderNodeSet& dependencies, ShaderInput *input);
166         void generate_nodes(const ShaderNodeSet& nodes);
167 #endif
168
169         void *shadingsys;
170         void *manager;
171         ShaderType current_type;
172         Shader *current_shader;
173 };
174
175 CCL_NAMESPACE_END
176
177 #endif  /* __OSL_H__  */