Blender V5.3
node_composite_keying_screen.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2011 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
5#include "BLI_math_base.hh"
7#include "BLI_string_utf8.hh"
8
10#include "DNA_node_types.h"
11#include "DNA_tracking_types.h"
12
13#include "BKE_context.hh"
14#include "BKE_lib_id.hh"
15#include "BKE_movieclip.hh"
16#include "BKE_tracking.hh"
17
18#include "RNA_access.hh"
19#include "RNA_prototypes.hh"
20
21#include "UI_interface_c.hh"
23#include "UI_resources.hh"
24
25#include "COM_keying_screen.hh"
26#include "COM_node_operation.hh"
27
29
31
33
35{
36 b.add_input<decl::Float>("Smoothness"_ustr)
37 .default_value(0.0f)
38 .subtype(PROP_FACTOR)
39 .min(0.0f)
40 .max(1.0f)
41 .description("Specifies the smoothness of the keying screen");
42
43 b.add_output<decl::Color>("Screen"_ustr)
45 .structure_type(StructureType::Dynamic);
46}
47
48static void node_init(bNodeTree * /*node_tree*/, bNode *node)
49{
50 NodeKeyingScreenData *data = MEM_new<NodeKeyingScreenData>(__func__);
51 node->storage = data;
52}
53
54static void node_init_api(const bContext *C, PointerRNA *node_ptr)
55{
56 const Scene *scene = CTX_data_scene(C);
57 MovieClip *movie_clip = scene->clip;
58 if (!movie_clip) {
59 return;
60 }
61
62 bNode *node = node_ptr->data_as<bNode>();
63 node->id = &movie_clip->id;
64 id_us_plus(&movie_clip->id);
65
67 &movie_clip->tracking);
68 NodeKeyingScreenData &data = node_storage(*node);
69 STRNCPY_UTF8(data.tracking_object, tracking_object->name);
70}
71
72static void node_draw_buttons(ui::Layout &layout, bContext *C, PointerRNA *ptr)
73{
74 bNode *node = static_cast<bNode *>(ptr->data);
75
76 template_id(&layout, C, ptr, "clip", nullptr, "CLIP_OT_open", nullptr);
77
78 if (node->id) {
79 MovieClip *clip = id_cast<MovieClip *>(node->id);
81 &clip->id, RNA_MovieTracking, &clip->tracking);
82
83 ui::Layout &col = layout.column(true);
84 col.prop_search(ptr, "tracking_object", &tracking_ptr, "objects", "", ICON_OBJECT_DATA);
85 }
86}
87
88using namespace blender::compositor;
89
91 public:
93
94 void execute() override
95 {
96 MovieTrackingObject *movie_tracking_object = get_movie_tracking_object();
97 if (!movie_tracking_object) {
99 return;
100 }
101
102 Result &cached_keying_screen = context().cache_manager().keying_screens.get(
103 context(), get_movie_clip(), movie_tracking_object, get_smoothness());
104
105 if (!cached_keying_screen.is_allocated()) {
107 return;
108 }
109
110 Result &keying_screen = get_result("Screen");
111 keying_screen.share_data(cached_keying_screen);
112 }
113
115 {
116 return Domain(get_size());
117 }
118
120 {
121 MovieClip *movie_clip = get_movie_clip();
122 if (!movie_clip) {
123 return nullptr;
124 }
125
126 MovieTracking *movie_tracking = &movie_clip->tracking;
127
128 MovieTrackingObject *movie_tracking_object = BKE_tracking_object_get_named(
129 movie_tracking, node_storage(node()).tracking_object);
130 if (movie_tracking_object) {
131 return movie_tracking_object;
132 }
133
134 return BKE_tracking_object_get_active(movie_tracking);
135 }
136
138 {
139 MovieClip *movie_clip = this->get_movie_clip();
140 if (!this->get_movie_clip()) {
141 return int2(1);
142 }
143
144 MovieClipUser movie_clip_user = {};
145 const int scene_frame = context().get_frame_number();
146 const int clip_frame = BKE_movieclip_remap_scene_to_clip_frame(movie_clip, scene_frame);
147 BKE_movieclip_user_set_frame(&movie_clip_user, clip_frame);
148
149 int2 size;
150 BKE_movieclip_get_size(movie_clip, &movie_clip_user, &size.x, &size.y);
151 return size;
152 }
153
154 /* The reciprocal of the smoothness is used as a shaping parameter for the radial basis function
155 * used in the RBF interpolation. The exponential nature of the function can cause numerical
156 * instability for low smoothness values, so we empirically choose 0.15 as a lower limit. */
158 {
159 return math::interpolate(
160 0.15f,
161 1.0f,
162 math::clamp(this->get_input("Smoothness").get_single_value_default<float>(), 0.0f, 1.0f));
163 }
164
166 {
167 return reinterpret_cast<MovieClip *>(node().id);
168 }
169};
170
172{
173 return new KeyingScreenOperation(context, node);
174}
175
176static void node_register()
177{
178 static bke::bNodeType ntype;
179
180 cmp_node_type_base(&ntype, "CompositorNodeKeyingScreen"_ustr, CMP_NODE_KEYINGSCREEN);
181 ntype.ui_name = "Keying Screen";
182 ntype.ui_description = "Create plates for use as a color reference for keying nodes";
183 ntype.enum_name_legacy = "KEYINGSCREEN";
184 ntype.nclass = NODE_CLASS_MATTE;
185 ntype.declare = node_declare;
187 ntype.initfunc = node_init;
190 ntype, "NodeKeyingScreenData", node_free_standard_storage, node_copy_standard_storage);
192
194}
196
197} // namespace blender::nodes::node_composite_keying_screen_cc
#define NODE_CLASS_MATTE
Definition BKE_node.hh:485
#define NODE_STORAGE_FUNCS(StorageT)
Definition BKE_node.hh:1353
#define CMP_NODE_KEYINGSCREEN
#define STRNCPY_UTF8(dst, src)
#define BLT_I18NCONTEXT_ID_SCREEN
#define NOD_REGISTER_NODE(REGISTER_FUNC)
#define C
Definition RandGen.cpp:29
btScalar max
Domain(const int2 &size)
Definition domain.cc:20
Result & get(Context &context, MovieClip *movie_clip, MovieTrackingObject *movie_tracking_object, float smoothness)
NodeOperation(Context &context, const bNode &node)
Result & get_result(StringRef identifier)
Definition operation.cc:40
Context & context() const
Definition operation.cc:57
Result & get_input(StringRef identifier) const
Definition operation.cc:35
void share_data(const Result &source)
Definition result.cc:996
std::optional< std::string > translation_context
void node_register_type(bNodeType &ntype)
Definition node.cc:2920
void node_type_storage(bNodeType &ntype, std::optional< StringRefNull > storagename, void(*freefunc)(bNode *node), void(*copyfunc)(bNodeTree *dest_ntree, bNode *dest_node, const bNode *src_node))
Definition node.cc:6166
T clamp(const T &a, const T &min, const T &max)
T interpolate(const T &a, const T &b, const FactorT &t)
static void node_draw_buttons(ui::Layout &layout, bContext *C, PointerRNA *ptr)
static NodeOperation * get_compositor_operation(Context &context, const bNode &node)
static void node_init_api(const bContext *C, PointerRNA *node_ptr)
void BKE_movieclip_get_size(MovieClip *clip, const MovieClipUser *user, int *r_width, int *r_height)
void id_us_plus(ID *id)
Definition lib_id.cc:433
MovieTrackingObject * BKE_tracking_object_get_active(const MovieTracking *tracking)
Definition tracking.cc:1982
BMesh const char void * data
PointerRNA RNA_pointer_create_discrete(ID *id, StructRNA *type, void *data)
void BKE_movieclip_user_set_frame(MovieClipUser *user, int framenr)
float BKE_movieclip_remap_scene_to_clip_frame(const MovieClip *clip, float framenr)
MovieTrackingObject * BKE_tracking_object_get_named(MovieTracking *tracking, const char *name)
Definition tracking.cc:1971
void node_copy_standard_storage(bNodeTree *, bNode *dest_node, const bNode *src_node)
Definition node_util.cc:57
Scene * CTX_data_scene(const bContext *C)
void node_free_standard_storage(bNode *node)
Definition node_util.cc:45
@ PROP_FACTOR
Definition RNA_types.hh:308
void cmp_node_type_base(bke::bNodeType *ntype, UString idname, const std::optional< int16_t > legacy_type)
#define min(a, b)
Definition sort.cc:38
struct MovieTracking tracking
T * data_as() const
Definition RNA_types.hh:139
struct MovieClip * clip
Defines a node type.
Definition BKE_node.hh:265
void(*) draw_buttons(ui::Layout &, bContext *C, PointerRNA *ptr)
Definition BKE_node.hh:290
std::string ui_description
Definition BKE_node.hh:271
void(*) initfunc_api(const bContext *C, PointerRNA *ptr)
Definition BKE_node.hh:333
NodeGetCompositorOperationFunction get_compositor_operation
Definition BKE_node.hh:379
void(*) initfunc(bNodeTree *ntree, bNode *node)
Definition BKE_node.hh:320
const char * enum_name_legacy
Definition BKE_node.hh:274
NodeDeclareFunction declare
Definition BKE_node.hh:393
void prop_search(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *searchptr, PropertyRNA *searchprop, PropertyRNA *item_searchpropname, std::optional< StringRefNull > name, int icon, bool results_are_suggestions)
Layout & column(bool align)