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