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