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