Blender V5.3
sequencer_modifier.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2012 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#include "BLI_listbase.hh"
10#include "BLI_utildefines.hh"
11
12#include "BLT_translation.hh"
13
14#include "DNA_scene_types.h"
15
16#include "DEG_depsgraph.hh"
17
18#include "BKE_context.hh"
19
20#include "ED_sequencer.hh"
21
22#include "WM_api.hh"
23#include "WM_types.hh"
24
25#include "RNA_define.hh"
26#include "RNA_enum_types.hh"
27#include "RNA_prototypes.hh"
28
29#include "SEQ_modifier.hh"
30#include "SEQ_relations.hh"
31#include "SEQ_select.hh"
32#include "SEQ_sound.hh"
33
34#include "UI_interface_c.hh"
35
36#include "sequencer_intern.hh"
37
38namespace blender::ed::vse {
39
46 wmOperator *op,
47 const wmEvent *event,
48 wmOperatorStatus *r_retval)
49{
50 if (RNA_struct_property_is_set(op->ptr, "modifier")) {
51 return true;
52 }
53
54 /* Note that the context pointer is *not* the active modifier, it is set in UI layouts. */
55 PointerRNA ctx_ptr = CTX_data_pointer_get_type(C, "modifier", RNA_StripModifier);
56 if (ctx_ptr) {
57 StripModifierData *smd = static_cast<StripModifierData *>(ctx_ptr.data);
58 RNA_string_set(op->ptr, "modifier", smd->name);
59 return true;
60 }
61
63 if (panel_ptr == nullptr || !*panel_ptr) {
64 /* The operators using this function can typically be called from UIs that aren't related to
65 * the modifiers UI at all. So include #OPERATOR_PASS_THROUGH to not block events from reaching
66 * other operators/handlers. */
68 return false;
69 }
70
71 if (!RNA_struct_is_a(panel_ptr->type, RNA_StripModifier)) {
72 /* Work around multiple operators using the same shortcut. The operators for the other
73 * stacks in the property editor use the same key, and will not run after these return
74 * OPERATOR_CANCELLED. */
76 return false;
77 }
78
79 const StripModifierData *smd = static_cast<const StripModifierData *>(panel_ptr->data);
80 RNA_string_set(op->ptr, "modifier", smd->name);
81 return true;
82}
83
84/* -------------------------------------------------------------------- */
87
102
104 PointerRNA * /*ptr*/,
105 PropertyRNA * /*prop*/,
106 bool * /*r_free*/)
107{
108 if (C == nullptr) {
110 }
111
113 Strip *strip = seq::select_active_get(scene);
114 if (strip) {
115 if (ELEM(strip->type, STRIP_TYPE_SOUND)) {
117 }
118 }
120}
121
123{
124 PropertyRNA *prop;
125
126 /* identifiers */
127 ot->name = "Add Strip Modifier";
128 ot->idname = "SEQUENCER_OT_strip_modifier_add";
129 ot->description = "Add a modifier to the strip";
130
131 /* API callbacks. */
134
135 /* flags */
137
138 /* properties */
139 prop = RNA_def_enum(ot->srna, "type", rna_enum_dummy_NULL_items, 0, "Type", "");
142 ot->prop = prop;
143}
144
146
147/* -------------------------------------------------------------------- */
150
152{
154 Strip *strip = seq::select_active_get(scene);
155 char name[MAX_NAME];
157
158 RNA_string_get(op->ptr, "name", name);
159
160 smd = seq::modifier_find_by_name(strip, name);
161 if (!smd) {
162 return OPERATOR_CANCELLED;
163 }
164
165 seq::modifier_remove(strip, smd);
166
167 if (ELEM(strip->type, STRIP_TYPE_SOUND)) {
169 }
170 else {
172 }
174
175 return OPERATOR_FINISHED;
176}
177
179{
180 PropertyRNA *prop;
181
182 /* identifiers */
183 ot->name = "Remove Strip Modifier";
184 ot->idname = "SEQUENCER_OT_strip_modifier_remove";
185 ot->description = "Remove a modifier from the strip";
186
187 /* API callbacks. */
190
191 /* flags */
193
194 /* properties */
195 prop = RNA_def_string(ot->srna, "name", "Name", MAX_NAME, "Name", "Name of modifier to remove");
197}
198
200
201/* -------------------------------------------------------------------- */
204
205enum {
208};
209
211{
213 Strip *strip = seq::select_active_get(scene);
214 char name[MAX_NAME];
215 int direction;
217
218 RNA_string_get(op->ptr, "name", name);
219 direction = RNA_enum_get(op->ptr, "direction");
220
221 smd = seq::modifier_find_by_name(strip, name);
222 if (!smd) {
223 return OPERATOR_CANCELLED;
224 }
225
226 if (direction == SEQ_MODIFIER_MOVE_UP) {
227 if (smd->prev) {
228 BLI_remlink(&strip->modifiers, smd);
229 BLI_insertlinkbefore(&strip->modifiers, smd->prev, smd);
230 }
231 }
232 else if (direction == SEQ_MODIFIER_MOVE_DOWN) {
233 if (smd->next) {
234 BLI_remlink(&strip->modifiers, smd);
235 BLI_insertlinkafter(&strip->modifiers, smd->next, smd);
236 }
237 }
238
239 if (ELEM(strip->type, STRIP_TYPE_SOUND)) {
241 }
242 else {
244 }
245
247
248 return OPERATOR_FINISHED;
249}
250
252{
253 PropertyRNA *prop;
254
255 static const EnumPropertyItem direction_items[] = {
256 {SEQ_MODIFIER_MOVE_UP, "UP", 0, "Up", "Move modifier up in the stack"},
257 {SEQ_MODIFIER_MOVE_DOWN, "DOWN", 0, "Down", "Move modifier down in the stack"},
258 {0, nullptr, 0, nullptr, nullptr},
259 };
260
261 /* identifiers */
262 ot->name = "Move Strip Modifier";
263 ot->idname = "SEQUENCER_OT_strip_modifier_move";
264 ot->description = "Move modifier up and down in the stack";
265
266 /* API callbacks. */
269
270 /* flags */
272
273 /* properties */
274 prop = RNA_def_string(ot->srna, "name", "Name", MAX_NAME, "Name", "Name of modifier to remove");
276 prop = RNA_def_enum(ot->srna, "direction", direction_items, SEQ_MODIFIER_MOVE_UP, "Type", "");
278}
279
281
282/* -------------------------------------------------------------------- */
285
286enum {
289};
290
292{
294 Strip *active_strip = seq::select_active_get(scene);
295 const int type = RNA_enum_get(op->ptr, "type");
296
297 if (!active_strip || !active_strip->modifiers.first_) {
298 return OPERATOR_CANCELLED;
299 }
300
301 std::string modifier_name = RNA_string_get(op->ptr, "modifier");
302 StripModifierData *src_smd = nullptr;
303 if (!modifier_name.empty()) {
304 src_smd = seq::modifier_find_by_name(active_strip, modifier_name.c_str());
305 if (!src_smd) {
306 return OPERATOR_CANCELLED;
307 }
308 }
309
310 int isSound = ELEM(active_strip->type, STRIP_TYPE_SOUND);
311
313 selected.remove(active_strip);
314
315 for (Strip *strip_iter : selected) {
316 int strip_iter_is_sound = ELEM(strip_iter->type, STRIP_TYPE_SOUND);
317 /* If original is sound, only copy to "sound" strips
318 * If original is not sound, only copy to "not sound" strips
319 */
320 if (isSound != strip_iter_is_sound) {
321 continue;
322 }
323
324 if (type == SEQ_MODIFIER_COPY_REPLACE) {
325 if (strip_iter->modifiers.first_) {
326 StripModifierData *smd_tmp, *smd = strip_iter->modifiers.first();
327 while (smd) {
328 smd_tmp = smd->next;
329 BLI_remlink(&strip_iter->modifiers, smd);
331 smd = smd_tmp;
332 }
333 strip_iter->modifiers.clear_no_delete();
334 }
335 }
336
337 if (src_smd) {
338 StripModifierData *smd_new = seq::modifier_copy(*strip_iter, src_smd, 0);
339 seq::modifier_persistent_uid_init(*strip_iter, *smd_new);
340 seq::modifier_set_active(strip_iter, smd_new);
341 }
342 else {
343 for (StripModifierData &smd : active_strip->modifiers) {
344 StripModifierData *smd_new = seq::modifier_copy(*strip_iter, &smd, 0);
345 seq::modifier_persistent_uid_init(*strip_iter, *smd_new);
346 /* When appending to an existing stack, ensure at most one is active. */
347 if ((type == SEQ_MODIFIER_COPY_APPEND) && (smd.flag & STRIP_MODIFIER_FLAG_ACTIVE) != 0) {
348 seq::modifier_set_active(strip_iter, smd_new);
349 }
350 }
351 }
352 }
353
354 if (ELEM(active_strip->type, STRIP_TYPE_SOUND)) {
356 }
357 else {
358 seq::relations_invalidate_cache(scene, active_strip);
359 }
360
362
363 return OPERATOR_FINISHED;
364}
365
367{
368 PropertyRNA *prop;
369 static const EnumPropertyItem type_items[] = {
370 {SEQ_MODIFIER_COPY_REPLACE, "REPLACE", 0, "Replace", "Replace modifiers in destination"},
372 "APPEND",
373 0,
374 "Append",
375 "Append active modifiers to selected strips"},
376 {0, nullptr, 0, nullptr, nullptr},
377 };
378
379 /* identifiers */
380 ot->name = "Copy to Selected Strips";
381 ot->idname = "SEQUENCER_OT_strip_modifier_copy";
382 ot->description = "Copy modifiers of the active strip to all selected strips";
383
384 /* API callbacks. */
388
389 /* flags */
391
392 /* properties */
393 ot->prop = RNA_def_enum(ot->srna,
394 "type",
395 type_items,
397 "Type",
398 "Whether to replace all modifiers on the selected strips or append to "
399 "their existing modifier stack");
400 prop = RNA_def_string(ot->srna,
401 "modifier",
402 nullptr,
403 MAX_NAME,
404 "Modifier",
405 "Name of the modifier to copy. If empty, copy all modifiers");
407}
408
410
411/* -------------------------------------------------------------------- */
414
416{
417 Scene *sequencer_scene = CTX_data_sequencer_scene(C);
418 Strip *active_strip = seq::select_active_get(sequencer_scene);
419 if (!active_strip || active_strip->modifiers.is_empty()) {
420 return OPERATOR_CANCELLED;
421 }
422
423 std::string modifier_name = RNA_string_get(op->ptr, "modifier");
424 StripModifierData *smd = [&]() {
425 if (modifier_name.empty()) {
426 /* Use the active modifier. */
427 return seq::modifier_get_active(active_strip);
428 }
429 return seq::modifier_find_by_name(active_strip, modifier_name.c_str());
430 }();
431
432 if (!smd) {
433 return OPERATOR_CANCELLED;
434 }
435
436 StripModifierData *smd_new = seq::modifier_copy(*active_strip, smd, 0);
437 seq::modifier_persistent_uid_init(*active_strip, *smd_new);
438 seq::modifier_set_active(active_strip, smd_new);
439
440 seq::relations_invalidate_cache(sequencer_scene, active_strip);
441
442 WM_event_add_notifier(C, NC_SCENE | ND_SEQUENCER, sequencer_scene);
443
444 return OPERATOR_FINISHED;
445}
446
448 wmOperator *op,
449 const wmEvent *event)
450{
451 wmOperatorStatus retval;
452 if (strip_modifier_invoke_properties_with_hover(C, op, event, &retval)) {
454 }
455 return retval;
456}
457
459{
460 ot->name = "Duplicate Modifier";
461 ot->idname = "SEQUENCER_OT_strip_modifier_duplicate";
462 ot->description = "Duplicate (active) modifier of the active strip";
463
467
469
470 ot->prop = RNA_def_string(
471 ot->srna,
472 "modifier",
473 nullptr,
474 MAX_NAME,
475 "Modifier",
476 "Name of the modifier to duplicate. If empty duplicate the active modifier");
478}
479
481
482/* -------------------------------------------------------------------- */
485
487{
489 Strip *strip = seq::select_active_get(scene);
491 char name[MAX_NAME];
492 RNA_string_get(op->ptr, "name", name);
493 int number = RNA_enum_get(op->ptr, "graphs");
494
495 smd = seq::modifier_find_by_name(strip, name);
496 if (!smd) {
497 return OPERATOR_CANCELLED;
498 }
499
501 number);
502
505
506 return OPERATOR_FINISHED;
507}
508
510{
511
512 static const EnumPropertyItem enum_modifier_equalizer_presets_items[] = {
513 {1, "SIMPLE", 0, "Unique", "One unique graphical definition"},
514 {2, "DOUBLE", 0, "Double", "Graphical definition in 2 sections"},
515 {3, "TRIPLE", 0, "Triplet", "Graphical definition in 3 sections"},
516 {0, nullptr, 0, nullptr, nullptr},
517 };
518 PropertyRNA *prop;
519
520 /* identifiers */
521 ot->name = "Redefine Equalizer Graphs";
522 ot->idname = "SEQUENCER_OT_strip_modifier_equalizer_redefine";
523 ot->description = "Redefine equalizer graphs";
524
525 /* API callbacks. */
528
529 /* flags */
531
532 /* properties */
533 prop = RNA_def_enum(
534 ot->srna, "graphs", enum_modifier_equalizer_presets_items, 1, "Graphs", "Number of graphs");
536 ot->prop = prop;
537 prop = RNA_def_string(
538 ot->srna, "name", "Name", MAX_NAME, "Name", "Name of modifier to redefine");
540}
541
543
544/* ------------------------------------------------------------------- */
547
549{
551 Strip *strip = seq::select_active_get(scene);
552
553 char name[MAX_NAME];
554 RNA_string_get(op->ptr, "modifier", name);
555 const int index = RNA_int_get(op->ptr, "index");
556
558 if (!smd) {
559 return OPERATOR_CANCELLED;
560 }
561
562 if (!seq::modifier_move_to_index(strip, smd, index)) {
563 return OPERATOR_CANCELLED;
564 }
565
566 if (ELEM(strip->type, STRIP_TYPE_SOUND)) {
568 }
569 else {
571 }
572
574
575 return OPERATOR_FINISHED;
576}
577
579 wmOperator *op,
580 const wmEvent * /*event*/)
581{
582 BLI_assert(RNA_struct_property_is_set(op->ptr, "modifier"));
583 return modifier_move_to_index_exec(C, op);
584}
585
587{
588 PropertyRNA *prop;
589
590 ot->name = "Move Active Strip Modifier to Index";
591 ot->description =
592 "Change the strip modifier's index in the stack so it evaluates after the set number of "
593 "others";
594 ot->idname = "SEQUENCER_OT_strip_modifier_move_to_index";
595
599
600 /* flags */
602
603 prop = RNA_def_string(
604 ot->srna, "modifier", nullptr, MAX_NAME, "Modifier", "Name of the modifier to edit");
607 ot->srna, "index", 0, 0, INT_MAX, "Index", "The index to move the modifier to", 0, INT_MAX);
608}
609
611
612/* ------------------------------------------------------------------- */
615
617{
619 Strip *strip = seq::select_active_get(scene);
620
621 char name[MAX_NAME];
622 RNA_string_get(op->ptr, "modifier", name);
623
625 /* If there is no modifier set for this operator, clear the active modifier field. */
626 seq::modifier_set_active(strip, smd);
627
629
630 return OPERATOR_FINISHED;
631}
632
634 wmOperator *op,
635 const wmEvent *event)
636{
637 wmOperatorStatus retval;
638 if (strip_modifier_invoke_properties_with_hover(C, op, event, &retval)) {
639 return modifier_set_active_exec(C, op);
640 }
641 return retval;
642}
643
645{
646 ot->name = "Set Active Strip Modifier";
647 ot->description = "Activate the strip modifier to use as the context";
648 ot->idname = "SEQUENCER_OT_strip_modifier_set_active";
649
653
655
656 ot->prop = RNA_def_string(
657 ot->srna, "modifier", nullptr, MAX_NAME, "Modifier", "Name of the strip modifier to edit");
659}
660
662
663} // namespace blender::ed::vse
#define BLT_I18NCONTEXT_ID_SEQUENCE
#define MAX_NAME
Definition DNA_defs.h:63
#define C
Definition RandGen.cpp:29
#define ND_SEQUENCER
Definition WM_types.hh:456
#define NC_SCENE
Definition WM_types.hh:391
#define ELEM(...)
bool remove(const Key &key)
#define INT_MAX
VectorSet< Strip * > selected_strips_from_context(bContext *C)
static wmOperatorStatus modifier_set_active_exec(bContext *C, wmOperator *op)
static wmOperatorStatus modifier_set_active_invoke(bContext *C, wmOperator *op, const wmEvent *event)
static wmOperatorStatus strip_modifier_move_exec(bContext *C, wmOperator *op)
static wmOperatorStatus strip_modifier_equalizer_redefine_exec(bContext *C, wmOperator *op)
static const EnumPropertyItem * filter_modifiers_by_sequence_type_itemf(bContext *C, PointerRNA *, PropertyRNA *, bool *)
void SEQUENCER_OT_strip_modifier_duplicate(wmOperatorType *ot)
static wmOperatorStatus strip_modifier_remove_exec(bContext *C, wmOperator *op)
void SEQUENCER_OT_strip_modifier_remove(wmOperatorType *ot)
static wmOperatorStatus modifier_move_to_index_invoke(bContext *C, wmOperator *op, const wmEvent *)
void SEQUENCER_OT_strip_modifier_set_active(wmOperatorType *ot)
static bool strip_modifier_invoke_properties_with_hover(bContext *C, wmOperator *op, const wmEvent *event, wmOperatorStatus *r_retval)
void SEQUENCER_OT_strip_modifier_equalizer_redefine(wmOperatorType *ot)
static wmOperatorStatus modifier_move_to_index_exec(bContext *C, wmOperator *op)
bool sequencer_strip_editable_poll(bContext *C)
static wmOperatorStatus strip_modifier_duplicate_exec(bContext *C, wmOperator *op)
void SEQUENCER_OT_strip_modifier_move_to_index(wmOperatorType *ot)
static wmOperatorStatus strip_modifier_duplicate_invoke(bContext *C, wmOperator *op, const wmEvent *event)
void SEQUENCER_OT_strip_modifier_move(wmOperatorType *ot)
static wmOperatorStatus strip_modifier_copy_exec(bContext *C, wmOperator *op)
void SEQUENCER_OT_strip_modifier_add(wmOperatorType *ot)
void SEQUENCER_OT_strip_modifier_copy(wmOperatorType *ot)
static wmOperatorStatus strip_modifier_add_exec(bContext *C, wmOperator *op)
bool modifier_move_to_index(Strip *strip, StripModifierData *smd, const int new_index)
void relations_invalidate_cache(Scene *scene, Strip *strip)
void modifier_persistent_uid_init(const Strip &strip, StripModifierData &smd)
StripModifierData * modifier_find_by_name(Strip *strip, const char *name)
Strip * select_active_get(const Scene *scene)
void modifier_free(StripModifierData *smd)
StripModifierData * modifier_copy(Strip &strip_dst, StripModifierData *mod_src, const int flag)
bool modifier_remove(Strip *strip, StripModifierData *smd)
void modifier_set_active(Strip *strip, StripModifierData *smd)
void sound_equalizermodifier_set_graphs(SoundEqualizerModifierData *semd, int number)
StripModifierData * modifier_new(Strip *strip, const char *name, eStripModifierType type)
StripModifierData * modifier_get_active(const Strip *strip)
PointerRNA * region_panel_custom_data_under_cursor(const bContext *C, const wmEvent *event)
void WM_main_add_notifier(uint type, void *reference)
const EnumPropertyItem rna_enum_strip_modifier_type_items[]
BLI_assert(slot->slot_subtype.map==BMO_OP_SLOT_SUBTYPE_MAP_FLT)
void RNA_def_enum_funcs(PropertyRNA *prop, EnumPropertyItemFunc itemfunc)
const EnumPropertyItem rna_enum_strip_video_modifier_type_items[]
wmOperatorStatus WM_menu_invoke(bContext *C, wmOperator *op, const wmEvent *)
int RNA_enum_get(PointerRNA *ptr, const char *name)
PropertyRNA * RNA_def_string(StructOrFunctionRNA *cont_, const char *identifier, const char *default_value, const int maxlen, const char *ui_name, const char *ui_description)
Scene * CTX_data_sequencer_scene(const bContext *C)
bool RNA_struct_is_a(const StructRNA *type, const StructRNA *srna)
void RNA_string_set(PointerRNA *ptr, const char *name, const char *value)
PropertyRNA * RNA_def_enum(StructOrFunctionRNA *cont_, const char *identifier, const EnumPropertyItem *items, const int default_value, const char *ui_name, const char *ui_description)
int RNA_int_get(PointerRNA *ptr, const char *name)
const EnumPropertyItem rna_enum_strip_sound_modifier_type_items[]
void BLI_remlink(ListBase *listbase, void *vlink) ATTR_NONNULL(1)
Definition listbase.cc:138
void DEG_id_tag_update(ID *id, unsigned int flags)
void BLI_insertlinkafter(ListBase *listbase, void *vprevlink, void *vnewlink) ATTR_NONNULL(1)
Definition listbase.cc:339
bool RNA_struct_property_is_set(PointerRNA *ptr, const char *identifier)
const EnumPropertyItem rna_enum_dummy_NULL_items[]
Definition rna_rna.cc:28
void WM_event_add_notifier(const bContext *C, uint type, void *reference)
void BLI_insertlinkbefore(ListBase *listbase, void *vnextlink, void *vnewlink) ATTR_NONNULL(1)
Definition listbase.cc:378
void RNA_def_property_translation_context(PropertyRNA *prop, const char *context)
void RNA_def_property_flag(PropertyRNA *prop, PropertyFlag flag)
PropertyRNA * RNA_def_int(StructOrFunctionRNA *cont_, const char *identifier, const int default_value, const int hardmin, const int hardmax, const char *ui_name, const char *ui_description, const int softmin, const int softmax)
@ ID_RECALC_AUDIO
Definition DNA_ID.h:1132
@ ID_RECALC_SEQUENCER_STRIPS
Definition DNA_ID.h:1122
@ PROP_HIDDEN
Definition RNA_types.hh:408
@ OPTYPE_REGISTER
Definition WM_types.hh:188
@ OPTYPE_UNDO
Definition WM_types.hh:190
@ OPTYPE_INTERNAL
Definition WM_types.hh:210
std::string RNA_string_get(PointerRNA *ptr, const char *name)
PointerRNA CTX_data_pointer_get_type(const bContext *C, const char *member, StructRNA *type)
StructRNA * type
Definition RNA_types.hh:63
struct StripModifierData * prev
struct StripModifierData * next
wmOperatorStatus(*) exec(bContext *C, wmOperator *op) ATTR_WARN_UNUSED_RESULT
Definition WM_types.hh:1125
const char * description
Definition WM_types.hh:1115
bool(*) poll(bContext *C) ATTR_WARN_UNUSED_RESULT
Definition WM_types.hh:1165
wmOperatorStatus(*) invoke(bContext *C, wmOperator *op, const wmEvent *event) ATTR_WARN_UNUSED_RESULT
Definition WM_types.hh:1141