Undo revision 23130 which was a merge with 2.5, a messy one because I did something...
[blender.git] / source / blender / blenkernel / intern / anim_sys.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 #include <stdio.h>
31 #include <string.h>
32 #include <stddef.h>
33 #include <float.h>
34 #include <math.h>
35
36 #include "MEM_guardedalloc.h"
37
38 #include "BLI_blenlib.h"
39 #include "BLI_arithb.h"
40 #include "BLI_dynstr.h"
41
42 #include "DNA_anim_types.h"
43
44 #include "BKE_animsys.h"
45 #include "BKE_action.h"
46 #include "BKE_fcurve.h"
47 #include "BKE_nla.h"
48 #include "BKE_global.h"
49 #include "BKE_main.h"
50 #include "BKE_utildefines.h"
51
52 #include "RNA_access.h"
53 #include "RNA_types.h"
54
55 #include "nla_private.h"
56
57 /* ***************************************** */
58 /* AnimData API */
59
60 /* Getter/Setter -------------------------------------------- */
61
62 /* Internal utility to check if ID can have AnimData */
63 static short id_has_animdata (ID *id)
64 {
65         /* sanity check */
66         if (id == NULL)
67                 return 0;
68                 
69         /* Only some ID-blocks have this info for now */
70         // TODO: finish adding this for the other blocktypes
71         switch (GS(id->name)) {
72                         /* has AnimData */
73                 case ID_OB:
74                 case ID_MB: case ID_CU:
75                 case ID_KE:
76                 case ID_PA:
77                 case ID_MA: case ID_TE: case ID_NT:
78                 case ID_LA: case ID_CA: case ID_WO:
79                 case ID_SCE:
80                 {
81                         return 1;
82                 }
83                 
84                         /* no AnimData */
85                 default:
86                         return 0;
87         }
88 }
89
90
91 /* Get AnimData from the given ID-block. In order for this to work, we assume that 
92  * the AnimData pointer is stored immediately after the given ID-block in the struct,
93  * as per IdAdtTemplate.
94  */
95 AnimData *BKE_animdata_from_id (ID *id)
96 {
97         /* only some ID-blocks have this info for now, so we cast the 
98          * types that do to be of type IdAdtTemplate, and extract the
99          * AnimData that way
100          */
101         if (id_has_animdata(id)) {
102                 IdAdtTemplate *iat= (IdAdtTemplate *)id;
103                 return iat->adt;
104         }
105         else
106                 return NULL;
107 }
108
109 /* Add AnimData to the given ID-block. In order for this to work, we assume that 
110  * the AnimData pointer is stored immediately after the given ID-block in the struct,
111  * as per IdAdtTemplate. Also note that 
112  */
113 AnimData *BKE_id_add_animdata (ID *id)
114 {
115         /* Only some ID-blocks have this info for now, so we cast the 
116          * types that do to be of type IdAdtTemplate, and add the AnimData
117          * to it using the template
118          */
119         if (id_has_animdata(id)) {
120                 IdAdtTemplate *iat= (IdAdtTemplate *)id;
121                 
122                 /* check if there's already AnimData, in which case, don't add */
123                 if (iat->adt == NULL) {
124                         AnimData *adt;
125                         
126                         /* add animdata */
127                         adt= iat->adt= MEM_callocN(sizeof(AnimData), "AnimData");
128                         
129                         /* set default settings */
130                         adt->act_influence= 1.0f;
131                 }
132                 
133                 return iat->adt;
134         }
135         else 
136                 return NULL;
137 }
138
139 /* Freeing -------------------------------------------- */
140
141 /* Free AnimData used by the nominated ID-block, and clear ID-block's AnimData pointer */
142 void BKE_free_animdata (ID *id)
143 {
144         /* Only some ID-blocks have this info for now, so we cast the 
145          * types that do to be of type IdAdtTemplate
146          */
147         if (id_has_animdata(id)) {
148                 IdAdtTemplate *iat= (IdAdtTemplate *)id;
149                 AnimData *adt= iat->adt;
150                 
151                 /* check if there's any AnimData to start with */
152                 if (adt) {
153                         /* unlink action (don't free, as it's in its own list) */
154                         if (adt->action)
155                                 adt->action->id.us--;
156                         /* same goes for the temporarily displaced action */
157                         if (adt->tmpact)
158                                 adt->tmpact->id.us--;
159                                 
160                         /* free nla data */
161                         free_nladata(&adt->nla_tracks);
162                         
163                         /* free drivers - stored as a list of F-Curves */
164                         free_fcurves(&adt->drivers);
165                         
166                         /* free overrides */
167                         // TODO...
168                         
169                         /* free animdata now */
170                         MEM_freeN(adt);
171                         iat->adt= NULL;
172                 }
173         }
174 }
175
176 /* Freeing -------------------------------------------- */
177
178 /* Make a copy of the given AnimData - to be used when copying datablocks */
179 AnimData *BKE_copy_animdata (AnimData *adt)
180 {
181         AnimData *dadt;
182         
183         /* sanity check before duplicating struct */
184         if (adt == NULL)
185                 return NULL;
186         dadt= MEM_dupallocN(adt);
187         
188         /* make a copy of action - at worst, user has to delete copies... */
189         // XXX review this... it might not be optimal behaviour yet...
190         //id_us_plus((ID *)dadt->action);
191         dadt->action= copy_action(adt->action);
192         dadt->tmpact= copy_action(adt->tmpact);
193         
194         /* duplicate NLA data */
195         copy_nladata(&dadt->nla_tracks, &adt->nla_tracks);
196         
197         /* duplicate drivers (F-Curves) */
198         copy_fcurves(&dadt->drivers, &adt->drivers);
199         
200         /* don't copy overrides */
201         dadt->overrides.first= dadt->overrides.last= NULL;
202         
203         /* return */
204         return dadt;
205 }
206
207 /* *********************************** */ 
208 /* KeyingSet API */
209
210 /* NOTES:
211  * It is very likely that there will be two copies of the api - one for internal use,
212  * and one 'operator' based wrapper of the internal API, which should allow for access
213  * from Python/scripts so that riggers can automate the creation of KeyingSets for their rigs.
214  */
215
216 /* Finding Tools --------------------------- */
217
218 /* Find the first path that matches the given criteria */
219 // TODO: do we want some method to perform partial matches too?
220 KS_Path *BKE_keyingset_find_destination (KeyingSet *ks, ID *id, const char group_name[], const char rna_path[], int array_index, int group_mode)
221 {
222         KS_Path *ksp;
223         
224         /* sanity checks */
225         if ELEM(NULL, ks, rna_path)
226                 return NULL;
227         
228         /* ID is optional for relative KeyingSets, but is necessary for absolute KeyingSets */
229         if (id == NULL) {
230                 if (ks->flag & KEYINGSET_ABSOLUTE)
231                         return NULL;
232         }
233         
234         /* loop over paths in the current KeyingSet, finding the first one where all settings match 
235          * (i.e. the first one where none of the checks fail and equal 0)
236          */
237         for (ksp= ks->paths.first; ksp; ksp= ksp->next) {
238                 short eq_id=1, eq_path=1, eq_index=1, eq_group=1;
239                 
240                 /* id */
241                 if ((ks->flag & KEYINGSET_ABSOLUTE) && (id != ksp->id))
242                         eq_id= 0;
243                 
244                 /* path */
245                 if ((ksp->rna_path==0) || strcmp(rna_path, ksp->rna_path))
246                         eq_path= 0;
247                         
248                 /* index */
249                 if (ksp->array_index != array_index)
250                         eq_index= 0;
251                         
252                 /* group */
253                 if (group_name) {
254                         // FIXME: these checks need to be coded... for now, it's not too important though
255                 }
256                         
257                 /* if all aspects are ok, return */
258                 if (eq_id && eq_path && eq_index && eq_group)
259                         return ksp;
260         }
261         
262         /* none found */
263         return NULL;
264 }
265  
266 /* Defining Tools --------------------------- */
267
268 /* Used to create a new 'custom' KeyingSet for the user, that will be automatically added to the stack */
269 KeyingSet *BKE_keyingset_add (ListBase *list, const char name[], short flag, short keyingflag)
270 {
271         KeyingSet *ks;
272         
273         /* allocate new KeyingSet */
274         ks= MEM_callocN(sizeof(KeyingSet), "KeyingSet");
275         
276         if (name)
277                 BLI_snprintf(ks->name, 64, name);
278         else
279                 strcpy(ks->name, "KeyingSet");
280         
281         ks->flag= flag;
282         ks->keyingflag= keyingflag;
283         
284         /* add KeyingSet to list */
285         BLI_addtail(list, ks);
286         
287         /* make sure KeyingSet has a unique name (this helps with identification) */
288         BLI_uniquename(list, ks, "KeyingSet", '.', offsetof(KeyingSet, name), 64);
289         
290         /* return new KeyingSet for further editing */
291         return ks;
292 }
293
294 /* Add a destination to a KeyingSet. Nothing is returned for now...
295  * Checks are performed to ensure that destination is appropriate for the KeyingSet in question
296  */
297 void BKE_keyingset_add_destination (KeyingSet *ks, ID *id, const char group_name[], const char rna_path[], int array_index, short flag, short groupmode)
298 {
299         KS_Path *ksp;
300         
301         /* sanity checks */
302         if ELEM(NULL, ks, rna_path)
303                 return;
304         
305         /* ID is optional for relative KeyingSets, but is necessary for absolute KeyingSets */
306         if (id == NULL) {
307                 if (ks->flag & KEYINGSET_ABSOLUTE)
308                         return;
309         }
310         
311         /* don't add if there is already a matching KS_Path in the KeyingSet */
312         if (BKE_keyingset_find_destination(ks, id, group_name, rna_path, array_index, groupmode))
313                 return;
314         
315         /* allocate a new KeyingSet Path */
316         ksp= MEM_callocN(sizeof(KS_Path), "KeyingSet Path");
317         
318         /* just store absolute info */
319         if (ks->flag & KEYINGSET_ABSOLUTE) {
320                 ksp->id= id;
321                 if (group_name)
322                         BLI_snprintf(ksp->group, 64, group_name);
323                 else
324                         strcpy(ksp->group, "");
325         }
326         
327         /* store additional info for relative paths (just in case user makes the set relative) */
328         if (id)
329                 ksp->idtype= GS(id->name);
330         
331         /* just copy path info */
332         // XXX no checks are performed for templates yet
333         // should array index be checked too?
334         ksp->rna_path= BLI_strdupn(rna_path, strlen(rna_path));
335         ksp->array_index= array_index;
336         
337         /* store flags */
338         ksp->flag= flag;
339         ksp->groupmode= groupmode;
340         
341         /* add KeyingSet path to KeyingSet */
342         BLI_addtail(&ks->paths, ksp);
343 }       
344
345 /* Copy all KeyingSets in the given list */
346 void BKE_keyingsets_copy(ListBase *newlist, ListBase *list)
347 {
348         KeyingSet *ksn;
349         KS_Path *kspn;
350
351         BLI_duplicatelist(newlist, list);
352
353         for(ksn=newlist->first; ksn; ksn=ksn->next) {
354                 BLI_duplicatelist(&ksn->paths, &ksn->paths);
355
356                 for(kspn=ksn->paths.first; kspn; kspn=kspn->next)
357                         kspn->rna_path= MEM_dupallocN(kspn->rna_path);
358         }
359 }
360
361 /* Freeing Tools --------------------------- */
362
363 /* Free data for KeyingSet but not set itself */
364 void BKE_keyingset_free (KeyingSet *ks)
365 {
366         KS_Path *ksp, *kspn;
367         
368         /* sanity check */
369         if (ks == NULL)
370                 return;
371         
372         /* free each path as we go to avoid looping twice */
373         for (ksp= ks->paths.first; ksp; ksp= kspn) {
374                 kspn= ksp->next;
375                 
376                 /* free RNA-path info */
377                 MEM_freeN(ksp->rna_path);
378                 
379                 /* free path itself */
380                 BLI_freelinkN(&ks->paths, ksp);
381         }
382 }
383
384 /* Free all the KeyingSets in the given list */
385 void BKE_keyingsets_free (ListBase *list)
386 {
387         KeyingSet *ks, *ksn;
388         
389         /* sanity check */
390         if (list == NULL)
391                 return;
392         
393         /* loop over KeyingSets freeing them 
394          *      - BKE_keyingset_free() doesn't free the set itself, but it frees its sub-data
395          */
396         for (ks= list->first; ks; ks= ksn) {
397                 ksn= ks->next;
398                 BKE_keyingset_free(ks);
399                 BLI_freelinkN(list, ks);
400         }
401 }
402
403 /* ***************************************** */
404 /* Evaluation Data-Setting Backend */
405
406 /* Retrieve string to act as RNA-path, adjusted using mapping-table if provided 
407  * It returns whether the string needs to be freed (i.e. if it was a temp remapped one)
408  * // FIXME: maybe it would be faster if we didn't have to alloc/free strings like this all the time, but for now it's safer
409  *
410  *      - remap: remapping table to use
411  *      - path: original path string (as stored in F-Curve data)
412  *      - dst: destination string to write data to
413  */
414 short animsys_remap_path (AnimMapper *remap, char *path, char **dst)
415 {
416         /* is there a valid remapping table to use? */
417         //if (remap) {
418                 /* find a matching entry... to use to remap */
419                 // ...TODO...
420         //}
421         
422         /* nothing suitable found, so just set dst to look at path (i.e. no alloc/free needed) */
423         *dst= path;
424         return 0;
425 }
426
427
428 /* Write the given value to a setting using RNA, and return success */
429 static short animsys_write_rna_setting (PointerRNA *ptr, char *path, int array_index, float value)
430 {
431         PropertyRNA *prop;
432         PointerRNA new_ptr;
433         
434         /* get property to write to */
435         if (RNA_path_resolve(ptr, path, &new_ptr, &prop)) 
436         {
437                 /* set value - only for animatable numerical values */
438                 if (RNA_property_animateable(&new_ptr, prop)) 
439                 {
440                         switch (RNA_property_type(prop)) 
441                         {
442                                 case PROP_BOOLEAN:
443                                         if (RNA_property_array_length(prop))
444                                                 RNA_property_boolean_set_index(&new_ptr, prop, array_index, (int)value);
445                                         else
446                                                 RNA_property_boolean_set(&new_ptr, prop, (int)value);
447                                         break;
448                                 case PROP_INT:
449                                         if (RNA_property_array_length(prop))
450                                                 RNA_property_int_set_index(&new_ptr, prop, array_index, (int)value);
451                                         else
452                                                 RNA_property_int_set(&new_ptr, prop, (int)value);
453                                         break;
454                                 case PROP_FLOAT:
455                                         if (RNA_property_array_length(prop))
456                                                 RNA_property_float_set_index(&new_ptr, prop, array_index, value);
457                                         else
458                                                 RNA_property_float_set(&new_ptr, prop, value);
459                                         break;
460                                 case PROP_ENUM:
461                                         RNA_property_enum_set(&new_ptr, prop, (int)value);
462                                         break;
463                                 default:
464                                         /* nothing can be done here... so it is unsuccessful? */
465                                         return 0;
466                         }
467                 }
468                 
469                 /* successful */
470                 return 1;
471         }
472         else {
473                 /* failed to get path */
474                 // XXX don't tag as failed yet though, as there are some legit situations (Action Constraint) 
475                 // where some channels will not exist, but shouldn't lock up Action
476                 if (G.f & G_DEBUG) {
477                         printf("Animato: Invalid path. ID = '%s',  '%s [%d]' \n", 
478                                 (ptr && ptr->id.data) ? (((ID *)ptr->id.data)->name+2) : "<No ID>", 
479                                 path, array_index);
480                 }
481                 return 0;
482         }
483 }
484
485 /* Simple replacement based data-setting of the FCurve using RNA */
486 static short animsys_execute_fcurve (PointerRNA *ptr, AnimMapper *remap, FCurve *fcu)
487 {
488         char *path = NULL;
489         short free_path=0;
490         short ok= 0;
491         
492         /* get path, remapped as appropriate to work in its new environment */
493         free_path= animsys_remap_path(remap, fcu->rna_path, &path);
494         
495         /* write value to setting */
496         if (path)
497                 ok= animsys_write_rna_setting(ptr, path, fcu->array_index, fcu->curval);
498         
499         /* free temp path-info */
500         if (free_path)
501                 MEM_freeN(path);
502                 
503         /* return whether we were successful */
504         return ok;
505 }
506
507 /* Evaluate all the F-Curves in the given list 
508  * This performs a set of standard checks. If extra checks are required, separate code should be used
509  */
510 static void animsys_evaluate_fcurves (PointerRNA *ptr, ListBase *list, AnimMapper *remap, float ctime)
511 {
512         FCurve *fcu;
513         
514         /* calculate then execute each curve */
515         for (fcu= list->first; fcu; fcu= fcu->next) 
516         {
517                 /* check if this F-Curve doesn't belong to a muted group */
518                 if ((fcu->grp == NULL) || (fcu->grp->flag & AGRP_MUTED)==0) {
519                         /* check if this curve should be skipped */
520                         if ((fcu->flag & (FCURVE_MUTED|FCURVE_DISABLED)) == 0) 
521                         {
522                                 calculate_fcurve(fcu, ctime);
523                                 animsys_execute_fcurve(ptr, remap, fcu); 
524                         }
525                 }
526         }
527 }
528
529 /* ***************************************** */
530 /* Driver Evaluation */
531
532 /* Evaluate Drivers */
533 static void animsys_evaluate_drivers (PointerRNA *ptr, AnimData *adt, float ctime)
534 {
535         FCurve *fcu;
536         
537         /* drivers are stored as F-Curves, but we cannot use the standard code, as we need to check if
538          * the depsgraph requested that this driver be evaluated...
539          */
540         for (fcu= adt->drivers.first; fcu; fcu= fcu->next) 
541         {
542                 ChannelDriver *driver= fcu->driver;
543                 short ok= 0;
544                 
545                 /* check if this driver's curve should be skipped */
546                 if ((fcu->flag & (FCURVE_MUTED|FCURVE_DISABLED)) == 0) 
547                 {
548                         /* check if driver itself is tagged for recalculation */
549                         if ((driver) && !(driver->flag & DRIVER_FLAG_INVALID)/*&& (driver->flag & DRIVER_FLAG_RECALC)*/) {      // XXX driver recalc flag is not set yet by depsgraph!
550                                 /* evaluate this using values set already in other places */
551                                 // NOTE: for 'layering' option later on, we should check if we should remove old value before adding new to only be done when drivers only changed
552                                 calculate_fcurve(fcu, ctime);
553                                 ok= animsys_execute_fcurve(ptr, NULL, fcu);
554                                 
555                                 /* clear recalc flag */
556                                 driver->flag &= ~DRIVER_FLAG_RECALC;
557                                 
558                                 /* set error-flag if evaluation failed */
559                                 if (ok == 0)
560                                         driver->flag |= DRIVER_FLAG_INVALID; 
561                         }
562                 }
563         }
564 }
565
566 /* ***************************************** */
567 /* Actions Evaluation */
568
569 /* Evaluate Action Group */
570 void animsys_evaluate_action_group (PointerRNA *ptr, bAction *act, bActionGroup *agrp, AnimMapper *remap, float ctime)
571 {
572         FCurve *fcu;
573         
574         /* check if mapper is appropriate for use here (we set to NULL if it's inappropriate) */
575         if ELEM(NULL, act, agrp) return;
576         if ((remap) && (remap->target != act)) remap= NULL;
577         
578         /* if group is muted, don't evaluated any of the F-Curve */
579         if (agrp->flag & AGRP_MUTED)
580                 return;
581         
582         /* calculate then execute each curve */
583         for (fcu= agrp->channels.first; (fcu) && (fcu->grp == agrp); fcu= fcu->next) 
584         {
585                 /* check if this curve should be skipped */
586                 if ((fcu->flag & (FCURVE_MUTED|FCURVE_DISABLED)) == 0) 
587                 {
588                         calculate_fcurve(fcu, ctime);
589                         animsys_execute_fcurve(ptr, remap, fcu); 
590                 }
591         }
592 }
593
594 /* Evaluate Action (F-Curve Bag) */
595 void animsys_evaluate_action (PointerRNA *ptr, bAction *act, AnimMapper *remap, float ctime)
596 {
597         /* check if mapper is appropriate for use here (we set to NULL if it's inappropriate) */
598         if (act == NULL) return;
599         if ((remap) && (remap->target != act)) remap= NULL;
600         
601         /* calculate then execute each curve */
602         animsys_evaluate_fcurves(ptr, &act->curves, remap, ctime);
603 }
604
605 /* ***************************************** */
606 /* NLA System - Evaluation */
607
608 /* calculate influence of strip based for given frame based on blendin/out values */
609 static float nlastrip_get_influence (NlaStrip *strip, float cframe)
610 {
611         /* sanity checks - normalise the blendin/out values? */
612         strip->blendin= (float)fabs(strip->blendin);
613         strip->blendout= (float)fabs(strip->blendout);
614         
615         /* result depends on where frame is in respect to blendin/out values */
616         if (IS_EQ(strip->blendin, 0)==0 && (cframe <= (strip->start + strip->blendin))) {
617                 /* there is some blend-in */
618                 return (float)fabs(cframe - strip->start) / (strip->blendin);
619         }
620         else if (IS_EQ(strip->blendout, 0)==0 && (cframe >= (strip->end - strip->blendout))) {
621                 /* there is some blend-out */
622                 return (float)fabs(strip->end - cframe) / (strip->blendout);
623         }
624         else {
625                 /* in the middle of the strip, we should be full strength */
626                 return 1.0f;
627         }
628 }
629
630 /* evaluate the evaluation time and influence for the strip, storing the results in the strip */
631 static void nlastrip_evaluate_controls (NlaStrip *strip, float ctime)
632 {
633         /* firstly, analytically generate values for influence and time (if applicable) */
634         if ((strip->flag & NLASTRIP_FLAG_USR_TIME) == 0)
635                 strip->strip_time= nlastrip_get_frame(strip, ctime, NLATIME_CONVERT_EVAL);
636         if ((strip->flag & NLASTRIP_FLAG_USR_INFLUENCE) == 0)
637                 strip->influence= nlastrip_get_influence(strip, ctime);
638         
639         /* now strip's evaluate F-Curves for these settings (if applicable) */
640         if (strip->fcurves.first) {
641                 PointerRNA strip_ptr;
642                 
643                 /* create RNA-pointer needed to set values */
644                 RNA_pointer_create(NULL, &RNA_NlaStrip, strip, &strip_ptr);
645                 
646                 /* execute these settings as per normal */
647                 animsys_evaluate_fcurves(&strip_ptr, &strip->fcurves, NULL, ctime);
648         }
649 }
650
651 /* gets the strip active at the current time for a list of strips for evaluation purposes */
652 NlaEvalStrip *nlastrips_ctime_get_strip (ListBase *list, ListBase *strips, short index, float ctime)
653 {
654         NlaStrip *strip, *estrip=NULL;
655         NlaEvalStrip *nes;
656         short side= 0;
657         
658         /* loop over strips, checking if they fall within the range */
659         for (strip= strips->first; strip; strip= strip->next) {
660                 /* check if current time occurs within this strip  */
661                 if (IN_RANGE_INCL(ctime, strip->start, strip->end)) {
662                         /* this strip is active, so try to use it */
663                         estrip= strip;
664                         side= NES_TIME_WITHIN;
665                         break;
666                 }
667                 
668                 /* if time occurred before current strip... */
669                 if (ctime < strip->start) {
670                         if (strip == strips->first) {
671                                 /* before first strip - only try to use it if it extends backwards in time too */
672                                 if (strip->extendmode == NLASTRIP_EXTEND_HOLD)
673                                         estrip= strip;
674                                         
675                                 /* side is 'before' regardless of whether there's a useful strip */
676                                 side= NES_TIME_BEFORE;
677                         }
678                         else {
679                                 /* before next strip - previous strip has ended, but next hasn't begun, 
680                                  * so blending mode depends on whether strip is being held or not...
681                                  *      - only occurs when no transition strip added, otherwise the transition would have
682                                  *        been picked up above...
683                                  */
684                                 strip= strip->prev;
685                                 
686                                 if (strip->extendmode != NLASTRIP_EXTEND_NOTHING)
687                                         estrip= strip;
688                                 side= NES_TIME_AFTER;
689                         }
690                         break;
691                 }
692                 
693                 /* if time occurred after current strip... */
694                 if (ctime > strip->end) {
695                         /* only if this is the last strip should we do anything, and only if that is being held */
696                         if (strip == strips->last) {
697                                 if (strip->extendmode != NLASTRIP_EXTEND_NOTHING)
698                                         estrip= strip;
699                                         
700                                 side= NES_TIME_AFTER;
701                                 break;
702                         }
703                         
704                         /* otherwise, skip... as the 'before' case will catch it more elegantly! */
705                 }
706         }
707         
708         /* check if a valid strip was found
709          *      - must not be muted (i.e. will have contribution
710          */
711         if ((estrip == NULL) || (estrip->flag & NLASTRIP_FLAG_MUTED)) 
712                 return NULL;
713                 
714         /* if ctime was not within the boundaries of the strip, clamp! */
715         switch (side) {
716                 case NES_TIME_BEFORE: /* extend first frame only */
717                         ctime= estrip->start;
718                         break;
719                 case NES_TIME_AFTER: /* extend last frame only */
720                         ctime= estrip->end;
721                         break;
722         }
723         
724         /* evaluate strip's evaluation controls  
725          *      - skip if no influence (i.e. same effect as muting the strip)
726          *      - negative influence is not supported yet... how would that be defined?
727          */
728         // TODO: this sounds a bit hacky having a few isolated F-Curves stuck on some data it operates on...
729         nlastrip_evaluate_controls(estrip, ctime);
730         if (estrip->influence <= 0.0f)
731                 return NULL;
732                 
733         /* check if strip has valid data to evaluate,
734          * and/or perform any additional type-specific actions
735          */
736         switch (estrip->type) {
737                 case NLASTRIP_TYPE_CLIP: 
738                         /* clip must have some action to evaluate */
739                         if (estrip->act == NULL)
740                                 return NULL;
741                         break;
742                 case NLASTRIP_TYPE_TRANSITION:
743                         /* there must be strips to transition from and to (i.e. prev and next required) */
744                         if (ELEM(NULL, estrip->prev, estrip->next))
745                                 return NULL;
746                                 
747                         /* evaluate controls for the relevant extents of the bordering strips... */
748                         nlastrip_evaluate_controls(estrip->prev, estrip->start);
749                         nlastrip_evaluate_controls(estrip->next, estrip->end);
750                         break;
751         }
752         
753         /* add to list of strips we need to evaluate */
754         nes= MEM_callocN(sizeof(NlaEvalStrip), "NlaEvalStrip");
755         
756         nes->strip= estrip;
757         nes->strip_mode= side;
758         nes->track_index= index;
759         nes->strip_time= estrip->strip_time;
760         
761         if (list)
762                 BLI_addtail(list, nes);
763         
764         return nes;
765 }
766
767 /* ---------------------- */
768
769 /* find an NlaEvalChannel that matches the given criteria 
770  *      - ptr and prop are the RNA data to find a match for
771  */
772 static NlaEvalChannel *nlaevalchan_find_match (ListBase *channels, PointerRNA *ptr, PropertyRNA *prop, int array_index)
773 {
774         NlaEvalChannel *nec;
775         
776         /* sanity check */
777         if (channels == NULL)
778                 return NULL;
779         
780         /* loop through existing channels, checking for a channel which affects the same property */
781         for (nec= channels->first; nec; nec= nec->next) {
782                 /* - comparing the PointerRNA's is done by comparing the pointers
783                  *   to the actual struct the property resides in, since that all the
784                  *   other data stored in PointerRNA cannot allow us to definitively 
785                  *      identify the data 
786                  */
787                 if ((nec->ptr.data == ptr->data) && (nec->prop == prop) && (nec->index == array_index))
788                         return nec;
789         }
790         
791         /* not found */
792         return NULL;
793 }
794
795 /* verify that an appropriate NlaEvalChannel for this F-Curve exists */
796 static NlaEvalChannel *nlaevalchan_verify (PointerRNA *ptr, ListBase *channels, NlaEvalStrip *nes, FCurve *fcu, short *newChan)
797 {
798         NlaEvalChannel *nec;
799         NlaStrip *strip= nes->strip;
800         PropertyRNA *prop;
801         PointerRNA new_ptr;
802         char *path = NULL;
803         short free_path=0;
804         
805         /* sanity checks */
806         if (channels == NULL)
807                 return NULL;
808         
809         /* get RNA pointer+property info from F-Curve for more convenient handling */
810                 /* get path, remapped as appropriate to work in its new environment */
811         free_path= animsys_remap_path(strip->remap, fcu->rna_path, &path);
812         
813                 /* a valid property must be available, and it must be animateable */
814         if (RNA_path_resolve(ptr, path, &new_ptr, &prop) == 0) {
815                 if (G.f & G_DEBUG) printf("NLA Strip Eval: Cannot resolve path \n");
816                 return NULL;
817         }
818                 /* only ok if animateable */
819         else if (RNA_property_animateable(&new_ptr, prop) == 0) {
820                 if (G.f & G_DEBUG) printf("NLA Strip Eval: Property not animateable \n");
821                 return NULL;
822         }
823         
824         /* try to find a match */
825         nec= nlaevalchan_find_match(channels, &new_ptr, prop, fcu->array_index);
826         
827         /* allocate a new struct for this if none found */
828         if (nec == NULL) {
829                 nec= MEM_callocN(sizeof(NlaEvalChannel), "NlaEvalChannel");
830                 *newChan= 1;
831                 BLI_addtail(channels, nec);
832                 
833                 nec->ptr= new_ptr; 
834                 nec->prop= prop;
835                 nec->index= fcu->array_index;
836         }
837         else
838                 *newChan= 0;
839         
840         /* we can now return */
841         return nec;
842 }
843
844 /* accumulate (i.e. blend) the given value on to the channel it affects */
845 static void nlaevalchan_accumulate (NlaEvalChannel *nec, NlaEvalStrip *nes, short newChan, float value)
846 {
847         NlaStrip *strip= nes->strip;
848         short blendmode= strip->blendmode;
849         float inf= strip->influence;
850         
851         /* if channel is new, just store value regardless of blending factors, etc. */
852         if (newChan) {
853                 nec->value= value;
854                 return;
855         }
856                 
857         /* if this is being performed as part of transition evaluation, incorporate
858          * an additional weighting factor for the influence
859          */
860         if (nes->strip_mode == NES_TIME_TRANSITION_END) 
861                 inf *= nes->strip_time;
862         
863         /* premultiply the value by the weighting factor */
864         if (IS_EQ(inf, 0)) return;
865         value *= inf;
866         
867         /* perform blending */
868         switch (blendmode) {
869                 case NLASTRIP_MODE_ADD:
870                         /* simply add the scaled value on to the stack */
871                         nec->value += value;
872                         break;
873                         
874                 case NLASTRIP_MODE_SUBTRACT:
875                         /* simply subtract the scaled value from the stack */
876                         nec->value -= value;
877                         break;
878                         
879                 case NLASTRIP_MODE_MULTIPLY:
880                         /* multiply the scaled value with the stack */
881                         nec->value *= value;
882                         break;
883                 
884                 case NLASTRIP_MODE_REPLACE:
885                 default: // TODO: do we really want to blend by default? it seems more uses might prefer add...
886                         /* do linear interpolation 
887                          *      - the influence of the accumulated data (elsewhere, that is called dstweight) 
888                          *        is 1 - influence, since the strip's influence is srcweight
889                          */
890                         nec->value= nec->value * (1.0f - inf)   +   value;
891                         break;
892         }
893 }
894
895 /* accumulate the results of a temporary buffer with the results of the full-buffer */
896 static void nlaevalchan_buffers_accumulate (ListBase *channels, ListBase *tmp_buffer, NlaEvalStrip *nes)
897 {
898         NlaEvalChannel *nec, *necn, *necd;
899         
900         /* optimise - abort if no channels */
901         if (tmp_buffer->first == NULL)
902                 return;
903         
904         /* accumulate results in tmp_channels buffer to the accumulation buffer */
905         for (nec= tmp_buffer->first; nec; nec= necn) {
906                 /* get pointer to next channel in case we remove the current channel from the temp-buffer */
907                 necn= nec->next;
908                 
909                 /* try to find an existing matching channel for this setting in the accumulation buffer */
910                 necd= nlaevalchan_find_match(channels, &nec->ptr, nec->prop, nec->index);
911                 
912                 /* if there was a matching channel already in the buffer, accumulate to it,
913                  * otherwise, add the current channel to the buffer for efficiency
914                  */
915                 if (necd)
916                         nlaevalchan_accumulate(necd, nes, 0, nec->value);
917                 else {
918                         BLI_remlink(tmp_buffer, nec);
919                         BLI_addtail(channels, nec);
920                 }
921         }
922         
923         /* free temp-channels that haven't been assimilated into the buffer */
924         BLI_freelistN(tmp_buffer);
925 }
926
927 /* ---------------------- */
928 /* F-Modifier stack joining/separation utilities - should we generalise these for BLI_listbase.h interface? */
929
930 /* Temporarily join two lists of modifiers together, storing the result in a third list */
931 static void nlaeval_fmodifiers_join_stacks (ListBase *result, ListBase *list1, ListBase *list2)
932 {
933         FModifier *fcm1, *fcm2;
934         
935         /* if list1 is invalid...  */
936         if ELEM(NULL, list1, list1->first) {
937                 if (list2 && list2->first) {
938                         result->first= list2->first;
939                         result->last= list2->last;
940                 }
941         }
942         /* if list 2 is invalid... */
943         else if ELEM(NULL, list2, list2->first) {
944                 result->first= list1->first;
945                 result->last= list1->last;
946         }
947         else {
948                 /* list1 should be added first, and list2 second, with the endpoints of these being the endpoints for result 
949                  *      - the original lists must be left unchanged though, as we need that fact for restoring
950                  */
951                 result->first= list1->first;
952                 result->last= list2->last;
953                 
954                 fcm1= list1->last;
955                 fcm2= list2->first;
956                 
957                 fcm1->next= fcm2;
958                 fcm2->prev= fcm1;
959         }
960 }
961
962 /* Split two temporary lists of modifiers */
963 static void nlaeval_fmodifiers_split_stacks (ListBase *list1, ListBase *list2)
964 {
965         FModifier *fcm1, *fcm2;
966         
967         /* if list1/2 is invalid... just skip */
968         if ELEM(NULL, list1, list2)
969                 return;
970         if ELEM(NULL, list1->first, list2->first)
971                 return;
972                 
973         /* get endpoints */
974         fcm1= list1->last;
975         fcm2= list2->first;
976         
977         /* clear their links */
978         fcm1->next= NULL;
979         fcm2->prev= NULL;
980 }
981
982 /* ---------------------- */
983
984 /* evaluate action-clip strip */
985 static void nlastrip_evaluate_actionclip (PointerRNA *ptr, ListBase *channels, ListBase *modifiers, NlaEvalStrip *nes)
986 {
987         ListBase tmp_modifiers = {NULL, NULL};
988         NlaStrip *strip= nes->strip;
989         FCurve *fcu;
990         float evaltime;
991         
992         /* join this strip's modifiers to the parent's modifiers (own modifiers first) */
993         nlaeval_fmodifiers_join_stacks(&tmp_modifiers, &strip->modifiers, modifiers);
994         
995         /* evaluate strip's modifiers which modify time to evaluate the base curves at */
996         evaltime= evaluate_time_fmodifiers(&tmp_modifiers, NULL, 0.0f, strip->strip_time);
997         
998         /* evaluate all the F-Curves in the action, saving the relevant pointers to data that will need to be used */
999         for (fcu= strip->act->curves.first; fcu; fcu= fcu->next) {
1000                 NlaEvalChannel *nec;
1001                 float value = 0.0f;
1002                 short newChan = -1;
1003                 
1004                 /* check if this curve should be skipped */
1005                 if (fcu->flag & (FCURVE_MUTED|FCURVE_DISABLED)) 
1006                         continue;
1007                 if ((fcu->grp) && (fcu->grp->flag & AGRP_MUTED))
1008                         continue;
1009                         
1010                 /* evaluate the F-Curve's value for the time given in the strip 
1011                  * NOTE: we use the modified time here, since strip's F-Curve Modifiers are applied on top of this 
1012                  */
1013                 value= evaluate_fcurve(fcu, evaltime);
1014                 
1015                 /* apply strip's F-Curve Modifiers on this value 
1016                  * NOTE: we apply the strip's original evaluation time not the modified one (as per standard F-Curve eval)
1017                  */
1018                 evaluate_value_fmodifiers(&tmp_modifiers, fcu, &value, strip->strip_time);
1019                 
1020                 
1021                 /* get an NLA evaluation channel to work with, and accumulate the evaluated value with the value(s)
1022                  * stored in this channel if it has been used already
1023                  */
1024                 nec= nlaevalchan_verify(ptr, channels, nes, fcu, &newChan);
1025                 if (nec)
1026                         nlaevalchan_accumulate(nec, nes, newChan, value);
1027         }
1028         
1029         /* unlink this strip's modifiers from the parent's modifiers again */
1030         nlaeval_fmodifiers_split_stacks(&strip->modifiers, modifiers);
1031 }
1032
1033 /* evaluate transition strip */
1034 static void nlastrip_evaluate_transition (PointerRNA *ptr, ListBase *channels, ListBase *modifiers, NlaEvalStrip *nes)
1035 {
1036         ListBase tmp_channels = {NULL, NULL};
1037         ListBase tmp_modifiers = {NULL, NULL};
1038         NlaEvalStrip tmp_nes;
1039         NlaStrip *s1, *s2;
1040         
1041         /* join this strip's modifiers to the parent's modifiers (own modifiers first) */
1042         nlaeval_fmodifiers_join_stacks(&tmp_modifiers, &nes->strip->modifiers, modifiers);
1043         
1044         /* get the two strips to operate on 
1045          *      - we use the endpoints of the strips directly flanking our strip
1046          *        using these as the endpoints of the transition (destination and source)
1047          *      - these should have already been determined to be valid...
1048          *      - if this strip is being played in reverse, we need to swap these endpoints
1049          *        otherwise they will be interpolated wrong
1050          */
1051         if (nes->strip->flag & NLASTRIP_FLAG_REVERSE) {
1052                 s1= nes->strip->next;
1053                 s2= nes->strip->prev;
1054         }
1055         else {
1056                 s1= nes->strip->prev;
1057                 s2= nes->strip->next;
1058         }
1059         
1060         /* prepare template for 'evaluation strip' 
1061          *      - based on the transition strip's evaluation strip data
1062          *      - strip_mode is NES_TIME_TRANSITION_* based on which endpoint
1063          *      - strip_time is the 'normalised' (i.e. in-strip) time for evaluation,
1064          *        which doubles up as an additional weighting factor for the strip influences
1065          *        which allows us to appear to be 'interpolating' between the two extremes
1066          */
1067         tmp_nes= *nes;
1068         
1069         /* evaluate these strips into a temp-buffer (tmp_channels) */
1070         // FIXME: modifier evalation here needs some work...
1071                 /* first strip */
1072         tmp_nes.strip_mode= NES_TIME_TRANSITION_START;
1073         tmp_nes.strip= s1;
1074         nlastrip_evaluate(ptr, &tmp_channels, &tmp_modifiers, &tmp_nes);
1075         
1076                 /* second strip */
1077         tmp_nes.strip_mode= NES_TIME_TRANSITION_END;
1078         tmp_nes.strip= s2;
1079         nlastrip_evaluate(ptr, &tmp_channels, &tmp_modifiers, &tmp_nes);
1080         
1081         
1082         /* assumulate temp-buffer and full-buffer, using the 'real' strip */
1083         nlaevalchan_buffers_accumulate(channels, &tmp_channels, nes);
1084         
1085         /* unlink this strip's modifiers from the parent's modifiers again */
1086         nlaeval_fmodifiers_split_stacks(&nes->strip->modifiers, modifiers);
1087 }
1088
1089 /* evaluate meta-strip */
1090 static void nlastrip_evaluate_meta (PointerRNA *ptr, ListBase *channels, ListBase *modifiers, NlaEvalStrip *nes)
1091 {
1092         ListBase tmp_channels = {NULL, NULL};
1093         ListBase tmp_modifiers = {NULL, NULL};
1094         NlaStrip *strip= nes->strip;
1095         NlaEvalStrip *tmp_nes;
1096         float evaltime;
1097         
1098         /* meta-strip was calculated normally to have some time to be evaluated at
1099          * and here we 'look inside' the meta strip, treating it as a decorated window to
1100          * it's child strips, which get evaluated as if they were some tracks on a strip 
1101          * (but with some extra modifiers to apply).
1102          *
1103          * NOTE: keep this in sync with animsys_evaluate_nla()
1104          */
1105          
1106         /* join this strip's modifiers to the parent's modifiers (own modifiers first) */
1107         nlaeval_fmodifiers_join_stacks(&tmp_modifiers, &strip->modifiers, modifiers); 
1108         
1109         /* find the child-strip to evaluate */
1110         evaltime= (nes->strip_time * (strip->end - strip->start)) + strip->start;
1111         tmp_nes= nlastrips_ctime_get_strip(NULL, &strip->strips, -1, evaltime);
1112         if (tmp_nes == NULL)
1113                 return;
1114                 
1115         /* evaluate child-strip into tmp_channels buffer before accumulating 
1116          * in the accumulation buffer
1117          */
1118         nlastrip_evaluate(ptr, &tmp_channels, &tmp_modifiers, tmp_nes);
1119         
1120         /* assumulate temp-buffer and full-buffer, using the 'real' strip */
1121         nlaevalchan_buffers_accumulate(channels, &tmp_channels, nes);
1122         
1123         /* free temp eval-strip */
1124         MEM_freeN(tmp_nes);
1125         
1126         /* unlink this strip's modifiers from the parent's modifiers again */
1127         nlaeval_fmodifiers_split_stacks(&strip->modifiers, modifiers);
1128 }
1129
1130 /* evaluates the given evaluation strip */
1131 void nlastrip_evaluate (PointerRNA *ptr, ListBase *channels, ListBase *modifiers, NlaEvalStrip *nes)
1132 {
1133         NlaStrip *strip= nes->strip;
1134         
1135         /* to prevent potential infinite recursion problems (i.e. transition strip, beside meta strip containing a transition
1136          * several levels deep inside it), we tag the current strip as being evaluated, and clear this when we leave
1137          */
1138         // TODO: be careful with this flag, since some edit tools may be running and have set this while animplayback was running
1139         if (strip->flag & NLASTRIP_FLAG_EDIT_TOUCHED)
1140                 return;
1141         strip->flag |= NLASTRIP_FLAG_EDIT_TOUCHED;
1142         
1143         /* actions to take depend on the type of strip */
1144         switch (strip->type) {
1145                 case NLASTRIP_TYPE_CLIP: /* action-clip */
1146                         nlastrip_evaluate_actionclip(ptr, channels, modifiers, nes);
1147                         break;
1148                 case NLASTRIP_TYPE_TRANSITION: /* transition */
1149                         nlastrip_evaluate_transition(ptr, channels, modifiers, nes);
1150                         break;
1151                 case NLASTRIP_TYPE_META: /* meta */
1152                         nlastrip_evaluate_meta(ptr, channels, modifiers, nes);
1153                         break;
1154         }
1155         
1156         /* clear temp recursion safe-check */
1157         strip->flag &= ~NLASTRIP_FLAG_EDIT_TOUCHED;
1158 }
1159
1160 /* write the accumulated settings to */
1161 void nladata_flush_channels (ListBase *channels)
1162 {
1163         NlaEvalChannel *nec;
1164         
1165         /* sanity checks */
1166         if (channels == NULL)
1167                 return;
1168         
1169         /* for each channel with accumulated values, write its value on the property it affects */
1170         for (nec= channels->first; nec; nec= nec->next) {
1171                 PointerRNA *ptr= &nec->ptr;
1172                 PropertyRNA *prop= nec->prop;
1173                 int array_index= nec->index;
1174                 float value= nec->value;
1175                 
1176                 /* write values - see animsys_write_rna_setting() to sync the code */
1177                 switch (RNA_property_type(prop)) 
1178                 {
1179                         case PROP_BOOLEAN:
1180                                 if (RNA_property_array_length(prop))
1181                                         RNA_property_boolean_set_index(ptr, prop, array_index, (int)value);
1182                                 else
1183                                         RNA_property_boolean_set(ptr, prop, (int)value);
1184                                 break;
1185                         case PROP_INT:
1186                                 if (RNA_property_array_length(prop))
1187                                         RNA_property_int_set_index(ptr, prop, array_index, (int)value);
1188                                 else
1189                                         RNA_property_int_set(ptr, prop, (int)value);
1190                                 break;
1191                         case PROP_FLOAT:
1192                                 if (RNA_property_array_length(prop))
1193                                         RNA_property_float_set_index(ptr, prop, array_index, value);
1194                                 else
1195                                         RNA_property_float_set(ptr, prop, value);
1196                                 break;
1197                         case PROP_ENUM:
1198                                 RNA_property_enum_set(ptr, prop, (int)value);
1199                                 break;
1200                         default:
1201                                 // can't do anything with other types of property....
1202                                 break;
1203                 }
1204         }
1205 }
1206
1207 /* ---------------------- */
1208
1209 /* NLA Evaluation function (mostly for use through do_animdata) 
1210  *      - All channels that will be affected are not cleared anymore. Instead, we just evaluate into 
1211  *              some temp channels, where values can be accumulated in one go.
1212  */
1213 static void animsys_evaluate_nla (PointerRNA *ptr, AnimData *adt, float ctime)
1214 {
1215         ListBase dummy_trackslist = {NULL, NULL};
1216         NlaStrip dummy_strip;
1217         
1218         NlaTrack *nlt;
1219         short track_index=0;
1220         short has_strips = 0;
1221         
1222         ListBase estrips= {NULL, NULL};
1223         ListBase echannels= {NULL, NULL};
1224         NlaEvalStrip *nes;
1225         
1226         // TODO: need to zero out all channels used, otherwise we have problems with threadsafety
1227         // and also when the user jumps between different times instead of moving sequentially...
1228         
1229         /* 1. get the stack of strips to evaluate at current time (influence calculated here) */
1230         for (nlt=adt->nla_tracks.first; nlt; nlt=nlt->next, track_index++) { 
1231                 /* if tweaking is on and this strip is the tweaking track, stop on this one */
1232                 if ((adt->flag & ADT_NLA_EDIT_ON) && (nlt->flag & NLATRACK_DISABLED))
1233                         break;
1234                         
1235                 /* skip if we're only considering a track tagged 'solo' */
1236                 if ((adt->flag & ADT_NLA_SOLO_TRACK) && (nlt->flag & NLATRACK_SOLO)==0)
1237                         continue;
1238                 /* skip if track is muted */
1239                 if (nlt->flag & NLATRACK_MUTED) 
1240                         continue;
1241                         
1242                 /* if this track has strips (but maybe they won't be suitable), set has_strips 
1243                  *      - used for mainly for still allowing normal action evaluation...
1244                  */
1245                 if (nlt->strips.first)
1246                         has_strips= 1;
1247                         
1248                 /* otherwise, get strip to evaluate for this channel */
1249                 nes= nlastrips_ctime_get_strip(&estrips, &nlt->strips, track_index, ctime);
1250                 if (nes) nes->track= nlt;
1251         }
1252         
1253         /* add 'active' Action (may be tweaking track) as last strip to evaluate in NLA stack
1254          *      - only do this if we're not exclusively evaluating the 'solo' NLA-track
1255          */
1256         if ((adt->action) && !(adt->flag & ADT_NLA_SOLO_TRACK)) {
1257                 /* if there are strips, evaluate action as per NLA rules */
1258                 if (has_strips) {
1259                         /* make dummy NLA strip, and add that to the stack */
1260                         memset(&dummy_strip, 0, sizeof(NlaStrip));
1261                         dummy_trackslist.first= dummy_trackslist.last= &dummy_strip;
1262                         
1263                         dummy_strip.act= adt->action;
1264                         dummy_strip.remap= adt->remap;
1265                         
1266                                 // FIXME: what happens when we want to included F-Modifier access?
1267                         calc_action_range(dummy_strip.act, &dummy_strip.actstart, &dummy_strip.actend, 1);
1268                         dummy_strip.start = dummy_strip.actstart;
1269                         dummy_strip.end = (IS_EQ(dummy_strip.actstart, dummy_strip.actend)) ?  (dummy_strip.actstart + 1.0f): (dummy_strip.actend);
1270                         
1271                         dummy_strip.blendmode= adt->act_blendmode;
1272                         dummy_strip.extendmode= adt->act_extendmode;
1273                         dummy_strip.influence= adt->act_influence;
1274                         
1275                         /* add this to our list of evaluation strips */
1276                         nlastrips_ctime_get_strip(&estrips, &dummy_trackslist, -1, ctime);
1277                 }
1278                 else {
1279                         /* special case - evaluate as if there isn't any NLA data */
1280                         // TODO: this is really just a stop-gap measure...
1281                         animsys_evaluate_action(ptr, adt->action, adt->remap, ctime);
1282                         return;
1283                 }
1284         }
1285         
1286         /* only continue if there are strips to evaluate */
1287         if (estrips.first == NULL)
1288                 return;
1289         
1290         
1291         /* 2. for each strip, evaluate then accumulate on top of existing channels, but don't set values yet */
1292         for (nes= estrips.first; nes; nes= nes->next) 
1293                 nlastrip_evaluate(ptr, &echannels, NULL, nes);
1294         
1295         /* 3. flush effects of accumulating channels in NLA to the actual data they affect */
1296         nladata_flush_channels(&echannels);
1297         
1298         /* 4. free temporary evaluation data */
1299         BLI_freelistN(&estrips);
1300         BLI_freelistN(&echannels);
1301 }
1302
1303 /* ***************************************** */ 
1304 /* Overrides System - Public API */
1305
1306 /* Clear all overides */
1307
1308 /* Add or get existing Override for given setting */
1309 AnimOverride *BKE_animsys_validate_override (PointerRNA *ptr, char *path, int array_index)
1310 {
1311         // FIXME: need to define how to get overrides
1312         return NULL;
1313
1314
1315 /* -------------------- */
1316
1317 /* Evaluate Overrides */
1318 static void animsys_evaluate_overrides (PointerRNA *ptr, AnimData *adt, float ctime)
1319 {
1320         AnimOverride *aor;
1321         
1322         /* for each override, simply execute... */
1323         for (aor= adt->overrides.first; aor; aor= aor->next)
1324                 animsys_write_rna_setting(ptr, aor->rna_path, aor->array_index, aor->value);
1325 }
1326
1327 /* ***************************************** */
1328 /* Evaluation System - Public API */
1329
1330 /* Overview of how this system works:
1331  *      1) Depsgraph sorts data as necessary, so that data is in an order that means 
1332  *              that all dependences are resolved before dependants.
1333  *      2) All normal animation is evaluated, so that drivers have some basis values to
1334  *              work with
1335  *              a.      NLA stacks are done first, as the Active Actions act as 'tweaking' tracks
1336  *                      which modify the effects of the NLA-stacks
1337  *              b.      Active Action is evaluated as per normal, on top of the results of the NLA tracks
1338  *
1339  * --------------< often in a separate phase... >------------------ 
1340  *
1341  *      3) Drivers/expressions are evaluated on top of this, in an order where dependences are
1342  *              resolved nicely. 
1343  *         Note: it may be necessary to have some tools to handle the cases where some higher-level
1344  *              drivers are added and cause some problematic dependencies that didn't exist in the local levels...
1345  *
1346  * --------------< always executed >------------------ 
1347  *
1348  * Maintainance of editability of settings (XXX):
1349  *      In order to ensure that settings that are animated can still be manipulated in the UI without requiring
1350  *      that keyframes are added to prevent these values from being overwritten, we use 'overrides'. 
1351  *
1352  * Unresolved things:
1353  *      - Handling of multi-user settings (i.e. time-offset, group-instancing) -> big cache grids or nodal system? but stored where?
1354  *      - Multiple-block dependencies (i.e. drivers for settings are in both local and higher levels) -> split into separate lists?  
1355  */
1356
1357 /* Evaluation loop for evaluation animation data 
1358  *
1359  * This assumes that the animation-data provided belongs to the ID block in question,
1360  * and that the flags for which parts of the anim-data settings need to be recalculated 
1361  * have been set already by the depsgraph. Now, we use the recalc 
1362  */
1363 void BKE_animsys_evaluate_animdata (ID *id, AnimData *adt, float ctime, short recalc)
1364 {
1365         PointerRNA id_ptr;
1366         
1367         /* sanity checks */
1368         if ELEM(NULL, id, adt)
1369                 return;
1370         
1371         /* get pointer to ID-block for RNA to use */
1372         RNA_id_pointer_create(id, &id_ptr);
1373         
1374         /* recalculate keyframe data:
1375          *      - NLA before Active Action, as Active Action behaves as 'tweaking track'
1376          *        that overrides 'rough' work in NLA
1377          */
1378         // TODO: need to double check that this all works correctly
1379         if ((recalc & ADT_RECALC_ANIM) || (adt->recalc & ADT_RECALC_ANIM))
1380         {
1381                 /* evaluate NLA data */
1382                 if ((adt->nla_tracks.first) && !(adt->flag & ADT_NLA_EVAL_OFF))
1383                 {
1384                         /* evaluate NLA-stack 
1385                          *      - active action is evaluated as part of the NLA stack as the last item
1386                          */
1387                         animsys_evaluate_nla(&id_ptr, adt, ctime);
1388                 }
1389                 /* evaluate Active Action only */
1390                 else if (adt->action)
1391                         animsys_evaluate_action(&id_ptr, adt->action, adt->remap, ctime);
1392                 
1393                 /* reset tag */
1394                 adt->recalc &= ~ADT_RECALC_ANIM;
1395         }
1396         
1397         /* recalculate drivers 
1398          *      - Drivers need to be evaluated afterwards, as they can either override 
1399          *        or be layered on top of existing animation data.
1400          *      - Drivers should be in the appropriate order to be evaluated without problems...
1401          */
1402         if ((recalc & ADT_RECALC_DRIVERS) /*&& (adt->recalc & ADT_RECALC_DRIVERS)*/) // XXX for now, don't check yet, as depsgraph hasn't been updated
1403         {
1404                 animsys_evaluate_drivers(&id_ptr, adt, ctime);
1405         }
1406         
1407         /* always execute 'overrides' 
1408          *      - Overrides allow editing, by overwriting the value(s) set from animation-data, with the
1409          *        value last set by the user (and not keyframed yet). 
1410          *      - Overrides are cleared upon frame change and/or keyframing
1411          *      - It is best that we execute this everytime, so that no errors are likely to occur.
1412          */
1413         animsys_evaluate_overrides(&id_ptr, adt, ctime);
1414         
1415         /* clear recalc flag now */
1416         adt->recalc= 0;
1417 }
1418
1419 /* Evaluation of all ID-blocks with Animation Data blocks - Animation Data Only
1420  *
1421  * This will evaluate only the animation info available in the animation data-blocks
1422  * encountered. In order to enforce the system by which some settings controlled by a
1423  * 'local' (i.e. belonging in the nearest ID-block that setting is related to, not a
1424  * standard 'root') block are overridden by a larger 'user'
1425  */
1426 // FIXME?: we currently go over entire 'main' database...
1427 void BKE_animsys_evaluate_all_animation (Main *main, float ctime)
1428 {
1429         ID *id;
1430         
1431         if (G.f & G_DEBUG)
1432                 printf("Evaluate all animation - %f \n", ctime);
1433         
1434         /* macro for less typing 
1435          *      - only evaluate animation data for id if it has users (and not just fake ones)
1436          *      - whether animdata exists is checked for by the evaluation function, though taking 
1437          *        this outside of the function may make things slightly faster?
1438          */
1439 #define EVAL_ANIM_IDS(first, aflag) \
1440         for (id= first; id; id= id->next) { \
1441                 AnimData *adt= BKE_animdata_from_id(id); \
1442                 if ( (id->us > 1) || (id->us && !(id->flag & LIB_FAKEUSER)) ) \
1443                         BKE_animsys_evaluate_animdata(id, adt, ctime, aflag); \
1444         }
1445         
1446         /* optimisation: 
1447          * when there are no actions, don't go over database and loop over heaps of datablocks, 
1448          * which should ultimately be empty, since it is not possible for now to have any animation 
1449          * without some actions, and drivers wouldn't get affected by any state changes
1450          */
1451         if (main->action.first == NULL) {
1452                 if (G.f & G_DEBUG)
1453                         printf("\tNo Actions, so no animation needs to be evaluated...\n");
1454                         
1455                 return;
1456         }
1457         
1458         /* nodes */
1459         // TODO...
1460         
1461         /* textures */
1462         EVAL_ANIM_IDS(main->tex.first, ADT_RECALC_ANIM);
1463         
1464         /* lamps */
1465         EVAL_ANIM_IDS(main->lamp.first, ADT_RECALC_ANIM);
1466         
1467         /* materials */
1468         EVAL_ANIM_IDS(main->mat.first, ADT_RECALC_ANIM);
1469         
1470         /* cameras */
1471         EVAL_ANIM_IDS(main->camera.first, ADT_RECALC_ANIM);
1472         
1473         /* shapekeys */
1474                 // TODO: we probably need the same hack as for curves (ctime-hack)
1475         EVAL_ANIM_IDS(main->key.first, ADT_RECALC_ANIM);
1476         
1477         /* metaballs */
1478         EVAL_ANIM_IDS(main->mball.first, ADT_RECALC_ANIM);
1479         
1480         /* curves */
1481                 /* we need to perform a special hack here to ensure that the ctime 
1482                  * value of the curve gets set in case there's no animation for that
1483                  *      - it needs to be set before animation is evaluated just so that 
1484                  *        animation can successfully override...
1485                  */
1486         for (id= main->curve.first; id; id= id->next) {
1487                 AnimData *adt= BKE_animdata_from_id(id);
1488                 Curve *cu= (Curve *)id;
1489                 
1490                 cu->ctime= ctime;
1491                 BKE_animsys_evaluate_animdata(id, adt, ctime, ADT_RECALC_ANIM);
1492         }
1493         
1494         /* meshes */
1495         // TODO...
1496         
1497         /* particles */
1498         EVAL_ANIM_IDS(main->particle.first, ADT_RECALC_ANIM);
1499         
1500         /* objects */
1501                 /* ADT_RECALC_ANIM doesn't need to be supplied here, since object AnimData gets 
1502                  * this tagged by Depsgraph on framechange 
1503                  */
1504         EVAL_ANIM_IDS(main->object.first, /*ADT_RECALC_ANIM*/0); 
1505         
1506         /* worlds */
1507         EVAL_ANIM_IDS(main->world.first, ADT_RECALC_ANIM);
1508         
1509         /* scenes */
1510         EVAL_ANIM_IDS(main->scene.first, ADT_RECALC_ANIM);
1511 }
1512
1513 /* ***************************************** */