forked from NatronGitHub/Natron
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ReadNode.h
169 lines (147 loc) · 8.67 KB
/
ReadNode.h
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
/* ***** BEGIN LICENSE BLOCK *****
* This file is part of Natron <https://natrongithub.github.io/>,
* (C) 2018-2021 The Natron developers
* (C) 2013-2018 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 ***** */
#ifndef READNODE_H
#define READNODE_H
// ***** 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 "Global/Macros.h"
#if !defined(Q_MOC_RUN) && !defined(SBK_RUN)
#include <boost/shared_ptr.hpp>
#include <boost/scoped_ptr.hpp>
#endif
#include "Engine/EffectInstance.h"
#define NATRON_READER_INPUT_NAME "Sync"
#define kNatronReadNodeParamDecodingPluginChoice "decodingPluginChoice"
#define kNatronReadNodeParamDecodingPluginID "decodingPluginID"
#define kNatronReadNodeOCIOParamInputSpace "ocioInputSpace"
NATRON_NAMESPACE_ENTER
/**
* @brief A wrapper around all OpenFX Readers nodes so that to the user they all appear under a single Read node that has a dynamic
* settings panel.
* Every method forwards to the corresponding OpenFX plug-in.
**/
struct ReadNodePrivate;
class ReadNode
: public EffectInstance
{
GCC_DIAG_SUGGEST_OVERRIDE_OFF
Q_OBJECT
GCC_DIAG_SUGGEST_OVERRIDE_ON
public:
static EffectInstance* BuildEffect(NodePtr n)
{
return new ReadNode(n);
}
/**
* @brief Returns if the given plug-in is compatible with this ReadNode container.
* by default all nodes which inherits GenericReader in OpenFX are.
**/
static bool isBundledReader(const std::string& pluginID, bool wasProjectCreatedWithLowerCaseIDs);
bool isBundledReader(const std::string& pluginID);
ReadNode(NodePtr n);
virtual ~ReadNode();
NodePtr getEmbeddedReader() const;
void setEmbeddedReader(const NodePtr& node);
static bool isVideoReader(const std::string& pluginID);
virtual bool isReader() const OVERRIDE FINAL WARN_UNUSED_RETURN;
virtual bool isVideoReader() const OVERRIDE FINAL WARN_UNUSED_RETURN;
virtual bool isGenerator() const OVERRIDE FINAL WARN_UNUSED_RETURN;
virtual bool isOutput() const OVERRIDE FINAL WARN_UNUSED_RETURN;
virtual bool isMultiPlanar() const OVERRIDE FINAL WARN_UNUSED_RETURN;
virtual bool isViewAware() const OVERRIDE FINAL WARN_UNUSED_RETURN;
virtual bool supportsTiles() const OVERRIDE FINAL WARN_UNUSED_RETURN;
virtual bool supportsMultiResolution() const OVERRIDE FINAL WARN_UNUSED_RETURN;
virtual bool supportsMultipleClipDepths() const OVERRIDE FINAL WARN_UNUSED_RETURN;
virtual RenderSafetyEnum renderThreadSafety() const OVERRIDE FINAL WARN_UNUSED_RETURN;
virtual bool getCanTransform() const OVERRIDE FINAL WARN_UNUSED_RETURN;
virtual SequentialPreferenceEnum getSequentialPreference() const OVERRIDE FINAL WARN_UNUSED_RETURN;
virtual EffectInstance::ViewInvarianceLevel isViewInvariant() const OVERRIDE FINAL WARN_UNUSED_RETURN;
virtual EffectInstance::PassThroughEnum isPassThroughForNonRenderedPlanes() const OVERRIDE FINAL WARN_UNUSED_RETURN;
virtual bool getCreateChannelSelectorKnob() const OVERRIDE FINAL WARN_UNUSED_RETURN;
virtual bool isHostChannelSelectorSupported(bool* defaultR, bool* defaultG, bool* defaultB, bool* defaultA) const OVERRIDE WARN_UNUSED_RETURN;
virtual int getMajorVersion() const OVERRIDE FINAL WARN_UNUSED_RETURN;
virtual int getMinorVersion() const OVERRIDE FINAL WARN_UNUSED_RETURN;
virtual std::string getPluginID() const OVERRIDE FINAL WARN_UNUSED_RETURN;
virtual std::string getPluginLabel() const OVERRIDE FINAL WARN_UNUSED_RETURN;
virtual std::string getPluginDescription() const OVERRIDE FINAL WARN_UNUSED_RETURN;
virtual void getPluginGrouping(std::list<std::string>* grouping) const OVERRIDE FINAL;
virtual int getNInputs() const OVERRIDE FINAL WARN_UNUSED_RETURN;
virtual std::string getInputLabel (int inputNb) const OVERRIDE FINAL WARN_UNUSED_RETURN;
virtual bool isInputOptional(int inputNb) const OVERRIDE FINAL WARN_UNUSED_RETURN;
virtual bool isInputMask(int inputNb) const OVERRIDE FINAL WARN_UNUSED_RETURN;
virtual void addAcceptedComponents(int inputNb, std::list<ImagePlaneDesc>* comps) OVERRIDE FINAL;
virtual void addSupportedBitDepth(std::list<ImageBitDepthEnum>* depths) const OVERRIDE FINAL;
virtual void onInputChanged(int inputNo) OVERRIDE FINAL;
virtual void purgeCaches() OVERRIDE FINAL;
virtual void onEffectCreated(bool mayCreateFileDialog,
const CreateNodeArgs& defaultParamValues) OVERRIDE FINAL;
private:
virtual StatusEnum getPreferredMetadata(NodeMetadata& metadata) OVERRIDE FINAL;
virtual void onMetadataRefreshed(const NodeMetadata& metadata) OVERRIDE FINAL;
virtual void initializeKnobs() OVERRIDE FINAL;
virtual void onKnobsAboutToBeLoaded(const NodeSerializationPtr& serialization) OVERRIDE FINAL;
virtual bool knobChanged(KnobI* k,
ValueChangedReasonEnum reason,
ViewSpec view,
double time,
bool originatedFromMainThread) OVERRIDE FINAL;
virtual StatusEnum getRegionOfDefinition(U64 hash, double time, const RenderScale & scale, ViewIdx view, RectD* rod) OVERRIDE WARN_UNUSED_RETURN;
virtual void getFrameRange(double *first, double *last) OVERRIDE FINAL;
virtual void getComponentsNeededAndProduced(double time, ViewIdx view,
EffectInstance::ComponentsNeededMap* comps,
double* passThroughTime,
int* passThroughView,
int* passThroughInput) OVERRIDE;
virtual StatusEnum beginSequenceRender(double first,
double last,
double step,
bool interactive,
const RenderScale & scale,
bool isSequentialRender,
bool isRenderResponseToUserInteraction,
bool draftMode,
ViewIdx view,
bool isOpenGLRender,
const EffectInstance::OpenGLContextEffectDataPtr& glContextData) OVERRIDE FINAL WARN_UNUSED_RETURN;
virtual StatusEnum endSequenceRender(double first,
double last,
double step,
bool interactive,
const RenderScale & scale,
bool isSequentialRender,
bool isRenderResponseToUserInteraction,
bool draftMode,
ViewIdx view,
bool isOpenGLRender,
const EffectInstance::OpenGLContextEffectDataPtr& glContextData) OVERRIDE FINAL WARN_UNUSED_RETURN;
virtual StatusEnum render(const RenderActionArgs& args) OVERRIDE WARN_UNUSED_RETURN;
virtual void getRegionsOfInterest(double time,
const RenderScale & scale,
const RectD & outputRoD, //!< full RoD in canonical coordinates
const RectD & renderWindow, //!< the region to be rendered in the output image, in Canonical Coordinates
ViewIdx view,
RoIMap* ret) OVERRIDE FINAL;
virtual FramesNeededMap getFramesNeeded(double time, ViewIdx view) OVERRIDE WARN_UNUSED_RETURN;
boost::scoped_ptr<ReadNodePrivate> _imp;
};
NATRON_NAMESPACE_EXIT
#endif // READNODE_H