Blender V5.3
SEQ_modifier.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2004 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
5#pragma once
6
10
11#include "BKE_sound_types.hh"
12
13#include "BLI_function_ref.hh"
14
15#include "DNA_sequence_types.h"
16
17namespace blender {
18
19struct ARegionType;
20struct BlendDataReader;
21struct BlendWriter;
22struct Strip;
24struct ID;
25struct Main;
26
27namespace seq {
28
30
36 char idname[/*MAX_NAME*/ 64];
37
38 /* default name for the modifier */
39 char name[/*MAX_NAME*/ 64];
40
41 /* DNA structure name used on load/save filed */
42 char struct_name[/*MAX_NAME*/ 64];
43
44 /* size of modifier data structure, used by allocation */
46
47 /* data initialization */
49
50 /* free data used by modifier,
51 * only modifier-specific data should be freed, modifier descriptor would
52 * be freed outside of this callback
53 */
55
56 /* copy data from one modifier to another */
58
59 /* Apply modifier on an image buffer. */
61
63 void (*panel_register)(ARegionType *region_type);
64
65 /* Callback to read custom strip modifier data. */
66 void (*blend_write)(BlendWriter *writer, const StripModifierData *smd);
67
68 /* Callback to write custom strip modifier data. */
70};
71
73 /* Reference parameters for optimizing updates. Sound modifiers can store parameters, sound
74 * inputs and outputs. When all existing parameters do match new ones, the update can be skipped
75 * and old sound handle may be returned. This is to prevent audio glitches, see #141595 */
76
77 /* Reference sound handles (may be used by any sound modifier). */
80
81 /* Hash to detect change in modifier state. */
83
85};
86
87void modifiers_init();
88
90StripModifierData *modifier_new(Strip *strip, const char *name, eStripModifierType type);
91bool modifier_remove(Strip *strip, StripModifierData *smd);
92void modifier_clear(Strip *strip);
95StripModifierData *modifier_find_by_name(Strip *strip, const char *name);
100StripModifierData *modifier_copy(Strip &strip_dst, StripModifierData *mod_src, int flag);
101void modifier_list_copy(Strip *strip_new, Strip *strip, int flag);
102bool strip_supports_modifiers(const Strip *strip);
103
104void modifier_blend_write(BlendWriter *writer, ListBaseT<StripModifierData> *modbase);
105void modifier_blend_read_data(BlendDataReader *reader, ListBaseT<StripModifierData> *lb);
107
108bool modifier_move_to_index(Strip *strip, StripModifierData *smd, int new_index);
109
112
113static constexpr char STRIP_MODIFIER_TYPE_PANEL_PREFIX[] = "STRIPMOD_PT_";
114void modifier_type_panel_id(eStripModifierType type, char *r_idname);
115
116/* Iterate over all the modifiers and call the callback function for every referenced ID. */
117void foreach_strip_modifier_id(Strip *strip, const FunctionRef<void(ID *)> fn);
118
120 Scene &sequencer_scene,
122
123} // namespace seq
124} // namespace blender
std::shared_ptr< void > AUD_Sound
void modifier_list_copy(Strip *strip_new, Strip *strip, const int flag)
void foreach_strip_modifier_id(Strip *strip, const FunctionRef< void(ID *)> fn)
bool modifier_move_to_index(Strip *strip, StripModifierData *smd, const int new_index)
void modifier_type_panel_id(eStripModifierType type, char *r_idname)
void modifier_persistent_uid_init(const Strip &strip, StripModifierData &smd)
static constexpr char STRIP_MODIFIER_TYPE_PANEL_PREFIX[]
void modifier_unique_name(Strip *strip, StripModifierData *smd)
void compositor_modifier_nodes_update_interface(Main &bmain, Scene &sequencer_scene, SequencerCompositorModifierData &cmd)
StripModifierData * modifier_find_by_name(Strip *strip, const char *name)
void modifier_free(StripModifierData *smd)
StripModifierData * modifier_copy(Strip &strip_dst, StripModifierData *mod_src, const int flag)
bool modifier_remove(Strip *strip, StripModifierData *smd)
const StripModifierTypeInfo * modifier_type_info_get(eStripModifierType type)
void modifier_set_active(Strip *strip, StripModifierData *smd)
bool strip_supports_modifiers(const Strip *strip)
void modifier_blend_read_data(BlendDataReader *reader, ListBaseT< StripModifierData > *lb)
StripModifierData * modifier_new(Strip *strip, const char *name, eStripModifierType type)
void modifier_blend_write(BlendWriter *writer, ListBaseT< StripModifierData > *modbase)
StripModifierData * modifier_get_active(const Strip *strip)
BMesh Iterators.
unsigned __int64 uint64_t
Definition BKE_text.h:91
void(*) copy_data(StripModifierData *smd, StripModifierData *target)
void(*) blend_write(BlendWriter *writer, const StripModifierData *smd)
void(*) free_data(StripModifierData *smd)
void(*) panel_register(ARegionType *region_type)
void(*) init_data(StripModifierData *smd)
void(*) apply(ModifierApplyContext &context, StripModifierData *smd)
void(*) blend_read(BlendDataReader *reader, StripModifierData *smd)