This repository was archived by the owner on Dec 9, 2022. It is now read-only.
forked from MrKepzie/Natron
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathNodeGroupSerialization.cpp
More file actions
391 lines (333 loc) · 20 KB
/
NodeGroupSerialization.cpp
File metadata and controls
391 lines (333 loc) · 20 KB
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
/* ***** BEGIN LICENSE BLOCK *****
* This file is part of Natron <http://www.natron.fr/>,
* Copyright (C) 2015 INRIA and Alexandre Gauthier-Foichat
*
* Natron is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* Natron is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Natron. If not, see <http://www.gnu.org/licenses/gpl-2.0.html>
* ***** END LICENSE BLOCK ***** */
// ***** BEGIN PYTHON BLOCK *****
// from <https://docs.python.org/3/c-api/intro.html#include-files>:
// "Since Python may define some pre-processor definitions which affect the standard headers on some systems, you must include Python.h before any standard headers are included."
#include <Python.h>
// ***** END PYTHON BLOCK *****
#include "NodeGroupSerialization.h"
#include <QFileInfo>
#include "Engine/AppManager.h"
#include "Engine/Settings.h"
#include "Engine/AppInstance.h"
#include "Engine/NodeGroup.h"
#include "Engine/ViewerInstance.h"
#include <SequenceParsing.h>
void
NodeCollectionSerialization::initialize(const NodeCollection& group)
{
NodeList nodes;
group.getActiveNodes(&nodes);
_serializedNodes.clear();
for (NodeList::iterator it = nodes.begin(); it != nodes.end() ; ++it) {
if (!(*it)->getParentMultiInstance()) {
boost::shared_ptr<NodeSerialization> state(new NodeSerialization(*it));
_serializedNodes.push_back(state);
}
}
}
bool
NodeCollectionSerialization::restoreFromSerialization(const std::list< boost::shared_ptr<NodeSerialization> > & serializedNodes,
const boost::shared_ptr<NodeCollection>& group,
bool createNodes,
std::map<std::string,bool>* moduleUpdatesProcessed,
bool* hasProjectAWriter)
{
bool mustShowErrorsLog = false;
NodeGroup* isNodeGroup = dynamic_cast<NodeGroup*>(group.get());
QString groupName;
if (isNodeGroup) {
groupName = isNodeGroup->getNode()->getLabel().c_str();
} else {
groupName = QObject::tr("top-level");
}
group->getApplication()->updateProjectLoadStatus(QObject::tr("Creating nodes in group: ") + groupName);
///If a parent of a multi-instance node doesn't exist anymore but the children do, we must recreate the parent.
///Problem: we have lost the nodes connections. To do so we restore them using the serialization of a child.
///This map contains all the parents that must be reconnected and an iterator to the child serialization
std::map<boost::shared_ptr<Natron::Node>, std::list<boost::shared_ptr<NodeSerialization> >::const_iterator > parentsToReconnect;
for (std::list< boost::shared_ptr<NodeSerialization> >::const_iterator it = serializedNodes.begin(); it != serializedNodes.end(); ++it) {
std::string pluginID = (*it)->getPluginID();
if ( appPTR->isBackground() && (pluginID == PLUGINID_NATRON_VIEWER || pluginID == "Viewer") ) {
//if the node is a viewer, don't try to load it in background mode
continue;
}
///If the node is a multiinstance child find in all the serialized nodes if the parent exists.
///If not, create it
if ( !(*it)->getMultiInstanceParentName().empty() ) {
bool foundParent = false;
for (std::list< boost::shared_ptr<NodeSerialization> >::const_iterator it2 = serializedNodes.begin();
it2 != serializedNodes.end(); ++it2) {
if ( (*it2)->getNodeScriptName() == (*it)->getMultiInstanceParentName() ) {
foundParent = true;
break;
}
}
if (!foundParent) {
///Maybe it was created so far by another child who created it so look into the nodes
NodePtr parent = group->getNodeByName((*it)->getMultiInstanceParentName());
if (parent) {
foundParent = true;
}
///Create the parent
if (!foundParent) {
boost::shared_ptr<Natron::Node> parent = group->getApplication()->createNode(CreateNodeArgs( pluginID.c_str(),
"",
(*it)->getPluginMajorVersion(),
(*it)->getPluginMinorVersion(),
true,
INT_MIN,
INT_MIN,
false,
true,
false,
QString(),
CreateNodeArgs::DefaultValuesList(),
group));
parent->setScriptName( (*it)->getMultiInstanceParentName().c_str() );
parentsToReconnect.insert( std::make_pair(parent, it) );
}
}
}
const std::string& pythonModuleAbsolutePath = (*it)->getPythonModule();
boost::shared_ptr<Natron::Node> n;
bool usingPythonModule = false;
if (!pythonModuleAbsolutePath.empty()) {
unsigned int savedPythonModuleVersion = (*it)->getPythonModuleVersion();
QString qPyModulePath(pythonModuleAbsolutePath.c_str());
//Workaround a bug introduced in Natron where we were not saving the .py extension
if (!qPyModulePath.endsWith(".py")) {
qPyModulePath.append(".py");
}
///The path that has been saved in the project might not be corresponding on this computer.
///We need to search through all search paths for a match
std::string pythonModuleUnPathed = qPyModulePath.toStdString();
std::string s = SequenceParsing::removePath(pythonModuleUnPathed);
Q_UNUSED(s);
qPyModulePath.clear();
QStringList natronPaths = appPTR->getAllNonOFXPluginsPaths();
for (int i = 0; i < natronPaths.size(); ++i) {
QString path = natronPaths[i];
if (!path.endsWith("/")) {
path.append('/');
}
path.append(pythonModuleUnPathed.c_str());
if (QFile::exists(path)) {
qPyModulePath = path;
break;
}
}
//This is a python group plug-in, try to find the corresponding .py file, maybe a more recent version of the plug-in exists.
QFileInfo pythonModuleInfo(qPyModulePath);
if (pythonModuleInfo.exists() && appPTR->getCurrentSettings()->isLoadFromPyPlugsEnabled()) {
std::string pythonPluginID,pythonPluginLabel,pythonIcFilePath,pythonGrouping,pythonDesc;
unsigned int pyVersion;
QString pythonModuleName = pythonModuleInfo.fileName();
if (pythonModuleName.endsWith(".py")) {
pythonModuleName = pythonModuleName.remove(pythonModuleName.size() - 3, 3);
}
std::string stdModuleName = pythonModuleName.toStdString();
if (getGroupInfos(pythonModuleInfo.path().toStdString() + '/', stdModuleName, &pythonPluginID, &pythonPluginLabel, &pythonIcFilePath, &pythonGrouping, &pythonDesc, &pyVersion)) {
if (pyVersion != savedPythonModuleVersion) {
std::map<std::string,bool>::iterator found = moduleUpdatesProcessed->find(stdModuleName);
if (found != moduleUpdatesProcessed->end()) {
if (found->second) {
pluginID = pythonPluginID;
usingPythonModule = true;
}
} else {
Natron::StandardButtonEnum rep = Natron::questionDialog(QObject::tr("New PyPlug version").toStdString()
, QObject::tr("A different version of ").toStdString() +
stdModuleName + " (" +
QString::number(pyVersion).toStdString() + ") " +
QObject::tr("was found.\n").toStdString() +
QObject::tr("You are currently using version ").toStdString() +
QString::number(savedPythonModuleVersion).toStdString() + ".\n" +
QObject::tr("Would you like to update your script?").toStdString()
, false ,
Natron::StandardButtons(Natron::eStandardButtonYes | Natron::eStandardButtonNo));
if (rep == Natron::eStandardButtonYes) {
pluginID = pythonPluginID;
usingPythonModule = true;
}
moduleUpdatesProcessed->insert(std::make_pair(stdModuleName, rep == Natron::eStandardButtonYes));
}
} else {
pluginID = pythonPluginID;
usingPythonModule = true;
}
}
}
}
if (!createNodes) {
///We are in the case where we loaded a PyPlug: it probably created all the nodes in the group already but didn't
///load their serialization
n = group->getNodeByName((*it)->getNodeScriptName());
if (n) {
n->loadKnobs(**it);
}
}
unsigned int majorVersion,minorVersion;
if (usingPythonModule) {
//We already asked the user whether he/she wanted to load a newer version of the PyPlug, let the loadNode function accept it
majorVersion = -1;
minorVersion = -1;
} else {
majorVersion = (*it)->getPluginMajorVersion();
minorVersion = (*it)->getPluginMinorVersion();
}
if (!n) {
n = group->getApplication()->loadNode( LoadNodeArgs(pluginID.c_str()
,(*it)->getMultiInstanceParentName()
,majorVersion
,minorVersion,it->get(),false,group) );
}
if (!n) {
QString text( QObject::tr("ERROR: The node ") );
text.append( pluginID.c_str() );
text.append(QObject::tr(" version %1.%2").arg(majorVersion).arg(minorVersion));
text.append( QObject::tr(" was found in the script but does not"
" exist in the loaded plug-ins.") );
appPTR->writeToOfxLog_mt_safe(text);
mustShowErrorsLog = true;
continue;
} else {
if (n->getPlugin() && n->getPlugin()->getMajorVersion() != (int)majorVersion) {
QString text( QObject::tr("WARNING: The node ") );
text.append((*it)->getNodeScriptName().c_str());
text.append(" (");
text.append( pluginID.c_str() );
text.append(")");
text.append(QObject::tr(" version %1.%2").arg(majorVersion).arg(minorVersion));
text.append( QObject::tr(" was found in the script but was loaded"
" with version %3.%4 instead").arg(n->getPlugin()->getMajorVersion()).arg(n->getPlugin()->getMinorVersion()) );
appPTR->writeToOfxLog_mt_safe(text);
mustShowErrorsLog = true;
}
}
if ( n->isOutputNode() ) {
*hasProjectAWriter = true;
}
const std::list<boost::shared_ptr<NodeSerialization> >& children = (*it)->getNodesCollection();
if (!children.empty()) {
NodeGroup* isGrp = dynamic_cast<NodeGroup*>(n->getLiveInstance());
if (isGrp) {
boost::shared_ptr<Natron::EffectInstance> sharedEffect = isGrp->shared_from_this();
boost::shared_ptr<NodeGroup> sharedGrp = boost::dynamic_pointer_cast<NodeGroup>(sharedEffect);
NodeCollectionSerialization::restoreFromSerialization(children, sharedGrp ,!usingPythonModule, moduleUpdatesProcessed, hasProjectAWriter);
} else {
assert(n->isMultiInstance());
NodeCollectionSerialization::restoreFromSerialization(children, group, true, moduleUpdatesProcessed, hasProjectAWriter);
}
}
}
group->getApplication()->updateProjectLoadStatus(QObject::tr("Restoring graph links in group: ") + groupName);
NodeList nodes = group->getNodes();
/// Connect the nodes together, and restore the slave/master links for all knobs.
for (std::list< boost::shared_ptr<NodeSerialization> >::const_iterator it = serializedNodes.begin(); it != serializedNodes.end(); ++it) {
if ( appPTR->isBackground() && ((*it)->getPluginID() == PLUGINID_NATRON_VIEWER) ) {
//ignore viewers on background mode
continue;
}
boost::shared_ptr<Natron::Node> thisNode = group->getNodeByName((*it)->getNodeScriptName());
if (!thisNode) {
continue;
}
///for all nodes that are part of a multi-instance, fetch the main instance node pointer
const std::string & parentName = (*it)->getMultiInstanceParentName();
if ( !parentName.empty() ) {
thisNode->fetchParentMultiInstancePointer();
}
///restore slave/master link if any
const std::string & masterNodeName = (*it)->getMasterNodeName();
if ( !masterNodeName.empty() ) {
///find such a node
boost::shared_ptr<Natron::Node> masterNode = thisNode->getApp()->getNodeByFullySpecifiedName(masterNodeName);
if (!masterNode) {
appPTR->writeToOfxLog_mt_safe(QString("Cannot restore the link between " + QString((*it)->getNodeScriptName().c_str()) + " and " + masterNodeName.c_str()));
mustShowErrorsLog = true;
} else {
thisNode->getLiveInstance()->slaveAllKnobs( masterNode->getLiveInstance(), true );
}
}
thisNode->restoreKnobsLinks(**it,nodes);
const std::vector<std::string> & oldInputs = (*it)->getOldInputs();
if (!oldInputs.empty()) {
/*
* Prior to Natron v2 OpenFX effects had their inputs reversed internally
*/
bool isOfxEffect = thisNode->isOpenFXNode();
for (U32 j = 0; j < oldInputs.size(); ++j) {
if ( !oldInputs[j].empty() && !group->connectNodes(isOfxEffect ? oldInputs.size() - 1 - j : j, oldInputs[j],thisNode.get()) ) {
qDebug() << "Failed to connect node" << (*it)->getNodeScriptName().c_str() << "to" << oldInputs[j].c_str()
<< "[This is normal if loading a PyPlug]";
}
}
} else {
const std::map<std::string,std::string>& inputs = (*it)->getInputs();
for (std::map<std::string,std::string>::const_iterator it2 = inputs.begin(); it2 != inputs.end(); ++it2) {
if (it2->second.empty()) {
continue;
}
int index = thisNode->getInputNumberFromLabel(it2->first);
if (index == -1) {
appPTR->writeToOfxLog_mt_safe(QString("Could not find input named ") + it2->first.c_str());
continue;
}
if (!it2->second.empty() && !group->connectNodes(index, it2->second, thisNode.get())) {
qDebug() << "Failed to connect node" << (*it)->getNodeScriptName().c_str() << "to" << it2->second.c_str()
<< "[This is normal if loading a PyPlug]";
}
}
}
}
///Also reconnect parents of multiinstance nodes that were created on the fly
for (std::map<boost::shared_ptr<Natron::Node>, std::list<boost::shared_ptr<NodeSerialization> >::const_iterator >::const_iterator
it = parentsToReconnect.begin(); it != parentsToReconnect.end(); ++it) {
const std::vector<std::string> & oldInputs = (*it->second)->getOldInputs();
if (!oldInputs.empty()) {
/*
* Prior to Natron v2 OpenFX effects had their inputs reversed internally
*/
bool isOfxEffect = it->first->isOpenFXNode();
for (U32 j = 0; j < oldInputs.size(); ++j) {
if ( !oldInputs[j].empty() && !group->connectNodes(isOfxEffect ? oldInputs.size() - 1 - j : j, oldInputs[j],it->first.get()) ) {
qDebug() << "Failed to connect node" << it->first->getPluginLabel().c_str() << "to" << oldInputs[j].c_str()
<< "[This is normal if loading a PyPlug]";
}
}
} else {
const std::map<std::string,std::string>& inputs = (*it->second)->getInputs();
for (std::map<std::string,std::string>::const_iterator it2 = inputs.begin(); it2 != inputs.end(); ++it2) {
if (it2->second.empty()) {
continue;
}
int index = it->first->getInputNumberFromLabel(it2->first);
if (index == -1) {
appPTR->writeToOfxLog_mt_safe(QString("Could not find input named ") + it2->first.c_str());
continue;
}
if (!it2->second.empty() && !group->connectNodes(index, it2->second, it->first.get())) {
qDebug() << "Failed to connect node" << it->first->getPluginLabel().c_str() << "to" << it2->second.c_str()
<< "[This is normal if loading a PyPlug]";
}
}
}
}
return !mustShowErrorsLog;
}