3 #include <msp/strings/format.h>
6 #include "programbuilder.h"
8 #include "vertexformat.h"
18 l_* Lighting component
22 tbn_* Tangent-Binormal-Normal space
24 env_* Environment space
25 *_dir Direction vector
27 zzz_* Wildcard space, resolved by the builder
28 All wildcard spaces within an expression must match
30 xxx_yyy_* Matrix that transforms between yyy to xxx
31 The vector is on the side of its designated space, result will be
33 *_matrix A matrix (duh)
34 *_rmatrix A mat4 that works with a row vector
36 rgb_* Color with rgb components only
37 color_* Color with rgba components
40 /* The array are stored in reverse order, so that variables always come after
41 anything that might need them. */
42 const ProgramBuilder::VariableDefinition ProgramBuilder::standard_variables[] =
44 { FRAGMENT, "gl_FragColor", "vec4", "frag_color", "g" },
45 { FRAGMENT, "frag_color", "vec4", "color_base", "!t" },
46 { FRAGMENT, "frag_color", "vec4", "tex_sample", "!l!s!mt" },
47 { FRAGMENT, "frag_color", "vec4", "tex_sample*color_base", "l|s|mt" },
48 { FRAGMENT, "color_base", "vec4", "vec4(1.0)", "!l!s!m" },
49 { FRAGMENT, "color_base", "vec4", "color", "!l!sm" },
50 { FRAGMENT, "color_base", "vec4", "vec4(vec3(l_shadow), 1.0)", "!ls!m" },
51 { FRAGMENT, "color_base", "vec4", "color*vec4(vec3(l_shadow), 1.0)", "!lsm" },
52 { FRAGMENT, "color_base", "vec4", "vec4(rgb_light_env, 1.0)", "l!m" },
53 { FRAGMENT, "color_base", "vec4", "vec4(rgb_light_env, material.diffuse.a)", "lm" },
54 { FRAGMENT, "rgb_light_env", "vec3", "rgb_light_full+reflect_sample.rgb*reflectivity", "e" },
55 { FRAGMENT, "rgb_light_env", "vec3", "rgb_light_full", "!e" },
56 { FRAGMENT, "rgb_light_full", "vec3", "rgb_light_shadow+ambient_product_diffuse.rgb", "m" },
57 { FRAGMENT, "rgb_light_full", "vec3", "rgb_light_shadow", "!m" },
58 { FRAGMENT, "ambient_product_diffuse", "vec4", "gl_FrontLightModelProduct.sceneColor", "g" },
59 { FRAGMENT, "ambient_product_diffuse", "vec4", "ambient_color*material.diffuse", "!g" },
60 { FRAGMENT, "rgb_light_shadow", "vec3", "rgb_light*l_shadow", "s" },
61 { FRAGMENT, "rgb_light_shadow", "vec3", "rgb_light", "!s" },
62 { FRAGMENT, "rgb_light", "vec3", "vec3(l_diffuse)", "!m!p" },
63 { FRAGMENT, "rgb_light", "vec3", "vec3(l_diffuse+l_specular)", "!mp" },
64 { FRAGMENT, "rgb_light", "vec3", "l_diffuse*light_product_diffuse.rgb", "m!p" },
65 { FRAGMENT, "rgb_light", "vec3", "l_diffuse*light_product_diffuse.rgb+l_specular*light_product_specular.rgb", "mp" },
66 { FRAGMENT, "light_product_diffuse", "vec4", "gl_FrontLightProduct[0].diffuse", "g" },
67 { FRAGMENT, "light_product_diffuse", "vec4", "light_sources[0].diffuse*material.diffuse", "!g" },
68 { FRAGMENT, "light_product_specular", "vec4", "gl_FrontLightProduct[0].specular", "g" },
69 { FRAGMENT, "light_product_specular", "vec4", "light_sources[0].specular*material.specular", "!g" },
70 { FRAGMENT, "reflect_sample", "vec4", "textureCube(environment, env_reflect_dir)", 0 },
71 { FRAGMENT, "env_reflect_dir", "vec3", "env_eye_matrix*eye_reflect_dir", 0 },
72 { FRAGMENT, "eye_reflect_dir", "vec3", "eye_tbn_matrix*tbn_reflect_dir", "n" },
73 { FRAGMENT, "zzz_reflect_dir", "vec3", "reflect(zzz_incident_dir, n_zzz_normal)", 0 },
74 { FRAGMENT, "l_shadow", "float", "mix(1.0, shadow_sample, shadow_darkness)", 0 },
75 { FRAGMENT, "shadow_sample", "float", "shadow2D(shadow, shd_vertex).r", 0 },
76 { FRAGMENT, "l_diffuse", "float", "max(dot(n_zzz_normal, n_zzz_light_dir), 0.0)", 0 },
77 { FRAGMENT, "l_specular", "float", "pow(max(dot(n_zzz_half_vec, n_zzz_normal), 0.0), material.shininess)", 0 },
78 { FRAGMENT, "n_zzz_half_vec", "vec3", "normalize(zzz_light_dir-zzz_incident_dir)", 0 },
79 { FRAGMENT, "n_zzz_light_dir", "vec3", "normalize(zzz_light_dir)", 0 },
80 { FRAGMENT, "n_tbn_normal", "vec3", "normal_sample*2.0-1.0", "n" },
81 { FRAGMENT, "n_eye_normal", "vec3", "normalize(eye_normal)", "!n" },
82 { FRAGMENT, "normal_sample", "vec3", "texture2D(normalmap, texture_coord).xyz", 0 },
83 { FRAGMENT, "tex_sample", "vec4", "texture2D(texture, texture_coord)", 0 },
85 { VERTEX, "gl_Position", "vec4", "projection_matrix*eye_vertex", 0 },
86 { VERTEX, "shd_vertex", "vec3", "vec3(dot(eye_vertex, gl_EyePlaneS[shadow_unit]), dot(eye_vertex, gl_EyePlaneT[shadow_unit]), dot(eye_vertex, gl_EyePlaneR[shadow_unit]))", "g" },
87 { VERTEX, "shd_vertex", "vec3", "(shd_eye_matrix*eye_vertex).xyz", "!g" },
88 { VERTEX, "tbn_light_dir", "vec3", "eye_light_dir*eye_tbn_matrix", 0 },
89 { VERTEX, "eye_light_dir", "vec3", "normalize(eye_light_position.xyz-eye_vertex.xyz*eye_light_position.w)", 0 },
90 { VERTEX, "eye_light_position", "vec4", "light_sources[0].position", 0 },
91 { VERTEX, "tbn_incident_dir", "vec3", "eye_incident_dir*eye_tbn_matrix", 0 },
92 { VERTEX, "eye_incident_dir", "vec3", "normalize(eye_vertex.xyz)", 0 },
93 { VERTEX, "eye_tbn_matrix", "mat3", "mat3(eye_tangent, eye_binormal, eye_normal)", 0 },
94 { VERTEX, "eye_vertex", "vec4", "eye_obj_matrix*vertex", 0 },
95 { VERTEX, "eye_normal", "vec3", "eye_obj_normal_matrix*normal", 0 },
96 { VERTEX, "eye_tangent", "vec3", "eye_obj_normal_matrix*tangent", 0 },
97 { VERTEX, "eye_binormal", "vec3", "eye_obj_normal_matrix*binormal", 0 },
98 { VERTEX, "texture_coord", "vec2", "texcoord.xy", 0 },
100 { ATTRIBUTE, "vertex", "vec4", "gl_Vertex", 0 },
101 { ATTRIBUTE, "texcoord", "vec4", "gl_MultiTexCoord0", 0 },
102 { ATTRIBUTE, "color", "vec4", "gl_Color", 0 },
103 { ATTRIBUTE, "normal", "vec3", "gl_Normal", 0 },
104 { ATTRIBUTE, "tangent", "vec3", 0, 0 },
105 { ATTRIBUTE, "binormal", "vec3", 0, 0 },
107 { UNIFORM, "shadow_unit", "int", 0, 0 },
108 { UNIFORM, "texture", "sampler2D", 0, 0 },
109 { UNIFORM, "shadow", "sampler2DShadow", 0, 0 },
110 { UNIFORM, "shadow_darkness", "float", 0, 0 },
111 { UNIFORM, "normalmap", "sampler2D", 0, 0 },
112 { UNIFORM, "environment", "samplerCube", 0, 0 },
113 { UNIFORM, "env_eye_matrix", "mat3", 0, 0 },
114 { UNIFORM, "reflectivity", "float", 0, 0 },
115 { UNIFORM, "eye_obj_matrix", "mat4", "gl_ModelViewMatrix", 0 },
116 { UNIFORM, "eye_obj_normal_matrix", "mat3", "gl_NormalMatrix", 0 },
117 { UNIFORM, "projection_matrix", "mat4", "gl_ProjectionMatrix", 0 },
118 { UNIFORM, "shd_eye_matrix", "mat4", 0, 0 },
119 { UNIFORM, "light_sources", "struct { vec4 position; vec4 diffuse; vec4 specular; }[2]", "gl_LightSource", 0 },
120 { UNIFORM, "ambient_color", "vec4", 0, 0 },
121 { UNIFORM, "material", "struct { vec4 ambient; vec4 diffuse; vec4 specular; float shininess; }", "gl_FrontMaterial", 0 },
124 { NO_SCOPE, 0, 0, 0, 0 }
127 const char ProgramBuilder::interfaces[] = { 0, 0, 0, 'v', 0 };
129 ProgramBuilder::ProgramBuilder(const StandardFeatures &f):
131 feature_flags(features.create_flags()),
134 if(!features.custom.empty())
136 const char *whitespace = " \t\n";
137 string::size_type start = 0;
140 start = features.custom.find_first_not_of(whitespace, start);
141 if(start==string::npos)
144 string::size_type semicolon = features.custom.find(';', start);
150 else if(semicolon==string::npos)
151 throw invalid_variable_definition(features.custom.substr(start));
153 string::size_type equals = features.custom.find('=', start);
155 equals = string::npos;
157 VariableDefinition var;
158 string::size_type decl_end = min(equals, semicolon);
159 for(unsigned i=0;; ++i)
161 string::size_type word_end = features.custom.find_first_of(whitespace, start);
162 word_end = min(word_end, decl_end);
163 features.custom[word_end] = 0;
165 const char *word = &features.custom[start];
168 if(!strcmp(word, "uniform"))
170 else if(!strcmp(word, "attribute"))
171 var.scope = ATTRIBUTE;
172 else if(!strcmp(word, "vertex"))
174 else if(!strcmp(word, "fragment"))
175 var.scope = FRAGMENT;
177 throw invalid_variable_definition(word);
184 start = features.custom.find_first_not_of(whitespace, word_end+1);
189 if(equals!=string::npos)
191 start = features.custom.find_first_not_of(whitespace, equals+1);
193 throw invalid_variable_definition("no expression");
194 features.custom[semicolon] = 0;
195 var.expression = &features.custom[start];
201 for(const VariableDefinition *j=standard_variables; j->name; ++j)
202 if(!strcmp(var.name, j->name))
205 custom_variables.push_front(var);
212 void ProgramBuilder::set_optimize(bool o)
217 Program *ProgramBuilder::create_program() const
219 Program *prog = new Program;
224 void ProgramBuilder::add_shaders(Program &prog) const
226 list<ShaderVariable> variables;
227 list<ShaderVariable *> resolved_vars;
229 variables.push_front(ShaderVariable("gl_Position"));
230 variables.push_front(ShaderVariable(features.legacy ? "gl_FragColor" : "frag_color"));
232 list<VariableDefinition>::const_iterator next_custom = custom_variables.begin();
233 for(const VariableDefinition *i=standard_variables; i->name; )
235 const VariableDefinition *def = 0;
236 if(next_custom!=custom_variables.end() && (!strcmp(next_custom->name, i->name) || !next_custom->flags))
246 // Skip over anything that isn't used with the supplied flags
247 if(def->flags && !evaluate_flags(def->flags))
251 // See if this variable can satisfy any unresolved variables
252 ShaderVariable *last_resolved = 0;
253 for(list<ShaderVariable>::iterator j=variables.begin(); j!=variables.end(); ++j)
258 if(!name_match(def->name, j->resolved_name.c_str()))
263 /* We've already resolved a non-fuzzy variable in this iteration.
264 If there are multiple variables that can be resolved, they refer
265 to the same variable. */
266 j->resolve(*last_resolved);
271 resolved_vars.push_front(&*j);
278 vector<string> identifiers = extract_identifiers(def->expression);
279 for(vector<string>::const_iterator k=identifiers.begin(); k!=identifiers.end(); ++k)
281 // Use an existing variable if possible, but only if it's not fuzzy
282 ShaderVariable *var = 0;
283 for(list<ShaderVariable>::iterator l=variables.begin(); (!var && l!=variables.end()); ++l)
284 if(!l->fuzzy_space && l->resolved_name==*k)
289 variables.push_back(ShaderVariable(*k));
290 var = &variables.back();
292 j->add_reference(*var);
297 for(list<ShaderVariable *>::const_iterator i=resolved_vars.begin(); i!=resolved_vars.end(); ++i)
298 (*i)->check_inline(features.legacy, !optimize);
300 prog.attach_shader_owned(new VertexShader(create_source(resolved_vars, VERTEX)));
301 prog.attach_shader_owned(new FragmentShader(create_source(resolved_vars, FRAGMENT)));
305 prog.bind_fragment_data(0, "frag_color");
306 prog.bind_attribute(VERTEX4, "vertex");
307 if(features.lighting)
308 prog.bind_attribute(NORMAL3, "normal");
309 else if(features.material)
310 prog.bind_attribute(COLOR4_FLOAT, "color");
311 if(features.texture || features.normalmap)
312 prog.bind_attribute(TEXCOORD4, "texcoord");
314 if(features.normalmap)
316 prog.bind_attribute(get_component_type(TANGENT3), "tangent");
317 prog.bind_attribute(get_component_type(BINORMAL3), "binormal");
321 string ProgramBuilder::create_source(const list<ShaderVariable *> &variables, VariableScope scope) const
326 source += "#version 130\n";
328 for(list<ShaderVariable *>::const_iterator i=variables.begin(); i!=variables.end(); ++i)
329 if((*i)->variable->scope==UNIFORM && (*i)->is_referenced_from(scope) && !(*i)->inlined)
330 source += format("uniform %s;\n", (*i)->create_declaration());
332 /* Interface variables need to have global declarations. */
333 for(list<ShaderVariable *>::const_iterator i=variables.begin(); i!=variables.end(); ++i)
335 if(!(*i)->resolved_name.compare(0, 3, "gl_"))
338 InterfaceFlags interface = (*i)->get_interface_flags(scope);
342 const char *qualifier = (features.legacy ? scope==VERTEX ? "attribute" : "varying" : "in");
343 source += format("%s %s;\n", qualifier, (*i)->create_declaration(interfaces[scope-1]));
348 const char *qualifier = (features.legacy ? "varying" : "out");
349 source += format("%s %s;\n", qualifier, (*i)->create_declaration(interfaces[scope]));
353 source += "void main()\n{\n";
355 for(list<ShaderVariable *>::const_iterator i=variables.begin(); i!=variables.end(); ++i)
357 InterfaceFlags interface = (*i)->get_interface_flags(scope);
359 if((*i)->variable->scope==scope && !(*i)->inlined)
361 string decl = ((interface&GOAL) ? (*i)->resolved_name : (*i)->create_declaration());
362 source += format("\t%s = %s;\n", decl, (*i)->create_expression());
365 if((interface&(OUTPUT|GOAL))==OUTPUT)
367 string expr = ((*i)->inlined ? (*i)->create_expression() : (*i)->resolved_name);
368 source += format("\t%c_%s = %s;\n", interfaces[scope], (*i)->resolved_name, expr);
377 bool ProgramBuilder::evaluate_flags(const char *flags) const
384 for(const char *i=flags; *i; ++i)
386 if(*i>='a' && *i<='z')
388 bool found = (feature_flags.find(*i)!=string::npos);
390 cond = (cond || found);
392 cond = (cond && !found);
394 cond = (cond && found);
404 ProgramBuilder::MatchLevel ProgramBuilder::name_match(const char *n1, const char *n2, const char **space)
411 if(*n1==*n2 || *n1=='z' || *n2=='z')
415 int side = (*n1=='z' ? 1 : 2);
428 else if(i>=zzz+3 || side!=zside)
438 return (!*n1 && !*n2) ? zzz>=0 ? FUZZY : EXACT : NO_MATCH;
441 bool ProgramBuilder::parse_identifier(const char *ptr, unsigned &start, unsigned &length)
445 for(const char *i=ptr;; ++i)
451 if(isalpha(*i) || *i=='_')
466 if(!isalnum(*i) && *i!='_')
468 length = i-(ptr+start);
475 vector<string> ProgramBuilder::extract_identifiers(const char *expression)
477 vector<string> result;
478 const char *ptr = expression;
481 while(parse_identifier(ptr, start, length))
483 result.push_back(string(ptr+start, length));
489 string ProgramBuilder::replace_identifiers(const char *expression, const map<string, string> &replace_map)
492 const char *ptr = expression;
495 while(parse_identifier(ptr, start, length))
497 result.append(ptr, start);
498 string identifier(ptr+start, length);
499 map<string, string>::const_iterator i = replace_map.find(identifier);
500 if(i!=replace_map.end())
503 result += identifier;
511 ProgramBuilder::StandardFeatures::StandardFeatures():
519 legacy(!(get_glsl_version()>=Version(1, 30)))
522 string ProgramBuilder::StandardFeatures::create_flags() const
548 ProgramBuilder::ShaderVariable::ShaderVariable(const std::string &n):
552 fuzzy_space(name.find("zzz")!=string::npos),
557 void ProgramBuilder::ShaderVariable::resolve(const VariableDefinition &var)
560 const char *space = 0;
561 if(name_match(var.name, resolved_name.c_str(), &space)==FUZZY)
562 resolve_space(string(space, 3));
566 void ProgramBuilder::ShaderVariable::resolve(ShaderVariable &var)
568 for(list<ShaderVariable *>::iterator i=referenced_by.begin(); i!=referenced_by.end(); ++i)
569 (*i)->update_reference(*this, var);
570 var.referenced_by.insert(var.referenced_by.end(), referenced_by.begin(), referenced_by.end());
573 void ProgramBuilder::ShaderVariable::resolve_space(const string &space)
577 resolved_space = space;
579 string::size_type zzz = resolved_name.find("zzz");
580 resolved_name.replace(zzz, 3, resolved_space);
583 // Resolving the space could have affected other variables that use this one
584 for(list<ShaderVariable *>::iterator i=referenced_by.begin(); i!=referenced_by.end(); ++i)
585 (*i)->resolve_space(space);
588 for(list<ShaderVariable *>::iterator i=referenced_vars.begin(); i!=referenced_vars.end(); ++i)
589 if((*i)->fuzzy_space)
590 (*i)->resolve_space(space);
593 void ProgramBuilder::ShaderVariable::add_reference(ShaderVariable &var)
595 referenced_vars.push_back(&var);
596 var.referenced_by.push_back(this);
597 if(var.fuzzy_space && !resolved_space.empty())
598 var.resolve_space(resolved_space);
601 void ProgramBuilder::ShaderVariable::update_reference(ShaderVariable &from, ShaderVariable &to)
603 replace(referenced_vars.begin(), referenced_vars.end(), &from, &to);
604 replace(referenced_by.begin(), referenced_by.end(), &from, &to);
605 if(from.fuzzy_space && !to.fuzzy_space && !to.resolved_space.empty())
606 resolve_space(to.resolved_space);
609 void ProgramBuilder::ShaderVariable::check_inline(bool allow_legacy, bool trivial_only)
611 if(variable->expression)
613 if(!allow_legacy && !strncmp(variable->expression, "gl_", 3))
616 // Never inline goal variables
617 unsigned total_refs = referenced_by.size();
621 // Inline an expression consisting of a single identifier
622 unsigned start, length;
623 if(parse_identifier(variable->expression, start, length))
624 if(start==0 && variable->expression[length]==0)
633 unsigned in_scope_refs = 0;
634 for(list<ShaderVariable *>::const_iterator i=referenced_by.begin(); i!=referenced_by.end(); ++i)
635 if((*i)->variable->scope==variable->scope)
638 /* Inline if there's only one ref, or if all refs are in other scopes.
639 In the latter case, the actual inlining will happen in the interface
640 variable assignment. */
641 if(total_refs==1 || in_scope_refs==0)
645 for(const char *c=variable->expression; (!inline_parens && *c); ++c)
651 else if(level==0 && !isalnum(*c) && *c!='_' && *c!='.')
652 inline_parens = true;
658 bool ProgramBuilder::ShaderVariable::is_referenced_from(VariableScope scope) const
660 for(list<ShaderVariable *>::const_iterator i=referenced_by.begin(); i!=referenced_by.end(); ++i)
661 if((*i)->variable->scope==scope)
666 ProgramBuilder::InterfaceFlags ProgramBuilder::ShaderVariable::get_interface_flags(VariableScope scope) const
668 /* Uniforms are available to all stages and are not passed through
670 if(variable->scope==UNIFORM)
673 int flags = NO_INTERFACE;
675 for(list<ShaderVariable *>::const_iterator i=referenced_by.begin(); i!=referenced_by.end(); ++i)
677 /* Variables used in a later scope than they are declared in need to go
678 through the interface */
679 if((*i)->variable->scope>scope && variable->scope<=scope)
681 if((*i)->variable->scope>=scope && variable->scope<scope)
682 if(!inlined || variable->scope!=ATTRIBUTE || scope!=VERTEX)
686 // Variables without any references are goals and also outputs.
687 if(referenced_by.empty() && variable->scope==scope)
688 flags |= OUTPUT|GOAL;
690 return static_cast<InterfaceFlags>(flags);
693 string ProgramBuilder::ShaderVariable::create_declaration(char interface) const
695 if(variable->scope==UNIFORM)
697 const char *bracket = strrchr(variable->type, '[');
699 return format("%s %s%s", string(variable->type, bracket), resolved_name, bracket);
703 return format("%s %c_%s", variable->type, interface, resolved_name);
705 return format("%s %s", variable->type, resolved_name);
708 string ProgramBuilder::ShaderVariable::create_replacement(VariableScope from_scope) const
710 string replacement = resolved_name;
713 InterfaceFlags interface = get_interface_flags(from_scope);
714 if((interface&INPUT) && interfaces[from_scope-1])
715 replacement = format("%c_%s", interfaces[from_scope-1], replacement);
718 replacement = create_expression();
720 replacement = "("+replacement+")";
727 string ProgramBuilder::ShaderVariable::create_expression() const
729 map<string, string> replace_map;
730 for(list<ShaderVariable *>::const_iterator i=referenced_vars.begin(); i!=referenced_vars.end(); ++i)
732 string replacement = (*i)->create_replacement(variable->scope);
733 if(replacement!=(*i)->name)
734 replace_map[(*i)->name] = replacement;
737 if(replace_map.empty())
738 return variable->expression;
740 return replace_identifiers(variable->expression, replace_map);
744 ProgramBuilder::StandardFeatures::Loader::Loader(StandardFeatures &f):
745 DataFile::ObjectLoader<StandardFeatures>(f)
747 add("custom", &StandardFeatures::custom);
748 add("lighting", &StandardFeatures::lighting);
749 add("material", &StandardFeatures::material);
750 add("normalmap", &StandardFeatures::normalmap);
751 add("reflection", &StandardFeatures::reflection);
752 add("shadow", &StandardFeatures::shadow);
753 add("specular", &StandardFeatures::specular);
754 add("texture", &StandardFeatures::texture);