Animation: Refactor storage usage during fcurve modifier evaluation
[blender.git] / source / blender / blenkernel / BKE_fcurve.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2009 Blender Foundation, Joshua Leung
17  * All rights reserved.
18  */
19
20 #ifndef __BKE_FCURVE_H__
21 #define __BKE_FCURVE_H__
22
23 /** \file
24  * \ingroup bke
25  */
26
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30
31 struct ChannelDriver;
32 struct DriverTarget;
33 struct DriverVar;
34 struct FCM_EnvelopeData;
35 struct FCurve;
36 struct FModifier;
37
38 struct AnimData;
39 struct BezTriple;
40 struct PathResolvedRNA;
41 struct PointerRNA;
42 struct PropertyRNA;
43 struct StructRNA;
44 struct bAction;
45 struct bContext;
46
47 #include "DNA_curve_types.h"
48
49 /* ************** Keyframe Tools ***************** */
50
51 typedef struct CfraElem {
52   struct CfraElem *next, *prev;
53   float cfra;
54   int sel;
55 } CfraElem;
56
57 void bezt_add_to_cfra_elem(ListBase *lb, struct BezTriple *bezt);
58
59 /* ************** F-Curve Drivers ***************** */
60
61 /* With these iterators for convenience, the variables "tarIndex" and "dtar" can be
62  * accessed directly from the code using them, but it is not recommended that their
63  * values be changed to point at other slots...
64  */
65
66 /* convenience looper over ALL driver targets for a given variable (even the unused ones) */
67 #define DRIVER_TARGETS_LOOPER_BEGIN(dvar) \
68   { \
69     DriverTarget *dtar = &dvar->targets[0]; \
70     int tarIndex = 0; \
71     for (; tarIndex < MAX_DRIVER_TARGETS; tarIndex++, dtar++)
72
73 /* convenience looper over USED driver targets only */
74 #define DRIVER_TARGETS_USED_LOOPER_BEGIN(dvar) \
75   { \
76     DriverTarget *dtar = &dvar->targets[0]; \
77     int tarIndex = 0; \
78     for (; tarIndex < dvar->num_targets; tarIndex++, dtar++)
79
80 /* tidy up for driver targets loopers */
81 #define DRIVER_TARGETS_LOOPER_END \
82   } \
83   ((void)0)
84
85 /* ---------------------- */
86
87 void fcurve_free_driver(struct FCurve *fcu);
88 struct ChannelDriver *fcurve_copy_driver(const struct ChannelDriver *driver);
89
90 void driver_variables_copy(struct ListBase *dst_list, const struct ListBase *src_list);
91
92 void driver_free_variable(struct ListBase *variables, struct DriverVar *dvar);
93 void driver_free_variable_ex(struct ChannelDriver *driver, struct DriverVar *dvar);
94
95 void driver_change_variable_type(struct DriverVar *dvar, int type);
96 void driver_variable_name_validate(struct DriverVar *dvar);
97 struct DriverVar *driver_add_new_variable(struct ChannelDriver *driver);
98
99 float driver_get_variable_value(struct ChannelDriver *driver, struct DriverVar *dvar);
100 bool driver_get_variable_property(struct ChannelDriver *driver,
101                                   struct DriverTarget *dtar,
102                                   struct PointerRNA *r_ptr,
103                                   struct PropertyRNA **r_prop,
104                                   int *r_index);
105
106 bool BKE_driver_has_simple_expression(struct ChannelDriver *driver);
107 void BKE_driver_invalidate_expression(struct ChannelDriver *driver,
108                                       bool expr_changed,
109                                       bool varname_changed);
110
111 float evaluate_driver(struct PathResolvedRNA *anim_rna,
112                       struct ChannelDriver *driver,
113                       struct ChannelDriver *driver_orig,
114                       const float evaltime);
115
116 /* ************** F-Curve Modifiers *************** */
117
118 /* F-Curve Modifier Type-Info (fmi):
119  *  This struct provides function pointers for runtime, so that functions can be
120  *  written more generally (with fewer/no special exceptions for various modifiers).
121  *
122  *  Callers of these functions must check that they actually point to something useful,
123  *  as some constraints don't define some of these.
124  *
125  *  Warning: it is not too advisable to reorder order of members of this struct,
126  *           as you'll have to edit quite a few ($FMODIFIER_NUM_TYPES) of these
127  *           structs.
128  */
129 typedef struct FModifierTypeInfo {
130   /* admin/ident */
131   short type;          /* FMODIFIER_TYPE_### */
132   short size;          /* size in bytes of the struct */
133   short acttype;       /* eFMI_Action_Types */
134   short requires;      /* eFMI_Requirement_Flags */
135   char name[64];       /* name of modifier in interface */
136   char structName[64]; /* name of struct for SDNA */
137   uint storage_size;   /* size of buffer that can be reused between time and value evaluation */
138
139   /* data management function pointers - special handling */
140   /* free any data that is allocated separately (optional) */
141   void (*free_data)(struct FModifier *fcm);
142   /* copy any special data that is allocated separately (optional) */
143   void (*copy_data)(struct FModifier *fcm, const struct FModifier *src);
144   /* set settings for data that will be used for FCuModifier.data (memory already allocated using MEM_callocN) */
145   void (*new_data)(void *mdata);
146   /* verifies that the modifier settings are valid */
147   void (*verify_data)(struct FModifier *fcm);
148
149   /* evaluation */
150   /* evaluate time that the modifier requires the F-Curve to be evaluated at */
151   float (*evaluate_modifier_time)(
152       struct FCurve *fcu, struct FModifier *fcm, float cvalue, float evaltime, void *storage);
153   /* evaluate the modifier for the given time and 'accumulated' value */
154   void (*evaluate_modifier)(
155       struct FCurve *fcu, struct FModifier *fcm, float *cvalue, float evaltime, void *storage);
156 } FModifierTypeInfo;
157
158 /* Values which describe the behavior of a FModifier Type */
159 typedef enum eFMI_Action_Types {
160   /* modifier only modifies values outside of data range */
161   FMI_TYPE_EXTRAPOLATION = 0,
162   /* modifier leaves data-points alone, but adjusts the interpolation between and around them */
163   FMI_TYPE_INTERPOLATION,
164   /* modifier only modifies the values of points (but times stay the same) */
165   FMI_TYPE_REPLACE_VALUES,
166   /* modifier generates a curve regardless of what came before */
167   FMI_TYPE_GENERATE_CURVE,
168 } eFMI_Action_Types;
169
170 /* Flags for the requirements of a FModifier Type */
171 typedef enum eFMI_Requirement_Flags {
172   /* modifier requires original data-points (kindof beats the purpose of a modifier stack?) */
173   FMI_REQUIRES_ORIGINAL_DATA = (1 << 0),
174   /* modifier doesn't require on any preceding data (i.e. it will generate a curve).
175    * Use in conjunction with FMI_TYPE_GENRATE_CURVE
176    */
177   FMI_REQUIRES_NOTHING = (1 << 1),
178   /* refer to modifier instance */
179   FMI_REQUIRES_RUNTIME_CHECK = (1 << 2),
180 } eFMI_Requirement_Flags;
181
182 /* Function Prototypes for FModifierTypeInfo's */
183 const FModifierTypeInfo *fmodifier_get_typeinfo(const struct FModifier *fcm);
184 const FModifierTypeInfo *get_fmodifier_typeinfo(const int type);
185
186 /* ---------------------- */
187
188 struct FModifier *add_fmodifier(ListBase *modifiers, int type, struct FCurve *owner_fcu);
189 struct FModifier *copy_fmodifier(const struct FModifier *src);
190 void copy_fmodifiers(ListBase *dst, const ListBase *src);
191 bool remove_fmodifier(ListBase *modifiers, struct FModifier *fcm);
192 void free_fmodifiers(ListBase *modifiers);
193
194 struct FModifier *find_active_fmodifier(ListBase *modifiers);
195 void set_active_fmodifier(ListBase *modifiers, struct FModifier *fcm);
196
197 bool list_has_suitable_fmodifier(ListBase *modifiers, int mtype, short acttype);
198
199 typedef struct FModifiersStackStorage {
200   uint modifier_count;
201   uint size_per_modifier;
202   void *buffer;
203 } FModifiersStackStorage;
204
205 uint evaluate_fmodifiers_storage_size_per_modifier(ListBase *modifiers);
206 float evaluate_time_fmodifiers(FModifiersStackStorage *storage,
207                                ListBase *modifiers,
208                                struct FCurve *fcu,
209                                float cvalue,
210                                float evaltime);
211 void evaluate_value_fmodifiers(FModifiersStackStorage *storage,
212                                ListBase *modifiers,
213                                struct FCurve *fcu,
214                                float *cvalue,
215                                float evaltime);
216
217 void fcurve_bake_modifiers(struct FCurve *fcu, int start, int end);
218
219 int BKE_fcm_envelope_find_index(struct FCM_EnvelopeData *array,
220                                 float frame,
221                                 int arraylen,
222                                 bool *r_exists);
223
224 /* ************** F-Curves API ******************** */
225
226 /* threshold for binary-searching keyframes - threshold here should be good enough for now, but should become userpref */
227 #define BEZT_BINARYSEARCH_THRESH 0.01f /* was 0.00001, but giving errors */
228
229 /* -------- Data Management  --------  */
230
231 void free_fcurve(struct FCurve *fcu);
232 struct FCurve *copy_fcurve(const struct FCurve *fcu);
233
234 void free_fcurves(ListBase *list);
235 void copy_fcurves(ListBase *dst, ListBase *src);
236
237 /* find matching F-Curve in the given list of F-Curves */
238 struct FCurve *list_find_fcurve(ListBase *list, const char rna_path[], const int array_index);
239
240 struct FCurve *iter_step_fcurve(struct FCurve *fcu_iter, const char rna_path[]);
241
242 /* high level function to get an fcurve from C without having the rna */
243 struct FCurve *id_data_find_fcurve(
244     ID *id, void *data, struct StructRNA *type, const char *prop_name, int index, bool *r_driven);
245
246 /* Get list of LinkData's containing pointers to the F-Curves which control the types of data indicated
247  * e.g.  numMatches = list_find_data_fcurves(matches, &act->curves, "pose.bones[", "MyFancyBone");
248  */
249 int list_find_data_fcurves(ListBase *dst,
250                            ListBase *src,
251                            const char *dataPrefix,
252                            const char *dataName);
253
254 /* Find an f-curve based on an rna property. */
255 struct FCurve *rna_get_fcurve(struct PointerRNA *ptr,
256                               struct PropertyRNA *prop,
257                               int rnaindex,
258                               struct AnimData **r_adt,
259                               struct bAction **r_action,
260                               bool *r_driven,
261                               bool *r_special);
262 /* Same as above, but takes a context data, temp hack needed for complex paths like texture ones. */
263 struct FCurve *rna_get_fcurve_context_ui(struct bContext *C,
264                                          struct PointerRNA *ptr,
265                                          struct PropertyRNA *prop,
266                                          int rnaindex,
267                                          struct AnimData **r_adt,
268                                          struct bAction **r_action,
269                                          bool *r_driven,
270                                          bool *r_special);
271
272 /* Binary search algorithm for finding where to 'insert' BezTriple with given frame number.
273  * Returns the index to insert at (data already at that index will be offset if replace is 0)
274  */
275 int binarysearch_bezt_index(struct BezTriple array[], float frame, int arraylen, bool *r_replace);
276
277 /* get the time extents for F-Curve */
278 bool calc_fcurve_range(
279     struct FCurve *fcu, float *min, float *max, const bool do_sel_only, const bool do_min_length);
280
281 /* get the bounding-box extents for F-Curve */
282 bool calc_fcurve_bounds(struct FCurve *fcu,
283                         float *xmin,
284                         float *xmax,
285                         float *ymin,
286                         float *ymax,
287                         const bool do_sel_only,
288                         const bool include_handles);
289
290 /* .............. */
291
292 /* Are keyframes on F-Curve of any use (to final result, and to show in editors)? */
293 bool fcurve_are_keyframes_usable(struct FCurve *fcu);
294
295 /* Can keyframes be added to F-Curve? */
296 bool fcurve_is_keyframable(struct FCurve *fcu);
297 bool BKE_fcurve_is_protected(struct FCurve *fcu);
298
299 /* The curve is an infinite cycle via Cycles modifier */
300 bool BKE_fcurve_is_cyclic(struct FCurve *fcu);
301
302 /* Type of infinite cycle for a curve. */
303 typedef enum eFCU_Cycle_Type {
304   FCU_CYCLE_NONE = 0,
305   /* The cycle repeats identically to the base range. */
306   FCU_CYCLE_PERFECT,
307   /* The cycle accumulates the change between start and end keys. */
308   FCU_CYCLE_OFFSET,
309 } eFCU_Cycle_Type;
310
311 eFCU_Cycle_Type BKE_fcurve_get_cycle_type(struct FCurve *fcu);
312
313 /* -------- Curve Sanity --------  */
314
315 void calchandles_fcurve(struct FCurve *fcu);
316 void testhandles_fcurve(struct FCurve *fcu, const bool use_handle);
317 void sort_time_fcurve(struct FCurve *fcu);
318 short test_time_fcurve(struct FCurve *fcu);
319
320 void correct_bezpart(float v1[2], float v2[2], float v3[2], float v4[2]);
321
322 /* -------- Evaluation --------  */
323
324 /* evaluate fcurve */
325 float evaluate_fcurve(struct FCurve *fcu, float evaltime);
326 float evaluate_fcurve_only_curve(struct FCurve *fcu, float evaltime);
327 float evaluate_fcurve_driver(struct PathResolvedRNA *anim_rna,
328                              struct FCurve *fcu,
329                              struct ChannelDriver *driver_orig,
330                              float evaltime);
331 /* evaluate fcurve and store value */
332 float calculate_fcurve(struct PathResolvedRNA *anim_rna, struct FCurve *fcu, float evaltime);
333
334 /* ************* F-Curve Samples API ******************** */
335
336 /* -------- Defines --------  */
337
338 /* Basic signature for F-Curve sample-creation function
339  * - fcu: the F-Curve being operated on
340  * - data: pointer to some specific data that may be used by one of the callbacks
341  */
342 typedef float (*FcuSampleFunc)(struct FCurve *fcu, void *data, float evaltime);
343
344 /* ----- Sampling Callbacks ------  */
345
346 /* Basic sampling callback which acts as a wrapper for evaluate_fcurve() */
347 float fcurve_samplingcb_evalcurve(struct FCurve *fcu, void *data, float evaltime);
348
349 /* -------- Main Methods --------  */
350
351 /* Main API function for creating a set of sampled curve data, given some callback function
352  * used to retrieve the values to store.
353  */
354 void fcurve_store_samples(
355     struct FCurve *fcu, void *data, int start, int end, FcuSampleFunc sample_cb);
356
357 #ifdef __cplusplus
358 }
359 #endif
360
361 #endif /* __BKE_FCURVE_H__*/