49d1b06d9a2bba4b4e373ebbe893d888db7c83f2
[blender-staging.git] / source / blender / blenkernel / intern / fcurve.c
1 /* Testing code for new animation system in 2.5 
2  * Copyright 2009, Joshua Leung
3  */
4  
5
6 #include <math.h>
7 #include <stdio.h>
8 #include <string.h>
9
10 #ifdef HAVE_CONFIG_H
11 #include <config.h>
12 #endif
13
14 #include "MEM_guardedalloc.h"
15
16 #include "DNA_anim_types.h"
17
18 #include "BLI_blenlib.h"
19 #include "BLI_arithb.h"
20
21 #include "BKE_fcurve.h"
22 #include "BKE_curve.h" 
23 #include "BKE_global.h"
24 #include "BKE_idprop.h"
25 #include "BKE_utildefines.h"
26
27 #include "RNA_access.h"
28 #include "RNA_types.h"
29
30 #ifndef DISABLE_PYTHON
31 #include "BPY_extern.h" /* for BPY_pydriver_eval() */
32 #endif
33
34 #define SMALL -1.0e-10
35 #define SELECT 1
36
37 /* ************************** Data-Level Functions ************************* */
38
39 /* ---------------------- Freeing --------------------------- */
40
41 /* Frees the F-Curve itself too, so make sure BLI_remlink is called before calling this... */
42 void free_fcurve (FCurve *fcu) 
43 {
44         if (fcu == NULL) 
45                 return;
46         
47         /* free curve data */
48         if (fcu) {
49                 if (fcu->bezt) MEM_freeN(fcu->bezt);
50                 if (fcu->fpt) MEM_freeN(fcu->fpt);
51         }
52         
53         /* free RNA-path, as this were allocated when getting the path string */
54         if (fcu->rna_path)
55                 MEM_freeN(fcu->rna_path);
56         
57         /* free extra data - i.e. modifiers, and driver */
58         fcurve_free_driver(fcu);
59         fcurve_free_modifiers(fcu);
60         
61         /* free f-cruve itself */
62         MEM_freeN(fcu);
63 }
64
65 /* Frees a list of F-Curves */
66 void free_fcurves (ListBase *list)
67 {
68         FCurve *fcu, *fcn;
69         
70         /* sanity check */
71         if (list == NULL)
72                 return;
73                 
74         /* free data - no need to call remlink before freeing each curve, 
75          * as we store reference to next, and freeing only touches the curve
76          * it's given
77          */
78         for (fcu= list->first; fcu; fcu= fcn) {
79                 fcn= fcu->next;
80                 free_fcurve(fcu);
81         }
82         
83         /* clear pointers just in case */
84         list->first= list->last= NULL;
85 }       
86
87 /* ---------------------- Copy --------------------------- */
88
89 /* duplicate an F-Curve */
90 FCurve *copy_fcurve (FCurve *fcu)
91 {
92         FCurve *fcu_d;
93         
94         /* sanity check */
95         if (fcu == NULL)
96                 return NULL;
97                 
98         /* make a copy */
99         fcu_d= MEM_dupallocN(fcu);
100         fcu_d->next= fcu_d->prev= NULL;
101         
102         /* copy curve data */
103         fcu_d->bezt= MEM_dupallocN(fcu_d->bezt);
104         fcu_d->fpt= MEM_dupallocN(fcu_d->fpt);
105         
106         /* copy rna-path */
107         fcu_d->rna_path= MEM_dupallocN(fcu_d->rna_path);
108         
109         /* copy driver */
110         fcu_d->driver= fcurve_copy_driver(fcu_d->driver);
111         
112         /* copy modifiers */
113         fcurve_copy_modifiers(&fcu_d->modifiers, &fcu->modifiers);
114         
115         /* return new data */
116         return fcu_d;
117 }
118
119 /* duplicate a list of F-Curves */
120 void copy_fcurves (ListBase *dst, ListBase *src)
121 {
122         FCurve *dfcu, *sfcu;
123         
124         /* sanity checks */
125         if ELEM(NULL, dst, src)
126                 return;
127         
128         /* clear destination list first */
129         dst->first= dst->last= NULL;
130         
131         /* copy one-by-one */
132         for (sfcu= src->first; sfcu; sfcu= sfcu->next) {
133                 dfcu= copy_fcurve(sfcu);
134                 BLI_addtail(dst, dfcu);
135         }
136 }
137
138 /* ---------------------- Relink --------------------------- */
139
140 #if 0
141 /* uses id->newid to match pointers with other copied data 
142  *      - called after single-user or other such
143  */
144                         if (icu->driver)
145                                 ID_NEW(icu->driver->ob);
146 #endif
147
148 /* --------------------- Finding -------------------------- */
149
150 /* Find the F-Curve affecting the given RNA-access path + index, in the list of F-Curves provided */
151 FCurve *list_find_fcurve (ListBase *list, const char rna_path[], const int array_index)
152 {
153         FCurve *fcu;
154         
155         /* sanity checks */
156         if ( ELEM(NULL, list, rna_path) || (array_index < 0) )
157                 return NULL;
158         
159         /* check paths of curves, then array indices... */
160         for (fcu= list->first; fcu; fcu= fcu->next) {
161                 /* simple string-compare (this assumes that they have the same root...) */
162                 if (strcmp(fcu->rna_path, rna_path) == 0) {
163                         /* now check indicies */
164                         if (fcu->array_index == array_index)
165                                 return fcu;
166                 }
167         }
168         
169         /* return */
170         return NULL;
171 }
172
173 /* Calculate the extents of F-Curve's data */
174 void calc_fcurve_bounds (FCurve *fcu, float *xmin, float *xmax, float *ymin, float *ymax)
175 {
176         float xminv=999999999.0f, xmaxv=-999999999.0f;
177         float yminv=999999999.0f, ymaxv=-999999999.0f;
178         short foundvert=0;
179         int i;
180         
181         if (fcu->totvert) {
182                 if (fcu->bezt) {
183                         /* frame range can be directly calculated from end verts */
184                         if (xmin || xmax) {
185                                 xminv= MIN2(xminv, fcu->bezt[0].vec[1][0]);
186                                 xmaxv= MAX2(xmaxv, fcu->bezt[fcu->totvert-1].vec[1][0]);
187                         }
188                         
189                         /* only loop over keyframes to find extents for values if needed */
190                         if (ymin || ymax) {
191                                 BezTriple *bezt;
192                                 
193                                 for (bezt=fcu->bezt, i=0; i < fcu->totvert; bezt++, i++) {
194                                         yminv= MIN2(yminv, bezt->vec[1][1]);
195                                         ymaxv= MAX2(ymaxv, bezt->vec[1][1]);
196                                 }
197                         }
198                 }
199                 else if (fcu->fpt) {
200                         /* frame range can be directly calculated from end verts */
201                         if (xmin || xmax) {
202                                 xminv= MIN2(xminv, fcu->fpt[0].vec[0]);
203                                 xmaxv= MAX2(xmaxv, fcu->fpt[fcu->totvert-1].vec[0]);
204                         }
205                         
206                         /* only loop over keyframes to find extents for values if needed */
207                         if (ymin || ymax) {
208                                 FPoint *fpt;
209                                 
210                                 for (fpt=fcu->fpt, i=0; i < fcu->totvert; fpt++, i++) {
211                                         yminv= MIN2(yminv, fpt->vec[1]);
212                                         ymaxv= MAX2(ymaxv, fpt->vec[1]);
213                                 }
214                         }
215                 }
216                 
217                 foundvert=1;
218         }
219         
220         /* minimum sizes are 1.0f */
221         if (foundvert) {
222                 if (xminv == xmaxv) xmaxv += 1.0f;
223                 if (yminv == ymaxv) ymaxv += 1.0f;
224                 
225                 if (xmin) *xmin= xminv;
226                 if (xmax) *xmax= xmaxv;
227                 
228                 if (ymin) *ymin= yminv;
229                 if (ymax) *ymax= ymaxv;
230         }
231         else {
232                 if (xmin) *xmin= 0.0f;
233                 if (xmax) *xmax= 0.0f;
234                 
235                 if (ymin) *ymin= 1.0f;
236                 if (ymax) *ymax= 1.0f;
237         }
238 }
239
240 /* Calculate the extents of F-Curve's keyframes */
241 void calc_fcurve_range (FCurve *fcu, float *start, float *end)
242 {
243         float min=999999999.0f, max=-999999999.0f;
244         short foundvert=0;
245
246         if (fcu->totvert) {
247                 if (fcu->bezt) {
248                         min= MIN2(min, fcu->bezt[0].vec[1][0]);
249                         max= MAX2(max, fcu->bezt[fcu->totvert-1].vec[1][0]);
250                 }
251                 else if (fcu->fpt) {
252                         min= MIN2(min, fcu->fpt[0].vec[0]);
253                         max= MAX2(max, fcu->fpt[fcu->totvert-1].vec[0]);
254                 }
255                 
256                 foundvert=1;
257         }
258         
259         /* minimum length is 1 frame */
260         if (foundvert) {
261                 if (min == max) max += 1.0f;
262                 *start= min;
263                 *end= max;
264         }
265         else {
266                 *start= 0.0f;
267                 *end= 1.0f;
268         }
269 }
270
271 /* ***************************** Keyframe Column Tools ********************************* */
272
273 /* add a BezTriple to a column */
274 void bezt_add_to_cfra_elem (ListBase *lb, BezTriple *bezt)
275 {
276         CfraElem *ce, *cen;
277         
278         for (ce= lb->first; ce; ce= ce->next) {
279                 /* double key? */
280                 if (ce->cfra == bezt->vec[1][0]) {
281                         if (bezt->f2 & SELECT) ce->sel= bezt->f2;
282                         return;
283                 }
284                 /* should key be inserted before this column? */
285                 else if (ce->cfra > bezt->vec[1][0]) break;
286         }
287         
288         /* create a new column */
289         cen= MEM_callocN(sizeof(CfraElem), "add_to_cfra_elem"); 
290         if (ce) BLI_insertlinkbefore(lb, ce, cen);
291         else BLI_addtail(lb, cen);
292
293         cen->cfra= bezt->vec[1][0];
294         cen->sel= bezt->f2;
295 }
296
297 /* ***************************** F-Curve Sanity ********************************* */
298 /* The functions here are used in various parts of Blender, usually after some editing
299  * of keyframe data has occurred. They ensure that keyframe data is properly ordered and
300  * that the handles are correctly 
301  */
302
303 /* This function recalculates the handles of an F-Curve 
304  * If the BezTriples have been rearranged, sort them first before using this.
305  */
306 void calchandles_fcurve (FCurve *fcu)
307 {
308         BezTriple *bezt, *prev, *next;
309         int a= fcu->totvert;
310
311         /* Error checking:
312          *      - need at least two points
313          *      - need bezier keys
314          *      - only bezier-interpolation has handles (for now)
315          */
316         if (ELEM(NULL, fcu, fcu->bezt) || (a < 2) /*|| ELEM(fcu->ipo, BEZT_IPO_CONST, BEZT_IPO_LIN)*/) 
317                 return;
318         
319         /* get initial pointers */
320         bezt= fcu->bezt;
321         prev= NULL;
322         next= (bezt + 1);
323         
324         /* loop over all beztriples, adjusting handles */
325         while (a--) {
326                 /* clamp timing of handles to be on either side of beztriple */
327                 if (bezt->vec[0][0] > bezt->vec[1][0]) bezt->vec[0][0]= bezt->vec[1][0];
328                 if (bezt->vec[2][0] < bezt->vec[1][0]) bezt->vec[2][0]= bezt->vec[1][0];
329                 
330                 /* calculate auto-handles */
331                 if (fcu->flag & FCURVE_AUTO_HANDLES) 
332                         calchandleNurb(bezt, prev, next, 2);    /* 2==special autohandle && keep extrema horizontal */
333                 else
334                         calchandleNurb(bezt, prev, next, 1);    /* 1==special autohandle */
335                 
336                 /* for automatic ease in and out */
337                 if ((bezt->h1==HD_AUTO) && (bezt->h2==HD_AUTO)) {
338                         /* only do this on first or last beztriple */
339                         if ((a == 0) || (a == fcu->totvert-1)) {
340                                 /* set both handles to have same horizontal value as keyframe */
341                                 if (fcu->extend == FCURVE_EXTRAPOLATE_CONSTANT) {
342                                         bezt->vec[0][1]= bezt->vec[2][1]= bezt->vec[1][1];
343                                 }
344                         }
345                 }
346                 
347                 /* advance pointers for next iteration */
348                 prev= bezt;
349                 if (a == 1) next= NULL;
350                 else next++;
351                 bezt++;
352         }
353 }
354
355 /* Use when F-Curve with handles has changed
356  * It treats all BezTriples with the following rules:
357  *  - PHASE 1: do types have to be altered?
358  *              -> Auto handles: become aligned when selection status is NOT(000 || 111)
359  *              -> Vector handles: become 'nothing' when (one half selected AND other not)
360  *  - PHASE 2: recalculate handles
361 */
362 void testhandles_fcurve (FCurve *fcu)
363 {
364         BezTriple *bezt;
365         int a;
366
367         /* only beztriples have handles (bpoints don't though) */
368         if ELEM(NULL, fcu, fcu->bezt)
369                 return;
370         
371         /* loop over beztriples */
372         for (a=0, bezt=fcu->bezt; a < fcu->totvert; a++, bezt++) {
373                 short flag= 0;
374                 
375                 /* flag is initialised as selection status
376                  * of beztriple control-points (labelled 0,1,2)
377                  */
378                 if (bezt->f1 & SELECT) flag |= (1<<0); // == 1
379                 if (bezt->f2 & SELECT) flag |= (1<<1); // == 2
380                 if (bezt->f3 & SELECT) flag |= (1<<2); // == 4
381                 
382                 /* one or two handles selected only */
383                 if (ELEM(flag, 0, 7)==0) {
384                         /* auto handles become aligned */
385                         if (bezt->h1==HD_AUTO)
386                                 bezt->h1= HD_ALIGN;
387                         if (bezt->h2==HD_AUTO)
388                                 bezt->h2= HD_ALIGN;
389                         
390                         /* vector handles become 'free' when only one half selected */
391                         if (bezt->h1==HD_VECT) {
392                                 /* only left half (1 or 2 or 1+2) */
393                                 if (flag < 4) 
394                                         bezt->h1= 0;
395                         }
396                         if (bezt->h2==HD_VECT) {
397                                 /* only right half (4 or 2+4) */
398                                 if (flag > 3) 
399                                         bezt->h2= 0;
400                         }
401                 }
402         }
403
404         /* recalculate handles */
405         calchandles_fcurve(fcu);
406 }
407
408 /* This function sorts BezTriples so that they are arranged in chronological order,
409  * as tools working on F-Curves expect that the BezTriples are in order.
410  */
411 void sort_time_fcurve (FCurve *fcu)
412 {
413         short ok= 1;
414         
415         /* keep adjusting order of beztriples until nothing moves (bubble-sort) */
416         while (ok) {
417                 ok= 0;
418                 
419                 /* currently, will only be needed when there are beztriples */
420                 if (fcu->bezt) {
421                         BezTriple *bezt;
422                         int a;
423                         
424                         /* loop over ALL points to adjust position in array and recalculate handles */
425                         for (a=0, bezt=fcu->bezt; a < fcu->totvert; a++, bezt++) {
426                                 /* check if thee's a next beztriple which we could try to swap with current */
427                                 if (a < (fcu->totvert-1)) {
428                                         /* swap if one is after the other (and indicate that order has changed) */
429                                         if (bezt->vec[1][0] > (bezt+1)->vec[1][0]) {
430                                                 SWAP(BezTriple, *bezt, *(bezt+1));
431                                                 ok= 1;
432                                         }
433                                         
434                                         /* if either one of both of the points exceeds crosses over the keyframe time... */
435                                         if ( (bezt->vec[0][0] > bezt->vec[1][0]) && (bezt->vec[2][0] < bezt->vec[1][0]) ) {
436                                                 /* swap handles if they have switched sides for some reason */
437                                                 SWAP(float, bezt->vec[0][0], bezt->vec[2][0]);
438                                                 SWAP(float, bezt->vec[0][1], bezt->vec[2][1]);
439                                         }
440                                         else {
441                                                 /* clamp handles */
442                                                 if (bezt->vec[0][0] > bezt->vec[1][0]) 
443                                                         bezt->vec[0][0]= bezt->vec[1][0];
444                                                 if (bezt->vec[2][0] < bezt->vec[1][0]) 
445                                                         bezt->vec[2][0]= bezt->vec[1][0];
446                                         }
447                                 }
448                         }
449                 }
450         }
451 }
452
453 /* This function tests if any BezTriples are out of order, thus requiring a sort */
454 short test_time_fcurve (FCurve *fcu)
455 {
456         int a;
457         
458         /* sanity checks */
459         if (fcu == NULL)
460                 return 0;
461         
462         /* currently, only need to test beztriples */
463         if (fcu->bezt) {
464                 BezTriple *bezt;
465                 
466                 /* loop through all BezTriples, stopping when one exceeds the one after it */
467                 for (a=0, bezt= fcu->bezt; a < (fcu->totvert - 1); a++, bezt++) {
468                         if (bezt->vec[1][0] > (bezt+1)->vec[1][0])
469                                 return 1;
470                 }
471         }
472         else if (fcu->fpt) {
473                 FPoint *fpt;
474                 
475                 /* loop through all FPoints, stopping when one exceeds the one after it */
476                 for (a=0, fpt= fcu->fpt; a < (fcu->totvert - 1); a++, fpt++) {
477                         if (fpt->vec[0] > (fpt+1)->vec[0])
478                                 return 1;
479                 }
480         }
481         
482         /* none need any swapping */
483         return 0;
484 }
485
486 /* ***************************** Drivers ********************************* */
487
488 /* Driver API --------------------------------- */
489
490 /* This frees the driver itself */
491 void fcurve_free_driver(FCurve *fcu)
492 {
493         ChannelDriver *driver;
494         
495         /* sanity checks */
496         if ELEM(NULL, fcu, fcu->driver)
497                 return;
498         driver= fcu->driver;
499         
500         /* free RNA-paths, as these were allocated when getting the path string */
501         if (driver->rna_path) MEM_freeN(driver->rna_path);
502         if (driver->rna_path2) MEM_freeN(driver->rna_path2);
503         
504         /* free driver itself, then set F-Curve's point to this to NULL (as the curve may still be used) */
505         MEM_freeN(driver);
506         fcu->driver= NULL;
507 }
508
509 /* This makes a copy of the given driver */
510 ChannelDriver *fcurve_copy_driver (ChannelDriver *driver)
511 {
512         ChannelDriver *ndriver;
513         
514         /* sanity checks */
515         if (driver == NULL)
516                 return NULL;
517                 
518         /* copy all data */
519         ndriver= MEM_dupallocN(driver);
520         ndriver->rna_path= MEM_dupallocN(ndriver->rna_path);
521         ndriver->rna_path2= MEM_dupallocN(ndriver->rna_path2);
522         
523         /* return the new driver */
524         return ndriver;
525 }
526
527 /* Driver Evaluation -------------------------- */
528
529 /* Helper function to obtain a value using RNA from the specified source (for evaluating drivers) 
530  *      - target: used to specify which of the two driver-targets to use
531  */
532 static float driver_get_driver_value (ChannelDriver *driver, short target)
533 {
534         PointerRNA id_ptr, ptr;
535         PropertyRNA *prop;
536         ID *id;
537         char *path;
538         int index;
539         float value= 0.0f;
540         
541         /* get RNA-pointer for the ID-block given in driver */
542         if (target == 1) {
543                 /* second target */
544                 RNA_id_pointer_create(driver->id2, &id_ptr);
545                 id= driver->id2;
546                 path= driver->rna_path2;
547                 index= driver->array_index2;
548         }
549         else {
550                 /* first/main target */
551                 RNA_id_pointer_create(driver->id, &id_ptr);
552                 id= driver->id;
553                 path= driver->rna_path;
554                 index= driver->array_index;
555         }
556         
557         /* error check for missing pointer... */
558         if (id == NULL) {
559                 printf("Error: driver doesn't have any valid target to use \n");
560                 if (G.f & G_DEBUG) printf("\tpath = %s [%d] \n", path, index);
561                 driver->flag |= DRIVER_FLAG_INVALID;
562                 return 0.0f;
563         }
564         
565         /* get property to read from, and get value as appropriate */
566         if (RNA_path_resolve(&id_ptr, path, &ptr, &prop)) {
567                 switch (RNA_property_type(&ptr, prop)) {
568                         case PROP_BOOLEAN:
569                                 if (RNA_property_array_length(&ptr, prop))
570                                         value= (float)RNA_property_boolean_get_index(&ptr, prop, index);
571                                 else
572                                         value= (float)RNA_property_boolean_get(&ptr, prop);
573                                 break;
574                         case PROP_INT:
575                                 if (RNA_property_array_length(&ptr, prop))
576                                         value= (float)RNA_property_int_get_index(&ptr, prop, index);
577                                 else
578                                         value= (float)RNA_property_int_get(&ptr, prop);
579                                 break;
580                         case PROP_FLOAT:
581                                 if (RNA_property_array_length(&ptr, prop))
582                                         value= RNA_property_float_get_index(&ptr, prop, index);
583                                 else
584                                         value= RNA_property_float_get(&ptr, prop);
585                                 break;
586                         case PROP_ENUM:
587                                 value= (float)RNA_property_enum_get(&ptr, prop);
588                                 break;
589                         default:
590                                 break;
591                 }
592         }
593         
594         return value;
595 }
596
597 /* Evaluate an Channel-Driver to get a 'time' value to use instead of "evaltime"
598  *      - "evaltime" is the frame at which F-Curve is being evaluated
599  *      - has to return a float value 
600  */
601 static float evaluate_driver (ChannelDriver *driver, float evaltime)
602 {
603         /* check if driver can be evaluated */
604         if (driver->flag & DRIVER_FLAG_DISABLED)
605                 return 0.0f;
606         
607         switch (driver->type) {
608                 case DRIVER_TYPE_CHANNEL: /* channel/setting drivers channel/setting */
609                         return driver_get_driver_value(driver, 0);
610                         
611
612                 case DRIVER_TYPE_PYTHON: /* expression */
613                 {
614 #ifndef DISABLE_PYTHON
615                         /* check for empty or invalid expression */
616                         if ( (driver->expression[0] == '\0') ||
617                                  (driver->flag & DRIVER_FLAG_INVALID) )
618                         {
619                                 return 0.0f;
620                         }
621                         
622                         /* this evaluates the expression using Python,and returns its result:
623                          *      - on errors it reports, then returns 0.0f
624                          */
625                         return BPY_pydriver_eval(driver);
626 #endif /* DISABLE_PYTHON*/
627                 }
628                         break;
629
630                 
631                 case DRIVER_TYPE_ROTDIFF: /* difference of rotations of 2 bones (should be in same armature) */
632                 {
633                         /*
634                         float q1[4], q2[4], quat[4], angle;
635                         
636                         Mat4ToQuat(pchan->pose_mat, q1);
637                         Mat4ToQuat(pchan2->pose_mat, q2);
638                         
639                         QuatInv(q1);
640                         QuatMul(quat, q1, q2);
641                         angle = 2.0f * (saacos(quat[0]));
642                         angle= ABS(angle);
643                         
644                         return (angle > M_PI) ? (float)((2.0f * M_PI) - angle) : (float)(angle);
645                         */
646                 }
647                         break;
648                 
649                 default:
650                 {
651                         /* special 'hack' - just use stored value 
652                          *      This is currently used as the mechanism which allows animated settings to be able
653                          *      to be changed via the UI.
654                          */
655                         return driver->curval;
656                 }
657         }
658         
659         /* return 0.0f, as couldn't find relevant data to use */
660         return 0.0f;
661 }
662
663 /* ***************************** Curve Calculations ********************************* */
664
665 /* The total length of the handles is not allowed to be more
666  * than the horizontal distance between (v1-v4).
667  * This is to prevent curve loops.
668 */
669 void correct_bezpart (float *v1, float *v2, float *v3, float *v4)
670 {
671         float h1[2], h2[2], len1, len2, len, fac;
672         
673         /* calculate handle deltas */
674         h1[0]= v1[0] - v2[0];
675         h1[1]= v1[1] - v2[1];
676         
677         h2[0]= v4[0] - v3[0];
678         h2[1]= v4[1] - v3[1];
679         
680         /* calculate distances: 
681          *      - len   = span of time between keyframes 
682          *      - len1  = length of handle of start key
683          *      - len2  = length of handle of end key
684          */
685         len= v4[0]- v1[0];
686         len1= (float)fabs(h1[0]);
687         len2= (float)fabs(h2[0]);
688         
689         /* if the handles have no length, no need to do any corrections */
690         if ((len1+len2) == 0.0f) 
691                 return;
692                 
693         /* the two handles cross over each other, so force them
694          * apart using the proportion they overlap 
695          */
696         if ((len1+len2) > len) {
697                 fac= len / (len1+len2);
698                 
699                 v2[0]= (v1[0] - fac*h1[0]);
700                 v2[1]= (v1[1] - fac*h1[1]);
701                 
702                 v3[0]= (v4[0] - fac*h2[0]);
703                 v3[1]= (v4[1] - fac*h2[1]);
704         }
705 }
706
707 /* find root ('zero') */
708 int findzero (float x, float q0, float q1, float q2, float q3, float *o)
709 {
710         double c0, c1, c2, c3, a, b, c, p, q, d, t, phi;
711         int nr= 0;
712
713         c0= q0 - x;
714         c1= 3.0 * (q1 - q0);
715         c2= 3.0 * (q0 - 2.0*q1 + q2);
716         c3= q3 - q0 + 3.0 * (q1 - q2);
717         
718         if (c3 != 0.0) {
719                 a= c2/c3;
720                 b= c1/c3;
721                 c= c0/c3;
722                 a= a/3;
723                 
724                 p= b/3 - a*a;
725                 q= (2*a*a*a - a*b + c) / 2;
726                 d= q*q + p*p*p;
727                 
728                 if (d > 0.0) {
729                         t= sqrt(d);
730                         o[0]= (float)(Sqrt3d(-q+t) + Sqrt3d(-q-t) - a);
731                         
732                         if ((o[0] >= SMALL) && (o[0] <= 1.000001)) return 1;
733                         else return 0;
734                 }
735                 else if (d == 0.0) {
736                         t= Sqrt3d(-q);
737                         o[0]= (float)(2*t - a);
738                         
739                         if ((o[0] >= SMALL) && (o[0] <= 1.000001)) nr++;
740                         o[nr]= (float)(-t-a);
741                         
742                         if ((o[nr] >= SMALL) && (o[nr] <= 1.000001)) return nr+1;
743                         else return nr;
744                 }
745                 else {
746                         phi= acos(-q / sqrt(-(p*p*p)));
747                         t= sqrt(-p);
748                         p= cos(phi/3);
749                         q= sqrt(3 - 3*p*p);
750                         o[0]= (float)(2*t*p - a);
751                         
752                         if ((o[0] >= SMALL) && (o[0] <= 1.000001)) nr++;
753                         o[nr]= (float)(-t * (p + q) - a);
754                         
755                         if ((o[nr] >= SMALL) && (o[nr] <= 1.000001)) nr++;
756                         o[nr]= (float)(-t * (p - q) - a);
757                         
758                         if ((o[nr] >= SMALL) && (o[nr] <= 1.000001)) return nr+1;
759                         else return nr;
760                 }
761         }
762         else {
763                 a=c2;
764                 b=c1;
765                 c=c0;
766                 
767                 if (a != 0.0) {
768                         // discriminant
769                         p= b*b - 4*a*c;
770                         
771                         if (p > 0) {
772                                 p= sqrt(p);
773                                 o[0]= (float)((-b-p) / (2 * a));
774                                 
775                                 if ((o[0] >= SMALL) && (o[0] <= 1.000001)) nr++;
776                                 o[nr]= (float)((-b+p)/(2*a));
777                                 
778                                 if ((o[nr] >= SMALL) && (o[nr] <= 1.000001)) return nr+1;
779                                 else return nr;
780                         }
781                         else if (p == 0) {
782                                 o[0]= (float)(-b / (2 * a));
783                                 if ((o[0] >= SMALL) && (o[0] <= 1.000001)) return 1;
784                                 else return 0;
785                         }
786                 }
787                 else if (b != 0.0) {
788                         o[0]= (float)(-c/b);
789                         
790                         if ((o[0] >= SMALL) && (o[0] <= 1.000001)) return 1;
791                         else return 0;
792                 }
793                 else if (c == 0.0) {
794                         o[0]= 0.0;
795                         return 1;
796                 }
797                 
798                 return 0;       
799         }
800 }
801
802 void berekeny (float f1, float f2, float f3, float f4, float *o, int b)
803 {
804         float t, c0, c1, c2, c3;
805         int a;
806
807         c0= f1;
808         c1= 3.0f * (f2 - f1);
809         c2= 3.0f * (f1 - 2.0f*f2 + f3);
810         c3= f4 - f1 + 3.0f * (f2 - f3);
811         
812         for (a=0; a < b; a++) {
813                 t= o[a];
814                 o[a]= c0 + t*c1 + t*t*c2 + t*t*t*c3;
815         }
816 }
817
818 void berekenx (float *f, float *o, int b)
819 {
820         float t, c0, c1, c2, c3;
821         int a;
822
823         c0= f[0];
824         c1= 3.0f * (f[3] - f[0]);
825         c2= 3.0f * (f[0] - 2.0f*f[3] + f[6]);
826         c3= f[9] - f[0] + 3.0f * (f[3] - f[6]);
827         
828         for (a=0; a < b; a++) {
829                 t= o[a];
830                 o[a]= c0 + t*c1 + t*t*c2 + t*t*t*c3;
831         }
832 }
833
834
835 /* -------------------------- */
836
837 /* Calculate F-Curve value for 'evaltime' using BezTriple keyframes */
838 static float fcurve_eval_keyframes (FCurve *fcu, BezTriple *bezts, float evaltime)
839 {
840         BezTriple *bezt, *prevbezt, *lastbezt;
841         float v1[2], v2[2], v3[2], v4[2], opl[32], dx, fac;
842         int a, b;
843         float cvalue = 0.0f;
844         
845         /* get pointers */
846         a= fcu->totvert-1;
847         prevbezt= bezts;
848         bezt= prevbezt+1;
849         lastbezt= prevbezt + a;
850         
851         /* evaluation time at or past endpoints? */
852         if (prevbezt->vec[1][0] >= evaltime) {
853                 /* before or on first keyframe */
854                 if ((fcu->extend == FCURVE_EXTRAPOLATE_LINEAR) && (prevbezt->ipo != BEZT_IPO_CONST)) {
855                         /* linear or bezier interpolation */
856                         if (prevbezt->ipo==BEZT_IPO_LIN) {
857                                 /* Use the next center point instead of our own handle for
858                                  * linear interpolated extrapolate 
859                                  */
860                                 if (fcu->totvert == 1) 
861                                         cvalue= prevbezt->vec[1][1];
862                                 else {
863                                         bezt = prevbezt+1;
864                                         dx= prevbezt->vec[1][0] - evaltime;
865                                         fac= bezt->vec[1][0] - prevbezt->vec[1][0];
866                                         
867                                         /* prevent division by zero */
868                                         if (fac) {
869                                                 fac= (bezt->vec[1][1] - prevbezt->vec[1][1]) / fac;
870                                                 cvalue= prevbezt->vec[1][1] - (fac * dx);
871                                         }
872                                         else 
873                                                 cvalue= prevbezt->vec[1][1];
874                                 }
875                         } 
876                         else {
877                                 /* Use the first handle (earlier) of first BezTriple to calculate the
878                                  * gradient and thus the value of the curve at evaltime
879                                  */
880                                 dx= prevbezt->vec[1][0] - evaltime;
881                                 fac= prevbezt->vec[1][0] - prevbezt->vec[0][0];
882                                 
883                                 /* prevent division by zero */
884                                 if (fac) {
885                                         fac= (prevbezt->vec[1][1] - prevbezt->vec[0][1]) / fac;
886                                         cvalue= prevbezt->vec[1][1] - (fac * dx);
887                                 }
888                                 else 
889                                         cvalue= prevbezt->vec[1][1];
890                         }
891                 }
892                 else {
893                         /* constant (BEZT_IPO_HORIZ) extrapolation or constant interpolation, 
894                          * so just extend first keyframe's value 
895                          */
896                         cvalue= prevbezt->vec[1][1];
897                 }
898         }
899         else if (lastbezt->vec[1][0] <= evaltime) {
900                 /* after or on last keyframe */
901                 if ((fcu->extend == FCURVE_EXTRAPOLATE_LINEAR) && (lastbezt->ipo != BEZT_IPO_CONST)) {
902                         /* linear or bezier interpolation */
903                         if (lastbezt->ipo==BEZT_IPO_LIN) {
904                                 /* Use the next center point instead of our own handle for
905                                  * linear interpolated extrapolate 
906                                  */
907                                 if (fcu->totvert == 1) 
908                                         cvalue= lastbezt->vec[1][1];
909                                 else {
910                                         prevbezt = lastbezt - 1;
911                                         dx= evaltime - lastbezt->vec[1][0];
912                                         fac= lastbezt->vec[1][0] - prevbezt->vec[1][0];
913                                         
914                                         /* prevent division by zero */
915                                         if (fac) {
916                                                 fac= (lastbezt->vec[1][1] - prevbezt->vec[1][1]) / fac;
917                                                 cvalue= lastbezt->vec[1][1] + (fac * dx);
918                                         }
919                                         else 
920                                                 cvalue= lastbezt->vec[1][1];
921                                 }
922                         } 
923                         else {
924                                 /* Use the gradient of the second handle (later) of last BezTriple to calculate the
925                                  * gradient and thus the value of the curve at evaltime
926                                  */
927                                 dx= evaltime - lastbezt->vec[1][0];
928                                 fac= lastbezt->vec[2][0] - lastbezt->vec[1][0];
929                                 
930                                 /* prevent division by zero */
931                                 if (fac) {
932                                         fac= (lastbezt->vec[2][1] - lastbezt->vec[1][1]) / fac;
933                                         cvalue= lastbezt->vec[1][1] + (fac * dx);
934                                 }
935                                 else 
936                                         cvalue= lastbezt->vec[1][1];
937                         }
938                 }
939                 else {
940                         /* constant (BEZT_IPO_HORIZ) extrapolation or constant interpolation, 
941                          * so just extend last keyframe's value 
942                          */
943                         cvalue= lastbezt->vec[1][1];
944                 }
945         }
946         else {
947                 /* evaltime occurs somewhere in the middle of the curve */
948                 for (a=0; prevbezt && bezt && (a < fcu->totvert-1); a++, prevbezt=bezt, bezt++) {  
949                         /* evaltime occurs within the interval defined by these two keyframes */
950                         if ((prevbezt->vec[1][0] <= evaltime) && (bezt->vec[1][0] >= evaltime)) {
951                                 /* value depends on interpolation mode */
952                                 if (prevbezt->ipo == BEZT_IPO_CONST) {
953                                         /* constant (evaltime not relevant, so no interpolation needed) */
954                                         cvalue= prevbezt->vec[1][1];
955                                 }
956                                 else if (prevbezt->ipo == BEZT_IPO_LIN) {
957                                         /* linear - interpolate between values of the two keyframes */
958                                         fac= bezt->vec[1][0] - prevbezt->vec[1][0];
959                                         
960                                         /* prevent division by zero */
961                                         if (fac) {
962                                                 fac= (evaltime - prevbezt->vec[1][0]) / fac;
963                                                 cvalue= prevbezt->vec[1][1] + (fac * (bezt->vec[1][1] - prevbezt->vec[1][1]));
964                                         }
965                                         else
966                                                 cvalue= prevbezt->vec[1][1];
967                                 }
968                                 else {
969                                         /* bezier interpolation */
970                                                 /* v1,v2 are the first keyframe and its 2nd handle */
971                                         v1[0]= prevbezt->vec[1][0];
972                                         v1[1]= prevbezt->vec[1][1];
973                                         v2[0]= prevbezt->vec[2][0];
974                                         v2[1]= prevbezt->vec[2][1];
975                                                 /* v3,v4 are the last keyframe's 1st handle + the last keyframe */
976                                         v3[0]= bezt->vec[0][0];
977                                         v3[1]= bezt->vec[0][1];
978                                         v4[0]= bezt->vec[1][0];
979                                         v4[1]= bezt->vec[1][1];
980                                         
981                                         /* adjust handles so that they don't overlap (forming a loop) */
982                                         correct_bezpart(v1, v2, v3, v4);
983                                         
984                                         /* try to get a value for this position - if failure, try another set of points */
985                                         b= findzero(evaltime, v1[0], v2[0], v3[0], v4[0], opl);
986                                         if (b) {
987                                                 berekeny(v1[1], v2[1], v3[1], v4[1], opl, 1);
988                                                 cvalue= opl[0];
989                                                 break;
990                                         }
991                                 }
992                         }
993                 }
994         }
995         
996         /* return value */
997         return cvalue;
998 }
999
1000 /* Calculate F-Curve value for 'evaltime' using FPoint samples */
1001 static float fcurve_eval_samples (FCurve *fcu, FPoint *fpts, float evaltime)
1002 {
1003         FPoint *prevfpt, *lastfpt, *fpt;
1004         float cvalue= 0.0f;
1005         
1006         /* get pointers */
1007         prevfpt= fpts;
1008         lastfpt= prevfpt + fcu->totvert-1;
1009         
1010         /* evaluation time at or past endpoints? */
1011         if (prevfpt->vec[0] >= evaltime) {
1012                 /* before or on first sample, so just extend value */
1013                 cvalue= prevfpt->vec[1];
1014         }
1015         else if (lastfpt->vec[0] <= evaltime) {
1016                 /* after or on last sample, so just extend value */
1017                 cvalue= lastfpt->vec[1];
1018         }
1019         else {
1020                 /* find the one on the right frame (assume that these are spaced on 1-frame intervals) */
1021                 fpt= prevfpt + (int)(evaltime - prevfpt->vec[0]);
1022                 cvalue= fpt->vec[1];
1023         }
1024         
1025         /* return value */
1026         return cvalue;
1027 }
1028
1029 /* ******************************** F-Curve Modifiers ********************************* */
1030
1031 /* Template --------------------------- */
1032
1033 /* Each modifier defines a set of functions, which will be called at the appropriate
1034  * times. In addition to this, each modifier should have a type-info struct, where
1035  * its functions are attached for use. 
1036  */
1037  
1038 /* Template for type-info data:
1039  *      - make a copy of this when creating new modifiers, and just change the functions
1040  *        pointed to as necessary
1041  *      - although the naming of functions doesn't matter, it would help for code
1042  *        readability, to follow the same naming convention as is presented here
1043  *      - any functions that a constraint doesn't need to define, don't define
1044  *        for such cases, just use NULL 
1045  *      - these should be defined after all the functions have been defined, so that
1046  *        forward-definitions/prototypes don't need to be used!
1047  *      - keep this copy #if-def'd so that future constraints can get based off this
1048  */
1049 #if 0
1050 static FModifierTypeInfo FMI_MODNAME = {
1051         FMODIFIER_TYPE_MODNAME, /* type */
1052         sizeof(FMod_ModName), /* size */
1053         "Modifier Name", /* name */
1054         "FMod_ModName", /* struct name */
1055         fcm_modname_free, /* free data */
1056         fcm_modname_relink, /* relink data */
1057         fcm_modname_copy, /* copy data */
1058         fcm_modname_new_data, /* new data */
1059         fcm_modname_evaluate /* evaluate */
1060 };
1061 #endif
1062
1063 /* Generator F-Curve Modifier --------------------------- */
1064
1065 static void fcm_generator_free (FModifier *fcm)
1066 {
1067         FMod_Generator *data= (FMod_Generator *)fcm->data;
1068         
1069         /* free polynomial coefficients array */
1070         if (data->poly_coefficients)
1071                 MEM_freeN(data->poly_coefficients);
1072 }
1073
1074 static void fcm_generator_copy (FModifier *fcm, FModifier *src)
1075 {
1076         FMod_Generator *gen= (FMod_Generator *)fcm->data;
1077         FMod_Generator *ogen= (FMod_Generator *)src->data;
1078         
1079         /* copy polynomial coefficients array? */
1080         if (ogen->poly_coefficients)
1081                 gen->poly_coefficients= MEM_dupallocN(ogen->poly_coefficients);
1082 }
1083
1084 static void fcm_generator_new_data (void *mdata)
1085 {
1086         FMod_Generator *data= (FMod_Generator *)mdata;
1087         float *cp;
1088         
1089         /* set default generator to be linear 0-1 (gradient = 1, y-offset = 0) */
1090         data->poly_order= 1;
1091         cp= data->poly_coefficients= MEM_callocN(sizeof(float)*2, "FMod_Generator_Coefs");
1092         cp[0] = 0; // y-offset 
1093         cp[1] = 1; // gradient
1094 }
1095
1096
1097 static void fcm_generator_evaluate (FCurve *fcu, FModifier *fcm, float *cvalue, float evaltime)
1098 {
1099         FMod_Generator *data= (FMod_Generator *)fcm->data;
1100         
1101         /* behaviour depends on mode (NOTE: we don't need to do anything...) */
1102         switch (data->mode) {
1103                 case FCM_GENERATOR_POLYNOMIAL: /* polynomial expression */
1104                 {
1105                         /* we overwrite cvalue with the sum of the polynomial */
1106                         float value= 0.0f, *cp = NULL;
1107                         unsigned int i;
1108                         
1109                         /* for each coefficient, add to value, which we'll write to *cvalue in one go */
1110                         // TODO: could this be more efficient (i.e. without need to recalc pow() everytime)
1111                         cp= data->poly_coefficients;
1112                         for (i=0; (i <= data->poly_order) && (cp); i++, cp++)
1113                                 value += (*cp) * (float)pow(evaltime, i);
1114                         
1115                         /* only if something changed */
1116                         if (data->poly_order)
1117                                 *cvalue= value;
1118                 }
1119                         break;
1120
1121 #ifndef DISABLE_PYTHON
1122                 case FCM_GENERATOR_EXPRESSION: /* py-expression */
1123                         // TODO...
1124                         break;
1125 #endif /* DISABLE_PYTHON */
1126         }
1127 }
1128
1129 static FModifierTypeInfo FMI_GENERATOR = {
1130         FMODIFIER_TYPE_GENERATOR, /* type */
1131         sizeof(FMod_Generator), /* size */
1132         "Generator", /* name */
1133         "FMod_Generator", /* struct name */
1134         fcm_generator_free, /* free data */
1135         fcm_generator_copy, /* copy data */
1136         fcm_generator_new_data, /* new data */
1137         fcm_generator_evaluate /* evaluate */
1138 };
1139
1140 /* Envelope F-Curve Modifier --------------------------- */
1141
1142 static void fcm_envelope_free (FModifier *fcm)
1143 {
1144         FMod_Envelope *data= (FMod_Envelope *)fcm->data;
1145         
1146         /* free envelope data array */
1147         if (data->data)
1148                 MEM_freeN(data->data);
1149 }
1150
1151 static void fcm_envelope_copy (FModifier *fcm, FModifier *src)
1152 {
1153         FMod_Envelope *gen= (FMod_Envelope *)fcm->data;
1154         FMod_Envelope *ogen= (FMod_Envelope *)src->data;
1155         
1156         /* copy envelope data array */
1157         if (ogen->data)
1158                 gen->data= MEM_dupallocN(ogen->data);
1159 }
1160
1161 static void fcm_envelope_evaluate (FCurve *fcu, FModifier *fcm, float *cvalue, float evaltime)
1162 {
1163         FMod_Envelope *env= (FMod_Envelope *)fcm->data;
1164         FCM_EnvelopeData *fed, *prevfed, *lastfed;
1165         float min=0.0f, max=0.0f, fac=0.0f;
1166         int a;
1167         
1168         /* get pointers */
1169         if (env->data == NULL) return;
1170         prevfed= env->data;
1171         fed= prevfed + 1;
1172         lastfed= prevfed + env->totvert-1;
1173         
1174         /* get min/max values for envelope at evaluation time (relative to mid-value) */
1175         if (prevfed->time >= evaltime) {
1176                 /* before or on first sample, so just extend value */
1177                 min= prevfed->min;
1178                 max= prevfed->max;
1179         }
1180         else if (lastfed->time <= evaltime) {
1181                 /* after or on last sample, so just extend value */
1182                 min= lastfed->min;
1183                 max= lastfed->max;
1184         }
1185         else {
1186                 /* evaltime occurs somewhere between segments */
1187                 for (a=0; prevfed && fed && (a < env->totvert-1); a++, prevfed=fed, fed++) {  
1188                         /* evaltime occurs within the interval defined by these two envelope points */
1189                         if ((prevfed->time <= evaltime) && (fed->time >= evaltime)) {
1190                                 float afac, bfac, diff;
1191                                 
1192                                 diff= fed->time - prevfed->time;
1193                                 afac= (evaltime - prevfed->time) / diff;
1194                                 bfac= (fed->time - evaltime)/(diff);
1195                                 
1196                                 min= afac*prevfed->min + bfac*fed->min;
1197                                 max= afac*prevfed->max + bfac*fed->max;
1198                                 
1199                                 break;
1200                         }
1201                 }
1202         }
1203         
1204         /* adjust *cvalue 
1205          * NOTE: env->min/max are relative to env->midval, and can be either +ve OR -ve, so we add...
1206          */
1207         fac= (*cvalue - min) / (max - min);
1208         *cvalue= (env->midval + env->min) + (fac * (env->max - env->min)); 
1209 }
1210
1211 static FModifierTypeInfo FMI_ENVELOPE = {
1212         FMODIFIER_TYPE_ENVELOPE, /* type */
1213         sizeof(FMod_Envelope), /* size */
1214         "Envelope", /* name */
1215         "FMod_Envelope", /* struct name */
1216         fcm_envelope_free, /* free data */
1217         fcm_envelope_copy, /* copy data */
1218         NULL, /* new data */
1219         fcm_envelope_evaluate /* evaluate */
1220 };
1221
1222 /* Cycles F-Curve Modifier  --------------------------- */
1223
1224 /* This modifier changes evaltime to something that exists within the curve's frame-range, 
1225  * then re-evaluates modifier stack up to this point using the new time. This re-entrant behaviour
1226  * is very likely to be more time-consuming than the original approach... (which was tighly integrated into 
1227  * the calculation code...).
1228  *
1229  * NOTE: this needs to be at the start of the stack to be of use, as it needs to know the extents of the keyframes/sample-data
1230  * Possible TODO - store length of cycle information that can be initialised from the extents of the keyframes/sample-data, and adjusted
1231  *                              as appropriate
1232  */
1233
1234 static void fcm_cycles_evaluate (FCurve *fcu, FModifier *fcm, float *cvalue, float evaltime)
1235 {
1236         FMod_Cycles *data= (FMod_Cycles *)fcm->data;
1237         ListBase mods = {NULL, NULL};
1238         float prevkey[2], lastkey[2], cycyofs=0.0f;
1239         float new_value;
1240         short side=0, mode=0;
1241         int cycles=0;
1242         
1243         /* check if modifier is first in stack, otherwise disable ourself... */
1244         // FIXME...
1245         if (fcm->prev) {
1246                 fcm->flag |= FMODIFIER_FLAG_DISABLED;
1247                 return;
1248         }
1249         
1250         /* calculate new evaltime due to cyclic interpolation */
1251         if (fcu && fcu->bezt) {
1252                 BezTriple *prevbezt= fcu->bezt;
1253                 BezTriple *lastbezt= prevbezt + fcu->totvert-1;
1254                 
1255                 prevkey[0]= prevbezt->vec[1][0];
1256                 prevkey[1]= prevbezt->vec[1][1];
1257                 
1258                 lastkey[0]= lastbezt->vec[1][0];
1259                 lastkey[1]= lastbezt->vec[1][1];
1260         }
1261         else if (fcu && fcu->fpt) {
1262                 FPoint *prevfpt= fcu->fpt;
1263                 FPoint *lastfpt= prevfpt + fcu->totvert-1;
1264                 
1265                 prevkey[0]= prevfpt->vec[0];
1266                 prevkey[1]= prevfpt->vec[1];
1267                 
1268                 lastkey[0]= lastfpt->vec[0];
1269                 lastkey[1]= lastfpt->vec[1];
1270         }
1271         else
1272                 return;
1273                 
1274         /* check if modifier will do anything
1275          *      1) if in data range, definitely don't do anything
1276          *      2) if before first frame or after last frame, make sure some cycling is in use
1277          */
1278         if (evaltime < prevkey[0]) {
1279                 if (data->before_mode) {
1280                         side= -1;
1281                         mode= data->before_mode;
1282                         cycles= data->before_cycles;
1283                 }
1284         }
1285         else if (evaltime > lastkey[0]) {
1286                 if (data->after_mode) {
1287                         side= 1;
1288                         mode= data->after_mode;
1289                         cycles= data->after_cycles;
1290                 }
1291         }
1292         if ELEM(0, side, mode)
1293                 return;
1294                 
1295         /* extrapolation mode is 'cyclic' - find relative place within a cycle */
1296         // FIXME: adding the more fine-grained control of extrpolation mode
1297         {
1298                 float cycdx=0, cycdy=0, ofs=0;
1299                 
1300                 /* ofs is start frame of cycle */
1301                 ofs= prevkey[0];
1302                 
1303                 /* calculate period and amplitude (total height) of a cycle */
1304                 cycdx= lastkey[0] - prevkey[0];
1305                 cycdy= lastkey[1] - prevkey[1];
1306                 
1307                 /* check if cycle is infinitely small, to be point of being impossible to use */
1308                 if (cycdx == 0)
1309                         return;
1310                 /* check that cyclic is still enabled for the specified time */
1311                 if (cycles == 0) {
1312                         /* catch this case so that we don't exit when we have cycles=0
1313                          * as this indicates infinite cycles...
1314                          */
1315                 }
1316                 else if ( ((float)side * (evaltime - ofs) / cycdx) > cycles )
1317                         return;
1318                 
1319                 
1320                 /* check if 'cyclic extrapolation', and thus calculate y-offset for this cycle */
1321                 if (mode == FCM_EXTRAPOLATE_CYCLIC_OFFSET) {
1322                         cycyofs = (float)floor((evaltime - ofs) / cycdx);
1323                         cycyofs *= cycdy;
1324                 }
1325                 
1326                 /* calculate where in the cycle we are (overwrite evaltime to reflect this) */
1327                 evaltime= (float)(fmod(evaltime-ofs, cycdx) + ofs);
1328                 if (evaltime < ofs) evaltime += cycdx;
1329         }
1330         
1331         
1332         /* store modifiers after (and including ourself) before recalculating curve with new evaltime */
1333         mods= fcu->modifiers;
1334         fcu->modifiers.first= fcu->modifiers.last= NULL;
1335         
1336         /* re-enter the evaluation loop (but without the burden of evaluating any modifiers, so 'should' be relatively quick) */
1337         new_value= evaluate_fcurve(fcu, evaltime);
1338         
1339         /* restore modifiers, and set new value (don't assume everything is still ok after being re-entrant) */
1340         fcu->modifiers= mods;
1341         *cvalue= new_value + cycyofs;
1342 }
1343
1344 static FModifierTypeInfo FMI_CYCLES = {
1345         FMODIFIER_TYPE_CYCLES, /* type */
1346         sizeof(FMod_Cycles), /* size */
1347         "Cycles", /* name */
1348         "FMod_Cycles", /* struct name */
1349         NULL, /* free data */
1350         NULL, /* copy data */
1351         NULL, /* new data */
1352         fcm_cycles_evaluate /* evaluate */
1353 };
1354
1355 /* Noise F-Curve Modifier  --------------------------- */
1356
1357 #if 0 // XXX not yet implemented 
1358 static FModifierTypeInfo FMI_NOISE = {
1359         FMODIFIER_TYPE_NOISE, /* type */
1360         sizeof(FMod_Noise), /* size */
1361         "Noise", /* name */
1362         "FMod_Noise", /* struct name */
1363         NULL, /* free data */
1364         NULL, /* copy data */
1365         fcm_noise_new_data, /* new data */
1366         fcm_noise_evaluate /* evaluate */
1367 };
1368 #endif // XXX not yet implemented
1369
1370 /* Filter F-Curve Modifier --------------------------- */
1371
1372 #if 0 // XXX not yet implemented 
1373 static FModifierTypeInfo FMI_FILTER = {
1374         FMODIFIER_TYPE_FILTER, /* type */
1375         sizeof(FMod_Filter), /* size */
1376         "Filter", /* name */
1377         "FMod_Filter", /* struct name */
1378         NULL, /* free data */
1379         NULL, /* copy data */
1380         NULL, /* new data */
1381         fcm_filter_evaluate /* evaluate */
1382 };
1383 #endif // XXX not yet implemented
1384
1385
1386 /* Python F-Curve Modifier --------------------------- */
1387
1388 static void fcm_python_free (FModifier *fcm)
1389 {
1390         FMod_Python *data= (FMod_Python *)fcm->data;
1391         
1392         /* id-properties */
1393         IDP_FreeProperty(data->prop);
1394         MEM_freeN(data->prop);
1395 }
1396
1397 static void fcm_python_new_data (void *mdata) 
1398 {
1399         FMod_Python *data= (FMod_Python *)mdata;
1400         
1401         /* everything should be set correctly by calloc, except for the prop->type constant.*/
1402         data->prop = MEM_callocN(sizeof(IDProperty), "PyFModifierProps");
1403         data->prop->type = IDP_GROUP;
1404 }
1405
1406 static void fcm_python_copy (FModifier *fcm, FModifier *src)
1407 {
1408         FMod_Python *pymod = (FMod_Python *)fcm->data;
1409         FMod_Python *opymod = (FMod_Python *)src->data;
1410         
1411         pymod->prop = IDP_CopyProperty(opymod->prop);
1412 }
1413
1414 static void fcm_python_evaluate (FCurve *fcu, FModifier *fcm, float *cvalue, float evaltime)
1415 {
1416 #ifndef DISABLE_PYTHON
1417         //FMod_Python *data= (FMod_Python *)fcm->data;
1418         
1419         /* FIXME... need to implement this modifier...
1420          *      It will need it execute a script using the custom properties 
1421          */
1422 #endif /* DISABLE_PYTHON */
1423 }
1424
1425 static FModifierTypeInfo FMI_PYTHON = {
1426         FMODIFIER_TYPE_PYTHON, /* type */
1427         sizeof(FMod_Python), /* size */
1428         "Python", /* name */
1429         "FMod_Python", /* struct name */
1430         fcm_python_free, /* free data */
1431         fcm_python_copy, /* copy data */
1432         fcm_python_new_data, /* new data */
1433         fcm_python_evaluate /* evaluate */
1434 };
1435
1436
1437 /* F-Curve Modifier API --------------------------- */
1438 /* All of the F-Curve Modifier api functions use FModifierTypeInfo structs to carry out
1439  * and operations that involve F-Curve modifier specifc code.
1440  */
1441
1442 /* These globals only ever get directly accessed in this file */
1443 static FModifierTypeInfo *fmodifiersTypeInfo[FMODIFIER_NUM_TYPES];
1444 static short FMI_INIT= 1; /* when non-zero, the list needs to be updated */
1445
1446 /* This function only gets called when FMI_INIT is non-zero */
1447 static void fmods_init_typeinfo () {
1448         fmodifiersTypeInfo[0]=  NULL;                                   /* 'Null' F-Curve Modifier */
1449         fmodifiersTypeInfo[1]=  &FMI_GENERATOR;                 /* Generator F-Curve Modifier */
1450         fmodifiersTypeInfo[2]=  &FMI_ENVELOPE;                  /* Envelope F-Curve Modifier */
1451         fmodifiersTypeInfo[3]=  &FMI_CYCLES;                    /* Cycles F-Curve Modifier */
1452         fmodifiersTypeInfo[4]=  NULL/*&FMI_NOISE*/;                             /* Apply-Noise F-Curve Modifier */ // XXX unimplemented
1453         fmodifiersTypeInfo[5]=  NULL/*&FMI_FILTER*/;                    /* Filter F-Curve Modifier */  // XXX unimplemented
1454         fmodifiersTypeInfo[6]=  &FMI_PYTHON;                    /* Custom Python F-Curve Modifier */
1455 }
1456
1457 /* This function should be used for getting the appropriate type-info when only
1458  * a F-Curve modifier type is known
1459  */
1460 FModifierTypeInfo *get_fmodifier_typeinfo (int type)
1461 {
1462         /* initialise the type-info list? */
1463         if (FMI_INIT) {
1464                 fmods_init_typeinfo();
1465                 FMI_INIT = 0;
1466         }
1467         
1468         /* only return for valid types */
1469         if ( (type >= FMODIFIER_TYPE_NULL) && 
1470                  (type <= FMODIFIER_NUM_TYPES ) ) 
1471         {
1472                 /* there shouldn't be any segfaults here... */
1473                 return fmodifiersTypeInfo[type];
1474         }
1475         else {
1476                 printf("No valid F-Curve Modifier type-info data available. Type = %i \n", type);
1477         }
1478         
1479         return NULL;
1480
1481  
1482 /* This function should always be used to get the appropriate type-info, as it
1483  * has checks which prevent segfaults in some weird cases.
1484  */
1485 FModifierTypeInfo *fmodifier_get_typeinfo (FModifier *fcm)
1486 {
1487         /* only return typeinfo for valid modifiers */
1488         if (fcm)
1489                 return get_fmodifier_typeinfo(fcm->type);
1490         else
1491                 return NULL;
1492 }
1493
1494 /* API --------------------------- */
1495
1496 /* Add a new F-Curve Modifier to the given F-Curve of a certain type */
1497 FModifier *fcurve_add_modifier (FCurve *fcu, int type)
1498 {
1499         FModifierTypeInfo *fmi= get_fmodifier_typeinfo(type);
1500         FModifier *fcm;
1501         
1502         /* sanity checks */
1503         if ELEM(NULL, fcu, fmi)
1504                 return NULL;
1505         
1506         /* special checks for whether modifier can be added */
1507         if ((fcu->modifiers.first) && (type == FMODIFIER_TYPE_CYCLES)) {
1508                 /* cycles modifier must be first in stack, so for now, don't add if it can't be */
1509                 // TODO: perhaps there is some better way, but for now, 
1510                 printf("Error: Cannot add 'Cycles' modifier to F-Curve, as 'Cycles' modifier can only be first in stack. \n");
1511                 return NULL;
1512         }
1513         
1514         /* add modifier itself */
1515         fcm= MEM_callocN(sizeof(FModifier), "F-Curve Modifier");
1516         BLI_addtail(&fcu->modifiers, fcm);
1517         
1518         /* add modifier's data */
1519         fcm->data= MEM_callocN(fmi->size, "F-Curve Modifier Data");
1520                 
1521         /* init custom settings if necessary */
1522         if (fmi->new_data)      
1523                 fmi->new_data(fcm->data);
1524                 
1525         /* return modifier for further editing */
1526         return fcm;
1527 }
1528
1529 /* Duplicate all of the F-Curve Modifiers in the Modifier stacks */
1530 void fcurve_copy_modifiers (ListBase *dst, ListBase *src)
1531 {
1532         FModifier *fcm, *srcfcm;
1533         
1534         if ELEM(NULL, dst, src)
1535                 return;
1536         
1537         dst->first= dst->last= NULL;
1538         BLI_duplicatelist(dst, src);
1539         
1540         for (fcm=dst->first, srcfcm=src->first; fcm && srcfcm; srcfcm=srcfcm->next, fcm=fcm->next) {
1541                 FModifierTypeInfo *fmi= fmodifier_get_typeinfo(fcm);
1542                 
1543                 /* make a new copy of the F-Modifier's data */
1544                 fcm->data = MEM_dupallocN(fcm->data);
1545                 
1546                 /* only do specific constraints if required */
1547                 if (fmi && fmi->copy_data)
1548                         fmi->copy_data(fcm, srcfcm);
1549         }
1550 }
1551
1552 /* Remove and free the given F-Curve Modifier from the given F-Curve's stack  */
1553 void fcurve_remove_modifier (FCurve *fcu, FModifier *fcm)
1554 {
1555         FModifierTypeInfo *fmi= fmodifier_get_typeinfo(fcm);
1556         
1557         /* sanity check */
1558         if (fcm == NULL)
1559                 return;
1560         
1561         /* free modifier's special data (stored inside fcm->data) */
1562         if (fmi && fmi->free_data)
1563                 fmi->free_data(fcm);
1564                 
1565         /* free modifier's data (fcm->data) */
1566         MEM_freeN(fcm->data);
1567         
1568         /* remove modifier from stack */
1569         if (fcu)
1570                 BLI_freelinkN(&fcu->modifiers, fcm);
1571         else {
1572                 // XXX this case can probably be removed some day, as it shouldn't happen...
1573                 printf("fcurve_remove_modifier() - no fcurve \n");
1574                 MEM_freeN(fcm);
1575         }
1576 }
1577
1578 /* Remove all of a given F-Curve's modifiers */
1579 void fcurve_free_modifiers (FCurve *fcu)
1580 {
1581         FModifier *fcm, *fmn;
1582         
1583         /* sanity check */
1584         if (fcu == NULL)
1585                 return;
1586         
1587         /* free each modifier in order - modifier is unlinked from list and freed */
1588         for (fcm= fcu->modifiers.first; fcm; fcm= fmn) {
1589                 fmn= fcm->next;
1590                 fcurve_remove_modifier(fcu, fcm);
1591         }
1592 }
1593
1594 /* Bake modifiers for given F-Curve to curve sample data, in the frame range defined
1595  * by start and end (inclusive).
1596  */
1597 void fcurve_bake_modifiers (FCurve *fcu, int start, int end)
1598 {
1599         FPoint *fpt, *new_fpt;
1600         int cfra;
1601         
1602         /* sanity checks */
1603         // TODO: make these tests report errors using reports not printf's
1604         if ELEM(NULL, fcu, fcu->modifiers.first) {
1605                 printf("Error: No F-Curve with F-Curve Modifiers to Bake\n");
1606                 return;
1607         }
1608         if (start >= end) {
1609                 printf("Error: Frame range for F-Curve Modifier Baking inappropriate \n");
1610                 return;
1611         }
1612         
1613         /* set up sample data */
1614         fpt= new_fpt= MEM_callocN(sizeof(FPoint)*(end-start+1), "FPoint FModifier Samples");
1615         
1616         /* sample the curve at 1-frame intervals from start to end frames 
1617          *      - assume that any ChannelDriver possibly present did not interfere in any way
1618          */
1619         for (cfra= start; cfra <= end; cfra++, fpt++) {
1620                 fpt->vec[0]= (float)cfra;
1621                 fpt->vec[1]= evaluate_fcurve(fcu, (float)cfra);
1622         }
1623         
1624         /* free any existing sample/keyframe data on curve, and all modifiers */
1625         if (fcu->bezt) MEM_freeN(fcu->bezt);
1626         if (fcu->fpt) MEM_freeN(fcu->fpt);
1627         fcurve_free_modifiers(fcu);
1628         
1629         /* store the samples */
1630         fcu->fpt= new_fpt;
1631         fcu->totvert= end - start + 1;
1632 }
1633
1634 /* ***************************** F-Curve - Evaluation ********************************* */
1635
1636 /* Evaluate and return the value of the given F-Curve at the specified frame ("evaltime") 
1637  * Note: this is also used for drivers
1638  */
1639 // TODO: set up the modifier system...
1640 float evaluate_fcurve (FCurve *fcu, float evaltime) 
1641 {
1642         FModifier *fcm;
1643         float cvalue = 0.0f;
1644         
1645         /* if there is a driver (only if this F-Curve is acting as 'driver'), evaluate it to find value to use as "evaltime" 
1646          *      - this value will also be returned as the value of the 'curve', if there are no keyframes
1647          */
1648         if (fcu->driver) {
1649                 /* evaltime now serves as input for the curve */
1650                 evaltime= cvalue= evaluate_driver(fcu->driver, evaltime);
1651         }
1652         
1653         /* evaluate curve-data */
1654         if (fcu->bezt)
1655                 cvalue= fcurve_eval_keyframes(fcu, fcu->bezt, evaltime);
1656         else if (fcu->fpt)
1657                 cvalue= fcurve_eval_samples(fcu, fcu->fpt, evaltime);
1658         
1659         /* evaluate modifiers */
1660         for (fcm= fcu->modifiers.first; fcm; fcm= fcm->next) {
1661                 FModifierTypeInfo *fmi= fmodifier_get_typeinfo(fcm);
1662                 
1663                 /* only evaluate if there's a callback for this */
1664                 // TODO: implement the 'influence' control feature...
1665                 if (fmi && fmi->evaluate_modifier) {
1666                         if ((fcm->flag & FMODIFIER_FLAG_DISABLED) == 0)
1667                                 fmi->evaluate_modifier(fcu, fcm, &cvalue, evaltime);
1668                 }
1669         }
1670         
1671         /* return evaluated value */
1672         return cvalue;
1673 }
1674
1675 /* Calculate the value of the given F-Curve at the given frame, and set its curval */
1676 // TODO: will this be necessary?
1677 void calculate_fcurve (FCurve *fcu, float ctime)
1678 {
1679         /* calculate and set curval (evaluates driver too) */
1680         fcu->curval= evaluate_fcurve(fcu, ctime);
1681 }
1682