NLA Branch: Merge from 2.5 20116:20214
[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 <stddef.h>
9 #include <string.h>
10 #include <float.h>
11
12 #ifdef HAVE_CONFIG_H
13 #include <config.h>
14 #endif
15
16 #include "MEM_guardedalloc.h"
17
18 #include "DNA_anim_types.h"
19
20 #include "BLI_blenlib.h"
21 #include "BLI_arithb.h"
22 #include "BLI_noise.h"
23
24 #include "BKE_fcurve.h"
25 #include "BKE_curve.h" 
26 #include "BKE_global.h"
27 #include "BKE_idprop.h"
28 #include "BKE_utildefines.h"
29
30 #include "RNA_access.h"
31 #include "RNA_types.h"
32
33 #ifndef DISABLE_PYTHON
34 #include "BPY_extern.h" /* for BPY_pydriver_eval() */
35 #endif
36
37 #define SMALL -1.0e-10
38 #define SELECT 1
39
40 /* ************************** Data-Level Functions ************************* */
41
42 /* ---------------------- Freeing --------------------------- */
43
44 /* Frees the F-Curve itself too, so make sure BLI_remlink is called before calling this... */
45 void free_fcurve (FCurve *fcu) 
46 {
47         if (fcu == NULL) 
48                 return;
49         
50         /* free curve data */
51         if (fcu) {
52                 if (fcu->bezt) MEM_freeN(fcu->bezt);
53                 if (fcu->fpt) MEM_freeN(fcu->fpt);
54         }
55         
56         /* free RNA-path, as this were allocated when getting the path string */
57         if (fcu->rna_path)
58                 MEM_freeN(fcu->rna_path);
59         
60         /* free extra data - i.e. modifiers, and driver */
61         fcurve_free_driver(fcu);
62         fcurve_free_modifiers(fcu);
63         
64         /* free f-curve itself */
65         MEM_freeN(fcu);
66 }
67
68 /* Frees a list of F-Curves */
69 void free_fcurves (ListBase *list)
70 {
71         FCurve *fcu, *fcn;
72         
73         /* sanity check */
74         if (list == NULL)
75                 return;
76                 
77         /* free data - no need to call remlink before freeing each curve, 
78          * as we store reference to next, and freeing only touches the curve
79          * it's given
80          */
81         for (fcu= list->first; fcu; fcu= fcn) {
82                 fcn= fcu->next;
83                 free_fcurve(fcu);
84         }
85         
86         /* clear pointers just in case */
87         list->first= list->last= NULL;
88 }       
89
90 /* ---------------------- Copy --------------------------- */
91
92 /* duplicate an F-Curve */
93 FCurve *copy_fcurve (FCurve *fcu)
94 {
95         FCurve *fcu_d;
96         
97         /* sanity check */
98         if (fcu == NULL)
99                 return NULL;
100                 
101         /* make a copy */
102         fcu_d= MEM_dupallocN(fcu);
103         
104         fcu_d->next= fcu_d->prev= NULL;
105         fcu_d->grp= NULL;
106         
107         /* copy curve data */
108         fcu_d->bezt= MEM_dupallocN(fcu_d->bezt);
109         fcu_d->fpt= MEM_dupallocN(fcu_d->fpt);
110         
111         /* copy rna-path */
112         fcu_d->rna_path= MEM_dupallocN(fcu_d->rna_path);
113         
114         /* copy driver */
115         fcu_d->driver= fcurve_copy_driver(fcu_d->driver);
116         
117         /* copy modifiers */
118         fcurve_copy_modifiers(&fcu_d->modifiers, &fcu->modifiers);
119         
120         /* return new data */
121         return fcu_d;
122 }
123
124 /* duplicate a list of F-Curves */
125 void copy_fcurves (ListBase *dst, ListBase *src)
126 {
127         FCurve *dfcu, *sfcu;
128         
129         /* sanity checks */
130         if ELEM(NULL, dst, src)
131                 return;
132         
133         /* clear destination list first */
134         dst->first= dst->last= NULL;
135         
136         /* copy one-by-one */
137         for (sfcu= src->first; sfcu; sfcu= sfcu->next) {
138                 dfcu= copy_fcurve(sfcu);
139                 BLI_addtail(dst, dfcu);
140         }
141 }
142
143 /* ---------------------- Relink --------------------------- */
144
145 #if 0
146 /* uses id->newid to match pointers with other copied data 
147  *      - called after single-user or other such
148  */
149                         if (icu->driver)
150                                 ID_NEW(icu->driver->ob);
151 #endif
152
153 /* --------------------- Finding -------------------------- */
154
155 /* Find the F-Curve affecting the given RNA-access path + index, in the list of F-Curves provided */
156 FCurve *list_find_fcurve (ListBase *list, const char rna_path[], const int array_index)
157 {
158         FCurve *fcu;
159         
160         /* sanity checks */
161         if ( ELEM(NULL, list, rna_path) || (array_index < 0) )
162                 return NULL;
163         
164         /* check paths of curves, then array indices... */
165         for (fcu= list->first; fcu; fcu= fcu->next) {
166                 /* simple string-compare (this assumes that they have the same root...) */
167                 if (strcmp(fcu->rna_path, rna_path) == 0) {
168                         /* now check indicies */
169                         if (fcu->array_index == array_index)
170                                 return fcu;
171                 }
172         }
173         
174         /* return */
175         return NULL;
176 }
177
178 short on_keyframe_fcurve(FCurve *fcu, float cfra)
179 {
180         BezTriple *bezt;
181         unsigned i;
182
183         bezt= fcu->bezt;
184         for (i=0; i<fcu->totvert; i++, bezt++) {
185                 if (IS_EQ(bezt->vec[1][0], cfra))
186                         return 1;
187         }
188         
189         return 0;
190 }
191
192 /* Calculate the extents of F-Curve's data */
193 void calc_fcurve_bounds (FCurve *fcu, float *xmin, float *xmax, float *ymin, float *ymax)
194 {
195         float xminv=999999999.0f, xmaxv=-999999999.0f;
196         float yminv=999999999.0f, ymaxv=-999999999.0f;
197         short foundvert=0;
198         unsigned int i;
199         
200         if (fcu->totvert) {
201                 if (fcu->bezt) {
202                         /* frame range can be directly calculated from end verts */
203                         if (xmin || xmax) {
204                                 xminv= MIN2(xminv, fcu->bezt[0].vec[1][0]);
205                                 xmaxv= MAX2(xmaxv, fcu->bezt[fcu->totvert-1].vec[1][0]);
206                         }
207                         
208                         /* only loop over keyframes to find extents for values if needed */
209                         if (ymin || ymax) {
210                                 BezTriple *bezt;
211                                 
212                                 for (bezt=fcu->bezt, i=0; i < fcu->totvert; bezt++, i++) {
213                                         if (bezt->vec[1][1] < yminv)
214                                                 yminv= bezt->vec[1][1];
215                                         if (bezt->vec[1][1] > ymaxv)
216                                                 ymaxv= bezt->vec[1][1];
217                                 }
218                         }
219                 }
220                 else if (fcu->fpt) {
221                         /* frame range can be directly calculated from end verts */
222                         if (xmin || xmax) {
223                                 xminv= MIN2(xminv, fcu->fpt[0].vec[0]);
224                                 xmaxv= MAX2(xmaxv, fcu->fpt[fcu->totvert-1].vec[0]);
225                         }
226                         
227                         /* only loop over keyframes to find extents for values if needed */
228                         if (ymin || ymax) {
229                                 FPoint *fpt;
230                                 
231                                 for (fpt=fcu->fpt, i=0; i < fcu->totvert; fpt++, i++) {
232                                         if (fpt->vec[1] < yminv)
233                                                 yminv= fpt->vec[1];
234                                         if (fpt->vec[1] > ymaxv)
235                                                 ymaxv= fpt->vec[1];
236                                 }
237                         }
238                 }
239                 
240                 foundvert=1;
241         }
242         
243         /* minimum sizes are 1.0f */
244         if (foundvert) {
245                 if (xminv == xmaxv) xmaxv += 1.0f;
246                 if (yminv == ymaxv) ymaxv += 1.0f;
247                 
248                 if (xmin) *xmin= xminv;
249                 if (xmax) *xmax= xmaxv;
250                 
251                 if (ymin) *ymin= yminv;
252                 if (ymax) *ymax= ymaxv;
253         }
254         else {
255                 if (xmin) *xmin= 0.0f;
256                 if (xmax) *xmax= 0.0f;
257                 
258                 if (ymin) *ymin= 1.0f;
259                 if (ymax) *ymax= 1.0f;
260         }
261 }
262
263 /* Calculate the extents of F-Curve's keyframes */
264 void calc_fcurve_range (FCurve *fcu, float *start, float *end)
265 {
266         float min=999999999.0f, max=-999999999.0f;
267         short foundvert=0;
268
269         if (fcu->totvert) {
270                 if (fcu->bezt) {
271                         min= MIN2(min, fcu->bezt[0].vec[1][0]);
272                         max= MAX2(max, fcu->bezt[fcu->totvert-1].vec[1][0]);
273                 }
274                 else if (fcu->fpt) {
275                         min= MIN2(min, fcu->fpt[0].vec[0]);
276                         max= MAX2(max, fcu->fpt[fcu->totvert-1].vec[0]);
277                 }
278                 
279                 foundvert=1;
280         }
281         
282         /* minimum length is 1 frame */
283         if (foundvert) {
284                 if (min == max) max += 1.0f;
285                 *start= min;
286                 *end= max;
287         }
288         else {
289                 *start= 0.0f;
290                 *end= 1.0f;
291         }
292 }
293
294 /* ***************************** Keyframe Column Tools ********************************* */
295
296 /* add a BezTriple to a column */
297 void bezt_add_to_cfra_elem (ListBase *lb, BezTriple *bezt)
298 {
299         CfraElem *ce, *cen;
300         
301         for (ce= lb->first; ce; ce= ce->next) {
302                 /* double key? */
303                 if (ce->cfra == bezt->vec[1][0]) {
304                         if (bezt->f2 & SELECT) ce->sel= bezt->f2;
305                         return;
306                 }
307                 /* should key be inserted before this column? */
308                 else if (ce->cfra > bezt->vec[1][0]) break;
309         }
310         
311         /* create a new column */
312         cen= MEM_callocN(sizeof(CfraElem), "add_to_cfra_elem"); 
313         if (ce) BLI_insertlinkbefore(lb, ce, cen);
314         else BLI_addtail(lb, cen);
315
316         cen->cfra= bezt->vec[1][0];
317         cen->sel= bezt->f2;
318 }
319
320 /* ***************************** Samples Utilities ******************************* */
321 /* Some utilities for working with FPoints (i.e. 'sampled' animation curve data, such as
322  * data imported from BVH/Mocap files), which are specialised for use with high density datasets,
323  * which BezTriples/Keyframe data are ill equipped to do.
324  */
325  
326  
327 /* Basic sampling callback which acts as a wrapper for evaluate_fcurve() 
328  *      'data' arg here is unneeded here...
329  */
330 float fcurve_samplingcb_evalcurve (FCurve *fcu, void *data, float evaltime)
331 {
332         /* assume any interference from drivers on the curve is intended... */
333         return evaluate_fcurve(fcu, evaltime);
334
335
336  
337 /* Main API function for creating a set of sampled curve data, given some callback function 
338  * used to retrieve the values to store.
339  */
340 void fcurve_store_samples (FCurve *fcu, void *data, int start, int end, FcuSampleFunc sample_cb)
341 {
342         FPoint *fpt, *new_fpt;
343         int cfra;
344         
345         /* sanity checks */
346         // TODO: make these tests report errors using reports not printf's
347         if ELEM(NULL, fcu, sample_cb) {
348                 printf("Error: No F-Curve with F-Curve Modifiers to Bake\n");
349                 return;
350         }
351         if (start >= end) {
352                 printf("Error: Frame range for Sampled F-Curve creation is inappropriate \n");
353                 return;
354         }
355         
356         /* set up sample data */
357         fpt= new_fpt= MEM_callocN(sizeof(FPoint)*(end-start+1), "FPoint Samples");
358         
359         /* use the sampling callback at 1-frame intervals from start to end frames */
360         for (cfra= start; cfra <= end; cfra++, fpt++) {
361                 fpt->vec[0]= (float)cfra;
362                 fpt->vec[1]= sample_cb(fcu, data, (float)cfra);
363         }
364         
365         /* free any existing sample/keyframe data on curve  */
366         if (fcu->bezt) MEM_freeN(fcu->bezt);
367         if (fcu->fpt) MEM_freeN(fcu->fpt);
368         
369         /* store the samples */
370         fcu->bezt= NULL;
371         fcu->fpt= new_fpt;
372         fcu->totvert= end - start + 1;
373 }
374
375 /* ***************************** F-Curve Sanity ********************************* */
376 /* The functions here are used in various parts of Blender, usually after some editing
377  * of keyframe data has occurred. They ensure that keyframe data is properly ordered and
378  * that the handles are correctly 
379  */
380
381 /* This function recalculates the handles of an F-Curve 
382  * If the BezTriples have been rearranged, sort them first before using this.
383  */
384 void calchandles_fcurve (FCurve *fcu)
385 {
386         BezTriple *bezt, *prev, *next;
387         int a= fcu->totvert;
388
389         /* Error checking:
390          *      - need at least two points
391          *      - need bezier keys
392          *      - only bezier-interpolation has handles (for now)
393          */
394         if (ELEM(NULL, fcu, fcu->bezt) || (a < 2) /*|| ELEM(fcu->ipo, BEZT_IPO_CONST, BEZT_IPO_LIN)*/) 
395                 return;
396         
397         /* get initial pointers */
398         bezt= fcu->bezt;
399         prev= NULL;
400         next= (bezt + 1);
401         
402         /* loop over all beztriples, adjusting handles */
403         while (a--) {
404                 /* clamp timing of handles to be on either side of beztriple */
405                 if (bezt->vec[0][0] > bezt->vec[1][0]) bezt->vec[0][0]= bezt->vec[1][0];
406                 if (bezt->vec[2][0] < bezt->vec[1][0]) bezt->vec[2][0]= bezt->vec[1][0];
407                 
408                 /* calculate auto-handles */
409                 if (fcu->flag & FCURVE_AUTO_HANDLES) 
410                         calchandleNurb(bezt, prev, next, 2);    /* 2==special autohandle && keep extrema horizontal */
411                 else
412                         calchandleNurb(bezt, prev, next, 1);    /* 1==special autohandle */
413                 
414                 /* for automatic ease in and out */
415                 if ((bezt->h1==HD_AUTO) && (bezt->h2==HD_AUTO)) {
416                         /* only do this on first or last beztriple */
417                         if ((a == 0) || (a == fcu->totvert-1)) {
418                                 /* set both handles to have same horizontal value as keyframe */
419                                 if (fcu->extend == FCURVE_EXTRAPOLATE_CONSTANT) {
420                                         bezt->vec[0][1]= bezt->vec[2][1]= bezt->vec[1][1];
421                                 }
422                         }
423                 }
424                 
425                 /* advance pointers for next iteration */
426                 prev= bezt;
427                 if (a == 1) next= NULL;
428                 else next++;
429                 bezt++;
430         }
431 }
432
433 /* Use when F-Curve with handles has changed
434  * It treats all BezTriples with the following rules:
435  *  - PHASE 1: do types have to be altered?
436  *              -> Auto handles: become aligned when selection status is NOT(000 || 111)
437  *              -> Vector handles: become 'nothing' when (one half selected AND other not)
438  *  - PHASE 2: recalculate handles
439 */
440 void testhandles_fcurve (FCurve *fcu)
441 {
442         BezTriple *bezt;
443         unsigned int a;
444
445         /* only beztriples have handles (bpoints don't though) */
446         if ELEM(NULL, fcu, fcu->bezt)
447                 return;
448         
449         /* loop over beztriples */
450         for (a=0, bezt=fcu->bezt; a < fcu->totvert; a++, bezt++) {
451                 short flag= 0;
452                 
453                 /* flag is initialised as selection status
454                  * of beztriple control-points (labelled 0,1,2)
455                  */
456                 if (bezt->f1 & SELECT) flag |= (1<<0); // == 1
457                 if (bezt->f2 & SELECT) flag |= (1<<1); // == 2
458                 if (bezt->f3 & SELECT) flag |= (1<<2); // == 4
459                 
460                 /* one or two handles selected only */
461                 if (ELEM(flag, 0, 7)==0) {
462                         /* auto handles become aligned */
463                         if (bezt->h1==HD_AUTO)
464                                 bezt->h1= HD_ALIGN;
465                         if (bezt->h2==HD_AUTO)
466                                 bezt->h2= HD_ALIGN;
467                         
468                         /* vector handles become 'free' when only one half selected */
469                         if (bezt->h1==HD_VECT) {
470                                 /* only left half (1 or 2 or 1+2) */
471                                 if (flag < 4) 
472                                         bezt->h1= 0;
473                         }
474                         if (bezt->h2==HD_VECT) {
475                                 /* only right half (4 or 2+4) */
476                                 if (flag > 3) 
477                                         bezt->h2= 0;
478                         }
479                 }
480         }
481
482         /* recalculate handles */
483         calchandles_fcurve(fcu);
484 }
485
486 /* This function sorts BezTriples so that they are arranged in chronological order,
487  * as tools working on F-Curves expect that the BezTriples are in order.
488  */
489 void sort_time_fcurve (FCurve *fcu)
490 {
491         short ok= 1;
492         
493         /* keep adjusting order of beztriples until nothing moves (bubble-sort) */
494         while (ok) {
495                 ok= 0;
496                 
497                 /* currently, will only be needed when there are beztriples */
498                 if (fcu->bezt) {
499                         BezTriple *bezt;
500                         unsigned int a;
501                         
502                         /* loop over ALL points to adjust position in array and recalculate handles */
503                         for (a=0, bezt=fcu->bezt; a < fcu->totvert; a++, bezt++) {
504                                 /* check if thee's a next beztriple which we could try to swap with current */
505                                 if (a < (fcu->totvert-1)) {
506                                         /* swap if one is after the other (and indicate that order has changed) */
507                                         if (bezt->vec[1][0] > (bezt+1)->vec[1][0]) {
508                                                 SWAP(BezTriple, *bezt, *(bezt+1));
509                                                 ok= 1;
510                                         }
511                                         
512                                         /* if either one of both of the points exceeds crosses over the keyframe time... */
513                                         if ( (bezt->vec[0][0] > bezt->vec[1][0]) && (bezt->vec[2][0] < bezt->vec[1][0]) ) {
514                                                 /* swap handles if they have switched sides for some reason */
515                                                 SWAP(float, bezt->vec[0][0], bezt->vec[2][0]);
516                                                 SWAP(float, bezt->vec[0][1], bezt->vec[2][1]);
517                                         }
518                                         else {
519                                                 /* clamp handles */
520                                                 if (bezt->vec[0][0] > bezt->vec[1][0]) 
521                                                         bezt->vec[0][0]= bezt->vec[1][0];
522                                                 if (bezt->vec[2][0] < bezt->vec[1][0]) 
523                                                         bezt->vec[2][0]= bezt->vec[1][0];
524                                         }
525                                 }
526                         }
527                 }
528         }
529 }
530
531 /* This function tests if any BezTriples are out of order, thus requiring a sort */
532 short test_time_fcurve (FCurve *fcu)
533 {
534         unsigned int a;
535         
536         /* sanity checks */
537         if (fcu == NULL)
538                 return 0;
539         
540         /* currently, only need to test beztriples */
541         if (fcu->bezt) {
542                 BezTriple *bezt;
543                 
544                 /* loop through all BezTriples, stopping when one exceeds the one after it */
545                 for (a=0, bezt= fcu->bezt; a < (fcu->totvert - 1); a++, bezt++) {
546                         if (bezt->vec[1][0] > (bezt+1)->vec[1][0])
547                                 return 1;
548                 }
549         }
550         else if (fcu->fpt) {
551                 FPoint *fpt;
552                 
553                 /* loop through all FPoints, stopping when one exceeds the one after it */
554                 for (a=0, fpt= fcu->fpt; a < (fcu->totvert - 1); a++, fpt++) {
555                         if (fpt->vec[0] > (fpt+1)->vec[0])
556                                 return 1;
557                 }
558         }
559         
560         /* none need any swapping */
561         return 0;
562 }
563
564 /* ***************************** Drivers ********************************* */
565
566 /* Driver API --------------------------------- */
567
568 /* This frees the driver target itself */
569 void driver_free_target (ChannelDriver *driver, DriverTarget *dtar)
570 {
571         /* sanity checks */
572         if (dtar == NULL)
573                 return;
574                 
575         /* free target vars */
576         if (dtar->rna_path)
577                 MEM_freeN(dtar->rna_path);
578         
579         /* remove the target from the driver */
580         if (driver)
581                 BLI_freelinkN(&driver->targets, dtar);
582         else
583                 MEM_freeN(dtar);
584 }
585
586 /* Add a new driver target variable */
587 DriverTarget *driver_add_new_target (ChannelDriver *driver)
588 {
589         DriverTarget *dtar;
590         
591         /* sanity checks */
592         if (driver == NULL)
593                 return NULL;
594                 
595         /* make a new target */
596         dtar= MEM_callocN(sizeof(DriverTarget), "DriverTarget");
597         BLI_addtail(&driver->targets, dtar);
598         
599         /* give the target a 'unique' name */
600         strcpy(dtar->name, "var");
601         BLI_uniquename(&driver->targets, dtar, "var", '_', offsetof(DriverTarget, name), 64);
602         
603         /* return the target */
604         return dtar;
605 }
606
607 /* This frees the driver itself */
608 void fcurve_free_driver(FCurve *fcu)
609 {
610         ChannelDriver *driver;
611         DriverTarget *dtar, *dtarn;
612         
613         /* sanity checks */
614         if ELEM(NULL, fcu, fcu->driver)
615                 return;
616         driver= fcu->driver;
617         
618         /* free driver targets */
619         for (dtar= driver->targets.first; dtar; dtar= dtarn) {
620                 dtarn= dtar->next;
621                 driver_free_target(driver, dtar);
622         }
623         
624         /* free driver itself, then set F-Curve's point to this to NULL (as the curve may still be used) */
625         MEM_freeN(driver);
626         fcu->driver= NULL;
627 }
628
629 /* This makes a copy of the given driver */
630 ChannelDriver *fcurve_copy_driver (ChannelDriver *driver)
631 {
632         ChannelDriver *ndriver;
633         DriverTarget *dtar;
634         
635         /* sanity checks */
636         if (driver == NULL)
637                 return NULL;
638                 
639         /* copy all data */
640         ndriver= MEM_dupallocN(driver);
641         
642         /* copy targets */
643         ndriver->targets.first= ndriver->targets.last= NULL;
644         BLI_duplicatelist(&ndriver->targets, &driver->targets);
645         
646         for (dtar= ndriver->targets.first; dtar; dtar= dtar->next) {
647                 /* make a copy of target's rna path if available */
648                 if (dtar->rna_path)
649                         dtar->rna_path = MEM_dupallocN(dtar->rna_path);
650         }
651         
652         /* return the new driver */
653         return ndriver;
654 }
655
656 /* Driver Evaluation -------------------------- */
657
658 /* Helper function to obtain a value using RNA from the specified source (for evaluating drivers) */
659 float driver_get_target_value (ChannelDriver *driver, DriverTarget *dtar)
660 {
661         PointerRNA id_ptr, ptr;
662         PropertyRNA *prop;
663         ID *id;
664         char *path;
665         int index;
666         float value= 0.0f;
667         
668         /* sanity check */
669         if ELEM(NULL, driver, dtar)
670                 return 0.0f;
671         
672         /* get RNA-pointer for the ID-block given in target */
673         RNA_id_pointer_create(dtar->id, &id_ptr);
674         id= dtar->id;
675         path= dtar->rna_path;
676         index= dtar->array_index;
677         
678         /* error check for missing pointer... */
679         if (id == NULL) {
680                 printf("Error: driver doesn't have any valid target to use \n");
681                 if (G.f & G_DEBUG) printf("\tpath = %s [%d] \n", path, index);
682                 driver->flag |= DRIVER_FLAG_INVALID;
683                 return 0.0f;
684         }
685         
686         /* get property to read from, and get value as appropriate */
687         if (RNA_path_resolve(&id_ptr, path, &ptr, &prop)) {
688                 switch (RNA_property_type(prop)) {
689                         case PROP_BOOLEAN:
690                                 if (RNA_property_array_length(prop))
691                                         value= (float)RNA_property_boolean_get_index(&ptr, prop, index);
692                                 else
693                                         value= (float)RNA_property_boolean_get(&ptr, prop);
694                                 break;
695                         case PROP_INT:
696                                 if (RNA_property_array_length(prop))
697                                         value= (float)RNA_property_int_get_index(&ptr, prop, index);
698                                 else
699                                         value= (float)RNA_property_int_get(&ptr, prop);
700                                 break;
701                         case PROP_FLOAT:
702                                 if (RNA_property_array_length(prop))
703                                         value= RNA_property_float_get_index(&ptr, prop, index);
704                                 else
705                                         value= RNA_property_float_get(&ptr, prop);
706                                 break;
707                         case PROP_ENUM:
708                                 value= (float)RNA_property_enum_get(&ptr, prop);
709                                 break;
710                         default:
711                                 break;
712                 }
713         }
714         
715         return value;
716 }
717
718 /* Get two PoseChannels from the targets of the given Driver */
719 static void driver_get_target_pchans2 (ChannelDriver *driver, bPoseChannel **pchan1, bPoseChannel **pchan2)
720 {
721         DriverTarget *dtar;
722         short i = 0;
723         
724         /* before doing anything */
725         *pchan1= NULL;
726         *pchan2= NULL;
727         
728         /* only take the first two targets */
729         for (dtar= driver->targets.first; (dtar) && (i < 2); dtar=dtar->next, i++) {
730                 PointerRNA id_ptr, ptr;
731                 PropertyRNA *prop;
732                 
733                 /* get RNA-pointer for the ID-block given in target */
734                 if (dtar->id)
735                         RNA_id_pointer_create(dtar->id, &id_ptr);
736                 else
737                         continue;
738                 
739                 /* resolve path so that we have pointer to the right posechannel */
740                 if (RNA_path_resolve(&id_ptr, dtar->rna_path, &ptr, &prop)) {
741                         /* is pointer valid (i.e. pointing to an actual posechannel */
742                         if ((ptr.type == &RNA_PoseChannel) && (ptr.data)) {
743                                 /* first or second target? */
744                                 if (i)
745                                         *pchan1= ptr.data;
746                                 else
747                                         *pchan2= ptr.data;
748                         }
749                 }
750         }
751 }
752
753 /* Evaluate an Channel-Driver to get a 'time' value to use instead of "evaltime"
754  *      - "evaltime" is the frame at which F-Curve is being evaluated
755  *      - has to return a float value 
756  */
757 static float evaluate_driver (ChannelDriver *driver, float evaltime)
758 {
759         DriverTarget *dtar;
760         
761         /* check if driver can be evaluated */
762         if (driver->flag & DRIVER_FLAG_INVALID)
763                 return 0.0f;
764         
765         // TODO: the flags for individual targets need to be used too for more fine-grained support...
766         switch (driver->type) {
767                 case DRIVER_TYPE_AVERAGE: /* average values of driver targets */
768                 {
769                         /* check how many targets there are first (i.e. just one?) */
770                         if (driver->targets.first == driver->targets.last) {
771                                 /* just one target, so just use that */
772                                 dtar= driver->targets.first;
773                                 return driver_get_target_value(driver, dtar);
774                         }
775                         else {
776                                 /* more than one target, so average the values of the targets */
777                                 int tot = 0;
778                                 float value = 0.0f;
779                                 
780                                 /* loop through targets, adding (hopefully we don't get any overflow!) */
781                                 for (dtar= driver->targets.first; dtar; dtar=dtar->next) {
782                                         value += driver_get_target_value(driver, dtar); 
783                                         tot++;
784                                 }
785                                 
786                                 /* return the average of these */
787                                 return (value / (float)tot);
788                         }
789                 }
790                         break;
791                 
792                 case DRIVER_TYPE_PYTHON: /* expression */
793                 {
794 #ifndef DISABLE_PYTHON
795                         /* check for empty or invalid expression */
796                         if ( (driver->expression[0] == '\0') ||
797                                  (driver->flag & DRIVER_FLAG_INVALID) )
798                         {
799                                 return 0.0f;
800                         }
801                         
802                         /* this evaluates the expression using Python,and returns its result:
803                          *      - on errors it reports, then returns 0.0f
804                          */
805                         return BPY_pydriver_eval(driver);
806 #endif /* DISABLE_PYTHON*/
807                 }
808                         break;
809
810                 
811                 case DRIVER_TYPE_ROTDIFF: /* difference of rotations of 2 bones (should ideally be in same armature) */
812                 {
813                         bPoseChannel *pchan, *pchan2;
814                         float q1[4], q2[4], quat[4], angle;
815                         
816                         /* get pose channels, and check if we've got two */
817                         driver_get_target_pchans2(driver, &pchan, &pchan2);
818                         if (ELEM(NULL, pchan, pchan2)) {
819                                 /* disable this driver, since it doesn't work correctly... */
820                                 driver->flag |= DRIVER_FLAG_INVALID;
821                                 
822                                 /* check what the error was */
823                                 if ((pchan == NULL) && (pchan2 == NULL))
824                                         printf("Driver Evaluation Error: Rotational difference failed - first 2 targets invalid \n");
825                                 else if (pchan == NULL)
826                                         printf("Driver Evaluation Error: Rotational difference failed - first target not valid PoseChannel \n");
827                                 else if (pchan2 == NULL)
828                                         printf("Driver Evaluation Error: Rotational difference failed - second target not valid PoseChannel \n");
829                                         
830                                 /* stop here... */
831                                 return 0.0f;
832                         }                       
833                         
834                         /* use the final posed locations */
835                         Mat4ToQuat(pchan->pose_mat, q1);
836                         Mat4ToQuat(pchan2->pose_mat, q2);
837                         
838                         QuatInv(q1);
839                         QuatMul(quat, q1, q2);
840                         angle = 2.0f * (saacos(quat[0]));
841                         angle= ABS(angle);
842                         
843                         return (angle > M_PI) ? (float)((2.0f * M_PI) - angle) : (float)(angle);
844                 }
845                         break;
846                 
847                 default:
848                 {
849                         /* special 'hack' - just use stored value 
850                          *      This is currently used as the mechanism which allows animated settings to be able
851                          *      to be changed via the UI.
852                          */
853                         return driver->curval;
854                 }
855         }
856         
857         /* return 0.0f, as couldn't find relevant data to use */
858         return 0.0f;
859 }
860
861 /* ***************************** Curve Calculations ********************************* */
862
863 /* The total length of the handles is not allowed to be more
864  * than the horizontal distance between (v1-v4).
865  * This is to prevent curve loops.
866 */
867 void correct_bezpart (float *v1, float *v2, float *v3, float *v4)
868 {
869         float h1[2], h2[2], len1, len2, len, fac;
870         
871         /* calculate handle deltas */
872         h1[0]= v1[0] - v2[0];
873         h1[1]= v1[1] - v2[1];
874         
875         h2[0]= v4[0] - v3[0];
876         h2[1]= v4[1] - v3[1];
877         
878         /* calculate distances: 
879          *      - len   = span of time between keyframes 
880          *      - len1  = length of handle of start key
881          *      - len2  = length of handle of end key
882          */
883         len= v4[0]- v1[0];
884         len1= (float)fabs(h1[0]);
885         len2= (float)fabs(h2[0]);
886         
887         /* if the handles have no length, no need to do any corrections */
888         if ((len1+len2) == 0.0f) 
889                 return;
890                 
891         /* the two handles cross over each other, so force them
892          * apart using the proportion they overlap 
893          */
894         if ((len1+len2) > len) {
895                 fac= len / (len1+len2);
896                 
897                 v2[0]= (v1[0] - fac*h1[0]);
898                 v2[1]= (v1[1] - fac*h1[1]);
899                 
900                 v3[0]= (v4[0] - fac*h2[0]);
901                 v3[1]= (v4[1] - fac*h2[1]);
902         }
903 }
904
905 /* find root ('zero') */
906 int findzero (float x, float q0, float q1, float q2, float q3, float *o)
907 {
908         double c0, c1, c2, c3, a, b, c, p, q, d, t, phi;
909         int nr= 0;
910
911         c0= q0 - x;
912         c1= 3.0 * (q1 - q0);
913         c2= 3.0 * (q0 - 2.0*q1 + q2);
914         c3= q3 - q0 + 3.0 * (q1 - q2);
915         
916         if (c3 != 0.0) {
917                 a= c2/c3;
918                 b= c1/c3;
919                 c= c0/c3;
920                 a= a/3;
921                 
922                 p= b/3 - a*a;
923                 q= (2*a*a*a - a*b + c) / 2;
924                 d= q*q + p*p*p;
925                 
926                 if (d > 0.0) {
927                         t= sqrt(d);
928                         o[0]= (float)(Sqrt3d(-q+t) + Sqrt3d(-q-t) - a);
929                         
930                         if ((o[0] >= SMALL) && (o[0] <= 1.000001)) return 1;
931                         else return 0;
932                 }
933                 else if (d == 0.0) {
934                         t= Sqrt3d(-q);
935                         o[0]= (float)(2*t - a);
936                         
937                         if ((o[0] >= SMALL) && (o[0] <= 1.000001)) nr++;
938                         o[nr]= (float)(-t-a);
939                         
940                         if ((o[nr] >= SMALL) && (o[nr] <= 1.000001)) return nr+1;
941                         else return nr;
942                 }
943                 else {
944                         phi= acos(-q / sqrt(-(p*p*p)));
945                         t= sqrt(-p);
946                         p= cos(phi/3);
947                         q= sqrt(3 - 3*p*p);
948                         o[0]= (float)(2*t*p - a);
949                         
950                         if ((o[0] >= SMALL) && (o[0] <= 1.000001)) nr++;
951                         o[nr]= (float)(-t * (p + q) - a);
952                         
953                         if ((o[nr] >= SMALL) && (o[nr] <= 1.000001)) nr++;
954                         o[nr]= (float)(-t * (p - q) - a);
955                         
956                         if ((o[nr] >= SMALL) && (o[nr] <= 1.000001)) return nr+1;
957                         else return nr;
958                 }
959         }
960         else {
961                 a=c2;
962                 b=c1;
963                 c=c0;
964                 
965                 if (a != 0.0) {
966                         // discriminant
967                         p= b*b - 4*a*c;
968                         
969                         if (p > 0) {
970                                 p= sqrt(p);
971                                 o[0]= (float)((-b-p) / (2 * a));
972                                 
973                                 if ((o[0] >= SMALL) && (o[0] <= 1.000001)) nr++;
974                                 o[nr]= (float)((-b+p)/(2*a));
975                                 
976                                 if ((o[nr] >= SMALL) && (o[nr] <= 1.000001)) return nr+1;
977                                 else return nr;
978                         }
979                         else if (p == 0) {
980                                 o[0]= (float)(-b / (2 * a));
981                                 if ((o[0] >= SMALL) && (o[0] <= 1.000001)) return 1;
982                                 else return 0;
983                         }
984                 }
985                 else if (b != 0.0) {
986                         o[0]= (float)(-c/b);
987                         
988                         if ((o[0] >= SMALL) && (o[0] <= 1.000001)) return 1;
989                         else return 0;
990                 }
991                 else if (c == 0.0) {
992                         o[0]= 0.0;
993                         return 1;
994                 }
995                 
996                 return 0;       
997         }
998 }
999
1000 void berekeny (float f1, float f2, float f3, float f4, float *o, int b)
1001 {
1002         float t, c0, c1, c2, c3;
1003         int a;
1004
1005         c0= f1;
1006         c1= 3.0f * (f2 - f1);
1007         c2= 3.0f * (f1 - 2.0f*f2 + f3);
1008         c3= f4 - f1 + 3.0f * (f2 - f3);
1009         
1010         for (a=0; a < b; a++) {
1011                 t= o[a];
1012                 o[a]= c0 + t*c1 + t*t*c2 + t*t*t*c3;
1013         }
1014 }
1015
1016 void berekenx (float *f, float *o, int b)
1017 {
1018         float t, c0, c1, c2, c3;
1019         int a;
1020
1021         c0= f[0];
1022         c1= 3.0f * (f[3] - f[0]);
1023         c2= 3.0f * (f[0] - 2.0f*f[3] + f[6]);
1024         c3= f[9] - f[0] + 3.0f * (f[3] - f[6]);
1025         
1026         for (a=0; a < b; a++) {
1027                 t= o[a];
1028                 o[a]= c0 + t*c1 + t*t*c2 + t*t*t*c3;
1029         }
1030 }
1031
1032
1033 /* -------------------------- */
1034
1035 /* Calculate F-Curve value for 'evaltime' using BezTriple keyframes */
1036 static float fcurve_eval_keyframes (FCurve *fcu, BezTriple *bezts, float evaltime)
1037 {
1038         BezTriple *bezt, *prevbezt, *lastbezt;
1039         float v1[2], v2[2], v3[2], v4[2], opl[32], dx, fac;
1040         unsigned int a;
1041         int b;
1042         float cvalue = 0.0f;
1043         
1044         /* get pointers */
1045         a= fcu->totvert-1;
1046         prevbezt= bezts;
1047         bezt= prevbezt+1;
1048         lastbezt= prevbezt + a;
1049         
1050         /* evaluation time at or past endpoints? */
1051         if (prevbezt->vec[1][0] >= evaltime) {
1052                 /* before or on first keyframe */
1053                 if ((fcu->extend == FCURVE_EXTRAPOLATE_LINEAR) && (prevbezt->ipo != BEZT_IPO_CONST)) {
1054                         /* linear or bezier interpolation */
1055                         if (prevbezt->ipo==BEZT_IPO_LIN) {
1056                                 /* Use the next center point instead of our own handle for
1057                                  * linear interpolated extrapolate 
1058                                  */
1059                                 if (fcu->totvert == 1) 
1060                                         cvalue= prevbezt->vec[1][1];
1061                                 else {
1062                                         bezt = prevbezt+1;
1063                                         dx= prevbezt->vec[1][0] - evaltime;
1064                                         fac= bezt->vec[1][0] - prevbezt->vec[1][0];
1065                                         
1066                                         /* prevent division by zero */
1067                                         if (fac) {
1068                                                 fac= (bezt->vec[1][1] - prevbezt->vec[1][1]) / fac;
1069                                                 cvalue= prevbezt->vec[1][1] - (fac * dx);
1070                                         }
1071                                         else 
1072                                                 cvalue= prevbezt->vec[1][1];
1073                                 }
1074                         } 
1075                         else {
1076                                 /* Use the first handle (earlier) of first BezTriple to calculate the
1077                                  * gradient and thus the value of the curve at evaltime
1078                                  */
1079                                 dx= prevbezt->vec[1][0] - evaltime;
1080                                 fac= prevbezt->vec[1][0] - prevbezt->vec[0][0];
1081                                 
1082                                 /* prevent division by zero */
1083                                 if (fac) {
1084                                         fac= (prevbezt->vec[1][1] - prevbezt->vec[0][1]) / fac;
1085                                         cvalue= prevbezt->vec[1][1] - (fac * dx);
1086                                 }
1087                                 else 
1088                                         cvalue= prevbezt->vec[1][1];
1089                         }
1090                 }
1091                 else {
1092                         /* constant (BEZT_IPO_HORIZ) extrapolation or constant interpolation, 
1093                          * so just extend first keyframe's value 
1094                          */
1095                         cvalue= prevbezt->vec[1][1];
1096                 }
1097         }
1098         else if (lastbezt->vec[1][0] <= evaltime) {
1099                 /* after or on last keyframe */
1100                 if ((fcu->extend == FCURVE_EXTRAPOLATE_LINEAR) && (lastbezt->ipo != BEZT_IPO_CONST)) {
1101                         /* linear or bezier interpolation */
1102                         if (lastbezt->ipo==BEZT_IPO_LIN) {
1103                                 /* Use the next center point instead of our own handle for
1104                                  * linear interpolated extrapolate 
1105                                  */
1106                                 if (fcu->totvert == 1) 
1107                                         cvalue= lastbezt->vec[1][1];
1108                                 else {
1109                                         prevbezt = lastbezt - 1;
1110                                         dx= evaltime - lastbezt->vec[1][0];
1111                                         fac= lastbezt->vec[1][0] - prevbezt->vec[1][0];
1112                                         
1113                                         /* prevent division by zero */
1114                                         if (fac) {
1115                                                 fac= (lastbezt->vec[1][1] - prevbezt->vec[1][1]) / fac;
1116                                                 cvalue= lastbezt->vec[1][1] + (fac * dx);
1117                                         }
1118                                         else 
1119                                                 cvalue= lastbezt->vec[1][1];
1120                                 }
1121                         } 
1122                         else {
1123                                 /* Use the gradient of the second handle (later) of last BezTriple to calculate the
1124                                  * gradient and thus the value of the curve at evaltime
1125                                  */
1126                                 dx= evaltime - lastbezt->vec[1][0];
1127                                 fac= lastbezt->vec[2][0] - lastbezt->vec[1][0];
1128                                 
1129                                 /* prevent division by zero */
1130                                 if (fac) {
1131                                         fac= (lastbezt->vec[2][1] - lastbezt->vec[1][1]) / fac;
1132                                         cvalue= lastbezt->vec[1][1] + (fac * dx);
1133                                 }
1134                                 else 
1135                                         cvalue= lastbezt->vec[1][1];
1136                         }
1137                 }
1138                 else {
1139                         /* constant (BEZT_IPO_HORIZ) extrapolation or constant interpolation, 
1140                          * so just extend last keyframe's value 
1141                          */
1142                         cvalue= lastbezt->vec[1][1];
1143                 }
1144         }
1145         else {
1146                 /* evaltime occurs somewhere in the middle of the curve */
1147                 for (a=0; prevbezt && bezt && (a < fcu->totvert-1); a++, prevbezt=bezt, bezt++) {  
1148                         /* evaltime occurs within the interval defined by these two keyframes */
1149                         if ((prevbezt->vec[1][0] <= evaltime) && (bezt->vec[1][0] >= evaltime)) {
1150                                 /* value depends on interpolation mode */
1151                                 if (prevbezt->ipo == BEZT_IPO_CONST) {
1152                                         /* constant (evaltime not relevant, so no interpolation needed) */
1153                                         cvalue= prevbezt->vec[1][1];
1154                                 }
1155                                 else if (prevbezt->ipo == BEZT_IPO_LIN) {
1156                                         /* linear - interpolate between values of the two keyframes */
1157                                         fac= bezt->vec[1][0] - prevbezt->vec[1][0];
1158                                         
1159                                         /* prevent division by zero */
1160                                         if (fac) {
1161                                                 fac= (evaltime - prevbezt->vec[1][0]) / fac;
1162                                                 cvalue= prevbezt->vec[1][1] + (fac * (bezt->vec[1][1] - prevbezt->vec[1][1]));
1163                                         }
1164                                         else
1165                                                 cvalue= prevbezt->vec[1][1];
1166                                 }
1167                                 else {
1168                                         /* bezier interpolation */
1169                                                 /* v1,v2 are the first keyframe and its 2nd handle */
1170                                         v1[0]= prevbezt->vec[1][0];
1171                                         v1[1]= prevbezt->vec[1][1];
1172                                         v2[0]= prevbezt->vec[2][0];
1173                                         v2[1]= prevbezt->vec[2][1];
1174                                                 /* v3,v4 are the last keyframe's 1st handle + the last keyframe */
1175                                         v3[0]= bezt->vec[0][0];
1176                                         v3[1]= bezt->vec[0][1];
1177                                         v4[0]= bezt->vec[1][0];
1178                                         v4[1]= bezt->vec[1][1];
1179                                         
1180                                         /* adjust handles so that they don't overlap (forming a loop) */
1181                                         correct_bezpart(v1, v2, v3, v4);
1182                                         
1183                                         /* try to get a value for this position - if failure, try another set of points */
1184                                         b= findzero(evaltime, v1[0], v2[0], v3[0], v4[0], opl);
1185                                         if (b) {
1186                                                 berekeny(v1[1], v2[1], v3[1], v4[1], opl, 1);
1187                                                 cvalue= opl[0];
1188                                                 break;
1189                                         }
1190                                 }
1191                         }
1192                 }
1193         }
1194         
1195         /* return value */
1196         return cvalue;
1197 }
1198
1199 /* Calculate F-Curve value for 'evaltime' using FPoint samples */
1200 static float fcurve_eval_samples (FCurve *fcu, FPoint *fpts, float evaltime)
1201 {
1202         FPoint *prevfpt, *lastfpt, *fpt;
1203         float cvalue= 0.0f;
1204         
1205         /* get pointers */
1206         prevfpt= fpts;
1207         lastfpt= prevfpt + fcu->totvert-1;
1208         
1209         /* evaluation time at or past endpoints? */
1210         if (prevfpt->vec[0] >= evaltime) {
1211                 /* before or on first sample, so just extend value */
1212                 cvalue= prevfpt->vec[1];
1213         }
1214         else if (lastfpt->vec[0] <= evaltime) {
1215                 /* after or on last sample, so just extend value */
1216                 cvalue= lastfpt->vec[1];
1217         }
1218         else {
1219                 /* find the one on the right frame (assume that these are spaced on 1-frame intervals) */
1220                 fpt= prevfpt + (int)(evaltime - prevfpt->vec[0]);
1221                 cvalue= fpt->vec[1];
1222         }
1223         
1224         /* return value */
1225         return cvalue;
1226 }
1227
1228 /* ******************************** F-Curve Modifiers ********************************* */
1229
1230 /* Template --------------------------- */
1231
1232 /* Each modifier defines a set of functions, which will be called at the appropriate
1233  * times. In addition to this, each modifier should have a type-info struct, where
1234  * its functions are attached for use. 
1235  */
1236  
1237 /* Template for type-info data:
1238  *      - make a copy of this when creating new modifiers, and just change the functions
1239  *        pointed to as necessary
1240  *      - although the naming of functions doesn't matter, it would help for code
1241  *        readability, to follow the same naming convention as is presented here
1242  *      - any functions that a constraint doesn't need to define, don't define
1243  *        for such cases, just use NULL 
1244  *      - these should be defined after all the functions have been defined, so that
1245  *        forward-definitions/prototypes don't need to be used!
1246  *      - keep this copy #if-def'd so that future constraints can get based off this
1247  */
1248 #if 0
1249 static FModifierTypeInfo FMI_MODNAME = {
1250         FMODIFIER_TYPE_MODNAME, /* type */
1251         sizeof(FMod_ModName), /* size */
1252         FMI_TYPE_SOME_ACTION, /* action type */
1253         FMI_REQUIRES_SOME_REQUIREMENT, /* requirements */
1254         "Modifier Name", /* name */
1255         "FMod_ModName", /* struct name */
1256         fcm_modname_free, /* free data */
1257         fcm_modname_relink, /* relink data */
1258         fcm_modname_copy, /* copy data */
1259         fcm_modname_new_data, /* new data */
1260         fcm_modname_verify, /* verify */
1261         fcm_modname_time, /* evaluate time */
1262         fcm_modname_evaluate /* evaluate */
1263 };
1264 #endif
1265
1266 /* Generator F-Curve Modifier --------------------------- */
1267
1268 /* Generators available:
1269  *      1) simple polynomial generator:
1270  *              - Exanded form - (y = C[0]*(x^(n)) + C[1]*(x^(n-1)) + ... + C[n])  
1271  *              - Factorised form - (y = (C[0][0]*x + C[0][1]) * (C[1][0]*x + C[1][1]) * ... * (C[n][0]*x + C[n][1]))
1272  *      2) simple builin 'functions':
1273  *              of the form (y = C[0] * fn( C[1]*x + C[2] ) + C[3])
1274  *         where fn() can be any one of:
1275  *              sin, cos, tan, ln, sqrt
1276  *      3) expression...
1277  */
1278
1279 static void fcm_generator_free (FModifier *fcm)
1280 {
1281         FMod_Generator *data= (FMod_Generator *)fcm->data;
1282         
1283         /* free polynomial coefficients array */
1284         if (data->coefficients)
1285                 MEM_freeN(data->coefficients);
1286 }
1287
1288 static void fcm_generator_copy (FModifier *fcm, FModifier *src)
1289 {
1290         FMod_Generator *gen= (FMod_Generator *)fcm->data;
1291         FMod_Generator *ogen= (FMod_Generator *)src->data;
1292         
1293         /* copy coefficients array? */
1294         if (ogen->coefficients)
1295                 gen->coefficients= MEM_dupallocN(ogen->coefficients);
1296 }
1297
1298 static void fcm_generator_new_data (void *mdata)
1299 {
1300         FMod_Generator *data= (FMod_Generator *)mdata;
1301         float *cp;
1302         
1303         /* set default generator to be linear 0-1 (gradient = 1, y-offset = 0) */
1304         data->poly_order= 1;
1305         data->arraysize= 2;
1306         cp= data->coefficients= MEM_callocN(sizeof(float)*2, "FMod_Generator_Coefs");
1307         cp[0] = 0; // y-offset 
1308         cp[1] = 1; // gradient
1309 }
1310
1311 static void fcm_generator_verify (FModifier *fcm)
1312 {
1313         FMod_Generator *data= (FMod_Generator *)fcm->data;
1314         
1315         /* requirements depend on mode */
1316         switch (data->mode) {
1317                 case FCM_GENERATOR_POLYNOMIAL: /* expanded polynomial expression */
1318                 {
1319                         /* arraysize needs to be order+1, so resize if not */
1320                         if (data->arraysize != (data->poly_order+1)) {
1321                                 float *nc;
1322                                 
1323                                 /* make new coefficients array, and copy over as much data as can fit */
1324                                 nc= MEM_callocN(sizeof(float)*(data->poly_order+1), "FMod_Generator_Coefs");
1325                                 
1326                                 if (data->coefficients) {
1327                                         if (data->arraysize > (data->poly_order+1))
1328                                                 memcpy(nc, data->coefficients, sizeof(float)*(data->poly_order+1));
1329                                         else
1330                                                 memcpy(nc, data->coefficients, sizeof(float)*data->arraysize);
1331                                                 
1332                                         /* free the old data */
1333                                         MEM_freeN(data->coefficients);
1334                                 }       
1335                                 
1336                                 /* set the new data */
1337                                 data->coefficients= nc;
1338                                 data->arraysize= data->poly_order+1;
1339                         }
1340                 }
1341                         break;
1342                 
1343                 case FCM_GENERATOR_POLYNOMIAL_FACTORISED: /* expanded polynomial expression */
1344                 {
1345                         /* arraysize needs to be 2*order, so resize if not */
1346                         if (data->arraysize != (data->poly_order * 2)) {
1347                                 float *nc;
1348                                 
1349                                 /* make new coefficients array, and copy over as much data as can fit */
1350                                 nc= MEM_callocN(sizeof(float)*(data->poly_order*2), "FMod_Generator_Coefs");
1351                                 
1352                                 if (data->coefficients) {
1353                                         if (data->arraysize > (data->poly_order * 2))
1354                                                 memcpy(nc, data->coefficients, sizeof(float)*(data->poly_order * 2));
1355                                         else
1356                                                 memcpy(nc, data->coefficients, sizeof(float)*data->arraysize);
1357                                                 
1358                                         /* free the old data */
1359                                         MEM_freeN(data->coefficients);
1360                                 }       
1361                                 
1362                                 /* set the new data */
1363                                 data->coefficients= nc;
1364                                 data->arraysize= data->poly_order * 2;
1365                         }
1366                 }
1367                         break;
1368                         
1369                 case FCM_GENERATOR_FUNCTION: /* builtin function */
1370                 {
1371                         /* arraysize needs to be 4*/
1372                         if (data->arraysize != 4) {
1373                                 float *nc;
1374                                 
1375                                 /* free the old data */
1376                                 if (data->coefficients)
1377                                         MEM_freeN(data->coefficients);
1378                                 
1379                                 /* make new coefficients array, and init using default values */
1380                                 nc= data->coefficients= MEM_callocN(sizeof(float)*4, "FMod_Generator_Coefs");
1381                                 data->arraysize= 4;
1382                                 
1383                                 nc[0]= 1.0f;
1384                                 nc[1]= 1.0f;
1385                                 nc[2]= 0.0f;
1386                                 nc[3]= 0.0f;
1387                         }
1388                 }
1389                         break;  
1390         }
1391 }
1392
1393 static void fcm_generator_evaluate (FCurve *fcu, FModifier *fcm, float *cvalue, float evaltime)
1394 {
1395         FMod_Generator *data= (FMod_Generator *)fcm->data;
1396         
1397         /* behaviour depends on mode 
1398          * NOTE: the data in its default state is fine too
1399          */
1400         switch (data->mode) {
1401                 case FCM_GENERATOR_POLYNOMIAL: /* expanded polynomial expression */
1402                 {
1403                         /* we overwrite cvalue with the sum of the polynomial */
1404                         float *powers = MEM_callocN(sizeof(float)*data->arraysize, "Poly Powers");
1405                         float value= 0.0f;
1406                         unsigned int i;
1407                         
1408                         /* for each x^n, precalculate value based on previous one first... this should be 
1409                          * faster that calling pow() for each entry
1410                          */
1411                         for (i=0; i < data->arraysize; i++) {
1412                                 /* first entry is x^0 = 1, otherwise, calculate based on previous */
1413                                 if (i)
1414                                         powers[i]= powers[i-1] * evaltime;
1415                                 else
1416                                         powers[0]= 1;
1417                         }
1418                         
1419                         /* for each coefficient, add to value, which we'll write to *cvalue in one go */
1420                         for (i=0; i < data->arraysize; i++)
1421                                 value += data->coefficients[i] * powers[i];
1422                         
1423                         /* only if something changed, write *cvalue in one go */
1424                         if (data->poly_order) {
1425                                 if (data->flag & FCM_GENERATOR_ADDITIVE)
1426                                         *cvalue += value;
1427                                 else
1428                                         *cvalue= value;
1429                         }
1430                                 
1431                         /* cleanup */
1432                         if (powers) 
1433                                 MEM_freeN(powers);
1434                 }
1435                         break;
1436                         
1437                 case FCM_GENERATOR_POLYNOMIAL_FACTORISED: /* factorised polynomial */
1438                 {
1439                         float value= 1.0f, *cp=NULL;
1440                         unsigned int i;
1441                         
1442                         /* for each coefficient pair, solve for that bracket before accumulating in value by multiplying */
1443                         for (cp=data->coefficients, i=0; (cp) && (i < data->poly_order); cp+=2, i++) 
1444                                 value *= (cp[0]*evaltime + cp[1]);
1445                                 
1446                         /* only if something changed, write *cvalue in one go */
1447                         if (data->poly_order) {
1448                                 if (data->flag & FCM_GENERATOR_ADDITIVE)
1449                                         *cvalue += value;
1450                                 else
1451                                         *cvalue= value;
1452                         }
1453                 }
1454                         break;
1455                         
1456                 case FCM_GENERATOR_FUNCTION: /* builtin function */
1457                 {
1458                         double arg= data->coefficients[1]*evaltime + data->coefficients[2];
1459                         double (*fn)(double v) = NULL;
1460                         
1461                         /* get function pointer to the func to use:
1462                          * WARNING: must perform special argument validation hereto guard against crashes  
1463                          */
1464                         switch (data->func_type)
1465                         {
1466                                 /* simple ones */                       
1467                                 case FCM_GENERATOR_FN_SIN: /* sine wave */
1468                                         fn= sin;
1469                                         break;
1470                                 case FCM_GENERATOR_FN_COS: /* cosine wave */
1471                                         fn= cos;
1472                                         break;
1473                                         
1474                                 /* validation required */
1475                                 case FCM_GENERATOR_FN_TAN: /* tangent wave */
1476                                 {
1477                                         /* check that argument is not on one of the discontinuities (i.e. 90deg, 270 deg, etc) */
1478                                         if IS_EQ(fmod((arg - M_PI_2), M_PI), 0.0) {
1479                                                 if ((data->flag & FCM_GENERATOR_ADDITIVE) == 0)
1480                                                         *cvalue = 0.0f; /* no value possible here */
1481                                         }
1482                                         else
1483                                                 fn= tan;
1484                                 }
1485                                         break;
1486                                 case FCM_GENERATOR_FN_LN: /* natural log */
1487                                 {
1488                                         /* check that value is greater than 1? */
1489                                         if (arg > 1.0f) {
1490                                                 fn= log;
1491                                         }
1492                                         else {
1493                                                 if ((data->flag & FCM_GENERATOR_ADDITIVE) == 0)
1494                                                         *cvalue = 0.0f; /* no value possible here */
1495                                         }
1496                                 }
1497                                         break;
1498                                 case FCM_GENERATOR_FN_SQRT: /* square root */
1499                                 {
1500                                         /* no negative numbers */
1501                                         if (arg > 0.0f) {
1502                                                 fn= sqrt;
1503                                         }
1504                                         else {
1505                                                 if ((data->flag & FCM_GENERATOR_ADDITIVE) == 0)
1506                                                         *cvalue = 0.0f; /* no value possible here */
1507                                         }
1508                                 }
1509                                         break;
1510                                         
1511                                 default:
1512                                         printf("Invalid Function-Generator for F-Modifier - %d \n", data->func_type);
1513                         }
1514                         
1515                         /* execute function callback to set value if appropriate */
1516                         if (fn) {
1517                                 float value= (float)(data->coefficients[0]*fn(arg) + data->coefficients[3]);
1518                                 
1519                                 if (data->flag & FCM_GENERATOR_ADDITIVE)
1520                                         *cvalue += value;
1521                                 else
1522                                         *cvalue= value;
1523                         }
1524                 }
1525                         break;
1526
1527 #ifndef DISABLE_PYTHON
1528                 case FCM_GENERATOR_EXPRESSION: /* py-expression */
1529                         // TODO...
1530                         break;
1531 #endif /* DISABLE_PYTHON */
1532         }
1533 }
1534
1535 static FModifierTypeInfo FMI_GENERATOR = {
1536         FMODIFIER_TYPE_GENERATOR, /* type */
1537         sizeof(FMod_Generator), /* size */
1538         FMI_TYPE_GENERATE_CURVE, /* action type */
1539         FMI_REQUIRES_NOTHING, /* requirements */
1540         "Generator", /* name */
1541         "FMod_Generator", /* struct name */
1542         fcm_generator_free, /* free data */
1543         fcm_generator_copy, /* copy data */
1544         fcm_generator_new_data, /* new data */
1545         fcm_generator_verify, /* verify */
1546         NULL, /* evaluate time */
1547         fcm_generator_evaluate /* evaluate */
1548 };
1549
1550 /* Envelope F-Curve Modifier --------------------------- */
1551
1552 static void fcm_envelope_free (FModifier *fcm)
1553 {
1554         FMod_Envelope *env= (FMod_Envelope *)fcm->data;
1555         
1556         /* free envelope data array */
1557         if (env->data)
1558                 MEM_freeN(env->data);
1559 }
1560
1561 static void fcm_envelope_copy (FModifier *fcm, FModifier *src)
1562 {
1563         FMod_Envelope *env= (FMod_Envelope *)fcm->data;
1564         FMod_Envelope *oenv= (FMod_Envelope *)src->data;
1565         
1566         /* copy envelope data array */
1567         if (oenv->data)
1568                 env->data= MEM_dupallocN(oenv->data);
1569 }
1570
1571 static void fcm_envelope_new_data (void *mdata)
1572 {
1573         FMod_Envelope *env= (FMod_Envelope *)mdata;
1574         
1575         /* set default min/max ranges */
1576         env->min= -1.0f;
1577         env->max= 1.0f;
1578 }
1579
1580 static void fcm_envelope_verify (FModifier *fcm)
1581 {
1582         FMod_Envelope *env= (FMod_Envelope *)fcm->data;
1583         
1584         /* if the are points, perform bubble-sort on them, as user may have changed the order */
1585         if (env->data) {
1586                 // XXX todo...
1587         }
1588 }
1589
1590 static void fcm_envelope_evaluate (FCurve *fcu, FModifier *fcm, float *cvalue, float evaltime)
1591 {
1592         FMod_Envelope *env= (FMod_Envelope *)fcm->data;
1593         FCM_EnvelopeData *fed, *prevfed, *lastfed;
1594         float min=0.0f, max=0.0f, fac=0.0f;
1595         int a;
1596         
1597         /* get pointers */
1598         if (env->data == NULL) return;
1599         prevfed= env->data;
1600         fed= prevfed + 1;
1601         lastfed= prevfed + (env->totvert-1);
1602         
1603         /* get min/max values for envelope at evaluation time (relative to mid-value) */
1604         if (prevfed->time >= evaltime) {
1605                 /* before or on first sample, so just extend value */
1606                 min= prevfed->min;
1607                 max= prevfed->max;
1608         }
1609         else if (lastfed->time <= evaltime) {
1610                 /* after or on last sample, so just extend value */
1611                 min= lastfed->min;
1612                 max= lastfed->max;
1613         }
1614         else {
1615                 /* evaltime occurs somewhere between segments */
1616                 // TODO: implement binary search for this to make it faster?
1617                 for (a=0; prevfed && fed && (a < env->totvert-1); a++, prevfed=fed, fed++) {  
1618                         /* evaltime occurs within the interval defined by these two envelope points */
1619                         if ((prevfed->time <= evaltime) && (fed->time >= evaltime)) {
1620                                 float afac, bfac, diff;
1621                                 
1622                                 diff= fed->time - prevfed->time;
1623                                 afac= (evaltime - prevfed->time) / diff;
1624                                 bfac= (fed->time - evaltime) / diff;
1625                                 
1626                                 min= bfac*prevfed->min + afac*fed->min;
1627                                 max= bfac*prevfed->max + afac*fed->max;
1628                                 
1629                                 break;
1630                         }
1631                 }
1632         }
1633         
1634         /* adjust *cvalue 
1635          *      - fac is the ratio of how the current y-value corresponds to the reference range
1636          *      - thus, the new value is found by mapping the old range to the new!
1637          */
1638         fac= (*cvalue - (env->midval + env->min)) / (env->max - env->min);
1639         *cvalue= min + fac*(max - min); 
1640 }
1641
1642 static FModifierTypeInfo FMI_ENVELOPE = {
1643         FMODIFIER_TYPE_ENVELOPE, /* type */
1644         sizeof(FMod_Envelope), /* size */
1645         FMI_TYPE_REPLACE_VALUES, /* action type */
1646         0, /* requirements */
1647         "Envelope", /* name */
1648         "FMod_Envelope", /* struct name */
1649         fcm_envelope_free, /* free data */
1650         fcm_envelope_copy, /* copy data */
1651         fcm_envelope_new_data, /* new data */
1652         fcm_envelope_verify, /* verify */
1653         NULL, /* evaluate time */
1654         fcm_envelope_evaluate /* evaluate */
1655 };
1656
1657 /* Cycles F-Curve Modifier  --------------------------- */
1658
1659 /* This modifier changes evaltime to something that exists within the curve's frame-range, 
1660  * then re-evaluates modifier stack up to this point using the new time. This re-entrant behaviour
1661  * is very likely to be more time-consuming than the original approach... (which was tighly integrated into 
1662  * the calculation code...).
1663  *
1664  * 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
1665  * Possible TODO - store length of cycle information that can be initialised from the extents of the keyframes/sample-data, and adjusted
1666  *                              as appropriate
1667  */
1668
1669 /* temp data used during evaluation */
1670 typedef struct tFCMED_Cycles {
1671         float cycyofs;          /* y-offset to apply */
1672 } tFCMED_Cycles;
1673  
1674 static void fcm_cycles_new_data (void *mdata)
1675 {
1676         FMod_Cycles *data= (FMod_Cycles *)mdata;
1677         
1678         /* turn on cycles by default */
1679         data->before_mode= data->after_mode= FCM_EXTRAPOLATE_CYCLIC;
1680 }
1681
1682 static float fcm_cycles_time (FCurve *fcu, FModifier *fcm, float cvalue, float evaltime)
1683 {
1684         FMod_Cycles *data= (FMod_Cycles *)fcm->data;
1685         float prevkey[2], lastkey[2], cycyofs=0.0f;
1686         short side=0, mode=0;
1687         int cycles=0;
1688         
1689         /* check if modifier is first in stack, otherwise disable ourself... */
1690         // FIXME...
1691         if (fcm->prev) {
1692                 fcm->flag |= FMODIFIER_FLAG_DISABLED;
1693                 return evaltime;
1694         }
1695         
1696         /* calculate new evaltime due to cyclic interpolation */
1697         if (fcu && fcu->bezt) {
1698                 BezTriple *prevbezt= fcu->bezt;
1699                 BezTriple *lastbezt= prevbezt + fcu->totvert-1;
1700                 
1701                 prevkey[0]= prevbezt->vec[1][0];
1702                 prevkey[1]= prevbezt->vec[1][1];
1703                 
1704                 lastkey[0]= lastbezt->vec[1][0];
1705                 lastkey[1]= lastbezt->vec[1][1];
1706         }
1707         else if (fcu && fcu->fpt) {
1708                 FPoint *prevfpt= fcu->fpt;
1709                 FPoint *lastfpt= prevfpt + fcu->totvert-1;
1710                 
1711                 prevkey[0]= prevfpt->vec[0];
1712                 prevkey[1]= prevfpt->vec[1];
1713                 
1714                 lastkey[0]= lastfpt->vec[0];
1715                 lastkey[1]= lastfpt->vec[1];
1716         }
1717         else
1718                 return evaltime;
1719                 
1720         /* check if modifier will do anything
1721          *      1) if in data range, definitely don't do anything
1722          *      2) if before first frame or after last frame, make sure some cycling is in use
1723          */
1724         if (evaltime < prevkey[0]) {
1725                 if (data->before_mode)  {
1726                         side= -1;
1727                         mode= data->before_mode;
1728                         cycles= data->before_cycles;
1729                 }
1730         }
1731         else if (evaltime > lastkey[0]) {
1732                 if (data->after_mode) {
1733                         side= 1;
1734                         mode= data->after_mode;
1735                         cycles= data->after_cycles;
1736                 }
1737         }
1738         if ELEM(0, side, mode)
1739                 return evaltime;
1740                 
1741         /* find relative place within a cycle */
1742         {
1743                 float cycdx=0, cycdy=0, ofs=0;
1744                 float cycle= 0;
1745                 
1746                 /* ofs is start frame of cycle */
1747                 ofs= prevkey[0];
1748                 
1749                 /* calculate period and amplitude (total height) of a cycle */
1750                 cycdx= lastkey[0] - prevkey[0];
1751                 cycdy= lastkey[1] - prevkey[1];
1752                 
1753                 /* check if cycle is infinitely small, to be point of being impossible to use */
1754                 if (cycdx == 0)
1755                         return evaltime;
1756                         
1757                 /* calculate the 'number' of the cycle */
1758                 cycle= ((float)side * (evaltime - ofs) / cycdx);
1759                 
1760                 /* check that cyclic is still enabled for the specified time */
1761                 if (cycles == 0) {
1762                         /* catch this case so that we don't exit when we have cycles=0
1763                          * as this indicates infinite cycles...
1764                          */
1765                 }
1766                 else if (cycle > (cycles+1)) {
1767                         /* we are too far away from range to evaluate
1768                          * TODO: but we should still hold last value... 
1769                          */
1770                         return evaltime;
1771                 }
1772                 
1773                 /* check if 'cyclic extrapolation', and thus calculate y-offset for this cycle */
1774                 if (mode == FCM_EXTRAPOLATE_CYCLIC_OFFSET) {
1775                         cycyofs = (float)floor((evaltime - ofs) / cycdx);
1776                         cycyofs *= cycdy;
1777                 }
1778                 
1779                 /* calculate where in the cycle we are (overwrite evaltime to reflect this) */
1780                 if ((mode == FCM_EXTRAPOLATE_MIRROR) && ((int)(cycle) % 2)) {
1781                         /* when 'mirror' option is used and cycle number is odd, this cycle is played in reverse 
1782                          *      - for 'before' extrapolation, we need to flip in a different way, otherwise values past
1783                          *        then end of the curve get referenced (result of fmod will be negative, and with different phase)
1784                          */
1785                         if (side < 0)
1786                                 evaltime= (float)(prevkey[0] - fmod(evaltime-ofs, cycdx));
1787                         else
1788                                 evaltime= (float)(lastkey[0] - fmod(evaltime-ofs, cycdx));
1789                 }
1790                 else {
1791                         /* the cycle is played normally... */
1792                         evaltime= (float)(fmod(evaltime-ofs, cycdx) + ofs);
1793                 }
1794                 if (evaltime < ofs) evaltime += cycdx;
1795         }
1796         
1797         /* store temp data if needed */
1798         if (mode == FCM_EXTRAPOLATE_CYCLIC_OFFSET) {
1799                 tFCMED_Cycles *edata;
1800                 
1801                 /* for now, this is just a float, but we could get more stuff... */
1802                 fcm->edata= edata= MEM_callocN(sizeof(tFCMED_Cycles), "tFCMED_Cycles");
1803                 edata->cycyofs= cycyofs;
1804         }
1805         
1806         /* return the new frame to evaluate */
1807         return evaltime;
1808 }
1809  
1810 static void fcm_cycles_evaluate (FCurve *fcu, FModifier *fcm, float *cvalue, float evaltime)
1811 {
1812         tFCMED_Cycles *edata= (tFCMED_Cycles *)fcm->edata;
1813         
1814         /* use temp data */
1815         if (edata) {
1816                 /* add cyclic offset - no need to check for now, otherwise the data wouldn't exist! */
1817                 *cvalue += edata->cycyofs;
1818                 
1819                 /* free temp data */
1820                 MEM_freeN(edata);
1821                 fcm->edata= NULL;
1822         }
1823 }
1824
1825 static FModifierTypeInfo FMI_CYCLES = {
1826         FMODIFIER_TYPE_CYCLES, /* type */
1827         sizeof(FMod_Cycles), /* size */
1828         FMI_TYPE_EXTRAPOLATION, /* action type */
1829         FMI_REQUIRES_ORIGINAL_DATA, /* requirements */
1830         "Cycles", /* name */
1831         "FMod_Cycles", /* struct name */
1832         NULL, /* free data */
1833         NULL, /* copy data */
1834         fcm_cycles_new_data, /* new data */
1835         NULL /*fcm_cycles_verify*/, /* verify */
1836         fcm_cycles_time, /* evaluate time */
1837         fcm_cycles_evaluate /* evaluate */
1838 };
1839
1840 /* Noise F-Curve Modifier  --------------------------- */
1841
1842 static void fcm_noise_new_data (void *mdata)
1843 {
1844         FMod_Noise *data= (FMod_Noise *)mdata;
1845         
1846         /* defaults */
1847         data->size= 1.0f;
1848         data->strength= 1.0f;
1849         data->phase= 1.0f;
1850         data->depth = 0;
1851         data->modification = FCM_NOISE_MODIF_REPLACE;
1852 }
1853  
1854 static void fcm_noise_evaluate (FCurve *fcu, FModifier *fcm, float *cvalue, float evaltime)
1855 {
1856         FMod_Noise *data= (FMod_Noise *)fcm->data;
1857         float noise;
1858         
1859         noise = BLI_turbulence(data->size, evaltime, data->phase, 0.f, data->depth);
1860         
1861         switch (data->modification) {
1862                 case FCM_NOISE_MODIF_ADD:
1863                         *cvalue= *cvalue + noise * data->strength;
1864                         break;
1865                 case FCM_NOISE_MODIF_SUBTRACT:
1866                         *cvalue= *cvalue - noise * data->strength;
1867                         break;
1868                 case FCM_NOISE_MODIF_MULTIPLY:
1869                         *cvalue= *cvalue * noise * data->strength;
1870                         break;
1871                 case FCM_NOISE_MODIF_REPLACE:
1872                 default:
1873                         *cvalue= *cvalue + (noise - 0.5f) * data->strength;
1874                         break;
1875         }
1876 }
1877
1878 static FModifierTypeInfo FMI_NOISE = {
1879         FMODIFIER_TYPE_NOISE, /* type */
1880         sizeof(FMod_Noise), /* size */
1881         FMI_TYPE_REPLACE_VALUES, /* action type */
1882         0, /* requirements */
1883         "Noise", /* name */
1884         "FMod_Noise", /* struct name */
1885         NULL, /* free data */
1886         NULL, /* copy data */
1887         fcm_noise_new_data, /* new data */
1888         NULL /*fcm_noise_verify*/, /* verify */
1889         NULL, /* evaluate time */
1890         fcm_noise_evaluate /* evaluate */
1891 };
1892
1893 /* Filter F-Curve Modifier --------------------------- */
1894
1895 #if 0 // XXX not yet implemented 
1896 static FModifierTypeInfo FMI_FILTER = {
1897         FMODIFIER_TYPE_FILTER, /* type */
1898         sizeof(FMod_Filter), /* size */
1899         FMI_TYPE_REPLACE_VALUES, /* action type */
1900         0, /* requirements */
1901         "Filter", /* name */
1902         "FMod_Filter", /* struct name */
1903         NULL, /* free data */
1904         NULL, /* copy data */
1905         NULL, /* new data */
1906         NULL /*fcm_filter_verify*/, /* verify */
1907         NULL, /* evlauate time */
1908         fcm_filter_evaluate /* evaluate */
1909 };
1910 #endif // XXX not yet implemented
1911
1912
1913 /* Python F-Curve Modifier --------------------------- */
1914
1915 static void fcm_python_free (FModifier *fcm)
1916 {
1917         FMod_Python *data= (FMod_Python *)fcm->data;
1918         
1919         /* id-properties */
1920         IDP_FreeProperty(data->prop);
1921         MEM_freeN(data->prop);
1922 }
1923
1924 static void fcm_python_new_data (void *mdata) 
1925 {
1926         FMod_Python *data= (FMod_Python *)mdata;
1927         
1928         /* everything should be set correctly by calloc, except for the prop->type constant.*/
1929         data->prop = MEM_callocN(sizeof(IDProperty), "PyFModifierProps");
1930         data->prop->type = IDP_GROUP;
1931 }
1932
1933 static void fcm_python_copy (FModifier *fcm, FModifier *src)
1934 {
1935         FMod_Python *pymod = (FMod_Python *)fcm->data;
1936         FMod_Python *opymod = (FMod_Python *)src->data;
1937         
1938         pymod->prop = IDP_CopyProperty(opymod->prop);
1939 }
1940
1941 static void fcm_python_evaluate (FCurve *fcu, FModifier *fcm, float *cvalue, float evaltime)
1942 {
1943 #ifndef DISABLE_PYTHON
1944         //FMod_Python *data= (FMod_Python *)fcm->data;
1945         
1946         /* FIXME... need to implement this modifier...
1947          *      It will need it execute a script using the custom properties 
1948          */
1949 #endif /* DISABLE_PYTHON */
1950 }
1951
1952 static FModifierTypeInfo FMI_PYTHON = {
1953         FMODIFIER_TYPE_PYTHON, /* type */
1954         sizeof(FMod_Python), /* size */
1955         FMI_TYPE_GENERATE_CURVE, /* action type */
1956         FMI_REQUIRES_RUNTIME_CHECK, /* requirements */
1957         "Python", /* name */
1958         "FMod_Python", /* struct name */
1959         fcm_python_free, /* free data */
1960         fcm_python_copy, /* copy data */
1961         fcm_python_new_data, /* new data */
1962         NULL /*fcm_python_verify*/, /* verify */
1963         NULL /*fcm_python_time*/, /* evaluate time */
1964         fcm_python_evaluate /* evaluate */
1965 };
1966
1967
1968 /* Limits F-Curve Modifier --------------------------- */
1969
1970 static float fcm_limits_time (FCurve *fcu, FModifier *fcm, float cvalue, float evaltime)
1971 {
1972         FMod_Limits *data= (FMod_Limits *)fcm->data;
1973         
1974         /* check for the time limits */
1975         if ((data->flag & FCM_LIMIT_XMIN) && (evaltime < data->rect.xmin))
1976                 return data->rect.xmin;
1977         if ((data->flag & FCM_LIMIT_XMAX) && (evaltime > data->rect.xmax))
1978                 return data->rect.xmax;
1979                 
1980         /* modifier doesn't change time */
1981         return evaltime;
1982 }
1983
1984 static void fcm_limits_evaluate (FCurve *fcu, FModifier *fcm, float *cvalue, float evaltime)
1985 {
1986         FMod_Limits *data= (FMod_Limits *)fcm->data;
1987         
1988         /* value limits now */
1989         if ((data->flag & FCM_LIMIT_YMIN) && (*cvalue < data->rect.ymin))
1990                 *cvalue= data->rect.ymin;
1991         if ((data->flag & FCM_LIMIT_YMAX) && (*cvalue > data->rect.ymax))
1992                 *cvalue= data->rect.ymax;
1993 }
1994
1995 static FModifierTypeInfo FMI_LIMITS = {
1996         FMODIFIER_TYPE_LIMITS, /* type */
1997         sizeof(FMod_Limits), /* size */
1998         FMI_TYPE_GENERATE_CURVE, /* action type */  /* XXX... err... */   
1999         FMI_REQUIRES_RUNTIME_CHECK, /* requirements */
2000         "Limits", /* name */
2001         "FMod_Limits", /* struct name */
2002         NULL, /* free data */
2003         NULL, /* copy data */
2004         NULL, /* new data */
2005         NULL, /* verify */
2006         fcm_limits_time, /* evaluate time */
2007         fcm_limits_evaluate /* evaluate */
2008 };
2009
2010 /* F-Curve Modifier API --------------------------- */
2011 /* All of the F-Curve Modifier api functions use FModifierTypeInfo structs to carry out
2012  * and operations that involve F-Curve modifier specific code.
2013  */
2014
2015 /* These globals only ever get directly accessed in this file */
2016 static FModifierTypeInfo *fmodifiersTypeInfo[FMODIFIER_NUM_TYPES];
2017 static short FMI_INIT= 1; /* when non-zero, the list needs to be updated */
2018
2019 /* This function only gets called when FMI_INIT is non-zero */
2020 static void fmods_init_typeinfo () 
2021 {
2022         fmodifiersTypeInfo[0]=  NULL;                                   /* 'Null' F-Curve Modifier */
2023         fmodifiersTypeInfo[1]=  &FMI_GENERATOR;                 /* Generator F-Curve Modifier */
2024         fmodifiersTypeInfo[2]=  &FMI_ENVELOPE;                  /* Envelope F-Curve Modifier */
2025         fmodifiersTypeInfo[3]=  &FMI_CYCLES;                    /* Cycles F-Curve Modifier */
2026         fmodifiersTypeInfo[4]=  &FMI_NOISE;                             /* Apply-Noise F-Curve Modifier */
2027         fmodifiersTypeInfo[5]=  NULL/*&FMI_FILTER*/;                    /* Filter F-Curve Modifier */  // XXX unimplemented
2028         fmodifiersTypeInfo[6]=  &FMI_PYTHON;                    /* Custom Python F-Curve Modifier */
2029         fmodifiersTypeInfo[7]=  &FMI_LIMITS;                    /* Limits F-Curve Modifier */
2030 }
2031
2032 /* This function should be used for getting the appropriate type-info when only
2033  * a F-Curve modifier type is known
2034  */
2035 FModifierTypeInfo *get_fmodifier_typeinfo (int type)
2036 {
2037         /* initialise the type-info list? */
2038         if (FMI_INIT) {
2039                 fmods_init_typeinfo();
2040                 FMI_INIT = 0;
2041         }
2042         
2043         /* only return for valid types */
2044         if ( (type >= FMODIFIER_TYPE_NULL) && 
2045                  (type <= FMODIFIER_NUM_TYPES ) ) 
2046         {
2047                 /* there shouldn't be any segfaults here... */
2048                 return fmodifiersTypeInfo[type];
2049         }
2050         else {
2051                 printf("No valid F-Curve Modifier type-info data available. Type = %i \n", type);
2052         }
2053         
2054         return NULL;
2055
2056  
2057 /* This function should always be used to get the appropriate type-info, as it
2058  * has checks which prevent segfaults in some weird cases.
2059  */
2060 FModifierTypeInfo *fmodifier_get_typeinfo (FModifier *fcm)
2061 {
2062         /* only return typeinfo for valid modifiers */
2063         if (fcm)
2064                 return get_fmodifier_typeinfo(fcm->type);
2065         else
2066                 return NULL;
2067 }
2068
2069 /* API --------------------------- */
2070
2071 /* Add a new F-Curve Modifier to the given F-Curve of a certain type */
2072 FModifier *fcurve_add_modifier (FCurve *fcu, int type)
2073 {
2074         FModifierTypeInfo *fmi= get_fmodifier_typeinfo(type);
2075         FModifier *fcm;
2076         
2077         /* sanity checks */
2078         if ELEM(NULL, fcu, fmi)
2079                 return NULL;
2080         
2081         /* special checks for whether modifier can be added */
2082         if ((fcu->modifiers.first) && (type == FMODIFIER_TYPE_CYCLES)) {
2083                 /* cycles modifier must be first in stack, so for now, don't add if it can't be */
2084                 // TODO: perhaps there is some better way, but for now, 
2085                 printf("Error: Cannot add 'Cycles' modifier to F-Curve, as 'Cycles' modifier can only be first in stack. \n");
2086                 return NULL;
2087         }
2088         
2089         /* add modifier itself */
2090         fcm= MEM_callocN(sizeof(FModifier), "F-Curve Modifier");
2091         fcm->type = type;
2092         fcm->flag = FMODIFIER_FLAG_EXPANDED;
2093         BLI_addtail(&fcu->modifiers, fcm);
2094         
2095         /* add modifier's data */
2096         fcm->data= MEM_callocN(fmi->size, fmi->structName);
2097                 
2098         /* init custom settings if necessary */
2099         if (fmi->new_data)      
2100                 fmi->new_data(fcm->data);
2101                 
2102         /* return modifier for further editing */
2103         return fcm;
2104 }
2105
2106 /* Duplicate all of the F-Curve Modifiers in the Modifier stacks */
2107 void fcurve_copy_modifiers (ListBase *dst, ListBase *src)
2108 {
2109         FModifier *fcm, *srcfcm;
2110         
2111         if ELEM(NULL, dst, src)
2112                 return;
2113         
2114         dst->first= dst->last= NULL;
2115         BLI_duplicatelist(dst, src);
2116         
2117         for (fcm=dst->first, srcfcm=src->first; fcm && srcfcm; srcfcm=srcfcm->next, fcm=fcm->next) {
2118                 FModifierTypeInfo *fmi= fmodifier_get_typeinfo(fcm);
2119                 
2120                 /* make a new copy of the F-Modifier's data */
2121                 fcm->data = MEM_dupallocN(fcm->data);
2122                 
2123                 /* only do specific constraints if required */
2124                 if (fmi && fmi->copy_data)
2125                         fmi->copy_data(fcm, srcfcm);
2126         }
2127 }
2128
2129 /* Remove and free the given F-Curve Modifier from the given F-Curve's stack  */
2130 void fcurve_remove_modifier (FCurve *fcu, FModifier *fcm)
2131 {
2132         FModifierTypeInfo *fmi= fmodifier_get_typeinfo(fcm);
2133         
2134         /* sanity check */
2135         if (fcm == NULL)
2136                 return;
2137         
2138         /* free modifier's special data (stored inside fcm->data) */
2139         if (fcm->data) {
2140                 if (fmi && fmi->free_data)
2141                         fmi->free_data(fcm);
2142                         
2143                 /* free modifier's data (fcm->data) */
2144                 MEM_freeN(fcm->data);
2145         }
2146         
2147         /* remove modifier from stack */
2148         if (fcu)
2149                 BLI_freelinkN(&fcu->modifiers, fcm);
2150         else {
2151                 // XXX this case can probably be removed some day, as it shouldn't happen...
2152                 printf("fcurve_remove_modifier() - no fcurve \n");
2153                 MEM_freeN(fcm);
2154         }
2155 }
2156
2157 /* Remove all of a given F-Curve's modifiers */
2158 void fcurve_free_modifiers (FCurve *fcu)
2159 {
2160         FModifier *fcm, *fmn;
2161         
2162         /* sanity check */
2163         if (fcu == NULL)
2164                 return;
2165         
2166         /* free each modifier in order - modifier is unlinked from list and freed */
2167         for (fcm= fcu->modifiers.first; fcm; fcm= fmn) {
2168                 fmn= fcm->next;
2169                 fcurve_remove_modifier(fcu, fcm);
2170         }
2171 }
2172
2173 /* Find the active F-Curve Modifier */
2174 FModifier *fcurve_find_active_modifier (FCurve *fcu)
2175 {
2176         FModifier *fcm;
2177         
2178         /* sanity checks */
2179         if ELEM(NULL, fcu, fcu->modifiers.first)
2180                 return NULL;
2181         
2182         /* loop over modifiers until 'active' one is found */
2183         for (fcm= fcu->modifiers.first; fcm; fcm= fcm->next) {
2184                 if (fcm->flag & FMODIFIER_FLAG_ACTIVE)
2185                         return fcm;
2186         }
2187         
2188         /* no modifier is active */
2189         return NULL;
2190 }
2191
2192 /* Set the active F-Curve Modifier */
2193 void fcurve_set_active_modifier (FCurve *fcu, FModifier *fcm)
2194 {
2195         FModifier *fm;
2196         
2197         /* sanity checks */
2198         if ELEM(NULL, fcu, fcu->modifiers.first)
2199                 return;
2200         
2201         /* deactivate all, and set current one active */
2202         for (fm= fcu->modifiers.first; fm; fm= fm->next)
2203                 fm->flag &= ~FMODIFIER_FLAG_ACTIVE;
2204         
2205         /* make given modifier active */
2206         if (fcm)
2207                 fcm->flag |= FMODIFIER_FLAG_ACTIVE;
2208 }
2209
2210 /* Evaluation API --------------------------- */
2211
2212 /* evaluate time modifications imposed by some F-Curve Modifiers
2213  *      - this step acts as an optimisation to prevent the F-Curve stack being evaluated 
2214  *        several times by modifiers requesting the time be modified, as the final result
2215  *        would have required using the modified time
2216  *      - modifiers only ever recieve the unmodified time, as subsequent modifiers should be
2217  *        working on the 'global' result of the modified curve, not some localised segment,
2218  *        so nevaltime gets set to whatever the last time-modifying modifier likes...
2219  *      - we start from the end of the stack, as only the last one matters for now
2220  */
2221 float evaluate_time_fmodifiers (ListBase *modifiers, FCurve *fcu, float cvalue, float evaltime)
2222 {
2223         FModifier *fcm;
2224         float m_evaltime= evaltime;
2225         
2226         /* sanity checks */
2227         if ELEM(NULL, modifiers, modifiers->first)
2228                 return evaltime;
2229                 
2230         /* find the first modifier from end of stack that modifies time, and calculate the time the modifier
2231          * would calculate time at
2232          */
2233         for (fcm= fcu->modifiers.last; fcm; fcm= fcm->prev) {
2234                 FModifierTypeInfo *fmi= fmodifier_get_typeinfo(fcm);
2235                 
2236                 /* only evaluate if there's a callback for this */
2237                 // TODO: implement the 'influence' control feature...
2238                 if (fmi && fmi->evaluate_modifier_time) {
2239                         if ((fcm->flag & (FMODIFIER_FLAG_DISABLED|FMODIFIER_FLAG_MUTED)) == 0)
2240                                 m_evaltime= fmi->evaluate_modifier_time(fcu, fcm, cvalue, evaltime);
2241                         break;
2242                 }
2243         }
2244         
2245         /* return the modified evaltime */
2246         return m_evaltime;
2247 }
2248
2249 /* Evalautes the given set of F-Curve Modifiers using the given data
2250  * Should only be called after evaluate_time_fmodifiers() has been called...
2251  */
2252 void evaluate_value_fmodifiers (ListBase *modifiers, FCurve *fcu, float *cvalue, float evaltime)
2253 {
2254         FModifier *fcm;
2255         
2256         /* sanity checks */
2257         if ELEM(NULL, modifiers, modifiers->first)
2258                 return;
2259         
2260         /* evaluate modifiers */
2261         for (fcm= modifiers->first; fcm; fcm= fcm->next) {
2262                 FModifierTypeInfo *fmi= fmodifier_get_typeinfo(fcm);
2263                 
2264                 /* only evaluate if there's a callback for this */
2265                 // TODO: implement the 'influence' control feature...
2266                 if (fmi && fmi->evaluate_modifier) {
2267                         if ((fcm->flag & (FMODIFIER_FLAG_DISABLED|FMODIFIER_FLAG_MUTED)) == 0)
2268                                 fmi->evaluate_modifier(fcu, fcm, cvalue, evaltime);
2269                 }
2270         }
2271
2272
2273
2274 /* Bake modifiers for given F-Curve to curve sample data, in the frame range defined
2275  * by start and end (inclusive).
2276  */
2277 void fcurve_bake_modifiers (FCurve *fcu, int start, int end)
2278 {
2279         ChannelDriver *driver;
2280         
2281         /* sanity checks */
2282         // TODO: make these tests report errors using reports not printf's
2283         if ELEM(NULL, fcu, fcu->modifiers.first) {
2284                 printf("Error: No F-Curve with F-Curve Modifiers to Bake\n");
2285                 return;
2286         }
2287         
2288         /* temporarily, disable driver while we sample, so that they don't influence the outcome */
2289         driver= fcu->driver;
2290         fcu->driver= NULL;
2291         
2292         /* bake the modifiers, by sampling the curve at each frame */
2293         fcurve_store_samples(fcu, NULL, start, end, fcurve_samplingcb_evalcurve);
2294         
2295         /* free the modifiers now */
2296         fcurve_free_modifiers(fcu);
2297         
2298         /* restore driver */
2299         fcu->driver= driver;
2300 }
2301
2302 /* ***************************** F-Curve - Evaluation ********************************* */
2303
2304 /* Evaluate and return the value of the given F-Curve at the specified frame ("evaltime") 
2305  * Note: this is also used for drivers
2306  */
2307 float evaluate_fcurve (FCurve *fcu, float evaltime) 
2308 {
2309         float cvalue= 0.0f;
2310         float devaltime;
2311         
2312         /* if there is a driver (only if this F-Curve is acting as 'driver'), evaluate it to find value to use as "evaltime" 
2313          * since drivers essentially act as alternative input (i.e. in place of 'time') for F-Curves
2314          *      - this value will also be returned as the value of the 'curve', if there are no keyframes
2315          */
2316         if (fcu->driver) {
2317                 /* evaltime now serves as input for the curve */
2318                 evaltime= cvalue= evaluate_driver(fcu->driver, evaltime);
2319         }
2320         
2321         /* evaluate modifiers which modify time to evaluate the base curve at */
2322         devaltime= evaluate_time_fmodifiers(&fcu->modifiers, fcu, cvalue, evaltime);
2323         
2324         /* evaluate curve-data 
2325          *      - 'devaltime' instead of 'evaltime', as this is the time that the last time-modifying 
2326          *        F-Curve modifier on the stack requested the curve to be evaluated at
2327          */
2328         if (fcu->bezt)
2329                 cvalue= fcurve_eval_keyframes(fcu, fcu->bezt, devaltime);
2330         else if (fcu->fpt)
2331                 cvalue= fcurve_eval_samples(fcu, fcu->fpt, devaltime);
2332         
2333         /* evaluate modifiers */
2334         evaluate_value_fmodifiers(&fcu->modifiers, fcu, &cvalue, evaltime);
2335         
2336         /* if curve can only have integral values, perform truncation (i.e. drop the decimal part)
2337          * here so that the curve can be sampled correctly
2338          */
2339         if (fcu->flag & FCURVE_INT_VALUES)
2340                 cvalue= (float)((int)cvalue);
2341         
2342         /* return evaluated value */
2343         return cvalue;
2344 }
2345
2346 /* Calculate the value of the given F-Curve at the given frame, and set its curval */
2347 // TODO: will this be necessary?
2348 void calculate_fcurve (FCurve *fcu, float ctime)
2349 {
2350         /* calculate and set curval (evaluates driver too) */
2351         fcu->curval= evaluate_fcurve(fcu, ctime);
2352 }
2353