sim: Remove "continue physics" code
[blender.git] / source / blender / blenkernel / intern / fmodifier.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2009 Blender Foundation, Joshua Leung
19  * All rights reserved.
20  *
21  * Contributor(s): Joshua Leung (full recode)
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 /** \file blender/blenkernel/intern/fmodifier.c
27  *  \ingroup bke
28  */
29
30
31
32 #include <math.h>
33 #include <stdio.h>
34 #include <stddef.h>
35 #include <string.h>
36 #include <float.h>
37
38 #include "MEM_guardedalloc.h"
39
40 #include "DNA_anim_types.h"
41
42 #include "BLF_translation.h"
43
44 #include "BLI_blenlib.h"
45 #include "BLI_noise.h"
46 #include "BLI_math.h" /* windows needs for M_PI */
47 #include "BLI_utildefines.h"
48
49 #include "BKE_fcurve.h"
50 #include "BKE_idprop.h"
51
52 /* ******************************** F-Modifiers ********************************* */
53
54 /* Info ------------------------------- */
55
56 /* F-Modifiers are modifiers which operate on F-Curves. However, they can also be defined
57  * on NLA-Strips to affect all of the F-Curves referenced by the NLA-Strip. 
58  */
59
60 /* Template --------------------------- */
61
62 /* Each modifier defines a set of functions, which will be called at the appropriate
63  * times. In addition to this, each modifier should have a type-info struct, where
64  * its functions are attached for use. 
65  */
66  
67 /* Template for type-info data:
68  *  - make a copy of this when creating new modifiers, and just change the functions
69  *    pointed to as necessary
70  *  - although the naming of functions doesn't matter, it would help for code
71  *    readability, to follow the same naming convention as is presented here
72  *  - any functions that a constraint doesn't need to define, don't define
73  *    for such cases, just use NULL 
74  *  - these should be defined after all the functions have been defined, so that
75  *    forward-definitions/prototypes don't need to be used!
76  *      - keep this copy #if-def'd so that future constraints can get based off this
77  */
78 #if 0
79 static FModifierTypeInfo FMI_MODNAME = {
80         FMODIFIER_TYPE_MODNAME, /* type */
81         sizeof(FMod_ModName), /* size */
82         FMI_TYPE_SOME_ACTION, /* action type */
83         FMI_REQUIRES_SOME_REQUIREMENT, /* requirements */
84         "Modifier Name", /* name */
85         "FMod_ModName", /* struct name */
86         fcm_modname_free, /* free data */
87         fcm_modname_relink, /* relink data */
88         fcm_modname_copy, /* copy data */
89         fcm_modname_new_data, /* new data */
90         fcm_modname_verify, /* verify */
91         fcm_modname_time, /* evaluate time */
92         fcm_modname_evaluate /* evaluate */
93 };
94 #endif
95
96 /* Generator F-Curve Modifier --------------------------- */
97
98 /* Generators available:
99  *  1) simple polynomial generator:
100  *              - Exanded form - (y = C[0]*(x^(n)) + C[1]*(x^(n-1)) + ... + C[n])  
101  *              - Factorized form - (y = (C[0][0]*x + C[0][1]) * (C[1][0]*x + C[1][1]) * ... * (C[n][0]*x + C[n][1]))
102  */
103
104 static void fcm_generator_free(FModifier *fcm)
105 {
106         FMod_Generator *data = (FMod_Generator *)fcm->data;
107         
108         /* free polynomial coefficients array */
109         if (data->coefficients)
110                 MEM_freeN(data->coefficients);
111 }
112
113 static void fcm_generator_copy(FModifier *fcm, FModifier *src)
114 {
115         FMod_Generator *gen = (FMod_Generator *)fcm->data;
116         FMod_Generator *ogen = (FMod_Generator *)src->data;
117         
118         /* copy coefficients array? */
119         if (ogen->coefficients)
120                 gen->coefficients = MEM_dupallocN(ogen->coefficients);
121 }
122
123 static void fcm_generator_new_data(void *mdata)
124 {
125         FMod_Generator *data = (FMod_Generator *)mdata;
126         float *cp;
127         
128         /* set default generator to be linear 0-1 (gradient = 1, y-offset = 0) */
129         data->poly_order = 1;
130         data->arraysize = 2;
131         cp = data->coefficients = MEM_callocN(sizeof(float) * 2, "FMod_Generator_Coefs");
132         cp[0] = 0; // y-offset 
133         cp[1] = 1; // gradient
134 }
135
136 static void fcm_generator_verify(FModifier *fcm)
137 {
138         FMod_Generator *data = (FMod_Generator *)fcm->data;
139         
140         /* requirements depend on mode */
141         switch (data->mode) {
142                 case FCM_GENERATOR_POLYNOMIAL: /* expanded polynomial expression */
143                 {
144                         const int arraysize_new = data->poly_order + 1;
145                         /* arraysize needs to be order+1, so resize if not */
146                         if (data->arraysize != arraysize_new) {
147                                 if (data->coefficients) {
148                                         data->coefficients = MEM_recallocN(data->coefficients, sizeof(float) * arraysize_new);
149                                 }
150                                 else {
151                                         data->coefficients = MEM_callocN(sizeof(float) * arraysize_new, "FMod_Generator_Coefs");
152                                 }
153                                 data->arraysize = arraysize_new;
154                         }
155                         break;
156                 }
157                 case FCM_GENERATOR_POLYNOMIAL_FACTORISED: /* expanded polynomial expression */
158                 {
159                         const int arraysize_new = data->poly_order * 2;
160                         /* arraysize needs to be (2 * order), so resize if not */
161                         if (data->arraysize != arraysize_new) {
162                                 if (data->coefficients) {
163                                         data->coefficients = MEM_recallocN(data->coefficients, sizeof(float) * arraysize_new);
164                                 }
165                                 else {
166                                         data->coefficients = MEM_callocN(sizeof(float) * arraysize_new, "FMod_Generator_Coefs");
167                                 }
168                                 data->arraysize = arraysize_new;
169                         }
170                         break;
171                 }
172         }
173 }
174
175 static void fcm_generator_evaluate(FCurve *UNUSED(fcu), FModifier *fcm, float *cvalue, float evaltime)
176 {
177         FMod_Generator *data = (FMod_Generator *)fcm->data;
178         
179         /* behavior depends on mode 
180          * NOTE: the data in its default state is fine too
181          */
182         switch (data->mode) {
183                 case FCM_GENERATOR_POLYNOMIAL: /* expanded polynomial expression */
184                 {
185                         /* we overwrite cvalue with the sum of the polynomial */
186                         float *powers = MEM_callocN(sizeof(float) * data->arraysize, "Poly Powers");
187                         float value = 0.0f;
188                         unsigned int i;
189                         
190                         /* for each x^n, precalculate value based on previous one first... this should be 
191                          * faster that calling pow() for each entry
192                          */
193                         for (i = 0; i < data->arraysize; i++) {
194                                 /* first entry is x^0 = 1, otherwise, calculate based on previous */
195                                 if (i)
196                                         powers[i] = powers[i - 1] * evaltime;
197                                 else
198                                         powers[0] = 1;
199                         }
200                         
201                         /* for each coefficient, add to value, which we'll write to *cvalue in one go */
202                         for (i = 0; i < data->arraysize; i++)
203                                 value += data->coefficients[i] * powers[i];
204                         
205                         /* only if something changed, write *cvalue in one go */
206                         if (data->poly_order) {
207                                 if (data->flag & FCM_GENERATOR_ADDITIVE)
208                                         *cvalue += value;
209                                 else
210                                         *cvalue = value;
211                         }
212                                 
213                         /* cleanup */
214                         if (powers) 
215                                 MEM_freeN(powers);
216                 }
217                 break;
218                         
219                 case FCM_GENERATOR_POLYNOMIAL_FACTORISED: /* Factorized polynomial */
220                 {
221                         float value = 1.0f, *cp = NULL;
222                         unsigned int i;
223                         
224                         /* for each coefficient pair, solve for that bracket before accumulating in value by multiplying */
225                         for (cp = data->coefficients, i = 0; (cp) && (i < (unsigned int)data->poly_order); cp += 2, i++)
226                                 value *= (cp[0] * evaltime + cp[1]);
227                                 
228                         /* only if something changed, write *cvalue in one go */
229                         if (data->poly_order) {
230                                 if (data->flag & FCM_GENERATOR_ADDITIVE)
231                                         *cvalue += value;
232                                 else
233                                         *cvalue = value;
234                         }
235                 }
236                 break;
237         }
238 }
239
240 static FModifierTypeInfo FMI_GENERATOR = {
241         FMODIFIER_TYPE_GENERATOR, /* type */
242         sizeof(FMod_Generator), /* size */
243         FMI_TYPE_GENERATE_CURVE, /* action type */
244         FMI_REQUIRES_NOTHING, /* requirements */
245         N_("Generator"), /* name */
246         "FMod_Generator", /* struct name */
247         fcm_generator_free, /* free data */
248         fcm_generator_copy, /* copy data */
249         fcm_generator_new_data, /* new data */
250         fcm_generator_verify, /* verify */
251         NULL, /* evaluate time */
252         fcm_generator_evaluate /* evaluate */
253 };
254
255 /* Built-In Function Generator F-Curve Modifier --------------------------- */
256
257 /* This uses the general equation for equations:
258  *   y = amplitude * fn(phase_multiplier * x + phase_offset) + y_offset
259  *
260  * where amplitude, phase_multiplier/offset, y_offset are user-defined coefficients,
261  * x is the evaluation 'time', and 'y' is the resultant value
262  *
263  * Functions available are
264  *      sin, cos, tan, sinc (normalized sin), natural log, square root 
265  */
266
267 static void fcm_fn_generator_new_data(void *mdata)
268 {
269         FMod_FunctionGenerator *data = (FMod_FunctionGenerator *)mdata;
270         
271         /* set amplitude and phase multiplier to 1.0f so that something is generated */
272         data->amplitude = 1.0f;
273         data->phase_multiplier = 1.0f;
274 }
275
276 /* Unary 'normalized sine' function
277  *  y = sin(PI + x) / (PI * x),
278  * except for x = 0 when y = 1.
279  */
280 static double sinc(double x)
281 {
282         if (fabs(x) < 0.0001)
283                 return 1.0;
284         else
285                 return sin(M_PI * x) / (M_PI * x);
286 }
287
288 static void fcm_fn_generator_evaluate(FCurve *UNUSED(fcu), FModifier *fcm, float *cvalue, float evaltime)
289 {
290         FMod_FunctionGenerator *data = (FMod_FunctionGenerator *)fcm->data;
291         double arg = data->phase_multiplier * evaltime + data->phase_offset;
292         double (*fn)(double v) = NULL;
293         
294         /* get function pointer to the func to use:
295          * WARNING: must perform special argument validation hereto guard against crashes  
296          */
297         switch (data->type) {
298                 /* simple ones */
299                 case FCM_GENERATOR_FN_SIN: /* sine wave */
300                         fn = sin;
301                         break;
302                 case FCM_GENERATOR_FN_COS: /* cosine wave */
303                         fn = cos;
304                         break;
305                 case FCM_GENERATOR_FN_SINC: /* normalized sine wave */
306                         fn = sinc;
307                         break;
308                         
309                 /* validation required */
310                 case FCM_GENERATOR_FN_TAN: /* tangent wave */
311                 {
312                         /* check that argument is not on one of the discontinuities (i.e. 90deg, 270 deg, etc) */
313                         if (IS_EQ(fmod((arg - M_PI_2), M_PI), 0.0)) {
314                                 if ((data->flag & FCM_GENERATOR_ADDITIVE) == 0)
315                                         *cvalue = 0.0f;  /* no value possible here */
316                         }
317                         else
318                                 fn = tan;
319                 }
320                 break;
321                 case FCM_GENERATOR_FN_LN: /* natural log */
322                 {
323                         /* check that value is greater than 1? */
324                         if (arg > 1.0) {
325                                 fn = log;
326                         }
327                         else {
328                                 if ((data->flag & FCM_GENERATOR_ADDITIVE) == 0)
329                                         *cvalue = 0.0f;  /* no value possible here */
330                         }
331                 }
332                 break;
333                 case FCM_GENERATOR_FN_SQRT: /* square root */
334                 {
335                         /* no negative numbers */
336                         if (arg > 0.0) {
337                                 fn = sqrt;
338                         }
339                         else {
340                                 if ((data->flag & FCM_GENERATOR_ADDITIVE) == 0)
341                                         *cvalue = 0.0f;  /* no value possible here */
342                         }
343                 }
344                 break;
345                 
346                 default:
347                         printf("Invalid Function-Generator for F-Modifier - %d\n", data->type);
348         }
349         
350         /* execute function callback to set value if appropriate */
351         if (fn) {
352                 float value = (float)(data->amplitude * (float)fn(arg) + data->value_offset);
353                 
354                 if (data->flag & FCM_GENERATOR_ADDITIVE)
355                         *cvalue += value;
356                 else
357                         *cvalue = value;
358         }
359 }
360
361 static FModifierTypeInfo FMI_FN_GENERATOR = {
362         FMODIFIER_TYPE_FN_GENERATOR, /* type */
363         sizeof(FMod_FunctionGenerator), /* size */
364         FMI_TYPE_GENERATE_CURVE, /* action type */
365         FMI_REQUIRES_NOTHING, /* requirements */
366         N_("Built-In Function"), /* name */
367         "FMod_FunctionGenerator", /* struct name */
368         NULL, /* free data */
369         NULL, /* copy data */
370         fcm_fn_generator_new_data, /* new data */
371         NULL, /* verify */
372         NULL, /* evaluate time */
373         fcm_fn_generator_evaluate /* evaluate */
374 };
375
376 /* Envelope F-Curve Modifier --------------------------- */
377
378 static void fcm_envelope_free(FModifier *fcm)
379 {
380         FMod_Envelope *env = (FMod_Envelope *)fcm->data;
381         
382         /* free envelope data array */
383         if (env->data)
384                 MEM_freeN(env->data);
385 }
386
387 static void fcm_envelope_copy(FModifier *fcm, FModifier *src)
388 {
389         FMod_Envelope *env = (FMod_Envelope *)fcm->data;
390         FMod_Envelope *oenv = (FMod_Envelope *)src->data;
391         
392         /* copy envelope data array */
393         if (oenv->data)
394                 env->data = MEM_dupallocN(oenv->data);
395 }
396
397 static void fcm_envelope_new_data(void *mdata)
398 {
399         FMod_Envelope *env = (FMod_Envelope *)mdata;
400         
401         /* set default min/max ranges */
402         env->min = -1.0f;
403         env->max = 1.0f;
404 }
405
406 static void fcm_envelope_verify(FModifier *fcm)
407 {
408         FMod_Envelope *env = (FMod_Envelope *)fcm->data;
409         
410         /* if the are points, perform bubble-sort on them, as user may have changed the order */
411         if (env->data) {
412                 /* XXX todo... */
413         }
414 }
415
416 static void fcm_envelope_evaluate(FCurve *UNUSED(fcu), FModifier *fcm, float *cvalue, float evaltime)
417 {
418         FMod_Envelope *env = (FMod_Envelope *)fcm->data;
419         FCM_EnvelopeData *fed, *prevfed, *lastfed;
420         float min = 0.0f, max = 0.0f, fac = 0.0f;
421         int a;
422         
423         /* get pointers */
424         if (env->data == NULL) return;
425         prevfed = env->data;
426         fed = prevfed + 1;
427         lastfed = prevfed + (env->totvert - 1);
428         
429         /* get min/max values for envelope at evaluation time (relative to mid-value) */
430         if (prevfed->time >= evaltime) {
431                 /* before or on first sample, so just extend value */
432                 min = prevfed->min;
433                 max = prevfed->max;
434         }
435         else if (lastfed->time <= evaltime) {
436                 /* after or on last sample, so just extend value */
437                 min = lastfed->min;
438                 max = lastfed->max;
439         }
440         else {
441                 /* evaltime occurs somewhere between segments */
442                 /* TODO: implement binary search for this to make it faster? */
443                 for (a = 0; prevfed && fed && (a < env->totvert - 1); a++, prevfed = fed, fed++) {
444                         /* evaltime occurs within the interval defined by these two envelope points */
445                         if ((prevfed->time <= evaltime) && (fed->time >= evaltime)) {
446                                 float afac, bfac, diff;
447                                 
448                                 diff = fed->time - prevfed->time;
449                                 afac = (evaltime - prevfed->time) / diff;
450                                 bfac = (fed->time - evaltime) / diff;
451                                 
452                                 min = bfac * prevfed->min + afac * fed->min;
453                                 max = bfac * prevfed->max + afac * fed->max;
454                                 
455                                 break;
456                         }
457                 }
458         }
459         
460         /* adjust *cvalue 
461          *      - fac is the ratio of how the current y-value corresponds to the reference range
462          *      - thus, the new value is found by mapping the old range to the new!
463          */
464         fac = (*cvalue - (env->midval + env->min)) / (env->max - env->min);
465         *cvalue = min + fac * (max - min);
466 }
467
468 static FModifierTypeInfo FMI_ENVELOPE = {
469         FMODIFIER_TYPE_ENVELOPE, /* type */
470         sizeof(FMod_Envelope), /* size */
471         FMI_TYPE_REPLACE_VALUES, /* action type */
472         0, /* requirements */
473         N_("Envelope"), /* name */
474         "FMod_Envelope", /* struct name */
475         fcm_envelope_free, /* free data */
476         fcm_envelope_copy, /* copy data */
477         fcm_envelope_new_data, /* new data */
478         fcm_envelope_verify, /* verify */
479         NULL, /* evaluate time */
480         fcm_envelope_evaluate /* evaluate */
481 };
482
483 /* Cycles F-Curve Modifier  --------------------------- */
484
485 /* This modifier changes evaltime to something that exists within the curve's frame-range, 
486  * then re-evaluates modifier stack up to this point using the new time. This re-entrant behavior
487  * is very likely to be more time-consuming than the original approach... (which was tightly integrated into
488  * the calculation code...).
489  *
490  * NOTE: this needs to be at the start of the stack to be of use, as it needs to know the extents of the
491  * keyframes/sample-data.
492  *
493  * Possible TODO - store length of cycle information that can be initialized from the extents of the
494  * keyframes/sample-data, and adjusted as appropriate.
495  */
496
497 /* temp data used during evaluation */
498 typedef struct tFCMED_Cycles {
499         float cycyofs;      /* y-offset to apply */
500 } tFCMED_Cycles;
501  
502 static void fcm_cycles_new_data(void *mdata)
503 {
504         FMod_Cycles *data = (FMod_Cycles *)mdata;
505         
506         /* turn on cycles by default */
507         data->before_mode = data->after_mode = FCM_EXTRAPOLATE_CYCLIC;
508 }
509
510 static float fcm_cycles_time(FCurve *fcu, FModifier *fcm, float UNUSED(cvalue), float evaltime)
511 {
512         FMod_Cycles *data = (FMod_Cycles *)fcm->data;
513         float prevkey[2], lastkey[2], cycyofs = 0.0f;
514         short side = 0, mode = 0;
515         int cycles = 0, ofs = 0;
516         
517         /* check if modifier is first in stack, otherwise disable ourself... */
518         /* FIXME... */
519         if (fcm->prev) {
520                 fcm->flag |= FMODIFIER_FLAG_DISABLED;
521                 return evaltime;
522         }
523         
524         /* calculate new evaltime due to cyclic interpolation */
525         if (fcu && fcu->bezt) {
526                 BezTriple *prevbezt = fcu->bezt;
527                 BezTriple *lastbezt = prevbezt + fcu->totvert - 1;
528                 
529                 prevkey[0] = prevbezt->vec[1][0];
530                 prevkey[1] = prevbezt->vec[1][1];
531                 
532                 lastkey[0] = lastbezt->vec[1][0];
533                 lastkey[1] = lastbezt->vec[1][1];
534         }
535         else if (fcu && fcu->fpt) {
536                 FPoint *prevfpt = fcu->fpt;
537                 FPoint *lastfpt = prevfpt + fcu->totvert - 1;
538                 
539                 prevkey[0] = prevfpt->vec[0];
540                 prevkey[1] = prevfpt->vec[1];
541                 
542                 lastkey[0] = lastfpt->vec[0];
543                 lastkey[1] = lastfpt->vec[1];
544         }
545         else
546                 return evaltime;
547                 
548         /* check if modifier will do anything
549          *      1) if in data range, definitely don't do anything
550          *      2) if before first frame or after last frame, make sure some cycling is in use
551          */
552         if (evaltime < prevkey[0]) {
553                 if (data->before_mode) {
554                         side = -1;
555                         mode = data->before_mode;
556                         cycles = data->before_cycles;
557                         ofs = prevkey[0];
558                 }
559         }
560         else if (evaltime > lastkey[0]) {
561                 if (data->after_mode) {
562                         side = 1;
563                         mode = data->after_mode;
564                         cycles = data->after_cycles;
565                         ofs = lastkey[0];
566                 }
567         }
568         if ((ELEM(0, side, mode)))
569                 return evaltime;
570                 
571         /* find relative place within a cycle */
572         {
573                 float cycdx = 0, cycdy = 0;
574                 float cycle = 0, cyct = 0;
575                 
576                 /* calculate period and amplitude (total height) of a cycle */
577                 cycdx = lastkey[0] - prevkey[0];
578                 cycdy = lastkey[1] - prevkey[1];
579                 
580                 /* check if cycle is infinitely small, to be point of being impossible to use */
581                 if (cycdx == 0)
582                         return evaltime;
583                         
584                 /* calculate the 'number' of the cycle */
585                 cycle = ((float)side * (evaltime - ofs) / cycdx);
586                 
587                 /* calculate the time inside the cycle */
588                 cyct = fmod(evaltime - ofs, cycdx);
589                 
590                 /* check that cyclic is still enabled for the specified time */
591                 if (cycles == 0) {
592                         /* catch this case so that we don't exit when we have (cycles = 0)
593                          * as this indicates infinite cycles...
594                          */
595                 }
596                 else if (cycle > cycles) {
597                         /* we are too far away from range to evaluate
598                          * TODO: but we should still hold last value... 
599                          */
600                         return evaltime;
601                 }
602                 
603                 /* check if 'cyclic extrapolation', and thus calculate y-offset for this cycle */
604                 if (mode == FCM_EXTRAPOLATE_CYCLIC_OFFSET) {
605                         if (side < 0)
606                                 cycyofs = (float)floor((evaltime - ofs) / cycdx);
607                         else
608                                 cycyofs = (float)ceil((evaltime - ofs) / cycdx);
609                         cycyofs *= cycdy;
610                 }
611                 
612                 /* special case for cycle start/end */
613                 if (cyct == 0.0f) {
614                         evaltime = (side == 1 ? lastkey[0] : prevkey[0]);
615                         
616                         if ((mode == FCM_EXTRAPOLATE_MIRROR) && ((int)cycle % 2))
617                                 evaltime = (side == 1 ? prevkey[0] : lastkey[0]);
618                 }
619                 /* calculate where in the cycle we are (overwrite evaltime to reflect this) */
620                 else if ((mode == FCM_EXTRAPOLATE_MIRROR) && ((int)(cycle + 1) % 2)) {
621                         /* when 'mirror' option is used and cycle number is odd, this cycle is played in reverse 
622                          *      - for 'before' extrapolation, we need to flip in a different way, otherwise values past
623                          *        then end of the curve get referenced (result of fmod will be negative, and with different phase)
624                          */
625                         if (side < 0)
626                                 evaltime = prevkey[0] - cyct;
627                         else
628                                 evaltime = lastkey[0] - cyct;
629                 }
630                 else {
631                         /* the cycle is played normally... */
632                         evaltime = prevkey[0] + cyct;
633                 }
634                 if (evaltime < prevkey[0]) evaltime += cycdx;
635         }
636         
637         /* store temp data if needed */
638         if (mode == FCM_EXTRAPOLATE_CYCLIC_OFFSET) {
639                 tFCMED_Cycles *edata;
640                 
641                 /* for now, this is just a float, but we could get more stuff... */
642                 fcm->edata = edata = MEM_callocN(sizeof(tFCMED_Cycles), "tFCMED_Cycles");
643                 edata->cycyofs = cycyofs;
644         }
645         
646         /* return the new frame to evaluate */
647         return evaltime;
648 }
649  
650 static void fcm_cycles_evaluate(FCurve *UNUSED(fcu), FModifier *fcm, float *cvalue, float UNUSED(evaltime))
651 {
652         tFCMED_Cycles *edata = (tFCMED_Cycles *)fcm->edata;
653         
654         /* use temp data */
655         if (edata) {
656                 /* add cyclic offset - no need to check for now, otherwise the data wouldn't exist! */
657                 *cvalue += edata->cycyofs;
658                 
659                 /* free temp data */
660                 MEM_freeN(edata);
661                 fcm->edata = NULL;
662         }
663 }
664
665 static FModifierTypeInfo FMI_CYCLES = {
666         FMODIFIER_TYPE_CYCLES, /* type */
667         sizeof(FMod_Cycles), /* size */
668         FMI_TYPE_EXTRAPOLATION, /* action type */
669         FMI_REQUIRES_ORIGINAL_DATA, /* requirements */
670         N_("Cycles"), /* name */
671         "FMod_Cycles", /* struct name */
672         NULL, /* free data */
673         NULL, /* copy data */
674         fcm_cycles_new_data, /* new data */
675         NULL /*fcm_cycles_verify*/, /* verify */
676         fcm_cycles_time, /* evaluate time */
677         fcm_cycles_evaluate /* evaluate */
678 };
679
680 /* Noise F-Curve Modifier  --------------------------- */
681
682 static void fcm_noise_new_data(void *mdata)
683 {
684         FMod_Noise *data = (FMod_Noise *)mdata;
685         
686         /* defaults */
687         data->size = 1.0f;
688         data->strength = 1.0f;
689         data->phase = 1.0f;
690         data->depth = 0;
691         data->modification = FCM_NOISE_MODIF_REPLACE;
692 }
693  
694 static void fcm_noise_evaluate(FCurve *UNUSED(fcu), FModifier *fcm, float *cvalue, float evaltime)
695 {
696         FMod_Noise *data = (FMod_Noise *)fcm->data;
697         float noise;
698         
699         /* generate noise using good ol' Blender Noise
700          *      - 0.1 is passed as the 'z' value, otherwise evaluation fails for size = phase = 1
701          *        with evaltime being an integer (which happens when evaluating on frame by frame basis)
702          */
703         noise = BLI_turbulence(data->size, evaltime, data->phase, 0.1f, data->depth);
704         
705         /* combine the noise with existing motion data */
706         switch (data->modification) {
707                 case FCM_NOISE_MODIF_ADD:
708                         *cvalue = *cvalue + noise * data->strength;
709                         break;
710                 case FCM_NOISE_MODIF_SUBTRACT:
711                         *cvalue = *cvalue - noise * data->strength;
712                         break;
713                 case FCM_NOISE_MODIF_MULTIPLY:
714                         *cvalue = *cvalue * noise * data->strength;
715                         break;
716                 case FCM_NOISE_MODIF_REPLACE:
717                 default:
718                         *cvalue = *cvalue + (noise - 0.5f) * data->strength;
719                         break;
720         }
721 }
722
723 static FModifierTypeInfo FMI_NOISE = {
724         FMODIFIER_TYPE_NOISE, /* type */
725         sizeof(FMod_Noise), /* size */
726         FMI_TYPE_REPLACE_VALUES, /* action type */
727         0, /* requirements */
728         N_("Noise"), /* name */
729         "FMod_Noise", /* struct name */
730         NULL, /* free data */
731         NULL, /* copy data */
732         fcm_noise_new_data, /* new data */
733         NULL /*fcm_noise_verify*/, /* verify */
734         NULL, /* evaluate time */
735         fcm_noise_evaluate /* evaluate */
736 };
737
738 /* Filter F-Curve Modifier --------------------------- */
739
740 #if 0 // XXX not yet implemented 
741 static FModifierTypeInfo FMI_FILTER = {
742         FMODIFIER_TYPE_FILTER, /* type */
743         sizeof(FMod_Filter), /* size */
744         FMI_TYPE_REPLACE_VALUES, /* action type */
745         0, /* requirements */
746         N_("Filter"), /* name */
747         "FMod_Filter", /* struct name */
748         NULL, /* free data */
749         NULL, /* copy data */
750         NULL, /* new data */
751         NULL /*fcm_filter_verify*/, /* verify */
752         NULL, /* evlauate time */
753         fcm_filter_evaluate /* evaluate */
754 };
755 #endif // XXX not yet implemented
756
757
758 /* Python F-Curve Modifier --------------------------- */
759
760 static void fcm_python_free(FModifier *fcm)
761 {
762         FMod_Python *data = (FMod_Python *)fcm->data;
763         
764         /* id-properties */
765         IDP_FreeProperty(data->prop);
766         MEM_freeN(data->prop);
767 }
768
769 static void fcm_python_new_data(void *mdata)
770 {
771         FMod_Python *data = (FMod_Python *)mdata;
772         
773         /* everything should be set correctly by calloc, except for the prop->type constant.*/
774         data->prop = MEM_callocN(sizeof(IDProperty), "PyFModifierProps");
775         data->prop->type = IDP_GROUP;
776 }
777
778 static void fcm_python_copy(FModifier *fcm, FModifier *src)
779 {
780         FMod_Python *pymod = (FMod_Python *)fcm->data;
781         FMod_Python *opymod = (FMod_Python *)src->data;
782         
783         pymod->prop = IDP_CopyProperty(opymod->prop);
784 }
785
786 static void fcm_python_evaluate(FCurve *UNUSED(fcu), FModifier *UNUSED(fcm), float *UNUSED(cvalue), float UNUSED(evaltime))
787 {
788 #ifdef WITH_PYTHON
789         //FMod_Python *data = (FMod_Python *)fcm->data;
790         
791         /* FIXME... need to implement this modifier...
792          *      It will need it execute a script using the custom properties 
793          */
794 #endif /* WITH_PYTHON */
795 }
796
797 static FModifierTypeInfo FMI_PYTHON = {
798         FMODIFIER_TYPE_PYTHON, /* type */
799         sizeof(FMod_Python), /* size */
800         FMI_TYPE_GENERATE_CURVE, /* action type */
801         FMI_REQUIRES_RUNTIME_CHECK, /* requirements */
802         N_("Python"), /* name */
803         "FMod_Python", /* struct name */
804         fcm_python_free, /* free data */
805         fcm_python_copy, /* copy data */
806         fcm_python_new_data, /* new data */
807         NULL /*fcm_python_verify*/, /* verify */
808         NULL /*fcm_python_time*/, /* evaluate time */
809         fcm_python_evaluate /* evaluate */
810 };
811
812
813 /* Limits F-Curve Modifier --------------------------- */
814
815 static float fcm_limits_time(FCurve *UNUSED(fcu), FModifier *fcm, float UNUSED(cvalue), float evaltime)
816 {
817         FMod_Limits *data = (FMod_Limits *)fcm->data;
818         
819         /* check for the time limits */
820         if ((data->flag & FCM_LIMIT_XMIN) && (evaltime < data->rect.xmin))
821                 return data->rect.xmin;
822         if ((data->flag & FCM_LIMIT_XMAX) && (evaltime > data->rect.xmax))
823                 return data->rect.xmax;
824                 
825         /* modifier doesn't change time */
826         return evaltime;
827 }
828
829 static void fcm_limits_evaluate(FCurve *UNUSED(fcu), FModifier *fcm, float *cvalue, float UNUSED(evaltime))
830 {
831         FMod_Limits *data = (FMod_Limits *)fcm->data;
832         
833         /* value limits now */
834         if ((data->flag & FCM_LIMIT_YMIN) && (*cvalue < data->rect.ymin))
835                 *cvalue = data->rect.ymin;
836         if ((data->flag & FCM_LIMIT_YMAX) && (*cvalue > data->rect.ymax))
837                 *cvalue = data->rect.ymax;
838 }
839
840 static FModifierTypeInfo FMI_LIMITS = {
841         FMODIFIER_TYPE_LIMITS, /* type */
842         sizeof(FMod_Limits), /* size */
843         FMI_TYPE_GENERATE_CURVE, /* action type */  /* XXX... err... */   
844         FMI_REQUIRES_RUNTIME_CHECK, /* requirements */
845         N_("Limits"), /* name */
846         "FMod_Limits", /* struct name */
847         NULL, /* free data */
848         NULL, /* copy data */
849         NULL, /* new data */
850         NULL, /* verify */
851         fcm_limits_time, /* evaluate time */
852         fcm_limits_evaluate /* evaluate */
853 };
854
855 /* Stepped F-Curve Modifier --------------------------- */
856
857 static void fcm_stepped_new_data(void *mdata)
858 {
859         FMod_Stepped *data = (FMod_Stepped *)mdata;
860         
861         /* just need to set the step-size to 2-frames by default */
862         /* XXX: or would 5 be more normal? */
863         data->step_size = 2.0f;
864 }
865
866 static float fcm_stepped_time(FCurve *UNUSED(fcu), FModifier *fcm, float UNUSED(cvalue), float evaltime)
867 {
868         FMod_Stepped *data = (FMod_Stepped *)fcm->data;
869         int snapblock;
870         
871         /* check range clamping to see if we should alter the timing to achieve the desired results */
872         if (data->flag & FCM_STEPPED_NO_BEFORE) {
873                 if (evaltime < data->start_frame)
874                         return evaltime;
875         }
876         if (data->flag & FCM_STEPPED_NO_AFTER) {
877                 if (evaltime > data->end_frame)
878                         return evaltime;
879         }
880         
881         /* we snap to the start of the previous closest block of 'step_size' frames 
882          * after the start offset has been discarded 
883          *      - i.e. round down
884          */
885         snapblock = (int)((evaltime - data->offset) / data->step_size);
886         
887         /* reapply the offset, and multiple the snapblock by the size of the steps to get 
888          * the new time to evaluate at 
889          */
890         return ((float)snapblock * data->step_size) + data->offset;
891 }
892
893 static FModifierTypeInfo FMI_STEPPED = {
894         FMODIFIER_TYPE_STEPPED, /* type */
895         sizeof(FMod_Limits), /* size */
896         FMI_TYPE_GENERATE_CURVE, /* action type */  /* XXX... err... */   
897         FMI_REQUIRES_RUNTIME_CHECK, /* requirements */
898         N_("Stepped"), /* name */
899         "FMod_Stepped", /* struct name */
900         NULL, /* free data */
901         NULL, /* copy data */
902         fcm_stepped_new_data, /* new data */
903         NULL, /* verify */
904         fcm_stepped_time, /* evaluate time */
905         NULL /* evaluate */
906 };
907
908 /* F-Curve Modifier API --------------------------- */
909 /* All of the F-Curve Modifier api functions use FModifierTypeInfo structs to carry out
910  * and operations that involve F-Curve modifier specific code.
911  */
912
913 /* These globals only ever get directly accessed in this file */
914 static FModifierTypeInfo *fmodifiersTypeInfo[FMODIFIER_NUM_TYPES];
915 static short FMI_INIT = 1; /* when non-zero, the list needs to be updated */
916
917 /* This function only gets called when FMI_INIT is non-zero */
918 static void fmods_init_typeinfo(void)
919 {
920         fmodifiersTypeInfo[0] =  NULL;                   /* 'Null' F-Curve Modifier */
921         fmodifiersTypeInfo[1] =  &FMI_GENERATOR;         /* Generator F-Curve Modifier */
922         fmodifiersTypeInfo[2] =  &FMI_FN_GENERATOR;      /* Built-In Function Generator F-Curve Modifier */
923         fmodifiersTypeInfo[3] =  &FMI_ENVELOPE;          /* Envelope F-Curve Modifier */
924         fmodifiersTypeInfo[4] =  &FMI_CYCLES;            /* Cycles F-Curve Modifier */
925         fmodifiersTypeInfo[5] =  &FMI_NOISE;             /* Apply-Noise F-Curve Modifier */
926         fmodifiersTypeInfo[6] =  NULL /*&FMI_FILTER*/;   /* Filter F-Curve Modifier */           // XXX unimplemented
927         fmodifiersTypeInfo[7] =  &FMI_PYTHON;            /* Custom Python F-Curve Modifier */
928         fmodifiersTypeInfo[8] =  &FMI_LIMITS;            /* Limits F-Curve Modifier */
929         fmodifiersTypeInfo[9] =  &FMI_STEPPED;           /* Stepped F-Curve Modifier */
930 }
931
932 /* This function should be used for getting the appropriate type-info when only
933  * a F-Curve modifier type is known
934  */
935 FModifierTypeInfo *get_fmodifier_typeinfo(int type)
936 {
937         /* initialize the type-info list? */
938         if (FMI_INIT) {
939                 fmods_init_typeinfo();
940                 FMI_INIT = 0;
941         }
942         
943         /* only return for valid types */
944         if ((type >= FMODIFIER_TYPE_NULL) &&
945             (type <  FMODIFIER_NUM_TYPES))
946         {
947                 /* there shouldn't be any segfaults here... */
948                 return fmodifiersTypeInfo[type];
949         }
950         else {
951                 printf("No valid F-Curve Modifier type-info data available. Type = %i\n", type);
952         }
953         
954         return NULL;
955
956  
957 /* This function should always be used to get the appropriate type-info, as it
958  * has checks which prevent segfaults in some weird cases.
959  */
960 FModifierTypeInfo *fmodifier_get_typeinfo(FModifier *fcm)
961 {
962         /* only return typeinfo for valid modifiers */
963         if (fcm)
964                 return get_fmodifier_typeinfo(fcm->type);
965         else
966                 return NULL;
967 }
968
969 /* API --------------------------- */
970
971 /* Add a new F-Curve Modifier to the given F-Curve of a certain type */
972 FModifier *add_fmodifier(ListBase *modifiers, int type)
973 {
974         FModifierTypeInfo *fmi = get_fmodifier_typeinfo(type);
975         FModifier *fcm;
976         
977         /* sanity checks */
978         if (ELEM(NULL, modifiers, fmi))
979                 return NULL;
980         
981         /* special checks for whether modifier can be added */
982         if ((modifiers->first) && (type == FMODIFIER_TYPE_CYCLES)) {
983                 /* cycles modifier must be first in stack, so for now, don't add if it can't be */
984                 /* TODO: perhaps there is some better way, but for now, */
985                 printf("Error: Cannot add 'Cycles' modifier to F-Curve, as 'Cycles' modifier can only be first in stack.\n");
986                 return NULL;
987         }
988         
989         /* add modifier itself */
990         fcm = MEM_callocN(sizeof(FModifier), "F-Curve Modifier");
991         fcm->type = type;
992         fcm->flag = FMODIFIER_FLAG_EXPANDED;
993         fcm->influence = 1.0f;
994         BLI_addtail(modifiers, fcm);
995         
996         /* tag modifier as "active" if no other modifiers exist in the stack yet */
997         if (modifiers->first == modifiers->last)
998                 fcm->flag |= FMODIFIER_FLAG_ACTIVE;
999         
1000         /* add modifier's data */
1001         fcm->data = MEM_callocN(fmi->size, fmi->structName);
1002         
1003         /* init custom settings if necessary */
1004         if (fmi->new_data)
1005                 fmi->new_data(fcm->data);
1006                 
1007         /* return modifier for further editing */
1008         return fcm;
1009 }
1010
1011 /* Make a copy of the specified F-Modifier */
1012 FModifier *copy_fmodifier(FModifier *src)
1013 {
1014         FModifierTypeInfo *fmi = fmodifier_get_typeinfo(src);
1015         FModifier *dst;
1016         
1017         /* sanity check */
1018         if (src == NULL)
1019                 return NULL;
1020                 
1021         /* copy the base data, clearing the links */
1022         dst = MEM_dupallocN(src);
1023         dst->next = dst->prev = NULL;
1024         
1025         /* make a new copy of the F-Modifier's data */
1026         dst->data = MEM_dupallocN(src->data);
1027         
1028         /* only do specific constraints if required */
1029         if (fmi && fmi->copy_data)
1030                 fmi->copy_data(dst, src);
1031                 
1032         /* return the new modifier */
1033         return dst;
1034 }
1035
1036 /* Duplicate all of the F-Modifiers in the Modifier stacks */
1037 void copy_fmodifiers(ListBase *dst, ListBase *src)
1038 {
1039         FModifier *fcm, *srcfcm;
1040         
1041         if (ELEM(NULL, dst, src))
1042                 return;
1043         
1044         dst->first = dst->last = NULL;
1045         BLI_duplicatelist(dst, src);
1046         
1047         for (fcm = dst->first, srcfcm = src->first; fcm && srcfcm; srcfcm = srcfcm->next, fcm = fcm->next) {
1048                 FModifierTypeInfo *fmi = fmodifier_get_typeinfo(fcm);
1049                 
1050                 /* make a new copy of the F-Modifier's data */
1051                 fcm->data = MEM_dupallocN(fcm->data);
1052                 
1053                 /* only do specific constraints if required */
1054                 if (fmi && fmi->copy_data)
1055                         fmi->copy_data(fcm, srcfcm);
1056         }
1057 }
1058
1059 /* Remove and free the given F-Modifier from the given stack  */
1060 int remove_fmodifier(ListBase *modifiers, FModifier *fcm)
1061 {
1062         FModifierTypeInfo *fmi = fmodifier_get_typeinfo(fcm);
1063         
1064         /* sanity check */
1065         if (fcm == NULL)
1066                 return 0;
1067         
1068         /* free modifier's special data (stored inside fcm->data) */
1069         if (fcm->data) {
1070                 if (fmi && fmi->free_data)
1071                         fmi->free_data(fcm);
1072                         
1073                 /* free modifier's data (fcm->data) */
1074                 MEM_freeN(fcm->data);
1075         }
1076         
1077         /* remove modifier from stack */
1078         if (modifiers) {
1079                 BLI_freelinkN(modifiers, fcm);
1080                 return 1;
1081         }
1082         else {
1083                 /* XXX this case can probably be removed some day, as it shouldn't happen... */
1084                 printf("remove_fmodifier() - no modifier stack given\n");
1085                 MEM_freeN(fcm);
1086                 return 0;
1087         }
1088 }
1089
1090 /* Remove all of a given F-Curve's modifiers */
1091 void free_fmodifiers(ListBase *modifiers)
1092 {
1093         FModifier *fcm, *fmn;
1094         
1095         /* sanity check */
1096         if (modifiers == NULL)
1097                 return;
1098         
1099         /* free each modifier in order - modifier is unlinked from list and freed */
1100         for (fcm = modifiers->first; fcm; fcm = fmn) {
1101                 fmn = fcm->next;
1102                 remove_fmodifier(modifiers, fcm);
1103         }
1104 }
1105
1106 /* Find the active F-Modifier */
1107 FModifier *find_active_fmodifier(ListBase *modifiers)
1108 {
1109         FModifier *fcm;
1110         
1111         /* sanity checks */
1112         if (ELEM(NULL, modifiers, modifiers->first))
1113                 return NULL;
1114         
1115         /* loop over modifiers until 'active' one is found */
1116         for (fcm = modifiers->first; fcm; fcm = fcm->next) {
1117                 if (fcm->flag & FMODIFIER_FLAG_ACTIVE)
1118                         return fcm;
1119         }
1120         
1121         /* no modifier is active */
1122         return NULL;
1123 }
1124
1125 /* Set the active F-Modifier */
1126 void set_active_fmodifier(ListBase *modifiers, FModifier *fcm)
1127 {
1128         FModifier *fm;
1129         
1130         /* sanity checks */
1131         if (ELEM(NULL, modifiers, modifiers->first))
1132                 return;
1133         
1134         /* deactivate all, and set current one active */
1135         for (fm = modifiers->first; fm; fm = fm->next)
1136                 fm->flag &= ~FMODIFIER_FLAG_ACTIVE;
1137         
1138         /* make given modifier active */
1139         if (fcm)
1140                 fcm->flag |= FMODIFIER_FLAG_ACTIVE;
1141 }
1142
1143 /* Do we have any modifiers which match certain criteria 
1144  *      - mtype - type of modifier (if 0, doesn't matter)
1145  *      - acttype - type of action to perform (if -1, doesn't matter)
1146  */
1147 short list_has_suitable_fmodifier(ListBase *modifiers, int mtype, short acttype)
1148 {
1149         FModifier *fcm;
1150         
1151         /* if there are no specific filtering criteria, just skip */
1152         if ((mtype == 0) && (acttype == 0))
1153                 return (modifiers && modifiers->first);
1154                 
1155         /* sanity checks */
1156         if (ELEM(NULL, modifiers, modifiers->first))
1157                 return 0;
1158                 
1159         /* find the first mdifier fitting these criteria */
1160         for (fcm = modifiers->first; fcm; fcm = fcm->next) {
1161                 FModifierTypeInfo *fmi = fmodifier_get_typeinfo(fcm);
1162                 short mOk = 1, aOk = 1; /* by default 1, so that when only one test, won't fail */
1163                 
1164                 /* check if applicable ones are fullfilled */
1165                 if (mtype)
1166                         mOk = (fcm->type == mtype);
1167                 if (acttype > -1)
1168                         aOk = (fmi->acttype == acttype);
1169                         
1170                 /* if both are ok, we've found a hit */
1171                 if (mOk && aOk)
1172                         return 1;
1173         }
1174         
1175         /* no matches */
1176         return 0;
1177 }  
1178
1179 /* Evaluation API --------------------------- */
1180
1181 /* helper function - calculate influence of FModifier */
1182 static float eval_fmodifier_influence(FModifier *fcm, float evaltime)
1183 {
1184         float influence;
1185         
1186         /* sanity check */
1187         if (fcm == NULL) 
1188                 return 0.0f;
1189         
1190         /* should we use influence stored in modifier or not 
1191          * NOTE: this is really just a hack so that we don't need to version patch old files ;)
1192          */
1193         if (fcm->flag & FMODIFIER_FLAG_USEINFLUENCE)
1194                 influence = fcm->influence;
1195         else
1196                 influence = 1.0f;
1197                 
1198         /* restricted range or full range? */
1199         if (fcm->flag & FMODIFIER_FLAG_RANGERESTRICT) {
1200                 if ((evaltime <= fcm->sfra) || (evaltime >= fcm->efra)) {
1201                         /* out of range */
1202                         return 0.0f;
1203                 }
1204                 else if ((evaltime > fcm->sfra) && (evaltime < fcm->sfra + fcm->blendin)) {
1205                         /* blend in range */
1206                         float a = fcm->sfra;
1207                         float b = fcm->sfra + fcm->blendin;
1208                         return influence * (evaltime - a) / (b - a);
1209                 }
1210                 else if ((evaltime < fcm->efra) && (evaltime > fcm->efra - fcm->blendout)) {
1211                         /* blend out range */
1212                         float a = fcm->efra;
1213                         float b = fcm->efra - fcm->blendout;
1214                         return influence * (evaltime - a) / (b - a);
1215                 }
1216         }
1217         
1218         /* just return the influence of the modifier */
1219         return influence;
1220 }
1221
1222 /* evaluate time modifications imposed by some F-Curve Modifiers
1223  *      - this step acts as an optimization to prevent the F-Curve stack being evaluated 
1224  *        several times by modifiers requesting the time be modified, as the final result
1225  *        would have required using the modified time
1226  *      - modifiers only ever receive the unmodified time, as subsequent modifiers should be
1227  *        working on the 'global' result of the modified curve, not some localised segment,
1228  *        so nevaltime gets set to whatever the last time-modifying modifier likes...
1229  *      - we start from the end of the stack, as only the last one matters for now
1230  */
1231 float evaluate_time_fmodifiers(ListBase *modifiers, FCurve *fcu, float cvalue, float evaltime)
1232 {
1233         FModifier *fcm;
1234         
1235         /* sanity checks */
1236         if (ELEM(NULL, modifiers, modifiers->last))
1237                 return evaltime;
1238                 
1239         /* Starting from the end of the stack, calculate the time effects of various stacked modifiers 
1240          * on the time the F-Curve should be evaluated at. 
1241          *
1242          * This is done in reverse order to standard evaluation, as when this is done in standard
1243          * order, each modifier would cause jumps to other points in the curve, forcing all
1244          * previous ones to be evaluated again for them to be correct. However, if we did in the 
1245          * reverse order as we have here, we can consider them a macro to micro type of waterfall
1246          * effect, which should get us the desired effects when using layered time manipulations
1247          * (such as multiple 'stepped' modifiers in sequence, causing different stepping rates)
1248          */
1249         for (fcm = modifiers->last; fcm; fcm = fcm->prev) {
1250                 FModifierTypeInfo *fmi = fmodifier_get_typeinfo(fcm);
1251                 
1252                 if (fmi == NULL) 
1253                         continue;
1254                 
1255                 /* if modifier cannot be applied on this frame (whatever scale it is on, it won't affect the results)
1256                  * hence we shouldn't bother seeing what it would do given the chance
1257                  */
1258                 if ((fcm->flag & FMODIFIER_FLAG_RANGERESTRICT) == 0 ||
1259                     ((fcm->sfra <= evaltime) && (fcm->efra >= evaltime)) )
1260                 {
1261                         /* only evaluate if there's a callback for this */
1262                         if (fmi->evaluate_modifier_time) {
1263                                 if ((fcm->flag & (FMODIFIER_FLAG_DISABLED | FMODIFIER_FLAG_MUTED)) == 0) {
1264                                         float influence = eval_fmodifier_influence(fcm, evaltime);
1265                                         float nval = fmi->evaluate_modifier_time(fcu, fcm, cvalue, evaltime);
1266                                         
1267                                         evaltime = interpf(nval, evaltime, influence);
1268                                 }
1269                         }
1270                 }
1271         }
1272         
1273         /* return the modified evaltime */
1274         return evaltime;
1275 }
1276
1277 /* Evaluates the given set of F-Curve Modifiers using the given data
1278  * Should only be called after evaluate_time_fmodifiers() has been called...
1279  */
1280 void evaluate_value_fmodifiers(ListBase *modifiers, FCurve *fcu, float *cvalue, float evaltime)
1281 {
1282         FModifier *fcm;
1283         
1284         /* sanity checks */
1285         if (ELEM(NULL, modifiers, modifiers->first))
1286                 return;
1287         
1288         /* evaluate modifiers */
1289         for (fcm = modifiers->first; fcm; fcm = fcm->next) {
1290                 FModifierTypeInfo *fmi = fmodifier_get_typeinfo(fcm);
1291                 
1292                 if (fmi == NULL) 
1293                         continue;
1294                 
1295                 /* only evaluate if there's a callback for this, and if F-Modifier can be evaluated on this frame */
1296                 if ((fcm->flag & FMODIFIER_FLAG_RANGERESTRICT) == 0 ||
1297                     ((fcm->sfra <= evaltime) && (fcm->efra >= evaltime)) )
1298                 {
1299                         if (fmi->evaluate_modifier) {
1300                                 if ((fcm->flag & (FMODIFIER_FLAG_DISABLED | FMODIFIER_FLAG_MUTED)) == 0) {
1301                                         float influence = eval_fmodifier_influence(fcm, evaltime);
1302                                         float nval = *cvalue;
1303                                         
1304                                         fmi->evaluate_modifier(fcu, fcm, &nval, evaltime);
1305                                         *cvalue = interpf(nval, *cvalue, influence);
1306                                 }
1307                         }
1308                 }
1309         }
1310
1311
1312 /* ---------- */
1313
1314 /* Bake modifiers for given F-Curve to curve sample data, in the frame range defined
1315  * by start and end (inclusive).
1316  */
1317 void fcurve_bake_modifiers(FCurve *fcu, int start, int end)
1318 {
1319         ChannelDriver *driver;
1320         
1321         /* sanity checks */
1322         /* TODO: make these tests report errors using reports not printf's */
1323         if (ELEM(NULL, fcu, fcu->modifiers.first)) {
1324                 printf("Error: No F-Curve with F-Curve Modifiers to Bake\n");
1325                 return;
1326         }
1327         
1328         /* temporarily, disable driver while we sample, so that they don't influence the outcome */
1329         driver = fcu->driver;
1330         fcu->driver = NULL;
1331         
1332         /* bake the modifiers, by sampling the curve at each frame */
1333         fcurve_store_samples(fcu, NULL, start, end, fcurve_samplingcb_evalcurve);
1334         
1335         /* free the modifiers now */
1336         free_fmodifiers(&fcu->modifiers);
1337         
1338         /* restore driver */
1339         fcu->driver = driver;
1340 }