svn merge -r39145:39286 https://svn.blender.org/svnroot/bf-blender/trunk/blender
[blender.git] / source / blender / blenkernel / intern / fcurve.c
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2009 Blender Foundation, Joshua Leung
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): Joshua Leung (full recode)
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 /** \file blender/blenkernel/intern/fcurve.c
31  *  \ingroup bke
32  */
33
34  
35
36 #include <math.h>
37 #include <stdio.h>
38 #include <stddef.h>
39 #include <string.h>
40 #include <float.h>
41
42 #include "MEM_guardedalloc.h"
43
44 #include "DNA_anim_types.h"
45 #include "DNA_constraint_types.h"
46 #include "DNA_object_types.h"
47
48 #include "BLI_blenlib.h"
49 #include "BLI_math.h"
50 #include "BLI_utildefines.h"
51
52 #include "BKE_fcurve.h"
53 #include "BKE_animsys.h"
54 #include "BKE_action.h"
55 #include "BKE_armature.h"
56 #include "BKE_constraint.h"
57 #include "BKE_curve.h" 
58 #include "BKE_global.h"
59 #include "BKE_object.h"
60 #include "BKE_utildefines.h"
61
62 #include "RNA_access.h"
63
64 #ifdef WITH_PYTHON
65 #include "BPY_extern.h" 
66 #endif
67
68 #define SMALL -1.0e-10
69 #define SELECT 1
70
71 /* ************************** Data-Level Functions ************************* */
72
73 /* ---------------------- Freeing --------------------------- */
74
75 /* Frees the F-Curve itself too, so make sure BLI_remlink is called before calling this... */
76 void free_fcurve (FCurve *fcu) 
77 {
78         if (fcu == NULL) 
79                 return;
80         
81         /* free curve data */
82         if (fcu) {
83                 if (fcu->bezt) MEM_freeN(fcu->bezt);
84                 if (fcu->fpt) MEM_freeN(fcu->fpt);
85         }
86         
87         /* free RNA-path, as this were allocated when getting the path string */
88         if (fcu->rna_path)
89                 MEM_freeN(fcu->rna_path);
90         
91         /* free extra data - i.e. modifiers, and driver */
92         fcurve_free_driver(fcu);
93         free_fmodifiers(&fcu->modifiers);
94         
95         /* free f-curve itself */
96         MEM_freeN(fcu);
97 }
98
99 /* Frees a list of F-Curves */
100 void free_fcurves (ListBase *list)
101 {
102         FCurve *fcu, *fcn;
103         
104         /* sanity check */
105         if (list == NULL)
106                 return;
107                 
108         /* free data - no need to call remlink before freeing each curve, 
109          * as we store reference to next, and freeing only touches the curve
110          * it's given
111          */
112         for (fcu= list->first; fcu; fcu= fcn) {
113                 fcn= fcu->next;
114                 free_fcurve(fcu);
115         }
116         
117         /* clear pointers just in case */
118         list->first= list->last= NULL;
119 }       
120
121 /* ---------------------- Copy --------------------------- */
122
123 /* duplicate an F-Curve */
124 FCurve *copy_fcurve (FCurve *fcu)
125 {
126         FCurve *fcu_d;
127         
128         /* sanity check */
129         if (fcu == NULL)
130                 return NULL;
131                 
132         /* make a copy */
133         fcu_d= MEM_dupallocN(fcu);
134         
135         fcu_d->next= fcu_d->prev= NULL;
136         fcu_d->grp= NULL;
137         
138         /* copy curve data */
139         fcu_d->bezt= MEM_dupallocN(fcu_d->bezt);
140         fcu_d->fpt= MEM_dupallocN(fcu_d->fpt);
141         
142         /* copy rna-path */
143         fcu_d->rna_path= MEM_dupallocN(fcu_d->rna_path);
144         
145         /* copy driver */
146         fcu_d->driver= fcurve_copy_driver(fcu_d->driver);
147         
148         /* copy modifiers */
149         copy_fmodifiers(&fcu_d->modifiers, &fcu->modifiers);
150         
151         /* return new data */
152         return fcu_d;
153 }
154
155 /* duplicate a list of F-Curves */
156 void copy_fcurves (ListBase *dst, ListBase *src)
157 {
158         FCurve *dfcu, *sfcu;
159         
160         /* sanity checks */
161         if ELEM(NULL, dst, src)
162                 return;
163         
164         /* clear destination list first */
165         dst->first= dst->last= NULL;
166         
167         /* copy one-by-one */
168         for (sfcu= src->first; sfcu; sfcu= sfcu->next) {
169                 dfcu= copy_fcurve(sfcu);
170                 BLI_addtail(dst, dfcu);
171         }
172 }
173
174 /* ----------------- Finding F-Curves -------------------------- */
175
176 /* high level function to get an fcurve from C without having the rna */
177 FCurve *id_data_find_fcurve(ID *id, void *data, StructRNA *type, const char *prop_name, int index, char *driven)
178 {
179         /* anim vars */
180         AnimData *adt= BKE_animdata_from_id(id);
181         FCurve *fcu= NULL;
182
183         /* rna vars */
184         PointerRNA ptr;
185         PropertyRNA *prop;
186         char *path;
187
188         if(driven)
189                 *driven = 0;
190         
191         /* only use the current action ??? */
192         if (ELEM(NULL, adt, adt->action))
193                 return NULL;
194         
195         RNA_pointer_create(id, type, data, &ptr);
196         prop = RNA_struct_find_property(&ptr, prop_name);
197         
198         if (prop) {
199                 path= RNA_path_from_ID_to_property(&ptr, prop);
200                         
201                 if (path) {
202                         /* animation takes priority over drivers */
203                         if ((adt->action) && (adt->action->curves.first))
204                                 fcu= list_find_fcurve(&adt->action->curves, path, index);
205                         
206                         /* if not animated, check if driven */
207                         if ((fcu == NULL) && (adt->drivers.first)) {
208                                 fcu= list_find_fcurve(&adt->drivers, path, index);
209                                 if(fcu && driven)
210                                         *driven = 1;
211                                 fcu = NULL;
212                         }
213                         
214                         MEM_freeN(path);
215                 }
216         }
217
218         return fcu;
219 }
220
221
222 /* Find the F-Curve affecting the given RNA-access path + index, in the list of F-Curves provided */
223 FCurve *list_find_fcurve (ListBase *list, const char rna_path[], const int array_index)
224 {
225         FCurve *fcu;
226         
227         /* sanity checks */
228         if ( ELEM(NULL, list, rna_path) || (array_index < 0) )
229                 return NULL;
230         
231         /* check paths of curves, then array indices... */
232         for (fcu= list->first; fcu; fcu= fcu->next) {
233                 /* simple string-compare (this assumes that they have the same root...) */
234                 if (fcu->rna_path && !strcmp(fcu->rna_path, rna_path)) {
235                         /* now check indices */
236                         if (fcu->array_index == array_index)
237                                 return fcu;
238                 }
239         }
240         
241         /* return */
242         return NULL;
243 }
244
245 /* quick way to loop over all fcurves of a given 'path' */
246 FCurve *iter_step_fcurve (FCurve *fcu_iter, const char rna_path[])
247 {
248         FCurve *fcu;
249         
250         /* sanity checks */
251         if (ELEM(NULL, fcu_iter, rna_path))
252                 return NULL;
253
254         /* check paths of curves, then array indices... */
255         for (fcu= fcu_iter; fcu; fcu= fcu->next) {
256                 /* simple string-compare (this assumes that they have the same root...) */
257                 if (fcu->rna_path && !strcmp(fcu->rna_path, rna_path)) {
258                         return fcu;
259                 }
260         }
261
262         /* return */
263         return NULL;
264 }
265
266 /* Get list of LinkData's containing pointers to the F-Curves which control the types of data indicated 
267  * Lists...
268  *      - dst: list of LinkData's matching the criteria returned. 
269  *        List must be freed after use, and is assumed to be empty when passed.
270  *      - src: list of F-Curves to search through
271  * Filters...
272  *      - dataPrefix: i.e. 'pose.bones[' or 'nodes['
273  *      - dataName: name of entity within "" immediately following the prefix
274  */
275 int list_find_data_fcurves (ListBase *dst, ListBase *src, const char *dataPrefix, const char *dataName)
276 {
277         FCurve *fcu;
278         int matches = 0;
279         
280         /* sanity checks */
281         if (ELEM4(NULL, dst, src, dataPrefix, dataName))
282                 return 0;
283         else if ((dataPrefix[0] == 0) || (dataName[0] == 0))
284                 return 0;
285         
286         /* search each F-Curve one by one */
287         for (fcu= src->first; fcu; fcu= fcu->next) {
288                 /* check if quoted string matches the path */
289                 if ((fcu->rna_path) && strstr(fcu->rna_path, dataPrefix)) {
290                         char *quotedName= BLI_getQuotedStr(fcu->rna_path, dataPrefix);
291                         
292                         if (quotedName) {
293                                 /* check if the quoted name matches the required name */
294                                 if (strcmp(quotedName, dataName) == 0) {
295                                         LinkData *ld= MEM_callocN(sizeof(LinkData), "list_find_data_fcurves");
296                                         
297                                         ld->data= fcu;
298                                         BLI_addtail(dst, ld);
299                                         
300                                         matches++;
301                                 }
302                                 
303                                 /* always free the quoted string, since it needs freeing */
304                                 MEM_freeN(quotedName);
305                         }
306                 }
307         }
308         
309         /* return the number of matches */
310         return matches;
311 }
312
313 FCurve *rna_get_fcurve (PointerRNA *ptr, PropertyRNA *prop, int rnaindex, bAction **action, int *driven)
314 {
315         FCurve *fcu= NULL;
316         
317         *driven= 0;
318         
319         /* there must be some RNA-pointer + property combon */
320         if (prop && ptr->id.data && RNA_property_animateable(ptr, prop)) {
321                 AnimData *adt= BKE_animdata_from_id(ptr->id.data);
322                 char *path;
323                 
324                 if (adt) {
325                         if ((adt->action && adt->action->curves.first) || (adt->drivers.first)) {
326                                 /* XXX this function call can become a performance bottleneck */
327                                 path= RNA_path_from_ID_to_property(ptr, prop);
328                                 
329                                 if (path) {
330                                         /* animation takes priority over drivers */
331                                         if (adt->action && adt->action->curves.first)
332                                                 fcu= list_find_fcurve(&adt->action->curves, path, rnaindex);
333                                         
334                                         /* if not animated, check if driven */
335                                         if (!fcu && (adt->drivers.first)) {
336                                                 fcu= list_find_fcurve(&adt->drivers, path, rnaindex);
337                                                 
338                                                 if (fcu)
339                                                         *driven= 1;
340                                         }
341                                         
342                                         if (fcu && action)
343                                                 *action= adt->action;
344                                         
345                                         MEM_freeN(path);
346                                 }
347                         }
348                 }
349         }
350         
351         return fcu;
352 }
353
354 /* ----------------- Finding Keyframes/Extents -------------------------- */
355
356 /* threshold for binary-searching keyframes - threshold here should be good enough for now, but should become userpref */
357 #define BEZT_BINARYSEARCH_THRESH        0.01f /* was 0.00001, but giving errors */
358
359 /* Binary search algorithm for finding where to insert BezTriple. (for use by insert_bezt_fcurve)
360  * Returns the index to insert at (data already at that index will be offset if replace is 0)
361  */
362 int binarysearch_bezt_index (BezTriple array[], float frame, int arraylen, short *replace)
363 {
364         int start=0, end=arraylen;
365         int loopbreaker= 0, maxloop= arraylen * 2;
366         
367         /* initialise replace-flag first */
368         *replace= 0;
369         
370         /* sneaky optimisations (don't go through searching process if...):
371          *      - keyframe to be added is to be added out of current bounds
372          *      - keyframe to be added would replace one of the existing ones on bounds
373          */
374         if ((arraylen <= 0) || (array == NULL)) {
375                 printf("Warning: binarysearch_bezt_index() encountered invalid array \n");
376                 return 0;
377         }
378         else {
379                 /* check whether to add before/after/on */
380                 float framenum;
381                 
382                 /* 'First' Keyframe (when only one keyframe, this case is used) */
383                 framenum= array[0].vec[1][0];
384                 if (IS_EQT(frame, framenum, BEZT_BINARYSEARCH_THRESH)) {
385                         *replace = 1;
386                         return 0;
387                 }
388                 else if (frame < framenum)
389                         return 0;
390                         
391                 /* 'Last' Keyframe */
392                 framenum= array[(arraylen-1)].vec[1][0];
393                 if (IS_EQT(frame, framenum, BEZT_BINARYSEARCH_THRESH)) {
394                         *replace= 1;
395                         return (arraylen - 1);
396                 }
397                 else if (frame > framenum)
398                         return arraylen;
399         }
400         
401         
402         /* most of the time, this loop is just to find where to put it
403          * 'loopbreaker' is just here to prevent infinite loops 
404          */
405         for (loopbreaker=0; (start <= end) && (loopbreaker < maxloop); loopbreaker++) {
406                 /* compute and get midpoint */
407                 int mid = start + ((end - start) / 2);  /* we calculate the midpoint this way to avoid int overflows... */
408                 float midfra= array[mid].vec[1][0];
409                 
410                 /* check if exactly equal to midpoint */
411                 if (IS_EQT(frame, midfra, BEZT_BINARYSEARCH_THRESH)) {
412                         *replace = 1;
413                         return mid;
414                 }
415                 
416                 /* repeat in upper/lower half */
417                 if (frame > midfra)
418                         start= mid + 1;
419                 else if (frame < midfra)
420                         end= mid - 1;
421         }
422         
423         /* print error if loop-limit exceeded */
424         if (loopbreaker == (maxloop-1)) {
425                 printf("Error: binarysearch_bezt_index() was taking too long \n");
426                 
427                 // include debug info 
428                 printf("\tround = %d: start = %d, end = %d, arraylen = %d \n", loopbreaker, start, end, arraylen);
429         }
430         
431         /* not found, so return where to place it */
432         return start;
433 }
434
435 /* ...................................... */
436
437 /* helper for calc_fcurve_* functions -> find first and last BezTriple to be used */
438 static void get_fcurve_end_keyframes (FCurve *fcu, BezTriple **first, BezTriple **last, const short selOnly)
439 {
440         /* init outputs */
441         *first = NULL;
442         *last = NULL;
443         
444         /* sanity checks */
445         if (fcu->bezt == NULL)
446                 return;
447         
448         /* only include selected items? */
449         if (selOnly) {
450                 BezTriple *bezt;
451                 unsigned int i;
452                 
453                 /* find first selected */
454                 bezt = fcu->bezt;
455                 for (i=0; i < fcu->totvert; bezt++, i++) {
456                         if (BEZSELECTED(bezt)) {
457                                 *first= bezt;
458                                 break;
459                         }
460                 }
461                 
462                 /* find last selected */
463                 bezt = ARRAY_LAST_ITEM(fcu->bezt, BezTriple, sizeof(BezTriple), fcu->totvert);
464                 for (i=0; i < fcu->totvert; bezt--, i++) {
465                         if (BEZSELECTED(bezt)) {
466                                 *last= bezt;
467                                 break;
468                         }
469                 }
470         }
471         else {
472                 /* just full array */
473                 *first = fcu->bezt;
474                 *last = ARRAY_LAST_ITEM(fcu->bezt, BezTriple, sizeof(BezTriple), fcu->totvert);
475         }
476 }
477
478
479 /* Calculate the extents of F-Curve's data */
480 void calc_fcurve_bounds (FCurve *fcu, float *xmin, float *xmax, float *ymin, float *ymax, const short selOnly)
481 {
482         float xminv=999999999.0f, xmaxv=-999999999.0f;
483         float yminv=999999999.0f, ymaxv=-999999999.0f;
484         short foundvert=0;
485         unsigned int i;
486         
487         if (fcu->totvert) {
488                 if (fcu->bezt) {
489                         BezTriple *bezt_first= NULL, *bezt_last= NULL;
490                         
491                         if (xmin || xmax) {
492                                 /* get endpoint keyframes */
493                                 get_fcurve_end_keyframes(fcu, &bezt_first, &bezt_last, selOnly);
494                                 
495                                 if (bezt_first) {
496                                         BLI_assert(bezt_last != NULL);
497                                         
498                                         xminv= MIN2(xminv, bezt_first->vec[1][0]);
499                                         xmaxv= MAX2(xmaxv, bezt_last->vec[1][0]);
500                                 }
501                         }
502                         
503                         /* only loop over keyframes to find extents for values if needed */
504                         if (ymin || ymax) {     
505                                 BezTriple *bezt;
506                                 
507                                 for (bezt=fcu->bezt, i=0; i < fcu->totvert; bezt++, i++) {
508                                         if ((selOnly == 0) || BEZSELECTED(bezt)) {
509                                                 if (bezt->vec[1][1] < yminv)
510                                                         yminv= bezt->vec[1][1];
511                                                 if (bezt->vec[1][1] > ymaxv)
512                                                         ymaxv= bezt->vec[1][1];
513                                         }
514                                 }
515                         }
516                 }
517                 else if (fcu->fpt) {
518                         /* frame range can be directly calculated from end verts */
519                         if (xmin || xmax) {
520                                 xminv= MIN2(xminv, fcu->fpt[0].vec[0]);
521                                 xmaxv= MAX2(xmaxv, fcu->fpt[fcu->totvert-1].vec[0]);
522                         }
523                         
524                         /* only loop over keyframes to find extents for values if needed */
525                         if (ymin || ymax) {
526                                 FPoint *fpt;
527                                 
528                                 for (fpt=fcu->fpt, i=0; i < fcu->totvert; fpt++, i++) {
529                                         if (fpt->vec[1] < yminv)
530                                                 yminv= fpt->vec[1];
531                                         if (fpt->vec[1] > ymaxv)
532                                                 ymaxv= fpt->vec[1];
533                                 }
534                         }
535                 }
536                 
537                 foundvert=1;
538         }
539         
540         if (foundvert) {
541                 if (xmin) *xmin= xminv;
542                 if (xmax) *xmax= xmaxv;
543                 
544                 if (ymin) *ymin= yminv;
545                 if (ymax) *ymax= ymaxv;
546         }
547         else {
548                 if (G.f & G_DEBUG)
549                         printf("F-Curve calc bounds didn't find anything, so assuming minimum bounds of 1.0\n");
550                         
551                 if (xmin) *xmin= 0.0f;
552                 if (xmax) *xmax= 1.0f;
553                 
554                 if (ymin) *ymin= 0.0f;
555                 if (ymax) *ymax= 1.0f;
556         }
557 }
558
559 /* Calculate the extents of F-Curve's keyframes */
560 void calc_fcurve_range (FCurve *fcu, float *start, float *end, const short selOnly)
561 {
562         float min=999999999.0f, max=-999999999.0f;
563         short foundvert=0;
564
565         if (fcu->totvert) {
566                 if (fcu->bezt) {
567                         BezTriple *bezt_first= NULL, *bezt_last= NULL;
568                         
569                         /* get endpoint keyframes */
570                         get_fcurve_end_keyframes(fcu, &bezt_first, &bezt_last, selOnly);
571                         
572                         if (bezt_first) {
573                                 BLI_assert(bezt_last != NULL);
574                                 
575                                 min= MIN2(min, bezt_first->vec[1][0]);
576                                 max= MAX2(max, bezt_last->vec[1][0]);
577                         }
578                 }
579                 else if (fcu->fpt) {
580                         min= MIN2(min, fcu->fpt[0].vec[0]);
581                         max= MAX2(max, fcu->fpt[fcu->totvert-1].vec[0]);
582                 }
583                 
584                 foundvert=1;
585         }
586         
587         /* minimum length is 1 frame */
588         if (foundvert) {
589                 if (min == max) max += 1.0f;
590                 *start= min;
591                 *end= max;
592         }
593         else {
594                 *start= 0.0f;
595                 *end= 1.0f;
596         }
597 }
598
599 /* ----------------- Status Checks -------------------------- */
600
601 /* Are keyframes on F-Curve of any use? 
602  * Usability of keyframes refers to whether they should be displayed,
603  * and also whether they will have any influence on the final result.
604  */
605 short fcurve_are_keyframes_usable (FCurve *fcu)
606 {
607         /* F-Curve must exist */
608         if (fcu == NULL)
609                 return 0;
610                 
611         /* F-Curve must not have samples - samples are mutually exclusive of keyframes */
612         if (fcu->fpt)
613                 return 0;
614         
615         /* if it has modifiers, none of these should "drastically" alter the curve */
616         if (fcu->modifiers.first) {
617                 FModifier *fcm;
618                 
619                 /* check modifiers from last to first, as last will be more influential */
620                 // TODO: optionally, only check modifier if it is the active one...
621                 for (fcm = fcu->modifiers.last; fcm; fcm = fcm->prev) {
622                         /* ignore if muted/disabled */
623                         if (fcm->flag & (FMODIFIER_FLAG_DISABLED|FMODIFIER_FLAG_MUTED))
624                                 continue;
625                                 
626                         /* type checks */
627                         switch (fcm->type) {
628                                 /* clearly harmless - do nothing */
629                                 case FMODIFIER_TYPE_CYCLES:
630                                 case FMODIFIER_TYPE_STEPPED:
631                                 case FMODIFIER_TYPE_NOISE:
632                                         break;
633                                         
634                                 /* sometimes harmful - depending on whether they're "additive" or not */
635                                 case FMODIFIER_TYPE_GENERATOR:
636                                 {
637                                         FMod_Generator *data = (FMod_Generator *)fcm->data;
638                                         
639                                         if ((data->flag & FCM_GENERATOR_ADDITIVE) == 0)
640                                                 return 0;
641                                 }
642                                         break;
643                                 case FMODIFIER_TYPE_FN_GENERATOR:
644                                 {
645                                         FMod_FunctionGenerator *data = (FMod_FunctionGenerator *)fcm->data;
646                                         
647                                         if ((data->flag & FCM_GENERATOR_ADDITIVE) == 0)
648                                                 return 0;
649                                 }
650                                         break;
651                                         
652                                 /* always harmful - cannot allow */
653                                 default:
654                                         return 0;
655                         }
656                 }
657         }
658         
659         /* keyframes are usable */
660         return 1;
661 }
662
663 /* Can keyframes be added to F-Curve? 
664  * Keyframes can only be added if they are already visible
665  */
666 short fcurve_is_keyframable (FCurve *fcu)
667 {
668         /* F-Curve's keyframes must be "usable" (i.e. visible + have an effect on final result) */
669         if (fcurve_are_keyframes_usable(fcu) == 0)
670                 return 0;
671                 
672         /* F-Curve must currently be editable too */
673         if ( (fcu->flag & FCURVE_PROTECTED) || ((fcu->grp) && (fcu->grp->flag & AGRP_PROTECTED)) )
674                 return 0;
675         
676         /* F-Curve is keyframable */
677         return 1;
678 }
679
680 /* ***************************** Keyframe Column Tools ********************************* */
681
682 /* add a BezTriple to a column */
683 void bezt_add_to_cfra_elem (ListBase *lb, BezTriple *bezt)
684 {
685         CfraElem *ce, *cen;
686         
687         for (ce= lb->first; ce; ce= ce->next) {
688                 /* double key? */
689                 if (ce->cfra == bezt->vec[1][0]) {
690                         if (bezt->f2 & SELECT) ce->sel= bezt->f2;
691                         return;
692                 }
693                 /* should key be inserted before this column? */
694                 else if (ce->cfra > bezt->vec[1][0]) break;
695         }
696         
697         /* create a new column */
698         cen= MEM_callocN(sizeof(CfraElem), "add_to_cfra_elem"); 
699         if (ce) BLI_insertlinkbefore(lb, ce, cen);
700         else BLI_addtail(lb, cen);
701
702         cen->cfra= bezt->vec[1][0];
703         cen->sel= bezt->f2;
704 }
705
706 /* ***************************** Samples Utilities ******************************* */
707 /* Some utilities for working with FPoints (i.e. 'sampled' animation curve data, such as
708  * data imported from BVH/Mocap files), which are specialised for use with high density datasets,
709  * which BezTriples/Keyframe data are ill equipped to do.
710  */
711  
712  
713 /* Basic sampling callback which acts as a wrapper for evaluate_fcurve() 
714  *      'data' arg here is unneeded here...
715  */
716 float fcurve_samplingcb_evalcurve (FCurve *fcu, void *UNUSED(data), float evaltime)
717 {
718         /* assume any interference from drivers on the curve is intended... */
719         return evaluate_fcurve(fcu, evaltime);
720
721
722  
723 /* Main API function for creating a set of sampled curve data, given some callback function 
724  * used to retrieve the values to store.
725  */
726 void fcurve_store_samples (FCurve *fcu, void *data, int start, int end, FcuSampleFunc sample_cb)
727 {
728         FPoint *fpt, *new_fpt;
729         int cfra;
730         
731         /* sanity checks */
732         // TODO: make these tests report errors using reports not printf's
733         if ELEM(NULL, fcu, sample_cb) {
734                 printf("Error: No F-Curve with F-Curve Modifiers to Bake\n");
735                 return;
736         }
737         if (start >= end) {
738                 printf("Error: Frame range for Sampled F-Curve creation is inappropriate \n");
739                 return;
740         }
741         
742         /* set up sample data */
743         fpt= new_fpt= MEM_callocN(sizeof(FPoint)*(end-start+1), "FPoint Samples");
744         
745         /* use the sampling callback at 1-frame intervals from start to end frames */
746         for (cfra= start; cfra <= end; cfra++, fpt++) {
747                 fpt->vec[0]= (float)cfra;
748                 fpt->vec[1]= sample_cb(fcu, data, (float)cfra);
749         }
750         
751         /* free any existing sample/keyframe data on curve  */
752         if (fcu->bezt) MEM_freeN(fcu->bezt);
753         if (fcu->fpt) MEM_freeN(fcu->fpt);
754         
755         /* store the samples */
756         fcu->bezt= NULL;
757         fcu->fpt= new_fpt;
758         fcu->totvert= end - start + 1;
759 }
760
761 /* ***************************** F-Curve Sanity ********************************* */
762 /* The functions here are used in various parts of Blender, usually after some editing
763  * of keyframe data has occurred. They ensure that keyframe data is properly ordered and
764  * that the handles are correctly 
765  */
766
767 /* This function recalculates the handles of an F-Curve 
768  * If the BezTriples have been rearranged, sort them first before using this.
769  */
770 void calchandles_fcurve (FCurve *fcu)
771 {
772         BezTriple *bezt, *prev, *next;
773         int a= fcu->totvert;
774
775         /* Error checking:
776          *      - need at least two points
777          *      - need bezier keys
778          *      - only bezier-interpolation has handles (for now)
779          */
780         if (ELEM(NULL, fcu, fcu->bezt) || (a < 2) /*|| ELEM(fcu->ipo, BEZT_IPO_CONST, BEZT_IPO_LIN)*/) 
781                 return;
782         
783         /* get initial pointers */
784         bezt= fcu->bezt;
785         prev= NULL;
786         next= (bezt + 1);
787         
788         /* loop over all beztriples, adjusting handles */
789         while (a--) {
790                 /* clamp timing of handles to be on either side of beztriple */
791                 if (bezt->vec[0][0] > bezt->vec[1][0]) bezt->vec[0][0]= bezt->vec[1][0];
792                 if (bezt->vec[2][0] < bezt->vec[1][0]) bezt->vec[2][0]= bezt->vec[1][0];
793                 
794                 /* calculate auto-handles */
795                 calchandleNurb(bezt, prev, next, 1);    /* 1==special autohandle */
796                 
797                 /* for automatic ease in and out */
798                 if (ELEM(bezt->h1,HD_AUTO,HD_AUTO_ANIM) && ELEM(bezt->h2,HD_AUTO,HD_AUTO_ANIM)) {
799                         /* only do this on first or last beztriple */
800                         if ((a == 0) || (a == fcu->totvert-1)) {
801                                 /* set both handles to have same horizontal value as keyframe */
802                                 if (fcu->extend == FCURVE_EXTRAPOLATE_CONSTANT) {
803                                         bezt->vec[0][1]= bezt->vec[2][1]= bezt->vec[1][1];
804                                 }
805                         }
806                 }
807                 
808                 /* advance pointers for next iteration */
809                 prev= bezt;
810                 if (a == 1) next= NULL;
811                 else next++;
812                 bezt++;
813         }
814 }
815
816 /* Use when F-Curve with handles has changed
817  * It treats all BezTriples with the following rules:
818  *  - PHASE 1: do types have to be altered?
819  *              -> Auto handles: become aligned when selection status is NOT(000 || 111)
820  *              -> Vector handles: become 'nothing' when (one half selected AND other not)
821  *  - PHASE 2: recalculate handles
822 */
823 void testhandles_fcurve (FCurve *fcu)
824 {
825         BezTriple *bezt;
826         unsigned int a;
827
828         /* only beztriples have handles (bpoints don't though) */
829         if ELEM(NULL, fcu, fcu->bezt)
830                 return;
831         
832         /* loop over beztriples */
833         for (a=0, bezt=fcu->bezt; a < fcu->totvert; a++, bezt++) {
834                 short flag= 0;
835                 
836                 /* flag is initialised as selection status
837                  * of beztriple control-points (labelled 0,1,2)
838                  */
839                 if (bezt->f1 & SELECT) flag |= (1<<0); // == 1
840                 if (bezt->f2 & SELECT) flag |= (1<<1); // == 2
841                 if (bezt->f3 & SELECT) flag |= (1<<2); // == 4
842                 
843                 /* one or two handles selected only */
844                 if (ELEM(flag, 0, 7)==0) {
845                         /* auto handles become aligned */
846                         if (ELEM(bezt->h1, HD_AUTO, HD_AUTO_ANIM))
847                                 bezt->h1= HD_ALIGN;
848                         if (ELEM(bezt->h2, HD_AUTO, HD_AUTO_ANIM))
849                                 bezt->h2= HD_ALIGN;
850                         
851                         /* vector handles become 'free' when only one half selected */
852                         if (bezt->h1==HD_VECT) {
853                                 /* only left half (1 or 2 or 1+2) */
854                                 if (flag < 4) 
855                                         bezt->h1= 0;
856                         }
857                         if (bezt->h2==HD_VECT) {
858                                 /* only right half (4 or 2+4) */
859                                 if (flag > 3) 
860                                         bezt->h2= 0;
861                         }
862                 }
863         }
864
865         /* recalculate handles */
866         calchandles_fcurve(fcu);
867 }
868
869 /* This function sorts BezTriples so that they are arranged in chronological order,
870  * as tools working on F-Curves expect that the BezTriples are in order.
871  */
872 void sort_time_fcurve (FCurve *fcu)
873 {
874         short ok= 1;
875         
876         /* keep adjusting order of beztriples until nothing moves (bubble-sort) */
877         while (ok) {
878                 ok= 0;
879                 
880                 /* currently, will only be needed when there are beztriples */
881                 if (fcu->bezt) {
882                         BezTriple *bezt;
883                         unsigned int a;
884                         
885                         /* loop over ALL points to adjust position in array and recalculate handles */
886                         for (a=0, bezt=fcu->bezt; a < fcu->totvert; a++, bezt++) {
887                                 /* check if thee's a next beztriple which we could try to swap with current */
888                                 if (a < (fcu->totvert-1)) {
889                                         /* swap if one is after the other (and indicate that order has changed) */
890                                         if (bezt->vec[1][0] > (bezt+1)->vec[1][0]) {
891                                                 SWAP(BezTriple, *bezt, *(bezt+1));
892                                                 ok= 1;
893                                         }
894                                         
895                                         /* if either one of both of the points exceeds crosses over the keyframe time... */
896                                         if ( (bezt->vec[0][0] > bezt->vec[1][0]) && (bezt->vec[2][0] < bezt->vec[1][0]) ) {
897                                                 /* swap handles if they have switched sides for some reason */
898                                                 SWAP(float, bezt->vec[0][0], bezt->vec[2][0]);
899                                                 SWAP(float, bezt->vec[0][1], bezt->vec[2][1]);
900                                         }
901                                         else {
902                                                 /* clamp handles */
903                                                 if (bezt->vec[0][0] > bezt->vec[1][0]) 
904                                                         bezt->vec[0][0]= bezt->vec[1][0];
905                                                 if (bezt->vec[2][0] < bezt->vec[1][0]) 
906                                                         bezt->vec[2][0]= bezt->vec[1][0];
907                                         }
908                                 }
909                         }
910                 }
911         }
912 }
913
914 /* This function tests if any BezTriples are out of order, thus requiring a sort */
915 short test_time_fcurve (FCurve *fcu)
916 {
917         unsigned int a;
918         
919         /* sanity checks */
920         if (fcu == NULL)
921                 return 0;
922         
923         /* currently, only need to test beztriples */
924         if (fcu->bezt) {
925                 BezTriple *bezt;
926                 
927                 /* loop through all BezTriples, stopping when one exceeds the one after it */
928                 for (a=0, bezt= fcu->bezt; a < (fcu->totvert - 1); a++, bezt++) {
929                         if (bezt->vec[1][0] > (bezt+1)->vec[1][0])
930                                 return 1;
931                 }
932         }
933         else if (fcu->fpt) {
934                 FPoint *fpt;
935                 
936                 /* loop through all FPoints, stopping when one exceeds the one after it */
937                 for (a=0, fpt= fcu->fpt; a < (fcu->totvert - 1); a++, fpt++) {
938                         if (fpt->vec[0] > (fpt+1)->vec[0])
939                                 return 1;
940                 }
941         }
942         
943         /* none need any swapping */
944         return 0;
945 }
946
947 /* ***************************** Drivers ********************************* */
948
949 /* Driver Variables --------------------------- */
950
951 /* TypeInfo for Driver Variables (dvti) */
952 typedef struct DriverVarTypeInfo {
953         /* evaluation callback */
954         float (*get_value)(ChannelDriver *driver, DriverVar *dvar);
955         
956         /* allocation of target slots */
957         int num_targets;                                                /* number of target slots required */
958         const char *target_names[MAX_DRIVER_TARGETS];   /* UI names that should be given to the slots */
959         int target_flags[MAX_DRIVER_TARGETS];   /* flags defining the requirements for each slot */
960 } DriverVarTypeInfo;
961
962 /* Macro to begin definitions */
963 #define BEGIN_DVAR_TYPEDEF(type) \
964         {
965         
966 /* Macro to end definitions */
967 #define END_DVAR_TYPEDEF \
968         }
969
970 /* ......... */
971
972 static ID *dtar_id_ensure_proxy_from(ID *id)
973 {
974         if (id && GS(id->name)==ID_OB && ((Object *)id)->proxy_from)
975                 return (ID *)(((Object *)id)->proxy_from);
976         return id;
977 }
978
979 /* Helper function to obtain a value using RNA from the specified source (for evaluating drivers) */
980 static float dtar_get_prop_val (ChannelDriver *driver, DriverTarget *dtar)
981 {
982         PointerRNA id_ptr, ptr;
983         PropertyRNA *prop;
984         ID *id;
985         int index;
986         float value= 0.0f;
987         
988         /* sanity check */
989         if ELEM(NULL, driver, dtar)
990                 return 0.0f;
991         
992         id= dtar_id_ensure_proxy_from(dtar->id);
993         
994         /* error check for missing pointer... */
995         // TODO: tag the specific target too as having issues
996         if (id == NULL) {
997                 printf("Error: driver has an invalid target to use \n");
998                 if (G.f & G_DEBUG) printf("\tpath = %s\n", dtar->rna_path);
999                 driver->flag |= DRIVER_FLAG_INVALID;
1000                 return 0.0f;
1001         }
1002         
1003         /* get RNA-pointer for the ID-block given in target */
1004         RNA_id_pointer_create(id, &id_ptr);
1005         
1006         /* get property to read from, and get value as appropriate */
1007         if (RNA_path_resolve_full(&id_ptr, dtar->rna_path, &ptr, &prop, &index)) {
1008                 if(RNA_property_array_check(&ptr, prop)) {
1009                         /* array */
1010                         if (index < RNA_property_array_length(&ptr, prop)) {    
1011                                 switch (RNA_property_type(prop)) {
1012                                 case PROP_BOOLEAN:
1013                                         value= (float)RNA_property_boolean_get_index(&ptr, prop, index);
1014                                         break;
1015                                 case PROP_INT:
1016                                         value= (float)RNA_property_int_get_index(&ptr, prop, index);
1017                                         break;
1018                                 case PROP_FLOAT:
1019                                         value= RNA_property_float_get_index(&ptr, prop, index);
1020                                         break;
1021                                 default:
1022                                         break;
1023                                 }
1024                         }
1025                 }
1026                 else {
1027                         /* not an array */
1028                         switch (RNA_property_type(prop)) {
1029                         case PROP_BOOLEAN:
1030                                 value= (float)RNA_property_boolean_get(&ptr, prop);
1031                                 break;
1032                         case PROP_INT:
1033                                 value= (float)RNA_property_int_get(&ptr, prop);
1034                                 break;
1035                         case PROP_FLOAT:
1036                                 value= RNA_property_float_get(&ptr, prop);
1037                                 break;
1038                         case PROP_ENUM:
1039                                 value= (float)RNA_property_enum_get(&ptr, prop);
1040                                 break;
1041                         default:
1042                                 break;
1043                         }
1044                 }
1045
1046         }
1047         else {
1048                 if (G.f & G_DEBUG)
1049                         printf("Driver Evaluation Error: cannot resolve target for %s -> %s \n", id->name, dtar->rna_path);
1050                 
1051                 driver->flag |= DRIVER_FLAG_INVALID;
1052                 return 0.0f;
1053         }
1054         
1055         return value;
1056 }
1057
1058 /* Helper function to obtain a pointer to a Pose Channel (for evaluating drivers) */
1059 static bPoseChannel *dtar_get_pchan_ptr (ChannelDriver *driver, DriverTarget *dtar)
1060 {
1061         ID *id;
1062         /* sanity check */
1063         if ELEM(NULL, driver, dtar)
1064                 return NULL;
1065
1066         id= dtar_id_ensure_proxy_from(dtar->id);
1067
1068         /* check if the ID here is a valid object */
1069         if (id && GS(id->name)) {
1070                 Object *ob= (Object *)id;
1071                 
1072                 /* get pose, and subsequently, posechannel */
1073                 return get_pose_channel(ob->pose, dtar->pchan_name);
1074         }
1075         else {
1076                 /* cannot find a posechannel this way */
1077                 return NULL;
1078         }
1079 }
1080
1081 /* ......... */
1082
1083 /* evaluate 'single prop' driver variable */
1084 static float dvar_eval_singleProp (ChannelDriver *driver, DriverVar *dvar)
1085 {
1086         /* just evaluate the first target slot */
1087         return dtar_get_prop_val(driver, &dvar->targets[0]);
1088 }
1089
1090 /* evaluate 'rotation difference' driver variable */
1091 static float dvar_eval_rotDiff (ChannelDriver *driver, DriverVar *dvar)
1092 {
1093         bPoseChannel *pchan, *pchan2;
1094         float q1[4], q2[4], quat[4], angle;
1095         
1096         /* get pose channels, and check if we've got two */
1097         pchan= dtar_get_pchan_ptr(driver, &dvar->targets[0]);
1098         pchan2= dtar_get_pchan_ptr(driver, &dvar->targets[1]);
1099         
1100         if (ELEM(NULL, pchan, pchan2)) {
1101                 /* disable this driver, since it doesn't work correctly... */
1102                 driver->flag |= DRIVER_FLAG_INVALID;
1103                 
1104                 /* check what the error was */
1105                 if ((pchan == NULL) && (pchan2 == NULL))
1106                         printf("Driver Evaluation Error: Rotational difference failed - first 2 targets invalid \n");
1107                 else if (pchan == NULL)
1108                         printf("Driver Evaluation Error: Rotational difference failed - first target not valid PoseChannel \n");
1109                 else if (pchan2 == NULL)
1110                         printf("Driver Evaluation Error: Rotational difference failed - second target not valid PoseChannel \n");
1111                         
1112                 /* stop here... */
1113                 return 0.0f;
1114         }                       
1115         
1116         /* use the final posed locations */
1117         mat4_to_quat(q1, pchan->pose_mat);
1118         mat4_to_quat(q2, pchan2->pose_mat);
1119         
1120         invert_qt(q1);
1121         mul_qt_qtqt(quat, q1, q2);
1122         angle = 2.0f * (saacos(quat[0]));
1123         angle= ABS(angle);
1124         
1125         return (angle > (float)M_PI) ? (float)((2.0f * (float)M_PI) - angle) : (float)(angle);
1126 }
1127
1128 /* evaluate 'location difference' driver variable */
1129 // TODO: this needs to take into account space conversions...
1130 static float dvar_eval_locDiff (ChannelDriver *driver, DriverVar *dvar)
1131 {
1132         float loc1[3] = {0.0f,0.0f,0.0f};
1133         float loc2[3] = {0.0f,0.0f,0.0f};
1134         
1135         /* get two location values */
1136         // NOTE: for now, these are all just worldspace
1137         DRIVER_TARGETS_USED_LOOPER(dvar)
1138         {
1139                 /* get pointer to loc values to store in */
1140                 Object *ob= (Object *)dtar_id_ensure_proxy_from(dtar->id);
1141                 bPoseChannel *pchan;
1142                 float tmp_loc[3];
1143                 
1144                 /* check if this target has valid data */
1145                 if ((ob == NULL) || (GS(ob->id.name) != ID_OB)) {
1146                         /* invalid target, so will not have enough targets */
1147                         driver->flag |= DRIVER_FLAG_INVALID;
1148                         return 0.0f;
1149                 }
1150                 
1151                 /* try to get posechannel */
1152                 pchan= get_pose_channel(ob->pose, dtar->pchan_name);
1153                 
1154                 /* check if object or bone */
1155                 if (pchan) {
1156                         /* bone */
1157                         if (dtar->flag & DTAR_FLAG_LOCALSPACE) {
1158                                 if (dtar->flag & DTAR_FLAG_LOCAL_CONSTS) {
1159                                         float mat[4][4];
1160                                         
1161                                         /* extract transform just like how the constraints do it! */
1162                                         copy_m4_m4(mat, pchan->pose_mat);
1163                                         constraint_mat_convertspace(ob, pchan, mat, CONSTRAINT_SPACE_POSE, CONSTRAINT_SPACE_LOCAL);
1164                                         
1165                                         /* ... and from that, we get our transform */
1166                                         VECCOPY(tmp_loc, mat[3]);
1167                                 }
1168                                 else {
1169                                         /* transform space (use transform values directly) */
1170                                         VECCOPY(tmp_loc, pchan->loc);
1171                                 }
1172                         }
1173                         else {
1174                                 /* convert to worldspace */
1175                                 VECCOPY(tmp_loc, pchan->pose_head);
1176                                 mul_m4_v3(ob->obmat, tmp_loc);
1177                         }
1178                 }
1179                 else {
1180                         /* object */
1181                         if (dtar->flag & DTAR_FLAG_LOCALSPACE) {
1182                                 if (dtar->flag & DTAR_FLAG_LOCAL_CONSTS) {
1183                                         // XXX: this should practically be the same as transform space...
1184                                         float mat[4][4];
1185                                         
1186                                         /* extract transform just like how the constraints do it! */
1187                                         copy_m4_m4(mat, ob->obmat);
1188                                         constraint_mat_convertspace(ob, NULL, mat, CONSTRAINT_SPACE_WORLD, CONSTRAINT_SPACE_LOCAL);
1189                                         
1190                                         /* ... and from that, we get our transform */
1191                                         VECCOPY(tmp_loc, mat[3]);
1192                                 }
1193                                 else {
1194                                         /* transform space (use transform values directly) */
1195                                         VECCOPY(tmp_loc, ob->loc);
1196                                 }
1197                         }
1198                         else {
1199                                 /* worldspace */
1200                                 VECCOPY(tmp_loc, ob->obmat[3]); 
1201                         }
1202                 }
1203                 
1204                 /* copy the location to the right place */
1205                 if (tarIndex) {
1206                         VECCOPY(loc2, tmp_loc);
1207                 }
1208                 else {
1209                         VECCOPY(loc1, tmp_loc);
1210                 }
1211         }
1212         DRIVER_TARGETS_LOOPER_END
1213         
1214         
1215         /* if we're still here, there should now be two targets to use,
1216          * so just take the length of the vector between these points 
1217          */
1218         return len_v3v3(loc1, loc2);
1219 }
1220
1221 /* evaluate 'transform channel' driver variable */
1222 static float dvar_eval_transChan (ChannelDriver *driver, DriverVar *dvar)
1223 {
1224         DriverTarget *dtar= &dvar->targets[0];
1225         Object *ob= (Object *)dtar_id_ensure_proxy_from(dtar->id);
1226         bPoseChannel *pchan;
1227         float mat[4][4];
1228         float oldEul[3] = {0.0f,0.0f,0.0f};
1229         short useEulers=0, rotOrder=ROT_MODE_EUL;
1230         
1231         /* check if this target has valid data */
1232         if ((ob == NULL) || (GS(ob->id.name) != ID_OB)) {
1233                 /* invalid target, so will not have enough targets */
1234                 driver->flag |= DRIVER_FLAG_INVALID;
1235                 return 0.0f;
1236         }
1237         
1238         /* try to get posechannel */
1239         pchan= get_pose_channel(ob->pose, dtar->pchan_name);
1240         
1241         /* check if object or bone, and get transform matrix accordingly 
1242          *      - "useEulers" code is used to prevent the problems associated with non-uniqueness
1243          *        of euler decomposition from matrices [#20870]
1244          *      - localspace is for [#21384], where parent results are not wanted
1245          *        but local-consts is for all the common "corrective-shapes-for-limbs" situations
1246          */
1247         if (pchan) {
1248                 /* bone */
1249                 if (pchan->rotmode > 0) {
1250                         VECCOPY(oldEul, pchan->eul);
1251                         rotOrder= pchan->rotmode;
1252                         useEulers = 1;
1253                 }
1254                 
1255                 if (dtar->flag & DTAR_FLAG_LOCALSPACE) {
1256                         if (dtar->flag & DTAR_FLAG_LOCAL_CONSTS) {
1257                                 /* just like how the constraints do it! */
1258                                 copy_m4_m4(mat, pchan->pose_mat);
1259                                 constraint_mat_convertspace(ob, pchan, mat, CONSTRAINT_SPACE_POSE, CONSTRAINT_SPACE_LOCAL);
1260                         }
1261                         else {
1262                                 /* specially calculate local matrix, since chan_mat is not valid 
1263                                  * since it stores delta transform of pose_mat so that deforms work
1264                                  * so it cannot be used here for "transform" space
1265                                  */
1266                                 pchan_to_mat4(pchan, mat);
1267                         }
1268                 }
1269                 else {
1270                         /* worldspace matrix */
1271                         mul_m4_m4m4(mat, pchan->pose_mat, ob->obmat);
1272                 }
1273         }
1274         else {
1275                 /* object */
1276                 if (ob->rotmode > 0) {
1277                         VECCOPY(oldEul, ob->rot);
1278                         rotOrder= ob->rotmode;
1279                         useEulers = 1;
1280                 }
1281                 
1282                 if (dtar->flag & DTAR_FLAG_LOCALSPACE) {
1283                         if (dtar->flag & DTAR_FLAG_LOCAL_CONSTS) {
1284                                 /* just like how the constraints do it! */
1285                                 copy_m4_m4(mat, ob->obmat);
1286                                 constraint_mat_convertspace(ob, NULL, mat, CONSTRAINT_SPACE_WORLD, CONSTRAINT_SPACE_LOCAL);
1287                         }
1288                         else {
1289                                 /* transforms to matrix */
1290                                 object_to_mat4(ob, mat);
1291                         }
1292                 }
1293                 else {
1294                         /* worldspace matrix - just the good-old one */
1295                         copy_m4_m4(mat, ob->obmat);
1296                 }
1297         }
1298         
1299         /* check which transform */
1300         if (dtar->transChan >= MAX_DTAR_TRANSCHAN_TYPES) {
1301                 /* not valid channel */
1302                 return 0.0f;
1303         }
1304         else if (dtar->transChan >= DTAR_TRANSCHAN_SCALEX) {
1305                 /* extract scale, and choose the right axis */
1306                 float scale[3];
1307                 
1308                 mat4_to_size(scale, mat);
1309                 return scale[dtar->transChan - DTAR_TRANSCHAN_SCALEX];
1310         }
1311         else if (dtar->transChan >= DTAR_TRANSCHAN_ROTX) {
1312                 /* extract rotation as eulers (if needed) 
1313                  *      - definitely if rotation order isn't eulers already
1314                  *      - if eulers, then we have 2 options:
1315                  *              a) decompose transform matrix as required, then try to make eulers from
1316                  *                 there compatible with original values
1317                  *              b) [NOT USED] directly use the original values (no decomposition) 
1318                  *                      - only an option for "transform space", if quality is really bad with a)
1319                  */
1320                 float eul[3];
1321                 
1322                 mat4_to_eulO(eul, rotOrder, mat);
1323                 
1324                 if (useEulers) {
1325                         compatible_eul(eul, oldEul);
1326                 }
1327                 
1328                 return eul[dtar->transChan - DTAR_TRANSCHAN_ROTX];
1329         }
1330         else {
1331                 /* extract location and choose right axis */
1332                 return mat[3][dtar->transChan];
1333         }
1334 }
1335
1336 /* ......... */
1337
1338 /* Table of Driver Varaiable Type Info Data */
1339 static DriverVarTypeInfo dvar_types[MAX_DVAR_TYPES] = {
1340         BEGIN_DVAR_TYPEDEF(DVAR_TYPE_SINGLE_PROP)
1341                 dvar_eval_singleProp, /* eval callback */
1342                 1, /* number of targets used */
1343                 {"Property"}, /* UI names for targets */
1344                 {0} /* flags */
1345         END_DVAR_TYPEDEF,
1346         
1347         BEGIN_DVAR_TYPEDEF(DVAR_TYPE_ROT_DIFF)
1348                 dvar_eval_rotDiff, /* eval callback */
1349                 2, /* number of targets used */
1350                 {"Bone 1", "Bone 2"}, /* UI names for targets */
1351                 {DTAR_FLAG_STRUCT_REF|DTAR_FLAG_ID_OB_ONLY, DTAR_FLAG_STRUCT_REF|DTAR_FLAG_ID_OB_ONLY} /* flags */
1352         END_DVAR_TYPEDEF,
1353         
1354         BEGIN_DVAR_TYPEDEF(DVAR_TYPE_LOC_DIFF)
1355                 dvar_eval_locDiff, /* eval callback */
1356                 2, /* number of targets used */
1357                 {"Object/Bone 1", "Object/Bone 2"}, /* UI names for targets */
1358                 {DTAR_FLAG_STRUCT_REF|DTAR_FLAG_ID_OB_ONLY, DTAR_FLAG_STRUCT_REF|DTAR_FLAG_ID_OB_ONLY} /* flags */
1359         END_DVAR_TYPEDEF,
1360         
1361         BEGIN_DVAR_TYPEDEF(DVAR_TYPE_TRANSFORM_CHAN)
1362                 dvar_eval_transChan, /* eval callback */
1363                 1, /* number of targets used */
1364                 {"Object/Bone"}, /* UI names for targets */
1365                 {DTAR_FLAG_STRUCT_REF|DTAR_FLAG_ID_OB_ONLY} /* flags */
1366         END_DVAR_TYPEDEF,
1367 };
1368
1369 /* Get driver variable typeinfo */
1370 static DriverVarTypeInfo *get_dvar_typeinfo (int type)
1371 {
1372         /* check if valid type */
1373         if ((type >= 0) && (type < MAX_DVAR_TYPES))
1374                 return &dvar_types[type];
1375         else
1376                 return NULL;
1377 }
1378
1379 /* Driver API --------------------------------- */
1380
1381 /* This frees the driver variable itself */
1382 void driver_free_variable (ChannelDriver *driver, DriverVar *dvar)
1383 {
1384         /* sanity checks */
1385         if (dvar == NULL)
1386                 return;
1387                 
1388         /* free target vars 
1389          *      - need to go over all of them, not just up to the ones that are used
1390          *        currently, since there may be some lingering RNA paths from 
1391          *        previous users needing freeing
1392          */
1393         DRIVER_TARGETS_LOOPER(dvar) 
1394         {
1395                 /* free RNA path if applicable */
1396                 if (dtar->rna_path)
1397                         MEM_freeN(dtar->rna_path);
1398         }
1399         DRIVER_TARGETS_LOOPER_END
1400         
1401         /* remove the variable from the driver */
1402         if (driver)
1403                 BLI_freelinkN(&driver->variables, dvar);
1404         else
1405                 MEM_freeN(dvar);
1406
1407 #ifdef WITH_PYTHON
1408         /* since driver variables are cached, the expression needs re-compiling too */
1409         if(driver->type==DRIVER_TYPE_PYTHON)
1410                 driver->flag |= DRIVER_FLAG_RENAMEVAR;
1411 #endif
1412 }
1413
1414 /* Change the type of driver variable */
1415 void driver_change_variable_type (DriverVar *dvar, int type)
1416 {
1417         DriverVarTypeInfo *dvti= get_dvar_typeinfo(type);
1418         
1419         /* sanity check */
1420         if (ELEM(NULL, dvar, dvti))
1421                 return;
1422                 
1423         /* set the new settings */
1424         dvar->type= type;
1425         dvar->num_targets= dvti->num_targets;
1426         
1427         /* make changes to the targets based on the defines for these types 
1428          * NOTE: only need to make sure the ones we're using here are valid...
1429          */
1430         DRIVER_TARGETS_USED_LOOPER(dvar)
1431         {
1432                 int flags = dvti->target_flags[tarIndex];
1433                 
1434                 /* store the flags */
1435                 dtar->flag = flags;
1436                 
1437                 /* object ID types only, or idtype not yet initialised*/
1438                 if ((flags & DTAR_FLAG_ID_OB_ONLY) || (dtar->idtype == 0))
1439                         dtar->idtype= ID_OB;
1440         }
1441         DRIVER_TARGETS_LOOPER_END
1442 }
1443
1444 /* Add a new driver variable */
1445 DriverVar *driver_add_new_variable (ChannelDriver *driver)
1446 {
1447         DriverVar *dvar;
1448         
1449         /* sanity checks */
1450         if (driver == NULL)
1451                 return NULL;
1452                 
1453         /* make a new variable */
1454         dvar= MEM_callocN(sizeof(DriverVar), "DriverVar");
1455         BLI_addtail(&driver->variables, dvar);
1456         
1457         /* give the variable a 'unique' name */
1458         strcpy(dvar->name, "var");
1459         BLI_uniquename(&driver->variables, dvar, "var", '_', offsetof(DriverVar, name), sizeof(dvar->name));
1460         
1461         /* set the default type to 'single prop' */
1462         driver_change_variable_type(dvar, DVAR_TYPE_SINGLE_PROP);
1463         
1464 #ifdef WITH_PYTHON
1465         /* since driver variables are cached, the expression needs re-compiling too */
1466         if (driver->type==DRIVER_TYPE_PYTHON)
1467                 driver->flag |= DRIVER_FLAG_RENAMEVAR;
1468 #endif
1469
1470         /* return the target */
1471         return dvar;
1472 }
1473
1474 /* This frees the driver itself */
1475 void fcurve_free_driver(FCurve *fcu)
1476 {
1477         ChannelDriver *driver;
1478         DriverVar *dvar, *dvarn;
1479         
1480         /* sanity checks */
1481         if ELEM(NULL, fcu, fcu->driver)
1482                 return;
1483         driver= fcu->driver;
1484         
1485         /* free driver targets */
1486         for (dvar= driver->variables.first; dvar; dvar= dvarn) {
1487                 dvarn= dvar->next;
1488                 driver_free_variable(driver, dvar);
1489         }
1490
1491 #ifdef WITH_PYTHON
1492         /* free compiled driver expression */
1493         if (driver->expr_comp)
1494                 BPY_DECREF(driver->expr_comp);
1495 #endif
1496
1497         /* free driver itself, then set F-Curve's point to this to NULL (as the curve may still be used) */
1498         MEM_freeN(driver);
1499         fcu->driver= NULL;
1500 }
1501
1502 /* This makes a copy of the given driver */
1503 ChannelDriver *fcurve_copy_driver (ChannelDriver *driver)
1504 {
1505         ChannelDriver *ndriver;
1506         DriverVar *dvar;
1507         
1508         /* sanity checks */
1509         if (driver == NULL)
1510                 return NULL;
1511                 
1512         /* copy all data */
1513         ndriver= MEM_dupallocN(driver);
1514         ndriver->expr_comp= NULL;
1515         
1516         /* copy variables */
1517         ndriver->variables.first= ndriver->variables.last= NULL;
1518         BLI_duplicatelist(&ndriver->variables, &driver->variables);
1519         
1520         for (dvar= ndriver->variables.first; dvar; dvar= dvar->next) {  
1521                 /* need to go over all targets so that we don't leave any dangling paths */
1522                 DRIVER_TARGETS_LOOPER(dvar) 
1523                 {       
1524                         /* make a copy of target's rna path if available */
1525                         if (dtar->rna_path)
1526                                 dtar->rna_path = MEM_dupallocN(dtar->rna_path);
1527                 }
1528                 DRIVER_TARGETS_LOOPER_END
1529         }
1530         
1531         /* return the new driver */
1532         return ndriver;
1533 }
1534
1535 /* Driver Evaluation -------------------------- */
1536
1537 /* Evaluate a Driver Variable to get a value that contributes to the final */
1538 float driver_get_variable_value (ChannelDriver *driver, DriverVar *dvar)
1539 {
1540         DriverVarTypeInfo *dvti;
1541
1542         /* sanity check */
1543         if (ELEM(NULL, driver, dvar))
1544                 return 0.0f;
1545         
1546         /* call the relevant callbacks to get the variable value 
1547          * using the variable type info, storing the obtained value
1548          * in dvar->curval so that drivers can be debugged
1549          */
1550         dvti= get_dvar_typeinfo(dvar->type);
1551         
1552         if (dvti && dvti->get_value)
1553                 dvar->curval= dvti->get_value(driver, dvar);
1554         else
1555                 dvar->curval= 0.0f;
1556         
1557         return dvar->curval;
1558 }
1559
1560 /* Evaluate an Channel-Driver to get a 'time' value to use instead of "evaltime"
1561  *      - "evaltime" is the frame at which F-Curve is being evaluated
1562  *      - has to return a float value 
1563  */
1564 static float evaluate_driver (ChannelDriver *driver, float UNUSED(evaltime))
1565 {
1566         DriverVar *dvar;
1567         
1568         /* check if driver can be evaluated */
1569         if (driver->flag & DRIVER_FLAG_INVALID)
1570                 return 0.0f;
1571         
1572         switch (driver->type) {
1573                 case DRIVER_TYPE_AVERAGE: /* average values of driver targets */
1574                 case DRIVER_TYPE_SUM: /* sum values of driver targets */
1575                 {
1576                         /* check how many variables there are first (i.e. just one?) */
1577                         if (driver->variables.first == driver->variables.last) {
1578                                 /* just one target, so just use that */
1579                                 dvar= driver->variables.first;
1580                                 driver->curval= driver_get_variable_value(driver, dvar);
1581                         }
1582                         else {
1583                                 /* more than one target, so average the values of the targets */
1584                                 float value = 0.0f;
1585                                 int tot = 0;
1586                                 
1587                                 /* loop through targets, adding (hopefully we don't get any overflow!) */
1588                                 for (dvar= driver->variables.first; dvar; dvar=dvar->next) {
1589                                         value += driver_get_variable_value(driver, dvar);
1590                                         tot++;
1591                                 }
1592                                 
1593                                 /* perform operations on the total if appropriate */
1594                                 if (driver->type == DRIVER_TYPE_AVERAGE)
1595                                         driver->curval= (value / (float)tot);
1596                                 else
1597                                         driver->curval= value;
1598                         }
1599                 }
1600                         break;
1601                         
1602                 case DRIVER_TYPE_MIN: /* smallest value */
1603                 case DRIVER_TYPE_MAX: /* largest value */
1604                 {
1605                         float value = 0.0f;
1606                         
1607                         /* loop through the variables, getting the values and comparing them to existing ones */
1608                         for (dvar= driver->variables.first; dvar; dvar= dvar->next) {
1609                                 /* get value */
1610                                 float tmp_val= driver_get_variable_value(driver, dvar);
1611                                 
1612                                 /* store this value if appropriate */
1613                                 if (dvar->prev) {
1614                                         /* check if greater/smaller than the baseline */
1615                                         if (driver->type == DRIVER_TYPE_MAX) {
1616                                                 /* max? */
1617                                                 if (tmp_val > value) 
1618                                                         value= tmp_val;
1619                                         }
1620                                         else {
1621                                                 /* min? */
1622                                                 if (tmp_val < value) 
1623                                                         value= tmp_val;
1624                                         }
1625                                 }
1626                                 else {
1627                                         /* first item - make this the baseline for comparisons */
1628                                         value= tmp_val;
1629                                 }
1630                         }
1631                         
1632                         /* store value in driver */
1633                         driver->curval= value;
1634                 }
1635                         break;
1636                         
1637                 case DRIVER_TYPE_PYTHON: /* expression */
1638                 {
1639 #ifdef WITH_PYTHON
1640                         /* check for empty or invalid expression */
1641                         if ( (driver->expression[0] == '\0') ||
1642                                  (driver->flag & DRIVER_FLAG_INVALID) )
1643                         {
1644                                 driver->curval= 0.0f;
1645                         }
1646                         else
1647                         {
1648                                 /* this evaluates the expression using Python,and returns its result:
1649                                  *      - on errors it reports, then returns 0.0f
1650                                  */
1651                                 driver->curval= BPY_driver_exec(driver);
1652                         }
1653 #endif /* WITH_PYTHON*/
1654                 }
1655                         break;
1656                 
1657                 default:
1658                 {
1659                         /* special 'hack' - just use stored value 
1660                          *      This is currently used as the mechanism which allows animated settings to be able
1661                          *      to be changed via the UI.
1662                          */
1663                 }
1664         }
1665         
1666         /* return value for driver */
1667         return driver->curval;
1668 }
1669
1670 /* ***************************** Curve Calculations ********************************* */
1671
1672 /* The total length of the handles is not allowed to be more
1673  * than the horizontal distance between (v1-v4).
1674  * This is to prevent curve loops.
1675 */
1676 void correct_bezpart (float *v1, float *v2, float *v3, float *v4)
1677 {
1678         float h1[2], h2[2], len1, len2, len, fac;
1679         
1680         /* calculate handle deltas */
1681         h1[0]= v1[0] - v2[0];
1682         h1[1]= v1[1] - v2[1];
1683         
1684         h2[0]= v4[0] - v3[0];
1685         h2[1]= v4[1] - v3[1];
1686         
1687         /* calculate distances: 
1688          *      - len   = span of time between keyframes 
1689          *      - len1  = length of handle of start key
1690          *      - len2  = length of handle of end key
1691          */
1692         len= v4[0]- v1[0];
1693         len1= (float)fabs(h1[0]);
1694         len2= (float)fabs(h2[0]);
1695         
1696         /* if the handles have no length, no need to do any corrections */
1697         if ((len1+len2) == 0.0f) 
1698                 return;
1699                 
1700         /* the two handles cross over each other, so force them
1701          * apart using the proportion they overlap 
1702          */
1703         if ((len1+len2) > len) {
1704                 fac= len / (len1+len2);
1705                 
1706                 v2[0]= (v1[0] - fac*h1[0]);
1707                 v2[1]= (v1[1] - fac*h1[1]);
1708                 
1709                 v3[0]= (v4[0] - fac*h2[0]);
1710                 v3[1]= (v4[1] - fac*h2[1]);
1711         }
1712 }
1713
1714 /* find root ('zero') */
1715 static int findzero (float x, float q0, float q1, float q2, float q3, float *o)
1716 {
1717         double c0, c1, c2, c3, a, b, c, p, q, d, t, phi;
1718         int nr= 0;
1719
1720         c0= q0 - x;
1721         c1= 3.0f * (q1 - q0);
1722         c2= 3.0f * (q0 - 2.0f*q1 + q2);
1723         c3= q3 - q0 + 3.0f * (q1 - q2);
1724         
1725         if (c3 != 0.0) {
1726                 a= c2/c3;
1727                 b= c1/c3;
1728                 c= c0/c3;
1729                 a= a/3;
1730                 
1731                 p= b/3 - a*a;
1732                 q= (2*a*a*a - a*b + c) / 2;
1733                 d= q*q + p*p*p;
1734                 
1735                 if (d > 0.0) {
1736                         t= sqrt(d);
1737                         o[0]= (float)(sqrt3d(-q+t) + sqrt3d(-q-t) - a);
1738                         
1739                         if ((o[0] >= (float)SMALL) && (o[0] <= 1.000001f)) return 1;
1740                         else return 0;
1741                 }
1742                 else if (d == 0.0) {
1743                         t= sqrt3d(-q);
1744                         o[0]= (float)(2*t - a);
1745                         
1746                         if ((o[0] >= (float)SMALL) && (o[0] <= 1.000001f)) nr++;
1747                         o[nr]= (float)(-t-a);
1748                         
1749                         if ((o[nr] >= (float)SMALL) && (o[nr] <= 1.000001f)) return nr+1;
1750                         else return nr;
1751                 }
1752                 else {
1753                         phi= acos(-q / sqrt(-(p*p*p)));
1754                         t= sqrt(-p);
1755                         p= cos(phi/3);
1756                         q= sqrt(3 - 3*p*p);
1757                         o[0]= (float)(2*t*p - a);
1758                         
1759                         if ((o[0] >= (float)SMALL) && (o[0] <= 1.000001f)) nr++;
1760                         o[nr]= (float)(-t * (p + q) - a);
1761                         
1762                         if ((o[nr] >= (float)SMALL) && (o[nr] <= 1.000001f)) nr++;
1763                         o[nr]= (float)(-t * (p - q) - a);
1764                         
1765                         if ((o[nr] >= (float)SMALL) && (o[nr] <= 1.000001f)) return nr+1;
1766                         else return nr;
1767                 }
1768         }
1769         else {
1770                 a=c2;
1771                 b=c1;
1772                 c=c0;
1773                 
1774                 if (a != 0.0) {
1775                         // discriminant
1776                         p= b*b - 4*a*c;
1777                         
1778                         if (p > 0) {
1779                                 p= sqrt(p);
1780                                 o[0]= (float)((-b-p) / (2 * a));
1781                                 
1782                                 if ((o[0] >= (float)SMALL) && (o[0] <= 1.000001f)) nr++;
1783                                 o[nr]= (float)((-b+p)/(2*a));
1784                                 
1785                                 if ((o[nr] >= (float)SMALL) && (o[nr] <= 1.000001f)) return nr+1;
1786                                 else return nr;
1787                         }
1788                         else if (p == 0) {
1789                                 o[0]= (float)(-b / (2 * a));
1790                                 if ((o[0] >= (float)SMALL) && (o[0] <= 1.000001f)) return 1;
1791                                 else return 0;
1792                         }
1793                 }
1794                 else if (b != 0.0) {
1795                         o[0]= (float)(-c/b);
1796                         
1797                         if ((o[0] >= (float)SMALL) && (o[0] <= 1.000001f)) return 1;
1798                         else return 0;
1799                 }
1800                 else if (c == 0.0) {
1801                         o[0]= 0.0;
1802                         return 1;
1803                 }
1804                 
1805                 return 0;       
1806         }
1807 }
1808
1809 static void berekeny (float f1, float f2, float f3, float f4, float *o, int b)
1810 {
1811         float t, c0, c1, c2, c3;
1812         int a;
1813
1814         c0= f1;
1815         c1= 3.0f * (f2 - f1);
1816         c2= 3.0f * (f1 - 2.0f*f2 + f3);
1817         c3= f4 - f1 + 3.0f * (f2 - f3);
1818         
1819         for (a=0; a < b; a++) {
1820                 t= o[a];
1821                 o[a]= c0 + t*c1 + t*t*c2 + t*t*t*c3;
1822         }
1823 }
1824
1825 #if 0
1826 static void berekenx (float *f, float *o, int b)
1827 {
1828         float t, c0, c1, c2, c3;
1829         int a;
1830
1831         c0= f[0];
1832         c1= 3.0f * (f[3] - f[0]);
1833         c2= 3.0f * (f[0] - 2.0f*f[3] + f[6]);
1834         c3= f[9] - f[0] + 3.0f * (f[3] - f[6]);
1835         
1836         for (a=0; a < b; a++) {
1837                 t= o[a];
1838                 o[a]= c0 + t*c1 + t*t*c2 + t*t*t*c3;
1839         }
1840 }
1841 #endif
1842
1843
1844 /* -------------------------- */
1845
1846 /* Calculate F-Curve value for 'evaltime' using BezTriple keyframes */
1847 static float fcurve_eval_keyframes (FCurve *fcu, BezTriple *bezts, float evaltime)
1848 {
1849         BezTriple *bezt, *prevbezt, *lastbezt;
1850         float v1[2], v2[2], v3[2], v4[2], opl[32], dx, fac;
1851         unsigned int a;
1852         int b;
1853         float cvalue = 0.0f;
1854         
1855         /* get pointers */
1856         a= fcu->totvert-1;
1857         prevbezt= bezts;
1858         bezt= prevbezt+1;
1859         lastbezt= prevbezt + a;
1860         
1861         /* evaluation time at or past endpoints? */
1862         if (prevbezt->vec[1][0] >= evaltime) 
1863         {
1864                 /* before or on first keyframe */
1865                 if ( (fcu->extend == FCURVE_EXTRAPOLATE_LINEAR) && (prevbezt->ipo != BEZT_IPO_CONST) &&
1866                         !(fcu->flag & FCURVE_DISCRETE_VALUES) ) 
1867                 {
1868                         /* linear or bezier interpolation */
1869                         if (prevbezt->ipo==BEZT_IPO_LIN) 
1870                         {
1871                                 /* Use the next center point instead of our own handle for
1872                                  * linear interpolated extrapolate 
1873                                  */
1874                                 if (fcu->totvert == 1) 
1875                                         cvalue= prevbezt->vec[1][1];
1876                                 else 
1877                                 {
1878                                         bezt = prevbezt+1;
1879                                         dx= prevbezt->vec[1][0] - evaltime;
1880                                         fac= bezt->vec[1][0] - prevbezt->vec[1][0];
1881                                         
1882                                         /* prevent division by zero */
1883                                         if (fac) {
1884                                                 fac= (bezt->vec[1][1] - prevbezt->vec[1][1]) / fac;
1885                                                 cvalue= prevbezt->vec[1][1] - (fac * dx);
1886                                         }
1887                                         else 
1888                                                 cvalue= prevbezt->vec[1][1];
1889                                 }
1890                         } 
1891                         else 
1892                         {
1893                                 /* Use the first handle (earlier) of first BezTriple to calculate the
1894                                  * gradient and thus the value of the curve at evaltime
1895                                  */
1896                                 dx= prevbezt->vec[1][0] - evaltime;
1897                                 fac= prevbezt->vec[1][0] - prevbezt->vec[0][0];
1898                                 
1899                                 /* prevent division by zero */
1900                                 if (fac) {
1901                                         fac= (prevbezt->vec[1][1] - prevbezt->vec[0][1]) / fac;
1902                                         cvalue= prevbezt->vec[1][1] - (fac * dx);
1903                                 }
1904                                 else 
1905                                         cvalue= prevbezt->vec[1][1];
1906                         }
1907                 }
1908                 else 
1909                 {
1910                         /* constant (BEZT_IPO_HORIZ) extrapolation or constant interpolation, 
1911                          * so just extend first keyframe's value 
1912                          */
1913                         cvalue= prevbezt->vec[1][1];
1914                 }
1915         }
1916         else if (lastbezt->vec[1][0] <= evaltime) 
1917         {
1918                 /* after or on last keyframe */
1919                 if ( (fcu->extend == FCURVE_EXTRAPOLATE_LINEAR) && (lastbezt->ipo != BEZT_IPO_CONST) &&
1920                         !(fcu->flag & FCURVE_DISCRETE_VALUES) ) 
1921                 {
1922                         /* linear or bezier interpolation */
1923                         if (lastbezt->ipo==BEZT_IPO_LIN) 
1924                         {
1925                                 /* Use the next center point instead of our own handle for
1926                                  * linear interpolated extrapolate 
1927                                  */
1928                                 if (fcu->totvert == 1) 
1929                                         cvalue= lastbezt->vec[1][1];
1930                                 else 
1931                                 {
1932                                         prevbezt = lastbezt - 1;
1933                                         dx= evaltime - lastbezt->vec[1][0];
1934                                         fac= lastbezt->vec[1][0] - prevbezt->vec[1][0];
1935                                         
1936                                         /* prevent division by zero */
1937                                         if (fac) {
1938                                                 fac= (lastbezt->vec[1][1] - prevbezt->vec[1][1]) / fac;
1939                                                 cvalue= lastbezt->vec[1][1] + (fac * dx);
1940                                         }
1941                                         else 
1942                                                 cvalue= lastbezt->vec[1][1];
1943                                 }
1944                         } 
1945                         else 
1946                         {
1947                                 /* Use the gradient of the second handle (later) of last BezTriple to calculate the
1948                                  * gradient and thus the value of the curve at evaltime
1949                                  */
1950                                 dx= evaltime - lastbezt->vec[1][0];
1951                                 fac= lastbezt->vec[2][0] - lastbezt->vec[1][0];
1952                                 
1953                                 /* prevent division by zero */
1954                                 if (fac) {
1955                                         fac= (lastbezt->vec[2][1] - lastbezt->vec[1][1]) / fac;
1956                                         cvalue= lastbezt->vec[1][1] + (fac * dx);
1957                                 }
1958                                 else 
1959                                         cvalue= lastbezt->vec[1][1];
1960                         }
1961                 }
1962                 else 
1963                 {
1964                         /* constant (BEZT_IPO_HORIZ) extrapolation or constant interpolation, 
1965                          * so just extend last keyframe's value 
1966                          */
1967                         cvalue= lastbezt->vec[1][1];
1968                 }
1969         }
1970         else 
1971         {
1972                 /* evaltime occurs somewhere in the middle of the curve */
1973                 for (a=0; prevbezt && bezt && (a < fcu->totvert-1); a++, prevbezt=bezt, bezt++) 
1974                 {
1975                         /* use if the key is directly on the frame, rare cases this is needed else we get 0.0 instead. */
1976                         if(fabs(bezt->vec[1][0] - evaltime) < SMALL_NUMBER) {
1977                                 cvalue= bezt->vec[1][1];
1978                         }
1979                         /* evaltime occurs within the interval defined by these two keyframes */
1980                         else if ((prevbezt->vec[1][0] <= evaltime) && (bezt->vec[1][0] >= evaltime))
1981                         {
1982                                 /* value depends on interpolation mode */
1983                                 if ((prevbezt->ipo == BEZT_IPO_CONST) || (fcu->flag & FCURVE_DISCRETE_VALUES))
1984                                 {
1985                                         /* constant (evaltime not relevant, so no interpolation needed) */
1986                                         cvalue= prevbezt->vec[1][1];
1987                                 }
1988                                 else if (prevbezt->ipo == BEZT_IPO_LIN) 
1989                                 {
1990                                         /* linear - interpolate between values of the two keyframes */
1991                                         fac= bezt->vec[1][0] - prevbezt->vec[1][0];
1992                                         
1993                                         /* prevent division by zero */
1994                                         if (fac) {
1995                                                 fac= (evaltime - prevbezt->vec[1][0]) / fac;
1996                                                 cvalue= prevbezt->vec[1][1] + (fac * (bezt->vec[1][1] - prevbezt->vec[1][1]));
1997                                         }
1998                                         else
1999                                                 cvalue= prevbezt->vec[1][1];
2000                                 }
2001                                 else 
2002                                 {
2003                                         /* bezier interpolation */
2004                                                 /* v1,v2 are the first keyframe and its 2nd handle */
2005                                         v1[0]= prevbezt->vec[1][0];
2006                                         v1[1]= prevbezt->vec[1][1];
2007                                         v2[0]= prevbezt->vec[2][0];
2008                                         v2[1]= prevbezt->vec[2][1];
2009                                                 /* v3,v4 are the last keyframe's 1st handle + the last keyframe */
2010                                         v3[0]= bezt->vec[0][0];
2011                                         v3[1]= bezt->vec[0][1];
2012                                         v4[0]= bezt->vec[1][0];
2013                                         v4[1]= bezt->vec[1][1];
2014                                         
2015                                         /* adjust handles so that they don't overlap (forming a loop) */
2016                                         correct_bezpart(v1, v2, v3, v4);
2017                                         
2018                                         /* try to get a value for this position - if failure, try another set of points */
2019                                         b= findzero(evaltime, v1[0], v2[0], v3[0], v4[0], opl);
2020                                         if (b) {
2021                                                 berekeny(v1[1], v2[1], v3[1], v4[1], opl, 1);
2022                                                 cvalue= opl[0];
2023                                                 break;
2024                                         }
2025                                 }
2026                         }
2027                 }
2028         }
2029         
2030         /* return value */
2031         return cvalue;
2032 }
2033
2034 /* Calculate F-Curve value for 'evaltime' using FPoint samples */
2035 static float fcurve_eval_samples (FCurve *fcu, FPoint *fpts, float evaltime)
2036 {
2037         FPoint *prevfpt, *lastfpt, *fpt;
2038         float cvalue= 0.0f;
2039         
2040         /* get pointers */
2041         prevfpt= fpts;
2042         lastfpt= prevfpt + fcu->totvert-1;
2043         
2044         /* evaluation time at or past endpoints? */
2045         if (prevfpt->vec[0] >= evaltime) {
2046                 /* before or on first sample, so just extend value */
2047                 cvalue= prevfpt->vec[1];
2048         }
2049         else if (lastfpt->vec[0] <= evaltime) {
2050                 /* after or on last sample, so just extend value */
2051                 cvalue= lastfpt->vec[1];
2052         }
2053         else {
2054                 float t= (float)abs(evaltime - (int)evaltime);
2055                 
2056                 /* find the one on the right frame (assume that these are spaced on 1-frame intervals) */
2057                 fpt= prevfpt + (int)(evaltime - prevfpt->vec[0]);
2058                 
2059                 /* if not exactly on the frame, perform linear interpolation with the next one */
2060                 if (t != 0.0f) 
2061                         cvalue= interpf(fpt->vec[1], (fpt+1)->vec[1], t);
2062                 else
2063                         cvalue= fpt->vec[1];
2064         }
2065         
2066         /* return value */
2067         return cvalue;
2068 }
2069
2070 /* ***************************** F-Curve - Evaluation ********************************* */
2071
2072 /* Evaluate and return the value of the given F-Curve at the specified frame ("evaltime") 
2073  * Note: this is also used for drivers
2074  */
2075 float evaluate_fcurve (FCurve *fcu, float evaltime) 
2076 {
2077         float cvalue= 0.0f;
2078         float devaltime;
2079         
2080         /* if there is a driver (only if this F-Curve is acting as 'driver'), evaluate it to find value to use as "evaltime" 
2081          * since drivers essentially act as alternative input (i.e. in place of 'time') for F-Curves
2082          *      - this value will also be returned as the value of the 'curve', if there are no keyframes
2083          */
2084         if (fcu->driver) {
2085                 /* evaltime now serves as input for the curve */
2086                 evaltime= cvalue= evaluate_driver(fcu->driver, evaltime);
2087         }
2088         
2089         /* evaluate modifiers which modify time to evaluate the base curve at */
2090         devaltime= evaluate_time_fmodifiers(&fcu->modifiers, fcu, cvalue, evaltime);
2091         
2092         /* evaluate curve-data 
2093          *      - 'devaltime' instead of 'evaltime', as this is the time that the last time-modifying 
2094          *        F-Curve modifier on the stack requested the curve to be evaluated at
2095          */
2096         if (fcu->bezt)
2097                 cvalue= fcurve_eval_keyframes(fcu, fcu->bezt, devaltime);
2098         else if (fcu->fpt)
2099                 cvalue= fcurve_eval_samples(fcu, fcu->fpt, devaltime);
2100         
2101         /* evaluate modifiers */
2102         evaluate_value_fmodifiers(&fcu->modifiers, fcu, &cvalue, evaltime);
2103         
2104         /* if curve can only have integral values, perform truncation (i.e. drop the decimal part)
2105          * here so that the curve can be sampled correctly
2106          */
2107         if (fcu->flag & FCURVE_INT_VALUES)
2108                 cvalue= floorf(cvalue + 0.5f);
2109         
2110         /* return evaluated value */
2111         return cvalue;
2112 }
2113
2114 /* Calculate the value of the given F-Curve at the given frame, and set its curval */
2115 void calculate_fcurve (FCurve *fcu, float ctime)
2116 {
2117         /* only calculate + set curval (overriding the existing value) if curve has 
2118          * any data which warrants this...
2119          */
2120         if ( (fcu->totvert) || (fcu->driver && !(fcu->driver->flag & DRIVER_FLAG_INVALID)) ||
2121                  list_has_suitable_fmodifier(&fcu->modifiers, 0, FMI_TYPE_GENERATE_CURVE) )
2122         {
2123                 /* calculate and set curval (evaluates driver too if necessary) */
2124                 fcu->curval= evaluate_fcurve(fcu, ctime);
2125         }
2126 }
2127