forked from AcademySoftwareFoundation/MaterialX
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ShaderGenerator.cpp
463 lines (400 loc) · 13.9 KB
/
ShaderGenerator.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
//
// TM & (c) 2017 Lucasfilm Entertainment Company Ltd. and Lucasfilm Ltd.
// All rights reserved. See LICENSE.txt for license.
//
#include <MaterialXGenShader/ShaderGenerator.h>
#include <MaterialXGenShader/GenContext.h>
#include <MaterialXGenShader/ShaderNodeImpl.h>
#include <MaterialXGenShader/Nodes/CompoundNode.h>
#include <MaterialXGenShader/Nodes/SourceCodeNode.h>
#include <MaterialXGenShader/Nodes/ClosureCompoundNode.h>
#include <MaterialXGenShader/Nodes/ClosureSourceCodeNode.h>
#include <MaterialXGenShader/Util.h>
#include <MaterialXFormat/File.h>
#include <MaterialXCore/Document.h>
#include <MaterialXCore/Node.h>
#include <MaterialXCore/Value.h>
#include <sstream>
MATERIALX_NAMESPACE_BEGIN
const string ShaderGenerator::T_FILE_TRANSFORM_UV = "$fileTransformUv";
//
// ShaderGenerator methods
//
ShaderGenerator::ShaderGenerator(SyntaxPtr syntax) :
_syntax(syntax)
{
}
void ShaderGenerator::emitScopeBegin(ShaderStage& stage, Syntax::Punctuation punc) const
{
stage.beginScope(punc);
}
void ShaderGenerator::emitScopeEnd(ShaderStage& stage, bool semicolon, bool newline) const
{
stage.endScope(semicolon, newline);
}
void ShaderGenerator::emitLineBegin(ShaderStage& stage) const
{
stage.beginLine();
}
void ShaderGenerator::emitLineEnd(ShaderStage& stage, bool semicolon) const
{
stage.endLine(semicolon);
}
void ShaderGenerator::emitLineBreak(ShaderStage& stage) const
{
stage.newLine();
}
void ShaderGenerator::emitString(const string& str, ShaderStage& stage) const
{
stage.addString(str);
}
void ShaderGenerator::emitLine(const string& str, ShaderStage& stage, bool semicolon) const
{
stage.addLine(str, semicolon);
}
void ShaderGenerator::emitComment(const string& str, ShaderStage& stage) const
{
stage.addComment(str);
}
void ShaderGenerator::emitBlock(const string& str, const FilePath& sourceFilename, GenContext& context, ShaderStage& stage) const
{
stage.addBlock(str, sourceFilename, context);
}
void ShaderGenerator::emitLibraryInclude(const FilePath& filename, GenContext& context, ShaderStage& stage) const
{
FilePath libraryPrefix = context.getOptions().libraryPrefix;
FilePath fullFilename = libraryPrefix.isEmpty() ? filename : libraryPrefix / filename;
FilePath resolvedFilename = context.resolveSourceFile(fullFilename, FilePath());
stage.addInclude(fullFilename, resolvedFilename, context);
}
void ShaderGenerator::emitFunctionDefinition(const ShaderNode& node, GenContext& context, ShaderStage& stage) const
{
stage.addFunctionDefinition(node, context);
}
void ShaderGenerator::emitFunctionDefinitions(const ShaderGraph& graph, GenContext& context, ShaderStage& stage) const
{
// Emit function definitions for all nodes in the graph.
for (ShaderNode* node : graph.getNodes())
{
emitFunctionDefinition(*node, context, stage);
}
}
void ShaderGenerator::emitFunctionCall(const ShaderNode& node, GenContext& context, ShaderStage& stage,
bool checkScope) const
{
// Check if it's emitted already.
if (stage.isEmitted(node, context))
{
// emitComment("Omitted node '" + node.getName() + "'. Already called above.", stage);
return;
}
// Omit node if it's only used inside a conditional branch
if (checkScope && node.referencedConditionally())
{
emitComment("Omitted node '" + node.getName() + "'. Only used in conditional node '" +
node.getScopeInfo().conditionalNode->getName() + "'", stage);
return;
}
stage.addFunctionCall(node, context);
}
void ShaderGenerator::emitFunctionCalls(const ShaderGraph& graph, GenContext& context, ShaderStage& stage, uint32_t classification) const
{
for (ShaderNode* node : graph.getNodes())
{
if (!classification || node->hasClassification(classification))
{
emitFunctionCall(*node, context, stage);
}
}
}
void ShaderGenerator::emitDependentFunctionCalls(const ShaderNode& node, GenContext& context, ShaderStage& stage, uint32_t classification) const
{
for (ShaderInput* input : node.getInputs())
{
const ShaderNode* upstream = input->getConnectedSibling();
if (upstream && (!classification || upstream->hasClassification(classification)))
{
emitFunctionCall(*upstream, context, stage);
}
}
}
void ShaderGenerator::emitFunctionBodyBegin(const ShaderNode&, GenContext&, ShaderStage& stage, Syntax::Punctuation punc) const
{
emitScopeBegin(stage, punc);
}
void ShaderGenerator::emitFunctionBodyEnd(const ShaderNode&, GenContext&, ShaderStage& stage) const
{
emitScopeEnd(stage);
emitLineBreak(stage);
}
void ShaderGenerator::emitTypeDefinitions(GenContext&, ShaderStage& stage) const
{
// Emit typedef statements for all data types that have an alias
for (const auto& syntax : _syntax->getTypeSyntaxes())
{
if (!syntax->getTypeAlias().empty())
{
stage.addLine("#define " + syntax->getName() + " " + syntax->getTypeAlias(), false);
}
if (!syntax->getTypeDefinition().empty())
{
stage.addLine(syntax->getTypeDefinition(), false);
}
}
stage.newLine();
}
void ShaderGenerator::emitVariableDeclaration(const ShaderPort* variable, const string& qualifier,
GenContext&, ShaderStage& stage,
bool assignValue) const
{
string str = qualifier.empty() ? EMPTY_STRING : qualifier + " ";
str += _syntax->getTypeName(variable->getType());
bool haveArray = variable->getType()->isArray() && variable->getValue();
if (haveArray)
{
str += _syntax->getArrayTypeSuffix(variable->getType(), *variable->getValue());
}
str += " " + variable->getVariable();
// If an array we need an array qualifier (suffix) for the variable name
if (haveArray)
{
str += _syntax->getArrayVariableSuffix(variable->getType(), *variable->getValue());
}
if (assignValue)
{
const string valueStr = (variable->getValue() ?
_syntax->getValue(variable->getType(), *variable->getValue(), true) :
_syntax->getDefaultValue(variable->getType(), true));
str += valueStr.empty() ? EMPTY_STRING : " = " + valueStr;
}
stage.addString(str);
}
void ShaderGenerator::emitVariableDeclarations(const VariableBlock& block, const string& qualifier, const string& separator,
GenContext& context, ShaderStage& stage,
bool assignValue) const
{
for (size_t i=0; i<block.size(); ++i)
{
emitLineBegin(stage);
emitVariableDeclaration(block[i], qualifier, context, stage, assignValue);
emitString(separator, stage);
emitLineEnd(stage, false);
}
}
void ShaderGenerator::emitInput(const ShaderInput* input, GenContext& context, ShaderStage& stage) const
{
stage.addString(getUpstreamResult(input, context));
}
void ShaderGenerator::emitOutput(const ShaderOutput* output, bool includeType, bool assignValue, GenContext& context, ShaderStage& stage) const
{
stage.addString(includeType ? _syntax->getTypeName(output->getType()) + " " + output->getVariable() : output->getVariable());
// Look for any additional suffix to append
string suffix;
context.getOutputSuffix(output, suffix);
if (!suffix.empty())
{
stage.addString(suffix);
}
if (assignValue)
{
const string& value = _syntax->getDefaultValue(output->getType());
if (!value.empty())
{
stage.addString(" = " + value);
}
}
}
void ShaderGenerator::getClosureContexts(const ShaderNode&, vector<ClosureContext*>&) const
{
}
string ShaderGenerator::getUpstreamResult(const ShaderInput* input, GenContext& context) const
{
if (!input->getConnection())
{
return input->getValue() ? _syntax->getValue(input->getType(), *input->getValue()) : _syntax->getDefaultValue(input->getType());
}
string variable = input->getConnection()->getVariable();
if (!input->getChannels().empty())
{
variable = _syntax->getSwizzledVariable(variable, input->getConnection()->getType(), input->getChannels(), input->getType());
}
// Look for any additional suffix to append
string suffix;
context.getInputSuffix(input, suffix);
if (!suffix.empty())
{
variable += suffix;
}
return variable;
}
void ShaderGenerator::registerImplementation(const string& name, CreatorFunction<ShaderNodeImpl> creator)
{
_implFactory.registerClass(name, creator);
}
bool ShaderGenerator::implementationRegistered(const string& name) const
{
return _implFactory.classRegistered(name);
}
ShaderNodeImplPtr ShaderGenerator::getImplementation(const NodeDef& nodedef, GenContext& context) const
{
InterfaceElementPtr implElement = nodedef.getImplementation(getTarget());
if (!implElement)
{
return nullptr;
}
const string& name = implElement->getName();
// Check if it's created and cached already.
ShaderNodeImplPtr impl = context.findNodeImplementation(name);
if (impl)
{
return impl;
}
vector<OutputPtr> outputs = nodedef.getActiveOutputs();
if (outputs.empty())
{
throw ExceptionShaderGenError("NodeDef '" + nodedef.getName() + "' has no outputs defined");
}
const TypeDesc* outputType = TypeDesc::get(outputs[0]->getType());
if (implElement->isA<NodeGraph>())
{
// Use a compound implementation.
if (outputType->isClosure())
{
impl = ClosureCompoundNode::create();
}
else
{
impl = CompoundNode::create();
}
}
else if (implElement->isA<Implementation>())
{
// Try creating a new in the factory.
impl = _implFactory.create(name);
if (!impl)
{
// Fall back to source code implementation.
if (outputType->isClosure())
{
impl = ClosureSourceCodeNode::create();
}
else
{
impl = SourceCodeNode::create();
}
}
}
if (!impl)
{
return nullptr;
}
impl->initialize(*implElement, context);
// Cache it.
context.addNodeImplementation(name, impl);
return impl;
}
namespace
{
void replace(const StringMap& substitutions, ShaderPort* port)
{
string name = port->getName();
tokenSubstitution(substitutions, name);
port->setName(name);
string variable = port->getVariable();
tokenSubstitution(substitutions, variable);
port->setVariable(variable);
}
}
void ShaderGenerator::registerShaderMetadata(const DocumentPtr& doc, GenContext& context) const
{
ShaderMetadataRegistryPtr registry = context.getUserData<ShaderMetadataRegistry>(ShaderMetadataRegistry::USER_DATA_NAME);
if (!registry)
{
registry = std::make_shared<ShaderMetadataRegistry>();
context.pushUserData(ShaderMetadataRegistry::USER_DATA_NAME, registry);
}
// Add default entries.
ShaderMetadataVec defaultMetadata =
{
ShaderMetadata(ValueElement::UI_NAME_ATTRIBUTE, Type::STRING),
ShaderMetadata(ValueElement::UI_FOLDER_ATTRIBUTE, Type::STRING),
ShaderMetadata(ValueElement::UI_MIN_ATTRIBUTE, nullptr),
ShaderMetadata(ValueElement::UI_MAX_ATTRIBUTE, nullptr),
ShaderMetadata(ValueElement::UI_SOFT_MIN_ATTRIBUTE, nullptr),
ShaderMetadata(ValueElement::UI_SOFT_MAX_ATTRIBUTE, nullptr),
ShaderMetadata(ValueElement::UI_STEP_ATTRIBUTE, nullptr),
ShaderMetadata(ValueElement::UI_ADVANCED_ATTRIBUTE, Type::BOOLEAN),
ShaderMetadata(ValueElement::DOC_ATTRIBUTE, Type::STRING),
ShaderMetadata(ValueElement::UNIT_ATTRIBUTE, Type::STRING),
ShaderMetadata(ValueElement::COLOR_SPACE_ATTRIBUTE, Type::STRING)
};
for (auto data : defaultMetadata)
{
registry->addMetadata(data.name, data.type);
}
// Add entries from AttributeDefs in the document.
vector<AttributeDefPtr> attributeDefs = doc->getAttributeDefs();
for (const AttributeDefPtr& def : attributeDefs)
{
if (def->getExportable())
{
const string& attrName = def->getAttrName();
const TypeDesc* type = TypeDesc::get(def->getType());
if (!attrName.empty() && type)
{
registry->addMetadata(attrName, type, def->getValue());
}
}
}
}
void ShaderGenerator::replaceTokens(const StringMap& substitutions, ShaderStage& stage) const
{
// Replace tokens in source code
tokenSubstitution(substitutions, stage._code);
// Replace tokens on shader interface
for (size_t i = 0; i < stage._constants.size(); ++i)
{
replace(substitutions, stage._constants[i]);
}
for (const auto& it : stage._uniforms)
{
VariableBlock& uniforms = *it.second;
for (size_t i = 0; i < uniforms.size(); ++i)
{
replace(substitutions, uniforms[i]);
}
}
for (const auto& it : stage._inputs)
{
VariableBlock& inputs = *it.second;
for (size_t i = 0; i < inputs.size(); ++i)
{
replace(substitutions, inputs[i]);
}
}
for (const auto& it : stage._outputs)
{
VariableBlock& outputs = *it.second;
for (size_t i = 0; i < outputs.size(); ++i)
{
replace(substitutions, outputs[i]);
}
}
}
ShaderStagePtr ShaderGenerator::createStage(const string& name, Shader& shader) const
{
return shader.createStage(name, _syntax);
}
void ShaderGenerator::createVariables(ShaderGraphPtr graph, GenContext& context, Shader& shader) const
{
ApplicationVariableHandler handler = context.getApplicationVariableHandler();
for (ShaderNode* node : graph->getNodes())
{
if (handler)
{
handler(node, context);
}
node->getImplementation().createVariables(*node, context, shader);
}
}
MATERIALX_NAMESPACE_END