Fix #34121: OSL + persistent images option was not freeing shader memory properly,
[blender.git] / intern / cycles / render / osl.h
1 /*
2  * Copyright 2011, Blender Foundation.
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
19 #ifndef __OSL_H__
20 #define __OSL_H__
21
22 #include "util_set.h"
23 #include "util_string.h"
24
25 #include "shader.h"
26
27 #ifdef WITH_OSL
28 #include <OSL/oslcomp.h>
29 #include <OSL/oslexec.h>
30 #include <OSL/oslquery.h>
31 #endif
32
33 CCL_NAMESPACE_BEGIN
34
35 class Device;
36 class DeviceScene;
37 class ImageManager;
38 class OSLRenderServices;
39 struct OSLGlobals;
40 class Scene;
41 class ShaderGraph;
42 class ShaderNode;
43 class ShaderInput;
44 class ShaderOutput;
45
46 #ifdef WITH_OSL
47
48 /* OSL Shader Info
49  * to auto detect closures in the shader for MIS and transparent shadows */
50
51 struct OSLShaderInfo {
52         OSLShaderInfo()
53         : has_surface_emission(false), has_surface_transparent(false)
54         {}
55
56         bool has_surface_emission;
57         bool has_surface_transparent;
58 };
59
60 /* Shader Manage */
61
62 class OSLShaderManager : public ShaderManager {
63 public:
64         OSLShaderManager();
65         ~OSLShaderManager();
66
67         void reset(Scene *scene);
68
69         bool use_osl() { return true; }
70
71         void device_update(Device *device, DeviceScene *dscene, Scene *scene, Progress& progress);
72         void device_free(Device *device, DeviceScene *dscene);
73
74         /* osl compile and query */
75         static bool osl_compile(const string& inputfile, const string& outputfile);
76         static bool osl_query(OSL::OSLQuery& query, const string& filepath);
77
78         /* shader file loading, all functions return pointer to hash string if found */
79         const char *shader_test_loaded(const string& hash);
80         const char *shader_load_bytecode(const string& hash, const string& bytecode);
81         const char *shader_load_filepath(string filepath);
82         OSLShaderInfo *shader_loaded_info(const string& hash);
83
84 protected:
85         void texture_system_init();
86         void shading_system_init();
87
88         OSL::ShadingSystem *ss;
89         OSL::TextureSystem *ts;
90         OSLRenderServices *services;
91         OSL::ErrorHandler errhandler;
92         map<string, OSLShaderInfo> loaded_shaders;
93 };
94
95 #endif
96
97 /* Graph Compiler */
98
99 class OSLCompiler {
100 public:
101         OSLCompiler(void *manager, void *shadingsys, ImageManager *image_manager);
102         void compile(OSLGlobals *og, Shader *shader);
103
104         void add(ShaderNode *node, const char *name, bool isfilepath = false);
105
106         void parameter(const char *name, float f);
107         void parameter_color(const char *name, float3 f);
108         void parameter_vector(const char *name, float3 f);
109         void parameter_normal(const char *name, float3 f);
110         void parameter_point(const char *name, float3 f);
111         void parameter(const char *name, int f);
112         void parameter(const char *name, const char *s);
113         void parameter(const char *name, ustring str);
114         void parameter(const char *name, const Transform& tfm);
115
116         void parameter_array(const char *name, const float f[], int arraylen);
117         void parameter_color_array(const char *name, const float f[][3], int arraylen);
118         void parameter_vector_array(const char *name, const float f[][3], int arraylen);
119         void parameter_normal_array(const char *name, const float f[][3], int arraylen);
120         void parameter_point_array(const char *name, const float f[][3], int arraylen);
121         void parameter_array(const char *name, const int f[], int arraylen);
122         void parameter_array(const char *name, const char * const s[], int arraylen);
123         void parameter_array(const char *name, const Transform tfm[], int arraylen);
124
125         ShaderType output_type() { return current_type; }
126
127         bool background;
128         ImageManager *image_manager;
129
130 private:
131         string id(ShaderNode *node);
132         void compile_type(Shader *shader, ShaderGraph *graph, ShaderType type);
133         bool node_skip_input(ShaderNode *node, ShaderInput *input);
134         string compatible_name(ShaderNode *node, ShaderInput *input);
135         string compatible_name(ShaderNode *node, ShaderOutput *output);
136
137         void find_dependencies(set<ShaderNode*>& dependencies, ShaderInput *input);
138         void generate_nodes(const set<ShaderNode*>& nodes);
139
140         void *shadingsys;
141         void *manager;
142         ShaderType current_type;
143         Shader *current_shader;
144 };
145
146 CCL_NAMESPACE_END
147
148 #endif /* __OSL_H__  */
149