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